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