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