Open-ILS/xul/staff_client/chrome/content/OpenILS/global_util.js

   1     function $(id) { return document.getElementById(id); }
   2
   3     function ses(a,params) {
   4         try {
   5             if (!params) params = {};
   6             var data;
   7             if (params.data) {
   8                 data = params.data; data.stash_retrieve();
   9             } else {
  10                 // 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
  11                 JSAN.use('OpenILS.data'); data = new OpenILS.data(); data.stash_retrieve();
  12             }
  13
  14             switch(a) {
  15                 case 'staff' : return data.list.au[0]; break;
  16                 case 'staff_id' : return data.list.au[0].id(); break;
  17                 case 'staff_usrname' : return data.list.au[0].usrname(); break;
  18                 case 'ws_ou' :
  19                     return data.list.au[0].ws_ou();
  20                 break;
  21                 case 'ws_ou_shortname' :
  22                     return data.hash.aou[ data.list.au[0].ws_ou() ].shortname();
  23                 break;
  24                 case 'authtime' :
  25                     return data.session.authtime;
  26                 break;
  27                 case 'key':
  28                 default:
  29                     return data.session.key;
  30                 break;
  31             }
  32         } catch(E) {
  33             alert(location.href + '\nError in global_utils.js, ses(): ' + E);
  34             throw(E);
  35         }
  36     }
  37
  38     function font_helper() {
  39         try {
  40             JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
  41             removeCSSClass(document.documentElement,'ALL_FONTS_LARGER');
  42             removeCSSClass(document.documentElement,'ALL_FONTS_SMALLER');
  43             removeCSSClass(document.documentElement,'ALL_FONTS_XX_SMALL');
  44             removeCSSClass(document.documentElement,'ALL_FONTS_X_SMALL');
  45             removeCSSClass(document.documentElement,'ALL_FONTS_SMALL');
  46             removeCSSClass(document.documentElement,'ALL_FONTS_MEDIUM');
  47             removeCSSClass(document.documentElement,'ALL_FONTS_LARGE');
  48             removeCSSClass(document.documentElement,'ALL_FONTS_X_LARGE');
  49             removeCSSClass(document.documentElement,'ALL_FONTS_XX_LARGE');
  50             addCSSClass(document.documentElement,data.global_font_adjust);
  51         } catch(E) {
  52             var Strings = $('offlineStrings') || $('commonStrings');
  53             alert(Strings.getFormattedString('openils.global_util.font_size.error', [E]));
  54         }
  55     }
  56
  57     function oils_persist(e,cancelable) {
  58         try {
  59             if (!e) { return; }
  60             if (typeof cancelable == 'undefined') { cancelable = false; }
  61             var evt = document.createEvent("Events");
  62             evt.initEvent( 'oils_persist', false, cancelable ); // event name, bubbles, cancelable
  63             e.dispatchEvent(evt);
  64         } catch(E) {
  65             alert('Error with oils_persist():' + E);
  66         }
  67     }
  68
  69     function persist_helper(base_key_suffix) {
  70         try {
  71             if (base_key_suffix) {
  72                 base_key_suffix = base_key_suffix.replace(/[^A-Za-z]/g,'_') + '_';
  73             } else {
  74                 base_key_suffix = '';
  75             }
  76
  77             function gen_event_handler(etype,node) {
  78                 return function(ev) {
  79                     try {
  80                         oils_persist(ev.target);
  81                     } catch(E) {
  82                         alert('Error in persist_helper, firing virtual event oils_persist after ' + etype + ' event on ' + node.nodeName + '.id = ' + node.id + ': ' + E);
  83                     }
  84                 };
  85             };
  86
  87             function gen_oils_persist_handler(bk,node) {
  88                 return function(ev) {
  89                     try {
  90                         netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
  91                         var target;
  92                         if (ev.target.nodeName == 'command') {
  93                             target = node;
  94                             if (ev.explicitOriginalTarget != node) return;
  95                         } else {
  96                             target = ev.target;
  97                         }
  98                         var filename = location.pathname.split('/')[ location.pathname.split('/').length - 1 ];
  99                         var base_key = 'oils_persist_' + String(location.hostname + '_' + filename + '_' + target.getAttribute('id')).replace('/','_','g') + '_' + base_key_suffix;
 100                         var attribute_list = target.getAttribute('oils_persist').split(' ');
 101                         dump('on_oils_persist: <<< ' + target.nodeName + '.id = ' + target.id + '\t' + bk + '\n');
 102                         for (var j = 0; j < attribute_list.length; j++) {
 103                             var key = base_key + attribute_list[j];
 104                             var value = target.getAttribute( attribute_list[j] );
 105                             if ( attribute_list[j] == 'checked' && ['checkbox','toolbarbutton'].indexOf( target.nodeName ) > -1 ) {
 106                                 value = target.checked;
 107                                 dump('\t' + value + ' <== .' + attribute_list[j] + '\n');
 108                             } else if ( attribute_list[j] == 'value' && ['textbox'].indexOf( target.nodeName ) > -1 ) {
 109                                 value = target.value;
 110                                 dump('\t' + value + ' <== .' + attribute_list[j] + '\n');
 111                             } else {
 112                                 dump('\t' + value + ' <== @' + attribute_list[j] + '\n');
 113                             }
 114                             prefs.setCharPref( key, value );
 115                             // TODO: Need to add logic for window resizing, splitter repositioning, grippy state, etc.
 116                             // NOTE: oils_persist_peers and oils_persist="width" on those peers can help with the elements adjacent to a splitter
 117                         }
 118                         if (target.hasAttribute('oils_persist_peers') && ! ev.cancelable) { // We abuse the .cancelable field on the oils_persist event to prevent looping
 119                             var peer_list = target.getAttribute('oils_persist_peers').split(' ');
 120                             for (var j = 0; j < peer_list.length; j++) {
 121                                 dump('on_oils_persist: dispatching oils_persist to peer ' + peer_list[j] + '\n');
 122                                 oils_persist( document.getElementById( peer_list[j] ), true );
 123                             }
 124                         }
 125                     } catch(E) {
 126                         alert('Error in persist_helper() event listener for ' + bk + ': ' + E);
 127                     }
 128                 };
 129             }
 130
 131             netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
 132             var prefs = Components.classes['@mozilla.org/preferences-service;1'].getService(Components.interfaces['nsIPrefBranch']);
 133             var nodes = document.getElementsByAttribute('oils_persist','*');
 134             for (var i = 0; i < nodes.length; i++) {
 135                 var filename = location.pathname.split('/')[ location.pathname.split('/').length - 1 ];
 136                 var base_key = 'oils_persist_' + String(location.hostname + '_' + filename + '_' + nodes[i].getAttribute('id')).replace('/','_','g') + '_' + base_key_suffix;
 137                 var attribute_list = nodes[i].getAttribute('oils_persist').split(' ');
 138                 dump('persist_helper: >>> ' + nodes[i].nodeName + '.id = ' + nodes[i].id + '\t' + base_key + '\n');
 139                 for (var j = 0; j < attribute_list.length; j++) {
 140                     var key = base_key + attribute_list[j];
 141                     var has_key = prefs.prefHasUserValue(key);
 142                     var value = has_key ? prefs.getCharPref(key) : null;
 143                     if (value == 'true') { value = true; }
 144                     if (value == 'false') { value = false; }
 145                     if (has_key) {
 146                         if ( attribute_list[j] == 'checked' && ['checkbox','toolbarbutton'].indexOf( nodes[i].nodeName ) > -1 ) {
 147                             nodes[i].checked = value;
 148                             dump('\t' + value + ' ==> .' + attribute_list[j] + '\n');
 149                             if (!value) {
 150                                 nodes[i].removeAttribute('checked');
 151                                 dump('\tremoving @checked\n');
 152                             }
 153                         } else if ( attribute_list[j] == 'value' && ['textbox'].indexOf( nodes[i].nodeName ) > -1 ) {
 154                             nodes[i].value = value;
 155                             dump('\t' + value + ' ==> .' + attribute_list[j] + '\n');
 156                         } else {
 157                             nodes[i].setAttribute( attribute_list[j], value);
 158                             dump('\t' + value + ' ==> @' + attribute_list[j] + '\n');
 159                         }
 160                     }
 161                 }
 162                 var cmd = nodes[i].getAttribute('command');
 163                 var cmd_el = document.getElementById(cmd);
 164                 if (nodes[i].disabled == false && nodes[i].hidden == false) {
 165                     var no_poke = nodes[i].getAttribute('oils_persist_no_poke');
 166                     if (no_poke && no_poke == 'true') {
 167                         // Timing issue for some checkboxes; don't poke them with an event
 168                         dump('\tnot poking\n');
 169                     } else {
 170                         if (cmd_el) {
 171                             dump('\tpoking @command\n');
 172                             var evt = document.createEvent("Events");
 173                             evt.initEvent( 'command', true, true );
 174                             cmd_el.dispatchEvent(evt);
 175                         } else {
 176                             dump('\tpoking\n');
 177                             var evt = document.createEvent("Events");
 178                             evt.initEvent( 'command', true, true );
 179                             nodes[i].dispatchEvent(evt);
 180                         }
 181                     }
 182                 }
 183                 if (cmd_el) {
 184                     cmd_el.addEventListener(
 185                         'command',
 186                         gen_event_handler('command',cmd_el),
 187                         false
 188                     );
 189                     cmd_el.addEventListener(
 190                         'oils_persist',
 191                         gen_oils_persist_handler( base_key, nodes[i] ),
 192                         false
 193                     );
 194                 } else {
 195                     var event_types = [];
 196                     if (nodes[i].hasAttribute('oils_persist_events')) {
 197                         var event_type_list = nodes[i].getAttribute('oils_persist_events').split(' ');
 198                         for (var j = 0; j < event_type_list.length; j++) {
 199                             event_types.push( event_type_list[j] );
 200                         }
 201                     } else {
 202                         if (nodes[i].nodeName == 'textbox') {
 203                             event_types.push('change');
 204                         } else {
 205                             event_types.push('command');
 206                         }
 207                     }
 208                     for (var j = 0; j < event_types.length; j++) {
 209                         nodes[i].addEventListener(
 210                             event_types[j],
 211                             gen_event_handler(event_types[j],nodes[i]),
 212                             false
 213                         );
 214                     }
 215                     nodes[i].addEventListener(
 216                         'oils_persist',
 217                         gen_oils_persist_handler( base_key, nodes[i] ),
 218                         false
 219                     );
 220                 }
 221             }
 222         } catch(E) {
 223             alert('Error in persist_helper(): ' + E);
 224         }
 225     }
 226
 227     function getKeys(o) {
 228         var keys = [];
 229         for (var k in o) keys.push(k);
 230         return keys;
 231     }
 232
 233     function get_contentWindow(frame) {
 234         try {
 235             netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
 236             if (frame && frame.contentWindow) {
 237                 try {
 238                     if (typeof frame.contentWindow.wrappedJSObject != 'undefined') {
 239                                      return frame.contentWindow.wrappedJSObject;
 240                           }
 241                 } catch(E) {
 242                     var Strings = $('offlineStrings') || $('commonStrings');
 243                     alert(Strings.getFormattedString('openils.global_util.content_window_jsobject.error', [frame, E]));
 244                 }
 245                 return frame.contentWindow;
 246             } else {
 247                 return null;
 248             }
 249         } catch(E) {
 250             var Strings = $('offlineStrings') || $('commonStrings');
 251             alert(Strings.getFormattedString('openils.global_util.content_window.error', [frame, E]));
 252         }
 253     }
 254
 255     function update_modal_xulG(v) {
 256         try {
 257             JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
 258             var key = location.pathname + location.search + location.hash;
 259             if (typeof data.modal_xulG_stack != 'undefined' && typeof data.modal_xulG_stack[key] != 'undefined') {
 260                 data.modal_xulG_stack[key][ data.modal_xulG_stack[key].length - 1 ] = v;
 261                 data.stash('modal_xulG_stack');
 262             }
 263         } catch(E) {
 264             alert('FIXME: update_modal_xulG => ' + E);
 265         }
 266     }
 267
 268     function xul_param(param_name,_params) {
 269         /* 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 */
 270         try {
 271             //dump('xul_param('+param_name+','+js2JSON(_params)+')\n');
 272             var value = undefined; if (!_params) _params = {};
 273             if (typeof _params.no_cgi == 'undefined') {
 274                 var cgi = new CGI();
 275                 if (cgi.param(param_name)) {
 276                     var x = cgi.param(param_name);
 277                     //dump('\tfound via location.href = ' + x + '\n');
 278                     if (typeof _params.JSON2js_if_cgi != 'undefined') {
 279                         x = JSON2js( x );
 280                         //dump('\tJSON2js = ' + x + '\n');
 281                     }
 282                     if (typeof _params.concat == 'undefined') {
 283                         //alert(param_name + ' x = ' + x);
 284                         return x; // value
 285                     } else {
 286                         if (value) {
 287                             if (value.constructor != Array) value = [ value ];
 288                             value = value.concat(x);
 289                         } else {
 290                             value = x;
 291                         }
 292                     }
 293                 }
 294             }
 295             if (typeof _params.no_xulG == 'undefined') {
 296                 if (typeof _params.modal_xulG != 'undefined') {
 297                     JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
 298                     var key = location.pathname + location.search + location.hash;
 299                     //dump('xul_param, considering modal key = ' + key + '\n');
 300                     if (typeof data.modal_xulG_stack != 'undefined' && typeof data.modal_xulG_stack[key] != 'undefined') {
 301                         xulG = data.modal_xulG_stack[key][ data.modal_xulG_stack[key].length - 1 ];
 302                     }
 303                 }
 304                 if (typeof xulG == 'object' && typeof xulG[ param_name ] != 'undefined') {
 305                     var x = xulG[ param_name ];
 306                     //dump('\tfound via xulG = ' + x + '\n');
 307                     if (typeof _params.JSON2js_if_xulG != 'undefined') {
 308                         x = JSON2js( x );
 309                         //dump('\tJSON2js = ' + x + '\n');
 310                     }
 311                     if (typeof _params.concat == 'undefined') {
 312                         //alert(param_name + ' x = ' + x);
 313                         return x; // value
 314                     } else {
 315                         if (value) {
 316                             if (value.constructor != Array) value = [ value ];
 317                             value = value.concat(x);
 318                         } else {
 319                             value = x;
 320                         }
 321                     }
 322                 }
 323             }
 324             if (typeof _params.no_xpcom == 'undefined') {
 325                 /* 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 */
 326                 if (typeof _params.stash_name != 'undefined') {
 327                     JSAN.use('OpenILS.data'); var data = new OpenILS.data(); data.init({'via':'stash'});
 328                     if (typeof data[ _params.stash_name ] != 'undefined') {
 329                         var x = data[ _params.stash_name ];
 330                         //dump('\tfound via xpcom = ' + x + '\n');
 331                         if (typeof _params.JSON2js_if_xpcom != 'undefined') {
 332                             x = JSON2js( x );
 333                             //dump('\tJSON2js = ' + x + '\n');
 334                         }
 335                         if (_params.clear_xpcom) {
 336                             data[ _params.stash_name ] = undefined; data.stash( _params.stash_name );
 337                         }
 338                         if (typeof _params.concat == 'undefined') {
 339                             //alert(param_name + ' x = ' + x);
 340                             return x; // value
 341                         } else {
 342                             if (value) {
 343                                 if (value.constructor != Array) value = [ value ];
 344                                 value = value.concat(x);
 345                             } else {
 346                                 value = x;
 347                             }
 348                         }
 349                     }
 350                 }
 351             }
 352             //alert(param_name + ' value = ' + value);
 353             return value;
 354         } catch(E) {
 355             dump('xul_param error: ' + E + '\n');
 356         }
 357     }
 358
 359     function get_bool(a) {
 360         // Normal javascript interpretation except 'f' == false, per postgres, and 'F' == false, and '0' == false (newer JSON is returning '0' instead of 0 in cases)
 361         // So false includes 'f', '', '0', 0, null, and undefined
 362         if (a == 'f') return false;
 363         if (a == 'F') return false;
 364         if (a == '0') return false;
 365         if (a) return true; else return false;
 366     }
 367
 368     function get_localized_bool(a) {
 369         var Strings = $('offlineStrings') || $('commonStrings');
 370         return get_bool(a) ? Strings.getString('common.yes') : Strings.getString('common.no');
 371     }
 372
 373     function get_db_true() {
 374         return 't';
 375     }
 376
 377     function get_db_false() {
 378         return 'f';
 379     }
 380
 381     function copy_to_clipboard(ev) {
 382         try {
 383             netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
 384             var text;
 385             if (typeof ev == 'object') {
 386                 if (typeof ev.target != 'undefined') {
 387                     if (typeof ev.target.textContent != 'undefined') if (ev.target.textContent) text = ev.target.textContent;
 388                     if (typeof ev.target.value != 'undefined') if (ev.target.value) text = ev.target.value;
 389                 }
 390             } else if (typeof ev == 'string') {
 391                 text = ev;
 392             }
 393             const gClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
 394                 .getService(Components.interfaces.nsIClipboardHelper);
 395             gClipboardHelper.copyString(text);
 396             var Strings = $('offlineStrings') || $('commonStrings');
 397             alert(Strings.getFormattedString('openils.global_util.clipboard', [text]));
 398         } catch(E) {
 399             var Strings = $('offlineStrings') || $('commonStrings');
 400             alert(Strings.getFormattedString('openils.global_util.clipboard.error', [E]));
 401         }
 402     }
 403
 404     function clear_the_cache() {
 405         try {
 406             netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
 407             var cacheClass         = Components.classes["@mozilla.org/network/cache-service;1"];
 408             var cacheService    = cacheClass.getService(Components.interfaces.nsICacheService);
 409             cacheService.evictEntries(Components.interfaces.nsICache.STORE_ON_DISK);
 410             cacheService.evictEntries(Components.interfaces.nsICache.STORE_IN_MEMORY);
 411         } catch(E) {
 412             var Strings = $('offlineStrings') || $('commonStrings');
 413             alert(Strings.getFormattedString('openils.global_util.clear_cache.error', [E]));
 414         }
 415     }
 416
 417     function toOpenWindowByType(inType, uri) {
 418         var winopts = "chrome,extrachrome,menubar,resizable,scrollbars,status,toolbar";
 419         window.open(uri, "_blank", winopts);
 420     }
 421
 422     function url_prefix(url) {
 423         if (url.match(/^\//)) url = urls.remote + url;
 424         if (! url.match(/^(http|chrome):\/\//) && ! url.match(/^data:/) ) url = 'http://' + url;
 425         dump('url_prefix = ' + url + '\n');
 426         return url;
 427     }
 428