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