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