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