1 // Factory function for team objects. As much as possible, this uses
2 // only member variables (prefixed "m_") and inner functions with
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 // limitCategory(), delimitTarget(), delimitQuery(), showPage(),
9 // pagerPrev(), pagerNext().
11 function team($, teamName) {
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_filterSet = filterSet(that);
19 var m_totalRecordCount = 0;
20 var m_currentPage = 1;
21 var m_currentRecordId = '';
22 var m_currentRecordData = null;
24 // Timestamps for logging
28 var m_paz; // will be initialised below
30 var m_config = mkws.objectInheritingFrom(mkws.config);
31 var m_widgets = {}; // Maps widget-type to object
33 that.toString = function() { return '[Team ' + teamName + ']'; };
35 // Accessor methods for individual widgets: readers
36 that.name = function() { return m_teamName; };
37 that.submitted = function() { return m_submitted; };
38 that.perpage = function() { return m_perpage; };
39 that.totalRecordCount = function() { return m_totalRecordCount; };
40 that.currentPage = function() { return m_currentPage; };
41 that.currentRecordId = function() { return m_currentRecordId; };
42 that.currentRecordData = function() { return m_currentRecordData; };
43 that.filters = function() { return m_filterSet.list(); };
44 that.config = function() { return m_config; };
46 // Accessor methods for individual widgets: writers
47 that.set_sortOrder = function(val) { m_sortOrder = val };
48 that.set_perpage = function(val) { m_perpage = val };
51 // The following PubSub code is modified from the jQuery manual:
52 // http://api.jquery.com/jQuery.Callbacks/
55 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
56 // team.queue("eventName").publish(arg1, arg2, ...);
61 var callbacks = $.Callbacks();
63 publish: callbacks.fire,
64 subscribe: callbacks.add,
65 unsubscribe: callbacks.remove
75 var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
76 ((now - m_logTime.last)/1000).toFixed(3) + ") ");
78 mkws.log(m_teamName + ": " + timestamp + s);
79 that.queue("log").publish(m_teamName, timestamp, s);
84 log("start running MKWS");
86 m_sortOrder = m_config.sort_default;
87 m_perpage = m_config.perpage_default;
89 log("Create main pz2 object");
90 // create a parameters array and pass it to the pz2's constructor
91 // then register the form submit event with the pz2.search function
92 // autoInit is set to true on default
93 m_paz = new pz2({ "windowid": teamName,
94 "pazpar2path": m_config.pazpar2_url,
95 "usesessions" : m_config.use_service_proxy ? false : true,
97 "onbytarget": onBytarget,
99 "onterm": (m_config.facets.length ? onTerm : undefined),
101 "onrecord": onRecord,
102 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
103 "termlist": m_config.facets.join(',')
106 // pz2.js event handlers:
113 function onBytarget(data) {
115 queue("targets").publish(data);
118 function onStat(data) {
119 queue("stat").publish(data);
120 if (parseInt(data.activeclients[0], 10) === 0)
121 queue("complete").publish(parseInt(data.hits[0], 10));
124 function onTerm(data) {
126 queue("termlists").publish(data);
129 function onShow(data, teamName) {
131 m_totalRecordCount = data.merged;
132 log("found " + m_totalRecordCount + " records");
133 queue("pager").publish(data);
134 queue("records").publish(data);
137 function onRecord(data, args, teamName) {
139 // FIXME: record is async!!
140 clearTimeout(m_paz.recordTimer);
141 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
142 if (detRecordDiv.length) {
143 // in case on_show was faster to redraw element
146 m_currentRecordData = data;
147 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
148 var html = renderDetails(m_currentRecordData);
149 $(recordDiv).append(html);
153 // Used by the Records widget and onRecord()
154 function recordElementId(s) {
155 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
157 that.recordElementId = recordElementId;
159 // Used by onRecord(), showDetails() and renderDetails()
160 function recordDetailsId(s) {
161 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
165 that.targetFiltered = function(id) {
166 return m_filterSet.targetFiltered(id);
170 that.limitTarget = function(id, name) {
171 log("limitTarget(id=" + id + ", name=" + name + ")");
172 m_filterSet.add(filter(id, name));
178 that.limitQuery = function(field, value) {
179 log("limitQuery(field=" + field + ", value=" + value + ")");
180 m_filterSet.add(filter(null, null, field, value));
186 that.limitCategory = function(id) {
187 log("limitCategory(id=" + id + ")");
189 // ### triggerSearch() if there's a query
194 that.delimitTarget = function(id) {
195 log("delimitTarget(id=" + id + ")");
196 m_filterSet.removeMatching(function(f) { return f.id });
202 that.delimitQuery = function(field, value) {
203 log("delimitQuery(field=" + field + ", value=" + value + ")");
204 m_filterSet.removeMatching(function(f) { return f.field && field == f.field && value == f.value });
210 that.showPage = function(pageNum) {
211 m_currentPage = pageNum;
212 m_paz.showPage(m_currentPage - 1);
216 that.pagerNext = function() {
217 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
224 that.pagerPrev = function() {
225 if (m_paz.showPrev() != false)
230 that.reShow = function() {
232 m_paz.show(0, m_perpage, m_sortOrder);
236 function resetPage() {
238 m_totalRecordCount = 0;
240 that.resetPage = resetPage;
243 function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
244 log("newSearch: " + query);
246 if (m_config.use_service_proxy && !mkws.authenticated) {
247 alert("searching before authentication");
251 m_filterSet = filterSet(that);
252 triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
253 switchView('records'); // In case it's configured to start off as hidden
256 that.newSearch = newSearch;
259 function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
261 queue("navi").publish();
264 var pp2limit = limit || "";
266 // Continue to use previous query/sort-order unless new ones are specified
271 m_sortOrder = sortOrder;
277 m_filterSet.add(filter(id, id));
280 for (var i in m_filterSet.list()) {
281 var filter = m_filterSet.list()[i];
285 if (filter.id.match(/^[a-z:]+[=~]/)) {
286 log("filter '" + filter.id + "' already begins with SETTING OP");
288 filter.id = 'pz:id=' + filter.id;
290 pp2filter += filter.id;
293 for (var i in m_filterSet.list()) {
294 var filter = m_filterSet.list()[i];
298 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
304 params.limit = pp2limit;
307 params.maxrecs = maxrecs;
310 if (!mkws.config.use_service_proxy)
311 alert("can't narrow search by torusquery when Service Proxy is not in use");
312 params.torusquery = torusquery;
315 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filterSet.list()) + ", " +
316 "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
318 // We can use: params.torusquery = "udb=NAME"
319 // Note: that won't work when running against raw pazpar2
320 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
324 // switching view between targets and records
325 function switchView(view) {
326 var targets = widgetNode('Targets');
327 var results = widgetNode('Results') || widgetNode('Records');
328 var blanket = widgetNode('Blanket');
329 var motd = widgetNode('MOTD');
333 if (targets) targets.css('display', 'block');
334 if (results) results.css('display', 'none');
335 if (blanket) blanket.css('display', 'none');
336 if (motd) motd.css('display', 'none');
339 if (targets) targets.css('display', 'none');
340 if (results) results.css('display', 'block');
341 if (blanket) blanket.css('display', 'block');
342 if (motd) motd.css('display', 'none');
345 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
346 if (targets) targets.css('display', 'none');
347 if (results) results.css('display', 'none');
348 if (blanket) blanket.css('display', 'none');
349 if (motd) motd.css('display', 'none');
352 alert("Unknown view '" + view + "'");
355 that.switchView = switchView;
358 // detailed record drawing
359 that.showDetails = function(recId) {
360 var oldRecordId = m_currentRecordId;
361 m_currentRecordId = recId;
363 // remove current detailed view if any
364 findnode('#' + recordDetailsId(oldRecordId)).remove();
366 // if the same clicked, just hide
367 if (recId == oldRecordId) {
368 m_currentRecordId = '';
369 m_currentRecordData = null;
372 // request the record
373 log("showDetails() requesting record '" + recId + "'");
379 * All the HTML stuff to render the search forms and
382 function mkwsHtmlAll() {
384 if (m_config.show_lang)
387 log("HTML search form");
388 findnode('.mkwsSearch').html('\
389 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
390 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + m_config.query_width + '" />\
391 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
395 // If the team has a .mkwsResults, populate it in the usual
396 // way. If not, assume that it's a smarter application that
397 // defines its own subcomponents, some or all of the
404 findnode(".mkwsResults").html('\
405 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
407 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
408 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
410 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
411 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
412 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
413 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
414 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
419 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
425 var facets = m_config.facets;
426 acc.push('<div class="title">' + M('Termlists') + '</div>');
427 for (var i = 0; i < facets.length; i++) {
428 acc.push('<div class="mkwsFacet mkwsTeam_' + m_teamName + '" data-mkws-facet="' + facets[i] + '">');
431 findnode(".mkwsTermlists").html(acc.join(''));
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() + ' ';
437 if (m_config.show_perpage) {
438 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
440 ranking_data += '</form>';
441 findnode(".mkwsRanking").html(ranking_data);
445 findnode('.mkwsSearchForm').submit(function() {
446 var val = widgetNode('Query').val();
451 // on first page, hide the termlist
452 $(document).ready(function() { widgetNode("Termlists").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);
461 function mkwsSetLang() {
462 var lang = mkws.getParameterByName("lang") || m_config.lang;
463 if (!lang || !mkws.locale_lang[lang]) {
466 m_config.lang = lang;
469 log("Locale language: " + (m_config.lang ? m_config.lang : "none"));
470 return m_config.lang;
474 /* create locale language menu */
475 function mkwsHtmlLang() {
476 var lang_default = "en";
477 var lang = m_config.lang || lang_default;
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;
487 for (var k in mkws.locale_lang) {
488 if (toBeIncluded[k] || lang_options.length == 0)
493 if (lang_options.length == 0 || toBeIncluded[lang_default])
494 list.push(lang_default);
496 log("Language menu for: " + list.join(", "));
500 for(var i = 0; i < list.length; i++) {
507 data += ' <span>' + l + '</span> ';
509 data += ' <a href="?lang=' + l + '">' + l + '</a> '
513 findnode(".mkwsLang").html(data);
517 function mkwsHtmlSort() {
518 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
519 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
521 for(var i = 0; i < m_config.sort_options.length; i++) {
522 var opt = m_config.sort_options[i];
524 var val = opt.length == 1 ? opt[0] : opt[1];
526 sort_html += '<option value="' + key + '"';
527 if (m_sortOrder == key || m_sortOrder == val) {
528 sort_html += ' selected="selected"';
530 sort_html += '>' + M(val) + '</option>';
532 sort_html += '</select>';
538 function mkwsHtmlPerpage() {
539 log("HTML perpage, m_perpage = " + m_perpage);
540 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
542 for(var i = 0; i < m_config.perpage_options.length; i++) {
543 var key = m_config.perpage_options[i];
545 perpage_html += '<option value="' + key + '"';
546 if (key == m_perpage) {
547 perpage_html += ' selected="selected"';
549 perpage_html += '>' + key + '</option>';
551 perpage_html += '</select>';
557 function mkwsHtmlSwitch() {
558 log("HTML switch for team " + m_teamName);
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>'));
566 var node = findnode(".mkwsTargets");
568 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
569 No information available yet.\
571 node.css("display", "none");
575 // Translation function. At present, this is properly a
576 // global-level function (hence the assignment to mkws.M) but we
577 // want to make it per-team so different teams can operate in
578 // different languages.
581 var lang = m_config.lang;
583 if (!lang || !mkws.locale_lang[lang])
586 return mkws.locale_lang[lang][word] || word;
588 mkws.M = M; // so the Handlebars helper can use it
591 // Finds the node of the specified class within the current team
592 function findnode(selector, teamName) {
593 teamName = teamName || m_teamName;
595 if (teamName === 'AUTO') {
596 selector = (selector + '.mkwsTeam_' + teamName + ',' +
597 selector + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])');
599 selector = selector + '.mkwsTeam_' + teamName;
602 var node = $(selector);
603 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
606 that.findnode = findnode;
609 // This much simpler and more efficient function should be usable
610 // in place of most uses of findnode.
611 function widgetNode(type) {
612 var w = that.widget(type);
613 return w ? $(w.node) : undefined;
616 function renderDetails(data, marker) {
617 var template = loadTemplate("Record");
618 var details = template(data);
619 return '<div class="details mkwsTeam_' + m_teamName + '" ' +
620 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
622 that.renderDetails = renderDetails;
625 function loadTemplate(name) {
626 var template = m_template[name];
628 if (template === undefined) {
629 // Fall back to generic template if there is no team-specific one
631 var node = widgetNode("Template_" + name);
633 node = widgetNode("Template_" + name, "ALL");
636 source = node.html();
640 source = defaultTemplate(name);
643 template = Handlebars.compile(source);
644 log("compiled template '" + name + "'");
645 m_template[name] = template;
650 that.loadTemplate = loadTemplate;
653 function defaultTemplate(name) {
654 if (name === 'Record') {
658 <th>{{translate "Title"}}</th>\
661 {{#if md-title-remainder}}\
662 ({{md-title-remainder}})\
664 {{#if md-title-responsibility}}\
665 <i>{{md-title-responsibility}}</i>\
671 <th>{{translate "Date"}}</th>\
672 <td>{{md-date}}</td>\
677 <th>{{translate "Author"}}</th>\
678 <td>{{md-author}}</td>\
681 {{#if md-electronic-url}}\
683 <th>{{translate "Links"}}</th>\
685 {{#each md-electronic-url}}\
686 <a href="{{this}}">Link{{index1}}</a>\
691 {{#if-any location having="md-subject"}}\
693 <th>{{translate "Subject"}}</th>\
695 {{#first location having="md-subject"}}\
697 {{#commaList md-subject}}\
698 {{this}}{{/commaList}}\
705 <th>{{translate "Locations"}}</th>\
707 {{#commaList location}}\
708 {{attr "@name"}}{{/commaList}}\
713 } else if (name === "Summary") {
715 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
718 {{#if md-title-remainder}}\
719 <span>{{md-title-remainder}}</span>\
721 {{#if md-title-responsibility}}\
722 <span><i>{{md-title-responsibility}}</i></span>\
725 } else if (name === "Image") {
727 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
728 {{#first md-thumburl}}\
729 <img src="{{this}}" alt="{{../md-title}}"/>\
736 var s = "There is no default '" + name +"' template!";
741 that.addWidget = function(w) {
742 if (!m_widgets[w.type]) {
743 m_widgets[w.type] = w;
744 log("Registered '" + w.type + "' widget in team '" + m_teamName + "'");
745 } else if (typeof(m_widgets[w.type]) !== 'number') {
746 m_widgets[w.type] = 2;
747 log("Registered duplicate '" + w.type + "' widget in team '" + m_teamName + "'");
749 m_widgets[w.type] += 1;
750 log("Registered '" + w.type + "' widget #" + m_widgets[w.type] + "' in team '" + m_teamName + "'");
754 that.widgetTypes = function() {
756 for (var k in m_widgets) keys.push(k);
760 that.widget = function(type) {
761 return m_widgets[type];