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