1 /* Export some constants ----------------------------------------------------- */
3 var SHOW_MR_DEFAULT = false; /* true if we show metarecords by default */
5 //var DO_AUTHORITY_LOOKUPS = false;
6 var DO_AUTHORITY_LOOKUPS = true;
8 var STAFF_WEB_BASE_PATH = '/eg'; // root of the web-based staff interfaces
11 var PARAM_TERM = "t"; /* search term */
12 var PARAM_FACET = "ft"; /* facet term */
13 var PARAM_STYPE = "tp"; /* search type */
14 var PARAM_LOCATION = "l"; /* current location */
15 var PARAM_LASSO = "sg"; /* current location */
16 var PARAM_DEPTH = "d"; /* search depth */
17 var PARAM_FORM = "f"; /* search format */
18 var PARAM_OFFSET = "o"; /* search offset */
19 var PARAM_COUNT = "c"; /* hits per page */
20 var PARAM_HITCOUNT = "hc"; /* hits per page */
21 var PARAM_MRID = "m"; /* metarecord id */
22 var PARAM_RID = "r"; /* record id */
23 var PARAM_RLIST = "rl";
24 var PARAM_ORIGLOC = "ol"; /* the original location */
25 var PARAM_AUTHTIME = "at"; /* inactivity timeout in seconds */
26 var PARAM_ADVTERM = "adv"; /* advanced search term */
27 var PARAM_ADVTYPE = "adt"; /* the advanced search type */
28 var PARAM_RTYPE = "rt";
30 var PARAM_SORT_DIR = "sd";
31 var PARAM_DEBUG = "dbg";
33 var PARAM_LITFORM = 'lf';
34 var PARAM_ITEMFORM = 'if';
35 var PARAM_ITEMTYPE = 'it';
36 var PARAM_BIBLEVEL = 'bl';
37 var PARAM_AUDIENCE = 'a';
38 var PARAM_SEARCHES = 'ss';
39 var PARAM_LANGUAGE = 'la';
40 var PARAM_TFORM = 'tf'; /* temporary format for title result pages */
41 var PARAM_RDEPTH = 'rd';
42 var PARAM_REDIR = 're'; /* true if we have been redirected by IP (we're at a real lib) */
43 var PARAM_AVAIL = 'av'; /* limit search results to available items */
44 var PARAM_COPYLOCS = 'cl'; // copy (shelving) locations
45 var PARAM_PUBD_BEFORE = 'pdb';
46 var PARAM_PUBD_AFTER = 'pda';
47 var PARAM_PUBD_BETWEEN = 'pdt';
48 var PARAM_PUBD_DURING = 'pdd';
49 var PARAM_NOPERSIST_SEARCH = 'nps';
51 /* URL param values (see comments above) */
97 var COOKIE_SB = "sbe";
98 var COOKIE_SES = "ses";
99 //var COOKIE_IDS = "ids"; /* list of mrecord ids */
100 //var COOKIE_SRIDS = "srids"; /* record ids cached from a search */
101 var COOKIE_FONT = "fnt";
102 var COOKIE_SKIN = "skin";
103 var COOKIE_RIDS = "rids"; /* list of record ids */
104 var COOKIE_SEARCH = 'sr';
107 var MRESULT = "mresult";
108 var RRESULT = "rresult";
109 var RDETAIL = "rdetail";
110 var MYOPAC = "myopac";
111 var ADVANCED = "advanced";
114 var REQITEMS = "reqitems";
115 var CNBROWSE = "cnbrowse";
117 /* search type (STYPE) options */
118 var STYPE_AUTHOR = "author";
119 var STYPE_TITLE = "title";
120 var STYPE_SUBJECT = "subject";
121 var STYPE_SERIES = "series";
122 var STYPE_KEYWORD = "keyword";
124 /* record-level search types */
125 var RTYPE_MRID = "mrid";
126 var RTYPE_COOKIE = "cookie";
127 var RTYPE_AUTHOR = STYPE_AUTHOR;
128 var RTYPE_SUBJECT = STYPE_SUBJECT;
129 var RTYPE_TITLE = STYPE_TITLE;
130 var RTYPE_SERIES = STYPE_SERIES;
131 var RTYPE_KEYWORD = STYPE_KEYWORD;
132 var RTYPE_LIST = "list";
133 var RTYPE_MULTI = 'multi';
134 var RTYPE_MARC = 'marc';
135 var RTYPE_ISBN = 'isbn';
136 var RTYPE_ISSN = 'issn';
137 var RTYPE_TCN = 'tcn';
139 var SORT_TYPE_REL = "rel";
140 var SORT_TYPE_AUTHOR = STYPE_AUTHOR;
141 var SORT_TYPE_TITLE = STYPE_TITLE;
142 var SORT_TYPE_PUBDATE = "pubdate";
143 var SORT_DIR_ASC = "asc";
144 var SORT_DIR_DESC = "desc";
146 /* types of advanced search */
147 var ADVTYPE_MULTI = 'ml';
148 var ADVTYPE_MARC = 'ma';
151 var ADVTYPE_ISBN = 'isbn';
152 var ADVTYPE_ISSN = 'issn';
155 var LOGOUT_WARNING_TIME = 30; /* "head up" for session timeout */
157 /* user preferences */
158 var PREF_HITS_PER = 'opac.hits_per_page';
159 var PREF_DEF_FONT = 'opac.default_font';
160 var PREF_HOLD_NOTIFY = 'opac.hold_notify';
161 var PREF_DEF_LOCATION = 'opac.default_search_location';
162 var PREF_DEF_DEPTH = 'opac.default_search_depth';
165 /** If enabled, added content attribution links will be
166 made visible where appropriate. The added content vendor name
167 and URL are defined in the entities in opac.dtd
169 var ENABLE_ADDED_CONTENT_ATTRIB_LINKS = false;
172 /* container for global variables shared accross pages */
174 G.user = null; /* global user object */
175 G.ui = {} /* cache of UI components */
179 var REGEX_BARCODE = /^\d+/; /* starts with a number */
180 var REGEX_PHONE = /^\d{3}-\d{3}-\d{4}$/; /* 111-222-3333 */
183 /* call me after page init and I will load references
184 to all of the ui object id's defined below
185 They will be stored in G.ui.<page>.<thingy>
187 function loadUIObjects() {
188 for( var p in config.ids ) {
190 for( var o in config.ids[p] )
191 G.ui[p][o] = getId(config.ids[p][o]);
195 /* try our best to free memory */
196 function clearUIObjects() {
197 for( var p in config.ids ) {
198 for( var o in config.ids[p] ) {
200 G.ui[p][o].onclick = null;
201 G.ui[p][o].onkeydown = null;
209 /* ----------------------------------------------------------------------------
210 Set up ID's and CSS classes
211 Any new ids, css, etc. may be added by giving the unique names and putting
212 them into the correct scope
213 /* ---------------------------------------------------------------------------- */
217 /* Set up the page names */
219 config.page[HOME] = "index.xml";
220 config.page[ADVANCED] = "advanced.xml";
221 config.page[MRESULT] = "mresult.xml";
222 config.page[RRESULT] = "rresult.xml";
223 config.page[MYOPAC] = "myopac.xml";
224 config.page[RDETAIL] = "rdetail.xml";
225 config.page[BBAGS] = "bbags.xml";
226 config.page[REQITEMS] = "reqitems.xml";
227 config.page[CNBROWSE] = "cnbrowse.xml";
234 config.images.logo = "main_logo.jpg";
237 /* set up ID's, CSS, and node names */
239 config.ids.result = {};
240 config.ids.mresult = {};
241 config.ids.advanced = {};
242 config.ids.rresult = {};
243 config.ids.myopac = {};
244 config.ids.rdetail = {};
247 config.css.result = {};
248 config.css.mresult = {};
249 config.css.advanced = {};
250 config.css.rresult = {};
251 config.css.myopac = {};
252 config.css.rdetail = {};
255 config.names.result = {};
256 config.names.mresult = {};
257 config.names.advanced = {};
258 config.names.rresult = {};
259 config.names.myopac = {};
260 config.names.rdetail = {};
263 /* id's shared accross skins. These *must* be defined */
264 config.ids.common = {};
265 config.ids.common.loading = "loading_div";
266 config.ids.common.canvas = "canvas";
267 config.ids.common.canvas_main = "canvas_main";
268 config.ids.common.org_tree = "org_tree";
269 config.ids.common.org_container = "org_container";
275 config.css.hide_me = "hide_me";
276 config.css.dim = "dim";
277 config.css.dim2 = "dim2";
280 /* ---------------------------------------------------------------------------- */
281 /* These are pages that may replace the canvas */
282 /* ---------------------------------------------------------------------------- */
283 config.ids.altcanvas = {};
287 /* ---------------------------------------------------------------------------- */
288 /* Methods are defined as service:method
289 An optional 3rd component is when a method is followed by a :1, such methods
290 have a staff counterpart and should have ".staff" appended to the method
291 before the method is called when in XUL mode */
293 var SEARCH_MRS = 'open-ils.search:open-ils.search.metabib.multiclass:1';
294 var SEARCH_RS = 'open-ils.search:open-ils.search.biblio.multiclass:1';
295 var SEARCH_MRS_QUERY = 'open-ils.search:open-ils.search.metabib.multiclass.query:1';
296 var SEARCH_RS_QUERY = 'open-ils.search:open-ils.search.biblio.multiclass.query:1';
297 var FETCH_SEARCH_RIDS = "open-ils.search:open-ils.search.biblio.record.class.search:1";
298 var CREATE_MFHD_RECORD = "open-ils.cat:open-ils.cat.serial.record.xml.create";
299 var DELETE_MFHD_RECORD = "open-ils.cat:open-ils.cat.serial.record.delete";
300 var FETCH_MFHD_SUMMARY = "open-ils.search:open-ils.search.serial.record.bib.retrieve";
301 var FETCH_MRMODS = "open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve";
302 var FETCH_MODS_FROM_COPY = "open-ils.search:open-ils.search.biblio.mods_from_copy";
303 var FETCH_MR_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.metarecord.copy_count:1";
304 var FETCH_RIDS = "open-ils.search:open-ils.search.biblio.metarecord_to_records:1";
305 var FETCH_RMODS = "open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve";
306 var FETCH_R_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.record.copy_count:1";
307 var FETCH_FLESHED_USER = "open-ils.actor:open-ils.actor.user.fleshed.retrieve";
308 var FETCH_SESSION = "open-ils.auth:open-ils.auth.session.retrieve";
309 var LOGIN_INIT = "open-ils.auth:open-ils.auth.authenticate.init";
310 var LOGIN_COMPLETE = "open-ils.auth:open-ils.auth.authenticate.complete";
311 var LOGIN_DELETE = "open-ils.auth:open-ils.auth.session.delete";
312 var FETCH_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.retrieve";
313 var UPDATE_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.update";
314 var FETCH_COPY_STATUSES = "open-ils.search:open-ils.search.config.copy_status.retrieve.all";
315 var FETCH_COPY_LOCATION_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_location_counts.summary.retrieve";
316 var FETCH_COPY_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve";
317 //var FETCH_COPY_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_counts.location.summary.retrieve";
318 var FETCH_MARC_HTML = "open-ils.search:open-ils.search.biblio.record.html";
319 var FETCH_CHECKED_OUT_SUM = "open-ils.actor:open-ils.actor.user.checked_out";
320 var FETCH_HOLDS = "open-ils.circ:open-ils.circ.holds.retrieve";
321 var FETCH_FINES_SUMMARY = "open-ils.actor:open-ils.actor.user.fines.summary";
322 var FETCH_TRANSACTIONS = "open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed";
323 var FETCH_MONEY_BILLING = 'open-ils.circ:open-ils.circ.money.billing.retrieve.all';
324 var FETCH_CROSSREF = "open-ils.search:open-ils.search.authority.crossref";
325 var FETCH_CROSSREF_BATCH = "open-ils.search:open-ils.search.authority.crossref.batch";
326 var CREATE_HOLD = "open-ils.circ:open-ils.circ.holds.create";
327 var CREATE_HOLD_OVERRIDE = "open-ils.circ:open-ils.circ.holds.create.override";
328 var CANCEL_HOLD = "open-ils.circ:open-ils.circ.hold.cancel";
329 var UPDATE_USERNAME = "open-ils.actor:open-ils.actor.user.username.update";
330 var UPDATE_PASSWORD = "open-ils.actor:open-ils.actor.user.password.update";
331 var UPDATE_EMAIL = "open-ils.actor:open-ils.actor.user.email.update";
332 var RENEW_CIRC = "open-ils.circ:open-ils.circ.renew";
333 var CHECK_SPELL = "open-ils.search:open-ils.search.spellcheck";
334 var FETCH_REVIEWS = "open-ils.search:open-ils.search.added_content.review.retrieve.all";
335 var FETCH_TOC = "open-ils.search:open-ils.search.added_content.toc.retrieve";
336 var FETCH_ACONT_SUMMARY = "open-ils.search:open-ils.search.added_content.summary.retrieve";
337 var FETCH_USER_BYBARCODE = "open-ils.actor:open-ils.actor.user.fleshed.retrieve_by_barcode";
338 var FETCH_ADV_MARC_MRIDS = "open-ils.search:open-ils.search.biblio.marc:1";
339 var FETCH_ADV_ISBN_RIDS = "open-ils.search:open-ils.search.biblio.isbn:1";
340 var FETCH_ADV_ISSN_RIDS = "open-ils.search:open-ils.search.biblio.issn:1";
341 var FETCH_ADV_TCN_RIDS = "open-ils.search:open-ils.search.biblio.tcn";
342 var FETCH_CNBROWSE = 'open-ils.search:open-ils.search.callnumber.browse';
343 var FETCH_CONTAINERS = 'open-ils.actor:open-ils.actor.container.retrieve_by_class.authoritative';
344 var CREATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.create';
345 var DELETE_CONTAINER = 'open-ils.actor:open-ils.actor.container.full_delete';
346 var CREATE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.create';
347 var DELETE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.delete';
348 var FLESH_CONTAINER = 'open-ils.actor:open-ils.actor.container.flesh';
349 var FLESH_PUBLIC_CONTAINER = 'open-ils.actor:open-ils.actor.container.public.flesh';
350 var UPDATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.update';
351 var FETCH_COPY = 'open-ils.search:open-ils.search.asset.copy.retrieve';
352 var FETCH_FLESHED_COPY = 'open-ils.search:open-ils.search.asset.copy.fleshed2.retrieve';
353 var CHECK_HOLD_POSSIBLE = 'open-ils.circ:open-ils.circ.title_hold.is_possible';
354 var UPDATE_HOLD = 'open-ils.circ:open-ils.circ.hold.update';
355 var FETCH_COPIES_FROM_VOLUME = 'open-ils.search:open-ils.search.asset.copy.retrieve_by_cn_label:1';
356 var FETCH_VOLUME_BY_INFO = 'open-ils.search:open-ils.search.call_number.retrieve_by_info'; /* XXX staff method? */
357 var FETCH_VOLUME = 'open-ils.search:open-ils.search.asset.call_number.retrieve';
358 var FETCH_ISSUANCE = 'open-ils.serial:open-ils.serial.issuance.pub_fleshed.batch.retrieve';
359 var FETCH_COPY_LOCATIONS = 'open-ils.circ:open-ils.circ.copy_location.retrieve.all';
360 var FETCH_COPY_NOTES = 'open-ils.circ:open-ils.circ.copy_note.retrieve.all';
361 var FETCH_COPY_STAT_CATS = 'open-ils.circ:open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy';
363 /* XXX deprecated. Use ccvm's instead */
364 var FETCH_LIT_FORMS = 'open-ils.search:open-ils.search.biblio.lit_form_map.retrieve.all';
365 var FETCH_ITEM_FORMS = 'open-ils.search:open-ils.search.biblio.item_form_map.retrieve.all';
366 var FETCH_ITEM_TYPES = 'open-ils.search:open-ils.search.biblio.item_type_map.retrieve.all';
367 var FETCH_BIB_LEVELS = 'open-ils.search:open-ils.search.biblio.bib_level_map.retrieve.all';
368 var FETCH_AUDIENCES = 'open-ils.search:open-ils.search.biblio.audience_map.retrieve.all';
369 /* ----------------------------------- */
371 //var FETCH_HOLD_STATUS = 'open-ils.circ:open-ils.circ.hold.status.retrieve';
372 var FETCH_HOLD_STATUS = 'open-ils.circ:open-ils.circ.hold.queue_stats.retrieve';
373 var FETCH_NON_CAT_CIRCS = 'open-ils.circ:open-ils.circ.open_non_cataloged_circulation.user';
374 var FETCH_NON_CAT_CIRC = 'open-ils.circ:open-ils.circ.non_cataloged_circulation.retrieve';
375 var FETCH_NON_CAT_TYPES = "open-ils.circ:open-ils.circ.non_cat_types.retrieve.all";
376 var FETCH_BRE = 'open-ils.search:open-ils.search.biblio.record_entry.slim.retrieve';
377 var CHECK_USERNAME = 'open-ils.actor:open-ils.actor.username.exists';
378 var FETCH_CIRC_BY_ID = 'open-ils.circ:open-ils.circ.retrieve';
379 var FETCH_MR_DESCRIPTORS = 'open-ils.search:open-ils.search.metabib.record_to_descriptors';
380 var FETCH_HIGHEST_PERM_ORG = 'open-ils.actor:open-ils.actor.user.perm.highest_org.batch';
381 var FETCH_USER_NOTES = 'open-ils.actor:open-ils.actor.note.retrieve.all';
382 var FETCH_ORG_BY_SHORTNAME = 'open-ils.actor:open-ils.actor.org_unit.retrieve_by_shortname';
383 var FETCH_BIB_IDS_BY_BARCODE = 'open-ils.search:open-ils.search.multi_home.bib_ids.by_barcode';
384 var FETCH_ORG_SETTING = 'open-ils.actor:open-ils.actor.ou_setting.ancestor_default';
385 var TEST_PEER_BIBS = 'open-ils.search:open-ils.search.peer_bibs.test';
386 var FETCH_PEER_BIBS = 'open-ils.search:open-ils.search.peer_bibs';
388 /* ---------------------------------------------------------------------------- */
391 /* ---------------------------------------------------------------------------- */
392 /* event callback functions. Other functions may be appended to these vars to
393 for added functionality. */
395 G.evt = {}; /* events container */
397 function runEvt(scope, name, a, b, c, d, e, f, g) {
398 var evt = G.evt[scope][name];
399 for( var i in evt ) {
400 evt[i](a, b, c, d, e, f, g);
404 /* creates a new event if it doesn't already exist */
405 function createEvt(scope, name) {
406 if(!G.evt[scope]) G.evt[scope] = {};
407 if(G.evt[scope][name] == null)
408 G.evt[scope][name] = [];
411 function attachEvt(scope, name, action) {
412 createEvt(scope, name);
413 G.evt[scope][name].push(action);
416 function detachAllEvt(scope, name) {
417 G.evt[scope][name] = [];
421 createEvt("common", "init"); /* f() : what happens on page init */
422 createEvt("common", "pageRendered"); /* f() : what happens when the page is done (up to the skin to call this even)*/
423 createEvt("common", "unload"); /* f() : what happens on window unload (clean memory, etc.)*/
424 createEvt("common", "locationChanged"); /* f() : what happens when the location has changed */
425 createEvt("common", "locationUpdated"); /* f() : what happens when the location has updated by the code */
427 createEvt("common", "run"); /* f() : make the page do stuff */
428 createEvt("result", "idsReceived"); /* f(ids) */
429 createEvt("rresult", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
430 createEvt("result", "preCollectRecords"); /* f() we're about to go and grab the recs */
432 createEvt("result", "hitCountReceived"); /* f() : display hit info, pagination, etc. */
433 createEvt("result", "recordReceived"); /* f(mvr, pagePosition, isMr) : display the record*/
434 createEvt("result", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
435 createEvt("result", "copyCountsReceived"); /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
436 createEvt("result", "allRecordsReceived"); /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
438 createEvt("rdetail", "recordDrawn"); /* f() : the record has been drawn */
440 createEvt("common", "loggedIn"); /* f() : user has just logged in */
441 createEvt("common", "loginCanceled"); /* f() : user has just logged in */
442 createEvt('result', 'zeroHits');
443 createEvt('result', 'lowHits');
444 createEvt('rdetail', 'recordRetrieved'); /* we are about to draw the rdetail page */
445 createEvt('common', 'depthChanged');
446 createEvt('common', 'holdUpdated');
447 createEvt('common', 'holdUpdateCanceled');
449 createEvt('rdetail', 'nextPrevDrawn');