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