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