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