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