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