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