]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/xul/staff_client/chrome/content/OpenILS/global_util.js
Merge branch 'opac-tt-poc' of git+ssh://yeti.esilibrary.com/home/evergreen/evergreen...
[working/Evergreen.git] / Open-ILS / xul / staff_client / chrome / content / OpenILS / global_util.js
1     function $(id) { return document.getElementById(id); }
2
3     function oils_unsaved_data_V() {
4         JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.stash_retrieve();
5         data.stash_retrieve();
6         if (typeof data.unsaved_data == 'undefined') { data.unsaved_data = 0; }
7         data.unsaved_data++;
8         window.oils_lock++;
9         data.stash('unsaved_data');
10         dump('\n=-=-=-=-=\n');
11         dump('oils_unsaved_data_V for ' + location.href + '\n');
12         dump('incrementing window.oils_lock\n');
13         dump('incrementing data.unsaved_data\n');
14         dump('\twindow.oils_lock == ' + window.oils_lock + '\n');
15         dump('\tdata.unsaved_data == ' + data.unsaved_data + '\n');
16     }
17
18     function oils_unsaved_data_P(count) {
19         dump('\n=-=-=-=-=\n');
20         dump('oils_unsaved_data_P for ' + location.href + '\n');
21         if (!count) { count = 1; }
22         dump('decrementing window.oils_lock by ' + count + '\n');
23         window.oils_lock -= count;
24         if (window.oils_lock < 0) { window.oils_lock = 0; }
25         JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.stash_retrieve();
26         data.stash_retrieve();
27         if (typeof data.unsaved_data == 'undefined') { data.unsaved_data = 0; }
28         dump('decrementing data.unsaved_data by ' + count + '\n');
29         data.unsaved_data -= count;
30         if (data.unsaved_data < 0) { data.unsaved_data = 0; }
31         data.stash('unsaved_data');
32         dump('\twindow.oils_lock == ' + window.oils_lock + '\n');
33         dump('\tdata.unsaved_data == ' + data.unsaved_data + '\n');
34     }
35
36     function oils_lock_page(params) {
37         dump('\n=-=-=-=-=\n');
38         dump('oils_lock_page for ' + location.href + '\n');
39         if (!params) { params = {}; }
40         if (window.oils_lock > 0) {
41             if (!params.allow_multiple_locks) {
42                 return window.oils_lock;
43             }
44         }
45         if (typeof xulG != 'undefined') {
46             if (typeof xulG.unlock_tab == 'function') {
47                 dump('\twith xulG.lock_tab\n');
48                 xulG.lock_tab();
49                 window.oils_lock++; // different window scope than the chrome of xulG.lock_tab
50             } else {
51                 dump('\twithout xulG.lock_tab\n');
52                 oils_unsaved_data_V();
53             }
54         } else {
55             dump('\twithout xulG.lock_tab\n');
56             oils_unsaved_data_V();
57         }
58         return window.oils_lock;
59     }
60
61     function oils_unlock_page(params) {
62         dump('\n=-=-=-=-=\n');
63         dump('oils_unlock_page for ' + location.href + '\n');
64         if (typeof xulG != 'undefined') {
65             if (typeof xulG.unlock_tab == 'function') {
66                 dump('\twith xulG.unlock_tab\n');
67                 xulG.unlock_tab();
68                 window.oils_lock--; // different window scope than the chrome of xulG.unlock_tab
69                 if (window.oils_lock < 0) { window.oils_lock = 0; }
70             } else {
71                 dump('\twithout xulG.unlock_tab\n');
72                 oils_unsaved_data_P();
73             }
74         } else {
75             dump('\twithout xulG.unlock_tab\n');
76             oils_unsaved_data_P();
77         }
78         return window.oils_lock;
79     }
80
81     window.oils_lock = 0;
82     dump('\n=-=-=-=-=\n');
83     dump('init window.oils_lock == ' + window.oils_lock + ' for ' + location.href + '\n');
84     window.addEventListener(
85         'close',
86         function(ev) {
87             try {
88                 dump('\n=-=-=-=-=\n');
89                 dump('oils_lock_page/oils_unlock_page onclose handler for ' + location.href + '\n');
90                 if (window.oils_lock > 0) {
91                     var confirmation = window.confirm($('offlineStrings').getString('menu.close_window.unsaved_data_warning'));
92                     if (!confirmation) {
93                         ev.preventDefault();
94                         return false;
95                     }
96                 }
97
98                 if (typeof xulG != 'undefined') {
99                     if (typeof xulG.unlock_tab == 'function') {
100                         xulG.unlock_tab();
101                     } else {
102                         oils_unsaved_data_P( window.oils_lock );
103                     }
104                 } else {
105                     oils_unsaved_data_P( window.oils_lock );
106                 }
107                 window.oils_lock = 0;
108                 dump('forcing window.oils_lock == ' + window.oils_lock + '\n');
109
110                 // Dispatching the window close event doesn't always close the window, even though the event does happen
111                 setTimeout(
112                     function() {
113                         try {
114                             window.close();
115                         } catch(E) {
116                             dump('Error inside global_util.js, onclose handler, setTimeout window.close KLUDGE: ' + E + '\n');
117                         }
118                     }, 0
119                 );
120
121                 return true;
122             } catch(E) {
123                 dump('Error inside global_util.js, onclose handler: ' + E + '\n');
124                 return true;
125             }
126         },
127         false
128     );
129
130     function ses(a,params) {
131         try {
132             if (!params) params = {};
133             var data;
134             if (params.data) {
135                 data = params.data; data.stash_retrieve();
136             } else {
137                 // This has been breaking in certain contexts, with an internal instantiation of util.error failing because of util.error being an object instead of the constructor function it should be
138                 JSAN.use('OpenILS.data'); data = new OpenILS.data(); data.stash_retrieve();
139             }
140
141             switch(a) {
142                 case 'staff' : return data.list.au[0]; break;
143                 case 'staff_id' : return data.list.au[0].id(); break;
144                 case 'staff_usrname' : return data.list.au[0].usrname(); break;
145                 case 'ws_ou' :
146                     return data.list.au[0].ws_ou();
147                 break;
148                 case 'ws_ou_shortname' :
149                     return data.hash.aou[ data.list.au[0].ws_ou() ].shortname();
150                 break;
151                 case 'authtime' :
152                     return data.session.authtime;
153                 break;
154                 case 'key':
155                 default:
156                     return data.session.key;
157                 break;
158             }
159         } catch(E) {
160             alert(location.href + '\nError in global_utils.js, ses(): ' + E);
161             throw(E);
162         }
163     }
164
165     function font_helper() {
166         try {
167             JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
168             removeCSSClass(document.documentElement,'ALL_FONTS_LARGER');
169             removeCSSClass(document.documentElement,'ALL_FONTS_SMALLER');
170             removeCSSClass(document.documentElement,'ALL_FONTS_XX_SMALL');
171             removeCSSClass(document.documentElement,'ALL_FONTS_X_SMALL');
172             removeCSSClass(document.documentElement,'ALL_FONTS_SMALL');
173             removeCSSClass(document.documentElement,'ALL_FONTS_MEDIUM');
174             removeCSSClass(document.documentElement,'ALL_FONTS_LARGE');
175             removeCSSClass(document.documentElement,'ALL_FONTS_X_LARGE');
176             removeCSSClass(document.documentElement,'ALL_FONTS_XX_LARGE');
177             addCSSClass(document.documentElement,data.global_font_adjust);
178         } catch(E) {
179             var Strings = $('offlineStrings') || $('commonStrings');
180             alert(Strings.getFormattedString('openils.global_util.font_size.error', [E]));
181         }
182     }
183
184     function oils_persist(e,cancelable) {
185         try {
186             if (!e) { return; }
187             if (typeof cancelable == 'undefined') { cancelable = false; } 
188             var evt = document.createEvent("Events");
189             evt.initEvent( 'oils_persist', false, cancelable ); // event name, bubbles, cancelable
190             e.dispatchEvent(evt);
191         } catch(E) {
192             alert('Error with oils_persist():' + E);
193         }
194     }
195
196     function persist_helper(base_key_suffix) {
197         try {
198             if (base_key_suffix) {
199                 base_key_suffix = base_key_suffix.replace(/[^A-Za-z]/g,'_') + '_';
200             } else {
201                 base_key_suffix = '';
202             }
203
204             function gen_event_handler(etype,node) {
205                 return function(ev) {
206                     try {
207                         oils_persist(ev.target);
208                     } catch(E) {
209                         alert('Error in persist_helper, firing virtual event oils_persist after ' + etype + ' event on ' + node.nodeName + '.id = ' + node.id + ': ' + E);
210                     }
211                 };
212             };
213
214             function gen_oils_persist_handler(bk,node) {
215                 return function(ev) {
216                     try {
217                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
218                         var target;
219                         if (ev.target.nodeName == 'command') {
220                             target = node;
221                             if (ev.explicitOriginalTarget != node) return;
222                         } else {
223                             target = ev.target;
224                             if (target == window) {
225                                 target = window.document.documentElement;
226                             }
227                         }
228                         var filename = location.pathname.split('/')[ location.pathname.split('/').length - 1 ];
229                         var base_key = 'oils_persist_' + String(location.hostname + '_' + filename + '_' + target.getAttribute('id')).replace('/','_','g') + '_' + base_key_suffix;
230                         var attribute_list = target.getAttribute('oils_persist').split(' ');
231                         dump('on_oils_persist: <<< ' + target.nodeName + '.id = ' + target.id + '\t' + bk + '\n');
232                         for (var j = 0; j < attribute_list.length; j++) {
233                             var key = base_key + attribute_list[j];
234                             var value = target.getAttribute( attribute_list[j] );
235                             if ( attribute_list[j] == 'checked' && ['checkbox','toolbarbutton'].indexOf( target.nodeName ) > -1 ) {
236                                 value = target.checked;
237                                 dump('\t' + value + ' <== .' + attribute_list[j] + '\n');
238                             } else if ( attribute_list[j] == 'value' && ['textbox'].indexOf( target.nodeName ) > -1 ) {
239                                 value = target.value;
240                                 dump('\t' + value + ' <== .' + attribute_list[j] + '\n');
241                             } else if ( attribute_list[j] == 'sizemode' && ['window'].indexOf( target.nodeName ) > -1 ) {
242                                 value = window.windowState;
243                                 dump('\t' + value + ' <== window.windowState, @' + attribute_list[j] + '\n');
244                             } else if ( attribute_list[j] == 'height' && ['window'].indexOf( target.nodeName ) > -1 ) {
245                                 value = window.outerHeight;
246                                 dump('\t' + value + ' <== window.outerHeight, @' + attribute_list[j] + '\n');
247                             } else if ( attribute_list[j] == 'width' && ['window'].indexOf( target.nodeName ) > -1 ) {
248                                 value = window.outerWidth;
249                                 dump('\t' + value + ' <== window.outerWidth, @' + attribute_list[j] + '\n');
250                             } else {
251                                 dump('\t' + value + ' <== @' + attribute_list[j] + '\n');
252                             }
253                             prefs.setCharPref( key, value );
254                             // TODO: Need to add logic for splitter repositioning, grippy state, etc.
255                             // NOTE: oils_persist_peers and oils_persist="width" on those peers can help with the elements adjacent to a splitter
256                         }
257                         if (target.hasAttribute('oils_persist_peers') && ! ev.cancelable) { // We abuse the .cancelable field on the oils_persist event to prevent looping
258                             var peer_list = target.getAttribute('oils_persist_peers').split(' ');
259                             for (var j = 0; j < peer_list.length; j++) {
260                                 dump('on_oils_persist: dispatching oils_persist to peer ' + peer_list[j] + '\n');
261                                 oils_persist( document.getElementById( peer_list[j] ), true );
262                             } 
263                         }
264                     } catch(E) {
265                         alert('Error in persist_helper() event listener for ' + bk + ': ' + E);
266                     }
267                 };
268             }
269
270             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
271             var prefs = Components.classes['@mozilla.org/preferences-service;1'].getService(Components.interfaces['nsIPrefBranch']);
272             var nodes = document.getElementsByAttribute('oils_persist','*');
273             for (var i = 0; i < nodes.length; i++) {
274                 var filename = location.pathname.split('/')[ location.pathname.split('/').length - 1 ];
275                 var base_key = 'oils_persist_' + String(location.hostname + '_' + filename + '_' + nodes[i].getAttribute('id')).replace('/','_','g') + '_' + base_key_suffix;
276                 var attribute_list = nodes[i].getAttribute('oils_persist').split(' ');
277                 dump('persist_helper: >>> ' + nodes[i].nodeName + '.id = ' + nodes[i].id + '\t' + base_key + '\n');
278                 for (var j = 0; j < attribute_list.length; j++) {
279                     var key = base_key + attribute_list[j];
280                     var has_key = prefs.prefHasUserValue(key);
281                     var value = has_key ? prefs.getCharPref(key) : null;
282                     if (value == 'true') { value = true; }
283                     if (value == 'false') { value = false; }
284                     if (has_key) {
285                         if ( attribute_list[j] == 'checked' && ['checkbox','toolbarbutton'].indexOf( nodes[i].nodeName ) > -1 ) {
286                             nodes[i].checked = value; 
287                             dump('\t' + value + ' ==> .' + attribute_list[j] + '\n');
288                             if (!value) {
289                                 nodes[i].removeAttribute('checked');
290                                 dump('\tremoving @checked\n');
291                             }
292                         } else if ( attribute_list[j] == 'value' && ['textbox'].indexOf( nodes[i].nodeName ) > -1 ) {
293                             nodes[i].value = value;
294                             dump('\t' + value + ' ==> .' + attribute_list[j] + '\n');
295                         } else if ( attribute_list[j] == 'sizemode' && ['window'].indexOf( nodes[i].nodeName ) > -1 ) {
296                             switch(value) {
297                                 case window.STATE_MAXIMIZED:
298                                     window.maximize();
299                                     break;
300                                 case window.STATE_MINIMIZED:
301                                     window.minimize();
302                                     break;
303                             };
304                             dump('\t' + value + ' ==> window.windowState, @' + attribute_list[j] + '\n');
305                         } else if ( attribute_list[j] == 'height' && ['window'].indexOf( nodes[i].nodeName ) > -1 ) {
306                             window.outerHeight = value;
307                             dump('\t' + value + ' ==> window.outerHeight, @' + attribute_list[j] + '\n');
308                         } else if ( attribute_list[j] == 'width' && ['window'].indexOf( nodes[i].nodeName ) > -1 ) {
309                             window.outerWidth = value;
310                             dump('\t' + value + ' ==> window.outerWidth, @' + attribute_list[j] + '\n');
311                         } else {
312                             nodes[i].setAttribute( attribute_list[j], value);
313                             dump('\t' + value + ' ==> @' + attribute_list[j] + '\n');
314                         }
315                     }
316                 }
317                 var cmd = nodes[i].getAttribute('command');
318                 var cmd_el = document.getElementById(cmd);
319                 if (nodes[i].disabled == false && nodes[i].hidden == false) {
320                     var no_poke = nodes[i].getAttribute('oils_persist_no_poke');
321                     if (no_poke && no_poke == 'true') {
322                         // Timing issue for some checkboxes; don't poke them with an event
323                         dump('\tnot poking\n');
324                     } else {
325                         if (cmd_el) {
326                             dump('\tpoking @command\n');
327                             var evt = document.createEvent("Events");
328                             evt.initEvent( 'command', true, true );
329                             cmd_el.dispatchEvent(evt);
330                         } else {
331                             dump('\tpoking\n');
332                             var evt = document.createEvent("Events");
333                             evt.initEvent( 'command', true, true );
334                             nodes[i].dispatchEvent(evt);
335                         }
336                     }
337                 }
338                 if (cmd_el) {
339                     cmd_el.addEventListener(
340                         'command',
341                         gen_event_handler('command',cmd_el),
342                         false
343                     );
344                     cmd_el.addEventListener(
345                         'oils_persist',
346                         gen_oils_persist_handler( base_key, nodes[i] ),
347                         false
348                     );
349                 } else {
350                     var node = nodes[i];
351                     var event_types = [];
352                     if (node.hasAttribute('oils_persist_events')) {
353                         var event_type_list = node.getAttribute('oils_persist_events').split(' ');
354                         for (var j = 0; j < event_type_list.length; j++) {
355                             event_types.push( event_type_list[j] );
356                         }
357                     } else {
358                         if (node.nodeName == 'textbox') { 
359                             event_types.push('change'); 
360                         } else if (node.nodeName == 'window') {
361                             event_types.push('resize'); 
362                             node = window; // xul window is an element of window.document
363                         } else {
364                             event_types.push('command'); 
365                         }
366                     }
367                     for (var j = 0; j < event_types.length; j++) {
368                         node.addEventListener(
369                             event_types[j],
370                             gen_event_handler(event_types[j],node),
371                             false
372                         );
373                     }
374                     node.addEventListener(
375                         'oils_persist',
376                         gen_oils_persist_handler( base_key, node ),
377                         false
378                     );
379                 }
380             }
381         } catch(E) {
382             alert('Error in persist_helper(): ' + E);
383         }
384     }
385
386     function getKeys(o) {
387         var keys = [];
388         for (var k in o) keys.push(k);
389         return keys;
390     }
391
392     function get_contentWindow(frame) {
393         try {
394             netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
395             if (frame && frame.contentWindow) {
396                 try {
397                     if (typeof frame.contentWindow.wrappedJSObject != 'undefined') {
398                                      return frame.contentWindow.wrappedJSObject;
399                           }
400                 } catch(E) {
401                     var Strings = $('offlineStrings') || $('commonStrings');
402                     alert(Strings.getFormattedString('openils.global_util.content_window_jsobject.error', [frame, E]));
403                 }
404                 return frame.contentWindow;
405             } else {
406                 return null;
407             }
408         } catch(E) {
409             var Strings = $('offlineStrings') || $('commonStrings');
410             alert(Strings.getFormattedString('openils.global_util.content_window.error', [frame, E]));
411         }
412     }
413
414     function update_modal_xulG(v) {
415         try {
416             if (typeof xulG != "undefined" && xulG.not_modal) {
417                 xulG = v;
418                 xulG.not_modal = true;
419                 return;
420             }
421
422             JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
423             var key = location.pathname + location.search + location.hash;
424             if (typeof data.modal_xulG_stack != 'undefined' && typeof data.modal_xulG_stack[key] != 'undefined') {
425                 data.modal_xulG_stack[key][ data.modal_xulG_stack[key].length - 1 ] = v;
426                 data.stash('modal_xulG_stack');
427             }
428         } catch(E) {
429             alert('FIXME: update_modal_xulG => ' + E);
430         }
431     }
432
433     function xul_param(param_name,_params) {
434         /* By default, this function looks for a CGI-style query param identified by param_name.  If one isn't found, it then looks in xulG.  If one still isn't found, and _params.stash_name is true, it looks in the global xpcom stash for the field identified by stash_name.  If _params.concat is true, then it looks in all these places and concatenates the results.  There are also options for converting JSON to javascript objects, and clearing the xpcom stash_name field after retrieval.  Also added, ability to search a specific spot in the xpcom stash that implements a stack to hold xulG's for modal windows */
435         try {
436             //dump('xul_param('+param_name+','+js2JSON(_params)+')\n');
437             var value = undefined; if (!_params) _params = {};
438             if (typeof _params.no_cgi == 'undefined') {
439                 var cgi = new CGI();
440                 if (cgi.param(param_name)) {
441                     var x = cgi.param(param_name);
442                     //dump('\tfound via location.href = ' + x + '\n');
443                     if (typeof _params.JSON2js_if_cgi != 'undefined') {
444                         x = JSON2js( x );
445                         //dump('\tJSON2js = ' + x + '\n');
446                     }
447                     if (typeof _params.concat == 'undefined') {
448                         //alert(param_name + ' x = ' + x);
449                         return x; // value
450                     } else {
451                         if (value) {
452                             if (value.constructor != Array) value = [ value ];
453                             value = value.concat(x);
454                         } else {
455                             value = x;
456                         }
457                     }
458                 }
459             }
460             if (typeof _params.no_xulG == 'undefined') {
461                 if (typeof _params.modal_xulG != 'undefined') {
462                     if (typeof xulG != 'undefined' && xulG.not_modal) {
463                         // for interfaces that used to be modal but aren't now, do nothing
464                     } else {
465                         JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
466                         var key = location.pathname + location.search + location.hash;
467                         //dump('xul_param, considering modal key = ' + key + '\n');
468                         if (typeof data.modal_xulG_stack != 'undefined' && typeof data.modal_xulG_stack[key] != 'undefined') {
469                             xulG = data.modal_xulG_stack[key][ data.modal_xulG_stack[key].length - 1 ];
470                         }
471                     }
472                 }
473                 if (typeof xulG == 'object' && typeof xulG[ param_name ] != 'undefined') {
474                     var x = xulG[ param_name ];
475                     //dump('\tfound via xulG = ' + x + '\n');
476                     if (typeof _params.JSON2js_if_xulG != 'undefined') {
477                         x = JSON2js( x );
478                         //dump('\tJSON2js = ' + x + '\n');
479                     }
480                     if (typeof _params.concat == 'undefined') {
481                         //alert(param_name + ' x = ' + x);
482                         return x; // value
483                     } else {
484                         if (value) {
485                             if (value.constructor != Array) value = [ value ];
486                             value = value.concat(x);
487                         } else {
488                             value = x;
489                         }
490                     }
491                 }
492             }
493             if (typeof _params.no_xpcom == 'undefined') {
494                 /* the field names used for temp variables in the global stash tend to be more unique than xuLG or CGI param names, to avoid collisions */
495                 if (typeof _params.stash_name != 'undefined') { 
496                     JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
497                     if (typeof data[ _params.stash_name ] != 'undefined') {
498                         var x = data[ _params.stash_name ];
499                         //dump('\tfound via xpcom = ' + x + '\n');
500                         if (typeof _params.JSON2js_if_xpcom != 'undefined') {
501                             x = JSON2js( x );
502                             //dump('\tJSON2js = ' + x + '\n');
503                         }
504                         if (_params.clear_xpcom) { 
505                             data[ _params.stash_name ] = undefined; data.stash( _params.stash_name ); 
506                         }
507                         if (typeof _params.concat == 'undefined') {
508                             //alert(param_name + ' x = ' + x);
509                             return x; // value
510                         } else {
511                             if (value) {
512                                 if (value.constructor != Array) value = [ value ];
513                                 value = value.concat(x);
514                             } else {
515                                 value = x;
516                             }
517                         }
518                     }
519                 }
520             }
521             //alert(param_name + ' value = ' + value);
522             return value;
523         } catch(E) {
524             dump('xul_param error: ' + E + '\n');
525         }
526     }
527
528     function get_bool(a) {
529         // Normal javascript interpretation except 'f' == false, per postgres, and 'F' == false, and '0' == false (newer JSON is returning '0' instead of 0 in cases)
530         // So false includes 'f', '', '0', 0, null, and undefined
531         if (a == 'f') return false;
532         if (a == 'F') return false;
533         if (a == '0') return false;
534         if (a) return true; else return false;
535     }
536
537     function get_localized_bool(a) {
538         var Strings = $('offlineStrings') || $('commonStrings');
539         return get_bool(a) ? Strings.getString('common.yes') : Strings.getString('common.no');
540     }
541
542     function get_db_true() {
543         return 't';
544     }
545
546     function get_db_false() {
547         return 'f';
548     }
549
550     function copy_to_clipboard(ev) {
551         try {
552             netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
553             var text;
554             if (typeof ev == 'object') {
555                 if (typeof ev.target != 'undefined') {
556                     if (typeof ev.target.textContent != 'undefined') if (ev.target.textContent) text = ev.target.textContent;
557                     if (typeof ev.target.value != 'undefined') if (ev.target.value) text = ev.target.value;
558                 }
559             } else if (typeof ev == 'string') {
560                 text = ev;
561             }
562             const gClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
563                 .getService(Components.interfaces.nsIClipboardHelper);
564             gClipboardHelper.copyString(text);
565             var Strings = $('offlineStrings') || $('commonStrings');
566             alert(Strings.getFormattedString('openils.global_util.clipboard', [text]));
567         } catch(E) {
568             var Strings = $('offlineStrings') || $('commonStrings');
569             alert(Strings.getFormattedString('openils.global_util.clipboard.error', [E]));    
570         }
571     }
572
573     function clear_the_cache() {
574         try {
575             netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
576             var cacheClass         = Components.classes["@mozilla.org/network/cache-service;1"];
577             var cacheService    = cacheClass.getService(Components.interfaces.nsICacheService);
578             cacheService.evictEntries(Components.interfaces.nsICache.STORE_ON_DISK);
579             cacheService.evictEntries(Components.interfaces.nsICache.STORE_IN_MEMORY);
580         } catch(E) {
581             var Strings = $('offlineStrings') || $('commonStrings');
582             alert(Strings.getFormattedString('openils.global_util.clear_cache.error', [E]));
583         }
584     }
585
586     function toOpenWindowByType(inType, uri) {
587         var winopts = "chrome,extrachrome,menubar,resizable,scrollbars,status,toolbar";
588         window.open(uri, "_blank", winopts);
589     }
590
591     function url_prefix(url) {
592         if (url.match(/^\//)) url = urls.remote + url;
593         if (! url.match(/^(http|chrome):\/\//) && ! url.match(/^data:/) ) url = 'http://' + url;
594         dump('url_prefix = ' + url + '\n');
595         return url;
596     }
597
598     function widget_prompt(node,args) {
599         // args is an object that may contain the following keys: title, desc, ok_label, ok_accesskey, cancel_label, cancel_accesskey, access, method
600         // access may contain 'property' or 'attribute' or 'method' for retrieving the value from the node
601         // if 'method', then the method key will reference a function that returns the value
602         try {
603             if (!node) { return false; }
604             if (!args) { args = {}; }
605             args[ 'widget' ] = node;
606
607             var url = location.protocol == 'chrome'
608                 ? 'chrome://open_ils_staff_client/content/util/widget_prompt.xul'
609                 : '/xul/server/util/widget_prompt.xul';
610
611             JSAN.use('util.window'); var win = new util.window();
612             var my_xulG = win.open(
613                 url,
614                 args.title || 'widget_prompt',
615                 'chrome,modal',
616                 args
617             );
618
619             if (my_xulG.status == 'incomplete') {
620                 return false;
621             } else {
622                 return my_xulG.value;
623             }
624         } catch(E) {
625             alert('Error in global_utils.js, widget_prompt(): ' + E);
626         }
627     }