Add commented-out logging to findnode.
[mkws-moved-to-github.git] / src / mkws-team.js
1 // Factory function for team objects. As much as possible, this uses
2 // only member variables (prefixed "m_") and inner functions with
3 // private scope.
4 //
5 // Some functions are visible as member-functions to be called from
6 // outside code -- specifically, from generated HTML. These functions
7 // are that.switchView(), showDetails(), limitTarget(), limitQuery(),
8 // delimitTarget(), delimitQuery(), showPage(), pagerPrev(),
9 // pagerNext().
10 //
11 function team($, teamName) {
12     var that = {};
13     var m_teamName = teamName;
14     var m_submitted = false;
15     var m_query; // initially undefined
16     var m_sortOrder; // will be set below
17     var m_perpage; // will be set below
18     var m_filters = [];
19     var m_totalRecordCount = 0;
20     var m_currentPage = 1;
21     var m_currentRecordId = '';
22     var m_currentRecordData = null;
23     var m_logTime = {
24         // Timestamps for logging
25         "start": $.now(),
26         "last": $.now()
27     };
28     var m_paz; // will be initialised below
29     var m_template = {};
30
31
32     // Accessor methods for individual widgets: readers
33     that.name = function() { return m_teamName; }
34     that.submitted = function() { return m_submitted; }
35     that.perpage = function() { return m_perpage; }
36     that.totalRecordCount = function() { return m_totalRecordCount; }
37     that.currentPage = function() { return m_currentPage; }
38     that.currentRecordId = function() { return m_currentRecordId; }
39     that.currentRecordData = function() { return m_currentRecordData; }
40     that.filters = function() { return m_filters; }
41
42     // Accessor methods for individual widgets: writers
43     that.set_sortOrder = function(val) { m_sortOrder = val };
44     that.set_perpage = function(val) { m_perpage = val };
45
46
47     function log(s) {
48         var now = $.now();
49         var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
50         m_logTime.last = now;
51
52         mkws.log(m_teamName + ": " + timestamp + s);
53     }
54     that.log = log;
55
56     log("start running MKWS");
57
58     m_sortOrder = mkws_config.sort_default;
59     m_perpage = mkws_config.perpage_default;
60
61     log("Create main pz2 object");
62     // create a parameters array and pass it to the pz2's constructor
63     // then register the form submit event with the pz2.search function
64     // autoInit is set to true on default
65     m_paz = new pz2({ "windowid": teamName,
66                       "pazpar2path": mkws_config.pazpar2_url,
67                       "usesessions" : mkws_config.use_service_proxy ? false : true,
68                       "oninit": onInit,
69                       "onbytarget": onBytarget,
70                       "onstat": onStat,
71                       "onterm": (mkws_config.facets.length ? onTerm : undefined),
72                       "onshow": onShow,
73                       "onrecord": onRecord,
74                       "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
75                       "termlist": mkws_config.facets.join(',')
76                     });
77
78
79     // pz2.js event handlers:
80     function onInit() {
81         log("init");
82         m_paz.stat();
83         m_paz.bytarget();
84     }
85
86     function onBytarget(data) {
87         log("target");
88         queue("targets").publish(data);
89     }
90
91     function onStat(data) {
92         log("stat");
93         queue("stat").publish(data);
94     }
95
96     function onTerm(data) {
97         log("term");
98         queue("termlists").publish(data);
99     }
100
101     function onShow(data, teamName) {
102         log("show");
103         m_totalRecordCount = data.merged;
104         queue("pager").publish(data);
105         queue("records").publish(data);
106     }
107
108     function onRecord(data, args, teamName) {
109         log("record");
110         // FIXME: record is async!!
111         clearTimeout(m_paz.recordTimer);
112         var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
113         if (detRecordDiv.length) {
114             // in case on_show was faster to redraw element
115             return;
116         }
117         m_currentRecordData = data;
118         var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
119         var html = renderDetails(m_currentRecordData);
120         $(recordDiv).append(html);
121     }
122
123
124     // Used by promoteRecords() and onRecord()
125     function recordElementId(s) {
126         return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
127     }
128     that.recordElementId = recordElementId;
129
130     // Used by onRecord(), showDetails() and renderDetails()
131     function recordDetailsId(s) {
132         return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
133     }
134     that.recordElementId = recordElementId;
135
136
137     that.targetFiltered = function(id) {
138         for (var i = 0; i < m_filters.length; i++) {
139             if (m_filters[i].id === id ||
140                 m_filters[i].id === 'pz:id=' + id) {
141                 return true;
142             }
143         }
144         return false;
145     }
146
147
148     that.limitTarget  = function (id, name)
149     {
150         log("limitTarget(id=" + id + ", name=" + name + ")");
151         m_filters.push({ id: id, name: name });
152         triggerSearch();
153         return false;
154     }
155
156
157     that.limitQuery = function (field, value)
158     {
159         log("limitQuery(field=" + field + ", value=" + value + ")");
160         m_filters.push({ field: field, value: value });
161         triggerSearch();
162         return false;
163     }
164
165
166     that.delimitTarget = function (id)
167     {
168         log("delimitTarget(id=" + id + ")");
169         var newFilters = [];
170         for (var i in m_filters) {
171             var filter = m_filters[i];
172             if (filter.id) {
173                 log("delimitTarget() removing filter " + $.toJSON(filter));
174             } else {
175                 log("delimitTarget() keeping filter " + $.toJSON(filter));
176                 newFilters.push(filter);
177             }
178         }
179         m_filters = newFilters;
180
181         triggerSearch();
182         return false;
183     }
184
185
186     that.delimitQuery = function (field, value)
187     {
188         log("delimitQuery(field=" + field + ", value=" + value + ")");
189         var newFilters = [];
190         for (var i in m_filters) {
191             var filter = m_filters[i];
192             if (filter.field &&
193                 field == filter.field &&
194                 value == filter.value) {
195                 log("delimitQuery() removing filter " + $.toJSON(filter));
196             } else {
197                 log("delimitQuery() keeping filter " + $.toJSON(filter));
198                 newFilters.push(filter);
199             }
200         }
201         m_filters = newFilters;
202
203         triggerSearch();
204         return false;
205     }
206
207
208     that.showPage = function (pageNum)
209     {
210         m_currentPage = pageNum;
211         m_paz.showPage(m_currentPage - 1);
212     }
213
214
215     that.pagerNext = function () {
216         if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
217             m_paz.showNext();
218             m_currentPage++;
219         }
220     }
221
222
223     that.pagerPrev = function () {
224         if (m_paz.showPrev() != false)
225             m_currentPage--;
226     }
227
228
229     that.reShow = function() {
230         m_paz.show(0, m_perpage, m_sortOrder);
231     }
232
233
234     function resetPage()
235     {
236         m_currentPage = 1;
237         m_totalRecordCount = 0;
238     }
239     that.resetPage = resetPage;
240
241
242     function newSearch(query, sortOrder, targets)
243     {
244         log("newSearch: " + query);
245
246         if (mkws_config.use_service_proxy && !mkws.authenticated) {
247             alert("searching before authentication");
248             return;
249         }
250
251         m_filters = []
252         triggerSearch(query, sortOrder, targets);
253         switchView('records'); // In case it's configured to start off as hidden
254         m_submitted = true;
255     }
256
257
258     function triggerSearch (query, sortOrder, targets)
259     {
260         resetPage();
261         queue("navi").publish();
262
263         var pp2filter = "";
264         var pp2limit = "";
265
266         // Continue to use previous query/sort-order unless new ones are specified
267         if (query) {
268             m_query = query;
269         }
270         if (sortOrder) {
271             m_sortOrder = sortOrder;
272         }
273         if (targets) {
274             m_filters.push({ id: targets, name: targets });
275         }
276
277         for (var i in m_filters) {
278             var filter = m_filters[i];
279             if (filter.id) {
280                 if (pp2filter)
281                     pp2filter += ",";
282                 if (filter.id.match(/^[a-z:]+[=~]/)) {
283                     log("filter '" + filter.id + "' already begins with SETTING OP");
284                 } else {
285                     filter.id = 'pz:id=' + filter.id;
286                 }
287                 pp2filter += filter.id;
288             } else {
289                 if (pp2limit)
290                     pp2limit += ",";
291                 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
292             }
293         }
294
295         var params = {};
296         if (pp2limit) {
297             params.limit = pp2limit;
298         }
299
300         log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
301
302         // We can use: params.torusquery = "udb=NAME"
303         // Note: that won't work when running against raw pazpar2
304         m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
305     }
306
307
308     // switching view between targets and records
309     function switchView(view) {
310         var targets = findnode('.mkwsTargets');
311         var results = findnode('.mkwsResults,.mkwsRecords');
312         var blanket = findnode('.mkwsBlanket');
313         var motd    = findnode('.mkwsMOTD');
314
315         switch(view) {
316         case 'targets':
317             if (targets) targets.css('display', 'block');
318             if (results) results.css('display', 'none');
319             if (blanket) blanket.css('display', 'none');
320             if (motd) motd.css('display', 'none');
321             break;
322         case 'records':
323             if (targets) targets.css('display', 'none');
324             if (results) results.css('display', 'block');
325             if (blanket) blanket.css('display', 'block');
326             if (motd) motd.css('display', 'none');
327             break;
328         case 'none':
329             alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
330             if (targets) targets.css('display', 'none');
331             if (results) results.css('display', 'none');
332             if (blanket) blanket.css('display', 'none');
333             if (motd) motd.css('display', 'none');
334             break;
335         default:
336             alert("Unknown view '" + view + "'");
337         }
338     }
339     that.switchView = switchView;
340
341
342     // detailed record drawing
343     that.showDetails = function (recId) {
344         var oldRecordId = m_currentRecordId;
345         m_currentRecordId = recId;
346
347         // remove current detailed view if any
348         // ##### restrict to current team
349         var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
350         // lovin DOM!
351         if (detRecordDiv)
352             detRecordDiv.parentNode.removeChild(detRecordDiv);
353
354         // if the same clicked, just hide
355         if (recId == oldRecordId) {
356             m_currentRecordId = '';
357             m_currentRecordData = null;
358             return;
359         }
360         // request the record
361         log("showDetails() requesting record '" + recId + "'");
362         m_paz.record(recId);
363     }
364
365
366     /*
367      * All the HTML stuff to render the search forms and
368      * result pages.
369      */
370     function mkwsHtmlAll() {
371         mkwsSetLang();
372         if (mkws_config.show_lang)
373             mkwsHtmlLang();
374
375         log("HTML search form");
376         findnode('.mkwsSearch').html('\
377 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
378   <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
379   <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
380 </form>');
381
382         log("HTML records");
383         // If the team has a .mkwsResults, populate it in the usual
384         // way. If not, assume that it's a smarter application that
385         // defines its own subcomponents, some or all of the
386         // following:
387         //      .mkwsTermlists
388         //      .mkwsRanking
389         //      .mkwsPager
390         //      .mkwsNavi
391         //      .mkwsRecords
392         findnode(".mkwsResults").html('\
393 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
394   <tr>\
395     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
396       <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
397     </td>\
398     <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
399       <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
400       <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
401       <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
402       <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
403     </td>\
404   </tr>\
405   <tr>\
406     <td colspan="2">\
407       <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
408     </td>\
409   </tr>\
410 </table>');
411
412         var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
413         if (mkws_config.show_sort) {
414             ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
415         }
416         if (mkws_config.show_perpage) {
417             ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
418         }
419         ranking_data += '</form>';
420         findnode(".mkwsRanking").html(ranking_data);
421
422         mkwsHtmlSwitch();
423
424         findnode('.mkwsSearchForm').submit(function() {
425             var val = findnode('.mkwsQuery').val();
426             newSearch(val);
427             return false;
428         });
429
430         // on first page, hide the termlist
431         $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
432         var container = findnode(".mkwsMOTDContainer");
433         if (container.length) {
434             // Move the MOTD from the provided element down into the container
435             findnode(".mkwsMOTD").appendTo(container);
436         }
437     }
438
439
440     function mkwsSetLang()  {
441         var lang = getParameterByName("lang") || mkws_config.lang;
442         if (!lang || !mkws.locale_lang[lang]) {
443             mkws_config.lang = ""
444         } else {
445             mkws_config.lang = lang;
446         }
447
448         log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
449         return mkws_config.lang;
450     }
451
452
453     /* create locale language menu */
454     function mkwsHtmlLang() {
455         var lang_default = "en";
456         var lang = mkws_config.lang || lang_default;
457         var list = [];
458
459         /* display a list of configured languages, or all */
460         var lang_options = mkws_config.lang_options || [];
461         var toBeIncluded = {};
462         for (var i = 0; i < lang_options.length; i++) {
463             toBeIncluded[lang_options[i]] = true;
464         }
465
466         for (var k in mkws.locale_lang) {
467             if (toBeIncluded[k] || lang_options.length == 0)
468                 list.push(k);
469         }
470
471         // add english link
472         if (lang_options.length == 0 || toBeIncluded[lang_default])
473             list.push(lang_default);
474
475         log("Language menu for: " + list.join(", "));
476
477         /* the HTML part */
478         var data = "";
479         for(var i = 0; i < list.length; i++) {
480             var l = list[i];
481
482             if (data)
483                 data += ' | ';
484
485             if (lang == l) {
486                 data += ' <span>' + l + '</span> ';
487             } else {
488                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
489             }
490         }
491
492         findnode(".mkwsLang").html(data);
493     }
494
495
496     function mkwsHtmlSort() {
497         log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
498         var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
499
500         for(var i = 0; i < mkws_config.sort_options.length; i++) {
501             var opt = mkws_config.sort_options[i];
502             var key = opt[0];
503             var val = opt.length == 1 ? opt[0] : opt[1];
504
505             sort_html += '<option value="' + key + '"';
506             if (m_sortOrder == key || m_sortOrder == val) {
507                 sort_html += ' selected="selected"';
508             }
509             sort_html += '>' + M(val) + '</option>';
510         }
511         sort_html += '</select>';
512
513         return sort_html;
514     }
515
516
517     function mkwsHtmlPerpage() {
518         log("HTML perpage, m_perpage = " + m_perpage);
519         var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
520
521         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
522             var key = mkws_config.perpage_options[i];
523
524             perpage_html += '<option value="' + key + '"';
525             if (key == m_perpage) {
526                 perpage_html += ' selected="selected"';
527             }
528             perpage_html += '>' + key + '</option>';
529         }
530         perpage_html += '</select>';
531
532         return perpage_html;
533     }
534
535
536     function mkwsHtmlSwitch() {
537         log("HTML switch for team " + m_teamName);
538
539         var node = findnode(".mkwsSwitch");
540         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
541         node.append($("<span/>", { text: " | " }));
542         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
543
544         log("HTML targets");
545         var node = findnode(".mkwsTargets");
546         node.html('\
547 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
548   No information available yet.\
549 </div>');
550         node.css("display", "none");
551     }
552
553
554     that.runAutoSearch = function() {
555         var node = findnode('.mkwsRecords,.mkwsTermlists');
556         var query = node.attr('autosearch');
557         if (!query)
558             return;
559
560         if (query.match(/^!param!/)) {
561             var param = query.replace(/^!param!/, '');
562             query = getParameterByName(param);
563             log("obtained query '" + query + "' from param '" + param + "'");
564             if (!query) {
565                 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
566             }
567         } else if (query.match(/^!path!/)) {
568             var index = query.replace(/^!path!/, '');
569             var path = window.location.pathname.split('/');
570             query = path[path.length - index];
571             log("obtained query '" + query + "' from path-component '" + index + "'");
572             if (!query) {
573                 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
574             }
575         }
576
577         log("node=" + node + ", class='" + node.className + "', query=" + query);
578
579         var sortOrder = node.attr('sort');
580         var targets = node.attr('targets');
581         var s = "running auto search: '" + query + "'";
582         if (sortOrder) s += " sorted by '" + sortOrder + "'";
583         if (targets) s += " in targets '" + targets + "'";
584         log(s);
585
586         newSearch(query, sortOrder, targets);
587     }
588
589
590     // This function is taken from a StackOverflow answer
591     // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
592     function getParameterByName(name) {
593         name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
594         var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
595             results = regex.exec(location.search);
596         return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
597     }
598
599
600     // Translation function. At present, this is properly a
601     // global-level function (hence the assignment to mkws.M) but we
602     // want to make it per-team so different teams can operate in
603     // different languages.
604     //
605     function M(word) {
606         var lang = mkws_config.lang;
607
608         if (!lang || !mkws.locale_lang[lang])
609             return word;
610
611         return mkws.locale_lang[lang][word] || word;
612     }
613     mkws.M = M; // so the Handlebars helper can use it
614
615
616     // Finds the node of the specified class within the current team
617     // Multiple OR-clauses separated by commas are handled
618     // More complex cases may not work
619     //
620     function findnode(selector, teamName) {
621         teamName = teamName || m_teamName;
622
623         selector = $.map(selector.split(','), function(s, i) {
624             return s + '.mkwsTeam_' + teamName;
625         }).join(',');
626
627         var node = $(selector);
628         //log('findnode(' + selector + ') found ' + node.length + ' nodes');
629         return node;
630     }
631
632
633     function renderDetails(data, marker)
634     {
635         var template = loadTemplate("Record");
636         var details = template(data);
637         return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
638     }
639     that.renderDetails = renderDetails;
640
641
642     function loadTemplate(name)
643     {
644         var template = m_template[name];
645
646         if (template === undefined) {
647             // Fall back to generic template if there is no team-specific one
648             var node = findnode(".mkwsTemplate_" + name);
649             if (!node.length) {
650                 node = findnode(".mkwsTemplate_" + name, "ALL");
651             }
652
653             var source = node.html();
654             if (!source) {
655                 source = defaultTemplate(name);
656             }
657
658             template = Handlebars.compile(source);
659             log("compiled template '" + name + "'");
660             m_template[name] = template;
661         }
662
663         return template;
664     }
665     that.loadTemplate = loadTemplate;
666
667
668     function defaultTemplate(name)
669     {
670         if (name === 'Record') {
671             return '\
672 <table>\
673   <tr>\
674     <th>{{translate "Title"}}</th>\
675     <td>\
676       {{md-title}}\
677       {{#if md-title-remainder}}\
678         ({{md-title-remainder}})\
679       {{/if}}\
680       {{#if md-title-responsibility}}\
681         <i>{{md-title-responsibility}}</i>\
682       {{/if}}\
683     </td>\
684   </tr>\
685   {{#if md-date}}\
686   <tr>\
687     <th>{{translate "Date"}}</th>\
688     <td>{{md-date}}</td>\
689   </tr>\
690   {{/if}}\
691   {{#if md-author}}\
692   <tr>\
693     <th>{{translate "Author"}}</th>\
694     <td>{{md-author}}</td>\
695   </tr>\
696   {{/if}}\
697   {{#if md-electronic-url}}\
698   <tr>\
699     <th>{{translate "Links"}}</th>\
700     <td>\
701       {{#each md-electronic-url}}\
702         <a href="{{this}}">Link{{index1}}</a>\
703       {{/each}}\
704     </td>\
705   </tr>\
706   {{/if}}\
707   {{#if-any location having="md-subject"}}\
708   <tr>\
709     <th>{{translate "Subject"}}</th>\
710     <td>\
711       {{#first location having="md-subject"}}\
712         {{#if md-subject}}\
713           {{#commaList md-subject}}\
714             {{this}}{{/commaList}}\
715         {{/if}}\
716       {{/first}}\
717     </td>\
718   </tr>\
719   {{/if-any}}\
720   <tr>\
721     <th>{{translate "Locations"}}</th>\
722     <td>\
723       {{#commaList location}}\
724         {{attr "@name"}}{{/commaList}}\
725     </td>\
726   </tr>\
727 </table>\
728 ';
729         } else if (name === "Summary") {
730             return '\
731 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
732   <b>{{md-title}}</b>\
733 </a>\
734 {{#if md-title-remainder}}\
735   <span>{{md-title-remainder}}</span>\
736 {{/if}}\
737 {{#if md-title-responsibility}}\
738   <span><i>{{md-title-responsibility}}</i></span>\
739 {{/if}}\
740 ';
741         }
742
743         var s = "There is no default '" + name +"' template!";
744         alert(s);
745         return s;
746     }
747
748
749     // The following PubSub code is modified from the jQuery manual:
750     // https://api.jquery.com/jQuery.Callbacks/
751     //
752     // Use as:
753     //  team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
754     //  team.queue("eventName").publish(arg1, arg2, ...);
755
756     var queues = {};
757     var queue = function(id) {
758         if (!queues[id]) {
759             var callbacks = $.Callbacks();
760             queues[id] = {
761                 publish: callbacks.fire,
762                 subscribe: callbacks.add,
763                 unsubscribe: callbacks.remove
764             };
765         }
766         return queues[id];
767     }
768     that.queue = queue;
769
770     mkwsHtmlAll()
771
772     return that;
773 };