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';
50 var PARAM_AUTHORITY_BROWSE_AXIS = "bx";
51 var PARAM_AUTHORITY_BROWSE_TERM = "bt";
52 var PARAM_AUTHORITY_BROWSE_PAGE = "bp";
53 var PARAM_AUTHORITY_BROWSE_PER_PAGE = "be";
55 /* URL param values (see comments above) */
101 var COOKIE_SB = "sbe";
102 var COOKIE_SES = "ses";
103 //var COOKIE_IDS = "ids"; /* list of mrecord ids */
104 //var COOKIE_SRIDS = "srids"; /* record ids cached from a search */
105 var COOKIE_FONT = "fnt";
106 var COOKIE_SKIN = "skin";
107 var COOKIE_RIDS = "rids"; /* list of record ids */
108 var COOKIE_SEARCH = 'sr';
111 var MRESULT = "mresult";
112 var RRESULT = "rresult";
113 var RDETAIL = "rdetail";
114 var MYOPAC = "myopac";
115 var ADVANCED = "advanced";
118 var REQITEMS = "reqitems";
119 var CNBROWSE = "cnbrowse";
120 var AUTHBROWSE = "authbrowse";
122 /* search type (STYPE) options */
123 var STYPE_AUTHOR = "author";
124 var STYPE_TITLE = "title";
125 var STYPE_SUBJECT = "subject";
126 var STYPE_SERIES = "series";
127 var STYPE_KEYWORD = "keyword";
129 /* record-level search types */
130 var RTYPE_MRID = "mrid";
131 var RTYPE_COOKIE = "cookie";
132 var RTYPE_AUTHOR = STYPE_AUTHOR;
133 var RTYPE_SUBJECT = STYPE_SUBJECT;
134 var RTYPE_TITLE = STYPE_TITLE;
135 var RTYPE_SERIES = STYPE_SERIES;
136 var RTYPE_KEYWORD = STYPE_KEYWORD;
137 var RTYPE_LIST = "list";
138 var RTYPE_MULTI = 'multi';
139 var RTYPE_MARC = 'marc';
140 var RTYPE_ISBN = 'isbn';
141 var RTYPE_ISSN = 'issn';
142 var RTYPE_TCN = 'tcn';
144 var SORT_TYPE_REL = "rel";
145 var SORT_TYPE_AUTHOR = STYPE_AUTHOR;
146 var SORT_TYPE_TITLE = STYPE_TITLE;
147 var SORT_TYPE_PUBDATE = "pubdate";
148 var SORT_DIR_ASC = "asc";
149 var SORT_DIR_DESC = "desc";
151 /* types of advanced search */
152 var ADVTYPE_MULTI = 'ml';
153 var ADVTYPE_MARC = 'ma';
156 var ADVTYPE_ISBN = 'isbn';
157 var ADVTYPE_ISSN = 'issn';
160 var LOGOUT_WARNING_TIME = 30; /* "head up" for session timeout */
162 /* user preferences */
163 var PREF_HITS_PER = 'opac.hits_per_page';
164 var PREF_DEF_FONT = 'opac.default_font';
165 var PREF_HOLD_NOTIFY = 'opac.hold_notify';
166 var PREF_DEF_LOCATION = 'opac.default_search_location';
167 var PREF_DEF_DEPTH = 'opac.default_search_depth';
170 /** If enabled, added content attribution links will be
171 made visible where appropriate. The added content vendor name
172 and URL are defined in the entities in opac.dtd
174 var ENABLE_ADDED_CONTENT_ATTRIB_LINKS = false;
177 /* container for global variables shared accross pages */
179 G.user = null; /* global user object */
180 G.ui = {} /* cache of UI components */
184 var REGEX_BARCODE = /^\d+/; /* starts with a number */
185 var REGEX_PHONE = /^\d{3}-\d{3}-\d{4}$/; /* 111-222-3333 */
188 /* call me after page init and I will load references
189 to all of the ui object id's defined below
190 They will be stored in G.ui.<page>.<thingy>
192 function loadUIObjects() {
193 for( var p in config.ids ) {
195 for( var o in config.ids[p] )
196 G.ui[p][o] = getId(config.ids[p][o]);
200 /* try our best to free memory */
201 function clearUIObjects() {
202 for( var p in config.ids ) {
203 for( var o in config.ids[p] ) {
205 G.ui[p][o].onclick = null;
206 G.ui[p][o].onkeydown = null;
214 /* ----------------------------------------------------------------------------
215 Set up ID's and CSS classes
216 Any new ids, css, etc. may be added by giving the unique names and putting
217 them into the correct scope
218 /* ---------------------------------------------------------------------------- */
222 /* Set up the page names */
224 config.page[HOME] = "index.xml";
225 config.page[ADVANCED] = "advanced.xml";
226 config.page[MRESULT] = "mresult.xml";
227 config.page[RRESULT] = "rresult.xml";
228 config.page[MYOPAC] = "myopac.xml";
229 config.page[RDETAIL] = "rdetail.xml";
230 config.page[BBAGS] = "bbags.xml";
231 config.page[REQITEMS] = "reqitems.xml";
232 config.page[CNBROWSE] = "cnbrowse.xml";
233 config.page[AUTHBROWSE] = "authbrowse.xml";
240 config.images.logo = "main_logo.jpg";
243 /* set up ID's, CSS, and node names */
245 config.ids.result = {};
246 config.ids.mresult = {};
247 config.ids.advanced = {};
248 config.ids.rresult = {};
249 config.ids.myopac = {};
250 config.ids.rdetail = {};
253 config.css.result = {};
254 config.css.mresult = {};
255 config.css.advanced = {};
256 config.css.rresult = {};
257 config.css.myopac = {};
258 config.css.rdetail = {};
261 config.names.result = {};
262 config.names.mresult = {};
263 config.names.advanced = {};
264 config.names.rresult = {};
265 config.names.myopac = {};
266 config.names.rdetail = {};
269 /* id's shared accross skins. These *must* be defined */
270 config.ids.common = {};
271 config.ids.common.loading = "loading_div";
272 config.ids.common.canvas = "canvas";
273 config.ids.common.canvas_main = "canvas_main";
274 config.ids.common.org_tree = "org_tree";
275 config.ids.common.org_container = "org_container";
281 config.css.hide_me = "hide_me";
282 config.css.dim = "dim";
283 config.css.dim2 = "dim2";
286 /* ---------------------------------------------------------------------------- */
287 /* These are pages that may replace the canvas */
288 /* ---------------------------------------------------------------------------- */
289 config.ids.altcanvas = {};
293 /* ---------------------------------------------------------------------------- */
294 /* Methods are defined as service:method
295 An optional 3rd component is when a method is followed by a :1, such methods
296 have a staff counterpart and should have ".staff" appended to the method
297 before the method is called when in XUL mode */
299 var SEARCH_MRS = 'open-ils.search:open-ils.search.metabib.multiclass:1';
300 var SEARCH_RS = 'open-ils.search:open-ils.search.biblio.multiclass:1';
301 var SEARCH_MRS_QUERY = 'open-ils.search:open-ils.search.metabib.multiclass.query:1';
302 var SEARCH_RS_QUERY = 'open-ils.search:open-ils.search.biblio.multiclass.query:1';
303 var FETCH_SEARCH_RIDS = "open-ils.search:open-ils.search.biblio.record.class.search:1";
304 var CREATE_MFHD_RECORD = "open-ils.cat:open-ils.cat.serial.record.xml.create";
305 var DELETE_MFHD_RECORD = "open-ils.cat:open-ils.cat.serial.record.delete";
306 var FETCH_MFHD_SUMMARY = "open-ils.search:open-ils.search.serial.record.bib.retrieve";
307 var FETCH_MRMODS = "open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve";
308 var FETCH_MODS_FROM_COPY = "open-ils.search:open-ils.search.biblio.mods_from_copy";
309 var FETCH_MR_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.metarecord.copy_count:1";
310 var FETCH_RIDS = "open-ils.search:open-ils.search.biblio.metarecord_to_records:1";
311 var FETCH_RMODS = "open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve";
312 var FETCH_R_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.record.copy_count:1";
313 var FETCH_FLESHED_USER = "open-ils.actor:open-ils.actor.user.fleshed.retrieve";
314 var FETCH_SESSION = "open-ils.auth:open-ils.auth.session.retrieve";
315 var LOGIN_INIT = "open-ils.auth:open-ils.auth.authenticate.init";
316 var LOGIN_COMPLETE = "open-ils.auth:open-ils.auth.authenticate.complete";
317 var LOGIN_DELETE = "open-ils.auth:open-ils.auth.session.delete";
318 var FETCH_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.retrieve";
319 var UPDATE_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.update";
320 var FETCH_COPY_STATUSES = "open-ils.search:open-ils.search.config.copy_status.retrieve.all";
321 var FETCH_COPY_LOCATION_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_location_counts.summary.retrieve";
322 var FETCH_COPY_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve";
323 //var FETCH_COPY_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_counts.location.summary.retrieve";
324 var FETCH_MARC_HTML = "open-ils.search:open-ils.search.biblio.record.html";
325 var FETCH_CHECKED_OUT_SUM = "open-ils.actor:open-ils.actor.user.checked_out";
326 var FETCH_HOLDS = "open-ils.circ:open-ils.circ.holds.retrieve";
327 var FETCH_FINES_SUMMARY = "open-ils.actor:open-ils.actor.user.fines.summary";
328 var FETCH_TRANSACTIONS = "open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed";
329 var FETCH_MONEY_BILLING = 'open-ils.circ:open-ils.circ.money.billing.retrieve.all';
330 var FETCH_CROSSREF = "open-ils.search:open-ils.search.authority.crossref";
331 var FETCH_CROSSREF_BATCH = "open-ils.search:open-ils.search.authority.crossref.batch";
332 var CREATE_HOLD = "open-ils.circ:open-ils.circ.holds.create";
333 var CREATE_HOLD_OVERRIDE = "open-ils.circ:open-ils.circ.holds.create.override";
334 var CANCEL_HOLD = "open-ils.circ:open-ils.circ.hold.cancel";
335 var UPDATE_USERNAME = "open-ils.actor:open-ils.actor.user.username.update";
336 var UPDATE_PASSWORD = "open-ils.actor:open-ils.actor.user.password.update";
337 var UPDATE_EMAIL = "open-ils.actor:open-ils.actor.user.email.update";
338 var RENEW_CIRC = "open-ils.circ:open-ils.circ.renew";
339 var CHECK_SPELL = "open-ils.search:open-ils.search.spellcheck";
340 var FETCH_REVIEWS = "open-ils.search:open-ils.search.added_content.review.retrieve.all";
341 var FETCH_TOC = "open-ils.search:open-ils.search.added_content.toc.retrieve";
342 var FETCH_ACONT_SUMMARY = "open-ils.search:open-ils.search.added_content.summary.retrieve";
343 var FETCH_USER_BYBARCODE = "open-ils.actor:open-ils.actor.user.fleshed.retrieve_by_barcode";
344 var FETCH_ADV_MARC_MRIDS = "open-ils.search:open-ils.search.biblio.marc:1";
345 var FETCH_ADV_ISBN_RIDS = "open-ils.search:open-ils.search.biblio.isbn:1";
346 var FETCH_ADV_ISSN_RIDS = "open-ils.search:open-ils.search.biblio.issn:1";
347 var FETCH_ADV_TCN_RIDS = "open-ils.search:open-ils.search.biblio.tcn";
348 var FETCH_CNBROWSE = 'open-ils.search:open-ils.search.callnumber.browse';
349 var FETCH_CONTAINERS = 'open-ils.actor:open-ils.actor.container.retrieve_by_class.authoritative';
350 var CREATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.create';
351 var DELETE_CONTAINER = 'open-ils.actor:open-ils.actor.container.full_delete';
352 var CREATE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.create';
353 var DELETE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.delete';
354 var FLESH_CONTAINER = 'open-ils.actor:open-ils.actor.container.flesh';
355 var FLESH_PUBLIC_CONTAINER = 'open-ils.actor:open-ils.actor.container.public.flesh';
356 var UPDATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.update';
357 var FETCH_COPY = 'open-ils.search:open-ils.search.asset.copy.retrieve';
358 var FETCH_FLESHED_COPY = 'open-ils.search:open-ils.search.asset.copy.fleshed2.retrieve';
359 var CHECK_HOLD_POSSIBLE = 'open-ils.circ:open-ils.circ.title_hold.is_possible';
360 var UPDATE_HOLD = 'open-ils.circ:open-ils.circ.hold.update';
361 var FETCH_COPIES_FROM_VOLUME = 'open-ils.search:open-ils.search.asset.copy.retrieve_by_cn_label:1';
362 var FETCH_VOLUME_BY_INFO = 'open-ils.search:open-ils.search.call_number.retrieve_by_info'; /* XXX staff method? */
363 var FETCH_VOLUME = 'open-ils.search:open-ils.search.asset.call_number.retrieve';
364 var FETCH_ISSUANCE = 'open-ils.serial:open-ils.serial.issuance.pub_fleshed.batch.retrieve';
365 var FETCH_COPY_LOCATIONS = 'open-ils.circ:open-ils.circ.copy_location.retrieve.all';
366 var FETCH_COPY_NOTES = 'open-ils.circ:open-ils.circ.copy_note.retrieve.all';
367 var FETCH_COPY_STAT_CATS = 'open-ils.circ:open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy';
368 var FETCH_BIB_SOURCE = 'open-ils.pcrud:open-ils.pcrud.retrieve.cbs';
370 /* XXX deprecated. Use ccvm's instead */
371 var FETCH_LIT_FORMS = 'open-ils.search:open-ils.search.biblio.lit_form_map.retrieve.all';
372 var FETCH_ITEM_FORMS = 'open-ils.search:open-ils.search.biblio.item_form_map.retrieve.all';
373 var FETCH_ITEM_TYPES = 'open-ils.search:open-ils.search.biblio.item_type_map.retrieve.all';
374 var FETCH_BIB_LEVELS = 'open-ils.search:open-ils.search.biblio.bib_level_map.retrieve.all';
375 var FETCH_AUDIENCES = 'open-ils.search:open-ils.search.biblio.audience_map.retrieve.all';
376 /* ----------------------------------- */
378 //var FETCH_HOLD_STATUS = 'open-ils.circ:open-ils.circ.hold.status.retrieve';
379 var FETCH_HOLD_STATUS = 'open-ils.circ:open-ils.circ.hold.queue_stats.retrieve';
380 var FETCH_NON_CAT_CIRCS = 'open-ils.circ:open-ils.circ.open_non_cataloged_circulation.user';
381 var FETCH_NON_CAT_CIRC = 'open-ils.circ:open-ils.circ.non_cataloged_circulation.retrieve';
382 var FETCH_NON_CAT_TYPES = "open-ils.circ:open-ils.circ.non_cat_types.retrieve.all";
383 var FETCH_BRE = 'open-ils.search:open-ils.search.biblio.record_entry.slim.retrieve';
384 var CHECK_USERNAME = 'open-ils.actor:open-ils.actor.username.exists';
385 var FETCH_CIRC_BY_ID = 'open-ils.circ:open-ils.circ.retrieve';
386 var FETCH_MR_DESCRIPTORS = 'open-ils.search:open-ils.search.metabib.record_to_descriptors';
387 var FETCH_HIGHEST_PERM_ORG = 'open-ils.actor:open-ils.actor.user.perm.highest_org.batch';
388 var FETCH_USER_NOTES = 'open-ils.actor:open-ils.actor.note.retrieve.all';
389 var FETCH_ORG_BY_SHORTNAME = 'open-ils.actor:open-ils.actor.org_unit.retrieve_by_shortname';
390 var FETCH_BIB_IDS_BY_BARCODE = 'open-ils.search:open-ils.search.multi_home.bib_ids.by_barcode';
391 var FETCH_ORG_SETTING = 'open-ils.actor:open-ils.actor.ou_setting.ancestor_default';
392 var TEST_PEER_BIBS = 'open-ils.search:open-ils.search.peer_bibs.test';
393 var FETCH_PEER_BIBS = 'open-ils.search:open-ils.search.peer_bibs';
395 /* ---------------------------------------------------------------------------- */
398 /* ---------------------------------------------------------------------------- */
399 /* event callback functions. Other functions may be appended to these vars to
400 for added functionality. */
402 G.evt = {}; /* events container */
404 function runEvt(scope, name, a, b, c, d, e, f, g) {
405 var evt = G.evt[scope][name];
406 for( var i in evt ) {
407 evt[i](a, b, c, d, e, f, g);
411 /* creates a new event if it doesn't already exist */
412 function createEvt(scope, name) {
413 if(!G.evt[scope]) G.evt[scope] = {};
414 if(G.evt[scope][name] == null)
415 G.evt[scope][name] = [];
418 function attachEvt(scope, name, action) {
419 createEvt(scope, name);
420 G.evt[scope][name].push(action);
423 function detachAllEvt(scope, name) {
424 G.evt[scope][name] = [];
428 createEvt("common", "init"); /* f() : what happens on page init */
429 createEvt("common", "pageRendered"); /* f() : what happens when the page is done (up to the skin to call this even)*/
430 createEvt("common", "unload"); /* f() : what happens on window unload (clean memory, etc.)*/
431 createEvt("common", "locationChanged"); /* f() : what happens when the location has changed */
432 createEvt("common", "locationUpdated"); /* f() : what happens when the location has updated by the code */
434 createEvt("common", "run"); /* f() : make the page do stuff */
435 createEvt("result", "idsReceived"); /* f(ids) */
436 createEvt("rresult", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
437 createEvt("result", "preCollectRecords"); /* f() we're about to go and grab the recs */
439 createEvt("result", "hitCountReceived"); /* f() : display hit info, pagination, etc. */
440 createEvt("result", "recordReceived"); /* f(mvr, pagePosition, isMr) : display the record*/
441 createEvt("result", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
442 createEvt("result", "copyCountsReceived"); /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
443 createEvt("result", "allRecordsReceived"); /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
445 createEvt("rdetail", "recordDrawn"); /* f() : the record has been drawn */
447 createEvt("common", "loggedIn"); /* f() : user has just logged in */
448 createEvt("common", "loginCanceled"); /* f() : user has just logged in */
449 createEvt('result', 'zeroHits');
450 createEvt('result', 'lowHits');
451 createEvt('rdetail', 'recordRetrieved'); /* we are about to draw the rdetail page */
452 createEvt('common', 'depthChanged');
453 createEvt('common', 'holdUpdated');
454 createEvt('common', 'holdUpdateCanceled');
456 createEvt('rdetail', 'nextPrevDrawn');