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