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