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