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