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