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