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