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