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