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