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