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