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