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