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