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