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