1 /* Export some constants ----------------------------------------------------- */
4 var PARAM_TERM = "term"; /* search term */
5 var PARAM_STYPE = "stype"; /* search type */
6 var PARAM_LOCATION = "location" /* current location */;
7 var PARAM_DEPTH = "depth"; /* search depth */
8 var PARAM_FORM = "format"; /* search format */
9 var PARAM_OFFSET = "offset"; /* search offset */
10 var PARAM_COUNT = "count"; /* hits per page */
11 var PARAM_HITCOUNT = "hitcount"; /* hits per page */
12 var PARAM_MRID = "mrid"; /* metarecord id */
13 var PARAM_RID = "rid"; /* record id */
14 var PARAM_ORIGLOC = "orgloc" /* the original location */
15 var PARAM_TOPRANK = "toprank" /* this highest ranking rank */
17 /* URL param values (see comments above) */
37 var COOKIE_SB = "sbe";
38 var COOKIE_SES = "ses";
39 var COOKIE_IDS = "ids";
40 var COOKIE_FONT = "fnt";
41 var COOKIE_SKIN = "skin";
43 /* these are the actual param values - set on page load */
46 var MRESULT = "mresult";
47 var RRESULT = "rresult";
48 var RDETAIL = "rdetail";
49 var MYOPAC = "myopac";
50 var ADVANCED = "advanced";
53 /* search type (STYPE) options */
54 var STYPE_AUTHOR = "author";
55 var STYPE_TITLE = "title";
56 var STYPE_SUBJECT = "subject";
57 var STYPE_SERIES = "series";
58 var STYPE_KEYWORD = "keyword";
61 /* container for global variables shared accross pages */
63 G.user = null; /* global user object */
64 G.ui = {} /* cache of UI components */
67 /* call me after page init and I will load references
68 to all of the ui object id's defined below
69 They will be stored in G.ui.<page>.<thingy>
71 function loadUIObjects() {
72 for( var p in config.ids ) {
74 for( var o in config.ids[p] )
75 G.ui[p][o] = getId(config.ids[p][o]);
79 /* try our best to free memory */
80 function clearUIObjects() {
81 for( var p in config.ids ) {
82 for( var o in config.ids[p] ) {
84 G.ui[p][o].onclick = null;
85 G.ui[p][o].onkeydown = null;
93 /* ----------------------------------------------------------------------------
94 Set up ID's and CSS classes
95 Any new ids, css, etc. may be added by giving the unique names and putting
96 them into the correct scope
97 /* ---------------------------------------------------------------------------- */
101 /* Set up the page names */
103 config.page[HOME] = "index.xml";
104 config.page[ADVANCED] = "advanced.xml";
105 config.page[MRESULT] = "mresult.xml";
106 config.page[RRESULT] = "rresult.xml";
107 config.page[MYOPAC] = "myopac.xml";
108 config.page[RDETAIL] = "rdetail.xml";
115 config.images.logo = "main_logo.jpg";
118 /* set up ID's, CSS, and node names */
120 config.ids.result = {};
121 config.ids.mresult = {};
122 config.ids.advanced = {};
123 config.ids.rresult = {};
124 config.ids.myopac = {};
125 config.ids.rdetail = {};
128 config.css.result = {};
129 config.css.mresult = {};
130 config.css.advanced = {};
131 config.css.rresult = {};
132 config.css.myopac = {};
133 config.css.rdetail = {};
136 config.names.result = {};
137 config.names.mresult = {};
138 config.names.advanced = {};
139 config.names.rresult = {};
140 config.names.myopac = {};
141 config.names.rdetail = {};
144 /* id's shared accross skins. These *must* be defined */
145 config.ids.common = {};
146 config.ids.common.loading = "loading_div";
147 config.ids.common.canvas = "canvas";
148 config.ids.common.canvas_main = "canvas_main";
149 config.ids.common.org_tree = "org_tree";
150 config.ids.common.org_container = "org_container";
156 config.css.hide_me = "hide_me";
157 config.css.dim = "dim";
158 config.css.dim2 = "dim2";
161 /* ---------------------------------------------------------------------------- */
162 /* These are pages that may replace the canvas */
163 /* ---------------------------------------------------------------------------- */
164 config.ids.altcanvas = {};
168 /* ---------------------------------------------------------------------------- */
169 /* Methods are defined as service:method
170 An optional 3rd component is when a method is followed by a :1, such methods
171 have a staff counterpart and should have ".staff" appended to the method
172 before the method is called when in XUL mode */
174 var FETCH_MRCOUNT = "open-ils.search:open-ils.search.biblio.class.count:1";
175 var FETCH_MRIDS = "open-ils.search:open-ils.search.biblio.class:1";
176 var FETCH_MRIDS_FULL = "open-ils.search:open-ils.search.biblio.class.full:1";
177 var FETCH_MRMODS = "open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve";
178 var FETCH_MR_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.metarecord.copy_count:1";
179 var FETCH_RIDS = "open-ils.search:open-ils.search.biblio.metarecord_to_records:1";
180 var FETCH_RMODS = "open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve";
181 var FETCH_R_COPY_COUNTS = "open-ils.search:open-ils.search.biblio.record.copy_count";
182 var FETCH_FLESHED_USER = "open-ils.actor:open-ils.actor.user.fleshed.retrieve";
183 var FETCH_SESSION = "open-ils.auth:open-ils.auth.session.retrieve";
184 var LOGIN_INIT = "open-ils.auth:open-ils.auth.authenticate.init";
185 var LOGIN_COMPLETE = "open-ils.auth:open-ils.auth.authenticate.complete";
186 var LOGIN_DELETE = "open-ils.auth:open-ils.auth.session.delete";
187 var FETCH_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.retrieve";
188 var UPDATE_USER_PREFS = "open-ils.actor:open-ils.actor.patron.settings.update";
189 var FETCH_COPY_STATUSES = "open-ils.search:open-ils.search.config.copy_status.retrieve.all";
190 var FETCH_COPY_COUNTS_SUMMARY = "open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve";
191 var FETCH_MARC_HTML = "open-ils.search:open-ils.search.biblio.record.html";
192 var FETCH_CHECKED_OUT = "open-ils.circ:open-ils.circ.actor.user.checked_out";
193 var FETCH_HOLDS = "open-ils.circ:open-ils.circ.holds.retrieve";
194 var FETCH_FINES_SUMMARY = "open-ils.actor:open-ils.actor.user.fines.summary";
195 var FETCH_TRANSACTIONS = "open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed";
196 var FETCH_CROSSREF = "open-ils.search:open-ils.search.authority.crossref";
197 var FETCH_CROSSREF_BATCH = "open-ils.search:open-ils.search.authority.crossref.batch";
198 var CREATE_HOLD = "open-ils.circ:open-ils.circ.holds.create";
199 var CANCEL_HOLD = "open-ils.circ:open-ils.circ.hold.cancel";
200 var UPDATE_USERNAME = "open-ils.actor:open-ils.actor.user.username.update";
201 var UPDATE_PASSWORD = "open-ils.actor:open-ils.actor.user.password.update";
202 var UPDATE_EMAIL = "open-ils.actor:open-ils.actor.user.email.update";
203 var RENEW_CIRC = "open-ils.circ:open-ils.circ.renew";
204 var CHECK_SPELL = "open-ils.search:open-ils.search.spell_check";
205 var FETCH_REVIEWS = "open-ils.search:open-ils.search.added_content.review.retrieve.all";
206 var FETCH_TOC = "open-ils.search:open-ils.search.added_content.toc.retrieve";
207 var FETCH_ACONT_SUMMARY = "open-ils.search:open-ils.search.added_content.summary.retrieve";
208 /* ---------------------------------------------------------------------------- */
212 /* ---------------------------------------------------------------------------- */
213 /* event callback functions. Other functions may be appended to these vars to
214 for added functionality. */
216 G.evt = {}; /* events container */
218 function runEvt(scope, name, a, b, c, d, e, f, g) {
219 var evt = G.evt[scope][name];
220 for( var i in evt ) {
221 evt[i](a, b, c, d, e, f, g);
225 /* creates a new event if it doesn't already exist */
226 function createEvt(scope, name) {
227 if(!G.evt[scope]) G.evt[scope] = {};
228 if(G.evt[scope][name] == null)
229 G.evt[scope][name] = [];
232 function attachEvt(scope, name, action) {
233 createEvt(scope, name);
234 G.evt[scope][name].push(action);
237 function detachAllEvt(scope, name) {
238 G.evt[scope][name] = [];
242 createEvt("common", "init"); /* f() : what happens on page init */
243 createEvt("common", "pageRendered"); /* f() : what happens when the page is done (up to the skin to call this even)*/
244 createEvt("common", "unload"); /* f() : what happens on window unload (clean memory, etc.)*/
245 createEvt("common", "locationChanged"); /* f() : what happens when the location has changed */
246 createEvt("common", "locationUpdated"); /* f() : what happens when the location has updated by the code */
248 createEvt("common", "run"); /* f() : make the page do stuff */
249 createEvt("result", "idsReceived"); /* f(ids) */
250 createEvt("rresult", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
251 createEvt("result", "preCollectRecords"); /* f() we're about to go and grab the recs */
253 createEvt("result", "hitCountReceived"); /* f() : display hit info, pagination, etc. */
254 createEvt("result", "recordReceived"); /* f(mvr, pagePosition, isMr) : display the record*/
255 createEvt("result", "recordDrawn"); /* f(recordid, linkDOMNode) : after record is drawn, allow others (xul) to plugin actions */
256 createEvt("result", "copyCountsReceived"); /* f(mvr, pagePosition, copyCountInfo) : display copy counts*/
257 createEvt("result", "allRecordsReceived"); /* f(mvrsArray) : add other page stuff, sidebars, etc.*/
259 createEvt("rdetail", "recordDrawn"); /* f() : the record has been drawn */
261 createEvt("common", "loggedIn"); /* f() : user has just logged in */
262 createEvt('result', 'zeroHits');
263 createEvt('result', 'lowHits');
264 createEvt('rdetail', 'recordRetrieved'); /* we are about to draw the rdetail page */