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