]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/xul/staff_client/chrome/content/util/browser.js
88c0fe331d6ee656193fa17b7466cb1f8a20d603
[working/Evergreen.git] / 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.is_tab_locked) { cw.xulG.is_tab_locked = function() { return window.xulG.is_tab_locked(); }; }
297             if (!cw.xulG.new_patron_tab) { cw.xulG.new_patron_tab = function(a,b) { return window.xulG.new_patron_tab(a,b); }; }
298             if (!cw.xulG.set_patron_tab) { cw.xulG.set_patron_tab = function(a,b) { return window.xulG.set_patron_tab(a,b); }; }
299             if (!cw.xulG.volume_item_creator) { cw.xulG.volume_item_creator = function(a) { return window.xulG.volume_item_creator(a); }; }
300             if (!cw.xulG.get_new_session) { cw.xulG.get_new_session = function(a) { return window.xulG.get_new_session(a); }; }
301             if (!cw.xulG.holdings_maintenance_tab) { cw.xulG.holdings_maintenance_tab = function(a,b,c) { return window.xulG.holdings_maintenance_tab(a,b,c); }; }
302             if (!cw.xulG.url_prefix) { cw.xulG.url_prefix = function(url,secure) { return window.xulG.url_prefix(url,secure); }; }
303             if (!cw.xulG.urls) { cw.xulG.urls = window.urls; }
304             try { s += ('******** cw = ' + cw + ' cw.xulG = ' + (cw.xulG) + '\n'); } catch(E) { s+=E + '\n'; }
305             obj.error.sdump('D_BROWSER',s);
306         } catch(E) {
307             this.error.sdump('D_ERROR','util.browser.push_variables: ' + E + '\n');
308         }
309     },
310
311     'getWebNavigation' : function() {
312         try {
313             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
314             var wn = this.controller.view.browser_browser.webNavigation;
315             var s = this.url + '\n' + this.get_content().location.href + '\n';
316             s += ('getWebNavigation() = ' + wn + '\n');
317             //this.error.sdump('D_BROWSER',s);
318             return wn;
319         } catch(E) {
320             this.error.sdump('D_ERROR','util.browser.getWebNavigation(): ' + E );
321         }
322     },
323
324     'updateNavButtons' : function() {
325         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
326         var obj = this; 
327         var s = obj.url + '\n' + obj.get_content().location.href + '\n';
328         try {
329             var n = obj.getWebNavigation();
330             s += ('webNavigation = ' + n + '\n');
331             s += ('webNavigation.canGoForward = ' + n.canGoForward + '\n');
332             if (n.canGoForward) {
333                 if (typeof obj.controller.view.cmd_forward != 'undefined') {
334                     obj.controller.view.cmd_forward.disabled = false;
335                     obj.controller.view.cmd_forward.setAttribute('disabled','false');
336                 }
337             } else {
338                 if (typeof obj.controller.view.cmd_forward != 'undefined') {
339                     obj.controller.view.cmd_forward.disabled = true;
340                     obj.controller.view.cmd_forward.setAttribute('disabled','true');
341                 }
342             }
343         } catch(E) {
344             s += E + '\n';
345         }
346         try {
347             var n = obj.getWebNavigation();
348             s += ('webNavigation = ' + n + '\n');
349             s += ('webNavigation.canGoBack = ' + n.canGoBack + '\n');
350             if (n.canGoBack) {
351                 if (typeof obj.controller.view.cmd_back != 'undefined') {
352                     obj.controller.view.cmd_back.disabled = false;
353                     obj.controller.view.cmd_back.setAttribute('disabled','false');
354                 }
355             } else {
356                 if (typeof obj.controller.view.cmd_back != 'undefined') {
357                     obj.controller.view.cmd_back.disabled = true;
358                     obj.controller.view.cmd_back.setAttribute('disabled','true');
359                 }
360             }
361         } catch(E) {
362             s += E + '\n';
363         }
364         //this.error.sdump('D_BROWSER',s);
365
366         // Let's also update @protocol, @hostname, @port, and @pathname on the <help> widget
367         if (xulG.set_help_context) {
368             try {
369                 var help_params = {
370                     'protocol' : obj.get_content().location.protocol,
371                     'hostname' : obj.get_content().location.hostname,
372                     'port' : obj.get_content().location.port,
373                     'pathname' : obj.get_content().location.pathname,
374                     'src' : ''
375                 };
376                 xulG.set_help_context(help_params);
377             } catch(E) {
378                 dump('Error in browser.js, setting location on help widget: ' + E);
379             }
380         } else {
381             dump(location.href + ': browser.js, updateNavButtons, xulG = ' + xulG + ' xulG.set_help_context = ' + xulG.set_help_context + '\n');
382         }
383     },
384
385     'buildProgressListener' : function() {
386
387         try {
388             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
389
390             var obj = this;
391             obj.progressListener = {
392                 onProgressChange    : function(webProgress,request,curSelfProgress,maxSelfProgress,curTotalProgress,maxTotalProgress){
393                     try {
394                         /*dump('browser.js onProgressChange('
395                             +webProgress
396                             +','+request
397                             +','+curSelfProgress
398                             +','+maxSelfProgress
399                             +','+curTotalProgress
400                             +','+maxTotalProgress+')\n');*/
401                     } catch(E) {
402                         dump('error in util.browser.progresslistener.onProgressChange: ' + E + '\n');
403                     }
404                 },
405                 onLocationChange    : function(webProgress,request,uri){
406                     try {
407                         /*dump('browser.js onLocationChange('
408                             +webProgress
409                             +','+request
410                             +','+uri+')\n');*/
411                     } catch(E) {
412                         dump('error in util.browser.progresslistener.onLocationChange: ' + E + '\n');
413                     }
414                 },
415                 onStatusChange        : function(webProgress,request,status,message){
416                     try {
417                         /*dump('browser.js onStatusChange('
418                             +webProgress+','
419                             +request
420                             +','+status
421                             +','+message+')\n');*/
422                     } catch(E) {
423                         dump('error in util.browser.progresslistener.onStatusChange: ' + E + '\n');
424                     }
425                 },
426                 onSecurityChange    : function(webProgress,request,state){
427                     try {
428                         /*dump('browser.js onSecurityChange('
429                             +webProgress
430                             +','+request
431                             +','+state+')\n');*/
432                     } catch(E) {
433                         dump('error in util.browser.progresslistener.onSecurityChange: ' + E + '\n');
434                     }
435                 },
436                 onStateChange         : function ( webProgress, request, stateFlags, status) {
437                     try {
438                         netscape.security.PrivilegeManager.enablePrivilege( "UniversalXPConnect" );
439                         /*dump('browser.js onStateChange('
440                             +webProgress
441                             +','+request
442                             +','+stateFlags
443                             +','+status+')\n');*/
444                         var s = obj.url + '\n' + obj.get_content().location.href + '\n';
445                         const nsIWebProgressListener = Components.interfaces.nsIWebProgressListener;
446                         const nsIChannel = Components.interfaces.nsIChannel;
447                         ////// handle the throbber
448                         var throbber = xulG.page_meter;
449                         if (throbber) {
450                             var busy = false;
451                             if (!(stateFlags & nsIWebProgressListener.STATE_RESTORING)) {
452                                 busy = true;
453                                 throbber.on();
454                             }
455                             if (stateFlags & nsIWebProgressListener.STATE_STOP) {
456                                 busy = false;
457                                 setTimeout(
458                                     function() {
459                                         if (!busy) { throbber.off(); }
460                                     }, 2000
461                                 );
462                             }
463                         }
464                         //////
465                         if ( (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
466                                 && stateFlags & nsIWebProgressListener.STATE_TRANSFERRING)
467                             || (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
468                                 && stateFlags & nsIWebProgressListener.STATE_START)
469                             || (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST
470                                 && stateFlags & nsIWebProgressListener.STATE_STOP)
471                             ) {
472                             return;
473                         }
474                         s += ('onStateChange: stateFlags = ' + stateFlags + ' status = ' + status + '\n');
475                         if (stateFlags & nsIWebProgressListener.STATE_IS_REQUEST) {
476                             s += ('\tSTATE_IS_REQUEST\n');
477                         }
478                         if (stateFlags & nsIWebProgressListener.STATE_IS_DOCUMENT) {
479                             s += ('\tSTATE_IS_DOCUMENT\n');
480                             if( stateFlags & nsIWebProgressListener.STATE_STOP ) {
481                                 var alert_string = 'document has stopped: ' + new Date() + '\n'; dump(alert_string);
482                                 try {
483                                     obj.push_variables(); obj.updateNavButtons();
484                                 } catch(E) {
485                                     var err_msg = 'browser.js STATE_IS_DOCUMENT STATE_STOP error with push_variables or updateNavButtons: ' + E + '\n';
486                                     dump(err_msg);
487                                     obj.error.sdump('D_ERROR',err_msg);
488                                 }
489                                 if (typeof obj.on_url_load == 'function') {
490                                     try {
491                                         obj.error.sdump('D_TRACE','calling on_url_load');
492                                         var helpers = {
493                                             'doc_write' : function(html) {
494                                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
495                                                 obj.get_content().document.write(html);
496                                             },
497                                             'doc_close' : function() {
498                                                 netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
499                                                 obj.get_content().document.close();
500                                             }
501                                         }
502                                         obj.on_url_load( obj.controller.view.browser_browser, obj, helpers );
503                                     } catch(E) {
504                                         obj.error.sdump('D_ERROR','on_url_load: ' + E );
505                                     }
506                                 }
507                                 if (obj.debug_label) {
508                                     try {
509                                         document.getElementById(obj.debug_label).setAttribute('tooltiptext','url: ' + obj.get_content().location.href);
510                                     } catch(E) {
511                                         obj.error.sdump('D_ERROR','on_url_load, debug_label: ' + E );
512                                     }
513                                 }
514                             }
515                         }
516                         if (stateFlags & nsIWebProgressListener.STATE_IS_NETWORK) {
517                             s += ('\tSTATE_IS_NETWORK\n');
518                         }
519                         if (stateFlags & nsIWebProgressListener.STATE_IS_WINDOW) {
520                             s += ('\tSTATE_IS_WINDOW\n');
521                         }
522                         if (stateFlags & nsIWebProgressListener.STATE_START) {
523                             s += ('\tSTATE_START\n');
524                             obj.from_back = obj.back_button_clicked;
525                             obj.back_button_clicked = false;
526                         }
527                         if (stateFlags & nsIWebProgressListener.STATE_REDIRECTING) {
528                             s += ('\tSTATE_REDIRECTING\n');
529                         }
530                         if (stateFlags & nsIWebProgressListener.STATE_TRANSFERING) {
531                             s += ('\tSTATE_TRANSFERING\n');
532                         }
533                         if (stateFlags & nsIWebProgressListener.STATE_NEGOTIATING) {
534                             s += ('\tSTATE_NEGOTIATING\n');
535                         }
536                         if (stateFlags & nsIWebProgressListener.STATE_STOP) {
537                             s += ('\tSTATE_STOP\n');
538                         }
539                         //obj.error.sdump('D_BROWSER',s);    
540                         if (throbber) { throbber.tooltip(s); }
541                     } catch(E) {
542                         dump('error in util.browser.progresslistener.onStateChange: ' + E + '\n');
543                         obj.error.sdump('D_ERROR','util.browser.progresslistener.onstatechange: ' + (E));
544                     }
545                 }
546             }
547             obj.progressListener.QueryInterface = function(){return this;};
548         } catch(E) {
549             this.error.sdump('D_ERROR','util.browser.buildProgressListener: ' + E + '\n');
550         }
551     }
552 }
553
554 dump('exiting util.browser.js\n');