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         '_debug_stash' : function() {
  54                 try {
  55                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
  56                         const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
  57                         var data_cache=new OpenILS( );
  58                         for (var i in data_cache.wrappedJSObject.OpenILS.prototype.data) {
  59                                 dump('_debug_stash ' + i + '\n');
  60                         }
  61                 } catch(E) {
  62                         this.error.sdump('D_ERROR','Error in OpenILS.data._debug_stash(): ' + js2JSON(E) );
  63                 }
  64         },
  65
  66         '_fm_objects' : {
  67
  68                 'pgt' : [ api.FM_PGT_RETRIEVE.app, api.FM_PGT_RETRIEVE.method, [], true ],
  69                 'cit' : [ api.FM_CIT_RETRIEVE.app, api.FM_CIT_RETRIEVE.method, [], true ],
  70                 'citm' : [ api.FM_CITM_RETRIEVE.app, api.FM_CITM_RETRIEVE.method, [], true ],
  71                 /*
  72                 'cst' : [ api.FM_CST_RETRIEVE.app, api.FM_CST_RETRIEVE.method, [], true ],
  73                 */
  74                 'acpl' : [ api.FM_ACPL_RETRIEVE.app, api.FM_ACPL_RETRIEVE.method, [], true ],
  75                 'ccs' : [ api.FM_CCS_RETRIEVE.app, api.FM_CCS_RETRIEVE.method, [], true ],
  76                 'aou' : [ api.FM_AOU_RETRIEVE.app, api.FM_AOU_RETRIEVE.method, [], true ],
  77                 'aout' : [ api.FM_AOUT_RETRIEVE.app, api.FM_AOUT_RETRIEVE.method, [], true ],
  78                 'crahp' : [ api.FM_CRAHP_RETRIEVE.app, api.FM_CRAHP_RETRIEVE.method, [], true ],
  79         },
  80
  81         'stash_retrieve' : function() {
  82                 try {
  83                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
  84                         const OpenILS=new Components.Constructor("@mozilla.org/openils_data_cache;1", "nsIOpenILS");
  85                         var data_cache=new OpenILS( );
  86                         var dc = data_cache.wrappedJSObject.OpenILS.prototype.data;
  87                         for (var i in dc) {
  88                                 this.error.sdump('D_DATA_RETRIEVE','Retrieving ' + i + ' : ' + dc[i] + '\n');
  89                                 this[i] = dc[i];
  90                         }
  91                         if (typeof this.on_complete == 'function') {
  92
  93                                 this.on_complete();
  94                         }
  95                 } catch(E) {
  96                         this.error.sdump('D_ERROR','Error in OpenILS.data._debug_stash(): ' + js2JSON(E) );
  97                 }
  98         },
  99
 100         'print_list_defaults' : function() {
 101                 var obj = this;
 102                 //if (typeof obj.print_list_templates == 'undefined') {
 103                 {
 104                         obj.print_list_types = [
 105                                 'offline_checkout',
 106                                 'offline_checkin',
 107                                 'offline_renew',
 108                                 'offline_inhouse_use',
 109                                 'items',
 110                                 'bills',
 111                                 'payment',
 112                                 'holds',
 113                                 /* 'patrons' */
 114                         ];
 115                         obj.print_list_templates = {
 116                                 'item_status' : {
 117                                         'type' : 'items',
 118                                         'header' : 'The following items have been examined:<hr/><ol>',
 119                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode%\r\n',
 120                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
 121                                 },
 122                                 'items_out' : {
 123                                         'type' : 'items',
 124                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>\r\nYou have the following items:<hr/><ol>',
 125                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode% Due: %due_date%\r\n',
 126                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME% %STAFF_LASTNAME%<br/>\r\n<br/>\r\n',
 127                                 },
 128                                 'checkout' : {
 129                                         'type' : 'items',
 130                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>\r\nYou checked out the following items:<hr/><ol>',
 131                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode% Due: %due_date%\r\n',
 132                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME% %STAFF_LASTNAME%<br/>\r\n<br/>\r\n',
 133                                 },
 134                                 'offline_checkout' : {
 135                                         'type' : 'offline_checkout',
 136                                         'header' : 'Patron %patron_barcode%<br/>\r\nYou checked out the following items:<hr/><ol>',
 137                                         'line_item' : '<li>Barcode: %barcode%<br/>\r\nDue: %due_date%\r\n',
 138                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
 139                                 },
 140                                 'checkin' : {
 141                                         'type' : 'items',
 142                                         'header' : 'You checked in the following items:<hr/><ol>',
 143                                         'line_item' : '<li>%title%<br/>\r\nBarcode: %barcode%  Call Number: %call_number%\r\n',
 144                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
 145                                 },
 146                                 'bill_payment' : {
 147                                         'type' : 'payment',
 148                                         '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>',
 149                                         'line_item' : 'Bill #%bill_id%  Received: $%payment%<br />',
 150                                         'footer' : '</blockquote> </p> <hr />%PINES_CODE% %TODAY_TRIM%<br/> <br/> ',
 151                                 },
 152                                 'bills_historical' : {
 153                                         'type' : 'bills',
 154                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>You had the following bills:<hr/><ol>',
 155                                         '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/>',
 156                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
 157                                 },
 158                                 'bills_current' : {
 159                                         'type' : 'bills',
 160                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>You have the following bills:<hr/><ol>',
 161                                         '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/>',
 162                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\n<br/>\r\n',
 163                                 },
 164                                 'offline_checkin' : {
 165                                         'type' : 'offline_checkin',
 166                                         'header' : 'You checked in the following items:<hr/><ol>',
 167                                         'line_item' : '<li>Barcode: %barcode%\r\n',
 168                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
 169                                 },
 170                                 'offline_renew' : {
 171                                         'type' : 'offline_renew',
 172                                         'header' : 'You renewed the following items:<hr/><ol>',
 173                                         'line_item' : '<li>Barcode: %barcode%\r\n',
 174                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
 175                                 },
 176                                 'offline_inhouse_use' : {
 177                                         'type' : 'offline_inhouse_use',
 178                                         'header' : 'You marked the following in-house items used:<hr/><ol>',
 179                                         'line_item' : '<li>Barcode: %barcode%\r\nUses: %count%',
 180                                         'footer' : '</ol><hr />%TODAY_TRIM%<br/>\r\n<br/>\r\n',
 181                                 },
 182                                 'holds' : {
 183                                         'type' : 'holds',
 184                                         'header' : 'Welcome %PATRON_FIRSTNAME%, to %LIBRARY%!<br/>\r\nYou have the following titles on hold:<hr/><ol>',
 185                                         'line_item' : '<li>%title%\r\n',
 186                                         'footer' : '</ol><hr />%PINES_CODE% %TODAY_TRIM%<br/>\r\nYou were helped by %STAFF_FIRSTNAME% %STAFF_LASTNAME%<br/>\r\n<br/>\r\n',
 187                                 }
 188                         };
 189
 190                         obj.stash( 'print_list_templates', 'print_list_types' );
 191                 }
 192         },
 193
 194         'network_retrieve' : function() {
 195                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 196                 var obj = this;
 197
 198
 199                 JSAN.use('util.file'); var file = new util.file('print_list_templates');
 200                 obj.print_list_defaults();
 201                 if (file._file.exists()) {
 202                         try {
 203                                 var x = file.get_object();
 204                                 if (x) {
 205                                         for (var i in x) {
 206                                                 obj.print_list_templates[i] = x[i];
 207                                         }
 208                                         obj.stash('print_list_templates');
 209                                 }
 210                         } catch(E) {
 211                                 alert(E);
 212                         }
 213                 }
 214                 file.close();
 215
 216                 JSAN.use('util.file');
 217                 JSAN.use('util.functional');
 218                 JSAN.use('util.fm_utils');
 219
 220                 function gen_fm_retrieval_func(classname,data) {
 221                         var app = data[0]; var method = data[1]; var params = data[2]; var cacheable = data[3];
 222                         return function () {
 223                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 224
 225                                 function convert() {
 226                                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 227                                         try {
 228                                                 if (obj.list[classname].constructor.name == 'Array') {
 229                                                         obj.hash[classname] =
 230                                                                 util.functional.convert_object_list_to_hash(
 231                                                                         obj.list[classname]
 232                                                                 );
 233                                                 }
 234                                         } catch(E) {
 235
 236                                                 obj.error.sdump('D_ERROR',E + '\n');
 237                                         }
 238
 239                                 }
 240
 241                                 try {
 242                                         var level = obj.error.sdump_levels.D_SES_RESULT;
 243                                         if (classname == 'aou' || classname == 'my_aou')
 244                                                 obj.error.sdump_levels.D_SES_RESULT = false;
 245                                         var robj = obj.network.request( app, method, params);
 246                                         if (!robj || robj.ilsevent) {
 247                                                 obj.error.standard_unexpected_error_alert('The staff client failed to retrieve expected data from this call, "' + method + '"',robj);
 248                                                 throw(robj);
 249                                         }
 250                                         obj.list[classname] = robj;
 251                                         obj.error.sdump_levels.D_SES_RESULT = level;
 252                                         convert();
 253                                         // if cacheable, store an offline copy
 254                                         /* FIXME -- we're going to revisit caching and do it differently
 255                                         if (cacheable) {
 256                                                 var file = new util.file( classname );
 257                                                 file.set_object( obj.list[classname] );
 258                                         }
 259                                         */
 260
 261                                 } catch(E) {
 262                                         // if cacheable, try offline
 263                                         if (cacheable) {
 264                                                 /* FIXME -- we're going to revisit caching and do it differently
 265                                                 try {
 266                                                         var file = new util.file( classname );
 267                                                         obj.list[classname] = file.get_object(); file.close();
 268                                                         convert();
 269                                                 } catch(E) {
 270                                                         throw(E);
 271                                                 }
 272                                                 */
 273                                                 throw(E); // for now
 274                                         } else {
 275                                                 throw(E); // for now
 276                                         }
 277                                 }
 278                         }
 279                 }
 280
 281                 this.chain = [];
 282
 283                 this.chain.push(
 284                         function() {
 285                                 var f = gen_fm_retrieval_func(
 286                                         'au',
 287                                         [
 288                                                 api.FM_AU_RETRIEVE_VIA_SESSION.app,
 289                                                 api.FM_AU_RETRIEVE_VIA_SESSION.method,
 290                                                 [ obj.session.key ],
 291                                                 false
 292                                         ]
 293                                 );
 294                                 try {
 295                                         f();
 296                                 } catch(E) {
 297                                         var error = 'Error: ' + js2JSON(E);
 298                                         obj.error.sdump('D_ERROR',error);
 299                                         throw(E);
 300                                 }
 301                                 obj.list.au = [ obj.list.au ];
 302                         }
 303                 );
 304
 305                 this.chain.push(
 306                         function() {
 307                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 308                                 var f = gen_fm_retrieval_func(
 309                                         'my_asv',
 310                                         [
 311                                                 api.FM_ASV_RETRIEVE_REQUIRED.app,
 312                                                 api.FM_ASV_RETRIEVE_REQUIRED.method,
 313                                                 [ obj.session.key ],
 314                                                 true
 315                                         ]
 316                                 );
 317                                 try {
 318                                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 319                                         f();
 320                                 } catch(E) {
 321                                         var error = 'Error: ' + js2JSON(E);
 322                                         obj.error.sdump('D_ERROR',error);
 323                                         throw(E);
 324                                 }
 325                         }
 326                 );
 327
 328                 this.chain.push(
 329                         function() {
 330                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 331                                 var f = gen_fm_retrieval_func(
 332                                         'asv',
 333                                         [
 334                                                 api.FM_ASV_RETRIEVE.app,
 335                                                 api.FM_ASV_RETRIEVE.method,
 336                                                 [ obj.session.key ],
 337                                                 true
 338                                         ]
 339                                 );
 340                                 try {
 341                                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 342                                         f();
 343                                 } catch(E) {
 344                                         var error = 'Error: ' + js2JSON(E);
 345                                         obj.error.sdump('D_ERROR',error);
 346                                         throw(E);
 347                                 }
 348                         }
 349                 );
 350
 351                 obj.error.sdump('D_DEBUG','_fm_objects = ' + js2JSON(this._fm_objects) + '\n');
 352
 353                 for (var i in this._fm_objects) {
 354                         this.chain.push( gen_fm_retrieval_func(i,this._fm_objects[i]) );
 355                 }
 356
 357                 // The previous org_tree call returned a tree, not a list or hash.
 358                 this.chain.push(
 359                         function () {
 360                                 obj.tree.aou = obj.list.aou;
 361                                 obj.list.aou = util.fm_utils.flatten_ou_branch( obj.tree.aou );
 362                                 obj.hash.aou = util.functional.convert_object_list_to_hash( obj.list.aou );
 363                         }
 364                 );
 365
 366                 // Do this after we get the user object
 367                 this.chain.push(
 368
 369                         function() {
 370
 371                                 gen_fm_retrieval_func('my_aou',
 372                                         [
 373                                                 api.FM_AOU_RETRIEVE_RELATED_VIA_SESSION.app,
 374                                                 api.FM_AOU_RETRIEVE_RELATED_VIA_SESSION.method,
 375                                                 [ obj.session.key, obj.list.au[0].ws_ou() ], /* use ws_ou and not home_ou */
 376                                                 true
 377                                         ]
 378                                 )();
 379                         }
 380                 );
 381
 382                 this.chain.push(
 383
 384                         function () {
 385
 386                                 gen_fm_retrieval_func( 'my_actsc',
 387                                         [
 388                                                 api.FM_ACTSC_RETRIEVE_VIA_AOU.app,
 389                                                 api.FM_ACTSC_RETRIEVE_VIA_AOU.method,
 390                                                 [ obj.session.key, obj.list.au[0].ws_ou() ],
 391                                                 true
 392                                         ]
 393                                 )();
 394                         }
 395                 );
 396
 397                 this.chain.push(
 398
 399                         function () {
 400
 401                                 gen_fm_retrieval_func( 'my_asc',
 402                                         [
 403                                                 api.FM_ASC_RETRIEVE_VIA_AOU.app,
 404                                                 api.FM_ASC_RETRIEVE_VIA_AOU.method,
 405                                                 [ obj.session.key, obj.list.au[0].ws_ou() ],
 406                                                 true
 407                                         ]
 408                                 )();
 409                         }
 410                 );
 411
 412
 413                 this.chain.push(
 414                         function() {
 415                                 var f = gen_fm_retrieval_func(
 416                                         'cnct',
 417                                         [
 418                                                 api.FM_CNCT_RETRIEVE.app,
 419                                                 api.FM_CNCT_RETRIEVE.method,
 420                                                 [ obj.list.au[0].ws_ou() ],
 421                                                 false
 422                                         ]
 423                                 );
 424                                 try {
 425                                         f();
 426                                 } catch(E) {
 427                                         var error = 'Error: ' + js2JSON(E);
 428                                         obj.error.sdump('D_ERROR',error);
 429                                         throw(E);
 430                                 }
 431                         }
 432                 );
 433
 434
 435                 if (typeof this.on_complete == 'function') {
 436
 437                         this.chain.push( this.on_complete );
 438                 }
 439                 JSAN.use('util.exec'); this.exec = new util.exec();
 440                 this.exec.on_error = function(E) {
 441
 442                         if (typeof obj.on_error == 'function') {
 443                                 obj.on_error();
 444                         } else {
 445                                 alert('oops: ' + E );
 446                         }
 447
 448                         return false; /* break chain */
 449                 }
 450
 451                 this.exec.chain( this.chain );
 452
 453         }
 454 }
 455
 456 dump('exiting OpenILS/data.js\n');