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