Remove obsolete comment.
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
1 /*! MKWS, the MasterKey Widget Set.
2  *  Copyright (C) 2013-2014 Index Data
3  *  See the file LICENSE for details
4  */
5
6 "use strict"; // HTML5: disable for debug_level >= 2
7
8
9 // Handlebars helpers
10 Handlebars.registerHelper('json', function(obj) {
11     return $.toJSON(obj);
12 });
13
14
15 Handlebars.registerHelper('translate', function(s) {
16     return mkws.M(s);
17 });
18
19
20 // We need {{attr '@name'}} because Handlebars can't parse {{@name}}
21 Handlebars.registerHelper('attr', function(attrName) {
22     return this[attrName];
23 });
24
25
26 /*
27  * Use as follows: {{#if-any NAME1 having="NAME2"}}
28  * Applicable when NAME1 is the name of an array
29  * The guarded code runs only if at least one element of the NAME1
30  * array has a subelement called NAME2.
31  */
32 Handlebars.registerHelper('if-any', function(items, options) {
33     var having = options.hash.having;
34     for (var i in items) {
35         var item = items[i]
36         if (!having || item[having]) {
37             return options.fn(this);
38         }
39     }
40     return "";
41 });
42
43
44 Handlebars.registerHelper('first', function(items, options) {
45     var having = options.hash.having;
46     for (var i in items) {
47         var item = items[i]
48         if (!having || item[having]) {
49             return options.fn(item);
50         }
51     }
52     return "";
53 });
54
55
56 Handlebars.registerHelper('commaList', function(items, options) {
57     var out = "";
58
59     for (var i in items) {
60         if (i > 0) out += ", ";
61         out += options.fn(items[i])
62     }
63
64     return out;
65 });
66
67
68 Handlebars.registerHelper('index1', function(obj) {
69     return obj.data.index + 1;
70 });
71
72
73
74 // Set up global mkws object. Contains truly global state such as SP
75 // authentication, and a hash of team objects, indexed by windowid.
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": my_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": my_oninit,
246                       "onstat": my_onstat,
247                       "onterm": (mkws_config.facets.length ? my_onterm : undefined),
248                       "termlist": mkws_config.facets.join(','),
249                       "onbytarget": my_onbytarget,
250                       "usesessions" : mkws_config.use_service_proxy ? false : true,
251                       "showResponseType": '', // or "json" (for debugging?)
252                       "onrecord": my_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 my_oninit(teamName) {
278         debug("init");
279         m_paz.stat();
280         m_paz.bytarget();
281     }
282
283
284     function my_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 my_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 my_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("my_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                 add_single_facet(acc, "Sources",  data.xtargets, 16, null);
357             } else if (facets[i] == "subject") {
358                 add_single_facet(acc, "Subjects", data.subject,  10, "subject");
359             } else if (facets[i] == "author") {
360                 add_single_facet(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 add_single_facet(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 (!target_filtered(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 target_filtered(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 my_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 my_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     // ### doesn't need windowid
460     function newSearch(query, sort, targets, windowid)
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         redraw_navi();
471         resetPage();
472         loadSelect();
473         triggerSearch(query, sort, targets, windowid);
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     // ### doesn't need windowid
497     function triggerSearch (query, sort, targets, windowid)
498     {
499         var pp2filter = "";
500         var pp2limit = "";
501
502         // Re-use previous query/sort if new ones are not specified
503         if (query) {
504             m_query = query;
505         }
506         if (sort) {
507             m_sort = sort;
508         }
509         if (targets) {
510             // ### should support multiple |-separated targets
511             m_filters.push({ id: targets, name: targets });
512         }
513
514         for (var i in m_filters) {
515             var filter = m_filters[i];
516             if (filter.id) {
517                 if (pp2filter)
518                     pp2filter += ",";
519                 if (filter.id.match(/^[a-z:]+[=~]/)) {
520                     debug("filter '" + filter.id + "' already begins with SETTING OP");
521                 } else {
522                     filter.id = 'pz:id=' + filter.id;
523                 }
524                 pp2filter += filter.id;
525             } else {
526                 if (pp2limit)
527                     pp2limit += ",";
528                 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
529             }
530         }
531
532         var params = {};
533         if (pp2limit) {
534             params.limit = pp2limit;
535         }
536         if (windowid) {
537             params.windowid = windowid;
538         }
539         debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
540
541         // We can use: params.torusquery = "udb=NAME"
542         // Note: that won't work when running against raw pazpar2
543         m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
544     }
545
546
547     function loadSelect ()
548     {
549         var node = findnode('.mkwsSort');
550         if (node.length && node.val() != m_sort) {
551             debug("changing m_sort from " + m_sort + " to " + node.val());
552             m_sort = node.val();
553         }
554         node = findnode('.mkwsPerpage');
555         if (node.length && node.val() != m_perpage) {
556             debug("changing m_perpage from " + m_perpage + " to " + node.val());
557             m_perpage = node.val();
558         }
559     }
560
561
562     // limit by target functions
563     that.limitTarget  = function (id, name)
564     {
565         debug("limitTarget(id=" + id + ", name=" + name + ")");
566         m_filters.push({ id: id, name: name });
567         redraw_navi();
568         resetPage();
569         loadSelect();
570         triggerSearch();
571         return false;
572     }
573
574
575     // limit the query after clicking the facet
576     that.limitQuery = function (field, value)
577     {
578         debug("limitQuery(field=" + field + ", value=" + value + ")");
579         m_filters.push({ field: field, value: value });
580         redraw_navi();
581         resetPage();
582         loadSelect();
583         triggerSearch();
584         return false;
585     }
586
587
588     that.delimitTarget = function (id)
589     {
590         debug("delimitTarget(id=" + id + ")");
591         var newFilters = [];
592         for (var i in m_filters) {
593             var filter = m_filters[i];
594             if (filter.id) {
595                 debug("delimitTarget() removing filter " + $.toJSON(filter));
596             } else {
597                 debug("delimitTarget() keeping filter " + $.toJSON(filter));
598                 newFilters.push(filter);
599             }
600         }
601         m_filters = newFilters;
602
603         redraw_navi();
604         resetPage();
605         loadSelect();
606         triggerSearch();
607         return false;
608     }
609
610
611     that.delimitQuery = function (field, value)
612     {
613         debug("delimitQuery(field=" + field + ", value=" + value + ")");
614         var newFilters = [];
615         for (var i in m_filters) {
616             var filter = m_filters[i];
617             if (filter.field &&
618                 field == filter.field &&
619                 value == filter.value) {
620                 debug("delimitQuery() removing filter " + $.toJSON(filter));
621             } else {
622                 debug("delimitQuery() keeping filter " + $.toJSON(filter));
623                 newFilters.push(filter);
624             }
625         }
626         m_filters = newFilters;
627
628         redraw_navi();
629         resetPage();
630         loadSelect();
631         triggerSearch();
632         return false;
633     }
634
635
636     function redraw_navi ()
637     {
638         var navi = findnode('.mkwsNavi');
639         if (!navi) return;
640
641         var text = "";
642         for (var i in m_filters) {
643             if (text) {
644                 text += " | ";
645             }
646             var filter = m_filters[i];
647             if (filter.id) {
648                 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
649                     "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
650             } else {
651                 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
652                     "', '" + filter.field + "', '" + filter.value + "'" +
653                     ');return false;">' + filter.value + '</a>';
654             }
655         }
656
657         navi.html(text);
658     }
659
660
661     function drawPager (data)
662     {
663         var s = '<div style="float: right">' + M('Displaying') + ': '
664             + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
665             ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
666             + data.total + ')</div>';
667
668         //client indexes pages from 1 but pz2 from 0
669         var onsides = 6;
670         var pages = Math.ceil(m_totalRec / m_perpage);
671
672         var firstClkbl = (m_curPage - onsides > 0)
673             ? m_curPage - onsides
674             : 1;
675
676         var lastClkbl = firstClkbl + 2*onsides < pages
677             ? firstClkbl + 2*onsides
678             : pages;
679
680         var prev = '<span class="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
681         if (m_curPage > 1)
682             prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
683             +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
684
685         var middle = '';
686         for(var i = firstClkbl; i <= lastClkbl; i++) {
687             var numLabel = i;
688             if(i == m_curPage)
689                 numLabel = '<b>' + i + '</b>';
690
691             middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
692                 + numLabel + ' </a>';
693         }
694
695         var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
696         if (pages - m_curPage > 0)
697             next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
698             + M('Next') + ' &#62;&#62;</a>';
699
700         var predots = '';
701         if (firstClkbl > 1)
702             predots = '...';
703
704         var postdots = '';
705         if (lastClkbl < pages)
706             postdots = '...';
707
708         s += '<div style="float: clear">'
709             + prev + predots + middle + postdots + next + '</div>';
710
711         return s;
712     }
713
714
715     that.showPage = function (pageNum)
716     {
717         m_curPage = pageNum;
718         m_paz.showPage(m_curPage - 1);
719     }
720
721
722     // simple paging functions
723     that.pagerNext = function () {
724         if (m_totalRec - m_perpage*m_curPage > 0) {
725             m_paz.showNext();
726             m_curPage++;
727         }
728     }
729
730
731     that.pagerPrev = function () {
732         if (m_paz.showPrev() != false)
733             m_curPage--;
734     }
735
736
737     // switching view between targets and records
738     function switchView(view) {
739         var targets = findnode('.mkwsTargets');
740         var results = findnode('.mkwsResults,.mkwsRecords');
741         var blanket = findnode('.mkwsBlanket');
742         var motd    = findnode('.mkwsMOTD');
743
744         switch(view) {
745         case 'targets':
746             if (targets) targets.css('display', 'block');
747             if (results) results.css('display', 'none');
748             if (blanket) blanket.css('display', 'none');
749             if (motd) motd.css('display', 'none');
750             break;
751         case 'records':
752             if (targets) targets.css('display', 'none');
753             if (results) results.css('display', 'block');
754             if (blanket) blanket.css('display', 'block');
755             if (motd) motd.css('display', 'none');
756             break;
757         case 'none':
758             alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
759             if (targets) targets.css('display', 'none');
760             if (results) results.css('display', 'none');
761             if (blanket) blanket.css('display', 'none');
762             if (motd) motd.css('display', 'none');
763             break;
764         default:
765             alert("Unknown view '" + view + "'");
766         }
767     }
768
769
770     that.switchView = switchView;
771
772
773     // detailed record drawing
774     that.showDetails = function (prefixRecId) {
775         var recId = prefixRecId.replace('mkwsRec_', '');
776         var oldRecId = m_curDetRecId;
777         m_curDetRecId = recId;
778
779         // remove current detailed view if any
780         var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
781         // lovin DOM!
782         if (detRecordDiv)
783             detRecordDiv.parentNode.removeChild(detRecordDiv);
784
785         // if the same clicked, just hide
786         if (recId == oldRecId) {
787             m_curDetRecId = '';
788             m_curDetRecData = null;
789             return;
790         }
791         // request the record
792         debug("showDetails() requesting record '" + recId + "'");
793         m_paz.record(recId);
794     }
795
796
797     function renderDetails(data, marker)
798     {
799         var template = loadTemplate("Record");
800         var details = template(data);
801         return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
802     }
803
804
805     function loadTemplate(name)
806     {
807         var template = m_template[name];
808
809         if (template === undefined) {
810             // Fall back to generic template if there is no team-specific one
811             var node = findnode(".mkwsTemplate_" + name);
812             if (!node.length) {
813                 node = findnode(".mkwsTemplate_" + name, "ALL");
814             }
815
816             var source = node.html();
817             if (!source) {
818                 source = defaultTemplate(name);
819             }
820
821             template = Handlebars.compile(source);
822             debug("compiled template '" + name + "'");
823             m_template[name] = template;
824         }
825
826         return template;
827     }
828
829
830     function defaultTemplate(name)
831     {
832         if (name === 'Record') {
833             return '\
834 <table>\
835   <tr>\
836     <th>{{translate "Title"}}</th>\
837     <td>\
838       {{md-title}}\
839       {{#if md-title-remainder}}\
840         ({{md-title-remainder}})\
841       {{/if}}\
842       {{#if md-title-responsibility}}\
843         <i>{{md-title-responsibility}}</i>\
844       {{/if}}\
845     </td>\
846   </tr>\
847   {{#if md-date}}\
848   <tr>\
849     <th>{{translate "Date"}}</th>\
850     <td>{{md-date}}</td>\
851   </tr>\
852   {{/if}}\
853   {{#if md-author}}\
854   <tr>\
855     <th>{{translate "Author"}}</th>\
856     <td>{{md-author}}</td>\
857   </tr>\
858   {{/if}}\
859   {{#if md-electronic-url}}\
860   <tr>\
861     <th>{{translate "Links"}}</th>\
862     <td>\
863       {{#each md-electronic-url}}\
864         <a href="{{this}}">Link{{index1}}</a>\
865       {{/each}}\
866     </td>\
867   </tr>\
868   {{/if}}\
869   {{#if-any location having="md-subject"}}\
870   <tr>\
871     <th>{{translate "Subject"}}</th>\
872     <td>\
873       {{#first location having="md-subject"}}\
874         {{#if md-subject}}\
875           {{#commaList md-subject}}\
876             {{this}}{{/commaList}}\
877         {{/if}}\
878       {{/first}}\
879     </td>\
880   </tr>\
881   {{/if-any}}\
882   <tr>\
883     <th>{{translate "Locations"}}</th>\
884     <td>\
885       {{#commaList location}}\
886         {{attr "@name"}}{{/commaList}}\
887     </td>\
888   </tr>\
889 </table>\
890 ';
891         } else if (name === "Summary") {
892             return '\
893 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
894   <b>{{md-title}}</b>\
895 </a>\
896 {{#if md-title-remainder}}\
897   <span>{{md-title-remainder}}</span>\
898 {{/if}}\
899 {{#if md-title-responsibility}}\
900   <span><i>{{md-title-responsibility}}</i></span>\
901 {{/if}}\
902 ';
903         }
904
905         var s = "There is no default '" + name +"' template!";
906         alert(s);
907         return s;
908     }
909
910
911     /*
912      * All the HTML stuff to render the search forms and
913      * result pages.
914      */
915     // ### This and other multi-word identifiers should be camelCase
916     function mkws_html_all() {
917         mkws_set_lang();
918         if (mkws_config.show_lang)
919             mkws_html_lang();
920
921         debug("HTML search form");
922         mkws.handle_node_with_team(findnode('.mkwsSearch'), function(tname) {
923             this.html('\
924 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
925   <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
926   <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
927 </form>');
928         });
929
930         debug("HTML records");
931         // If the team has a .mkwsResults, populate it in the usual
932         // way. If not, assume that it's a smarter application that
933         // defines its own subcomponents, some or all of the
934         // following:
935         //      .mkwsTermlists
936         //      .mkwsRanking
937         //      .mkwsPager
938         //      .mkwsNavi
939         //      .mkwsRecords
940         if (findnode(".mkwsResults").length) {
941             findnode(".mkwsResults").html('\
942 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
943   <tr>\
944     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
945       <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
946     </td>\
947     <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
948       <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
949       <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
950       <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
951       <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
952     </td>\
953   </tr>\
954   <tr>\
955     <td colspan="2">\
956       <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
957     </td>\
958   </tr>\
959 </table>');
960         }
961
962         var node = findnode(".mkwsRanking");
963         if (node.length) {
964             var ranking_data = '';
965             ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
966             if (mkws_config.show_sort) {
967                 ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
968             }
969             if (mkws_config.show_perpage) {
970                 ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
971             }
972             ranking_data += '</form>';
973
974             node.html(ranking_data);
975         }
976
977         mkws_html_switch();
978
979         // ### Should not be in the team code, since window size is global
980         if (mkws_config.responsive_design_width) {
981             // Responsive web design - change layout on the fly based on
982             // current screen width. Required for mobile devices.
983             $(window).resize(function(e) { mkws.resize_page() });
984             // initial check after page load
985             $(document).ready(function() { mkws.resize_page() });
986         }
987
988         var node;
989         node = findnode('.mkwsSearchForm');
990         if (node.length)
991             node.submit(onFormSubmitEventHandler);
992         node = findnode('.mkwsSort');
993         if (node.length)
994             node.change(onSelectDdChange);
995         node = findnode('.mkwsPerpage');
996         if (node.length)
997             node.change(onSelectDdChange);
998
999         // on first page, hide the termlist
1000         $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
1001         var motd = findnode(".mkwsMOTD");
1002         var container = findnode(".mkwsMOTDContainer");
1003         if (motd.length && container.length) {
1004             // Move the MOTD from the provided element down into the container
1005             motd.appendTo(container);
1006         }
1007     }
1008
1009
1010     // implement $.parseQuerystring() for parsing URL parameters
1011     function parseQuerystring() {
1012         var nvpair = {};
1013         var qs = window.location.search.replace('?', '');
1014         var pairs = qs.split('&');
1015         $.each(pairs, function(i, v){
1016             var pair = v.split('=');
1017             nvpair[pair[0]] = pair[1];
1018         });
1019         return nvpair;
1020     }
1021
1022
1023     function mkws_set_lang()  {
1024         var lang = parseQuerystring().lang || mkws_config.lang;
1025         if (!lang || !mkws.locale_lang[lang]) {
1026             mkws_config.lang = ""
1027         } else {
1028             mkws_config.lang = lang;
1029         }
1030
1031         debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
1032         return mkws_config.lang;
1033     }
1034
1035
1036     function mkws_html_switch() {
1037         debug("HTML switch for team " + m_teamName);
1038
1039         var node = findnode(".mkwsSwitch");
1040         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
1041         node.append($("<span/>", { text: " | " }));
1042         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
1043
1044         debug("HTML targets");
1045         var node = findnode(".mkwsTargets");
1046         node.html('\
1047 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1048   No information available yet.\
1049 </div>');
1050         node.css("display", "none");
1051     }
1052
1053
1054     function mkws_html_sort() {
1055         debug("HTML sort, m_sort = '" + m_sort + "'");
1056         var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
1057
1058         for(var i = 0; i < mkws_config.sort_options.length; i++) {
1059             var opt = mkws_config.sort_options[i];
1060             var key = opt[0];
1061             var val = opt.length == 1 ? opt[0] : opt[1];
1062
1063             sort_html += '<option value="' + key + '"';
1064             if (m_sort == key || m_sort == val) {
1065                 sort_html += ' selected="selected"';
1066             }
1067             sort_html += '>' + M(val) + '</option>';
1068         }
1069         sort_html += '</select>';
1070
1071         return sort_html;
1072     }
1073
1074
1075     function mkws_html_perpage() {
1076         debug("HTML perpage, m_perpage = " + m_perpage);
1077         var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
1078
1079         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
1080             var key = mkws_config.perpage_options[i];
1081
1082             perpage_html += '<option value="' + key + '"';
1083             if (key == m_perpage) {
1084                 perpage_html += ' selected="selected"';
1085             }
1086             perpage_html += '>' + key + '</option>';
1087         }
1088         perpage_html += '</select>';
1089
1090         return perpage_html;
1091     }
1092
1093
1094     /* create locale language menu */
1095     function mkws_html_lang() {
1096         var lang_default = "en";
1097         var lang = mkws_config.lang || lang_default;
1098         var list = [];
1099
1100         /* display a list of configured languages, or all */
1101         var lang_options = mkws_config.lang_options || [];
1102         var toBeIncluded = {};
1103         for (var i = 0; i < lang_options.length; i++) {
1104             toBeIncluded[lang_options[i]] = true;
1105         }
1106
1107         for (var k in mkws.locale_lang) {
1108             if (toBeIncluded[k] || lang_options.length == 0)
1109                 list.push(k);
1110         }
1111
1112         // add english link
1113         if (lang_options.length == 0 || toBeIncluded[lang_default])
1114             list.push(lang_default);
1115
1116         debug("Language menu for: " + list.join(", "));
1117
1118         /* the HTML part */
1119         var data = "";
1120         for(var i = 0; i < list.length; i++) {
1121             var l = list[i];
1122
1123             if (data)
1124                 data += ' | ';
1125
1126             if (lang == l) {
1127                 data += ' <span>' + l + '</span> ';
1128             } else {
1129                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
1130             }
1131         }
1132
1133         findnode(".mkwsLang").html(data);
1134     }
1135
1136
1137     that.run_auto_search = function() {
1138         // ### should check mkwsTermlist as well, for facet-only teams
1139         var node = findnode('.mkwsRecords');
1140         var query = node.attr('autosearch');
1141         if (!query)
1142             return;
1143
1144         if (query.match(/^!param!/)) {
1145             var param = query.replace(/^!param!/, '');
1146             query = getParameterByName(param);
1147             debug("obtained query '" + query + "' from param '" + param + "'");
1148             if (!query) {
1149                 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1150             }
1151         } else if (query.match(/^!path!/)) {
1152             var index = query.replace(/^!path!/, '');
1153             var path = window.location.pathname.split('/');
1154             query = path[path.length - index];
1155             debug("obtained query '" + query + "' from path-component '" + index + "'");
1156             if (!query) {
1157                 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1158             }
1159         }
1160
1161         debug("node=" + node + ", class='" + node.className + "', query=" + query);
1162
1163         var sort = node.attr('sort');
1164         var targets = node.attr('targets');
1165         var s = "running auto search: '" + query + "'";
1166         if (sort) s += " sorted by '" + sort + "'";
1167         if (targets) s += " in targets '" + targets + "'";
1168         debug(s);
1169
1170         newSearch(query, sort, targets, m_teamName);
1171     }
1172
1173
1174     // This function is taken from a StackOverflow answer
1175     // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1176     // ### should we unify this and parseQuerystring()?
1177     function getParameterByName(name) {
1178         name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1179         var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1180             results = regex.exec(location.search);
1181         return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1182     }
1183
1184
1185     /* locale */
1186     function M(word) {
1187         var lang = mkws_config.lang;
1188
1189         if (!lang || !mkws.locale_lang[lang])
1190             return word;
1191
1192         return mkws.locale_lang[lang][word] || word;
1193     }
1194     mkws.M = M; // so the Handlebars helper can use it
1195
1196
1197     // main
1198     (function() {
1199         try {
1200             mkws_html_all()
1201         }
1202
1203         catch (e) {
1204             mkws_config.error = e.message;
1205             // alert(e.message);
1206         }
1207     })();
1208
1209     // Bizarrely, 'that' is just an empty hash. All its state is in
1210     // the closure variables defined earlier in this function.
1211     return that;
1212 };
1213
1214
1215 // wrapper to call team() after page load
1216 (function (j) {
1217     mkws.debug = function (string) {
1218         if (!mkws.debug_level)
1219             return;
1220
1221         if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1222             return;
1223         }
1224
1225         // you need to disable use strict at the top of the file!!!
1226         if (mkws.debug_level >= 3) {
1227             console.log(arguments.callee.caller);
1228         } else if (mkws.debug_level >= 2) {
1229             console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1230         }
1231         console.log(string);
1232     }
1233     var debug = mkws.debug;
1234
1235
1236     mkws.handle_node_with_team = function(node, callback) {
1237         // First branch for DOM objects; second branch for jQuery objects
1238         var classes = node.className || node.attr('class');
1239         if (!classes) {
1240             // For some reason, if we try to proceed when classes is
1241             // undefined, we don't get an error message, but this
1242             // function and its callers, up several stack level,
1243             // silently return. What a crock.
1244             mkws.debug("handle_node_with_team() called on node with no classes");
1245             return;
1246         }
1247         var list = classes.split(/\s+/)
1248         var teamName, type;
1249
1250         for (var i = 0; i < list.length; i++) {
1251             var cname = list[i];
1252             if (cname.match(/^mkwsTeam_/)) {
1253                 teamName = cname.replace(/^mkwsTeam_/, '');
1254             } else if (cname.match(/^mkws/)) {
1255                 type = cname.replace(/^mkws/, '');
1256             }
1257         }
1258         callback.call(node, teamName, type);
1259     }
1260
1261
1262     mkws.resize_page = function () {
1263         var list = ["mkwsSwitch", "mkwsLang"];
1264
1265         var width = mkws_config.responsive_design_width;
1266         var parent = $(".mkwsTermlists").parent();
1267
1268         if ($(window).width() <= width &&
1269             parent.hasClass("mkwsTermlistContainer1")) {
1270             debug("changing from wide to narrow: " + $(window).width());
1271             $(".mkwsTermlistContainer1").hide();
1272             $(".mkwsTermlistContainer2").show();
1273             for (var tname in mkws.teams) {
1274                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1275                 for(var i = 0; i < list.length; i++) {
1276                     $("." + list[i] + ".mkwsTeam_" + tname).hide();
1277                 }
1278             }
1279         } else if ($(window).width() > width &&
1280                    parent.hasClass("mkwsTermlistContainer2")) {
1281             debug("changing from narrow to wide: " + $(window).width());
1282             $(".mkwsTermlistContainer1").show();
1283             $(".mkwsTermlistContainer2").hide();
1284             for (var tname in mkws.teams) {
1285                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1286                 for(var i = 0; i < list.length; i++) {
1287                     $("." + list[i] + ".mkwsTeam_" + tname).show();
1288                 }
1289             }
1290         }
1291     };
1292
1293
1294     mkws.switchView = function(tname, view) {
1295         mkws.teams[tname].switchView(view);
1296     }
1297
1298     mkws.showDetails = function (tname, prefixRecId) {
1299         mkws.teams[tname].showDetails(prefixRecId);
1300     }
1301
1302     mkws.limitTarget  = function (tname, id, name) {
1303         mkws.teams[tname].limitTarget(id, name);
1304     }
1305
1306     mkws.limitQuery  = function (tname, field, value) {
1307         mkws.teams[tname].limitQuery(field, value);
1308     }
1309
1310     mkws.delimitTarget = function (tname, id) {
1311         mkws.teams[tname].delimitTarget(id);
1312     }
1313
1314     mkws.delimitQuery = function (tname, field, value) {
1315         mkws.teams[tname].delimitQuery(field, value);
1316     }
1317
1318     mkws.showPage = function (tname, pageNum) {
1319         mkws.teams[tname].showPage(pageNum);
1320     }
1321
1322     mkws.pagerPrev = function (tname) {
1323         mkws.teams[tname].pagerPrev();
1324     }
1325
1326     mkws.pagerNext = function (tname) {
1327         mkws.teams[tname].pagerNext();
1328     }
1329
1330
1331     function default_mkws_config() {
1332         /* default mkws config */
1333         var config_default = {
1334             use_service_proxy: true,
1335             pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1336             service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1337             lang: "",
1338             sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1339             perpage_options: [10, 20, 30, 50],
1340             sort_default: "relevance",
1341             perpage_default: 20,
1342             query_width: 50,
1343             show_lang: true,    /* show/hide language menu */
1344             show_sort: true,    /* show/hide sort menu */
1345             show_perpage: true,         /* show/hide perpage menu */
1346             lang_options: [],   /* display languages links for given languages, [] for all */
1347             facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1348             responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1349             debug_level: 1,     /* debug level for development: 0..2 */
1350
1351             dummy: "dummy"
1352         };
1353
1354         /* Set global debug_level flag early so that debug() works */
1355         if (typeof mkws_config.debug_level !== 'undefined') {
1356             mkws.debug_level = mkws_config.debug_level;
1357         } else if (typeof config_default.debug_level !== 'undefined') {
1358             mkws.debug_level = config_default.debug_level;
1359         }
1360
1361         // make sure the mkws_config is a valid hash
1362         if (!$.isPlainObject(mkws_config)) {
1363             debug("ERROR: mkws_config is not an JS object, ignore it....");
1364             mkws_config = {};
1365         }
1366
1367         /* override standard config values by function parameters */
1368         for (var k in config_default) {
1369             if (typeof mkws_config[k] === 'undefined')
1370                 mkws_config[k] = config_default[k];
1371             //debug("Set config: " + k + ' => ' + mkws_config[k]);
1372         }
1373     }
1374
1375
1376     /*
1377      * Run service-proxy authentication in background (after page load).
1378      * The username/password is configured in the apache config file
1379      * for the site.
1380      */
1381     function authenticate_session(auth_url, auth_domain, pp2_url) {
1382         debug("Run service proxy auth URL: " + auth_url);
1383
1384         if (!auth_domain) {
1385             auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1386             debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1387         }
1388
1389         var request = new pzHttpRequest(auth_url, function(err) {
1390             alert("HTTP call for authentication failed: " + err)
1391             return;
1392         }, auth_domain);
1393
1394         request.get(null, function(data) {
1395             if (!$.isXMLDoc(data)) {
1396                 alert("service proxy auth response document is not valid XML document, give up!");
1397                 return;
1398             }
1399             var status = $(data).find("status");
1400             if (status.text() != "OK") {
1401                 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1402                 return;
1403             }
1404
1405             debug("Service proxy auth successfully done");
1406             mkws.authenticated = true;
1407             run_auto_searches();
1408         });
1409     }
1410
1411
1412     function run_auto_searches() {
1413         debug("running auto searches");
1414
1415         for (var teamName in mkws.teams) {
1416             mkws.teams[teamName].run_auto_search();
1417         }
1418     }
1419
1420
1421     $(document).ready(function() {
1422         debug("on load ready");
1423         default_mkws_config();
1424
1425         if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1426             debug("Reset query width: " + mkws_config.query_width);
1427             mkws_config.query_width = 50;
1428         }
1429
1430         for (var key in mkws_config) {
1431             if (mkws_config.hasOwnProperty(key)) {
1432                 if (key.match(/^language_/)) {
1433                     var lang = key.replace(/^language_/, "");
1434                     // Copy custom languages into list
1435                     mkws.locale_lang[lang] = mkws_config[key];
1436                     debug("Added locally configured language '" + lang + "'");
1437                 }
1438             }
1439         }
1440
1441         // Backwards compatibility: set new magic class names on any
1442         // elements that have the old magic IDs.
1443         var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1444                     "Results", "Records", "Targets", "Ranking",
1445                     "Termlists", "Stat", "MOTD" ];
1446         for (var i = 0; i < ids.length; i++) {
1447             var id = 'mkws' + ids[i];
1448             var node = $('#' + id);
1449             if (node.attr('id')) {
1450                 node.addClass(id);
1451                 debug("added magic class to '" + node.attr('id') + "'");
1452             }
1453         }
1454
1455         // For all MKWS-classed nodes that don't have a team
1456         // specified, set the team to AUTO.
1457         $('[class^="mkws"],[class*=" mkws"]').each(function () {
1458             if (!this.className.match(/mkwsTeam_/)) {
1459                 debug("adding AUTO team to node with class '" + this.className + "'");
1460                 $(this).addClass('mkwsTeam_AUTO');
1461             }
1462         });
1463
1464         // Find all nodes with an class, and determine their team from
1465         // the mkwsTeam_* class. Make all team objects.
1466         var then = $.now();
1467         $('[class^="mkws"],[class*=" mkws"]').each(function () {
1468             mkws.handle_node_with_team(this, function(tname, type) {
1469                 if (!mkws.teams[tname]) {
1470                     mkws.teams[tname] = team(j, tname);
1471                     debug("Made MKWS team '" + tname + "'");
1472                 }
1473                 var myTeam = mkws.teams[tname];
1474                 var myWidget = widget(j, myTeam, type, this);
1475             });
1476         });
1477         var now = $.now();
1478         debug("Walking MKWS nodes took " + (now-then) + " ms");
1479
1480         if (mkws_config.use_service_proxy) {
1481             authenticate_session(mkws_config.service_proxy_auth,
1482                                  mkws_config.service_proxy_auth_domain,
1483                                  mkws_config.pazpar2_url);
1484         } else {
1485             // raw pp2
1486             run_auto_searches();
1487         }
1488     });
1489 })(jQuery);