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_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";
22 var PARAM_SORT_DIR = "sd";
23 var PARAM_DEBUG = "dbg";
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';
31 /* URL param values (see comments above) */
66 var COOKIE_SB = "sbe";
67 var COOKIE_SES = "ses";
68 var COOKIE_IDS = "ids"; /* list of mrecord ids */
69 var COOKIE_FONT = "fnt";
70 var COOKIE_SKIN = "skin";
71 var COOKIE_RIDS = "rids"; /* list of record ids */
74 var MRESULT = "mresult";
75 var RRESULT = "rresult";
76 var RDETAIL = "rdetail";
77 var MYOPAC = "myopac";
78 var ADVANCED = "advanced";
81 var REQITEMS = "reqitems";
82 var CNBROWSE = "cnbrowse";
84 /* search type (STYPE) options */
85 var STYPE_AUTHOR = "author";
86 var STYPE_TITLE = "title";
87 var STYPE_SUBJECT = "subject";
88 var STYPE_SERIES = "series";
89 var STYPE_KEYWORD = "keyword";
91 /* record-level search types */
92 var RTYPE_MRID = "mrid";
93 var RTYPE_COOKIE = "cookie";
94 var RTYPE_AUTHOR = STYPE_AUTHOR;
95 var RTYPE_SUBJECT = STYPE_SUBJECT;
96 var RTYPE_TITLE = STYPE_TITLE;
97 var RTYPE_SERIES = STYPE_SERIES;
98 var RTYPE_KEYWORD = STYPE_KEYWORD;
99 var RTYPE_LIST = "list";
100 var RTYPE_MULTI = 'multi';
102 var SORT_TYPE_REL = "rel";
103 var SORT_TYPE_AUTHOR = STYPE_AUTHOR;
104 var SORT_TYPE_TITLE = STYPE_TITLE;
105 var SORT_TYPE_PUBDATE = "pubdate";
106 var SORT_DIR_ASC = "asc";
107 var SORT_DIR_DESC = "desc";
109 /* types of advanced search */
110 var ADVTYPE_MULTI = 'ml';
111 var ADVTYPE_MARC = 'ma';
112 var ADVTYPE_ISBN = 'isbn';
113 var ADVTYPE_ISSN = 'issn';
115 var LOGOUT_WARNING_TIME = 30; /* "head up" for session timeout */
117 /* user preferences */
118 var PREF_HITS_PER = 'opac.hits_per_page';
119 //var PREF_BOOKBAG = 'opac.bookbag_enabled';
120 var PREF_DEF_FONT = 'opac.default_font';
121 var PREF_HOLD_NOTIFY = 'opac.hold_notify';
124 /* container for global variables shared accross pages */
126 G.user = null; /* global user object */
127 G.ui = {} /* cache of UI components */
131 var REGEX_BARCODE = /^\d+/; /* starts with a number */
132 var REGEX_PHONE = /^\d{3}-\d{3}-\d{4}$/; /* 111-222-3333 */
135 /* call me after page init and I will load references
136 to all of the ui object id's defined below
137 They will be stored in G.ui.<page>.<thingy>
139 function loadUIObjects() {
140 for( var p in config.ids ) {
142 for( var o in config.ids[p] )
143 G.ui[p][o] = getId(config.ids[p][o]);
147 /* try our best to free memory */
148 function clearUIObjects() {
149 for( var p in config.ids ) {
150 for( var o in config.ids[p] ) {
152 G.ui[p][o].onclick = null;
153 G.ui[p][o].onkeydown = null;
161 /* ----------------------------------------------------------------------------
162 Set up ID's and CSS classes
163 Any new ids, css, etc. may be added by giving the unique names and putting
164 them into the correct scope
165 /* ---------------------------------------------------------------------------- */
169 /* Set up the page names */
171 config.page[HOME] = "index.xml";
172 config.page[ADVANCED] = "advanced.xml";
173 config.page[MRESULT] = "mresult.xml";
174 config.page[RRESULT] = "rresult.xml";
175 config.page[MYOPAC] = "myopac.xml";
176 config.page[RDETAIL] = "rdetail.xml";
177 config.page[BBAGS] = "bbags.xml";
178 config.page[REQITEMS] = "reqitems.xml";
179 config.page[CNBROWSE] = "cnbrowse.xml";
186 config.images.logo = "main_logo.jpg";
189 /* set up ID's, CSS, and node names */
191 config.ids.result = {};
192 config.ids.mresult = {};
193 config.ids.advanced = {};
194 config.ids.rresult = {};
195 config.ids.myopac = {};
196 config.ids.rdetail = {};
199 config.css.result = {};
200 config.css.mresult = {};
201 config.css.advanced = {};
202 config.css.rresult = {};
203 config.css.myopac = {};
204 config.css.rdetail = {};
207 config.names.result = {};
208 config.names.mresult = {};
209 config.names.advanced = {};
210 config.names.rresult = {};
211 config.names.myopac = {};
212 config.names.rdetail = {};
215 /* id's shared accross skins. These *must* be defined */
216 config.ids.common = {};
217 config.ids.common.loading = "loading_div";
218 config.ids.common.canvas = "canvas";
219 config.ids.common.canvas_main = "canvas_main";
220 config.ids.common.org_tree = "org_tree";
221 config.ids.common.org_container = "org_container";
227 config.css.hide_me = "hide_me";
228 config.css.dim = "dim";
229 config.css.dim2 = "dim2";
232 /* ---------------------------------------------------------------------------- */
233 /* These are pages that may replace the canvas */
234 /* ---------------------------------------------------------------------------- */
235 config.ids.altcanvas = {};
239 /* ---------------------------------------------------------------------------- */
240 /* Methods are defined as service:method
241 An optional 3rd component is when a method is followed by a :1, such methods
242 have a staff counterpart and should have ".staff" appended to the method
243 before the method is called when in XUL mode */
245 var SEARCH_MRS = 'open-ils.search:open-ils.search.metabib.multiclass:1';
246 var SEARCH_RS = 'open-ils.search:open-ils.search.biblio.multiclass:1';
248 var FETCH_MRIDS_ = "open-ils.search:open-ils.search.biblio.metabib.class.search: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.slim";
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 /* ---------------------------------------------------------------------------- */
318 /* ---------------------------------------------------------------------------- */
319 /* event callback functions. Other functions may be appended to these vars to
320 for added functionality. */
322 G.evt = {}; /* events container */
324 function runEvt(scope, name, a, b, c, d, e, f, g) {
325 var evt = G.evt[scope][name];
326 for( var i in evt ) {
327 evt[i](a, b, c, d, e, f, g);
331 /* creates a new event if it doesn't already exist */
332 function createEvt(scope, name) {
333 if(!G.evt[scope]) G.evt[scope] = {};
334 if(G.evt[scope][name] == null)
335 G.evt[scope][name] = [];
338 function attachEvt(scope, name, action) {
339 createEvt(scope, name);
340 G.evt[scope][name].push(action);
343 function detachAllEvt(scope, name) {
344 G.evt[scope][name] = [];
348 createEvt("common", "init"); /* f() : what happens on page init */
349 createEvt("common", "pageRendered"); /* f() : what happens when the page is done (up to the skin to call this even)*/
350 createEvt("common", "unload"); /* f() : what happens on window unload (clean memory, etc.)*/
351 createEvt("common", "locationChanged"); /* f() : what happens when the location has changed */
352 createEvt("common", "locationUpdated"); /* f() : what happens when the location has updated by the code */
354 createEvt("common", "run"); /* f() : make the page do stuff */
355 createEvt("result", "idsReceived"); /* f(ids) */
356 createEvt("rresult", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
357 createEvt("result", "preCollectRecords"); /* f() we're about to go and grab the recs */
359 createEvt("result", "hitCountReceived"); /* f() : display hit info, pagination, etc. */
360 createEvt("result", "recordReceived"); /* f(mvr, pagePosition, isMr) : display the record*/
361 createEvt("result", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
362 createEvt("result", "copyCountsReceived"); /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
363 createEvt("result", "allRecordsReceived"); /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
365 createEvt("rdetail", "recordDrawn"); /* f() : the record has been drawn */
367 createEvt("common", "loggedIn"); /* f() : user has just logged in */
368 createEvt('result', 'zeroHits');
369 createEvt('result', 'lowHits');
370 createEvt('rdetail', 'recordRetrieved'); /* we are about to draw the rdetail page */
371 createEvt('common', 'depthChanged');