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