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