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