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