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