Open-ILS/xul/staff_client/chrome/content/util/print.js

   1 dump('entering util/print.js\n');
   2
   3 if (typeof util == 'undefined') util = {};
   4 util.print = function () {
   5
   6     netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
   7
   8     JSAN.use('util.error'); this.error = new util.error();
   9     JSAN.use('OpenILS.data'); this.data = new OpenILS.data(); this.data.init( { 'via':'stash' } );
  10     JSAN.use('util.window'); this.win = new util.window();
  11     JSAN.use('util.functional');
  12     JSAN.use('util.file');
  13
  14     return this;
  15 };
  16
  17 util.print.prototype = {
  18
  19     'reprint_last' : function() {
  20         try {
  21             var obj = this; obj.data.init({'via':'stash'});
  22             if (!obj.data.last_print) {
  23                 alert('Nothing to re-print');
  24                 return;
  25             }
  26             var msg = obj.data.last_print.msg;
  27             var params = obj.data.last_print.params; params.no_prompt = false;
  28             obj.simple( msg, params );
  29         } catch(E) {
  30             this.error.standard_unexpected_error_alert('util.print.reprint_last',E);
  31         }
  32     },
  33
  34     'simple' : function(msg,params) {
  35         try {
  36             if (!params) params = {};
  37
  38             var obj = this;
  39
  40             obj.data.last_print = { 'msg' : msg, 'params' : params}; obj.data.stash('last_print');
  41
  42             var silent = false;
  43             if ( params && params.no_prompt && (params.no_prompt == true || params.no_prompt == 'true') ) {
  44                 silent = true;
  45             }
  46
  47             var content_type;
  48             if (params && params.content_type) {
  49                 content_type = params.content_type;
  50             } else {
  51                 content_type = 'text/html';
  52             }
  53
  54             var w;
  55
  56             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
  57             obj.data.init({'via':'stash'});
  58
  59             if (params.print_strategy || obj.data.print_strategy) {
  60
  61                 switch(params.print_strategy || obj.data.print_strategy) {
  62                     case 'dos.print':
  63                         /* FIXME - this it a kludge.. we're going to sidestep window-based html rendering for printing */
  64                         /* I'm using regexps to mangle the html receipt templates; it'd be nice to use xsl but the */
  65                         /* templates aren't guaranteed to be valid xml */
  66                         if (content_type=='text/html') {
  67                             w = msg.replace(/<br.*?>/gi,'\r\n').replace(/<table.*?>/gi,'\r\n').replace(/<tr.*?>/gi,'\r\n').replace(/<hr.*?>/gi,'\r\n').replace(/<p.*?>/gi,'\r\n').replace(/<block.*?>/gi,'\r\n').replace(/<li.*?>/gi,'\r\n * ').replace(/<.+?>/gi,'');
  68                         } else {
  69                             w = msg;
  70                         }
  71                         if (! params.no_form_feed) { w = w + '\r\n\r\n\r\n\r\n\r\n\r\n\f'; }
  72                         obj.NSPrint(w, silent, params);
  73                         return;
  74                     break;
  75                 }
  76             }
  77
  78             switch(content_type) {
  79                 case 'text/html' :
  80                     var jsrc = 'data:text/javascript,' + window.escape('var params = { "data" : ' + js2JSON(params.data) + ', "list" : ' + js2JSON(params.list) + '}; function my_init() { if (typeof go_print == "function") { go_print(); } else { setTimeout( function() { if (typeof go_print == "function") { alert("Please tell the developers that the 2-second go_print workaround executed, and let them know whether this job printed successfully.  Thanks!"); go_print(); } else { alert("Please tell the developers that the 2-second go_print workaround did not work.  We will try to print one more time; there have been reports of wasted receipt paper at this point.  Please check the settings in the print dialog and/or prepare to power off your printer.  Thanks!"); window.print(); } }, 2000 ); } /* FIXME - mozilla bug#301560 - xpcom kills it too */ }');
  81                     w = obj.win.open('data:text/html,<html id="top"><head><script src="/xul/server/main/JSAN.js"></script><script src="' + window.escape(jsrc) + '"></script></head><body onload="try{my_init();}catch(E){alert(E);}">' + window.escape(msg) + '</body></html>','receipt_temp','chrome,resizable');
  82                     w.minimize();
  83                     w.go_print = function() {
  84                         try {
  85                             obj.NSPrint(w, silent, params);
  86                         } catch(E) {
  87                             obj.error.standard_unexpected_error_alert("Print Error in util.print.simple.  After this dialog we'll try a second print attempt. content_type = " + content_type,E);
  88                             w.print();
  89                         }
  90                         w.minimize(); w.close();
  91                     }
  92                 break;
  93                 default:
  94                     w = obj.win.open('data:' + content_type + ',' + window.escape(msg),'receipt_temp','chrome,resizable');
  95                     w.minimize();
  96                     setTimeout(
  97                         function() {
  98                             try {
  99                                 obj.NSPrint(w, silent, params);
 100                             } catch(E) {
 101                                 obj.error.standard_unexpected_error_alert("Print Error in util.print.simple.  After this dialog we'll try a second print attempt. content_type = " + content_type,E);
 102                                 w.print();
 103                             }
 104                             w.minimize(); w.close();
 105                         }, 1000
 106                     );
 107                 break;
 108             }
 109
 110         } catch(E) {
 111             this.error.standard_unexpected_error_alert('util.print.simple',E);
 112         }
 113     },
 114
 115     'tree_list' : function (params) {
 116         try {
 117             dump('print.tree_list.params.list = \n' + this.error.pretty_print(js2JSON(params.list)) + '\n');
 118             dump('print.tree_list.params.data = \n' + this.error.pretty_print(js2JSON(params.data)) + '\n');
 119         } catch(E) {
 120             dump(E+'\n');
 121         }
 122         var cols = [];
 123         var s = '';
 124         if (params.header) s += this.template_sub( params.header, cols, params );
 125         if (params.list) {
 126             for (var i = 0; i < params.list.length; i++) {
 127                 params.row = params.list[i];
 128                 params.row_idx = i;
 129                 s += this.template_sub( params.line_item, cols, params );
 130             }
 131         }
 132         if (params.footer) s += this.template_sub( params.footer, cols, params );
 133
 134         if (params.sample_frame) {
 135             var jsrc = 'data:text/javascript,' + window.escape('var params = { "data" : ' + js2JSON(params.data) + ', "list" : ' + js2JSON(params.list) + '};');
 136             params.sample_frame.setAttribute('src','data:text/html,<html id="top"><head><script src="' + window.escape(jsrc) + '"></script></head><body>' + window.escape(s) + '</body></html>');
 137         } else {
 138             this.simple(s,params);
 139         }
 140     },
 141
 142     'template_sub' : function( msg, cols, params ) {
 143         try {
 144             if (!msg) { dump('template sub called with empty string\n'); return; }
 145             JSAN.use('util.date');
 146             var s = msg; var b;
 147
 148             try{b = s; s = s.replace(/%LINE_NO%/,Number(params.row_idx)+1);}
 149                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 150
 151             try{b = s; s = s.replace(/%patron_barcode%/,params.patron_barcode);}
 152                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 153
 154             try{b = s; s = s.replace(/%LIBRARY%/,params.lib.name());}
 155                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 156             try{b = s; s = s.replace(/%PINES_CODE%/,params.lib.shortname());}
 157                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 158             try{b = s; s = s.replace(/%SHORTNAME%/,params.lib.shortname());}
 159                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 160             try{b = s; s = s.replace(/%STAFF_FIRSTNAME%/,params.staff.first_given_name());}
 161                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 162             try{b = s; s = s.replace(/%STAFF_LASTNAME%/,params.staff.family_name());}
 163                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 164             try{b = s; s = s.replace(/%STAFF_BARCODE%/,params.staff.barcode); }
 165                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 166             try{b = s; s = s.replace(/%STAFF_PROFILE%/,obj.data.hash.pgt[ params.staff.profile() ].name() ); }
 167                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 168             try{b = s; s = s.replace(/%PATRON_FIRSTNAME%/,params.patron.first_given_name());}
 169                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 170             try{b = s; s = s.replace(/%PATRON_LASTNAME%/,params.patron.family_name());}
 171                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 172             try{b = s; s = s.replace(/%PATRON_BARCODE%/,typeof params.patron.card() == 'object' ? params.patron.card().barcode() : util.functional.find_id_object_in_list( params.patron.cards(), params.patron.card() ).barcode() ) ;}
 173                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 174
 175             try{b = s; s=s.replace(/%TODAY%/g,(new Date()));}
 176                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 177             try{b = s; s=s.replace(/%TODAY_m%/g,(util.date.formatted_date(new Date(),'%m')));}
 178                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 179             try{b = s; s=s.replace(/%TODAY_TRIM%/g,(util.date.formatted_date(new Date(),'')));}
 180                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 181             try{b = s; s=s.replace(/%TODAY_d%/g,(util.date.formatted_date(new Date(),'%d')));}
 182                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 183             try{b = s; s=s.replace(/%TODAY_Y%/g,(util.date.formatted_date(new Date(),'%Y')));}
 184                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 185             try{b = s; s=s.replace(/%TODAY_H%/g,(util.date.formatted_date(new Date(),'%H')));}
 186                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 187             try{b = s; s=s.replace(/%TODAY_I%/g,(util.date.formatted_date(new Date(),'%I')));}
 188                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 189             try{b = s; s=s.replace(/%TODAY_M%/g,(util.date.formatted_date(new Date(),'%M')));}
 190                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 191             try{b = s; s=s.replace(/%TODAY_D%/g,(util.date.formatted_date(new Date(),'%D')));}
 192                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 193             try{b = s; s=s.replace(/%TODAY_F%/g,(util.date.formatted_date(new Date(),'%F')));}
 194                 catch(E){s = b; this.error.sdump('D_WARN','string = <' + s + '> error = ' + js2JSON(E)+'\n');}
 195
 196             try {
 197                 if (typeof params.row != 'undefined') {
 198                     if (params.row.length >= 0) {
 199                         alert('debug - please tell the developers that deprecated template code tried to execute');
 200                         for (var i = 0; i < cols.length; i++) {
 201                             var re = new RegExp(cols[i],"g");
 202                             try{b = s; s=s.replace(re, params.row[i]);}
 203                                 catch(E){s = b; this.error.standard_unexpected_error_alert('print.js, template_sub(): 1 string = <' + s + '>',E);}
 204                         }
 205                     } else {
 206                         /* for dump_with_keys */
 207                         for (var i in params.row) {
 208                             var re = new RegExp('%'+i+'%',"g");
 209                             try{b = s; s=s.replace(re, params.row[i]);}
 210                                 catch(E){s = b; this.error.standard_unexpected_error_alert('print.js, template_sub(): 2 string = <' + s + '>',E);}
 211                         }
 212                     }
 213                 }
 214
 215                 if (typeof params.data != 'undefined') {
 216                     for (var i in params.data) {
 217                         var re = new RegExp('%'+i+'%',"g");
 218                         if (typeof params.data[i] == 'string') {
 219                             try{b = s; s=s.replace(re, params.data[i]);}
 220                                 catch(E){s = b; this.error.standard_unexpected_error_alert('print.js, template_sub(): 3 string = <' + s + '>',E);}
 221                         }
 222                     }
 223                 }
 224             } catch(E) { dump(E+'\n'); }
 225
 226             return s;
 227         } catch(E) {
 228             alert('Error in print.js, template_sub(): ' + E);
 229         }
 230     },
 231
 232
 233     'NSPrint' : function(w,silent,params) {
 234         if (!w) w = window;
 235         var obj = this;
 236         try {
 237             if (!params) params = {};
 238
 239             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 240             obj.data.init({'via':'stash'});
 241
 242             if (params.print_strategy || obj.data.print_strategy) {
 243
 244                 switch(params.print_strategy || obj.data.print_strategy) {
 245                     case 'dos.print':
 246                         if (typeof w != 'string') {
 247                             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 248                             w.getSelection().selectAllChildren(w.document.firstChild);
 249                             w = w.getSelection().toString();
 250                         }
 251                         obj._NSPrint_dos_print(w,silent,params);
 252                     break;
 253                     case 'window.print':
 254                         w.print();
 255                     break;
 256                     case 'webBrowserPrint':
 257                         obj._NSPrint_webBrowserPrint(w,silent,params);
 258                     break;
 259                     default:
 260                         //w.print();
 261                         obj._NSPrint_webBrowserPrint(w,silent,params);
 262                     break;
 263                 }
 264
 265             } else {
 266                 //w.print();
 267                 obj._NSPrint_webBrowserPrint(w,silent,params);
 268             }
 269
 270         } catch (e) {
 271             alert('Probably not printing: ' + e);
 272             this.error.sdump('D_ERROR','PRINT EXCEPTION: ' + js2JSON(e) + '\n');
 273         }
 274
 275     },
 276
 277     '_NSPrint_dos_print' : function(w,silent,params) {
 278         var obj = this;
 279         try {
 280
 281             /* OLD way: This is a kludge/workaround.  webBrowserPrint doesn't always work.  So we're going to let
 282                 the html window handle our receipt template rendering, and then force a selection of all
 283                 the text nodes and dump that to a file, for printing through a dos utility */
 284
 285             /* NEW way: we just pass in the text */
 286
 287             var text = w;
 288
 289             var file = new util.file('receipt.txt');
 290             file.write_content('truncate',text);
 291             var path = file._file.path;
 292             file.close();
 293
 294             file = new util.file('receipt.bat');
 295             file.write_content('truncate+exec','#!/bin/sh\ncopy "' + path + '" lpt1 /b\nlpr ' + path + '\n');
 296             file.close();
 297             file = new util.file('receipt.bat');
 298
 299             var process = Components.classes["@mozilla.org/process/util;1"].createInstance(Components.interfaces.nsIProcess);
 300             process.init(file._file);
 301
 302             var args = [];
 303
 304             dump('process.run = ' + process.run(true, args, args.length) + '\n');
 305
 306             file.close();
 307
 308         } catch (e) {
 309             //alert('Probably not printing: ' + e);
 310             this.error.sdump('D_ERROR','_NSPrint_dos_print PRINT EXCEPTION: ' + js2JSON(e) + '\n');
 311         }
 312     },
 313
 314     '_NSPrint_webBrowserPrint' : function(w,silent,params) {
 315         var obj = this;
 316         try {
 317             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 318             var webBrowserPrint = w
 319                 .QueryInterface(Components.interfaces.nsIInterfaceRequestor)
 320                 .getInterface(Components.interfaces.nsIWebBrowserPrint);
 321             this.error.sdump('D_PRINT','webBrowserPrint = ' + webBrowserPrint);
 322             if (webBrowserPrint) {
 323                 var gPrintSettings = obj.GetPrintSettings();
 324                 if (silent) gPrintSettings.printSilent = true;
 325                 else gPrintSettings.printSilent = false;
 326                 if (params) {
 327                     if (params.marginLeft) gPrintSettings.marginLeft = params.marginLeft;
 328                 }
 329                 webBrowserPrint.print(gPrintSettings, null);
 330                 this.error.sdump('D_PRINT','Should be printing\n');
 331             } else {
 332                 this.error.sdump('D_ERROR','Should not be printing\n');
 333             }
 334         } catch (e) {
 335             //alert('Probably not printing: ' + e);
 336             // Pressing cancel is expressed as an NS_ERROR_ABORT return value,
 337             // causing an exception to be thrown which we catch here.
 338             // Unfortunately this will also consume helpful failures
 339             this.error.sdump('D_ERROR','_NSPrint_webBrowserPrint PRINT EXCEPTION: ' + js2JSON(e) + '\n');
 340         }
 341     },
 342
 343     'GetPrintSettings' : function() {
 344         try {
 345             //alert('entering GetPrintSettings');
 346             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 347             var pref = Components.classes["@mozilla.org/preferences-service;1"]
 348                 .getService(Components.interfaces.nsIPrefBranch);
 349             //alert('pref = ' + pref);
 350             if (pref) {
 351                 this.gPrintSettingsAreGlobal = pref.getBoolPref("print.use_global_printsettings", false);
 352                 this.gSavePrintSettings = pref.getBoolPref("print.save_print_settings", false);
 353                 //alert('gPrintSettingsAreGlobal = ' + this.gPrintSettingsAreGlobal + '  gSavePrintSettings = ' + this.gSavePrintSettings);
 354             }
 355
 356             var printService = Components.classes["@mozilla.org/gfx/printsettings-service;1"]
 357                 .getService(Components.interfaces.nsIPrintSettingsService);
 358             if (this.gPrintSettingsAreGlobal) {
 359                 this.gPrintSettings = printService.globalPrintSettings;
 360                 //alert('called setPrinterDefaultsForSelectedPrinter');
 361                 this.setPrinterDefaultsForSelectedPrinter(printService);
 362             } else {
 363                 this.gPrintSettings = printService.newPrintSettings;
 364                 //alert('used printService.newPrintSettings');
 365             }
 366         } catch (e) {
 367             this.error.sdump('D_ERROR',"GetPrintSettings() "+e+"\n");
 368             //alert("GetPrintSettings() "+e+"\n");
 369         }
 370
 371         return this.gPrintSettings;
 372     },
 373
 374     'setPrinterDefaultsForSelectedPrinter' : function (aPrintService) {
 375         try {
 376             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 377             if (this.gPrintSettings.printerName == "") {
 378                 this.gPrintSettings.printerName = aPrintService.defaultPrinterName;
 379                 //alert('used .defaultPrinterName');
 380             }
 381             //alert('printerName = ' + this.gPrintSettings.printerName);
 382
 383             // First get any defaults from the printer
 384             aPrintService.initPrintSettingsFromPrinter(this.gPrintSettings.printerName, this.gPrintSettings);
 385
 386             // now augment them with any values from last time
 387             aPrintService.initPrintSettingsFromPrefs(this.gPrintSettings, true, this.gPrintSettings.kInitSaveAll);
 388
 389             // now augment from our own saved settings if they exist
 390             this.load_settings();
 391
 392         } catch(E) {
 393             this.error.sdump('D_ERROR',"setPrinterDefaultsForSelectedPrinter() "+E+"\n");
 394         }
 395     },
 396
 397     'page_settings' : function() {
 398         try {
 399             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 400             this.GetPrintSettings();
 401             var PO = Components.classes["@mozilla.org/gfx/printsettings-service;1"].getService(Components.interfaces.nsIPrintOptions);
 402             PO.ShowPrintSetupDialog(this.gPrintSettings);
 403         } catch(E) {
 404             this.error.standard_unexpected_error_alert("page_settings()",E);
 405         }
 406     },
 407
 408     'load_settings' : function() {
 409         try {
 410             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 411             var file = new util.file('gPrintSettings');
 412             if (file._file.exists()) {
 413                 temp = file.get_object(); file.close();
 414                 for (var i in temp) {
 415                     this.gPrintSettings[i] = temp[i];
 416                 }
 417             } else {
 418                 this.gPrintSettings.marginTop = 0;
 419                 this.gPrintSettings.marginLeft = 0;
 420                 this.gPrintSettings.marginBottom = 0;
 421                 this.gPrintSettings.marginRight = 0;
 422                 this.gPrintSettings.headerStrLeft = '';
 423                 this.gPrintSettings.headerStrCenter = '';
 424                 this.gPrintSettings.headerStrRight = '';
 425                 this.gPrintSettings.footerStrLeft = '';
 426                 this.gPrintSettings.footerStrCenter = '';
 427                 this.gPrintSettings.footerStrRight = '';
 428             }
 429         } catch(E) {
 430             this.error.standard_unexpected_error_alert("load_settings()",E);
 431         }
 432     },
 433
 434     'save_settings' : function() {
 435         try {
 436             var obj = this;
 437             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 438             var file = new util.file('gPrintSettings');
 439             if (typeof obj.gPrintSettings == 'undefined') obj.GetPrintSettings();
 440             if (obj.gPrintSettings) file.set_object(obj.gPrintSettings);
 441             file.close();
 442         } catch(E) {
 443             this.error.standard_unexpected_error_alert("save_settings()",E);
 444         }
 445     }
 446 }
 447
 448 dump('exiting util/print.js\n');