1 /* Export some constants ----------------------------------------------------- */
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";
21 var PARAM_SORT_DIR = "sd";
22 var PARAM_DEBUG = "dbg";
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';
33 /* URL param values (see comments above) */
70 var COOKIE_SB = "sbe";
71 var COOKIE_SES = "ses";
72 //var COOKIE_IDS = "ids"; /* list of mrecord ids */
73 //var COOKIE_SRIDS = "srids"; /* record ids cached from a search */
74 var COOKIE_FONT = "fnt";
75 var COOKIE_SKIN = "skin";
76 var COOKIE_RIDS = "rids"; /* list of record ids */
79 var MRESULT = "mresult";
80 var RRESULT = "rresult";
81 var RDETAIL = "rdetail";
82 var MYOPAC = "myopac";
83 var ADVANCED = "advanced";
86 var REQITEMS = "reqitems";
87 var CNBROWSE = "cnbrowse";
89 /* search type (STYPE) options */
90 var STYPE_AUTHOR = "author";
91 var STYPE_TITLE = "title";
92 var STYPE_SUBJECT = "subject";
93 var STYPE_SERIES = "series";
94 var STYPE_KEYWORD = "keyword";
96 /* record-level search types */
97 var RTYPE_MRID = "mrid";
98 var RTYPE_COOKIE = "cookie";
99 var RTYPE_AUTHOR = STYPE_AUTHOR;
100 var RTYPE_SUBJECT = STYPE_SUBJECT;
101 var RTYPE_TITLE = STYPE_TITLE;
102 var RTYPE_SERIES = STYPE_SERIES;
103 var RTYPE_KEYWORD = STYPE_KEYWORD;
104 var RTYPE_LIST = "list";
105 var RTYPE_MULTI = 'multi';
106 var RTYPE_MARC = 'marc';
107 var RTYPE_ISBN = 'isbn';
108 var RTYPE_ISSN = 'issn';
109 var RTYPE_TCN = 'tcn';
111 var SORT_TYPE_REL = "rel";
112 var SORT_TYPE_AUTHOR = STYPE_AUTHOR;
113 var SORT_TYPE_TITLE = STYPE_TITLE;
114 var SORT_TYPE_PUBDATE = "pubdate";
115 var SORT_DIR_ASC = "asc";
116 var SORT_DIR_DESC = "desc";
118 /* types of advanced search */
119 var ADVTYPE_MULTI = 'ml';
120 var ADVTYPE_MARC = 'ma';
123 var ADVTYPE_ISBN = 'isbn';
124 var ADVTYPE_ISSN = 'issn';
127 var LOGOUT_WARNING_TIME = 30; /* "head up" for session timeout */
129 /* user preferences */
130 var PREF_HITS_PER = 'opac.hits_per_page';
131 var PREF_DEF_FONT = 'opac.default_font';
132 var PREF_HOLD_NOTIFY = 'opac.hold_notify';
135 /* container for global variables shared accross pages */
137 G.user = null; /* global user object */
138 G.ui = {} /* cache of UI components */
142 var REGEX_BARCODE = /^\d+/; /* starts with a number */
143 var REGEX_PHONE = /^\d{3}-\d{3}-\d{4}$/; /* 111-222-3333 */
146 /* call me after page init and I will load references
147 to all of the ui object id's defined below
148 They will be stored in G.ui.<page>.<thingy>
150 function loadUIObjects() {
151 for( var p in config.ids ) {
153 for( var o in config.ids[p] )
154 G.ui[p][o] = getId(config.ids[p][o]);
158 /* try our best to free memory */
159 function clearUIObjects() {
160 for( var p in config.ids ) {
161 for( var o in config.ids[p] ) {
163 G.ui[p][o].onclick = null;
164 G.ui[p][o].onkeydown = null;
172 /* ----------------------------------------------------------------------------
173 Set up ID's and CSS classes
174 Any new ids, css, etc. may be added by giving the unique names and putting
175 them into the correct scope
176 /* ---------------------------------------------------------------------------- */
180 /* Set up the page names */
182 config.page[HOME] = "index.xml";
183 config.page[ADVANCED] = "advanced.xml";
184 config.page[MRESULT] = "mresult.xml";
185 config.page[RRESULT] = "rresult.xml";
186 config.page[MYOPAC] = "myopac.xml";
187 config.page[RDETAIL] = "rdetail.xml";
188 config.page[BBAGS] = "bbags.xml";
189 config.page[REQITEMS] = "reqitems.xml";
190 config.page[CNBROWSE] = "cnbrowse.xml";
197 config.images.logo = "main_logo.jpg";
200 /* set up ID's, CSS, and node names */
202 config.ids.result = {};
203 config.ids.mresult = {};
204 config.ids.advanced = {};
205 config.ids.rresult = {};
206 config.ids.myopac = {};
207 config.ids.rdetail = {};
210 config.css.result = {};
211 config.css.mresult = {};
212 config.css.advanced = {};
213 config.css.rresult = {};
214 config.css.myopac = {};
215 config.css.rdetail = {};
218 config.names.result = {};
219 config.names.mresult = {};
220 config.names.advanced = {};
221 config.names.rresult = {};
222 config.names.myopac = {};
223 config.names.rdetail = {};
226 /* id's shared accross skins. These *must* be defined */
227 config.ids.common = {};
228 config.ids.common.loading = "loading_div";
229 config.ids.common.canvas = "canvas";
230 config.ids.common.canvas_main = "canvas_main";
231 config.ids.common.org_tree = "org_tree";
232 config.ids.common.org_container = "org_container";
238 config.css.hide_me = "hide_me";
239 config.css.dim = "dim";
240 config.css.dim2 = "dim2";
243 /* ---------------------------------------------------------------------------- */
244 /* These are pages that may replace the canvas */
245 /* ---------------------------------------------------------------------------- */
246 config.ids.altcanvas = {};
250 /* ---------------------------------------------------------------------------- */
251 /* Methods are defined as service:method
252 An optional 3rd component is when a method is followed by a :1, such methods
253 have a staff counterpart and should have ".staff" appended to the method
254 before the method is called when in XUL mode */
256 var SEARCH_MRS = 'open-ils.search:open-ils.search.metabib.multiclass:1';
257 var SEARCH_RS = 'open-ils.search:open-ils.search.biblio.multiclass:1';
258 var FETCH_SEARCH_RIDS = "open-ils.search:open-ils.search.biblio.record.class.search:1";
259 var FETCH_MRMODS = "open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve";
260 var FETCH_MODS_FROM_COPY = "open-ils.search:open-ils.search.biblio.mods_from_copy";
261 var FETCH_MR_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.metarecord.copy_count:1";
262 var FETCH_RIDS = "open-ils.search:open-ils.search.biblio.metarecord_to_records:1";
263 var FETCH_RMODS = "open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve";
264 var FETCH_R_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.record.copy_count:1";
265 var FETCH_FLESHED_USER = "open-ils.actor:open-ils.actor.user.fleshed.retrieve";
266 var FETCH_SESSION = "open-ils.auth:open-ils.auth.session.retrieve";
267 var LOGIN_INIT = "open-ils.auth:open-ils.auth.authenticate.init";
268 var LOGIN_COMPLETE = "open-ils.auth:open-ils.auth.authenticate.complete";
269 var LOGIN_DELETE = "open-ils.auth:open-ils.auth.session.delete";
270 var FETCH_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.retrieve";
271 var UPDATE_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.update";
272 var FETCH_COPY_STATUSES = "open-ils.search:open-ils.search.config.copy_status.retrieve.all";
273 var FETCH_COPY_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve";
274 var FETCH_MARC_HTML = "open-ils.search:open-ils.search.biblio.record.html";
276 var FETCH_CHECKED_OUT = "open-ils.circ:open-ils.circ.actor.user.checked_out";
277 var FETCH_CHECKED_OUT_SLIM = "open-ils.circ:open-ils.circ.actor.user.checked_out.opac";
279 var FETCH_CHECKED_OUT_SUM = "open-ils.actor:open-ils.actor.user.checked_out";
280 var FETCH_HOLDS = "open-ils.circ:open-ils.circ.holds.retrieve";
281 var FETCH_FINES_SUMMARY = "open-ils.actor:open-ils.actor.user.fines.summary";
282 var FETCH_TRANSACTIONS = "open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed";
283 var FETCH_MONEY_BILLING = 'open-ils.circ:open-ils.circ.money.billing.retrieve.all';
284 var FETCH_CROSSREF = "open-ils.search:open-ils.search.authority.crossref";
285 var FETCH_CROSSREF_BATCH = "open-ils.search:open-ils.search.authority.crossref.batch";
286 var CREATE_HOLD = "open-ils.circ:open-ils.circ.holds.create";
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_TARGET = 'open-ils.search:open-ils.search.callnumber.browse.target';
302 var FETCH_CNBROWSE_PREV = 'open-ils.search:open-ils.search.callnumber.browse.page_up';
303 var FETCH_CNBROWSE_NEXT = 'open-ils.search:open-ils.search.callnumber.browse.page_down';
304 var FETCH_CONTAINERS = 'open-ils.actor:open-ils.actor.container.retrieve_by_class';
305 var FETCH_CONTAINERS = 'open-ils.actor:open-ils.actor.container.retrieve_by_class';
306 var CREATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.create';
307 var DELETE_CONTAINER = 'open-ils.actor:open-ils.actor.container.full_delete';
308 var CREATE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.create';
309 var DELETE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.delete';
310 var FLESH_CONTAINER = 'open-ils.actor:open-ils.actor.container.flesh';
311 var FLESH_PUBLIC_CONTAINER = 'open-ils.actor:open-ils.actor.container.public.flesh';
312 var UPDATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.update';
313 var FETCH_COPY = 'open-ils.search:open-ils.search.asset.copy.retrieve';
314 var CHECK_HOLD_POSSIBLE = 'open-ils.circ:open-ils.circ.title_hold.is_possible';
315 var UPDATE_HOLD = 'open-ils.circ:open-ils.circ.hold.update';
316 var FETCH_COPIES_FROM_VOLUME = 'open-ils.search:open-ils.search.copies_by_call_number.retrieve';
317 var FETCH_VOLUME_BY_INFO = 'open-ils.search:open-ils.search.call_number.retrieve_by_info'; /* XXX staff method? */
318 var FETCH_VOLUME = 'open-ils.search:open-ils.search.asset.call_number.retrieve';
319 var FETCH_COPY_LOCATIONS = 'open-ils.circ:open-ils.circ.copy_location.retrieve.all';
320 var FETCH_COPY_NOTES = 'open-ils.circ:open-ils.circ.copy_note.retrieve.all';
321 var FETCH_COPY_STAT_CATS = 'open-ils.circ:open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy';
322 var FETCH_LIT_FORMS = 'open-ils.search:open-ils.search.biblio.lit_form_map.retrieve.all';
323 var FETCH_ITEM_FORMS = 'open-ils.search:open-ils.search.biblio.item_form_map.retrieve.all';
324 var FETCH_ITEM_TYPES = 'open-ils.search:open-ils.search.biblio.item_type_map.retrieve.all';
325 var FETCH_AUDIENCES = 'open-ils.search:open-ils.search.biblio.audience_map.retrieve.all';
326 var FETCH_HOLD_STATUS = 'open-ils.circ:open-ils.circ.hold.status.retrieve';
327 var FETCH_NON_CAT_CIRCS = 'open-ils.circ:open-ils.circ.open_non_cataloged_circulation.user';
328 var FETCH_NON_CAT_CIRC = 'open-ils.circ:open-ils.circ.non_cataloged_circulation.retrieve';
329 var FETCH_NON_CAT_TYPES = "open-ils.circ:open-ils.circ.non_cat_types.retrieve.all";
330 var FETCH_BRE = 'open-ils.search:open-ils.search.biblio.record_entry.slim.retrieve';
331 var CHECK_USERNAME = 'open-ils.actor:open-ils.actor.username.exists';
332 var FETCH_CIRC_BY_ID = 'open-ils.circ:open-ils.circ.retrieve';
333 var FETCH_MR_DESCRIPTORS = 'open-ils.search:open-ils.search.metabib.record_to_descriptors';
335 /* ---------------------------------------------------------------------------- */
338 /* ---------------------------------------------------------------------------- */
339 /* event callback functions. Other functions may be appended to these vars to
340 for added functionality. */
342 G.evt = {}; /* events container */
344 function runEvt(scope, name, a, b, c, d, e, f, g) {
345 var evt = G.evt[scope][name];
346 for( var i in evt ) {
347 evt[i](a, b, c, d, e, f, g);
351 /* creates a new event if it doesn't already exist */
352 function createEvt(scope, name) {
353 if(!G.evt[scope]) G.evt[scope] = {};
354 if(G.evt[scope][name] == null)
355 G.evt[scope][name] = [];
358 function attachEvt(scope, name, action) {
359 createEvt(scope, name);
360 G.evt[scope][name].push(action);
363 function detachAllEvt(scope, name) {
364 G.evt[scope][name] = [];
368 createEvt("common", "init"); /* f() : what happens on page init */
369 createEvt("common", "pageRendered"); /* f() : what happens when the page is done (up to the skin to call this even)*/
370 createEvt("common", "unload"); /* f() : what happens on window unload (clean memory, etc.)*/
371 createEvt("common", "locationChanged"); /* f() : what happens when the location has changed */
372 createEvt("common", "locationUpdated"); /* f() : what happens when the location has updated by the code */
374 createEvt("common", "run"); /* f() : make the page do stuff */
375 createEvt("result", "idsReceived"); /* f(ids) */
376 createEvt("rresult", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
377 createEvt("result", "preCollectRecords"); /* f() we're about to go and grab the recs */
379 createEvt("result", "hitCountReceived"); /* f() : display hit info, pagination, etc. */
380 createEvt("result", "recordReceived"); /* f(mvr, pagePosition, isMr) : display the record*/
381 createEvt("result", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
382 createEvt("result", "copyCountsReceived"); /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
383 createEvt("result", "allRecordsReceived"); /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
385 createEvt("rdetail", "recordDrawn"); /* f() : the record has been drawn */
387 createEvt("common", "loggedIn"); /* f() : user has just logged in */
388 createEvt('result', 'zeroHits');
389 createEvt('result', 'lowHits');
390 createEvt('rdetail', 'recordRetrieved'); /* we are about to draw the rdetail page */
391 createEvt('common', 'depthChanged');
392 createEvt('common', 'holdUpdated');
393 createEvt('common', 'holdUpdateCanceled');
395 createEvt('rdetail', 'nextPrevDrawn');