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