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