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