]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/xul/staff_client/chrome/content/OpenILS/data.js
lookup and stash
[working/Evergreen.git] / Open-ILS / xul / staff_client / chrome / content / OpenILS / data.js
1 dump('entering OpenILS/data.js\n');
2
3 if (typeof OpenILS == 'undefined') OpenILS = {};
4 OpenILS.data = function () {
5
6         JSAN.use('util.error'); this.error = new util.error();
7         JSAN.use('util.network'); this.network = new util.network();
8
9         return this;
10 }
11
12 OpenILS.data.prototype = {
13
14         'list' : {},
15         'hash' : {},
16         'tree' : {},
17
18         'temp' : '',
19
20         'init' : function (params) {
21
22                 try {
23                         if (params && params.via == 'stash') {  
24                                 this.stash_retrieve();
25                         } else {
26                                 this.network_retrieve();
27                         }
28                 
29                 } catch(E) {
30                         this.error.sdump('D_ERROR','Error in OpenILS.data.init('
31                                 +js2JSON(params)+'): ' + js2JSON(E) );
32                 }
33
34
35         },
36
37         'stash' : function () {
38                 try {
39                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
40                         const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
41                         var data_cache=new OpenILS( );
42                         for (var i = 0; i < arguments.length; i++) {
43                                 try {
44                                         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');
45                                 } catch(F) { alert(F); }
46                                 data_cache.wrappedJSObject.OpenILS.prototype.data[arguments[i]] = this[arguments[i]];
47                         }
48                 } catch(E) {
49                         this.error.sdump('D_ERROR','Error in OpenILS.data.stash(): ' + js2JSON(E) );
50                 }
51         },
52
53         'lookup' : function(key,value) {
54                 try {
55                         var obj = this; var found;
56                         if (obj.hash[key] && obj.hash[key][value]) return obj.hash[key][value];
57                         switch(key) {
58                                 case 'acpl': 
59                                         found = obj.network.simple_request('FM_ACPL_RETRIEVE_VIA_ID',[ value ]);
60                                 break;
61                                 default: return undefined; break;
62                         }
63                         if (typeof found.ilsevent != 'undefined') throw(found);
64                         if (!obj.hash[key]) obj.hash[key] = {};
65                         obj.hash[key][value] = found; obj.list[key].push( found ); obj.stash('hash','list');
66                         return found;
67                 } catch(E) {
68                         this.error.sdump('D_ERROR','Error in OpenILS.data.lookup('+key+','+value+'): ' + js2JSON(E) );
69                         return undefined;
70                 }
71         },
72
73         '_debug_stash' : function() {
74                 try {
75                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
76                         const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
77                         var data_cache=new OpenILS( );
78                         for (var i in data_cache.wrappedJSObject.OpenILS.prototype.data) {
79                                 dump('_debug_stash ' + i + '\n');
80                         }
81                 } catch(E) {
82                         this.error.sdump('D_ERROR','Error in OpenILS.data._debug_stash(): ' + js2JSON(E) );
83                 }
84         },
85
86         '_fm_objects' : {
87
88                 'pgt' : [ api.FM_PGT_RETRIEVE.app, api.FM_PGT_RETRIEVE.method, [], true ],
89                 'cit' : [ api.FM_CIT_RETRIEVE.app, api.FM_CIT_RETRIEVE.method, [], true ],
90                 'citm' : [ api.FM_CITM_RETRIEVE.app, api.FM_CITM_RETRIEVE.method, [], true ],
91                 /*
92                 'cst' : [ api.FM_CST_RETRIEVE.app, api.FM_CST_RETRIEVE.method, [], true ],
93                 */
94                 /*
95                 'acpl' : [ api.FM_ACPL_RETRIEVE.app, api.FM_ACPL_RETRIEVE.method, [], true ],
96                 */
97                 'ccs' : [ api.FM_CCS_RETRIEVE.app, api.FM_CCS_RETRIEVE.method, [], true ],
98                 'aou' : [ api.FM_AOU_RETRIEVE.app, api.FM_AOU_RETRIEVE.method, [], true ],
99                 'aout' : [ api.FM_AOUT_RETRIEVE.app, api.FM_AOUT_RETRIEVE.method, [], true ],
100                 'crahp' : [ api.FM_CRAHP_RETRIEVE.app, api.FM_CRAHP_RETRIEVE.method, [], true ],
101         },
102
103         'stash_retrieve' : function() {
104                 try {
105                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
106                         const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
107                         var data_cache=new OpenILS( );
108                         var dc = data_cache.wrappedJSObject.OpenILS.prototype.data;
109                         for (var i in dc) {
110                                 this.error.sdump('D_DATA_RETRIEVE','Retrieving ' + i + ' : ' + dc[i] + '\n');
111                                 this[i] = dc[i];
112                         }
113                         if (typeof this.on_complete == 'function') {
114
115                                 this.on_complete();
116                         }
117                 } catch(E) {
118                         this.error.sdump('D_ERROR','Error in OpenILS.data._debug_stash(): ' + js2JSON(E) );
119                 }
120         },
121
122         'print_list_defaults' : function() {
123                 var obj = this;
124                 //if (typeof obj.print_list_templates == 'undefined') {
125                 {
126                         obj.print_list_types = [ 
127                                 'offline_checkout', 
128                                 'offline_checkin', 
129                                 'offline_renew', 
130                                 'offline_inhouse_use', 
131                                 'items', 
132                                 'bills', 
133                                 'payment', 
134                                 'holds', 
135                                 /* 'patrons' */
136                         ];
137                         obj.print_list_templates = { 
138                                 'item_status' : {
139                                         'type' : 'items',
140                                         'header' : 'The following items have been examined:<hr/><ol>',
141                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode%\r\n',
142                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
143                                 }, 
144                                 'items_out' : {
145                                         'type' : 'items',
146                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>\r\nYou have the following items:<hr/><ol>',
147                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode% Due: %due_date%\r\n',
148                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME% %STAFF_LASTNAME%<br/>\r\n<br/>\r\n',
149                                 }, 
150                                 'checkout' : {
151                                         'type' : 'items',
152                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>\r\nYou checked out the following items:<hr/><ol>',
153                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode% Due: %due_date%\r\n',
154                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME% %STAFF_LASTNAME%<br/>\r\n<br/>\r\n',
155                                 }, 
156                                 'offline_checkout' : {
157                                         'type' : 'offline_checkout',
158                                         'header' : 'Patron %patron_barcode%<br/>\r\nYou checked out the following items:<hr/><ol>',
159                                         'line_item' : '<li>Barcode: %barcode%<br/>\r\nDue: %due_date%\r\n',
160                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
161                                 },
162                                 'checkin' : {
163                                         'type' : 'items',
164                                         'header' : 'You checked in the following items:<hr/><ol>',
165                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode%  Call Number: %call_number%\r\n',
166                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
167                                 }, 
168                                 'bill_payment' : {
169                                         'type' : 'payment',
170                                         'header' : 'Welcome %PATRON_FIRSTNAME%, 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>Change Given:</td> <td align="right">$%change_given%</td> </tr> <tr> <td>Credit Given:</td> <td align="right">$%credit_given%</td> </tr> <tr> <td>New Balance:</td> <td align="right">$%new_balance%</td> </tr> </table> <p> Note: %note% </p> <p> Specific bills: <blockquote>',
171                                         'line_item' : 'Bill #%bill_id%  Received: $%payment%<br />',
172                                         'footer' : '</blockquote> </p> <hr />%PINES_CODE% %TODAY_TRIM%<br/> <br/> ',
173                                 },
174                                 'bills_historical' : {
175                                         'type' : 'bills',
176                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>You had the following bills:<hr/><ol>',
177                                         '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/>',
178                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
179                                 }, 
180                                 'bills_current' : {
181                                         'type' : 'bills',
182                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>You have the following bills:<hr/><ol>',
183                                         '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/>',
184                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
185                                 }, 
186                                 'offline_checkin' : {
187                                         'type' : 'offline_checkin',
188                                         'header' : 'You checked in the following items:<hr/><ol>',
189                                         'line_item' : '<li>Barcode: %barcode%\r\n',
190                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
191                                 },
192                                 'offline_renew' : {
193                                         'type' : 'offline_renew',
194                                         'header' : 'You renewed the following items:<hr/><ol>',
195                                         'line_item' : '<li>Barcode: %barcode%\r\n',
196                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
197                                 },
198                                 'offline_inhouse_use' : {
199                                         'type' : 'offline_inhouse_use',
200                                         'header' : 'You marked the following in-house items used:<hr/><ol>',
201                                         'line_item' : '<li>Barcode: %barcode%\r\nUses: %count%',
202                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
203                                 },
204                                 'in_house_use' : {
205                                         'type' : 'items',
206                                         'header' : 'You marked the following in-house items used:<hr/><ol>',
207                                         'line_item' : '<li>Barcode: %barcode%\r\nUses: %uses%\r\n<br />%alert_message%',
208                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
209                                 },
210                                 'holds' : {
211                                         'type' : 'holds',
212                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>\r\nYou have the following titles on hold:<hr/><ol>',
213                                         'line_item' : '<li>%title%\r\n',
214                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME% %STAFF_LASTNAME%<br/>\r\n<br/>\r\n',
215                                 } 
216                         }; 
217
218                         obj.stash( 'print_list_templates', 'print_list_types' );
219                 }
220         },
221
222         'network_retrieve' : function() {
223                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
224                 var obj = this;
225
226
227                 JSAN.use('util.file'); var file = new util.file('print_list_templates');
228                 obj.print_list_defaults();
229                 if (file._file.exists()) {
230                         try {
231                                 var x = file.get_object();
232                                 if (x) {
233                                         for (var i in x) {
234                                                 obj.print_list_templates[i] = x[i];
235                                         }
236                                         obj.stash('print_list_templates');
237                                 }
238                         } catch(E) {
239                                 alert(E);
240                         }
241                 }
242                 file.close();
243
244                 JSAN.use('util.file');
245                 JSAN.use('util.functional');
246                 JSAN.use('util.fm_utils');
247
248                 function gen_fm_retrieval_func(classname,data) {
249                         var app = data[0]; var method = data[1]; var params = data[2]; var cacheable = data[3];
250                         return function () {
251                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
252
253                                 function convert() {
254                                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
255                                         try {
256                                                 if (obj.list[classname].constructor.name == 'Array') {
257                                                         obj.hash[classname] = 
258                                                                 util.functional.convert_object_list_to_hash(
259                                                                         obj.list[classname]
260                                                                 );
261                                                 }
262                                         } catch(E) {
263
264                                                 obj.error.sdump('D_ERROR',E + '\n');
265                                         }
266
267                                 }
268
269                                 try {
270                                         var level = obj.error.sdump_levels.D_SES_RESULT;
271                                         if (classname == 'aou' || classname == 'my_aou')
272                                                 obj.error.sdump_levels.D_SES_RESULT = false;
273                                         var robj = obj.network.request( app, method, params);
274                                         if (!robj || robj.ilsevent) {
275                                                 obj.error.standard_unexpected_error_alert('The staff client failed to retrieve expected data from this call, "' + method + '"',robj);
276                                                 throw(robj);
277                                         }
278                                         obj.list[classname] = robj;
279                                         obj.error.sdump_levels.D_SES_RESULT = level;
280                                         convert();
281                                         // if cacheable, store an offline copy
282                                         /* FIXME -- we're going to revisit caching and do it differently
283                                         if (cacheable) {
284                                                 var file = new util.file( classname );
285                                                 file.set_object( obj.list[classname] );
286                                         }
287                                         */
288
289                                 } catch(E) {
290                                         // if cacheable, try offline
291                                         if (cacheable) {
292                                                 /* FIXME -- we're going to revisit caching and do it differently
293                                                 try {
294                                                         var file = new util.file( classname );
295                                                         obj.list[classname] = file.get_object(); file.close();
296                                                         convert();
297                                                 } catch(E) {
298                                                         throw(E);
299                                                 }
300                                                 */
301                                                 throw(E); // for now
302                                         } else {
303                                                 throw(E); // for now
304                                         }
305                                 }
306                         }
307                 }
308
309                 this.chain = [];
310
311                 this.chain.push(
312                         function() {
313                                 var f = gen_fm_retrieval_func(
314                                         'cnal',
315                                         [
316                                                 api.FM_CNAL_RETRIEVE.app,
317                                                 api.FM_CNAL_RETRIEVE.method,
318                                                 [ obj.session.key ],
319                                                 false
320                                         ]
321                                 );
322                                 try {
323                                         f();
324                                 } catch(E) {
325                                         var error = 'Error: ' + js2JSON(E);
326                                         obj.error.sdump('D_ERROR',error);
327                                         throw(E);
328                                 }
329                         }
330                 );
331
332                 this.chain.push(
333                         function() {
334                                 var f = gen_fm_retrieval_func(
335                                         'au',
336                                         [
337                                                 api.FM_AU_RETRIEVE_VIA_SESSION.app,
338                                                 api.FM_AU_RETRIEVE_VIA_SESSION.method,
339                                                 [ obj.session.key ],
340                                                 false
341                                         ]
342                                 );
343                                 try {
344                                         f();
345                                 } catch(E) {
346                                         var error = 'Error: ' + js2JSON(E);
347                                         obj.error.sdump('D_ERROR',error);
348                                         throw(E);
349                                 }
350                                 obj.list.au = [ obj.list.au ];
351                         }
352                 );
353
354                 this.chain.push(
355                         function() {
356                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
357                                 var f = gen_fm_retrieval_func(
358                                         'my_asv',
359                                         [
360                                                 api.FM_ASV_RETRIEVE_REQUIRED.app,
361                                                 api.FM_ASV_RETRIEVE_REQUIRED.method,
362                                                 [ obj.session.key ],
363                                                 true
364                                         ]
365                                 );
366                                 try {
367                                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
368                                         f();
369                                 } catch(E) {
370                                         var error = 'Error: ' + js2JSON(E);
371                                         obj.error.sdump('D_ERROR',error);
372                                         throw(E);
373                                 }
374                         }
375                 );
376
377                 this.chain.push(
378                         function() {
379                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
380                                 var f = gen_fm_retrieval_func(
381                                         'asv',
382                                         [
383                                                 api.FM_ASV_RETRIEVE.app,
384                                                 api.FM_ASV_RETRIEVE.method,
385                                                 [ obj.session.key ],
386                                                 true
387                                         ]
388                                 );
389                                 try {
390                                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
391                                         f();
392                                 } catch(E) {
393                                         var error = 'Error: ' + js2JSON(E);
394                                         obj.error.sdump('D_ERROR',error);
395                                         throw(E);
396                                 }
397                         }
398                 );
399
400                 obj.error.sdump('D_DEBUG','_fm_objects = ' + js2JSON(this._fm_objects) + '\n');
401
402                 for (var i in this._fm_objects) {
403                         this.chain.push( gen_fm_retrieval_func(i,this._fm_objects[i]) );
404                 }
405
406                 // The previous org_tree call returned a tree, not a list or hash.
407                 this.chain.push(
408                         function () {
409                                 obj.tree.aou = obj.list.aou;
410                                 obj.list.aou = util.fm_utils.flatten_ou_branch( obj.tree.aou );
411                                 obj.hash.aou = util.functional.convert_object_list_to_hash( obj.list.aou );
412                         }
413                 );
414
415                 // The previous pgt call returned a tree, not a list or hash.
416                 this.chain.push(
417                         function () {
418                                 obj.tree.pgt = obj.list.pgt;
419                                 obj.list.pgt = util.fm_utils.flatten_ou_branch( obj.tree.pgt );
420                                 obj.hash.pgt = util.functional.convert_object_list_to_hash( obj.list.pgt );
421                         }
422                 );
423
424                 // Do this after we get the user object
425                 this.chain.push(
426
427                         function() {
428
429                                 gen_fm_retrieval_func('my_aou', 
430                                         [ 
431                                                 api.FM_AOU_RETRIEVE_RELATED_VIA_SESSION.app,
432                                                 api.FM_AOU_RETRIEVE_RELATED_VIA_SESSION.method,
433                                                 [ obj.session.key, obj.list.au[0].ws_ou() ], /* use ws_ou and not home_ou */
434                                                 true
435                                         ]
436                                 )();
437                         }
438                 );
439
440                 this.chain.push(
441
442                         function () {
443
444                                 gen_fm_retrieval_func( 'my_actsc', 
445                                         [ 
446                                                 api.FM_ACTSC_RETRIEVE_VIA_AOU.app,
447                                                 api.FM_ACTSC_RETRIEVE_VIA_AOU.method,
448                                                 [ obj.session.key, obj.list.au[0].ws_ou() ],
449                                                 true
450                                         ]
451                                 )();
452                         }
453                 );
454
455                 this.chain.push(
456
457                         function () {
458
459                                 gen_fm_retrieval_func( 'my_asc', 
460                                         [ 
461                                                 api.FM_ASC_RETRIEVE_VIA_AOU.app,
462                                                 api.FM_ASC_RETRIEVE_VIA_AOU.method,
463                                                 [ obj.session.key, obj.list.au[0].ws_ou() ],
464                                                 true
465                                         ]
466                                 )();
467                         }
468                 );
469
470
471                 this.chain.push(
472                         function() {
473                                 var f = gen_fm_retrieval_func(
474                                         'cnct',
475                                         [
476                                                 api.FM_CNCT_RETRIEVE.app,
477                                                 api.FM_CNCT_RETRIEVE.method,
478                                                 [ obj.list.au[0].ws_ou() ], 
479                                                 false
480                                         ]
481                                 );
482                                 try {
483                                         f();
484                                 } catch(E) {
485                                         var error = 'Error: ' + js2JSON(E);
486                                         obj.error.sdump('D_ERROR',error);
487                                         throw(E);
488                                 }
489                         }
490                 );
491
492                 this.chain.push(
493                         function() {
494                                 var f = gen_fm_retrieval_func(
495                                         'acpl',
496                                         [
497                                                 api.FM_ACPL_RETRIEVE.app,
498                                                 api.FM_ACPL_RETRIEVE.method,
499                                                 [ obj.list.au[0].ws_ou() ],
500                                                 false
501                                         ]
502                                 );
503                                 try {
504                                         f();
505                                 } catch(E) {
506                                         var error = 'Error: ' + js2JSON(E);
507                                         obj.error.sdump('D_ERROR',error);
508                                         throw(E);
509                                 }
510                         }
511                 );
512
513
514
515                 if (typeof this.on_complete == 'function') {
516
517                         this.chain.push( this.on_complete );
518                 }
519                 JSAN.use('util.exec'); this.exec = new util.exec();
520                 this.exec.on_error = function(E) { 
521                 
522                         if (typeof obj.on_error == 'function') {
523                                 obj.on_error();
524                         } else {
525                                 alert('oops: ' + E ); 
526                         }
527
528                         return false; /* break chain */
529                 }
530
531                 this.exec.chain( this.chain );
532
533         }
534 }
535
536 dump('exiting OpenILS/data.js\n');