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