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