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