Open-ILS/web/opac/common/js/config.js

   1 /* Export some constants  ----------------------------------------------------- */
   2
   3 /* URL param names */
   4 var PARAM_TERM                  = "t";                  /* search term */
   5 var PARAM_STYPE         = "tp";                 /* search type */
   6 var PARAM_LOCATION      = "l";                  /* current location */
   7 var PARAM_DEPTH         = "d";                  /* search depth */
   8 var PARAM_FORM                  = "f";                  /* search format */
   9 var PARAM_OFFSET                = "o";                  /* search offset */
  10 var PARAM_COUNT         = "c";                  /* hits per page */
  11 var PARAM_HITCOUNT      = "hc";                 /* hits per page */
  12 var PARAM_MRID                  = "m";                  /* metarecord id */
  13 var PARAM_RID                   = "r";                  /* record id */
  14 var PARAM_ORIGLOC               = "ol";                 /* the original location */
  15 var PARAM_TOPRANK               = "tr";                 /* this highest ranking rank */
  16 var PARAM_AUTHTIME      = "at";                 /* inactivity timeout in seconds */
  17 var PARAM_ADVTERM               = "adv";                        /* advanced search term */
  18 var PARAM_ADVTYPE               = "adt";                        /* the advanced search type */
  19
  20 /* URL param values (see comments above) */
  21 var TERM;
  22 var STYPE;
  23 var LOCATION;
  24 var DEPTH;
  25 var FORM;
  26 var OFFSET;
  27 var COUNT;
  28 var HITCOUNT;
  29 var RANKS;
  30 var FONTSIZE;
  31 var ORIGLOC;
  32 var TOPRANK;
  33 var AUTHTIME;
  34 var ADVTERM;
  35 var ADVTYPE;
  36
  37 /* cookie values */
  38 var SBEXTRAS;
  39 var SKIN;
  40
  41
  42 /* cookies */
  43 var COOKIE_SB = "sbe";
  44 var COOKIE_SES = "ses";
  45 var COOKIE_IDS  = "ids";
  46 var COOKIE_FONT = "fnt";
  47 var COOKIE_SKIN = "skin";
  48
  49 /* these are the actual param values - set on page load */
  50
  51 /* pages */
  52 var MRESULT             = "mresult";
  53 var RRESULT             = "rresult";
  54 var RDETAIL             = "rdetail";
  55 var MYOPAC              = "myopac";
  56 var ADVANCED    = "advanced";
  57 var HOME                        = "home";
  58
  59 /* search type (STYPE) options */
  60 var STYPE_AUTHOR        = "author";
  61 var STYPE_TITLE = "title";
  62 var STYPE_SUBJECT       = "subject";
  63 var STYPE_SERIES        = "series";
  64 var STYPE_KEYWORD       = "keyword";
  65
  66 /* types of advanced search */
  67 var ADVTYPE_MULTI = 'ml';
  68 var ADVTYPE_MARC        = 'ma';
  69 var ADVTYPE_ISBN        = 'isbn';
  70 var ADVTYPE_ISSN        = 'issn';
  71
  72 var LOGOUT_WARNING_TIME = 30; /* "head up" for session timeout */
  73
  74 /* user preferences */
  75 var PREF_HITS_PER = 'opac.hits_per_page';
  76 var PREF_BOOKBAG = 'opac.bookbag_enabled';
  77
  78
  79 /* container for global variables shared accross pages */
  80 var G           = {};
  81 G.user  = null; /* global user object */
  82 G.ui            = {} /* cache of UI components */
  83
  84
  85 /* call me after page init and I will load references
  86         to all of the ui object id's defined below
  87         They will be stored in G.ui.<page>.<thingy>
  88  */
  89 function loadUIObjects() {
  90         for( var p in config.ids ) {
  91                 G.ui[p] = {};
  92                 for( var o in config.ids[p] )
  93                         G.ui[p][o] = getId(config.ids[p][o]);
  94         }
  95 }
  96
  97 /* try our best to free memory */
  98 function clearUIObjects() {
  99         for( var p in config.ids ) {
 100                 for( var o in config.ids[p] ) {
 101                         if(G.ui[p][o]) {
 102                                 G.ui[p][o].onclick = null;
 103                                 G.ui[p][o].onkeydown = null;
 104                                 G.ui[p][o] = null;
 105                         }
 106                 }
 107                 G.ui[p] = null;
 108         }
 109 }
 110
 111 /* ----------------------------------------------------------------------------
 112         Set up ID's and CSS classes
 113         Any new ids, css, etc. may be added by giving the unique names and putting
 114         them into the correct scope
 115 /* ---------------------------------------------------------------------------- */
 116
 117 var config = {};
 118
 119 /* Set up the page names */
 120 config.page = {};
 121 config.page[HOME]                       = "index.xml";
 122 config.page[ADVANCED]   = "advanced.xml";
 123 config.page[MRESULT]            = "mresult.xml";
 124 config.page[RRESULT]            = "rresult.xml";
 125 config.page[MYOPAC]             = "myopac.xml";
 126 config.page[RDETAIL]            = "rdetail.xml";
 127
 128 /* themes */
 129 config.themes = {};
 130
 131 /* set up images  */
 132 config.images = {};
 133 config.images.logo = "main_logo.jpg";
 134
 135
 136 /* set up ID's, CSS, and node names */
 137 config.ids                              = {};
 138 config.ids.result               = {};
 139 config.ids.mresult      = {};
 140 config.ids.advanced     = {};
 141 config.ids.rresult      = {};
 142 config.ids.myopac               = {};
 143 config.ids.rdetail      = {};
 144
 145 config.css                              = {};
 146 config.css.result               = {};
 147 config.css.mresult      = {};
 148 config.css.advanced     = {};
 149 config.css.rresult      = {};
 150 config.css.myopac               = {};
 151 config.css.rdetail      = {};
 152
 153 config.names                    = {};
 154 config.names.result     = {};
 155 config.names.mresult = {};
 156 config.names.advanced = {};
 157 config.names.rresult = {};
 158 config.names.myopac     = {};
 159 config.names.rdetail = {};
 160
 161
 162 /* id's shared accross skins. These *must* be defined */
 163 config.ids.common = {};
 164 config.ids.common.loading                       = "loading_div";
 165 config.ids.common.canvas                        = "canvas";
 166 config.ids.common.canvas_main           = "canvas_main";
 167 config.ids.common.org_tree                      = "org_tree";
 168 config.ids.common.org_container = "org_container";
 169
 170 config.ids.xul = {};
 171
 172
 173 /* shared CSS */
 174 config.css.hide_me = "hide_me";
 175 config.css.dim = "dim";
 176 config.css.dim2 = "dim2";
 177
 178
 179 /* ---------------------------------------------------------------------------- */
 180 /* These are pages that may replace the canvas */
 181 /* ---------------------------------------------------------------------------- */
 182 config.ids.altcanvas = {};
 183
 184
 185
 186 /* ---------------------------------------------------------------------------- */
 187 /* Methods are defined as service:method
 188         An optional 3rd component is when a method is followed by a :1, such methods
 189         have a staff counterpart and should have ".staff" appended to the method
 190         before the method is called when in XUL mode */
 191
 192 var FETCH_MRCOUNT                                       = "open-ils.search:open-ils.search.biblio.class.count:1";
 193 var FETCH_MRIDS                                 = "open-ils.search:open-ils.search.biblio.class:1";
 194 var FETCH_MRIDS_FULL                            = "open-ils.search:open-ils.search.biblio.class.full:1";
 195 var FETCH_MRMODS                                        = "open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve";
 196 var FETCH_MODS_FROM_COPY                = "open-ils.search:open-ils.search.biblio.mods_from_copy";
 197 var FETCH_MR_COPY_COUNTS                = "open-ils.search:open-ils.search.biblio.metarecord.copy_count:1";
 198 var FETCH_RIDS                                          = "open-ils.search:open-ils.search.biblio.metarecord_to_records:1";
 199 var FETCH_RMODS                                 = "open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve";
 200 var FETCH_R_COPY_COUNTS                 = "open-ils.search:open-ils.search.biblio.record.copy_count";
 201 var FETCH_FLESHED_USER                  = "open-ils.actor:open-ils.actor.user.fleshed.retrieve";
 202 var FETCH_SESSION                                       = "open-ils.auth:open-ils.auth.session.retrieve";
 203 var LOGIN_INIT                                          = "open-ils.auth:open-ils.auth.authenticate.init";
 204 var LOGIN_COMPLETE                              = "open-ils.auth:open-ils.auth.authenticate.complete";
 205 var LOGIN_DELETE                                        = "open-ils.auth:open-ils.auth.session.delete";
 206 var FETCH_USER_PREFS                            = "open-ils.actor:open-ils.actor.patron.settings.retrieve";
 207 var UPDATE_USER_PREFS                   = "open-ils.actor:open-ils.actor.patron.settings.update";
 208 var FETCH_COPY_STATUSES                 = "open-ils.search:open-ils.search.config.copy_status.retrieve.all";
 209 var FETCH_COPY_COUNTS_SUMMARY   = "open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve";
 210 var FETCH_MARC_HTML                             = "open-ils.search:open-ils.search.biblio.record.html";
 211 var FETCH_CHECKED_OUT                   = "open-ils.circ:open-ils.circ.actor.user.checked_out";
 212 var FETCH_CHECKED_OUT_SLIM              = "open-ils.circ:open-ils.circ.actor.user.checked_out.slim";
 213 var FETCH_HOLDS                                 = "open-ils.circ:open-ils.circ.holds.retrieve";
 214 var FETCH_FINES_SUMMARY                 = "open-ils.actor:open-ils.actor.user.fines.summary";
 215 var FETCH_TRANSACTIONS                  = "open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed";
 216 var FETCH_CROSSREF                              = "open-ils.search:open-ils.search.authority.crossref";
 217 var FETCH_CROSSREF_BATCH                = "open-ils.search:open-ils.search.authority.crossref.batch";
 218 var CREATE_HOLD                                 = "open-ils.circ:open-ils.circ.holds.create";
 219 var CANCEL_HOLD                                 = "open-ils.circ:open-ils.circ.hold.cancel";
 220 var UPDATE_USERNAME                             = "open-ils.actor:open-ils.actor.user.username.update";
 221 var UPDATE_PASSWORD                             = "open-ils.actor:open-ils.actor.user.password.update";
 222 var UPDATE_EMAIL                                        = "open-ils.actor:open-ils.actor.user.email.update";
 223 var RENEW_CIRC                                          = "open-ils.circ:open-ils.circ.renew";
 224 var CHECK_SPELL                                 = "open-ils.search:open-ils.search.spell_check";
 225 var FETCH_REVIEWS                                       = "open-ils.search:open-ils.search.added_content.review.retrieve.all";
 226 var FETCH_TOC                                           = "open-ils.search:open-ils.search.added_content.toc.retrieve";
 227 var FETCH_ACONT_SUMMARY                 = "open-ils.search:open-ils.search.added_content.summary.retrieve";
 228 var FETCH_USER_BYBARCODE                = "open-ils.actor:open-ils.actor.user.fleshed.retrieve_by_barcode";
 229 var FETCH_ADV_MRIDS                             = "open-ils.search:open-ils.search.biblio.multiclass:1";
 230 var FETCH_ADV_MARC_MRIDS                = "open-ils.search:open-ils.search.biblio.marc:1";
 231 var FETCH_ADV_ISBN_MRIDS                = "open-ils.search:open-ils.search.biblio.isbn";
 232 var FETCH_ADV_ISSN_MRIDS                = "open-ils.search:open-ils.search.biblio.issn";
 233 var FETCH_CNBROWSE_TARGET               = 'open-ils.search:open-ils.search.callnumber.browse.target';
 234 var FETCH_CNBROWSE_PREV                 = 'open-ils.search:open-ils.search.callnumber.browse.page_up';
 235 var FETCH_CNBROWSE_NEXT                 = 'open-ils.search:open-ils.search.callnumber.browse.page_down';
 236 var FETCH_CONTAINERS                            = 'open-ils.actor:open-ils.actor.container.retrieve_by_class';
 237 var CREATE_CONTAINER                            = 'open-ils.actor:open-ils.actor.container.create';
 238 var DELETE_CONTAINER                            = 'open-ils.actor:open-ils.actor.container.delete';
 239 var CREATE_CONTAINER_ITEM               = 'open-ils.actor:open-ils.actor.container.item.create';
 240 var DELETE_CONTAINER_ITEM               = 'open-ils.actor:open-ils.actor.container.item.delete';
 241 /* ---------------------------------------------------------------------------- */
 242
 243
 244 /* ---------------------------------------------------------------------------- */
 245 /* event callback functions. Other functions may be appended to these vars to
 246         for added functionality.  */
 247
 248 G.evt                           = {}; /* events container */
 249
 250 function runEvt(scope, name, a, b, c, d, e, f, g) {
 251         var evt = G.evt[scope][name];
 252         for( var i in evt ) {
 253                 evt[i](a, b, c, d, e, f, g);
 254         }
 255 }
 256
 257 /* creates a new event if it doesn't already exist */
 258 function createEvt(scope, name) {
 259         if(!G.evt[scope]) G.evt[scope] = {};
 260         if(G.evt[scope][name] == null)
 261                 G.evt[scope][name] = [];
 262 }
 263
 264 function attachEvt(scope, name, action) {
 265         createEvt(scope, name);
 266         G.evt[scope][name].push(action);
 267 }
 268
 269 function detachAllEvt(scope, name) {
 270         G.evt[scope][name] = [];
 271 }
 272
 273
 274 createEvt("common", "init");                                            /* f() : what happens on page init */
 275 createEvt("common", "pageRendered");                    /* f() : what happens when the page is done (up to the skin to call this even)*/
 276 createEvt("common", "unload");                                  /* f() : what happens on window unload (clean memory, etc.)*/
 277 createEvt("common", "locationChanged");         /* f() : what happens when the location has changed */
 278 createEvt("common", "locationUpdated");         /* f() : what happens when the location has updated by the code */
 279
 280 createEvt("common", "run");                                             /* f() : make the page do stuff */
 281 createEvt("result", "idsReceived");                             /* f(ids) */
 282 createEvt("rresult", "recordDrawn");                    /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
 283 createEvt("result", "preCollectRecords");               /* f() we're about to go and grab the recs */
 284
 285 createEvt("result", "hitCountReceived");                /* f() : display hit info, pagination, etc. */
 286 createEvt("result", "recordReceived");                  /* f(mvr, pagePosition, isMr) : display the record*/
 287 createEvt("result", "recordDrawn");                             /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
 288 createEvt("result", "copyCountsReceived");      /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
 289 createEvt("result", "allRecordsReceived");      /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
 290
 291 createEvt("rdetail", "recordDrawn");                    /* f() : the record has been drawn */
 292
 293 createEvt("common", "loggedIn");                                        /* f() : user has just logged in */
 294 createEvt('result', 'zeroHits');
 295 createEvt('result', 'lowHits');
 296 createEvt('rdetail', 'recordRetrieved');                        /* we are about to draw the rdetail page */
 297 createEvt('common', 'depthChanged');
 298
 299
 300
 301
 302