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