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_RLIST         = "rl";
  15 var PARAM_ORIGLOC               = "ol";                 /* the original location */
  16 //var PARAM_TOPRANK             = "tr";                 /* this highest ranking rank */
  17 var PARAM_AUTHTIME      = "at";                 /* inactivity timeout in seconds */
  18 var PARAM_ADVTERM               = "adv";                        /* advanced search term */
  19 var PARAM_ADVTYPE               = "adt";                        /* the advanced search type */
  20 var PARAM_RTYPE         = "rt";
  21 var PARAM_SORT                  = "s";
  22 var PARAM_SORT_DIR      = "sd";
  23 var PARAM_DEBUG         = "dbg";
  24 var PARAM_CN                    = "cn";
  25 var PARAM_LITFORM               = 'lf';
  26 var PARAM_ITEMFORM      = 'if';
  27 var PARAM_ITEMTYPE      = 'it';
  28 var PARAM_AUDIENCE      = 'a';
  29 var PARAM_SEARCHES      = 'ss';
  30 var PARAM_LANGUAGE      = 'la';
  31
  32 /* URL param values (see comments above) */
  33 var TERM;
  34 var STYPE;
  35 var LOCATION;
  36 var DEPTH;
  37 var FORM;
  38 var OFFSET;
  39 var COUNT;
  40 var HITCOUNT;
  41 var RANKS;
  42 var FONTSIZE;
  43 var ORIGLOC;
  44 var AUTHTIME;
  45 var ADVTERM;
  46 var ADVTYPE;
  47 var MRID;
  48 var RID;
  49 var RTYPE;
  50 var SORT;
  51 var SORT_DIR;
  52 var RLIST;
  53 var DEBUG;
  54 var CALLNUM;
  55 var LITFORM;
  56 var ITEMFORM;
  57 var ITEMTYPE;
  58 var AUDIENCE;
  59 var SEARCHES;
  60 var LANGUAGE;
  61
  62 /* cookie values */
  63 var SBEXTRAS;
  64 var SKIN;
  65
  66
  67 /* cookies */
  68 var COOKIE_SB = "sbe";
  69 var COOKIE_SES = "ses";
  70 var COOKIE_IDS  = "ids"; /* list of mrecord ids */
  71 var COOKIE_FONT = "fnt";
  72 var COOKIE_SKIN = "skin";
  73 var COOKIE_RIDS = "rids"; /* list of record ids */
  74
  75 /* pages */
  76 var MRESULT             = "mresult";
  77 var RRESULT             = "rresult";
  78 var RDETAIL             = "rdetail";
  79 var MYOPAC              = "myopac";
  80 var ADVANCED    = "advanced";
  81 var HOME                        = "home";
  82 var BBAGS               = "bbags";
  83 var REQITEMS    = "reqitems";
  84 var CNBROWSE    = "cnbrowse";
  85
  86 /* search type (STYPE) options */
  87 var STYPE_AUTHOR        = "author";
  88 var STYPE_TITLE = "title";
  89 var STYPE_SUBJECT       = "subject";
  90 var STYPE_SERIES        = "series";
  91 var STYPE_KEYWORD       = "keyword";
  92
  93 /* record-level search types */
  94 var RTYPE_MRID          = "mrid";
  95 var RTYPE_COOKIE        = "cookie";
  96 var RTYPE_AUTHOR        = STYPE_AUTHOR;
  97 var RTYPE_SUBJECT       = STYPE_SUBJECT;
  98 var RTYPE_TITLE = STYPE_TITLE;
  99 var RTYPE_SERIES        = STYPE_SERIES;
 100 var RTYPE_KEYWORD       = STYPE_KEYWORD;
 101 var RTYPE_LIST          = "list";
 102 var RTYPE_MULTI = 'multi';
 103 var RTYPE_MARC          = 'marc';
 104
 105 var SORT_TYPE_REL                       = "rel";
 106 var SORT_TYPE_AUTHOR            = STYPE_AUTHOR;
 107 var SORT_TYPE_TITLE             = STYPE_TITLE;
 108 var SORT_TYPE_PUBDATE   = "pubdate";
 109 var SORT_DIR_ASC                        = "asc";
 110 var SORT_DIR_DESC                       = "desc";
 111
 112 /* types of advanced search */
 113 var ADVTYPE_MULTI = 'ml';
 114 var ADVTYPE_MARC        = 'ma';
 115 var ADVTYPE_ISBN        = 'isbn';
 116 var ADVTYPE_ISSN        = 'issn';
 117
 118 var LOGOUT_WARNING_TIME = 30; /* "head up" for session timeout */
 119
 120 /* user preferences */
 121 var PREF_HITS_PER               = 'opac.hits_per_page';
 122 //var PREF_BOOKBAG              = 'opac.bookbag_enabled';
 123 var PREF_DEF_FONT               = 'opac.default_font';
 124 var PREF_HOLD_NOTIFY = 'opac.hold_notify';
 125
 126
 127 /* container for global variables shared accross pages */
 128 var G           = {};
 129 G.user  = null; /* global user object */
 130 G.ui            = {} /* cache of UI components */
 131
 132
 133 /* regexes */
 134 var REGEX_BARCODE = /^\d+/; /* starts with a number */
 135 var REGEX_PHONE = /^\d{3}-\d{3}-\d{4}$/; /* 111-222-3333 */
 136
 137
 138 /* call me after page init and I will load references
 139         to all of the ui object id's defined below
 140         They will be stored in G.ui.<page>.<thingy>
 141  */
 142 function loadUIObjects() {
 143         for( var p in config.ids ) {
 144                 G.ui[p] = {};
 145                 for( var o in config.ids[p] )
 146                         G.ui[p][o] = getId(config.ids[p][o]);
 147         }
 148 }
 149
 150 /* try our best to free memory */
 151 function clearUIObjects() {
 152         for( var p in config.ids ) {
 153                 for( var o in config.ids[p] ) {
 154                         if(G.ui[p][o]) {
 155                                 G.ui[p][o].onclick = null;
 156                                 G.ui[p][o].onkeydown = null;
 157                                 G.ui[p][o] = null;
 158                         }
 159                 }
 160                 G.ui[p] = null;
 161         }
 162 }
 163
 164 /* ----------------------------------------------------------------------------
 165         Set up ID's and CSS classes
 166         Any new ids, css, etc. may be added by giving the unique names and putting
 167         them into the correct scope
 168 /* ---------------------------------------------------------------------------- */
 169
 170 var config = {};
 171
 172 /* Set up the page names */
 173 config.page = {};
 174 config.page[HOME]                       = "index.xml";
 175 config.page[ADVANCED]   = "advanced.xml";
 176 config.page[MRESULT]            = "mresult.xml";
 177 config.page[RRESULT]            = "rresult.xml";
 178 config.page[MYOPAC]             = "myopac.xml";
 179 config.page[RDETAIL]            = "rdetail.xml";
 180 config.page[BBAGS]              = "bbags.xml";
 181 config.page[REQITEMS]   = "reqitems.xml";
 182 config.page[CNBROWSE]   = "cnbrowse.xml";
 183
 184 /* themes */
 185 config.themes = {};
 186
 187 /* set up images  */
 188 config.images = {};
 189 config.images.logo = "main_logo.jpg";
 190
 191
 192 /* set up ID's, CSS, and node names */
 193 config.ids                              = {};
 194 config.ids.result               = {};
 195 config.ids.mresult      = {};
 196 config.ids.advanced     = {};
 197 config.ids.rresult      = {};
 198 config.ids.myopac               = {};
 199 config.ids.rdetail      = {};
 200
 201 config.css                              = {};
 202 config.css.result               = {};
 203 config.css.mresult      = {};
 204 config.css.advanced     = {};
 205 config.css.rresult      = {};
 206 config.css.myopac               = {};
 207 config.css.rdetail      = {};
 208
 209 config.names                    = {};
 210 config.names.result     = {};
 211 config.names.mresult = {};
 212 config.names.advanced = {};
 213 config.names.rresult = {};
 214 config.names.myopac     = {};
 215 config.names.rdetail = {};
 216
 217
 218 /* id's shared accross skins. These *must* be defined */
 219 config.ids.common = {};
 220 config.ids.common.loading                       = "loading_div";
 221 config.ids.common.canvas                        = "canvas";
 222 config.ids.common.canvas_main           = "canvas_main";
 223 config.ids.common.org_tree                      = "org_tree";
 224 config.ids.common.org_container = "org_container";
 225
 226 config.ids.xul = {};
 227
 228
 229 /* shared CSS */
 230 config.css.hide_me = "hide_me";
 231 config.css.dim = "dim";
 232 config.css.dim2 = "dim2";
 233
 234
 235 /* ---------------------------------------------------------------------------- */
 236 /* These are pages that may replace the canvas */
 237 /* ---------------------------------------------------------------------------- */
 238 config.ids.altcanvas = {};
 239
 240
 241
 242 /* ---------------------------------------------------------------------------- */
 243 /* Methods are defined as service:method
 244         An optional 3rd component is when a method is followed by a :1, such methods
 245         have a staff counterpart and should have ".staff" appended to the method
 246         before the method is called when in XUL mode */
 247
 248 var SEARCH_MRS                                          = 'open-ils.search:open-ils.search.metabib.multiclass:1';
 249 var SEARCH_RS                                           = 'open-ils.search:open-ils.search.biblio.multiclass:1';
 250 var FETCH_SEARCH_RIDS                   = "open-ils.search:open-ils.search.biblio.record.class.search:1";
 251 var FETCH_MRMODS                                        = "open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve";
 252 var FETCH_MODS_FROM_COPY                = "open-ils.search:open-ils.search.biblio.mods_from_copy";
 253 var FETCH_MR_COPY_COUNTS                = "open-ils.search:open-ils.search.biblio.metarecord.copy_count:1";
 254 var FETCH_RIDS                                          = "open-ils.search:open-ils.search.biblio.metarecord_to_records:1";
 255 var FETCH_RMODS                                 = "open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve";
 256 var FETCH_R_COPY_COUNTS                 = "open-ils.search:open-ils.search.biblio.record.copy_count";
 257 var FETCH_FLESHED_USER                  = "open-ils.actor:open-ils.actor.user.fleshed.retrieve";
 258 var FETCH_SESSION                                       = "open-ils.auth:open-ils.auth.session.retrieve";
 259 var LOGIN_INIT                                          = "open-ils.auth:open-ils.auth.authenticate.init";
 260 var LOGIN_COMPLETE                              = "open-ils.auth:open-ils.auth.authenticate.complete";
 261 var LOGIN_DELETE                                        = "open-ils.auth:open-ils.auth.session.delete";
 262 var FETCH_USER_PREFS                            = "open-ils.actor:open-ils.actor.patron.settings.retrieve";
 263 var UPDATE_USER_PREFS                   = "open-ils.actor:open-ils.actor.patron.settings.update";
 264 var FETCH_COPY_STATUSES                 = "open-ils.search:open-ils.search.config.copy_status.retrieve.all";
 265 var FETCH_COPY_COUNTS_SUMMARY   = "open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve";
 266 var FETCH_MARC_HTML                             = "open-ils.search:open-ils.search.biblio.record.html";
 267 var FETCH_CHECKED_OUT                   = "open-ils.circ:open-ils.circ.actor.user.checked_out";
 268 var FETCH_CHECKED_OUT_SLIM              = "open-ils.circ:open-ils.circ.actor.user.checked_out.opac";
 269 var FETCH_HOLDS                                 = "open-ils.circ:open-ils.circ.holds.retrieve";
 270 var FETCH_FINES_SUMMARY                 = "open-ils.actor:open-ils.actor.user.fines.summary";
 271 var FETCH_TRANSACTIONS                  = "open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed";
 272 var FETCH_MONEY_BILLING                 = 'open-ils.circ:open-ils.circ.money.billing.retrieve.all';
 273 var FETCH_CROSSREF                              = "open-ils.search:open-ils.search.authority.crossref";
 274 var FETCH_CROSSREF_BATCH                = "open-ils.search:open-ils.search.authority.crossref.batch";
 275 var CREATE_HOLD                                 = "open-ils.circ:open-ils.circ.holds.create";
 276 var CANCEL_HOLD                                 = "open-ils.circ:open-ils.circ.hold.cancel";
 277 var UPDATE_USERNAME                             = "open-ils.actor:open-ils.actor.user.username.update";
 278 var UPDATE_PASSWORD                             = "open-ils.actor:open-ils.actor.user.password.update";
 279 var UPDATE_EMAIL                                        = "open-ils.actor:open-ils.actor.user.email.update";
 280 var RENEW_CIRC                                          = "open-ils.circ:open-ils.circ.renew";
 281 var CHECK_SPELL                                 = "open-ils.search:open-ils.search.spell_check";
 282 var FETCH_REVIEWS                                       = "open-ils.search:open-ils.search.added_content.review.retrieve.all";
 283 var FETCH_TOC                                           = "open-ils.search:open-ils.search.added_content.toc.retrieve";
 284 var FETCH_ACONT_SUMMARY                 = "open-ils.search:open-ils.search.added_content.summary.retrieve";
 285 var FETCH_USER_BYBARCODE                = "open-ils.actor:open-ils.actor.user.fleshed.retrieve_by_barcode";
 286 /*var FETCH_ADV_MRIDS                           = "open-ils.search:open-ils.search.biblio.multiclass:1";*/
 287 var FETCH_ADV_MARC_MRIDS                = "open-ils.search:open-ils.search.biblio.marc:1";
 288 var FETCH_ADV_ISBN_MRIDS                = "open-ils.search:open-ils.search.biblio.isbn";
 289 var FETCH_ADV_ISSN_MRIDS                = "open-ils.search:open-ils.search.biblio.issn";
 290 var FETCH_CNBROWSE_TARGET               = 'open-ils.search:open-ils.search.callnumber.browse.target';
 291 var FETCH_CNBROWSE_PREV                 = 'open-ils.search:open-ils.search.callnumber.browse.page_up';
 292 var FETCH_CNBROWSE_NEXT                 = 'open-ils.search:open-ils.search.callnumber.browse.page_down';
 293 var FETCH_CONTAINERS                            = 'open-ils.actor:open-ils.actor.container.retrieve_by_class';
 294 var FETCH_CONTAINERS                            = 'open-ils.actor:open-ils.actor.container.retrieve_by_class';
 295 var CREATE_CONTAINER                            = 'open-ils.actor:open-ils.actor.container.create';
 296 var DELETE_CONTAINER                            = 'open-ils.actor:open-ils.actor.container.full_delete';
 297 var CREATE_CONTAINER_ITEM               = 'open-ils.actor:open-ils.actor.container.item.create';
 298 var DELETE_CONTAINER_ITEM               = 'open-ils.actor:open-ils.actor.container.item.delete';
 299 var FLESH_CONTAINER                             = 'open-ils.actor:open-ils.actor.container.flesh';
 300 var FLESH_PUBLIC_CONTAINER              = 'open-ils.actor:open-ils.actor.container.public.flesh';
 301 var UPDATE_CONTAINER                            = 'open-ils.actor:open-ils.actor.container.update';
 302 var FETCH_COPY                                          = 'open-ils.search:open-ils.search.asset.copy.retrieve';
 303 var CHECK_HOLD_POSSIBLE                 = 'open-ils.circ:open-ils.circ.title_hold.is_possible';
 304 var UPDATE_HOLD                                 = 'open-ils.circ:open-ils.circ.hold.update';
 305 /*var FETCH_BIBLIO_NOTES                        = 'open-ils.circ:open-ils.circ.biblio_notes.public.batch.retrieve';*/
 306 var FETCH_COPIES_FROM_VOLUME    = 'open-ils.search:open-ils.search.copies_by_call_number.retrieve';
 307 var FETCH_VOLUME_BY_INFO                = 'open-ils.search:open-ils.search.call_number.retrieve_by_info'; /* XXX staff method? */
 308 var FETCH_COPY_LOCATIONS                = 'open-ils.circ:open-ils.circ.copy_location.retrieve.all';
 309 var FETCH_COPY_NOTES                            = 'open-ils.circ:open-ils.circ.copy_note.retrieve.all';
 310 var FETCH_COPY_STAT_CATS                = 'open-ils.circ:open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy';
 311 var FETCH_LIT_FORMS                             = 'open-ils.search:open-ils.search.biblio.lit_form_map.retrieve.all';
 312 var FETCH_ITEM_FORMS                            = 'open-ils.search:open-ils.search.biblio.item_form_map.retrieve.all';
 313 var FETCH_ITEM_TYPES                            = 'open-ils.search:open-ils.search.biblio.item_type_map.retrieve.all';
 314 var FETCH_AUDIENCES                             = 'open-ils.search:open-ils.search.biblio.audience_map.retrieve.all';
 315 var FETCH_HOLD_STATUS                   = 'open-ils.circ:open-ils.circ.hold.status.retrieve';
 316 /* ---------------------------------------------------------------------------- */
 317
 318
 319 /* ---------------------------------------------------------------------------- */
 320 /* event callback functions. Other functions may be appended to these vars to
 321         for added functionality.  */
 322
 323 G.evt                           = {}; /* events container */
 324
 325 function runEvt(scope, name, a, b, c, d, e, f, g) {
 326         var evt = G.evt[scope][name];
 327         for( var i in evt ) {
 328                 evt[i](a, b, c, d, e, f, g);
 329         }
 330 }
 331
 332 /* creates a new event if it doesn't already exist */
 333 function createEvt(scope, name) {
 334         if(!G.evt[scope]) G.evt[scope] = {};
 335         if(G.evt[scope][name] == null)
 336                 G.evt[scope][name] = [];
 337 }
 338
 339 function attachEvt(scope, name, action) {
 340         createEvt(scope, name);
 341         G.evt[scope][name].push(action);
 342 }
 343
 344 function detachAllEvt(scope, name) {
 345         G.evt[scope][name] = [];
 346 }
 347
 348
 349 createEvt("common", "init");                                            /* f() : what happens on page init */
 350 createEvt("common", "pageRendered");                    /* f() : what happens when the page is done (up to the skin to call this even)*/
 351 createEvt("common", "unload");                                  /* f() : what happens on window unload (clean memory, etc.)*/
 352 createEvt("common", "locationChanged");         /* f() : what happens when the location has changed */
 353 createEvt("common", "locationUpdated");         /* f() : what happens when the location has updated by the code */
 354
 355 createEvt("common", "run");                                             /* f() : make the page do stuff */
 356 createEvt("result", "idsReceived");                             /* f(ids) */
 357 createEvt("rresult", "recordDrawn");                    /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
 358 createEvt("result", "preCollectRecords");               /* f() we're about to go and grab the recs */
 359
 360 createEvt("result", "hitCountReceived");                /* f() : display hit info, pagination, etc. */
 361 createEvt("result", "recordReceived");                  /* f(mvr, pagePosition, isMr) : display the record*/
 362 createEvt("result", "recordDrawn");                             /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
 363 createEvt("result", "copyCountsReceived");      /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
 364 createEvt("result", "allRecordsReceived");      /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
 365
 366 createEvt("rdetail", "recordDrawn");                    /* f() : the record has been drawn */
 367
 368 createEvt("common", "loggedIn");                                        /* f() : user has just logged in */
 369 createEvt('result', 'zeroHits');
 370 createEvt('result', 'lowHits');
 371 createEvt('rdetail', 'recordRetrieved');                        /* we are about to draw the rdetail page */
 372 createEvt('common', 'depthChanged');
 373 createEvt('common', 'holdUpdated');
 374 createEvt('common', 'holdUpdateCanceled');
 375
 376
 377
 378
 379