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