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