configurable facets
[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.facets || mkws_config.facets.length == 0)
162         return;
163
164     var termlists = [];
165     termlists.push('<div class="title">' + M('Termlists') + '</div>');
166     var facets = mkws_config.facets;
167
168     for(var i = 0; i < facets.length; i++) {
169         if (facets[i] == "sources")
170             add_single_facet(termlists, "Sources",  data.xtargets, SourceMax, null);
171         if (facets[i] == "subjects")
172             add_single_facet(termlists, "Subjects", data.subject,  SubjectMax, "su");
173         if (facets[i] == "authors")
174             add_single_facet(termlists, "Authors",  data.author,   AuthorMax, "au");
175     }
176
177     var termlist = document.getElementById("termlist");
178     replaceHtml(termlist, termlists.join(''));
179 }
180
181 function add_single_facet(acc, caption, data, max, cclIndex) {
182     acc.push('<div class="facet">');
183     acc.push('<div class="termtitle">' + M(caption) + '</div>');
184     for (var i = 0; i < data.length && i < max; i++ ) {
185         acc.push('<a href="#" ');
186         var action;
187         if (!cclIndex) {
188             // Special case: target selection
189             acc.push('target_id='+data[i].id+' ');
190             action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
191         } else {
192             action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
193         }
194         acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
195                  + '<span> (' + data[i].freq + ')</span><br/>');
196     }
197     acc.push('</div>');
198 }
199
200 function my_onrecord(data) {
201     // FIXME: record is async!!
202     clearTimeout(my_paz.recordTimer);
203     // in case on_show was faster to redraw element
204     var detRecordDiv = document.getElementById('det_'+data.recid);
205     if (detRecordDiv) return;
206     curDetRecData = data;
207     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
208     var html = renderDetails(curDetRecData);
209     recordDiv.innerHTML += html;
210 }
211
212 function my_onbytarget(data) {
213     var targetDiv = document.getElementById("bytarget");
214     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
215         +'<td>Records</td><td>State</td></tr></thead><tbody>';
216
217     for (var i = 0; i < data.length; i++ ) {
218         table += "<tr><td>" + data[i].id +
219             "</td><td>" + data[i].hits +
220             "</td><td>" + data[i].diagnostic +
221             "</td><td>" + data[i].records +
222             "</td><td>" + data[i].state + "</td></tr>";
223     }
224
225     table += '</tbody></table>';
226     targetDiv.innerHTML = table;
227 }
228
229 ////////////////////////////////////////////////////////////////////////////////
230 ////////////////////////////////////////////////////////////////////////////////
231
232 // wait until the DOM is ready
233 function domReady ()
234 {
235     document.search.onsubmit = onFormSubmitEventHandler;
236     document.search.query.value = '';
237     document.select.sort.onchange = onSelectDdChange;
238     document.select.perpage.onchange = onSelectDdChange;
239 }
240
241 // when search button pressed
242 function onFormSubmitEventHandler()
243 {
244     resetPage();
245     loadSelect();
246     triggerSearch();
247     switchView('records'); // In case it's configured to start off as hidden
248     submitted = true;
249     return false;
250 }
251
252 function onSelectDdChange()
253 {
254     if (!submitted) return false;
255     resetPage();
256     loadSelect();
257     my_paz.show(0, recPerPage, curSort);
258     return false;
259 }
260
261 function resetPage()
262 {
263     curPage = 1;
264     totalRec = 0;
265 }
266
267 function triggerSearch ()
268 {
269     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
270 }
271
272 function loadSelect ()
273 {
274     curSort = document.select.sort.value;
275     recPerPage = document.select.perpage.value;
276 }
277
278 // limit the query after clicking the facet
279 function limitQuery (field, value)
280 {
281     document.search.query.value += ' and ' + field + '="' + value + '"';
282     onFormSubmitEventHandler();
283 }
284
285 // limit by target functions
286 function limitTarget (id, name)
287 {
288     var navi = document.getElementById('navi');
289     navi.innerHTML =
290         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
291         + name + '</a>';
292     navi.innerHTML += '<hr/>';
293     curFilter = 'pz:id=' + id;
294     resetPage();
295     loadSelect();
296     triggerSearch();
297     return false;
298 }
299
300 function delimitTarget ()
301 {
302     var navi = document.getElementById('navi');
303     navi.innerHTML = '';
304     curFilter = null;
305     resetPage();
306     loadSelect();
307     triggerSearch();
308     return false;
309 }
310
311 function drawPager (pagerDiv)
312 {
313     //client indexes pages from 1 but pz2 from 0
314     var onsides = 6;
315     var pages = Math.ceil(totalRec / recPerPage);
316
317     var firstClkbl = ( curPage - onsides > 0 )
318         ? curPage - onsides
319         : 1;
320
321     var lastClkbl = firstClkbl + 2*onsides < pages
322         ? firstClkbl + 2*onsides
323         : pages;
324
325     var prev = '<span id="prev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
326     if (curPage > 1)
327         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
328         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
329
330     var middle = '';
331     for(var i = firstClkbl; i <= lastClkbl; i++) {
332         var numLabel = i;
333         if(i == curPage)
334             numLabel = '<b>' + i + '</b>';
335
336         middle += '<a href="#" onclick="showPage(' + i + ')"> '
337             + numLabel + ' </a>';
338     }
339
340     var next = '<b> | </b><span id="next">' + M('Next') + ' &#62;&#62;</span>';
341     if (pages - curPage > 0)
342         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
343         + M('Next') + ' &#62;&#62;</a>';
344
345     var predots = '';
346     if (firstClkbl > 1)
347         predots = '...';
348
349     var postdots = '';
350     if (lastClkbl < pages)
351         postdots = '...';
352
353     pagerDiv.innerHTML += '<div style="float: clear">'
354         + prev + predots + middle + postdots + next + '</div><hr/>';
355 }
356
357 function showPage (pageNum)
358 {
359     curPage = pageNum;
360     my_paz.showPage( curPage - 1 );
361 }
362
363 // simple paging functions
364
365 function pagerNext() {
366     if ( totalRec - recPerPage*curPage > 0) {
367         my_paz.showNext();
368         curPage++;
369     }
370 }
371
372 function pagerPrev() {
373     if ( my_paz.showPrev() != false )
374         curPage--;
375 }
376
377 // swithing view between targets and records
378
379 function switchView(view) {
380
381     var targets = document.getElementById('mkwsTargets');
382     var records = document.getElementById('mkwsRecords');
383     var blanket = document.getElementById('mkwsBlanket');
384
385     switch(view) {
386         case 'targets':
387             targets.style.display = "block";
388             records.style.display = "none";
389             if (blanket) { blanket.style.display = "none"; }
390             break;
391         case 'records':
392             targets.style.display = "none";
393             records.style.display = "block";
394             if (blanket) { blanket.style.display = "block"; }
395             break;
396         case 'none':
397             targets.style.display = "none";
398             records.style.display = "none";
399             if (blanket) { blanket.style.display = "none"; }
400             break;
401         default:
402             alert('Unknown view.');
403     }
404 }
405
406 // detailed record drawing
407 function showDetails (prefixRecId) {
408     var recId = prefixRecId.replace('rec_', '');
409     var oldRecId = curDetRecId;
410     curDetRecId = recId;
411
412     // remove current detailed view if any
413     var detRecordDiv = document.getElementById('det_'+oldRecId);
414     // lovin DOM!
415     if (detRecordDiv)
416       detRecordDiv.parentNode.removeChild(detRecordDiv);
417
418     // if the same clicked, just hide
419     if (recId == oldRecId) {
420         curDetRecId = '';
421         curDetRecData = null;
422         return;
423     }
424     // request the record
425     my_paz.record(recId);
426 }
427
428 function replaceHtml(el, html) {
429   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
430   /*@cc_on // Pure innerHTML is slightly faster in IE
431     oldEl.innerHTML = html;
432     return oldEl;
433     @*/
434   var newEl = oldEl.cloneNode(false);
435   newEl.innerHTML = html;
436   oldEl.parentNode.replaceChild(newEl, oldEl);
437   /* Since we just removed the old element from the DOM, return a reference
438      to the new element, which can be used to restore variable references. */
439   return newEl;
440 };
441
442 function renderDetails(data, marker)
443 {
444     var details = '<div class="details" id="det_'+data.recid+'"><table>';
445     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
446
447     details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
448     details += renderField("Date", data["md-date"]);
449     details += renderField("Author", data["md-author"]);
450     details += renderField("URL", data["md-electronic-url"]);
451     details += renderField("Subject", data["location"][0]["md-subject"]);
452     details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
453     details += '</table></div>';
454
455     return details;
456 }
457
458 function renderField(caption, data, data2, data3) {
459     if (data === undefined) {
460         return "";
461     }
462
463     if (caption == "URL") {
464         data = '<a href="' + data + '" target="_blank">' + data + '</a>';
465     }
466
467     if (data2 != undefined) {
468         data = data + " (" + data2 + ")";
469     }
470
471     if (data3 != undefined) {
472         data = data + " <i>" + data3 + "</i>";
473     }
474
475     return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
476 }
477
478
479 /*
480  * All the HTML stuff to render the search forms and
481  * result pages.
482  */
483 function mkws_html_all(config) {
484
485     /* default mkws config */
486     var mkws_config_default = {
487         sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
488         perpage: [10, 20, 30, 50],
489         sort_default: "relevance",
490         perpage_default: 20,
491         query_width: 50,
492         switch_menu: true,      /* show/hide Records|Targets menu */
493         lang_menu: true,        /* show/hide language menu */
494         lang_display: [],       /* display languages links for given languages, [] for all */
495         facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
496
497         debug: 0,     /* debug level for development: 0..2 */
498
499         dummy: "dummy"
500     };
501
502     /* set global debug flag early */
503     if (config.debug !== 'undefined') {
504         mkws_debug = config.debug;
505     } else if (mkws_config_default.debug !== 'undefined') {
506         mkws_debug = mkws_config_default.debug;
507     }
508
509     /* override standard config values by function parameters */
510     for (var k in mkws_config_default) {
511         if (typeof config[k] === 'undefined')
512            mkws_config[k] = mkws_config_default[k];
513         debug("Set config: " + k + ' => ' + mkws_config[k]);
514     }
515
516     if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
517         debug("Reset query width: " + mkws_config.query_width);
518         mkws_config.query_width = 50;
519     }
520
521     mkws_set_lang(mkws_config);
522     if (mkws_config.lang_menu)
523         mkws_html_lang(mkws_config);
524
525     // For some reason, doing this programmatically results in
526     // document.search.query being undefined, hence the raw HTML.
527     debug("HTML search form");
528     $("#mkwsSearch").html('\
529     <form id="searchForm" name="search" action="" >\
530       <input id="query" type="text" size="' + mkws_config.query_width + '" />\
531       <input id="button" type="submit" value="' + M('Search') + '" />\
532     </form>');
533
534     debug("HTML records");
535     $("#mkwsRecords").html('\
536       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
537         <tr>\
538           <td width="250" valign="top">\
539             <div id="termlist"></div>\
540           </td>\
541           <td valign="top">\
542             <div id="ranking">\
543               <form name="select" id="select" action="" >\
544         ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\
545         ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
546         ' + M('per page') + '.\
547        </form>\
548             </div>\
549             <div id="pager"></div>\
550             <div id="navi"></div>\
551             <div id="results"></div>\
552           </td>\
553         </tr>\
554       </table>');
555
556     mkws_html_switch(config);
557     if (mkws_config.use_service_proxy)
558         mkws_service_proxy_auth(config.service_proxy_auth);
559
560     domReady();
561 }
562
563 function mkws_set_lang(mkws_config)  {
564     var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
565     if (!lang || !mkws_locale_lang[lang]) {
566         mkws_config.lang = ""
567     } else {
568         mkws_config.lang = lang;
569     }
570
571     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
572     return mkws_config.lang;
573 }
574
575 function mkws_html_switch(config) {
576     debug("HTML switch");
577
578     $("#mkwsSwitch").html($("<a/>", {
579         href: '#',
580         onclick: "switchView(\'records\')",
581         text: "Records"
582     }));
583     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
584     $("#mkwsSwitch").append($("<a/>", {
585         href: '#',
586         onclick: "switchView(\'targets\')",
587         text: "Targets"
588     }));
589
590     debug("HTML targets");
591     $("#mkwsTargets").html('\
592       <div id="bytarget">\
593        No information available yet.\
594       </div>');
595     $("#mkwsTargets").css("display", "none");
596
597     if (!config.switch_menu) {
598         debug("disable switch menu");
599         $("#mkwsSwitch").css("display", "none");
600     }
601 }
602
603 function mkws_html_sort(config) {
604     debug("HTML sort");
605     var sort_html = '<select name="sort" id="sort">';
606
607     for(var i = 0; i < config.sort.length; i++) {
608         var key = config.sort[i][0];
609         var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
610
611         sort_html += '<option value="' + key + '"';
612         if (key == config.sort_default) {
613             sort_html += ' selected="selected"';
614         }
615         sort_html += '>' + val + '</option>';
616     }
617     sort_html += '</select>';
618
619     return sort_html;
620 }
621
622 function mkws_html_perpage(config) {
623     debug("HTML perpage");
624     var perpage_html = '<select name="perpage" id="perpage">';
625
626     for(var i = 0; i < config.perpage.length; i++) {
627         var key = config.perpage[i];
628
629         perpage_html += '<option value="' + key + '"';
630         if (key == config.perpage_default) {
631             perpage_html += ' selected="selected"';
632         }
633         perpage_html += '>' + key + '</option>';
634     }
635     perpage_html += '</select>';
636
637     return perpage_html;
638 }
639
640 /*
641  * Run service-proxy authentication in background (after page load).
642  * The username/password is configured in the apache config file
643  * for the site.
644  */
645 function mkws_service_proxy_auth(auth_url) {
646     if (!auth_url)
647         auth_url = "http://mkws.indexdata.com/service-proxy-auth";
648
649     debug("Run service proxy auth URL: " + auth_url);
650
651     var request = new pzHttpRequest(auth_url);
652     request.get(null, function(data) {
653         if (!jQuery.isXMLDoc(data)) {
654             alert("service proxy auth response document is not valid XML document, give up!");
655             return;
656         }
657         var status = $(data).find("status");
658         if (status.text() != "OK") {
659             alert("service proxy auth repsonse status: " + status.text() + ", give up!");
660             return;
661         }
662     });
663 }
664
665 /* create locale language menu */
666 function mkws_html_lang(mkws_config) {
667     var lang_default = "en";
668     var lang = mkws_config.lang || lang_default;
669     var list = [];
670
671     /* display a list of configured languages, or all */
672     var lang_display = mkws_config.lang_display || [];
673     var hash = {};
674     for (var i = 0; i < lang_display.length; i++) {
675         hash[lang_display[i]] = 1;
676     }
677
678     for (var k in mkws_locale_lang) {
679         if (hash[k] == 1 || lang_display.length == 0)
680             list.push(k);
681     }
682
683     // add english link
684     if (lang_display.length == 0 || hash[lang_default] == 1)
685         list.push(lang_default);
686
687     debug("Language menu for: " + list.join(", "));
688
689     /* the HTML part */
690     var data = "";
691     for(var i = 0; i < list.length; i++) {
692         var l = list[i];
693
694         if (data)
695             data += ' | ';
696
697         if (lang == l) {
698             data += ' <span>' + l + '</span> ';
699         } else {
700             data += ' <a href="?lang=' + l + '">' + l + '</a> '
701         }
702     }
703
704     $("#mkwsLang").html(data);
705 }
706
707 /* locale */
708 function M(word) {
709     var lang = mkws_config.lang;
710
711     if (!lang || !mkws_locale_lang[lang])
712         return word;
713
714     return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
715 }
716
717 /* implement jQuery.parseQuerystring() for parsing URL parameters */
718 jQuery.extend({
719   parseQuerystring: function() {
720     var nvpair = {};
721     var qs = window.location.search.replace('?', '');
722     var pairs = qs.split('&');
723     $.each(pairs, function(i, v){
724         var pair = v.split('=');
725         nvpair[pair[0]] = pair[1];
726     });
727     return nvpair;
728   },
729   pazpar2: function(data) {
730         document.write('<div id="mkwsSwitch"></div>\
731     <div id="mkwsLang"></div>\
732     <div id="mkwsSearch"></div>\
733     <div id="mkwsRecords"></div>\
734     <div id="mkwsTargets"></div>\
735     <div id="footer">\
736       <div id="mkwsStat"></div>\
737       <span>Powered by MKWS &copy; 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
738     </div>');
739
740     mkws_html_all(mkws_config);
741   }
742 });
743
744 function debug(string) {
745     if (!mkws_debug)
746         return;
747
748     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
749         return;
750     }
751
752     // you need to disable use strict at the top of the file!!!
753     if (mkws_debug >= 3) {
754         console.log(arguments.callee.caller);
755     } else if (mkws_debug >= 2) {
756         console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
757     }
758     console.log(string);
759 }
760
761 /* magic */
762 $(document).ready(function() { mkws_html_all(mkws_config) });