1 dump('entering OpenILS/data.js\n');
3 if (typeof OpenILS == 'undefined') OpenILS = {};
4 OpenILS.data = function () {
6 JSAN.use('util.error'); this.error = new util.error();
7 JSAN.use('util.network'); this.network = new util.network();
12 OpenILS.data.prototype = {
20 'data_progress' : function(msg) {
22 var x = document.getElementById('data_progress');
24 x.appendChild( document.createTextNode( msg ) );
27 this.error.sdump('D_ERROR',msg + '\n' + E);
31 'init' : function (params) {
34 if (params && params.via == 'stash') {
35 this.stash_retrieve();
37 this.network_retrieve();
41 this.error.sdump('D_ERROR','Error in OpenILS.data.init('
42 +js2JSON(params)+'): ' + js2JSON(E) );
48 // This should be invoked only once per application, in a persistant window
49 'init_observer_functions' : function() {
51 var obj = this; // OpenILS.data
52 obj.observers = {}; //
53 obj.observers.id = 1; // Unique id for each observer function added
54 obj.observers.id2path = {}; // Lookup for full_path via observer id
55 obj.observers.cache = {}; // Observer funcs go in here
57 // For a given path, this executes all the registered observer funcs
58 obj.observers.dispatch = function(full_path, old_value, new_value) {
59 obj.error.sdump('D_OBSERVERS', 'entering observers.dispatch\nfull_path = ' + full_path + '\nold_value = ' + js2JSON(old_value) + '\nnew_value = ' + js2JSON(new_value) + '\n');
61 var path = full_path.split(/\./).pop();
62 for (var i in obj.observers.cache[full_path]) {
64 var o = obj.observers.cache[full_path][i];
65 if (typeof o.func == 'function') o.func(path, old_value, new_value);
67 obj.error.sdump('D_ERROR','Error in OpenILS.data.observers.dispatch(): ' + js2JSON(E) );
71 obj.error.sdump('D_ERROR','Error in OpenILS.data.observers.dispatch(): ' + js2JSON(E) );
75 // This registers an observer function for a given path
76 obj.observers.add = function(full_path, func) {
78 obj.error.sdump('D_OBSERVERS', 'entering observers.add\nfull_path = ' + full_path + '\nfunc = ' + func + '\n');
79 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
80 const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
81 var data_cache=new OpenILS( );
82 var stash = data_cache.wrappedJSObject.OpenILS.prototype.data;
84 var id = obj.observers.id++;
85 if (typeof obj.observers.cache[ full_path ] == 'undefined') obj.observers.cache[ full_path ] = {};
86 obj.observers.cache[ full_path ][ id ] = { 'func' : func, 'time_added' : new Date() };
87 obj.observers.id2path[ id ] = [ full_path ];
89 var path_list = full_path.split(/\./);
90 var observed_prop = path_list.pop();
92 // Convert soft path to object reference. Error if any but the last node is undefined
93 for (var i in path_list) stash = stash[ path_list[i] ];
97 // experiment with storing only json in cache to avoid the [ ] -> { '0' : .., '1' : .. } bug
99 if (stash[observed_prop] && getKeys( obj.observers.cache[ full_path ] ).length == 0) {
100 stash['_' + observed_prop] = js2JSON(stash[observed_prop]);
103 stash.__defineSetter__(observed_prop, function(x) { this['_'+observed_prop] = js2JSON(x); });
104 stash.__defineGetter__(observed_prop, function() { return JSON2js(this['_'+observed_prop]); });
109 function(p,old_value,new_value) {
110 obj.observers.dispatch(full_path,old_value,new_value);
117 obj.error.sdump('D_ERROR','Error in OpenILS.data.observers.add(): ' + js2JSON(E) );
121 // This unregisters an observer function for a given observer id
122 obj.observers.remove = function(id) {
124 obj.error.sdump('D_OBSERVERS', 'entering observers.remove\nid = ' + id + '\n');
125 var path = obj.observers.id2path[ id ];
126 delete obj.observers.cache[ path ][ id ];
127 delete obj.observers.id2path[ id ];
129 obj.error.sdump('D_ERROR','Error in OpenILS.data.observers.remove(): ' + js2JSON(E) );
133 // This purges observer functions for a given path
134 obj.observers.purge = function(full_path) {
135 obj.error.sdump('D_OBSERVERS', 'entering observers.purge\nfull_path = ' + full_path + '\n');
137 var remove_these = [];
138 for (var id in obj.observers.cache[ full_path ]) remove_these.push( id );
139 for (var id in remove_these) delete obj.observers.id2path[ id ];
140 delete obj.observers.cache[ full_path ];
142 obj.error.sdump('D_ERROR','Error in OpenILS.data.observers.purge(): ' + js2JSON(E) );
146 obj.stash('observers'); // make this accessible globally
149 this.error.sdump('D_ERROR','Error in OpenILS.data.init_observer_functions(): ' + js2JSON(E) );
153 'stash' : function () {
155 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
156 const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
157 var data_cache=new OpenILS( );
158 for (var i = 0; i < arguments.length; i++) {
160 if (arguments[i] != 'hash' && arguments[i] != 'list') this.error.sdump('D_DATA_STASH','stashing ' + arguments[i] + ' : ' + this[arguments[i]] + (typeof this[arguments[i]] == 'object' ? ' = ' + js2JSON(this[arguments[i]]) : '') + '\n');
161 } catch(F) { alert(F); }
162 data_cache.wrappedJSObject.OpenILS.prototype.data[arguments[i]] = this[arguments[i]];
165 this.error.sdump('D_ERROR','Error in OpenILS.data.stash(): ' + js2JSON(E) );
169 'lookup' : function(key,value) {
171 var obj = this; var found;
172 if (obj.hash[key] && obj.hash[key][value]) return obj.hash[key][value];
175 found = obj.network.simple_request('FM_ACPL_RETRIEVE_VIA_ID',[ value ]);
177 default: return undefined; break;
179 if (typeof found.ilsevent != 'undefined') throw(found);
180 if (!obj.hash[key]) obj.hash[key] = {};
181 obj.hash[key][value] = found; obj.list[key].push( found ); obj.stash('hash','list');
184 this.error.sdump('D_ERROR','Error in OpenILS.data.lookup('+key+','+value+'): ' + js2JSON(E) );
189 '_debug_stash' : function() {
191 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
192 const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
193 var data_cache=new OpenILS( );
194 for (var i in data_cache.wrappedJSObject.OpenILS.prototype.data) {
195 dump('_debug_stash ' + i + '\n');
198 this.error.sdump('D_ERROR','Error in OpenILS.data._debug_stash(): ' + js2JSON(E) );
204 'pgt' : [ api.FM_PGT_RETRIEVE.app, api.FM_PGT_RETRIEVE.method, [], true ],
205 'cit' : [ api.FM_CIT_RETRIEVE.app, api.FM_CIT_RETRIEVE.method, [], true ],
206 'citm' : [ api.FM_CITM_RETRIEVE.app, api.FM_CITM_RETRIEVE.method, [], true ],
208 'cst' : [ api.FM_CST_RETRIEVE.app, api.FM_CST_RETRIEVE.method, [], true ],
211 'acpl' : [ api.FM_ACPL_RETRIEVE.app, api.FM_ACPL_RETRIEVE.method, [], true ],
213 'ccs' : [ api.FM_CCS_RETRIEVE.app, api.FM_CCS_RETRIEVE.method, [], true ],
214 'aou' : [ api.FM_AOU_RETRIEVE.app, api.FM_AOU_RETRIEVE.method, [], true ],
215 'aout' : [ api.FM_AOUT_RETRIEVE.app, api.FM_AOUT_RETRIEVE.method, [], true ],
216 'crahp' : [ api.FM_CRAHP_RETRIEVE.app, api.FM_CRAHP_RETRIEVE.method, [], true ],
219 'stash_retrieve' : function() {
221 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
222 const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
223 var data_cache=new OpenILS( );
224 var dc = data_cache.wrappedJSObject.OpenILS.prototype.data;
226 this.error.sdump('D_DATA_RETRIEVE','Retrieving ' + i + ' : ' + dc[i] + '\n');
229 if (typeof this.on_complete == 'function') {
234 this.error.sdump('D_ERROR','Error in OpenILS.data._debug_stash(): ' + js2JSON(E) );
238 'print_list_defaults' : function() {
240 //if (typeof obj.print_list_templates == 'undefined') {
242 obj.print_list_types = [
246 'offline_inhouse_use',
253 obj.print_list_templates = {
256 'header' : 'The following items have been examined:<hr/><ol>',
257 'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode%\r\n',
258 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
262 'header' : 'Transits:<hr/><ol>',
263 'line_item' : '<li>From: %transit_source% To: %transit_dest_lib%<br/>\r\nWhen: %transit_source_send_time%<br />\r\nBarcode: %transit_item_barcode% Title: %transit_item_title%<br/>\r\n',
264 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
268 'header' : 'Welcome to %LIBRARY%!<br/>\r\nYou have the following items:<hr/><ol>',
269 'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode% Due: %due_date%\r\n',
270 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME%<br/>\r\n<br/>\r\n',
274 'header' : 'Welcome to %LIBRARY%!<br/>\r\nYou checked out the following items:<hr/><ol>',
275 'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode% Due: %due_date%\r\n',
276 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME%<br/>\r\n<br/>\r\n',
278 'offline_checkout' : {
279 'type' : 'offline_checkout',
280 'header' : 'Patron %patron_barcode%<br/>\r\nYou checked out the following items:<hr/><ol>',
281 'line_item' : '<li>Barcode: %barcode%<br/>\r\nDue: %due_date%\r\n',
282 'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
286 'header' : 'You checked in the following items:<hr/><ol>',
287 'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode% Call Number: %call_number%\r\n',
288 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
292 'header' : 'Welcome to %LIBRARY%!<br/>A receipt of your transaction:<hr/> <table width="100%"> <tr> <td>Original Balance:</td> <td align="right">$%original_balance%</td> </tr> <tr> <td>Payment Method:</td> <td align="right">%payment_type%</td> </tr> <tr> <td>Payment Received:</td> <td align="right">$%payment_received%</td> </tr> <tr> <td>Payment Applied:</td> <td align="right">$%payment_applied%</td> </tr> <tr> <td>Billings Voided:</td> <td align="right">%voided_balance%</td> </tr> <tr> <td>Change Given:</td> <td align="right">$%change_given%</td> </tr> <tr> <td>New Balance:</td> <td align="right">$%new_balance%</td> </tr> </table> <p> Note: %note% </p> <p> Specific bills: <blockquote>',
293 'line_item' : 'Bill #%bill_id% %last_billing_type% Received: $%payment%<br />%barcode% %title%<br /><br />',
294 'footer' : '</blockquote> </p> <hr />%SHORTNAME% %TODAY_TRIM%<br/> <br/> ',
296 'bills_historical' : {
298 'header' : 'Welcome to %LIBRARY%!<br/>You had the following bills:<hr/><ol>',
299 'line_item' : '<dt><b>Bill #%id%</b></dt> <dd> <table> <tr valign="top"><td>Date:</td><td>%xact_start%</td></tr> <tr valign="top"><td>Type:</td><td>%xact_type%</td></tr> <tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr> <tr valign="top"><td>Total Billed:</td><td>$%total_owed%</td></tr> <tr valign="top"><td>Last Payment:</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr> <tr valign="top"><td>Total Paid:</td><td>$%total_paid%</td></tr> <tr valign="top"><td><b>Balance:</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/>',
300 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
304 'header' : 'Welcome to %LIBRARY%!<br/>You have the following bills:<hr/><ol>',
305 'line_item' : '<dt><b>Bill #%id%</b></dt> <dd> <table> <tr valign="top"><td>Date:</td><td>%xact_start%</td></tr> <tr valign="top"><td>Type:</td><td>%xact_type%</td></tr> <tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr> <tr valign="top"><td>Total Billed:</td><td>$%total_owed%</td></tr> <tr valign="top"><td>Last Payment:</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr> <tr valign="top"><td>Total Paid:</td><td>$%total_paid%</td></tr> <tr valign="top"><td><b>Balance:</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/>',
306 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
308 'offline_checkin' : {
309 'type' : 'offline_checkin',
310 'header' : 'You checked in the following items:<hr/><ol>',
311 'line_item' : '<li>Barcode: %barcode%\r\n',
312 'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
315 'type' : 'offline_renew',
316 'header' : 'You renewed the following items:<hr/><ol>',
317 'line_item' : '<li>Barcode: %barcode%\r\n',
318 'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
320 'offline_inhouse_use' : {
321 'type' : 'offline_inhouse_use',
322 'header' : 'You marked the following in-house items used:<hr/><ol>',
323 'line_item' : '<li>Barcode: %barcode%\r\nUses: %count%',
324 'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
328 'header' : 'You marked the following in-house items used:<hr/><ol>',
329 'line_item' : '<li>Barcode: %barcode%\r\nUses: %uses%\r\n<br />%alert_message%',
330 'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
334 'header' : 'Welcome to %LIBRARY%!<br/>\r\nYou have the following titles on hold:<hr/><ol>',
335 'line_item' : '<li>%title%\r\n',
336 'footer' : '</ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME%<br/>\r\n<br/>\r\n',
340 obj.stash( 'print_list_templates', 'print_list_types' );
344 'network_retrieve' : function() {
345 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
349 JSAN.use('util.file'); var file = new util.file('print_list_templates');
350 obj.print_list_defaults();
351 obj.data_progress('Default print templates set. ');
352 if (file._file.exists()) {
354 var x = file.get_object();
357 obj.print_list_templates[i] = x[i];
359 obj.stash('print_list_templates');
360 obj.data_progress('Saved print templates retrieved from file. ');
368 JSAN.use('util.file'); var file = new util.file('global_font_adjust');
369 if (file._file.exists()) {
371 var x = file.get_object();
373 obj.global_font_adjust = x;
374 obj.stash('global_font_adjust');
375 obj.data_progress('Saved font settings retrieved from file. ');
383 JSAN.use('util.file'); var file = new util.file('no_sound');
384 if (file._file.exists()) {
386 var x = file.get_content();
389 obj.stash('no_sound');
390 obj.data_progress('Saved sound settings retrieved from file. ');
398 JSAN.use('util.file'); var file = new util.file('print_strategy');
399 if (file._file.exists()) {
401 var x = file.get_content();
403 obj.print_strategy = x;
404 obj.stash('print_strategy');
405 obj.data_progress('Print strategy retrieved from file. ');
413 JSAN.use('util.functional');
414 JSAN.use('util.fm_utils');
416 function gen_fm_retrieval_func(classname,data) {
417 var app = data[0]; var method = data[1]; var params = data[2]; var cacheable = data[3];
419 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
422 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
424 if (obj.list[classname].constructor.name == 'Array') {
425 obj.hash[classname] =
426 util.functional.convert_object_list_to_hash(
432 obj.error.sdump('D_ERROR',E + '\n');
438 var level = obj.error.sdump_levels.D_SES_RESULT;
439 if (classname == 'aou' || classname == 'my_aou')
440 obj.error.sdump_levels.D_SES_RESULT = false;
441 var robj = obj.network.request( app, method, params);
442 if (!robj || robj.ilsevent) {
443 obj.error.standard_unexpected_error_alert('The staff client failed to retrieve expected data from this call, "' + method + '"',robj);
446 obj.list[classname] = robj;
447 obj.error.sdump_levels.D_SES_RESULT = level;
449 obj.data_progress('Retrieved list for ' + classname + ' objects. ');
452 // if cacheable, try offline
454 /* FIXME -- we're going to revisit caching and do it differently
456 var file = new util.file( classname );
457 obj.list[classname] = file.get_object(); file.close();
476 var robj = obj.network.simple_request('CIRC_MODIFIER_LIST',[]);
477 if (typeof robj.ilsevent != 'undefined') throw(robj);
478 obj.list.circ_modifier = robj;
479 obj.data_progress('Retrieved circ modifier list. ');
481 var error = 'Error: ' + js2JSON(E);
482 obj.error.sdump('D_ERROR',error);
491 var robj = obj.network.simple_request('BILLING_TYPE_LIST',[]);
492 if (typeof robj.ilsevent != 'undefined') throw(robj);
493 obj.list.billing_type = robj;
494 obj.data_progress('Retrieved billing type list. ');
496 var error = 'Error: ' + js2JSON(E);
497 obj.error.sdump('D_ERROR',error);
506 var f = gen_fm_retrieval_func(
509 api.FM_CNAL_RETRIEVE.app,
510 api.FM_CNAL_RETRIEVE.method,
518 var error = 'Error: ' + js2JSON(E);
519 obj.error.sdump('D_ERROR',error);
527 var f = gen_fm_retrieval_func(
530 api.FM_AU_RETRIEVE_VIA_SESSION.app,
531 api.FM_AU_RETRIEVE_VIA_SESSION.method,
539 var error = 'Error: ' + js2JSON(E);
540 obj.error.sdump('D_ERROR',error);
543 obj.list.au = [ obj.list.au ];
549 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
550 var f = gen_fm_retrieval_func(
553 api.FM_ASV_RETRIEVE_REQUIRED.app,
554 api.FM_ASV_RETRIEVE_REQUIRED.method,
560 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
563 var error = 'Error: ' + js2JSON(E);
564 obj.error.sdump('D_ERROR',error);
572 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
573 var f = gen_fm_retrieval_func(
576 api.FM_ASV_RETRIEVE.app,
577 api.FM_ASV_RETRIEVE.method,
583 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
586 var error = 'Error: ' + js2JSON(E);
587 obj.error.sdump('D_ERROR',error);
593 obj.error.sdump('D_DEBUG','_fm_objects = ' + js2JSON(this._fm_objects) + '\n');
595 for (var i in this._fm_objects) {
596 this.chain.push( gen_fm_retrieval_func(i,this._fm_objects[i]) );
599 // The previous org_tree call returned a tree, not a list or hash.
602 obj.tree.aou = obj.list.aou;
603 obj.list.aou = util.fm_utils.flatten_ou_branch( obj.tree.aou );
604 for (var i = 0; i < obj.list.aou.length; i++) {
605 var c = obj.list.aou[i].children();
609 if (a.shortname() < b.shortname()) return -1;
610 if (a.shortname() > b.shortname()) return 1;
614 obj.list.aou[i].children( c );
616 obj.list.aou = util.fm_utils.flatten_ou_branch( obj.tree.aou );
617 obj.hash.aou = util.functional.convert_object_list_to_hash( obj.list.aou );
621 // The previous pgt call returned a tree, not a list or hash.
624 obj.tree.pgt = obj.list.pgt;
625 obj.list.pgt = util.fm_utils.flatten_ou_branch( obj.tree.pgt );
626 obj.hash.pgt = util.functional.convert_object_list_to_hash( obj.list.pgt );
630 // Do this after we get the user object
635 gen_fm_retrieval_func('my_aou',
637 api.FM_AOU_RETRIEVE_RELATED_VIA_SESSION.app,
638 api.FM_AOU_RETRIEVE_RELATED_VIA_SESSION.method,
639 [ obj.session.key, obj.list.au[0].ws_ou() ], /* use ws_ou and not home_ou */
650 gen_fm_retrieval_func( 'my_actsc',
652 api.FM_ACTSC_RETRIEVE_VIA_AOU.app,
653 api.FM_ACTSC_RETRIEVE_VIA_AOU.method,
654 [ obj.session.key, obj.list.au[0].ws_ou() ],
665 gen_fm_retrieval_func( 'my_asc',
667 api.FM_ASC_RETRIEVE_VIA_AOU.app,
668 api.FM_ASC_RETRIEVE_VIA_AOU.method,
669 [ obj.session.key, obj.list.au[0].ws_ou() ],
679 var f = gen_fm_retrieval_func(
682 api.FM_CNCT_RETRIEVE.app,
683 api.FM_CNCT_RETRIEVE.method,
684 [ obj.list.au[0].ws_ou() ],
691 var error = 'Error: ' + js2JSON(E);
692 obj.error.sdump('D_ERROR',error);
700 var f = gen_fm_retrieval_func(
703 api.FM_ACPL_RETRIEVE.app,
704 api.FM_ACPL_RETRIEVE.method,
705 [ obj.list.au[0].ws_ou() ],
712 var error = 'Error: ' + js2JSON(E);
713 obj.error.sdump('D_ERROR',error);
721 if (typeof this.on_complete == 'function') {
723 this.chain.push( this.on_complete );
725 JSAN.use('util.exec'); this.exec = new util.exec();
726 this.exec.on_error = function(E) {
728 if (typeof obj.on_error == 'function') {
731 alert('oops: ' + E );
734 return false; /* break chain */
737 this.exec.chain( this.chain );
742 dump('exiting OpenILS/data.js\n');