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