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