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