b17a0c4e681b3fd850a5ec89f846854672bda549
[Evergreen.git] / Open-ILS / web / opac / common / js / opac_utils.js
1 /* - Request ------------------------------------------------------------- */
2 function Request(type) {
3         var s = type.split(":");
4         if(s[2] == "1" && isXUL()) s[1] += ".staff";
5         this.request = new RemoteRequest(s[0], s[1]);
6         for( var x = 1; x!= arguments.length; x++ ) 
7                 this.request.addParam(arguments[x]);
8 }
9
10 Request.prototype.callback = function(cal) { this.request.setCompleteCallback(cal); }
11 Request.prototype.send          = function(block){this.request.send(block);}
12 Request.prototype.result        = function(){return this.request.getResultObject();}
13
14 function showCanvas() {
15         for( var x in G.ui.altcanvas ) {
16                 hideMe(G.ui.altcanvas[x]);
17         }
18         hideMe(G.ui.common.loading);
19         unHideMe(G.ui.common.canvas_main);
20         G.ui.searchbar.text.focus(); 
21 }
22
23 function swapCanvas(newNode) {
24         for( var x in G.ui.altcanvas ) 
25                 hideMe(G.ui.altcanvas[x]);
26
27         hideMe(G.ui.common.loading);
28         hideMe(G.ui.common.canvas_main);
29         unHideMe(newNode);
30 }
31
32 /* finds the name of the current page */
33 var currentPage = null;
34 function findCurrentPage() {
35         if(currentPage) return currentPage;
36
37         var pages = [];
38         for( var p in config.page ) pages.push(config.page[p]);
39         pages = pages.sort( function(a,b){ return - (a.length - b.length); } );
40
41         var path = location.pathname;
42         if(!path.match(/.*\.xml$/))
43                 path += "index.xml"; /* in case they go to  / */
44
45         var page = null;
46         for( var p in pages ) {
47                 if( path.indexOf(pages[p]) != -1)
48                         page = pages[p];
49         }
50
51         for( var p in config.page ) {
52                 if(config.page[p] == page) {
53                         currentPage = p;
54                         return p;
55                 }
56         }
57         return null;
58 }
59
60
61 /* sets all of the params values  ----------------------------- */
62 function initParams() {
63         var cgi = new CGI();    
64
65         TERM    = cgi.param(PARAM_TERM);
66         STYPE   = cgi.param(PARAM_STYPE);
67         FORM    = cgi.param(PARAM_FORM);
68
69         LOCATION        = parseInt(cgi.param(PARAM_LOCATION));
70         ORIGLOC = parseInt(cgi.param(PARAM_ORIGLOC));
71         DEPTH           = parseInt(cgi.param(PARAM_DEPTH));
72         OFFSET  = parseInt(cgi.param(PARAM_OFFSET));
73         COUNT           = parseInt(cgi.param(PARAM_COUNT));
74         HITCOUNT        = parseInt(cgi.param(PARAM_HITCOUNT));
75         MRID            = parseInt(cgi.param(PARAM_MRID));
76         RID             = parseInt(cgi.param(PARAM_RID));
77         TOPRANK  = parseFloat(cgi.param(PARAM_TOPRANK));
78
79         /* set up some sane defaults */
80         if(isNaN(LOCATION))     LOCATION        = 1;
81         if(isNaN(DEPTH))                DEPTH           = 0;
82         if(isNaN(OFFSET))               OFFSET  = 0;
83         if(isNaN(COUNT))                COUNT           = 10;
84         if(isNaN(HITCOUNT))     HITCOUNT        = 0;
85         if(isNaN(MRID))         MRID            = 0;
86         if(isNaN(RID))                  RID             = 0;
87         if(isNaN(ORIGLOC))      ORIGLOC = 0;
88         if(isNaN(TOPRANK))      TOPRANK = 1;
89 }
90
91 function initCookies() {
92         FONTSIZE = "medium";
93         var font = fontCookie.get(COOKIE_FONT);
94         if(font) FONTSIZE = font;
95         SKIN = skinCookie.get(COOKIE_SKIN);
96 }
97
98 /* URL param accessors */
99 function getTerm(){return TERM;}
100 function getStype(){return STYPE;}
101 function getLocation(){return LOCATION;}
102 function getDepth(){return DEPTH;}
103 function getForm(){return FORM;}
104 function getOffset(){return OFFSET;}
105 function getDisplayCount(){return COUNT;}
106 function getHitCount(){return HITCOUNT;}
107 function getMrid(){return MRID;};
108 function getRid(){return RID;};
109 function getOrigLocation(){return ORIGLOC;}
110 function getTopRank(){return TOPRANK;}
111
112 function getSearchBarExtras(){return SBEXTRAS;}
113 function getFontSize(){return FONTSIZE;};
114 function getSkin(){return SKIN;};
115
116
117 function findBasePath() {
118         var path = location.pathname;
119         if(!path.match(/.*\.xml$/)) path += "index.xml"; 
120         var idx = path.indexOf(config.page[findCurrentPage()]);
121         return path.substring(0, idx);
122 }
123
124 function findBaseURL(ssl) {
125         var path = findBasePath();
126         var proto = (ssl) ? "https:" : "http:";
127         return proto + "//" + location.host + path;
128         dump( 'ssl: ' + ssl + 'proto ' + proto );
129 }
130
131 function buildImageLink(name, ssl) {
132         return findBaseURL(ssl) + "../../../images/" + name;
133 }
134
135 function  buildOPACLink(args, slim, ssl) {
136
137         if(!args) args = {};
138         var string = "";
139
140         if(!slim) {
141                 string = findBaseURL(ssl);
142                 if(args.page) string += config.page[args.page];
143                 else string += config.page[findCurrentPage()];
144         }
145
146         string += "?";
147
148         for( var x in args ) {
149                 if(x == "page" || args[x] == null) continue;
150                 string += "&" + x + "=" + encodeURIComponent(args[x]);
151         }
152
153         string += _appendParam(TERM,            PARAM_TERM, args, getTerm, string);
154         string += _appendParam(STYPE,           PARAM_STYPE, args, getStype, string);
155         string += _appendParam(LOCATION, PARAM_LOCATION, args, getLocation, string);
156         string += _appendParam(DEPTH,           PARAM_DEPTH, args, getDepth, string);
157         string += _appendParam(FORM,            PARAM_FORM, args, getForm, string);
158         string += _appendParam(OFFSET,  PARAM_OFFSET, args, getOffset, string);
159         string += _appendParam(COUNT,           PARAM_COUNT, args, getDisplayCount, string);
160         string += _appendParam(HITCOUNT, PARAM_HITCOUNT, args, getHitCount, string);
161         string += _appendParam(MRID,            PARAM_MRID, args, getMrid, string);
162         string += _appendParam(RID,             PARAM_RID, args, getRid, string);
163         string += _appendParam(TOPRANK, PARAM_TOPRANK, args, getTopRank, string);
164
165         return string.replace(/\&$/,'').replace(/\?\&/,"?");    
166 }
167
168 function _appendParam( fieldVar, fieldName, overrideArgs, getFunc, string ) {
169         var ret = "";
170         if( fieldVar != null && overrideArgs[fieldName] == null ) 
171                 ret = "&" + fieldName + "=" + encodeURIComponent(getFunc());
172         return ret;
173 }
174
175 /* ----------------------------------------------------------------------- */
176 function cleanISBN(isbn) {
177    if(isbn) {
178       isbn = isbn.toString().replace(/^\s+/,"");
179       var idx = isbn.indexOf(" ");
180       if(idx > -1) { isbn = isbn.substring(0, idx); }
181    } else isbn = "";
182    return isbn;
183 }       
184
185
186 /* builds a link that goes to the title listings for a metarecord */
187 function buildTitleLink(rec, link) {
188         if(!rec) return;
189         link.appendChild(text(normalize(truncate(rec.title(), 65))));
190         var args = {};
191         args.page = RRESULT;
192         args[PARAM_OFFSET] = 0;
193         args[PARAM_MRID] = rec.doc_id();
194         link.setAttribute("href", buildOPACLink(args));
195 }
196
197 function buildTitleDetailLink(rec, link) {
198         if(!rec) return;
199         link.appendChild(text(normalize(truncate(rec.title(), 65))));
200         var args = {};
201         args.page = RDETAIL;
202         args[PARAM_OFFSET] = 0;
203         args[PARAM_RID] = rec.doc_id();
204         link.setAttribute("href", buildOPACLink(args));
205 }
206
207 /* 'type' is one of STYPE_AUTHOR, STYPE_SUBJECT, ... found in config.js 
208         'trunc' is the number of characters to show in the string, defaults to 65 */
209 function buildSearchLink(type, string, linknode, trunc) {
210         if(!trunc) trunc = 65;
211         var args = {};
212         args.page = MRESULT;
213         args[PARAM_OFFSET] = 0;
214         args[PARAM_TERM] = string;
215         args[PARAM_STYPE] = type;
216         linknode.appendChild(text(normalize(truncate(string, trunc))));
217         linknode.setAttribute("href", buildOPACLink(args));
218 }
219
220
221 /* ----------------------------------------------------------------------- */
222 /* user session handling */
223 /* ----------------------------------------------------------------------- */
224 /* session is the login session.  If no session is provided, we attempt
225         to find one in the cookies.  If 'force' is true we retrieve the 
226         user from the server even if there is already a global user present.
227         if ses != G.user.session, we also force a grab */
228 var cookie = new cookieObject("ses", 1, "/", COOKIE_SES);
229 function grabUser(ses, force) {
230
231         if(!ses) ses = cookie.get(COOKIE_SES);
232         if(!ses) return false;
233
234         if(!force) 
235                 if(G.user && G.user.session == ses)
236                         return G.user;
237
238         /* first make sure the session is valid */
239         var request = new Request(FETCH_SESSION, ses );
240         request.send(true);
241         var user = request.result();
242         if( !(typeof user == 'object' && user._isfieldmapper) ) {
243                 return false;
244         }
245
246         G.user = user;
247         G.user.fleshed = false;
248         G.user.session = ses;
249         cookie.put(COOKIE_SES, ses);
250         cookie.write();
251
252         return G.user;
253
254 }
255
256
257 /* sets the 'prefs' field of the user object to their preferences 
258         and returns the preferences */
259 function grabUserPrefs(user, force) {
260         if(user == null) user = G.user;
261         if(!force && user.prefs) return user.prefs;     
262         var req = new Request(FETCH_USER_PREFS, user.session, user.id());
263         req.send(true);
264         user.prefs = req.result();
265         return user.prefs;
266 }
267
268 function grabFleshedUser() {
269
270         if(!G.user || !G.user.session) {
271                 grabUser();     
272                 if(!G.user || !G.user.session) return null;
273         }
274
275         if(G.user.fleshed) return G.user;
276
277    var req = new Request(FETCH_FLESHED_USER, G.user.session);
278         req.send(true);
279
280         G.user = req.result();
281
282         if(!G.user || G.user.length == 0) { 
283                 G.user = null; return false; 
284                 cookie.remove(COOKIE_SES);
285         }
286
287         G.user.session = ses;
288         G.user.fleshed = true;
289
290         cookie.put(COOKIE_SES, ses); /*  update the cookie */
291         cookie.write();
292
293         return G.user;
294 }
295
296 var skinCookie = new cookieObject("skin", 1, "/", COOKIE_SKIN);
297 function checkUserSkin(new_skin) {
298
299         return; /* XXX do some debugging with this... */
300
301         var user_skin = getSkin();
302         var cur_skin = grabSkinFromURL();
303
304         if(new_skin) user_skin = new_skin;
305
306         if(!user_skin) {
307
308                 if(grabUser()) {
309                         if(grabUserPrefs()) {
310                                 user_skin = G.user.prefs["opac.skin"];
311                                 skinCookie.put( COOKIE_SKIN, user_skin );
312                                 skinCookie.write();
313                         }
314                 }
315         }
316
317         if(!user_skin) return;
318
319         if( cur_skin != user_skin ) {
320                 var url = buildOPACLink();
321                 goTo(url.replace(cur_skin, user_skin));
322         }
323 }
324
325 function updateUserSetting(setting, value, user) {
326         if(user == null) user = G.user;
327         var a = {};
328         a[setting] = value;
329         var req = new Request( UPDATE_USER_PREFS, user.session, a );
330         req.send(true);
331         return req.result();
332 }
333
334 function grabSkinFromURL() {
335         var path = findBasePath();
336         path = path.replace("/xml/", "");
337         var skin = "";
338         for( var i = path.length - 1; i >= 0; i-- ) {
339                 var ch = path.charAt(i);
340                 if(ch == "/") break;
341                 skin += ch;
342         }
343
344         var skin2 = "";
345         for( i = skin.length - 1; i >= 0; i--)
346                 skin2 += skin.charAt(i);
347
348         return skin2;
349 }
350
351
352 /* returns a fleshed G.user on success, false on failure */
353 function doLogin() {
354
355         var uname = G.ui.login.username.value;
356         var passwd = G.ui.login.password.value; 
357
358         var init_request = new Request( LOGIN_INIT, uname );
359    init_request.send(true);
360    var seed = init_request.result();
361
362    if( ! seed || seed == '0') {
363       alert( "Error Communicating with Authentication Server" );
364       return null;
365    }
366
367    var auth_request = new Request( LOGIN_COMPLETE, 
368                 uname, hex_md5(seed + hex_md5(passwd)), "opac");
369
370
371    auth_request.send(true);
372    var auth_result = auth_request.result();
373
374    if(auth_result == '0' || auth_result == null || auth_result.length == 0) { 
375                 alert("Login failed");
376                 return false; 
377         }
378
379         var u = grabUser(auth_result, true);
380         if(u) runEvt( "common", "locationChanged", u.home_ou(), findOrgDepth(u.home_ou()) );
381
382         checkUserSkin();
383
384         return u;
385 }
386
387 function doLogout() {
388
389         /* be nice and delete the session from the server */
390         if(G.user && G.user.session) { 
391                 var req = new Request(LOGIN_DELETE, G.user.session);
392       req.send(true);
393                 try { req.result(); } catch(E){}
394     }
395
396         G.user = null;
397         cookie.remove(COOKIE_SES);
398         skinCookie.remove(COOKIE_SKIN);
399         checkUserSkin("default");
400
401         var args = {};
402         args[PARAM_TERM] = "";
403         args[PARAM_LOCATION] = globalOrgTree.id();
404         args[PARAM_DEPTH] = findOrgDepth(globalOrgTree);
405         args.page = "home";
406
407         goTo(buildOPACLink(args));
408 }
409
410
411 function hideMe(obj) { addCSSClass(obj, config.css.hide_me); } 
412 function unHideMe(obj) { removeCSSClass(obj, config.css.hide_me); }
413
414
415 /* ----------------------------------------------------------------------- */
416 /* build the org tree */
417 /* ----------------------------------------------------------------------- */
418 function drawOrgTree() {
419         //G.ui.common.org_tree.innerHTML = buildOrgSelector().toString();
420         //buildOrgSelector(G.ui.common.org_tree, orgTreeSelector);
421         setTimeout( 'buildOrgSelector(G.ui.common.org_tree, orgTreeSelector);', 10 );
422 }
423         
424 var orgTreeSelector;
425 function buildOrgSelector(node) {
426         //var tree = new dTree("orgTreeSelector"); 
427         var tree = new SlimTree(node,'orgTreeSelector');
428         orgTreeSelector = tree;
429         for( var i in orgArraySearcher ) { 
430                 var node = orgArraySearcher[i];
431                 if( node == null ) continue;
432                 if(node.parent_ou() == null)
433                         tree.addNode(node.id(), -1, node.name(), 
434                                 "javascript:orgSelect(" + node.id() + ");", node.name());
435                 else {
436                         tree.addNode(node.id(), findOrgUnit(node.parent_ou()).id(), node.name(), 
437                                 "javascript:orgSelect(" + node.id() + ");", node.name());
438                 }
439         }
440         hideMe($('org_loading_div'));
441         unHideMe($('org_selector_tip'));
442         return tree;
443 }
444
445 function orgSelect(id) {
446         showCanvas();
447         runEvt("common", "locationChanged", id, findOrgDepth(id) );
448
449         removeChildren(G.ui.common.now_searching);
450         G.ui.common.now_searching.appendChild(text(findOrgUnit(id).name()));
451 }
452
453 var fontCookie = new cookieObject("fonts", 1, "/", COOKIE_FONT);
454 function setFontSize(size) {
455         scaleFonts(size);
456         fontCookie.put(COOKIE_FONT, size);
457         fontCookie.write();
458 }
459
460
461 var resourceFormats = [
462    "text",
463    "moving image",
464    "sound recording", "software, multimedia",
465    "still images",
466    "cartographic",
467    "mixed material",
468    "notated music",
469    "three dimensional object" ];
470
471
472 function modsFormatToMARC(format) {
473    switch(format) {
474       case "text":
475          return "at";
476       case "moving image":
477          return "g";
478       case "sound recording":
479          return "ij";
480       case "sound recording-nonmusical":
481          return "i";
482       case "sound recording-musical":
483          return "j";
484       case "software, multimedia":
485          return "m";
486       case "still images":
487          return "k";
488       case "cartographic":
489          return "ef";
490       case "mixed material":
491          return "op";
492       case "notated music":
493          return "cd";
494       case "three dimensional object":
495          return "r";
496    }
497    return "at";
498 }
499
500
501 function MARCFormatToMods(format) {
502    switch(format) {
503       case "a":
504       case "t":
505          return "text";
506       case "g":
507          return "moving image";
508       case "i":
509          return "sound recording-nonmusical";
510       case "j":
511          return "sound recording-musical";
512       case "m":
513          return "software, multimedia";
514       case "k":
515          return "still images";
516       case "e":
517       case "f":
518          return "cartographic";
519       case "o":
520       case "p":
521          return "mixed material";
522       case "c":
523       case "d":
524          return "notated music";
525       case "r":
526          return "three dimensional object";
527    }
528    return "text";
529 }
530
531 function setResourcePic( img, resource ) {
532         img.setAttribute( "src", "../../../images/tor/" + resource + ".jpg");
533         img.title = resource;
534 }
535
536
537
538 function msg( text ) {
539         try {
540                 alert( text );
541         } catch(e) {}
542 }
543
544 function findRecord(id,type) {
545         try {
546                 for( var i = 0; i != recordsCache.length; i++ ) {
547                         var rec = recordsCache[i];
548                         if( rec && rec.doc_id() == id ) return rec;
549                 }
550         } catch(E){}
551         var meth = FETCH_RMODS
552         if(type == 'M') meth = FETCH_MRMODS;
553         var req = new Request(meth, id);
554         req.send(true);
555         return req.result();
556 }
557
558
559
560