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