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