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