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