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