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

   1 dump('entering util.browser.js\n');
   2
   3 if (typeof util == 'undefined') util = {};
   4 util.browser = function (params) {
   5     try {
   6         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
   7         JSAN.use('util.error'); this.error = new util.error();
   8     } catch(E) {
   9         dump('util.browser: ' + E + '\n');
  10     }
  11 }
  12
  13 util.browser.prototype = {
  14
  15     'lock_reload' : false, // as opposed to lock 'n load :)
  16
  17     'back_button_clicked' : false,
  18     'from_back' : false,
  19
  20     'init' : function( params ) {
  21
  22         try {
  23             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
  24
  25             var obj = this;
  26
  27             obj.url = params['url'];
  28             obj.push_xulG = params['push_xulG'];
  29             obj.html_source = params['html_source'];
  30             obj.browser_id = params['browser_id'];
  31             obj.debug_label = params['debug_label'];
  32             obj.passthru_content_params = params['passthru_content_params'];
  33             obj.on_url_load = params['on_url_load'];
  34             obj.printer_context = params['printer_context'] || 'default';
  35
  36             JSAN.use('util.controller'); obj.controller = new util.controller();
  37             obj.controller.init(
  38                 {
  39                     control_map : {
  40                         'cmd_broken' : [
  41                             ['command'],
  42                             function() { alert('Not Yet Implemented'); }
  43                         ],
  44                         'cmd_debug' : [
  45                             ['command'],
  46                             function() {
  47                                 var curr_url = obj.get_content().location.href;
  48                                 var url = window.prompt('Original URL: ' + obj.url + '\nCurrent URL: ' + curr_url + '\nEnter new URL:',curr_url);
  49                                 if (url) { obj.get_content().location.href = url; }
  50                             }
  51                         ],
  52                         'cmd_view_source' : [
  53                             ['command'],
  54                             function() {
  55                                 var curr_url = obj.get_content().location.href;
  56                                 //obj.get_content().location.href = 'view-source:' + curr_url; // This works too, but the openDialog below is more feature-rich
  57                                 window.openDialog("chrome://global/content/viewSource.xul", "", "all,dialog=no", curr_url);
  58                             }
  59                         ],
  60                         'cmd_print' : [
  61                             ['command'],
  62                             function() {
  63                                 try {
  64                                     netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
  65                                     var content = obj.get_content();
  66                                     JSAN.use('util.print'); var p = new util.print(obj.printer_context);
  67                                     var print_params = {};
  68                                     if (obj.html_source) {
  69                                         print_params.msg = obj.html_source;
  70                                         print_params.content_type = 'text/html';
  71                                     }
  72                                     if (typeof content.printable_output == 'function') {
  73                                         print_params.msg = content.printable_output();
  74                                         print_params.content_type = 'text/plain';
  75                                         content = print_params.msg;
  76                                     }
  77                                     JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.stash_retrieve();
  78                                     // Override the print strategy temporarily if it's not set or is equal to webBrowserPrint (which is buggy here)
  79                                     if (data.print_strategy) {
  80                                         if (data.print_strategy[obj.printer_context] || data.print_strategy['default']) {
  81                                             if (data.print_strategy[obj.printer_context]) {
  82                                                 if (data.print_strategy[obj.printer_context] == 'webBrowserPrint') {
  83                                                     print_params.print_strategy = 'window.print';
  84                                                 }
  85                                             } else {
  86                                                 if (data.print_strategy['default'] == 'webBrowserPrint') {
  87                                                     print_params.print_strategy = 'window.print';
  88                                                 }
  89                                             }
  90                                         } else {
  91                                             print_params.print_strategy = 'window.print';
  92                                         }
  93                                     } else {
  94                                         print_params.print_strategy = 'window.print';
  95                                     }
  96                                     p.NSPrint(content,false,print_params);
  97                                 } catch(E) {
  98                                     alert('browser.js, cmd_print exception: ' + E);
  99                                 }
 100                             }
 101                         ],
 102                         'cmd_forward' : [
 103                             ['command'],
 104                             function() {
 105                                 try {
 106                                     netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 107                                     var n = obj.getWebNavigation();
 108                                     if (n.canGoForward) n.goForward();
 109                                 } catch(E) {
 110                                     var err = 'cmd_forward: ' + E;
 111                                     obj.error.sdump('D_ERROR',err);
 112                                 }
 113                             }
 114                         ],
 115                         'cmd_back' : [
 116                             ['command'],
 117                             function() {
 118                                 try {
 119                                     netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 120                                     var n = obj.getWebNavigation();
 121                                     if (n.canGoBack) {
 122                                         obj.back_button_clicked = true;
 123                                         n.goBack();
 124                                     }
 125                                 } catch(E) {
 126                                     var err = 'cmd_back: ' + E;
 127                                     obj.error.sdump('D_ERROR',err);
 128                                 }
 129                             }
 130                         ],
 131                         'cmd_reload' : [
 132                             ['command'],
 133                             function() {
 134                                 try {
 135                                     obj.reload();
 136                                 } catch(E) {
 137                                     var err = 'cmd_reload: ' + E;
 138                                     obj.error.sdump('D_ERROR',err);
 139                                 }
 140                             }
 141                         ],
 142                         'cmd_find' : [
 143                             ['command'],
 144                             function() {
 145                                 var text = window.prompt('Enter text to find:');
 146                                 obj.find(text);
 147                             }
 148                         ]
 149                     }
 150                 }
 151             );
 152             obj.controller.render();
 153
 154             var browser_id = 'browser_browser'; if (obj.browser_id) browser_id = obj.browser_id;
 155             obj.controller.view.browser_browser = document.getElementById(browser_id);
 156
 157             obj.buildProgressListener();
 158             /*
 159             dump('obj.controller.view.browser_browser.addProgressListener = '
 160                 + obj.controller.view.browser_browser.addProgressListener + '\n');
 161             */
 162             obj.controller.view.browser_browser.addProgressListener(obj.progressListener,
 163                             Components.interfaces.nsIWebProgress.NOTIFY_ALL );
 164
 165             obj.controller.view.browser_browser.setAttribute('src',obj.url);
 166             //dump('browser url = ' + obj.url + '\n');
 167
 168             window.help_context_set_locally = true;
 169
 170         } catch(E) {
 171             this.error.sdump('D_ERROR','util.browser.init: ' + E + '\n');
 172         }
 173     },
 174
 175     'reload' : function() {
 176         var obj = this;
 177         if (obj.lock_reload) {
 178             if (window.confirm( $('offlineStrings').getString('browser.reload.unsaved_data_warning') )) {
 179                 obj.lock_reload = false;
 180                 window.xulG.unlock_tab();
 181             } else {
 182                 return;
 183             }
 184         }
 185         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 186         var n = obj.getWebNavigation();
 187         n.reload( Components.interfaces.nsIWebNavigation.LOAD_FLAGS_NONE );
 188     },
 189
 190     'find' : function(text) {
 191         var obj = this;
 192         try {
 193             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 194
 195             function getBrowser() {
 196                 return obj.controller.view.browser_browser;
 197             }
 198
 199             function getFocusedSelCtrl() {
 200                 var ds = getBrowser().docShell;
 201                 var dsEnum = ds.getDocShellEnumerator(Components.interfaces.nsIDocShellTreeItem.typeContent,
 202                                                     Components.interfaces.nsIDocShell.ENUMERATE_FORWARDS);
 203                 while (dsEnum.hasMoreElements()) {
 204                     ds = dsEnum.getNext().QueryInterface(Components.interfaces.nsIDocShell);
 205                     if (ds.hasFocus) {
 206                         var display = ds.QueryInterface(Components.interfaces.nsIInterfaceRequestor).getInterface(Components.interfaces.nsISelectionDisplay);
 207                         if (!display) return null;
 208                         return display.QueryInterface(Components.interfaces.nsISelectionController);
 209                     }
 210                 }
 211
 212                 // One last try
 213                 return getBrowser().docShell
 214                     .QueryInterface(Components.interfaces.nsIInterfaceRequestor)
 215                     .getInterface(Components.interfaces.nsISelectionDisplay)
 216                     .QueryInterface(Components.interfaces.nsISelectionController);
 217             }
 218
 219             function setSelection(range) {
 220                 try {
 221                     var selctrlcomp = Components.interfaces.nsISelectionController;
 222                     var selctrl = getFocusedSelCtrl();
 223                     var sel = selctrl.getSelection(selctrlcomp.SELECTION_NORMAL);
 224                     sel.removeAllRanges();
 225                     sel.addRange(range.cloneRange());
 226
 227                     selctrl.scrollSelectionIntoView(selctrlcomp.SELECTION_NORMAL,
 228                         selctrlcomp.SELECTION_FOCUS_REGION,
 229                         true);
 230                 } catch(e) {alert("setSelection: " + e);}
 231             }
 232
 233             var doc = obj.get_content().document;
 234             var body = doc.body;
 235             var count = body.childNodes.length;
 236             var finder = Components.classes["@mozilla.org/embedcomp/rangefind;1"].createInstance()
 237                 .QueryInterface(Components.interfaces.nsIFind);
 238             var searchRange = doc.createRange();
 239             var startPt = doc.createRange();
 240             var endPt = doc.createRange();
 241                 searchRange.setStart(body,0);
 242                 searchRange.setEnd(body, count);
 243                 startPt.setStart(body, 0);
 244                 startPt.setEnd(body, 0);
 245                 endPt.setStart(body, count);
 246                 endPt.setEnd(body, count);
 247             var retRange = finder.Find(text, searchRange, startPt, endPt);
 248             dump('retRange = ' + retRange + '\n');
 249             setSelection(retRange);
 250         } catch(E) {
 251             alert('Error in browser.js, find(): ' + E);
 252         }
 253     },
 254
 255     'get_content' : function() {
 256         try {
 257             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 258             if (this.controller.view.browser_browser.contentWindow.wrappedJSObject) {
 259                 return this.controller.view.browser_browser.contentWindow.wrappedJSObject;
 260             } else {
 261                 return this.controller.view.browser_browser.contentWindow;
 262             }
 263         } catch(E) {
 264             this.error.sdump('D_ERROR','util.browser.get_content(): ' + E);
 265         }
 266     },
 267
 268     'push_variables' : function() {
 269         try {
 270             var obj = this;
 271             var s = '';
 272             try { s += obj.url + '\n' + obj.get_content().location.href + '\n'; } catch(E) { s+=E + '\n'; }
 273             if (!obj.push_xulG) return;
 274             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 275             var cw = this.get_content();
 276             cw.IAMXUL = true;
 277             cw.XUL_BUILD_ID = '/xul/server/'.split(/\//)[2];
 278             cw.xulG = obj.passthru_content_params || {};
 279             cw.xulG.fromBack = obj.from_back;
 280             if (!cw.xulG.set_tab) { cw.xulG.set_tab = function(a,b,c) { return window.xulG.set_tab(a,b,c); }; }
 281             if (!cw.xulG.new_tab) { cw.xulG.new_tab = function(a,b,c) { return window.xulG.new_tab(a,b,c); }; }
 282             if (!cw.xulG.close_tab) { cw.xulG.close_tab = function(a) { return window.xulG.close_tab(a); }; }
 283             if (!cw.xulG.lock_tab) {
 284                 cw.xulG.lock_tab = function() {
 285                     obj.lock_reload = true;
 286                     return window.xulG.lock_tab();
 287                 };
 288             }
 289             if (!cw.xulG.unlock_tab) {
 290                 cw.xulG.unlock_tab = function() {
 291                     obj.lock_reload = false;
 292                     return window.xulG.unlock_tab();
 293                 };
 294             }
 295             if (!cw.xulG.inspect_tab) { cw.xulG.inspect_tab = function() { return window.xulG.inspect_tab(); }; }
 296             if (!cw.xulG.new_patron_tab) { cw.xulG.new_patron_tab = function(a,b) { return window.xulG.new_patron_tab(a,b); }; }
 297             if (!cw.xulG.set_patron_tab) { cw.xulG.set_patron_tab = function(a,b) { return window.xulG.set_patron_tab(a,b); }; }
 298             if (!cw.xulG.volume_item_creator) { cw.xulG.volume_item_creator = function(a) { return window.xulG.volume_item_creator(a); }; }
 299             if (!cw.xulG.get_new_session) { cw.xulG.get_new_session = function(a) { return window.xulG.get_new_session(a); }; }
 300             if (!cw.xulG.holdings_maintenance_tab) { cw.xulG.holdings_maintenance_tab = function(a,b,c) { return window.xulG.holdings_maintenance_tab(a,b,c); }; }
 301             if (!cw.xulG.url_prefix) { cw.xulG.url_prefix = function(url,secure) { return window.xulG.url_prefix(url,secure); }; }
 302             if (!cw.xulG.urls) { cw.xulG.urls = window.urls; }
 303             try { s += ('******** cw = ' + cw + ' cw.xulG = ' + (cw.xulG) + '\n'); } catch(E) { s+=E + '\n'; }
 304             obj.error.sdump('D_BROWSER',s);
 305         } catch(E) {
 306             this.error.sdump('D_ERROR','util.browser.push_variables: ' + E + '\n');
 307         }
 308     },
 309
 310     'getWebNavigation' : function() {
 311         try {
 312             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 313             var wn = this.controller.view.browser_browser.webNavigation;
 314             var s = this.url + '\n' + this.get_content().location.href + '\n';
 315             s += ('getWebNavigation() = ' + wn + '\n');
 316             //this.error.sdump('D_BROWSER',s);
 317             return wn;
 318         } catch(E) {
 319             this.error.sdump('D_ERROR','util.browser.getWebNavigation(): ' + E );
 320         }
 321     },
 322
 323     'updateNavButtons' : function() {
 324         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 325         var obj = this;
 326         var s = obj.url + '\n' + obj.get_content().location.href + '\n';
 327         try {
 328             var n = obj.getWebNavigation();
 329             s += ('webNavigation = ' + n + '\n');
 330             s += ('webNavigation.canGoForward = ' + n.canGoForward + '\n');
 331             if (n.canGoForward) {
 332                 if (typeof obj.controller.view.cmd_forward != 'undefined') {
 333                     obj.controller.view.cmd_forward.disabled = false;
 334                     obj.controller.view.cmd_forward.setAttribute('disabled','false');
 335                 }
 336             } else {
 337                 if (typeof obj.controller.view.cmd_forward != 'undefined') {
 338                     obj.controller.view.cmd_forward.disabled = true;
 339                     obj.controller.view.cmd_forward.setAttribute('disabled','true');
 340                 }
 341             }
 342         } catch(E) {
 343             s += E + '\n';
 344         }
 345         try {
 346             var n = obj.getWebNavigation();
 347             s += ('webNavigation = ' + n + '\n');
 348             s += ('webNavigation.canGoBack = ' + n.canGoBack + '\n');
 349             if (n.canGoBack) {
 350                 if (typeof obj.controller.view.cmd_back != 'undefined') {
 351                     obj.controller.view.cmd_back.disabled = false;
 352                     obj.controller.view.cmd_back.setAttribute('disabled','false');
 353                 }
 354             } else {
 355                 if (typeof obj.controller.view.cmd_back != 'undefined') {
 356                     obj.controller.view.cmd_back.disabled = true;
 357                     obj.controller.view.cmd_back.setAttribute('disabled','true');
 358                 }
 359             }
 360         } catch(E) {
 361             s += E + '\n';
 362         }
 363         //this.error.sdump('D_BROWSER',s);
 364
 365         // Let's also update @protocol, @hostname, @port, and @pathname on the <help> widget
 366         if (xulG.set_help_context) {
 367             try {
 368                 var help_params = {
 369                     'protocol' : obj.get_content().location.protocol,
 370                     'hostname' : obj.get_content().location.hostname,
 371                     'port' : obj.get_content().location.port,
 372                     'pathname' : obj.get_content().location.pathname,
 373                     'src' : ''
 374                 };
 375                 xulG.set_help_context(help_params);
 376             } catch(E) {
 377                 dump('Error in browser.js, setting location on help widget: ' + E);
 378             }
 379         } else {
 380             dump(location.href + ': browser.js, updateNavButtons, xulG = ' + xulG + ' xulG.set_help_context = ' + xulG.set_help_context + '\n');
 381         }
 382     },
 383
 384     'buildProgressListener' : function() {
 385
 386         try {
 387             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 388
 389             var obj = this;
 390             obj.progressListener = {
 391                 onProgressChange    : function(webProgress,request,curSelfProgress,maxSelfProgress,curTotalProgress,maxTotalProgress){
 392                     try {
 393                         /*dump('browser.js onProgressChange('
 394                             +webProgress
 395                             +','+request
 396                             +','+curSelfProgress
 397                             +','+maxSelfProgress
 398                             +','+curTotalProgress
 399                             +','+maxTotalProgress+')\n');*/
 400                     } catch(E) {
 401                         dump('error in util.browser.progresslistener.onProgressChange: ' + E + '\n');
 402                     }
 403                 },
 404                 onLocationChange    : function(webProgress,request,uri){
 405                     try {
 406                         /*dump('browser.js onLocationChange('
 407                             +webProgress
 408                             +','+request
 409                             +','+uri+')\n');*/
 410                     } catch(E) {
 411                         dump('error in util.browser.progresslistener.onLocationChange: ' + E + '\n');
 412                     }
 413                 },
 414                 onStatusChange        : function(webProgress,request,status,message){
 415                     try {
 416                         /*dump('browser.js onStatusChange('
 417                             +webProgress+','
 418                             +request
 419                             +','+status
 420                             +','+message+')\n');*/
 421                     } catch(E) {
 422                         dump('error in util.browser.progresslistener.onStatusChange: ' + E + '\n');
 423                     }
 424                 },
 425                 onSecurityChange    : function(webProgress,request,state){
 426                     try {
 427                         /*dump('browser.js onSecurityChange('
 428                             +webProgress
 429                             +','+request
 430                             +','+state+')\n');*/
 431                     } catch(E) {
 432                         dump('error in util.browser.progresslistener.onSecurityChange: ' + E + '\n');
 433                     }
 434                 },
 435                 onStateChange         : function ( webProgress, request, stateFlags, status) {
 436                     try {
 437                         netscape.security.PrivilegeManager.enablePrivilege( "UniversalXPConnect" );
 438                         /*dump('browser.js onStateChange('
 439                             +webProgress
 440                             +','+request
 441                             +','+stateFlags
 442                             +','+status+')\n');*/
 443                         var s = obj.url + '\n' + obj.get_content().location.href + '\n';
 444                         const nsIWebProgressListener = Components.interfaces.nsIWebProgressListener;
 445                         const nsIChannel = Components.interfaces.nsIChannel;
 446                         ////// handle the throbber
 447                         var throbber = xulG.page_meter;
 448                         if (throbber) {
 449                             var busy = false;
 450                             if (!(stateFlags & nsIWebProgressListener.STATE_RESTORING)) {
 451                                 busy = true;
 452                                 throbber.on();
 453                             }
 454                             if (stateFlags & nsIWebProgressListener.STATE_STOP) {
 455                                 busy = false;
 456                                 setTimeout(
 457                                     function() {
 458                                         if (!busy) { throbber.off(); }
 459                                     }, 2000
 460                                 );
 461                             }
 462                         }
 463                         //////
 464                         if ( (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
 465                                 && stateFlags & nsIWebProgressListener.STATE_TRANSFERRING)
 466                             || (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
 467                                 && stateFlags & nsIWebProgressListener.STATE_START)
 468                             || (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
 469                                 && stateFlags & nsIWebProgressListener.STATE_STOP)
 470                             ) {
 471                             return;
 472                         }
 473                         s += ('onStateChange: stateFlags = ' + stateFlags + ' status = ' + status + '\n');
 474                         if (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST) {
 475                             s += ('\tSTATE_IS_REQUEST\n');
 476                         }
 477                         if (stateFlags & nsIWebProgressListener.STATE_IS_DOCUMENT) {
 478                             s += ('\tSTATE_IS_DOCUMENT\n');
 479                             if( stateFlags & nsIWebProgressListener.STATE_STOP ) {
 480                                 var alert_string = 'document has stopped: ' + new Date() + '\n'; dump(alert_string);
 481                                 try {
 482                                     obj.push_variables(); obj.updateNavButtons();
 483                                 } catch(E) {
 484                                     var err_msg = 'browser.js STATE_IS_DOCUMENT STATE_STOP error with push_variables or updateNavButtons: ' + E + '\n';
 485                                     dump(err_msg);
 486                                     obj.error.sdump('D_ERROR',err_msg);
 487                                 }
 488                                 if (typeof obj.on_url_load == 'function') {
 489                                     try {
 490                                         obj.error.sdump('D_TRACE','calling on_url_load');
 491                                         var helpers = {
 492                                             'doc_write' : function(html) {
 493                                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 494                                                 obj.get_content().document.write(html);
 495                                             },
 496                                             'doc_close' : function() {
 497                                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 498                                                 obj.get_content().document.close();
 499                                             }
 500                                         }
 501                                         obj.on_url_load( obj.controller.view.browser_browser, obj, helpers );
 502                                     } catch(E) {
 503                                         obj.error.sdump('D_ERROR','on_url_load: ' + E );
 504                                     }
 505                                 }
 506                                 if (obj.debug_label) {
 507                                     try {
 508                                         document.getElementById(obj.debug_label).setAttribute('tooltiptext','url: ' + obj.get_content().location.href);
 509                                     } catch(E) {
 510                                         obj.error.sdump('D_ERROR','on_url_load, debug_label: ' + E );
 511                                     }
 512                                 }
 513                             }
 514                         }
 515                         if (stateFlags & nsIWebProgressListener.STATE_IS_NETWORK) {
 516                             s += ('\tSTATE_IS_NETWORK\n');
 517                         }
 518                         if (stateFlags & nsIWebProgressListener.STATE_IS_WINDOW) {
 519                             s += ('\tSTATE_IS_WINDOW\n');
 520                         }
 521                         if (stateFlags & nsIWebProgressListener.STATE_START) {
 522                             s += ('\tSTATE_START\n');
 523                             obj.from_back = obj.back_button_clicked;
 524                             obj.back_button_clicked = false;
 525                         }
 526                         if (stateFlags & nsIWebProgressListener.STATE_REDIRECTING) {
 527                             s += ('\tSTATE_REDIRECTING\n');
 528                         }
 529                         if (stateFlags & nsIWebProgressListener.STATE_TRANSFERING) {
 530                             s += ('\tSTATE_TRANSFERING\n');
 531                         }
 532                         if (stateFlags & nsIWebProgressListener.STATE_NEGOTIATING) {
 533                             s += ('\tSTATE_NEGOTIATING\n');
 534                         }
 535                         if (stateFlags & nsIWebProgressListener.STATE_STOP) {
 536                             s += ('\tSTATE_STOP\n');
 537                         }
 538                         //obj.error.sdump('D_BROWSER',s);
 539                         if (throbber) { throbber.tooltip(s); }
 540                     } catch(E) {
 541                         dump('error in util.browser.progresslistener.onStateChange: ' + E + '\n');
 542                         obj.error.sdump('D_ERROR','util.browser.progresslistener.onstatechange: ' + (E));
 543                     }
 544                 }
 545             }
 546             obj.progressListener.QueryInterface = function(){return this;};
 547         } catch(E) {
 548             this.error.sdump('D_ERROR','util.browser.buildProgressListener: ' + E + '\n');
 549         }
 550     }
 551 }
 552
 553 dump('exiting util.browser.js\n');