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