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                                     if (obj.lock_reload) {
 136                                         if (window.confirm( $('offlineStrings').getString('browser.reload.unsaved_data_warning') )) {
 137                                             obj.lock_reload = false;
 138                                             window.xulG.unlock_tab();
 139                                         } else {
 140                                             return;
 141                                         }
 142                                     }
 143                                     netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 144                                     var n = obj.getWebNavigation();
 145                                     n.reload( Components.interfaces.nsIWebNavigation.LOAD_FLAGS_NONE );
 146                                 } catch(E) {
 147                                     var err = 'cmd_reload: ' + E;
 148                                     obj.error.sdump('D_ERROR',err);
 149                                 }
 150                             }
 151                         ],
 152                         'cmd_find' : [
 153                             ['command'],
 154                             function() {
 155                                 var text = window.prompt('Enter text to find:');
 156                                 obj.find(text);
 157                             }
 158                         ]
 159                     }
 160                 }
 161             );
 162             obj.controller.render();
 163
 164             var browser_id = 'browser_browser'; if (obj.browser_id) browser_id = obj.browser_id;
 165             obj.controller.view.browser_browser = document.getElementById(browser_id);
 166
 167             obj.buildProgressListener();
 168             /*
 169             dump('obj.controller.view.browser_browser.addProgressListener = '
 170                 + obj.controller.view.browser_browser.addProgressListener + '\n');
 171             */
 172             obj.controller.view.browser_browser.addProgressListener(obj.progressListener,
 173                             Components.interfaces.nsIWebProgress.NOTIFY_ALL );
 174
 175             obj.controller.view.browser_browser.setAttribute('src',obj.url);
 176             //dump('browser url = ' + obj.url + '\n');
 177
 178             window.help_context_set_locally = true;
 179
 180         } catch(E) {
 181             this.error.sdump('D_ERROR','util.browser.init: ' + E + '\n');
 182         }
 183     },
 184
 185     'find' : function(text) {
 186         var obj = this;
 187         try {
 188             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 189
 190             function getBrowser() {
 191                 return obj.controller.view.browser_browser;
 192             }
 193
 194             function getFocusedSelCtrl() {
 195                 var ds = getBrowser().docShell;
 196                 var dsEnum = ds.getDocShellEnumerator(Components.interfaces.nsIDocShellTreeItem.typeContent,
 197                                                     Components.interfaces.nsIDocShell.ENUMERATE_FORWARDS);
 198                 while (dsEnum.hasMoreElements()) {
 199                     ds = dsEnum.getNext().QueryInterface(Components.interfaces.nsIDocShell);
 200                     if (ds.hasFocus) {
 201                         var display = ds.QueryInterface(Components.interfaces.nsIInterfaceRequestor).getInterface(Components.interfaces.nsISelectionDisplay);
 202                         if (!display) return null;
 203                         return display.QueryInterface(Components.interfaces.nsISelectionController);
 204                     }
 205                 }
 206
 207                 // One last try
 208                 return getBrowser().docShell
 209                     .QueryInterface(Components.interfaces.nsIInterfaceRequestor)
 210                     .getInterface(Components.interfaces.nsISelectionDisplay)
 211                     .QueryInterface(Components.interfaces.nsISelectionController);
 212             }
 213
 214             function setSelection(range) {
 215                 try {
 216                     var selctrlcomp = Components.interfaces.nsISelectionController;
 217                     var selctrl = getFocusedSelCtrl();
 218                     var sel = selctrl.getSelection(selctrlcomp.SELECTION_NORMAL);
 219                     sel.removeAllRanges();
 220                     sel.addRange(range.cloneRange());
 221
 222                     selctrl.scrollSelectionIntoView(selctrlcomp.SELECTION_NORMAL,
 223                         selctrlcomp.SELECTION_FOCUS_REGION,
 224                         true);
 225                 } catch(e) {alert("setSelection: " + e);}
 226             }
 227
 228             var doc = obj.get_content().document;
 229             var body = doc.body;
 230             var count = body.childNodes.length;
 231             var finder = Components.classes["@mozilla.org/embedcomp/rangefind;1"].createInstance()
 232                 .QueryInterface(Components.interfaces.nsIFind);
 233             var searchRange = doc.createRange();
 234             var startPt = doc.createRange();
 235             var endPt = doc.createRange();
 236                 searchRange.setStart(body,0);
 237                 searchRange.setEnd(body, count);
 238                 startPt.setStart(body, 0);
 239                 startPt.setEnd(body, 0);
 240                 endPt.setStart(body, count);
 241                 endPt.setEnd(body, count);
 242             var retRange = finder.Find(text, searchRange, startPt, endPt);
 243             dump('retRange = ' + retRange + '\n');
 244             setSelection(retRange);
 245         } catch(E) {
 246             alert('Error in browser.js, find(): ' + E);
 247         }
 248     },
 249
 250     'get_content' : function() {
 251         try {
 252             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 253             if (this.controller.view.browser_browser.contentWindow.wrappedJSObject) {
 254                 return this.controller.view.browser_browser.contentWindow.wrappedJSObject;
 255             } else {
 256                 return this.controller.view.browser_browser.contentWindow;
 257             }
 258         } catch(E) {
 259             this.error.sdump('D_ERROR','util.browser.get_content(): ' + E);
 260         }
 261     },
 262
 263     'push_variables' : function() {
 264         try {
 265             var obj = this;
 266             var s = '';
 267             try { s += obj.url + '\n' + obj.get_content().location.href + '\n'; } catch(E) { s+=E + '\n'; }
 268             if (!obj.push_xulG) return;
 269             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 270             var cw = this.get_content();
 271             cw.IAMXUL = true;
 272             cw.XUL_BUILD_ID = '/xul/server/'.split(/\//)[2];
 273             cw.xulG = obj.passthru_content_params || {};
 274             cw.xulG.fromBack = obj.from_back;
 275             if (!cw.xulG.set_tab) { cw.xulG.set_tab = function(a,b,c) { return window.xulG.set_tab(a,b,c); }; }
 276             if (!cw.xulG.new_tab) { cw.xulG.new_tab = function(a,b,c) { return window.xulG.new_tab(a,b,c); }; }
 277             if (!cw.xulG.close_tab) { cw.xulG.close_tab = function(a) { return window.xulG.close_tab(a); }; }
 278             if (!cw.xulG.lock_tab) {
 279                 cw.xulG.lock_tab = function() {
 280                     obj.lock_reload = true;
 281                     return window.xulG.lock_tab();
 282                 };
 283             }
 284             if (!cw.xulG.unlock_tab) {
 285                 cw.xulG.unlock_tab = function() {
 286                     obj.lock_reload = false;
 287                     return window.xulG.unlock_tab();
 288                 };
 289             }
 290             if (!cw.xulG.inspect_tab) { cw.xulG.inspect_tab = function() { return window.xulG.inspect_tab(); }; }
 291             if (!cw.xulG.new_patron_tab) { cw.xulG.new_patron_tab = function(a,b) { return window.xulG.new_patron_tab(a,b); }; }
 292             if (!cw.xulG.set_patron_tab) { cw.xulG.set_patron_tab = function(a,b) { return window.xulG.set_patron_tab(a,b); }; }
 293             if (!cw.xulG.volume_item_creator) { cw.xulG.volume_item_creator = function(a) { return window.xulG.volume_item_creator(a); }; }
 294             if (!cw.xulG.get_new_session) { cw.xulG.get_new_session = function(a) { return window.xulG.get_new_session(a); }; }
 295             if (!cw.xulG.holdings_maintenance_tab) { cw.xulG.holdings_maintenance_tab = function(a,b,c) { return window.xulG.holdings_maintenance_tab(a,b,c); }; }
 296             if (!cw.xulG.url_prefix) { cw.xulG.url_prefix = function(url,secure) { return window.xulG.url_prefix(url,secure); }; }
 297             if (!cw.xulG.urls) { cw.xulG.urls = window.urls; }
 298             try { s += ('******** cw = ' + cw + ' cw.xulG = ' + (cw.xulG) + '\n'); } catch(E) { s+=E + '\n'; }
 299             obj.error.sdump('D_BROWSER',s);
 300         } catch(E) {
 301             this.error.sdump('D_ERROR','util.browser.push_variables: ' + E + '\n');
 302         }
 303     },
 304
 305     'getWebNavigation' : function() {
 306         try {
 307             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 308             var wn = this.controller.view.browser_browser.webNavigation;
 309             var s = this.url + '\n' + this.get_content().location.href + '\n';
 310             s += ('getWebNavigation() = ' + wn + '\n');
 311             //this.error.sdump('D_BROWSER',s);
 312             return wn;
 313         } catch(E) {
 314             this.error.sdump('D_ERROR','util.browser.getWebNavigation(): ' + E );
 315         }
 316     },
 317
 318     'updateNavButtons' : function() {
 319         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 320         var obj = this;
 321         var s = obj.url + '\n' + obj.get_content().location.href + '\n';
 322         try {
 323             var n = obj.getWebNavigation();
 324             s += ('webNavigation = ' + n + '\n');
 325             s += ('webNavigation.canGoForward = ' + n.canGoForward + '\n');
 326             if (n.canGoForward) {
 327                 if (typeof obj.controller.view.cmd_forward != 'undefined') {
 328                     obj.controller.view.cmd_forward.disabled = false;
 329                     obj.controller.view.cmd_forward.setAttribute('disabled','false');
 330                 }
 331             } else {
 332                 if (typeof obj.controller.view.cmd_forward != 'undefined') {
 333                     obj.controller.view.cmd_forward.disabled = true;
 334                     obj.controller.view.cmd_forward.setAttribute('disabled','true');
 335                 }
 336             }
 337         } catch(E) {
 338             s += E + '\n';
 339         }
 340         try {
 341             var n = obj.getWebNavigation();
 342             s += ('webNavigation = ' + n + '\n');
 343             s += ('webNavigation.canGoBack = ' + n.canGoBack + '\n');
 344             if (n.canGoBack) {
 345                 if (typeof obj.controller.view.cmd_back != 'undefined') {
 346                     obj.controller.view.cmd_back.disabled = false;
 347                     obj.controller.view.cmd_back.setAttribute('disabled','false');
 348                 }
 349             } else {
 350                 if (typeof obj.controller.view.cmd_back != 'undefined') {
 351                     obj.controller.view.cmd_back.disabled = true;
 352                     obj.controller.view.cmd_back.setAttribute('disabled','true');
 353                 }
 354             }
 355         } catch(E) {
 356             s += E + '\n';
 357         }
 358         //this.error.sdump('D_BROWSER',s);
 359
 360         // Let's also update @protocol, @hostname, @port, and @pathname on the <help> widget
 361         if (xulG.set_help_context) {
 362             try {
 363                 var help_params = {
 364                     'protocol' : obj.get_content().location.protocol,
 365                     'hostname' : obj.get_content().location.hostname,
 366                     'port' : obj.get_content().location.port,
 367                     'pathname' : obj.get_content().location.pathname,
 368                     'src' : ''
 369                 };
 370                 xulG.set_help_context(help_params);
 371             } catch(E) {
 372                 dump('Error in browser.js, setting location on help widget: ' + E);
 373             }
 374         } else {
 375             dump(location.href + ': browser.js, updateNavButtons, xulG = ' + xulG + ' xulG.set_help_context = ' + xulG.set_help_context + '\n');
 376         }
 377     },
 378
 379     'buildProgressListener' : function() {
 380
 381         try {
 382             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 383
 384             var obj = this;
 385             obj.progressListener = {
 386                 onProgressChange    : function(webProgress,request,curSelfProgress,maxSelfProgress,curTotalProgress,maxTotalProgress){
 387                     try {
 388                         /*dump('browser.js onProgressChange('
 389                             +webProgress
 390                             +','+request
 391                             +','+curSelfProgress
 392                             +','+maxSelfProgress
 393                             +','+curTotalProgress
 394                             +','+maxTotalProgress+')\n');*/
 395                     } catch(E) {
 396                         dump('error in util.browser.progresslistener.onProgressChange: ' + E + '\n');
 397                     }
 398                 },
 399                 onLocationChange    : function(webProgress,request,uri){
 400                     try {
 401                         /*dump('browser.js onLocationChange('
 402                             +webProgress
 403                             +','+request
 404                             +','+uri+')\n');*/
 405                     } catch(E) {
 406                         dump('error in util.browser.progresslistener.onLocationChange: ' + E + '\n');
 407                     }
 408                 },
 409                 onStatusChange        : function(webProgress,request,status,message){
 410                     try {
 411                         /*dump('browser.js onStatusChange('
 412                             +webProgress+','
 413                             +request
 414                             +','+status
 415                             +','+message+')\n');*/
 416                     } catch(E) {
 417                         dump('error in util.browser.progresslistener.onStatusChange: ' + E + '\n');
 418                     }
 419                 },
 420                 onSecurityChange    : function(webProgress,request,state){
 421                     try {
 422                         /*dump('browser.js onSecurityChange('
 423                             +webProgress
 424                             +','+request
 425                             +','+state+')\n');*/
 426                     } catch(E) {
 427                         dump('error in util.browser.progresslistener.onSecurityChange: ' + E + '\n');
 428                     }
 429                 },
 430                 onStateChange         : function ( webProgress, request, stateFlags, status) {
 431                     try {
 432                         netscape.security.PrivilegeManager.enablePrivilege( "UniversalXPConnect" );
 433                         /*dump('browser.js onStateChange('
 434                             +webProgress
 435                             +','+request
 436                             +','+stateFlags
 437                             +','+status+')\n');*/
 438                         var s = obj.url + '\n' + obj.get_content().location.href + '\n';
 439                         const nsIWebProgressListener = Components.interfaces.nsIWebProgressListener;
 440                         const nsIChannel = Components.interfaces.nsIChannel;
 441                         ////// handle the throbber
 442                         var throbber = xulG.page_meter;
 443                         if (throbber) {
 444                             var busy = false;
 445                             if (!(stateFlags & nsIWebProgressListener.STATE_RESTORING)) {
 446                                 busy = true;
 447                                 throbber.on();
 448                             }
 449                             if (stateFlags & nsIWebProgressListener.STATE_STOP) {
 450                                 busy = false;
 451                                 setTimeout(
 452                                     function() {
 453                                         if (!busy) { throbber.off(); }
 454                                     }, 2000
 455                                 );
 456                             }
 457                         }
 458                         //////
 459                         if ( (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
 460                                 && stateFlags & nsIWebProgressListener.STATE_TRANSFERRING)
 461                             || (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
 462                                 && stateFlags & nsIWebProgressListener.STATE_START)
 463                             || (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
 464                                 && stateFlags & nsIWebProgressListener.STATE_STOP)
 465                             ) {
 466                             return;
 467                         }
 468                         s += ('onStateChange: stateFlags = ' + stateFlags + ' status = ' + status + '\n');
 469                         if (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST) {
 470                             s += ('\tSTATE_IS_REQUEST\n');
 471                         }
 472                         if (stateFlags & nsIWebProgressListener.STATE_IS_DOCUMENT) {
 473                             s += ('\tSTATE_IS_DOCUMENT\n');
 474                             if( stateFlags & nsIWebProgressListener.STATE_STOP ) {
 475                                 var alert_string = 'document has stopped: ' + new Date() + '\n'; dump(alert_string);
 476                                 try {
 477                                     obj.push_variables(); obj.updateNavButtons();
 478                                 } catch(E) {
 479                                     var err_msg = 'browser.js STATE_IS_DOCUMENT STATE_STOP error with push_variables or updateNavButtons: ' + E + '\n';
 480                                     dump(err_msg);
 481                                     obj.error.sdump('D_ERROR',err_msg);
 482                                 }
 483                                 if (typeof obj.on_url_load == 'function') {
 484                                     try {
 485                                         obj.error.sdump('D_TRACE','calling on_url_load');
 486                                         var helpers = {
 487                                             'doc_write' : function(html) {
 488                                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 489                                                 obj.get_content().document.write(html);
 490                                             },
 491                                             'doc_close' : function() {
 492                                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 493                                                 obj.get_content().document.close();
 494                                             }
 495                                         }
 496                                         obj.on_url_load( obj.controller.view.browser_browser, obj, helpers );
 497                                     } catch(E) {
 498                                         obj.error.sdump('D_ERROR','on_url_load: ' + E );
 499                                     }
 500                                 }
 501                                 if (obj.debug_label) {
 502                                     try {
 503                                         document.getElementById(obj.debug_label).setAttribute('tooltiptext','url: ' + obj.get_content().location.href);
 504                                     } catch(E) {
 505                                         obj.error.sdump('D_ERROR','on_url_load, debug_label: ' + E );
 506                                     }
 507                                 }
 508                             }
 509                         }
 510                         if (stateFlags & nsIWebProgressListener.STATE_IS_NETWORK) {
 511                             s += ('\tSTATE_IS_NETWORK\n');
 512                         }
 513                         if (stateFlags & nsIWebProgressListener.STATE_IS_WINDOW) {
 514                             s += ('\tSTATE_IS_WINDOW\n');
 515                         }
 516                         if (stateFlags & nsIWebProgressListener.STATE_START) {
 517                             s += ('\tSTATE_START\n');
 518                             obj.from_back = obj.back_button_clicked;
 519                             obj.back_button_clicked = false;
 520                         }
 521                         if (stateFlags & nsIWebProgressListener.STATE_REDIRECTING) {
 522                             s += ('\tSTATE_REDIRECTING\n');
 523                         }
 524                         if (stateFlags & nsIWebProgressListener.STATE_TRANSFERING) {
 525                             s += ('\tSTATE_TRANSFERING\n');
 526                         }
 527                         if (stateFlags & nsIWebProgressListener.STATE_NEGOTIATING) {
 528                             s += ('\tSTATE_NEGOTIATING\n');
 529                         }
 530                         if (stateFlags & nsIWebProgressListener.STATE_STOP) {
 531                             s += ('\tSTATE_STOP\n');
 532                         }
 533                         //obj.error.sdump('D_BROWSER',s);
 534                         if (throbber) { throbber.tooltip(s); }
 535                     } catch(E) {
 536                         dump('error in util.browser.progresslistener.onStateChange: ' + E + '\n');
 537                         obj.error.sdump('D_ERROR','util.browser.progresslistener.onstatechange: ' + (E));
 538                     }
 539                 }
 540             }
 541             obj.progressListener.QueryInterface = function(){return this;};
 542         } catch(E) {
 543             this.error.sdump('D_ERROR','util.browser.buildProgressListener: ' + E + '\n');
 544         }
 545     }
 546 }
 547
 548 dump('exiting util.browser.js\n');