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