Move non-member function mkws.resize_page outside the team object.
[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 = $('.mkwsStat.mkwsTeam_' + teamName);
294         if (stat.length === 0)
295             return;
296
297         stat.html('<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 = $('.mkwsBytarget.mkwsTeam_' + teamName);
377         if (!targetDiv) {
378             return;
379         }
380
381         var table ='<table><thead><tr>' +
382             '<td>' + M('Target ID') + '</td>' +
383             '<td>' + M('Hits') + '</td>' +
384             '<td>' + M('Diags') + '</td>' +
385             '<td>' + M('Records') + '</td>' +
386             '<td>' + M('State') + '</td>' +
387             '</tr></thead><tbody>';
388
389         for (var i = 0; i < data.length; i++) {
390             table += "<tr><td>" + data[i].id +
391                 "</td><td>" + data[i].hits +
392                 "</td><td>" + data[i].diagnostic +
393                 "</td><td>" + data[i].records +
394                 "</td><td>" + data[i].state + "</td></tr>";
395         }
396
397         table += '</tbody></table>';
398         targetDiv.html(table);
399     }
400
401     ////////////////////////////////////////////////////////////////////////////////
402     ////////////////////////////////////////////////////////////////////////////////
403
404
405     // wait until the DOM is ready
406     function domReady ()
407     {
408         $('.mkwsSearchForm.mkwsTeam_' + m_teamName).each(function (i, obj) {
409             debug("adding search-forms for team '" + m_teamName + "'");
410             var node = this;
411             mkws.handle_node_with_team(node, function(tname) {
412                 debug("adding search-form '" + tname + "' for team '" + m_teamName + "'");
413                 $(node).submit(onFormSubmitEventHandler);
414             });
415         });
416
417         document.mkwsSearchForm.mkwsQuery.value = '';
418         if (document.mkwsSelect) {
419             if (document.mkwsSelect.mkwsSort)
420                 document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
421             if (document.mkwsSelect.mkwsPerpage)
422                 document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
423         }
424     }
425
426
427     // when search button pressed
428     function onFormSubmitEventHandler()
429     {
430         mkws.handle_node_with_team(this, function (tname) {
431             var val = $('.mkwsQuery.mkwsTeam_' + tname).val();
432             mkws.teams[tname].newSearch(val);
433         });
434
435         return false;
436     }
437
438
439     that.newSearch = function(query, sort, targets, windowid)
440     {
441         debug("newSearch: " + query);
442
443         if (mkws_config.use_service_proxy && !mkws.authenticated) {
444             alert("searching before authentication");
445             return;
446         }
447
448         m_filters = []
449         redraw_navi(); // ### should use windowid
450         resetPage(); // ### the globals it resents should be indexed by windowid
451         loadSelect(); // ### should use windowid
452         triggerSearch(query, sort, targets, windowid);
453         mkws.switchView(m_teamName, 'records'); // In case it's configured to start off as hidden
454         m_submitted = true;
455     }
456
457
458     function onSelectDdChange()
459     {
460         if (!m_submitted) return false;
461         resetPage();
462         loadSelect();
463         m_paz.show(0, m_recPerPage, m_sort);
464         return false;
465     }
466
467
468     function resetPage()
469     {
470         m_curPage = 1;
471         m_totalRec = 0;
472     }
473
474
475     function triggerSearch (query, sort, targets, windowid)
476     {
477         var pp2filter = "";
478         var pp2limit = "";
479
480         // Re-use previous query/sort if new ones are not specified
481         if (query) {
482             m_query = query;
483         }
484         if (sort) {
485             m_sort = sort;
486         }
487         if (targets) {
488             // ### should support multiple |-separated targets
489             m_filters.push({ id: targets, name: targets });
490         }
491
492         for (var i in m_filters) {
493             var filter = m_filters[i];
494             if (filter.id) {
495                 if (pp2filter)
496                     pp2filter += ",";
497                 if (filter.id.match(/^[a-z:]+[=~]/)) {
498                     debug("filter '" + filter.id + "' already begins with SETTING OP");
499                 } else {
500                     filter.id = 'pz:id=' + filter.id;
501                 }
502                 pp2filter += filter.id;
503             } else {
504                 if (pp2limit)
505                     pp2limit += ",";
506                 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
507             }
508         }
509
510         var params = {};
511         if (pp2limit) {
512             params.limit = pp2limit;
513         }
514         if (windowid) {
515             params.windowid = windowid;
516         }
517         debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
518
519         m_paz.search(m_query, m_recPerPage, m_sort, pp2filter, undefined, params);
520     }
521
522
523     function loadSelect ()
524     {
525         if (document.mkwsSelect) {
526             if (document.mkwsSelect.mkwsSort)
527                 m_sort = document.mkwsSelect.mkwsSort.value;
528             if (document.mkwsSelect.mkwsPerpage)
529                 m_recPerPage = document.mkwsSelect.mkwsPerpage.value;
530         }
531     }
532
533
534     // limit the query after clicking the facet
535     mkws.limitQuery = function (field, value)
536     {
537         debug("limitQuery(field=" + field + ", value=" + value + ")");
538         m_filters.push({ field: field, value: value });
539         redraw_navi();
540         resetPage();
541         loadSelect();
542         triggerSearch();
543         return false;
544     }
545
546
547     // limit by target functions
548     mkws.limitTarget  = function (id, name)
549     {
550         debug("limitTarget(id=" + id + ", name=" + name + ")");
551         m_filters.push({ id: id, name: name });
552         redraw_navi();
553         resetPage();
554         loadSelect();
555         triggerSearch();
556         return false;
557     }
558
559
560     mkws.delimitQuery = function (field, value)
561     {
562         debug("delimitQuery(field=" + field + ", value=" + value + ")");
563         var newFilters = [];
564         for (var i in m_filters) {
565             var filter = m_filters[i];
566             if (filter.field &&
567                 field == filter.field &&
568                 value == filter.value) {
569                 debug("delimitTarget() removing filter " + $.toJSON(filter));
570             } else {
571                 debug("delimitTarget() keeping filter " + $.toJSON(filter));
572                 newFilters.push(filter);
573             }
574         }
575         m_filters = newFilters;
576
577         redraw_navi();
578         resetPage();
579         loadSelect();
580         triggerSearch();
581         return false;
582     }
583
584
585     mkws.delimitTarget = function (id)
586     {
587         debug("delimitTarget(id=" + id + ")");
588         var newFilters = [];
589         for (var i in m_filters) {
590             var filter = m_filters[i];
591             if (filter.id) {
592                 debug("delimitTarget() removing filter " + $.toJSON(filter));
593             } else {
594                 debug("delimitTarget() keeping filter " + $.toJSON(filter));
595                 newFilters.push(filter);
596             }
597         }
598         m_filters = newFilters;
599
600         redraw_navi();
601         resetPage();
602         loadSelect();
603         triggerSearch();
604         return false;
605     }
606
607
608     function redraw_navi ()
609     {
610         var navi = document.getElementById('mkwsNavi');
611         if (!navi) return;
612
613         var text = "";
614         for (var i in m_filters) {
615             if (text) {
616                 text += " | ";
617             }
618             var filter = m_filters[i];
619             if (filter.id) {
620                 text += 'Source: <a class="crossout" href="#" onclick="mkws.delimitTarget(' +
621                     "'" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
622             } else {
623                 text += filter.field + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(' +
624                     "'" + filter.field + "', '" + filter.value + "'" +
625                     ');return false;">' + filter.value + '</a>';
626             }
627         }
628
629         navi.innerHTML = text;
630     }
631
632
633     function drawPager (pagerDiv)
634     {
635         //client indexes pages from 1 but pz2 from 0
636         var onsides = 6;
637         var pages = Math.ceil(m_totalRec / m_recPerPage);
638
639         var firstClkbl = (m_curPage - onsides > 0)
640             ? m_curPage - onsides
641             : 1;
642
643         var lastClkbl = firstClkbl + 2*onsides < pages
644             ? firstClkbl + 2*onsides
645             : pages;
646
647         var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
648         if (m_curPage > 1)
649             prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
650             +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
651
652         var middle = '';
653         for(var i = firstClkbl; i <= lastClkbl; i++) {
654             var numLabel = i;
655             if(i == m_curPage)
656                 numLabel = '<b>' + i + '</b>';
657
658             middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
659                 + numLabel + ' </a>';
660         }
661
662         var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
663         if (pages - m_curPage > 0)
664             next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
665             + M('Next') + ' &#62;&#62;</a>';
666
667         var predots = '';
668         if (firstClkbl > 1)
669             predots = '...';
670
671         var postdots = '';
672         if (lastClkbl < pages)
673             postdots = '...';
674
675         pagerDiv.innerHTML += '<div style="float: clear">'
676             + prev + predots + middle + postdots + next + '</div>';
677     }
678
679
680     mkws.showPage = function (pageNum)
681     {
682         m_curPage = pageNum;
683         m_paz.showPage(m_curPage - 1);
684     }
685
686
687     // simple paging functions
688     mkws.pagerNext = function () {
689         if (m_totalRec - m_recPerPage*m_curPage > 0) {
690             m_paz.showNext();
691             m_curPage++;
692         }
693     }
694
695
696     mkws.pagerPrev = function () {
697         if (m_paz.showPrev() != false)
698             m_curPage--;
699     }
700
701
702     // switching view between targets and records
703     mkws.switchView = function(tname, view) {
704         debug("switchView(" + tname + ", " + view + ")");
705
706         var targets = $('.mkwsTargets.mkwsTeam_' + tname);
707         var results = $('.mkwsResults.mkwsTeam_' + tname + ',.mkwsRecords.mkwsTeam_' + tname);
708         var blanket = $('#mkwsBlanket');
709         var motd    = $('#mkwsMOTD');
710
711         switch(view) {
712         case 'targets':
713             if (targets) targets.css('display', 'block');
714             if (results) results.css('display', 'none');
715             if (blanket) blanket.css('display', 'none');
716             if (motd) motd.css('display', 'none');
717             break;
718         case 'records':
719             if (targets) targets.css('display', 'none');
720             if (results) results.css('display', 'block');
721             if (blanket) blanket.css('display', 'block');
722             if (motd) motd.css('display', 'none');
723             break;
724         case 'none':
725             alert("mkws.switchView(" + tname + ", 'none') shouldn't happen");
726             if (targets) targets.css('display', 'none');
727             if (results) results.css('display', 'none');
728             if (blanket) blanket.css('display', 'none');
729             if (motd) motd.css('display', 'none');
730             break;
731         default:
732             alert("Unknown view '" + view + "'");
733         }
734     }
735
736
737     // detailed record drawing
738     that.showDetails = function (prefixRecId) {
739         var recId = prefixRecId.replace('mkwsRec_', '');
740         var oldRecId = m_curDetRecId;
741         m_curDetRecId = recId;
742
743         // remove current detailed view if any
744         var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
745         // lovin DOM!
746         if (detRecordDiv)
747             detRecordDiv.parentNode.removeChild(detRecordDiv);
748
749         // if the same clicked, just hide
750         if (recId == oldRecId) {
751             m_curDetRecId = '';
752             m_curDetRecData = null;
753             return;
754         }
755         // request the record
756         m_paz.record(recId);
757     }
758
759
760     function renderDetails(data, marker)
761     {
762         var template = loadTemplate("Record");
763         var details = template(data);
764         return '<div class="details" id="mkwsDet_' + data.recid + '">' + details + '</div>';
765     }
766
767
768     function loadTemplate(name)
769     {
770         var template = mkws['template' + name];
771
772         if (template === undefined) {
773             var source = $("#mkwsTemplate" + name).html();
774             if (!source) {
775                 source = defaultTemplate(name);
776             }
777
778             template = Handlebars.compile(source);
779             debug("compiled template '" + name + "'");
780             mkws['template' + name] = template;
781         }
782
783         return template;
784     }
785
786
787     function defaultTemplate(name)
788     {
789         if (name === 'Record') {
790             return '\
791 <table>\
792   <tr>\
793     <th>{{translate "Title"}}</th>\
794     <td>\
795       {{md-title}}\
796       {{#if md-title-remainder}}\
797         ({{md-title-remainder}})\
798       {{/if}}\
799       {{#if md-title-responsibility}}\
800         <i>{{md-title-responsibility}}</i>\
801       {{/if}}\
802     </td>\
803   </tr>\
804   {{#if md-date}}\
805   <tr>\
806     <th>{{translate "Date"}}</th>\
807     <td>{{md-date}}</td>\
808   </tr>\
809   {{/if}}\
810   {{#if md-author}}\
811   <tr>\
812     <th>{{translate "Author"}}</th>\
813     <td>{{md-author}}</td>\
814   </tr>\
815   {{/if}}\
816   {{#if md-electronic-url}}\
817   <tr>\
818     <th>{{translate "URL"}}</th>\
819     <td>\
820       {{#each md-electronic-url}}\
821         <a href="{{this}}">{{this}}</a><br/>\
822       {{/each}}\
823     </td>\
824   </tr>\
825   {{/if}}\
826   {{#if-any location having="md-subject"}}\
827   <tr>\
828     <th>{{translate "Subject"}}</th>\
829     <td>\
830       {{#first location having="md-subject"}}\
831         {{#if md-subject}}\
832           {{md-subject}}\
833         {{/if}}\
834       {{/first}}\
835     </td>\
836   </tr>\
837   {{/if-any}}\
838   <tr>\
839     <th>{{translate "Locations"}}</th>\
840     <td>\
841       {{#commaList location}}\
842         {{attr "@name"}}{{/commaList}}\
843     </td>\
844   </tr>\
845 </table>\
846 ';
847         } else if (name === "Summary") {
848             return '\
849 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
850   <b>{{md-title}}</b>\
851 </a>\
852 {{#if md-title-remainder}}\
853   <span>{{md-title-remainder}}</span>\
854 {{/if}}\
855 {{#if md-title-responsibility}}\
856   <span><i>{{md-title-responsibility}}</i></span>\
857 {{/if}}\
858 ';
859         }
860
861         var s = "There is no default '" + name +"' template!";
862         alert(s);
863         return s;
864     }
865
866
867     /*
868      * All the HTML stuff to render the search forms and
869      * result pages.
870      */
871     function mkws_html_all() {
872         mkws_set_lang();
873         if (mkws_config.show_lang)
874             mkws_html_lang();
875
876         // For some reason, doing this programmatically results in
877         // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
878         debug("HTML search form");
879         // ### There is only one match here by design: fix not to bother looping
880         $('.mkwsSearch.mkwsTeam_' + m_teamName).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 team has a .mkwsResults, populate it in the usual
893         // way. If not, assume that it's a smarter application that
894         // defines its own subcomponents, some or all of the
895         // following:
896         //      .mkwsTermlists
897         //      .mkwsRanking
898         //      .mkwsPager
899         //      .mkwsNavi
900         //      .mkwsRecords
901         if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) {
902             $(".mkwsResults.mkwsTeam_" + m_teamName).html('\
903 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
904   <tr>\
905     <td id="mkwsTermlistContainer1" class="mkwsTermlistContainer1 mkwsTeam_AUTO" width="250" valign="top">\
906       <div id="mkwsTermlists" class="mkwsTermlists mkwsTeam_AUTO"></div>\
907     </td>\
908     <td id="mkwsMOTDContainer" valign="top">\
909       <div id="mkwsRanking" class="mkwsRanking mkwsTeam_AUTO"></div>\
910       <div id="mkwsPager" class="mkwsPager mkwsTeam_AUTO"></div>\
911       <div id="mkwsNavi" class="mkwsNavi mkwsTeam_AUTO"></div>\
912       <div id="mkwsRecords" class="mkwsRecords mkwsTeam_AUTO"></div>\
913     </td>\
914   </tr>\
915   <tr>\
916     <td colspan="2">\
917       <div id="mkwsTermlistContainer2" class="mkwsTermlistContainer2 mkwsTeam_AUTO"></div>\
918     </td>\
919   </tr>\
920 </table>');
921         }
922
923         if ($("#mkwsRanking").length) {
924             var ranking_data = '';
925             ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
926             if (mkws_config.show_sort) {
927                 ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
928             }
929             if (mkws_config.show_perpage) {
930                 ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
931             }
932             ranking_data += '</form>';
933
934             $("#mkwsRanking").html(ranking_data);
935         }
936
937         mkws_html_switch();
938
939         if (mkws_config.responsive_design_width) {
940             // Responsive web design - change layout on the fly based on
941             // current screen width. Required for mobile devices.
942             $(window).resize(function(e) { mkws.resize_page() });
943             // initial check after page load
944             $(document).ready(function() { mkws.resize_page() });
945         }
946
947         domReady();
948
949         // on first page, hide the termlist
950         $(document).ready(function() { $("#mkwsTermlists").hide(); });
951         var motd = document.getElementById("mkwsMOTD");
952         var container = document.getElementById("mkwsMOTDContainer");
953         if (motd && container) {
954             // Move the MOTD from the provided element down into the container
955             motd.parentNode.removeChild(motd);
956             container.appendChild(motd);
957         }
958     }
959
960
961     // implement $.parseQuerystring() for parsing URL parameters
962     function parseQuerystring() {
963         var nvpair = {};
964         var qs = window.location.search.replace('?', '');
965         var pairs = qs.split('&');
966         $.each(pairs, function(i, v){
967             var pair = v.split('=');
968             nvpair[pair[0]] = pair[1];
969         });
970         return nvpair;
971     }
972
973
974     function mkws_set_lang()  {
975         var lang = parseQuerystring().lang || mkws_config.lang;
976         if (!lang || !mkws.locale_lang[lang]) {
977             mkws_config.lang = ""
978         } else {
979             mkws_config.lang = lang;
980         }
981
982         debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
983         return mkws_config.lang;
984     }
985
986
987     function mkws_html_switch() {
988         debug("HTML switch for team " + m_teamName);
989
990         var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName);
991         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
992         node.append($("<span/>", { text: " | " }));
993         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
994
995         debug("HTML targets");
996         var node = $(".mkwsTargets.mkwsTeam_" + m_teamName);
997         node.html('\
998 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
999   No information available yet.\
1000 </div>');
1001         node.css("display", "none");
1002     }
1003
1004
1005     function mkws_html_sort() {
1006         debug("HTML sort, m_sort = '" + m_sort + "'");
1007         var sort_html = '<select name="mkwsSort" id="mkwsSort">';
1008
1009         for(var i = 0; i < mkws_config.sort_options.length; i++) {
1010             var opt = mkws_config.sort_options[i];
1011             var key = opt[0];
1012             var val = opt.length == 1 ? opt[0] : opt[1];
1013
1014             sort_html += '<option value="' + key + '"';
1015             if (m_sort == key || m_sort == val) {
1016                 sort_html += ' selected="selected"';
1017             }
1018             sort_html += '>' + M(val) + '</option>';
1019         }
1020         sort_html += '</select>';
1021
1022         return sort_html;
1023     }
1024
1025
1026     function mkws_html_perpage() {
1027         debug("HTML perpage");
1028         var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
1029
1030         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
1031             var key = mkws_config.perpage_options[i];
1032
1033             perpage_html += '<option value="' + key + '"';
1034             if (key == mkws_config.perpage_default) {
1035                 perpage_html += ' selected="selected"';
1036             }
1037             perpage_html += '>' + key + '</option>';
1038         }
1039         perpage_html += '</select>';
1040
1041         return perpage_html;
1042     }
1043
1044
1045     /* create locale language menu */
1046     function mkws_html_lang() {
1047         var lang_default = "en";
1048         var lang = mkws_config.lang || lang_default;
1049         var list = [];
1050
1051         /* display a list of configured languages, or all */
1052         var lang_options = mkws_config.lang_options || [];
1053         var toBeIncluded = {};
1054         for (var i = 0; i < lang_options.length; i++) {
1055             toBeIncluded[lang_options[i]] = true;
1056         }
1057
1058         for (var k in mkws.locale_lang) {
1059             if (toBeIncluded[k] || lang_options.length == 0)
1060                 list.push(k);
1061         }
1062
1063         // add english link
1064         if (lang_options.length == 0 || toBeIncluded[lang_default])
1065             list.push(lang_default);
1066
1067         debug("Language menu for: " + list.join(", "));
1068
1069         /* the HTML part */
1070         var data = "";
1071         for(var i = 0; i < list.length; i++) {
1072             var l = list[i];
1073
1074             if (data)
1075                 data += ' | ';
1076
1077             if (lang == l) {
1078                 data += ' <span>' + l + '</span> ';
1079             } else {
1080                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
1081             }
1082         }
1083
1084         $(".mkwsLang.mkwsTeam_" + m_teamName).html(data);
1085     }
1086
1087
1088     /* locale */
1089     function M(word) {
1090         var lang = mkws_config.lang;
1091
1092         if (!lang || !mkws.locale_lang[lang])
1093             return word;
1094
1095         return mkws.locale_lang[lang][word] || word;
1096     }
1097     mkws.M = M; // so the Handlebars helper can use it
1098
1099
1100     // main
1101     (function() {
1102         try {
1103             mkws_html_all()
1104         }
1105
1106         catch (e) {
1107             mkws_config.error = e.message;
1108             // alert(e.message);
1109         }
1110     })();
1111
1112     // Bizarrely, 'that' is just an empty hash. All its state is in
1113     // the closure variables defined earlier in this function.
1114     return that;
1115 };
1116
1117
1118 /*
1119  * implement jQuery plugin $.pazpar2({})
1120  */
1121 function _mkws_jquery_plugin ($) {
1122     var debug_level = 1;
1123
1124     function debug (string) {
1125         if (!debug_level)
1126             return;
1127
1128         if (typeof console === "undefined" || typeof console.log === "undefined")
1129             return;
1130
1131         console.log("jquery.pazpar2: " + string);
1132     }
1133
1134     function init_popup(obj) {
1135         var config = obj ? obj : {};
1136
1137         var height = config.height || 760;
1138         var width = config.width || 880;
1139         var id_button = config.id_button || "input#mkwsButton";
1140         var id_popup = config.id_popup || "#mkwsPopup";
1141
1142         debug("popup height: " + height + ", width: " + width);
1143
1144         // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
1145         // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
1146         if (!$.ui) {
1147             debug("Error: jquery-ui.js is missing, did you include it after jQuery core in the HTML file?");
1148             return;
1149         }
1150
1151         $(id_popup).dialog({
1152             closeOnEscape: true,
1153             autoOpen: false,
1154             height: height,
1155             width: width,
1156             modal: true,
1157             resizable: true,
1158             buttons: {
1159                 Cancel: function() {
1160                     $(this).dialog("close");
1161                 }
1162             },
1163             close: function() { }
1164         });
1165
1166         $(id_button)
1167             .button()
1168             .click(function() {
1169                 $(id_popup).dialog("open");
1170             });
1171     };
1172
1173     $.extend({
1174
1175         // service-proxy or pazpar2
1176         pazpar2: function(config) {
1177             var id_popup = config.id_popup || "#mkwsPopup";
1178             id_popup = id_popup.replace(/^#/, "");
1179
1180             // simple layout
1181             var div = '\
1182 <div id="mkwsSwitch"></div>\
1183 <div id="mkwsLang"></div>\
1184 <div id="mkwsSearch"></div>\
1185 <div id="mkwsResults"></div>\
1186 <div id="mkwsTargets"></div>\
1187 <div id="mkwsStat"></div>';
1188
1189             // new table layout
1190             var table = '\
1191 <style type="text/css">\
1192   #mkwsTermlists div.facet {\
1193   float:left;\
1194   width: 30%;\
1195   margin: 0.3em;\
1196   }\
1197   #mkwsStat {\
1198   text-align: right;\
1199   }\
1200 </style>\
1201     \
1202 <table width="100%" border="0">\
1203   <tr>\
1204     <td>\
1205       <div id="mkwsSwitch"></div>\
1206       <div id="mkwsLang"></div>\
1207       <div id="mkwsSearch"></div>\
1208     </td>\
1209   </tr>\
1210   <tr>\
1211     <td>\
1212       <div style="height:500px; overflow: auto">\
1213         <div id="mkwsPager"></div>\
1214         <div id="mkwsNavi"></div>\
1215         <div id="mkwsRecords"></div>\
1216         <div id="mkwsTargets"></div>\
1217         <div id="mkwsRanking"></div>\
1218       </div>\
1219     </td>\
1220   </tr>\
1221   <tr>\
1222     <td>\
1223       <div style="height:300px; overflow: hidden">\
1224         <div id="mkwsTermlists"></div>\
1225       </div>\
1226     </td>\
1227   </tr>\
1228   <tr>\
1229     <td>\
1230       <div id="mkwsStat"></div>\
1231     </td>\
1232   </tr>\
1233 </table>';
1234
1235             var popup = '\
1236 <div id="mkwsSearch"></div>\
1237 <div id="' + id_popup + '">\
1238   <div id="mkwsSwitch"></div>\
1239   <div id="mkwsLang"></div>\
1240   <div id="mkwsResults"></div>\
1241   <div id="mkwsTargets"></div>\
1242   <div id="mkwsStat"></div>\
1243 </div>'
1244
1245             if (config && config.layout == 'div') {
1246                 debug("jquery plugin layout: div");
1247                 document.write(div);
1248             } else if (config && config.layout == 'popup') {
1249                 debug("jquery plugin layout: popup with id: " + id_popup);
1250                 document.write(popup);
1251                 $(document).ready(function() { init_popup(config); });
1252             } else {
1253                 debug("jquery plugin layout: table");
1254                 document.write(table);
1255             }
1256         }
1257     });
1258 };
1259
1260
1261 // wrapper to call team() after page load
1262 (function (j) {
1263     function log(s) {
1264         if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1265             return;
1266         }
1267         console.log(s);
1268     }
1269
1270     // enable before page load, so we could call it before mkws() runs
1271     _mkws_jquery_plugin(j);
1272
1273     $(document).ready(function() {
1274         log("on load ready");
1275         default_mkws_config();
1276
1277         // Backwards compatibility: set new magic class names on any
1278         // elements that have the old magic IDs.
1279         var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1280                     "Results", "Records", "Targets", "Ranking",
1281                     "Termlists", "Stat" ];
1282         for (var i = 0; i < ids.length; i++) {
1283             var id = 'mkws' + ids[i];
1284             var node = $('#' + id);
1285             if (node.attr('id')) {
1286                 node.addClass(id);
1287                 log("added magic class to '" + node.attr('id') + "'");
1288             }
1289         }
1290
1291         // For all MKWS-classed nodes that don't have a team
1292         // specified, set the team to AUTO.
1293         $('div[class^="mkws"],div[class*=" mkws"]').each(function () {
1294             if (!this.className.match(/mkwsTeam_/)) {
1295                 log("adding AUTO team to node with class '" + this.className + "'");
1296                 $(this).addClass('mkwsTeam_AUTO');
1297             }
1298         });
1299
1300         // Find all nodes with class (NOT id) mkwsRecords, and
1301         // determine their team from the mkwsTeam_* class. So:
1302         //      <div class="mkwsRecords mkwsTeam_foo"/>
1303         $('.mkwsSearch, .mkwsResults, .mkwsRecords, .mkwsTermlists').each(function () {
1304             var node = this;
1305             mkws.handle_node_with_team(node, function(tname) {
1306                 if (mkws.teams[tname]) {
1307                     log("MKWS team '" + tname + "' already exists, skipping");
1308                 } else {
1309                     mkws.teams[tname] = team(j, tname);
1310                     log("Made MKWS team '" + tname + "'");
1311                 }
1312             });
1313         });
1314
1315         if (mkws_config.use_service_proxy) {
1316             authenticate_session(mkws_config.service_proxy_auth,
1317                                  mkws_config.service_proxy_auth_domain,
1318                                  mkws_config.pazpar2_url);
1319         } else {
1320             // raw pp2
1321             run_auto_searches();
1322         }
1323     });
1324
1325
1326     mkws.handle_node_with_team = function(node, callback) {
1327         var classes = node.className;
1328         var list = classes.split(/\s+/)
1329         var tname;
1330         for (var i = 0; i < list.length; i++) {
1331             var cname = list[i];
1332             if (cname.match(/^mkwsTeam_/)) {
1333                 tname = cname.replace(/^mkwsTeam_/, '');
1334             }
1335         }
1336         callback(tname);
1337     }
1338
1339
1340     mkws.resize_page = function () {
1341         var list = ["mkwsSwitch"];
1342
1343         var width = mkws_config.responsive_design_width;
1344         var parentId = $("#mkwsTermlists").parent().attr('id');
1345
1346         if ($(window).width() <= width &&
1347             parentId === "mkwsTermlistContainer1") {
1348             log("changing from wide to narrow: " + $(window).width());
1349             $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer2"));
1350             $("#mkwsTermlistContainer1").hide();
1351             $("#mkwsTermlistContainer2").show();
1352             for(var i = 0; i < list.length; i++) {
1353                 $("#" + list[i]).hide(); // ### make team-aware
1354             }
1355         } else if ($(window).width() > width &&
1356                    parentId === "mkwsTermlistContainer2") {
1357             log("changing from narrow to wide: " + $(window).width());
1358             $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer1"));
1359             $("#mkwsTermlistContainer1").show();
1360             $("#mkwsTermlistContainer2").hide();
1361             for(var i = 0; i < list.length; i++) {
1362                 $("#" + list[i]).show(); // ### make team-aware
1363             }
1364         }
1365     };
1366
1367
1368     mkws.showDetails = function (prefixRecId, tname) {
1369         mkws.teams[tname].showDetails(prefixRecId);
1370     }
1371
1372
1373     function default_mkws_config() {
1374         /* default mkws config */
1375         var config_default = {
1376             use_service_proxy: true,
1377             pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1378             service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1379             lang: "",
1380             sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1381             perpage_options: [10, 20, 30, 50],
1382             sort_default: "relevance",
1383             perpage_default: 20,
1384             query_width: 50,
1385             show_lang: true,    /* show/hide language menu */
1386             show_sort: true,    /* show/hide sort menu */
1387             show_perpage: true,         /* show/hide perpage menu */
1388             lang_options: [],   /* display languages links for given languages, [] for all */
1389             facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
1390             responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1391             debug_level: 1,     /* debug level for development: 0..2 */
1392
1393             dummy: "dummy"
1394         };
1395
1396         /* Set global debug_level flag early so that debug() works */
1397         if (typeof mkws_config.debug_level !== 'undefined') {
1398             mkws.debug_level = mkws_config.debug_level;
1399         } else if (typeof config_default.debug_level !== 'undefined') {
1400             mkws.debug_level = config_default.debug_level;
1401         }
1402
1403         // make sure the mkws_config is a valid hash
1404         if (!$.isPlainObject(mkws_config)) {
1405             debug("ERROR: mkws_config is not an JS object, ignore it....");
1406             mkws_config = {};
1407         }
1408
1409         /* override standard config values by function parameters */
1410         for (var k in config_default) {
1411             if (typeof mkws_config[k] === 'undefined')
1412                 mkws_config[k] = config_default[k];
1413             //debug("Set config: " + k + ' => ' + mkws_config[k]);
1414         }
1415     }
1416
1417
1418     /*
1419      * Run service-proxy authentication in background (after page load).
1420      * The username/password is configured in the apache config file
1421      * for the site.
1422      */
1423     function authenticate_session(auth_url, auth_domain, pp2_url) {
1424         log("Run service proxy auth URL: " + auth_url);
1425
1426         if (!auth_domain) {
1427             auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1428             log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1429         }
1430
1431         var request = new pzHttpRequest(auth_url, function(err) {
1432             alert("HTTP call for authentication failed: " + err)
1433             return;
1434         }, auth_domain);
1435
1436         request.get(null, function(data) {
1437             if (!$.isXMLDoc(data)) {
1438                 alert("service proxy auth response document is not valid XML document, give up!");
1439                 return;
1440             }
1441             var status = $(data).find("status");
1442             if (status.text() != "OK") {
1443                 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1444                 return;
1445             }
1446
1447             log("Service proxy auth successfully done");
1448             mkws.authenticated = true;
1449             run_auto_searches();
1450         });
1451     }
1452
1453
1454     function run_auto_searches() {
1455         log("running auto searches");
1456
1457         for (var teamName in mkws.teams) {
1458             // ### should check mkwsTermlist as well, for facet-only teams
1459             var node = $('.mkwsRecords.mkwsTeam_' + teamName);
1460             var query = node.attr('autosearch');
1461             log("teamName '" + teamName + "', node=" + node + ", class='" + node.className + "', query=" + query);
1462
1463             if (query) {
1464                 var sort = node.attr('sort');
1465                 var targets = node.attr('targets');
1466                 var s = "running auto search: '" + query + "'";
1467                 if (teamName) s += " [teamName '" + teamName + "']";
1468                 if (sort) s += " sorted by '" + sort + "'";
1469                 if (targets) s += " in targets '" + targets + "'";
1470                 log(s);
1471                 var team = mkws.teams[teamName];
1472                 log($.toJSON(team));
1473                 team.newSearch(query, sort, targets, teamName);
1474             }
1475         }
1476     }
1477 })(jQuery);