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";
26 /* URL param values (see comments above) */
56 var COOKIE_SB = "sbe";
57 var COOKIE_SES = "ses";
58 var COOKIE_IDS = "ids"; /* list of mrecord ids */
59 var COOKIE_FONT = "fnt";
60 var COOKIE_SKIN = "skin";
61 var COOKIE_RIDS = "rids"; /* list of record ids */
64 var MRESULT = "mresult";
65 var RRESULT = "rresult";
66 var RDETAIL = "rdetail";
67 var MYOPAC = "myopac";
68 var ADVANCED = "advanced";
71 var REQITEMS = "reqitems";
72 var CNBROWSE = "cnbrowse";
74 /* search type (STYPE) options */
75 var STYPE_AUTHOR = "author";
76 var STYPE_TITLE = "title";
77 var STYPE_SUBJECT = "subject";
78 var STYPE_SERIES = "series";
79 var STYPE_KEYWORD = "keyword";
81 /* record-level search types */
82 var RTYPE_MRID = "mrid";
83 var RTYPE_COOKIE = "cookie";
84 var RTYPE_AUTHOR = STYPE_AUTHOR;
85 var RTYPE_SUBJECT = STYPE_SUBJECT;
86 var RTYPE_TITLE = STYPE_TITLE;
87 var RTYPE_SERIES = STYPE_SERIES;
88 var RTYPE_KEYWORD = STYPE_KEYWORD;
89 var RTYPE_LIST = "list";
91 var SORT_TYPE_REL = "rel";
92 var SORT_TYPE_AUTHOR = STYPE_AUTHOR;
93 var SORT_TYPE_TITLE = STYPE_TITLE;
94 var SORT_TYPE_PUBDATE = "pubdate";
95 var SORT_DIR_ASC = "asc";
96 var SORT_DIR_DESC = "desc";
98 /* types of advanced search */
99 var ADVTYPE_MULTI = 'ml';
100 var ADVTYPE_MARC = 'ma';
101 var ADVTYPE_ISBN = 'isbn';
102 var ADVTYPE_ISSN = 'issn';
104 var LOGOUT_WARNING_TIME = 30; /* "head up" for session timeout */
106 /* user preferences */
107 var PREF_HITS_PER = 'opac.hits_per_page';
108 var PREF_BOOKBAG = 'opac.bookbag_enabled';
109 var PREF_DEF_FONT = 'opac.default_font';
112 /* container for global variables shared accross pages */
114 G.user = null; /* global user object */
115 G.ui = {} /* cache of UI components */
119 var REGEX_BARCODE = /^\d+/; /* starts with a number */
122 /* call me after page init and I will load references
123 to all of the ui object id's defined below
124 They will be stored in G.ui.<page>.<thingy>
126 function loadUIObjects() {
127 for( var p in config.ids ) {
129 for( var o in config.ids[p] )
130 G.ui[p][o] = getId(config.ids[p][o]);
134 /* try our best to free memory */
135 function clearUIObjects() {
136 for( var p in config.ids ) {
137 for( var o in config.ids[p] ) {
139 G.ui[p][o].onclick = null;
140 G.ui[p][o].onkeydown = null;
148 /* ----------------------------------------------------------------------------
149 Set up ID's and CSS classes
150 Any new ids, css, etc. may be added by giving the unique names and putting
151 them into the correct scope
152 /* ---------------------------------------------------------------------------- */
156 /* Set up the page names */
158 config.page[HOME] = "index.xml";
159 config.page[ADVANCED] = "advanced.xml";
160 config.page[MRESULT] = "mresult.xml";
161 config.page[RRESULT] = "rresult.xml";
162 config.page[MYOPAC] = "myopac.xml";
163 config.page[RDETAIL] = "rdetail.xml";
164 config.page[BBAGS] = "bbags.xml";
165 config.page[REQITEMS] = "reqitems.xml";
166 config.page[CNBROWSE] = "cnbrowse.xml";
173 config.images.logo = "main_logo.jpg";
176 /* set up ID's, CSS, and node names */
178 config.ids.result = {};
179 config.ids.mresult = {};
180 config.ids.advanced = {};
181 config.ids.rresult = {};
182 config.ids.myopac = {};
183 config.ids.rdetail = {};
186 config.css.result = {};
187 config.css.mresult = {};
188 config.css.advanced = {};
189 config.css.rresult = {};
190 config.css.myopac = {};
191 config.css.rdetail = {};
194 config.names.result = {};
195 config.names.mresult = {};
196 config.names.advanced = {};
197 config.names.rresult = {};
198 config.names.myopac = {};
199 config.names.rdetail = {};
202 /* id's shared accross skins. These *must* be defined */
203 config.ids.common = {};
204 config.ids.common.loading = "loading_div";
205 config.ids.common.canvas = "canvas";
206 config.ids.common.canvas_main = "canvas_main";
207 config.ids.common.org_tree = "org_tree";
208 config.ids.common.org_container = "org_container";
214 config.css.hide_me = "hide_me";
215 config.css.dim = "dim";
216 config.css.dim2 = "dim2";
219 /* ---------------------------------------------------------------------------- */
220 /* These are pages that may replace the canvas */
221 /* ---------------------------------------------------------------------------- */
222 config.ids.altcanvas = {};
226 /* ---------------------------------------------------------------------------- */
227 /* Methods are defined as service:method
228 An optional 3rd component is when a method is followed by a :1, such methods
229 have a staff counterpart and should have ".staff" appended to the method
230 before the method is called when in XUL mode */
232 var FETCH_MRIDS_ = "open-ils.search:open-ils.search.biblio.metabib.class.search:1";
233 var FETCH_SEARCH_RIDS = "open-ils.search:open-ils.search.biblio.record.class.search:1";
234 var FETCH_MRMODS = "open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve";
235 var FETCH_MODS_FROM_COPY = "open-ils.search:open-ils.search.biblio.mods_from_copy";
236 var FETCH_MR_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.metarecord.copy_count:1";
237 var FETCH_RIDS = "open-ils.search:open-ils.search.biblio.metarecord_to_records:1";
238 var FETCH_RMODS = "open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve";
239 var FETCH_R_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.record.copy_count";
240 var FETCH_FLESHED_USER = "open-ils.actor:open-ils.actor.user.fleshed.retrieve";
241 var FETCH_SESSION = "open-ils.auth:open-ils.auth.session.retrieve";
242 var LOGIN_INIT = "open-ils.auth:open-ils.auth.authenticate.init";
243 var LOGIN_COMPLETE = "open-ils.auth:open-ils.auth.authenticate.complete";
244 var LOGIN_DELETE = "open-ils.auth:open-ils.auth.session.delete";
245 var FETCH_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.retrieve";
246 var UPDATE_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.update";
247 var FETCH_COPY_STATUSES = "open-ils.search:open-ils.search.config.copy_status.retrieve.all";
248 var FETCH_COPY_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve";
249 var FETCH_MARC_HTML = "open-ils.search:open-ils.search.biblio.record.html";
250 var FETCH_CHECKED_OUT = "open-ils.circ:open-ils.circ.actor.user.checked_out";
251 var FETCH_CHECKED_OUT_SLIM = "open-ils.circ:open-ils.circ.actor.user.checked_out.slim";
252 var FETCH_HOLDS = "open-ils.circ:open-ils.circ.holds.retrieve";
253 var FETCH_FINES_SUMMARY = "open-ils.actor:open-ils.actor.user.fines.summary";
254 var FETCH_TRANSACTIONS = "open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed";
255 var FETCH_MONEY_BILLING = 'open-ils.circ:open-ils.circ.money.billing.retrieve.all';
256 var FETCH_CROSSREF = "open-ils.search:open-ils.search.authority.crossref";
257 var FETCH_CROSSREF_BATCH = "open-ils.search:open-ils.search.authority.crossref.batch";
258 var CREATE_HOLD = "open-ils.circ:open-ils.circ.holds.create";
259 var CANCEL_HOLD = "open-ils.circ:open-ils.circ.hold.cancel";
260 var UPDATE_USERNAME = "open-ils.actor:open-ils.actor.user.username.update";
261 var UPDATE_PASSWORD = "open-ils.actor:open-ils.actor.user.password.update";
262 var UPDATE_EMAIL = "open-ils.actor:open-ils.actor.user.email.update";
263 var RENEW_CIRC = "open-ils.circ:open-ils.circ.renew";
264 var CHECK_SPELL = "open-ils.search:open-ils.search.spell_check";
265 var FETCH_REVIEWS = "open-ils.search:open-ils.search.added_content.review.retrieve.all";
266 var FETCH_TOC = "open-ils.search:open-ils.search.added_content.toc.retrieve";
267 var FETCH_ACONT_SUMMARY = "open-ils.search:open-ils.search.added_content.summary.retrieve";
268 var FETCH_USER_BYBARCODE = "open-ils.actor:open-ils.actor.user.fleshed.retrieve_by_barcode";
269 var FETCH_ADV_MRIDS = "open-ils.search:open-ils.search.biblio.multiclass:1";
270 var FETCH_ADV_MARC_MRIDS = "open-ils.search:open-ils.search.biblio.marc:1";
271 var FETCH_ADV_ISBN_MRIDS = "open-ils.search:open-ils.search.biblio.isbn";
272 var FETCH_ADV_ISSN_MRIDS = "open-ils.search:open-ils.search.biblio.issn";
273 var FETCH_CNBROWSE_TARGET = 'open-ils.search:open-ils.search.callnumber.browse.target';
274 var FETCH_CNBROWSE_PREV = 'open-ils.search:open-ils.search.callnumber.browse.page_up';
275 var FETCH_CNBROWSE_NEXT = 'open-ils.search:open-ils.search.callnumber.browse.page_down';
276 var FETCH_CONTAINERS = 'open-ils.actor:open-ils.actor.container.retrieve_by_class';
277 var FETCH_CONTAINERS = 'open-ils.actor:open-ils.actor.container.retrieve_by_class';
278 var CREATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.create';
279 var DELETE_CONTAINER = 'open-ils.actor:open-ils.actor.container.full_delete';
280 var CREATE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.create';
281 var DELETE_CONTAINER_ITEM = 'open-ils.actor:open-ils.actor.container.item.delete';
282 var FLESH_CONTAINER = 'open-ils.actor:open-ils.actor.container.flesh';
283 var FLESH_PUBLIC_CONTAINER = 'open-ils.actor:open-ils.actor.container.public.flesh';
284 var UPDATE_CONTAINER = 'open-ils.actor:open-ils.actor.container.update';
285 var FETCH_COPY = 'open-ils.search:open-ils.search.asset.copy.retrieve';
286 var CHECK_HOLD_POSSIBLE = 'open-ils.circ:open-ils.circ.title_hold.is_possible';
287 var UPDATE_HOLD = 'open-ils.circ:open-ils.circ.hold.update';
288 var FETCH_BIBLIO_NOTES = 'open-ils.circ:open-ils.circ.biblio_notes.public.batch.retrieve';
289 /* ---------------------------------------------------------------------------- */
292 /* ---------------------------------------------------------------------------- */
293 /* event callback functions. Other functions may be appended to these vars to
294 for added functionality. */
296 G.evt = {}; /* events container */
298 function runEvt(scope, name, a, b, c, d, e, f, g) {
299 var evt = G.evt[scope][name];
300 for( var i in evt ) {
301 evt[i](a, b, c, d, e, f, g);
305 /* creates a new event if it doesn't already exist */
306 function createEvt(scope, name) {
307 if(!G.evt[scope]) G.evt[scope] = {};
308 if(G.evt[scope][name] == null)
309 G.evt[scope][name] = [];
312 function attachEvt(scope, name, action) {
313 createEvt(scope, name);
314 G.evt[scope][name].push(action);
317 function detachAllEvt(scope, name) {
318 G.evt[scope][name] = [];
322 createEvt("common", "init"); /* f() : what happens on page init */
323 createEvt("common", "pageRendered"); /* f() : what happens when the page is done (up to the skin to call this even)*/
324 createEvt("common", "unload"); /* f() : what happens on window unload (clean memory, etc.)*/
325 createEvt("common", "locationChanged"); /* f() : what happens when the location has changed */
326 createEvt("common", "locationUpdated"); /* f() : what happens when the location has updated by the code */
328 createEvt("common", "run"); /* f() : make the page do stuff */
329 createEvt("result", "idsReceived"); /* f(ids) */
330 createEvt("rresult", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
331 createEvt("result", "preCollectRecords"); /* f() we're about to go and grab the recs */
333 createEvt("result", "hitCountReceived"); /* f() : display hit info, pagination, etc. */
334 createEvt("result", "recordReceived"); /* f(mvr, pagePosition, isMr) : display the record*/
335 createEvt("result", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
336 createEvt("result", "copyCountsReceived"); /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
337 createEvt("result", "allRecordsReceived"); /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
339 createEvt("rdetail", "recordDrawn"); /* f() : the record has been drawn */
341 createEvt("common", "loggedIn"); /* f() : user has just logged in */
342 createEvt('result', 'zeroHits');
343 createEvt('result', 'lowHits');
344 createEvt('rdetail', 'recordRetrieved'); /* we are about to draw the rdetail page */
345 createEvt('common', 'depthChanged');