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