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