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