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