Factor out duplicate author/subject facet-generation code into new
[mkws-moved-to-github.git] / experiments / spclient / mkws.js
1 /* A very simple client that shows a basic usage of the pz2.js
2 */
3
4 "use strict"; // HTML5: disable for debug >= 2
5
6 /* 
7  * global config object: mkws_config 
8  * 
9  * needs to be defined in the HTML header before 
10  * including this JS file
11  */
12
13 if (!mkws_config)
14     var mkws_config = {}; // for the guys who forgot to define mkws_config...
15
16 if (typeof mkws_config.use_service_proxy === 'undefined')
17     mkws_config.use_service_proxy = true;
18
19 var mkws_debug = 1;
20
21 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
22 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
23
24 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
25 var usesessions = mkws_config.use_service_proxy ? false : true;
26
27
28 var mkws_locale_lang = {
29     "de": {
30         "Authors": "Autoren",
31         "Subjects": "Schlagwörter",
32         "Sources": "Daten und Quellen",
33         "Termlists": "Termlisten",
34         "Next": "Weiter",
35         "Prev": "Zurück",
36         "Search": "Suche",
37         "Sort by": "Sortieren nach",
38         "and show": "und zeige",
39         "per page": "pro Seite",
40         "Displaying": "Zeige",
41         "to": "von",
42         "of": "aus",
43         "found": "gefunden",
44         "Title": "Titel",
45         "Author": "Autor",
46         "Date": "Datum",
47         "Subject": "Schlagwort",
48         "Location": "Ort",
49
50         "dummy": "dummy"
51     },
52
53     "da": {
54         "Authors": "Forfattere",
55         "Subjects": "Emner",
56         "Sources": "Kilder",
57         "Termlists": "Termlists",
58         "Next": "Næste",
59         "Prev": "Forrige",
60         "Search": "Søg",
61         "Sort by": "Sorter efter",
62         "and show": "og vis",
63         "per page": "per side",
64         "Displaying": "Viser",
65         "to": "til",
66         "of": "ud af",
67         "found": "fandt",
68         "Title": "Title",
69         "Author": "Forfatter",
70         "Date": "Dato",
71         "Subject": "Emneord",
72         "Location": "Lokation",
73
74         "dummy": "dummy"
75     }
76 };
77
78 // create a parameters array and pass it to the pz2's constructor
79 // then register the form submit event with the pz2.search function
80 // autoInit is set to true on default
81 var my_paz = new pz2( { "onshow": my_onshow,
82                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
83                     "pazpar2path": pazpar2path,
84                     "oninit": my_oninit,
85                     "onstat": my_onstat,
86                     "onterm": my_onterm,
87                     "termlist": "xtargets,subject,author",
88                     "onbytarget": my_onbytarget,
89                     "usesessions" : usesessions,
90                     "showResponseType": '', // or "json" (for debugging?)
91                     "onrecord": my_onrecord } );
92 // some state vars
93 var curPage = 1;
94 var recPerPage = 20;
95 var totalRec = 0;
96 var curDetRecId = '';
97 var curDetRecData = null;
98 var curSort = 'relevance';
99 var curFilter = null;
100 var submitted = false;
101 var SourceMax = 16;
102 var SubjectMax = 10;
103 var AuthorMax = 10;
104
105 //
106 // pz2.js event handlers:
107 //
108 function my_oninit() {
109     my_paz.stat();
110     my_paz.bytarget();
111 }
112
113 function my_onshow(data) {
114     totalRec = data.merged;
115     // move it out
116     var pager = document.getElementById("pager");
117     pager.innerHTML = "";
118     pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
119                     + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
120                      ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
121                      + data.total + ')</div>';
122     drawPager(pager);
123     // navi
124     var results = document.getElementById("results");
125
126     var html = [];
127     for (var i = 0; i < data.hits.length; i++) {
128         var hit = data.hits[i];
129               html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
130             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
131             +'<a href="#" id="rec_'+hit.recid
132             +'" onclick="showDetails(this.id);return false;"><b>'
133             + hit["md-title"] +' </b></a>');
134               if (hit["md-title-remainder"] !== undefined) {
135                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
136               }
137               if (hit["md-title-responsibility"] !== undefined) {
138             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
139         }
140         if (hit.recid == curDetRecId) {
141             html.push(renderDetails(curDetRecData));
142         }
143         html.push('</div>');
144     }
145     replaceHtml(results, html.join(''));
146 }
147
148 function my_onstat(data) {
149     var stat = document.getElementById("mkwsStat");
150     if (stat == null)
151         return;
152
153     stat.innerHTML = '<span class="head">Status info</span>' +
154         ' -- ' +
155         '<span class="clients">' + data.activeclients + '/' + data.clients + '</span>' +
156         ' -- ' +
157         '<span class="records">' + data.records + '/' + data.hits + '</span>';
158 }
159
160 function my_onterm(data) {
161     if (!mkws_config.termlist_menu)
162         return;
163     
164     var termlists = [];
165     termlists.push('<div class="title">' + M('Termlists') + '</div>');
166
167     termlists.push('<div class="facet">');
168     termlists.push('<div class="termtitle">' + M('Sources') + '</div>');
169     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
170         termlists.push('<a href="#" target_id='+data.xtargets[i].id + ' onclick="limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue);return false;">'
171                        + data.xtargets[i].name
172                        + '</a><span> ('
173                        + data.xtargets[i].freq
174                        + ')</span><br/>');
175     }
176     termlists.push('</div>');
177
178     add_single_facet(termlists, "Subjects", data.subject, SubjectMax, "su");
179     add_single_facet(termlists, "Authors", data.author, AuthorMax, "au");
180
181     var termlist = document.getElementById("termlist");
182     replaceHtml(termlist, termlists.join(''));
183 }
184
185 function add_single_facet(termlists, caption, data, max, cclIndex) {
186     termlists.push('<div class="facet">');
187     termlists.push('<div class="termtitle">' + M(caption) + '</div>');
188     for (var i = 0; i < data.length && i < max; i++ ) {
189         termlists.push('<a href="#" onclick="limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue);return false;">'
190                        + data[i].name
191                        + '</a><span> ('
192                        + data[i].freq
193                        + ')</span><br/>');
194     }
195     termlists.push('</div>');
196 }
197
198 function my_onrecord(data) {
199     // FIXME: record is async!!
200     clearTimeout(my_paz.recordTimer);
201     // in case on_show was faster to redraw element
202     var detRecordDiv = document.getElementById('det_'+data.recid);
203     if (detRecordDiv) return;
204     curDetRecData = data;
205     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
206     var html = renderDetails(curDetRecData);
207     recordDiv.innerHTML += html;
208 }
209
210 function my_onbytarget(data) {
211     var targetDiv = document.getElementById("bytarget");
212     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
213         +'<td>Records</td><td>State</td></tr></thead><tbody>';
214
215     for (var i = 0; i < data.length; i++ ) {
216         table += "<tr><td>" + data[i].id +
217             "</td><td>" + data[i].hits +
218             "</td><td>" + data[i].diagnostic +
219             "</td><td>" + data[i].records +
220             "</td><td>" + data[i].state + "</td></tr>";
221     }
222
223     table += '</tbody></table>';
224     targetDiv.innerHTML = table;
225 }
226
227 ////////////////////////////////////////////////////////////////////////////////
228 ////////////////////////////////////////////////////////////////////////////////
229
230 // wait until the DOM is ready
231 function domReady ()
232 {
233     document.search.onsubmit = onFormSubmitEventHandler;
234     document.search.query.value = '';
235     document.select.sort.onchange = onSelectDdChange;
236     document.select.perpage.onchange = onSelectDdChange;
237 }
238
239 // when search button pressed
240 function onFormSubmitEventHandler()
241 {
242     resetPage();
243     loadSelect();
244     triggerSearch();
245     switchView('records'); // In case it's configured to start off as hidden
246     submitted = true;
247     return false;
248 }
249
250 function onSelectDdChange()
251 {
252     if (!submitted) return false;
253     resetPage();
254     loadSelect();
255     my_paz.show(0, recPerPage, curSort);
256     return false;
257 }
258
259 function resetPage()
260 {
261     curPage = 1;
262     totalRec = 0;
263 }
264
265 function triggerSearch ()
266 {
267     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
268 }
269
270 function loadSelect ()
271 {
272     curSort = document.select.sort.value;
273     recPerPage = document.select.perpage.value;
274 }
275
276 // limit the query after clicking the facet
277 function limitQuery (field, value)
278 {
279     document.search.query.value += ' and ' + field + '="' + value + '"';
280     onFormSubmitEventHandler();
281 }
282
283 // limit by target functions
284 function limitTarget (id, name)
285 {
286     var navi = document.getElementById('navi');
287     navi.innerHTML =
288         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
289         + name + '</a>';
290     navi.innerHTML += '<hr/>';
291     curFilter = 'pz:id=' + id;
292     resetPage();
293     loadSelect();
294     triggerSearch();
295     return false;
296 }
297
298 function delimitTarget ()
299 {
300     var navi = document.getElementById('navi');
301     navi.innerHTML = '';
302     curFilter = null;
303     resetPage();
304     loadSelect();
305     triggerSearch();
306     return false;
307 }
308
309 function drawPager (pagerDiv)
310 {
311     //client indexes pages from 1 but pz2 from 0
312     var onsides = 6;
313     var pages = Math.ceil(totalRec / recPerPage);
314
315     var firstClkbl = ( curPage - onsides > 0 )
316         ? curPage - onsides
317         : 1;
318
319     var lastClkbl = firstClkbl + 2*onsides < pages
320         ? firstClkbl + 2*onsides
321         : pages;
322
323     var prev = '<span id="prev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
324     if (curPage > 1)
325         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
326         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
327
328     var middle = '';
329     for(var i = firstClkbl; i <= lastClkbl; i++) {
330         var numLabel = i;
331         if(i == curPage)
332             numLabel = '<b>' + i + '</b>';
333
334         middle += '<a href="#" onclick="showPage(' + i + ')"> '
335             + numLabel + ' </a>';
336     }
337
338     var next = '<b> | </b><span id="next">' + M('Next') + ' &#62;&#62;</span>';
339     if (pages - curPage > 0)
340         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
341         + M('Next') + ' &#62;&#62;</a>';
342
343     var predots = '';
344     if (firstClkbl > 1)
345         predots = '...';
346
347     var postdots = '';
348     if (lastClkbl < pages)
349         postdots = '...';
350
351     pagerDiv.innerHTML += '<div style="float: clear">'
352         + prev + predots + middle + postdots + next + '</div><hr/>';
353 }
354
355 function showPage (pageNum)
356 {
357     curPage = pageNum;
358     my_paz.showPage( curPage - 1 );
359 }
360
361 // simple paging functions
362
363 function pagerNext() {
364     if ( totalRec - recPerPage*curPage > 0) {
365         my_paz.showNext();
366         curPage++;
367     }
368 }
369
370 function pagerPrev() {
371     if ( my_paz.showPrev() != false )
372         curPage--;
373 }
374
375 // swithing view between targets and records
376
377 function switchView(view) {
378
379     var targets = document.getElementById('mkwsTargets');
380     var records = document.getElementById('mkwsRecords');
381     var blanket = document.getElementById('mkwsBlanket');
382
383     switch(view) {
384         case 'targets':
385             targets.style.display = "block";
386             records.style.display = "none";
387             if (blanket) { blanket.style.display = "none"; }
388             break;
389         case 'records':
390             targets.style.display = "none";
391             records.style.display = "block";
392             if (blanket) { blanket.style.display = "block"; }
393             break;
394         case 'none':
395             targets.style.display = "none";
396             records.style.display = "none";
397             if (blanket) { blanket.style.display = "none"; }
398             break;
399         default:
400             alert('Unknown view.');
401     }
402 }
403
404 // detailed record drawing
405 function showDetails (prefixRecId) {
406     var recId = prefixRecId.replace('rec_', '');
407     var oldRecId = curDetRecId;
408     curDetRecId = recId;
409
410     // remove current detailed view if any
411     var detRecordDiv = document.getElementById('det_'+oldRecId);
412     // lovin DOM!
413     if (detRecordDiv)
414       detRecordDiv.parentNode.removeChild(detRecordDiv);
415
416     // if the same clicked, just hide
417     if (recId == oldRecId) {
418         curDetRecId = '';
419         curDetRecData = null;
420         return;
421     }
422     // request the record
423     my_paz.record(recId);
424 }
425
426 function replaceHtml(el, html) {
427   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
428   /*@cc_on // Pure innerHTML is slightly faster in IE
429     oldEl.innerHTML = html;
430     return oldEl;
431     @*/
432   var newEl = oldEl.cloneNode(false);
433   newEl.innerHTML = html;
434   oldEl.parentNode.replaceChild(newEl, oldEl);
435   /* Since we just removed the old element from the DOM, return a reference
436      to the new element, which can be used to restore variable references. */
437   return newEl;
438 };
439
440 function renderDetails(data, marker)
441 {
442     var details = '<div class="details" id="det_'+data.recid+'"><table>';
443     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
444
445     details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
446     details += renderField("Date", data["md-date"]);
447     details += renderField("Author", data["md-author"]);
448     details += renderField("URL", data["md-electronic-url"]);
449     details += renderField("Subject", data["location"][0]["md-subject"]);
450     details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
451     details += '</table></div>';
452
453     return details;
454 }
455
456 function renderField(caption, data, data2, data3) {
457     if (data === undefined) {
458         return "";
459     }
460
461     if (caption == "URL") {
462         data = '<a href="' + data + '" target="_blank">' + data + '</a>';
463     }
464
465     if (data2 != undefined) {
466         data = data + " (" + data2 + ")";
467     }
468
469     if (data3 != undefined) {
470         data = data + " <i>" + data3 + "</i>";
471     }
472
473     return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
474 }
475
476
477 /*
478  * All the HTML stuff to render the search forms and
479  * result pages.
480  */
481 function mkws_html_all(config) {
482
483     /* default mkws config */
484     var mkws_config_default = {
485         sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
486         perpage: [10, 20, 30, 50],
487         sort_default: "relevance",
488         perpage_default: 20,
489         query_width: 50,
490         switch_menu: true,      /* show/hide Records|Targets menu */
491         lang_menu: true,        /* show/hide language menu */
492         lang_display: [],       /* display languages links for given languages, [] for all */
493         termlist_menu: true,    /* show/hide termlist */
494         debug: 0,     /* debug level for development: 0..2 */
495
496         dummy: "dummy"
497     };
498
499     /* set global debug flag early */
500     if (config.debug !== 'undefined') {
501         mkws_debug = config.debug;
502     } else if (mkws_config_default.debug !== 'undefined') {
503         mkws_debug = mkws_config_default.debug;
504     }
505     
506     /* override standard config values by function parameters */
507     for (var k in mkws_config_default) {
508         if (typeof config[k] === 'undefined')
509            mkws_config[k] = mkws_config_default[k];
510         debug("Set config: " + k + ' => ' + mkws_config[k]);
511     }
512
513     if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
514         debug("Reset query width: " + mkws_config.query_width);
515         mkws_config.query_width = 50;
516     }
517    
518     mkws_set_lang(mkws_config); 
519     if (mkws_config.lang_menu)
520         mkws_html_lang(mkws_config); 
521
522     // For some reason, doing this programmatically results in
523     // document.search.query being undefined, hence the raw HTML.
524     debug("HTML search form");
525     $("#mkwsSearch").html('\
526     <form id="searchForm" name="search" action="" >\
527       <input id="query" type="text" size="' + mkws_config.query_width + '" />\
528       <input id="button" type="submit" value="' + M('Search') + '" />\
529     </form>');
530
531     debug("HTML records");
532     $("#mkwsRecords").html('\
533       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
534         <tr>\
535           <td width="250" valign="top">\
536             <div id="termlist"></div>\
537           </td>\
538           <td valign="top">\
539             <div id="ranking">\
540               <form name="select" id="select" action="" >\
541         ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\
542         ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
543         ' + M('per page') + '.\
544        </form>\
545             </div>\
546             <div id="pager"></div>\
547             <div id="navi"></div>\
548             <div id="results"></div>\
549           </td>\
550         </tr>\
551       </table>');
552
553     mkws_html_switch(config);
554     if (mkws_config.use_service_proxy)
555         mkws_service_proxy_auth(config.service_proxy_auth);
556
557     domReady();
558 }
559
560 function mkws_set_lang(mkws_config)  {
561     var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
562     if (!lang || !mkws_locale_lang[lang]) {
563         mkws_config.lang = ""
564     } else {
565         mkws_config.lang = lang;
566     }
567     
568     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
569     return mkws_config.lang;
570 }
571
572 function mkws_html_switch(config) {
573     debug("HTML switch");
574     
575     $("#mkwsSwitch").html($("<a/>", {
576         href: '#',
577         onclick: "switchView(\'records\')",
578         text: "Records"
579     }));
580     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
581     $("#mkwsSwitch").append($("<a/>", {
582         href: '#',
583         onclick: "switchView(\'targets\')",
584         text: "Targets"
585     }));
586
587     debug("HTML targets");
588     $("#mkwsTargets").html('\
589       <div id="bytarget">\
590        No information available yet.\
591       </div>');
592     $("#mkwsTargets").css("display", "none");
593
594     if (!config.switch_menu) {
595         debug("disable switch menu");
596         $("#mkwsSwitch").css("display", "none");
597     }
598 }
599
600 function mkws_html_sort(config) {
601     debug("HTML sort");
602     var sort_html = '<select name="sort" id="sort">';
603
604     for(var i = 0; i < config.sort.length; i++) {
605         var key = config.sort[i][0];
606         var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
607
608         sort_html += '<option value="' + key + '"';
609         if (key == config.sort_default) {
610             sort_html += ' selected="selected"';
611         }
612         sort_html += '>' + val + '</option>';
613     }
614     sort_html += '</select>';
615
616     return sort_html;
617 }
618
619 function mkws_html_perpage(config) {
620     debug("HTML perpage");
621     var perpage_html = '<select name="perpage" id="perpage">';
622
623     for(var i = 0; i < config.perpage.length; i++) {
624         var key = config.perpage[i];
625
626         perpage_html += '<option value="' + key + '"';
627         if (key == config.perpage_default) {
628             perpage_html += ' selected="selected"';
629         }
630         perpage_html += '>' + key + '</option>';
631     }
632     perpage_html += '</select>';
633
634     return perpage_html;
635 }
636
637 /*
638  * Run service-proxy authentication in background (after page load).
639  * The username/password is configured in the apache config file
640  * for the site.
641  */
642 function mkws_service_proxy_auth(auth_url) {
643     if (!auth_url)
644         auth_url = "http://mkws.indexdata.com/service-proxy-auth";
645         
646     debug("Run service proxy auth URL: " + auth_url);
647
648     var request = new pzHttpRequest(auth_url);
649     request.get(null, function(data) {
650         if (!jQuery.isXMLDoc(data)) {
651             alert("service proxy auth response document is not valid XML document, give up!");
652             return;
653         }
654         var status = $(data).find("status");
655         if (status.text() != "OK") {
656             alert("service proxy auth repsonse status: " + status.text() + ", give up!");
657             return;
658         }
659     });
660 }
661
662 /* create locale language menu */
663 function mkws_html_lang(mkws_config) {
664     var lang_default = "en";
665     var lang = mkws_config.lang || lang_default;
666     var list = [];
667
668     /* display a list of configured languages, or all */
669     var lang_display = mkws_config.lang_display || [];
670     var hash = {};
671     for (var i = 0; i < lang_display.length; i++) {
672         hash[lang_display[i]] = 1;
673     }
674     
675     for (var k in mkws_locale_lang) {
676         if (hash[k] == 1 || lang_display.length == 0)
677             list.push(k);
678     }
679
680     // add english link
681     if (lang_display.length == 0 || hash[lang_default] == 1)
682         list.push(lang_default);
683
684     debug("Language menu for: " + list.join(", "));
685
686     /* the HTML part */
687     var data = "";    
688     for(var i = 0; i < list.length; i++) {
689         var l = list[i];
690         
691         if (data)
692             data += ' | ';
693             
694         if (lang == l) {
695             data += ' <span>' + l + '</span> ';
696         } else {
697             data += ' <a href="?lang=' + l + '">' + l + '</a> '
698         }
699     }
700     
701     $("#mkwsLang").html(data);
702 }
703
704 /* locale */
705 function M(word) {
706     var lang = mkws_config.lang;
707
708     if (!lang || !mkws_locale_lang[lang])
709         return word;
710
711     return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
712 }
713
714 /* implement jQuery.parseQuerystring() for parsing URL parameters */
715 jQuery.extend({
716   parseQuerystring: function() {
717     var nvpair = {};
718     var qs = window.location.search.replace('?', '');
719     var pairs = qs.split('&');
720     $.each(pairs, function(i, v){
721         var pair = v.split('=');
722         nvpair[pair[0]] = pair[1];
723     });
724     return nvpair;
725   }, 
726   pazpar2: function(data) {
727         document.write('<div id="mkwsSwitch"></div>\
728     <div id="mkwsLang"></div>\
729     <div id="mkwsSearch"></div>\
730     <div id="mkwsRecords"></div>\
731     <div id="mkwsTargets"></div>\
732     <div id="footer">\
733       <div id="mkwsStat"></div>\
734       <span>Powered by MKWS &copy; 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
735     </div>');
736
737     mkws_html_all(mkws_config);
738   }
739 });
740
741 function debug(string) {
742     if (!mkws_debug)
743         return;
744
745     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
746         return;
747     }
748
749     // you need to disable use strict at the top of the file!!!
750     if (mkws_debug >= 3) {
751         console.log(arguments.callee.caller);
752     } else if (mkws_debug >= 2) {
753         console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
754     }
755     console.log(string);
756 }
757
758 /* magic */
759 $(document).ready(function() { mkws_html_all(mkws_config) });