New function delimitQuery().
[mkws-moved-to-github.git] / tools / htdocs / 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_level >= 2
5
6 // Set up namespace and some state.
7 var mkws = {
8     filters: [],
9     pp2filter: null,
10 };
11
12 /*
13  * global config object: mkws_config
14  *
15  * Needs to be defined in the HTML header before including this JS file.
16  * Define empty mkws_config for simple applications that don't define it.
17  */
18 if (!mkws_config)
19     var mkws_config = {};
20
21 // Wrapper for jQuery
22 (function ($) {
23
24 mkws.locale_lang = {
25     "de": {
26         "Authors": "Autoren",
27         "Subjects": "Schlagwörter",
28         "Sources": "Daten und Quellen",
29         "Termlists": "Termlisten",
30         "Next": "Weiter",
31         "Prev": "Zurück",
32         "Search": "Suche",
33         "Sort by": "Sortieren nach",
34         "and show": "und zeige",
35         "per page": "pro Seite",
36         "Displaying": "Zeige",
37         "to": "von",
38         "of": "aus",
39         "found": "gefunden",
40         "Title": "Titel",
41         "Author": "Autor",
42         "Date": "Datum",
43         "Subject": "Schlagwort",
44         "Location": "Ort",
45         // ### to add: Records, Targets
46
47         "dummy": "dummy"
48     },
49
50     "da": {
51         "Authors": "Forfattere",
52         "Subjects": "Emner",
53         "Sources": "Kilder",
54         "Termlists": "Termlists",
55         "Next": "Næste",
56         "Prev": "Forrige",
57         "Search": "Søg",
58         "Sort by": "Sorter efter",
59         "and show": "og vis",
60         "per page": "per side",
61         "Displaying": "Viser",
62         "to": "til",
63         "of": "ud af",
64         "found": "fandt",
65         "Title": "Title",
66         "Author": "Forfatter",
67         "Date": "Dato",
68         "Subject": "Emneord",
69         "Location": "Lokation",
70         // ### to add: Records, Targets
71
72         "dummy": "dummy"
73     }
74 };
75
76 // keep time state for debugging
77 mkws.debug_time = {
78     "start": $.now(),
79     "last": $.now()
80 };
81
82 mkws.debug_function = function (string) {
83     if (!mkws.debug_level)
84         return;
85
86     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
87         return;
88     }
89
90     var now = $.now();
91     var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") "
92     mkws.debug_time.last = now;
93
94     // you need to disable use strict at the top of the file!!!
95     if (mkws.debug_level >= 3) {
96         console.log(timestamp + arguments.callee.caller);
97     } else if (mkws.debug_level >= 2) {
98         console.log(timestamp + ">>> called from function " + arguments.callee.caller.name + ' <<<');
99     }
100     console.log(timestamp + string);
101 }
102 var debug = mkws.debug_function; // local alias
103
104 {
105     /* default mkws config */
106     var config_default = {
107         use_service_proxy: true,
108         service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth",
109         lang: "",
110         sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
111         perpage_options: [10, 20, 30, 50],
112         sort_default: "relevance",
113         perpage_default: 20,
114         query_width: 50,
115         show_lang: true,        /* show/hide language menu */
116         show_sort: true,        /* show/hide sort menu */
117         show_perpage: true,     /* show/hide perpage menu */
118         lang_options: [],       /* display languages links for given languages, [] for all */
119         facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
120         responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
121         debug_level: 1,     /* debug level for development: 0..2 */
122
123         dummy: "dummy"
124     };
125
126     /* set global debug_level flag early */
127     if (typeof mkws_config.debug_level !== 'undefined') {
128         mkws.debug_level = mkws_config.debug_level;
129     } else if (typeof config_default.debug_level !== 'undefined') {
130         mkws.debug_level = config_default.debug_level;
131     }
132
133     /* override standard config values by function parameters */
134     for (var k in config_default) {
135         if (typeof mkws_config[k] === 'undefined')
136            mkws_config[k] = config_default[k];
137         debug("Set config: " + k + ' => ' + mkws_config[k]);
138     }
139 }
140
141 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
142     debug("Reset query width: " + mkws_config.query_width);
143     mkws_config.query_width = 50;
144 }
145
146 for (var key in mkws_config) {
147     if (mkws_config.hasOwnProperty(key)) {
148         if (key.match(/^language_/)) {
149             var lang = key.replace(/^language_/, "");
150             // Copy custom languages into list
151             mkws.locale_lang[lang] = mkws_config[key];
152             debug("Added locally configured language '" + lang + "'");
153         }
154     }
155 }
156
157
158 // create a parameters array and pass it to the pz2's constructor
159 // then register the form submit event with the pz2.search function
160 // autoInit is set to true on default
161 var my_paz = new pz2( { "onshow": my_onshow,
162                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
163                     "pazpar2path": mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/",
164                     "oninit": my_oninit,
165                     "onstat": my_onstat,
166                     "onterm": my_onterm,
167                     "termlist": "xtargets,subject,author",
168                     "onbytarget": my_onbytarget,
169                     "usesessions" : mkws_config.use_service_proxy ? false : true,
170                     "showResponseType": '', // or "json" (for debugging?)
171                     "onrecord": my_onrecord } );
172
173 mkws.my_paz = my_paz; // export
174
175 // some state vars
176 var curPage = 1;
177 var recPerPage = 20;
178 var totalRec = 0;
179 var curDetRecId = '';
180 var curDetRecData = null;
181 var curSort = 'relevance';
182 var submitted = false;
183 var SourceMax = 16;
184 var SubjectMax = 10;
185 var AuthorMax = 10;
186
187 //
188 // pz2.js event handlers:
189 //
190 function my_oninit() {
191     my_paz.stat();
192     my_paz.bytarget();
193 }
194
195 function my_onshow(data) {
196     totalRec = data.merged;
197     // move it out
198     var pager = document.getElementById("mkwsPager");
199     if (pager) {
200         pager.innerHTML = "";
201         pager.innerHTML +='<div style="float: right">' + M('Displaying') + ': '
202             + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
203             ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
204             + data.total + ')</div>';
205         drawPager(pager);
206     }
207
208     // navi
209     var results = document.getElementById("mkwsRecords");
210
211     var html = [];
212     for (var i = 0; i < data.hits.length; i++) {
213         var hit = data.hits[i];
214               html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
215             +'<a href="#" id="mkwsRec_'+hit.recid
216             +'" onclick="mkws.showDetails(this.id);return false;"><b>'
217             + hit["md-title"] +' </b></a>');
218               if (hit["md-title-remainder"] !== undefined) {
219                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
220               }
221               if (hit["md-title-responsibility"] !== undefined) {
222             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
223         }
224         if (hit.recid == curDetRecId) {
225             html.push(renderDetails(curDetRecData));
226         }
227         html.push('</div>');
228     }
229     replaceHtml(results, html.join(''));
230 }
231
232 function my_onstat(data) {
233     var stat = document.getElementById("mkwsStat");
234     if (stat == null)
235         return;
236
237     stat.innerHTML = '<span class="head">' + M('Status info') + '</span>' +
238         ' -- ' +
239         '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
240         ' -- ' +
241         '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>';
242 }
243
244 function my_onterm(data) {
245     // no facets
246     if (!mkws_config.facets || mkws_config.facets.length == 0) {
247         $("#mkwsTermlists").hide();
248         return;
249     }
250
251     // display if we first got results
252     $("#mkwsTermlists").show();
253
254     var acc = [];
255     acc.push('<div class="title">' + M('Termlists') + '</div>');
256     var facets = mkws_config.facets;
257
258     for(var i = 0; i < facets.length; i++) {
259         if (facets[i] == "sources") {
260             add_single_facet(acc, "Sources",  data.xtargets, SourceMax, null);
261         } else if (facets[i] == "subjects") {
262             add_single_facet(acc, "Subjects", data.subject,  SubjectMax, "su");
263         } else if (facets[i] == "authors") {
264             add_single_facet(acc, "Authors",  data.author,   AuthorMax, "au");
265         } else {
266             alert("bad facet configuration: '" + facets[i] + "'");
267         }
268     }
269
270     var termlist = document.getElementById("mkwsTermlists");
271     replaceHtml(termlist, acc.join(''));
272 }
273
274 function add_single_facet(acc, caption, data, max, cclIndex) {
275     acc.push('<div class="facet" id="mkwsFacet' + caption + '">');
276     acc.push('<div class="termtitle">' + M(caption) + '</div>');
277     for (var i = 0; i < data.length && i < max; i++ ) {
278         acc.push('<div class="term">');
279         acc.push('<a href="#" ');
280         var action;
281         if (!cclIndex) {
282             // Special case: target selection
283             acc.push('target_id='+data[i].id+' ');
284             action = 'mkws.limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
285         } else {
286             action = 'mkws.limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
287         }
288         acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
289                  + ' <span>' + data[i].freq + '</span>');
290         acc.push('</div>');
291     }
292     acc.push('</div>');
293 }
294
295 function my_onrecord(data) {
296     // FIXME: record is async!!
297     clearTimeout(my_paz.recordTimer);
298     // in case on_show was faster to redraw element
299     var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
300     if (detRecordDiv) return;
301     curDetRecData = data;
302     var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
303     var html = renderDetails(curDetRecData);
304     recordDiv.innerHTML += html;
305 }
306
307 function my_onbytarget(data) {
308     var targetDiv = document.getElementById("mkwsBytarget");
309     if (!targetDiv) {
310         // No mkwsTargets div.
311         return;
312     }
313
314     var table ='<table><thead><tr>' +
315         '<td>' + M('Target ID') + '</td>' +
316         '<td>' + M('Hits') + '</td>' +
317         '<td>' + M('Diags') + '</td>' +
318         '<td>' + M('Records') + '</td>' +
319         '<td>' + M('State') + '</td>' +
320         '</tr></thead><tbody>';
321
322     for (var i = 0; i < data.length; i++ ) {
323         table += "<tr><td>" + data[i].id +
324             "</td><td>" + data[i].hits +
325             "</td><td>" + data[i].diagnostic +
326             "</td><td>" + data[i].records +
327             "</td><td>" + data[i].state + "</td></tr>";
328     }
329
330     table += '</tbody></table>';
331     targetDiv.innerHTML = table;
332 }
333
334 ////////////////////////////////////////////////////////////////////////////////
335 ////////////////////////////////////////////////////////////////////////////////
336
337 // wait until the DOM is ready
338 function domReady ()
339 {
340     document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
341     document.mkwsSearchForm.mkwsQuery.value = '';
342     if (document.mkwsSelect) {
343         if (document.mkwsSelect.mkwsSort)
344             document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
345         if (document.mkwsSelect.mkwsPerpage)
346             document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
347     }
348 }
349
350 // when search button pressed
351 function onFormSubmitEventHandler()
352 {
353     resetPage();
354     loadSelect();
355     triggerSearch();
356     mkws.switchView('records'); // In case it's configured to start off as hidden
357     submitted = true;
358     return false;
359 }
360
361 function onSelectDdChange()
362 {
363     if (!submitted) return false;
364     resetPage();
365     loadSelect();
366     my_paz.show(0, recPerPage, curSort);
367     return false;
368 }
369
370 function resetPage()
371 {
372     curPage = 1;
373     totalRec = 0;
374 }
375
376 function triggerSearch ()
377 {
378     debug("triggerSearch: filters = " + JSON.stringify(mkws.filters));
379     my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, mkws.pp2filter);
380 }
381
382 function loadSelect ()
383 {
384     if (document.mkwsSelect) {
385         if (document.mkwsSelect.mkwsSort)
386             curSort = document.mkwsSelect.mkwsSort.value;
387         if (document.mkwsSelect.mkwsPerpage)
388             recPerPage = document.mkwsSelect.mkwsPerpage.value;
389     }
390 }
391
392 // limit the query after clicking the facet
393 mkws.limitQuery = function (field, value)
394 {
395     debug("limitQuery(field=" + field + ", value=" + value + ")");
396     mkws.filters.push({ field: field, value: value });
397     redraw_navi();
398     document.mkwsSearchForm.mkwsQuery.value += ' and ' + field + '="' + value + '"';
399     onFormSubmitEventHandler();
400 }
401
402 // limit by target functions
403 mkws.limitTarget  = function (id, name)
404 {
405     debug("limitTarget(id=" + id + ", name=" + name + ")");
406     mkws.filters.push({ id: id, name: name });
407     redraw_navi();
408     mkws.pp2filter = 'pz:id=' + id;
409     resetPage();
410     loadSelect();
411     triggerSearch();
412     return false;
413 }
414
415 mkws.delimitQuery = function (field, value)
416 {
417     debug("delimitQuery(field=" + field + ", value=" + value + ")");    
418     var newFilters = [];
419     for (var i in mkws.filters) {
420         var filter = mkws.filters[i];
421         if (filter.field &&
422             field == filter.field &&
423             value == filter.value) {
424             debug("delimitTarget() removing filter " + JSON.stringify(filter));
425         } else {
426             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
427             newFilters.push(filter);
428         }
429     }
430     mkws.filters = newFilters;
431
432     redraw_navi();
433     mkws.pp2filter = null;
434     resetPage();
435     loadSelect();
436     triggerSearch();
437     return false;
438 }
439
440
441 mkws.delimitTarget = function (id)
442 {
443     debug("delimitTarget(id=" + id + ")");    
444     var newFilters = [];
445     for (var i in mkws.filters) {
446         var filter = mkws.filters[i];
447         if (filter.id) {
448             debug("delimitTarget() removing filter " + JSON.stringify(filter));
449         } else {
450             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
451             newFilters.push(filter);
452         }
453     }
454     mkws.filters = newFilters;
455
456     redraw_navi();
457     mkws.pp2filter = null;
458     resetPage();
459     loadSelect();
460     triggerSearch();
461     return false;
462 }
463
464
465 function redraw_navi ()
466 {
467     var navi = document.getElementById('mkwsNavi');
468     if (!navi) return;
469
470     var text = "";
471     for (var i in mkws.filters) {
472         if (text) {
473             text += " | ";
474         }
475         var filter = mkws.filters[i];
476         if (filter.id) {
477             text += 'Source: <a class="crossout" href="#" onclick="mkws.delimitTarget(' +
478                 "'" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
479         } else {
480             text += filter.field + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(' +
481                 "'" + filter.field + "', '" + filter.value + "'" +
482                 ');return false;">' + filter.value + '</a>';
483         }
484     }
485     
486     navi.innerHTML = text;
487 }
488
489
490 function drawPager (pagerDiv)
491 {
492     //client indexes pages from 1 but pz2 from 0
493     var onsides = 6;
494     var pages = Math.ceil(totalRec / recPerPage);
495
496     var firstClkbl = ( curPage - onsides > 0 )
497         ? curPage - onsides
498         : 1;
499
500     var lastClkbl = firstClkbl + 2*onsides < pages
501         ? firstClkbl + 2*onsides
502         : pages;
503
504     var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
505     if (curPage > 1)
506         prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
507         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
508
509     var middle = '';
510     for(var i = firstClkbl; i <= lastClkbl; i++) {
511         var numLabel = i;
512         if(i == curPage)
513             numLabel = '<b>' + i + '</b>';
514
515         middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
516             + numLabel + ' </a>';
517     }
518
519     var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
520     if (pages - curPage > 0)
521         next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
522         + M('Next') + ' &#62;&#62;</a>';
523
524     var predots = '';
525     if (firstClkbl > 1)
526         predots = '...';
527
528     var postdots = '';
529     if (lastClkbl < pages)
530         postdots = '...';
531
532     pagerDiv.innerHTML += '<div style="float: clear">'
533         + prev + predots + middle + postdots + next + '</div>';
534 }
535
536 mkws.showPage = function (pageNum)
537 {
538     curPage = pageNum;
539     my_paz.showPage( curPage - 1 );
540 }
541
542 // simple paging functions
543
544 mkws.pagerNext = function () {
545     if ( totalRec - recPerPage*curPage > 0) {
546         my_paz.showNext();
547         curPage++;
548     }
549 }
550
551 mkws.pagerPrev = function () {
552     if ( my_paz.showPrev() != false )
553         curPage--;
554 }
555
556 // switching view between targets and records
557
558 mkws.switchView = function(view) {
559     debug("switchView: " + view);
560
561     var targets = document.getElementById('mkwsTargets');
562     var results = document.getElementById('mkwsResults') ||
563                   document.getElementById('mkwsRecords');
564     var blanket = document.getElementById('mkwsBlanket');
565     var motd    = document.getElementById('mkwsMOTD');
566
567     switch(view) {
568         case 'targets':
569             if (targets) targets.style.display = "block";
570             if (results) results.style.display = "none";
571             if (blanket) blanket.style.display = "none";
572             if (motd) motd.style.display = "none";
573             break;
574         case 'records':
575             if (targets) targets.style.display = "none";
576             if (results) results.style.display = "block";
577             if (blanket) blanket.style.display = "block";
578             if (motd) motd.style.display = "none";
579             break;
580         case 'none':
581             if (targets) targets.style.display = "none";
582             if (results) results.style.display = "none";
583             if (blanket) blanket.style.display = "none";
584             if (motd) motd.style.display = "none";
585             break;
586         default:
587             alert("Unknown view '" + view + "'");
588     }
589 }
590
591 // detailed record drawing
592 mkws.showDetails = function (prefixRecId) {
593     var recId = prefixRecId.replace('mkwsRec_', '');
594     var oldRecId = curDetRecId;
595     curDetRecId = recId;
596
597     // remove current detailed view if any
598     var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
599     // lovin DOM!
600     if (detRecordDiv)
601       detRecordDiv.parentNode.removeChild(detRecordDiv);
602
603     // if the same clicked, just hide
604     if (recId == oldRecId) {
605         curDetRecId = '';
606         curDetRecData = null;
607         return;
608     }
609     // request the record
610     my_paz.record(recId);
611 }
612
613 function replaceHtml(el, html) {
614   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
615   /*@cc_on // Pure innerHTML is slightly faster in IE
616     oldEl.innerHTML = html;
617     return oldEl;
618     @*/
619   var newEl = oldEl.cloneNode(false);
620   newEl.innerHTML = html;
621   oldEl.parentNode.replaceChild(newEl, oldEl);
622   /* Since we just removed the old element from the DOM, return a reference
623      to the new element, which can be used to restore variable references. */
624   return newEl;
625 };
626
627 function renderDetails(data, marker)
628 {
629     var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
630     if (marker) details += '<tr><td colspan="2">'+ marker + '</td></tr>';
631
632     var locations = [];
633     for (var i in data.location) {
634         locations.push(data.location[i]['@name']);
635     }
636
637     details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
638     details += renderField("Date", data["md-date"]);
639     details += renderField("Author", data["md-author"]);
640     details += renderField("URL", data["md-electronic-url"]);
641     details += renderField("Subject", data["location"][0]["md-subject"]);
642     if (locations.length == 0) {
643         details += '<tr><td colspan="2">No locations for record!</td></tr>';
644     } else {
645         details += renderField("Location" + (locations.length == 1 ? "" : "s"), locations);
646     }
647     details += '</table></div>';
648
649     return details;
650 }
651
652 function renderField(caption, data, data2, data3) {
653     if (data === undefined) {
654         return "";
655     }
656
657     var res = "";
658     for (var i = 0; i < data.length; i++) {
659         var s = data[i];
660         if (i > 0)
661             res += ", ";
662
663         if (caption == "URL")
664             s = '<a href="' + s + '" target="_blank">' + s + '</a>';
665
666         res += s
667     }
668
669     if (data2 != undefined) {
670         res = res + " (" + data2 + ")";
671     }
672
673     if (data3 != undefined) {
674         res = res + " <i>" + data3 + "</i>";
675     }
676
677     return '<tr><th>' + M(caption) + '</th><td>' + res + '</td></tr>';
678 }
679
680
681 /*
682  * All the HTML stuff to render the search forms and
683  * result pages.
684  */
685 function mkws_html_all() {
686     mkws_set_lang();
687     if (mkws_config.show_lang)
688         mkws_html_lang();
689
690     // For some reason, doing this programmatically results in
691     // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
692     debug("HTML search form");
693     $("#mkwsSearch").html('\
694     <form name="mkwsSearchForm" action="" >\
695       <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
696       <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
697     </form>');
698
699     debug("HTML records");
700     // If the application has an #mkwsResults, populate it in the
701     // usual way. If not, assume that it's a smarter application that
702     // defines its own subcomponents:
703     //  #mkwsTermlists
704     //  #mkwsRanking
705     //  #mkwsPager
706     //  #mkwsNavi
707     //  #mkwsRecords
708     if ($("#mkwsResults").length) {
709         $("#mkwsResults").html('\
710       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
711         <tr>\
712           <td id="mkwsTermlistContainer1" width="250" valign="top">\
713             <div id="mkwsTermlists"></div>\
714           </td>\
715           <td id="mkwsMOTDContainer" valign="top">\
716             <div id="mkwsRanking"></div>\
717             <div id="mkwsPager"></div>\
718             <div id="mkwsNavi"></div>\
719             <div id="mkwsRecords"></div>\
720           </td>\
721         </tr>\
722         <tr>\
723           <td colspan="2">\
724             <div id="mkwsTermlistContainer2"></div>\
725           </td>\
726         </tr>\
727       </table>');
728     }
729
730     if ($("#mkwsRanking").length) {
731         var ranking_data = '';
732         ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
733         if (mkws_config.show_sort) {
734             ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
735         }
736         if (mkws_config.show_perpage) {
737             ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
738         }
739         ranking_data += '</form>';
740
741         $("#mkwsRanking").html(ranking_data);
742     }
743
744     mkws_html_switch();
745
746     if (mkws_config.use_service_proxy)
747           mkws_service_proxy_auth(mkws_config.service_proxy_auth, 
748           mkws_config.service_proxy_auth_domain);
749
750     if (mkws_config.responsive_design_width) {
751         // Responsive web design - change layout on the fly based on
752         // current screen width. Required for mobile devices.
753         $(window).resize( function(e) { mkws_resize_page() });
754         // initial check after page load
755         $(document).ready(function() { mkws_resize_page() });
756     }
757
758     domReady();
759
760     // on first page, hide the termlist
761     $(document).ready(function() { $("#mkwsTermlists").hide(); } );
762     var motd = document.getElementById("mkwsMOTD");
763     var container = document.getElementById("mkwsMOTDContainer");
764     if (motd && container) {
765         // Move the MOTD from the provided element down into the container
766         motd.parentNode.removeChild(motd);
767         container.appendChild(motd);
768     }
769 }
770
771 function mkws_set_lang()  {
772     var lang = $.parseQuerystring().lang || mkws_config.lang;
773     if (!lang || !mkws.locale_lang[lang]) {
774         mkws_config.lang = ""
775     } else {
776         mkws_config.lang = lang;
777     }
778
779     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
780     return mkws_config.lang;
781 }
782
783 function mkws_html_switch() {
784     debug("HTML switch");
785
786     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_records" onclick="mkws.switchView(\'records\')">' + M('Records') + '</a>'));
787     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
788     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_targets" onclick="mkws.switchView(\'targets\')">' + M('Targets') + '</a>'));
789
790     debug("HTML targets");
791     $("#mkwsTargets").html('\
792       <div id="mkwsBytarget">\
793        No information available yet.\
794       </div>');
795     $("#mkwsTargets").css("display", "none");
796 }
797
798 function mkws_html_sort() {
799     debug("HTML sort");
800     var sort_html = '<select name="mkwsSort" id="mkwsSort">';
801
802     for(var i = 0; i < mkws_config.sort_options.length; i++) {
803         var opt = mkws_config.sort_options[i];
804         var key = opt[0];
805         var val = opt.length == 1 ? opt[0] : opt[1];
806
807         sort_html += '<option value="' + key + '"';
808         if (key == mkws_config.sort_default) {
809             sort_html += ' selected="selected"';
810         }
811         sort_html += '>' + M(val) + '</option>';
812     }
813     sort_html += '</select>';
814
815     return sort_html;
816 }
817
818 function mkws_html_perpage() {
819     debug("HTML perpage");
820     var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
821
822     for(var i = 0; i < mkws_config.perpage_options.length; i++) {
823         var key = mkws_config.perpage_options[i];
824
825         perpage_html += '<option value="' + key + '"';
826         if (key == mkws_config.perpage_default) {
827             perpage_html += ' selected="selected"';
828         }
829         perpage_html += '>' + key + '</option>';
830     }
831     perpage_html += '</select>';
832
833     return perpage_html;
834 }
835
836 /*
837  * Run service-proxy authentication in background (after page load).
838  * The username/password is configured in the apache config file
839  * for the site.
840  */
841 function mkws_service_proxy_auth(auth_url, auth_domain) {
842     debug("Run service proxy auth URL: " + auth_url);
843
844     var request = new pzHttpRequest(auth_url, function(err) {
845           alert("HTTP call for authentication failed: " + err)
846           return;
847     }, auth_domain);
848
849     request.get(null, function(data) {
850         if (!$.isXMLDoc(data)) {
851             alert("service proxy auth response document is not valid XML document, give up!");
852             return;
853         }
854         var status = $(data).find("status");
855         if (status.text() != "OK") {
856             alert("service proxy auth repsonse status: " + status.text() + ", give up!");
857             return;
858         }
859
860         debug("Service proxy auth successfully done");
861         mkws.service_proxy_auth = true;
862     });
863 }
864
865 /* create locale language menu */
866 function mkws_html_lang() {
867     var lang_default = "en";
868     var lang = mkws_config.lang || lang_default;
869     var list = [];
870
871     /* display a list of configured languages, or all */
872     var lang_options = mkws_config.lang_options || [];
873     var hash = {};
874     for (var i = 0; i < lang_options.length; i++) {
875         hash[lang_options[i]] = 1;
876     }
877
878     for (var k in mkws.locale_lang) {
879         if (hash[k] == 1 || lang_options.length == 0)
880             list.push(k);
881     }
882
883     // add english link
884     if (lang_options.length == 0 || hash[lang_default] == 1)
885         list.push(lang_default);
886
887     debug("Language menu for: " + list.join(", "));
888
889     /* the HTML part */
890     var data = "";
891     for(var i = 0; i < list.length; i++) {
892         var l = list[i];
893
894         if (data)
895             data += ' | ';
896
897         if (lang == l) {
898             data += ' <span>' + l + '</span> ';
899         } else {
900             data += ' <a href="?lang=' + l + '">' + l + '</a> '
901         }
902     }
903
904     $("#mkwsLang").html(data);
905 }
906
907 function mkws_resize_page () {
908     var list = ["mkwsSwitch"];
909
910     var width = mkws_config.responsive_design_width;
911     var parentId = $("#mkwsTermlists").parent().attr('id');
912
913     if ($(window).width() <= width &&
914         parentId === "mkwsTermlistContainer1") {
915         debug("changing from wide to narrow: " + $(window).width());
916         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer2"));
917         $("#mkwsTermlistContainer1").hide();
918         $("#mkwsTermlistContainer2").show();
919         for(var i = 0; i < list.length; i++) {
920             $("#" + list[i]).hide();
921         }
922     } else if ($(window).width() > width &&
923         parentId === "mkwsTermlistContainer2") {
924         debug("changing from narrow to wide: " + $(window).width());
925         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer1"));
926         $("#mkwsTermlistContainer1").show();
927         $("#mkwsTermlistContainer2").hide();
928         for(var i = 0; i < list.length; i++) {
929             $("#" + list[i]).show();
930         }
931     }
932 };
933
934 /* locale */
935 function M(word) {
936     var lang = mkws_config.lang;
937
938     if (!lang || !mkws.locale_lang[lang])
939         return word;
940
941     return mkws.locale_lang[lang][word] || word;
942 }
943
944 /*
945  * implement jQuery plugins
946  */
947 $.extend({
948     // implement $.parseQuerystring() for parsing URL parameters
949     parseQuerystring: function() {
950         var nvpair = {};
951         var qs = window.location.search.replace('?', '');
952         var pairs = qs.split('&');
953         $.each(pairs, function(i, v){
954             var pair = v.split('=');
955             nvpair[pair[0]] = pair[1];
956         });
957         return nvpair;
958     },
959
960     debug2: function(string) { // delayed debug, internal variables are set after dom ready
961         setTimeout(function() { debug(string); }, 500);
962     },
963
964     // service-proxy or pazpar2
965     pazpar2: function(config) {
966         var id_popup = config.id_popup || "#mkwsPopup";
967         id_popup = id_popup.replace(/^#/, "");
968
969         // simple layout
970         var div = '<div id="mkwsSwitch"></div>\
971         <div id="mkwsLang"></div>\
972         <div id="mkwsSearch"></div>\
973         <div id="mkwsResults"></div>\
974         <div id="mkwsTargets"></div>\
975         <div id="mkwsStat"></div>';
976
977         // new table layout
978         var table = '\
979         <style type="text/css">\
980           #mkwsTermlists div.facet {\
981           float:left;\
982           width: 30%;\
983           margin: 0.3em;\
984           }\
985           #mkwsStat {\
986           text-align: right;\
987           }\
988         </style>\
989             \
990         <table width="100%" border="0">\
991           <tr>\
992             <td>\
993               <div id="mkwsSwitch"></div>\
994               <div id="mkwsLang"></div>\
995               <div id="mkwsSearch"></div>\
996             </td>\
997           </tr>\
998           <tr>\
999             <td>\
1000               <div style="height:500px; overflow: auto">\
1001                 <div id="mkwsPager"></div>\
1002                 <div id="mkwsNavi"></div>\
1003                 <div id="mkwsRecords"></div>\
1004                 <div id="mkwsTargets"></div>\
1005                 <div id="mkwsRanking"></div>\
1006               </div>\
1007             </td>\
1008           </tr>\
1009           <tr>\
1010             <td>\
1011               <div style="height:300px; overflow: hidden">\
1012                 <div id="mkwsTermlists"></div>\
1013               </div>\
1014             </td>\
1015           </tr>\
1016           <tr>\
1017             <td>\
1018               <div id="mkwsStat"></div>\
1019             </td>\
1020           </tr>\
1021         </table>';
1022
1023         var popup = '\
1024           <div id="mkwsSearch"></div>\
1025           <div id="' + id_popup + '">\
1026             <div id="mkwsSwitch"></div>\
1027             <div id="mkwsLang"></div>\
1028             <div id="mkwsResults"></div>\
1029             <div id="mkwsTargets"></div>\
1030             <div id="mkwsStat"></div>\
1031           </div>'
1032
1033         if (config && config.layout == 'div') {
1034             this.debug2("jquery plugin layout: div");
1035             document.write(div);
1036         } else if (config && config.layout == 'popup') {
1037             this.debug2("jquery plugin layout: popup with id: " + id_popup);
1038             document.write(popup);
1039             $(document).ready( function() { init_popup(config); } );
1040         } else {
1041             this.debug2("jquery plugin layout: table");
1042             document.write(table);
1043         }
1044     }
1045 });
1046
1047 function init_popup(obj) {
1048     var config = obj ? obj : {};
1049
1050     var height = config.height || 760;
1051     var width = config.width || 880;
1052     var id_button = config.id_button || "input#mkwsButton";
1053     var id_popup = config.id_popup || "#mkwsPopup";
1054
1055     debug("popup height: " + height + ", width: " + width);
1056
1057     // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
1058     // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
1059     if (!$.ui) {
1060         debug("Error: jquery-ui.js is missing, did you included it after jquery core in the HTML file?");
1061         return;
1062     }
1063
1064     $(id_popup).dialog({
1065       closeOnEscape: true,
1066       autoOpen: false,
1067       height: height,
1068       width: width,
1069       modal: true,
1070       resizable: true,
1071       buttons: {
1072               Cancel: function() {
1073                       $(this).dialog("close");
1074               }
1075       },
1076       close: function() { }
1077     });
1078
1079     $(id_button)
1080       .button()
1081       .click(function() {
1082               $(id_popup).dialog("open");
1083       });
1084 };
1085
1086
1087
1088
1089 /* magic */
1090 $(document).ready(function() {
1091     try {
1092         mkws_html_all()
1093     }
1094
1095     catch (e) {
1096         mkws_config.error = e.message;
1097         // alert(e.message);
1098     }
1099 });
1100
1101 })(jQuery);