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