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