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