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