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 // delimitTarget(), delimitQuery(), showPage(), pagerPrev(),
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
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);
32 that.toString = function() { return '[Team ' + teamName + ']'; };
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; };
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 };
50 // The following PubSub code is modified from the jQuery manual:
51 // http://api.jquery.com/jQuery.Callbacks/
54 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
55 // team.queue("eventName").publish(arg1, arg2, ...);
60 var callbacks = $.Callbacks();
62 publish: callbacks.fire,
63 subscribe: callbacks.add,
64 unsubscribe: callbacks.remove
74 var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
75 ((now - m_logTime.last)/1000).toFixed(3) + ") ");
77 mkws.log(m_teamName + ": " + timestamp + s);
78 that.queue("log").publish(m_teamName, timestamp, s);
83 log("start running MKWS");
85 m_sortOrder = m_config.sort_default;
86 m_perpage = m_config.perpage_default;
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,
96 "onbytarget": onBytarget,
98 "onterm": (m_config.facets.length ? onTerm : undefined),
100 "onrecord": onRecord,
101 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
102 "termlist": m_config.facets.join(',')
105 // pz2.js event handlers:
112 function onBytarget(data) {
114 queue("targets").publish(data);
117 function onStat(data) {
118 queue("stat").publish(data);
119 if (parseInt(data.activeclients[0], 10) === 0)
120 queue("complete").publish(parseInt(data.hits[0], 10));
123 function onTerm(data) {
125 queue("termlists").publish(data);
128 function onShow(data, teamName) {
130 m_totalRecordCount = data.merged;
131 log("found " + m_totalRecordCount + " records");
132 queue("pager").publish(data);
133 queue("records").publish(data);
136 function onRecord(data, args, teamName) {
138 // FIXME: record is async!!
139 clearTimeout(m_paz.recordTimer);
140 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
141 if (detRecordDiv.length) {
142 // in case on_show was faster to redraw element
145 m_currentRecordData = data;
146 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
147 var html = renderDetails(m_currentRecordData);
148 $(recordDiv).append(html);
152 // Used by the Records widget and onRecord()
153 function recordElementId(s) {
154 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
156 that.recordElementId = recordElementId;
158 // Used by onRecord(), showDetails() and renderDetails()
159 function recordDetailsId(s) {
160 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
164 that.targetFiltered = function(id) {
165 for (var i = 0; i < m_filters.length; i++) {
166 if (m_filters[i].id === id ||
167 m_filters[i].id === 'pz:id=' + id) {
175 that.limitTarget = function(id, name) {
176 log("limitTarget(id=" + id + ", name=" + name + ")");
177 m_filters.push({ id: id, name: name });
183 that.limitQuery = function(field, value) {
184 log("limitQuery(field=" + field + ", value=" + value + ")");
185 m_filters.push({ field: field, value: value });
191 that.delimitTarget = function(id) {
192 log("delimitTarget(id=" + id + ")");
193 removeMatchingFilters(function(f) { return f.id });
199 that.delimitQuery = function(field, value) {
200 log("delimitQuery(field=" + field + ", value=" + value + ")");
201 removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
207 function removeMatchingFilters(matchFn) {
209 for (var i in m_filters) {
210 var filter = m_filters[i];
211 if (matchFn(filter)) {
212 log("removeMatchingFilters() removing filter " + $.toJSON(filter));
214 log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
215 newFilters.push(filter);
218 m_filters = newFilters;
222 that.showPage = function(pageNum) {
223 m_currentPage = pageNum;
224 m_paz.showPage(m_currentPage - 1);
228 that.pagerNext = function() {
229 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
236 that.pagerPrev = function() {
237 if (m_paz.showPrev() != false)
242 that.reShow = function() {
244 m_paz.show(0, m_perpage, m_sortOrder);
248 function resetPage() {
250 m_totalRecordCount = 0;
252 that.resetPage = resetPage;
255 function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
256 log("newSearch: " + query);
258 if (m_config.use_service_proxy && !mkws.authenticated) {
259 alert("searching before authentication");
264 triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
265 switchView('records'); // In case it's configured to start off as hidden
268 that.newSearch = newSearch;
271 function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
273 queue("navi").publish();
276 var pp2limit = limit || "";
278 // Continue to use previous query/sort-order unless new ones are specified
283 m_sortOrder = sortOrder;
289 m_filters.push({ id: targets, name: targets });
292 for (var i in m_filters) {
293 var filter = m_filters[i];
297 if (filter.id.match(/^[a-z:]+[=~]/)) {
298 log("filter '" + filter.id + "' already begins with SETTING OP");
300 filter.id = 'pz:id=' + filter.id;
302 pp2filter += filter.id;
306 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
312 params.limit = pp2limit;
315 params.maxrecs = maxrecs;
318 if (!mkws.config.use_service_proxy)
319 alert("can't narrow search by torusquery when Service Proxy is not in use");
320 params.torusquery = torusquery;
323 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
324 "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
326 // We can use: params.torusquery = "udb=NAME"
327 // Note: that won't work when running against raw pazpar2
328 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
332 // switching view between targets and records
333 function switchView(view) {
334 var targets = findnode('.mkwsTargets');
335 var results = findnode('.mkwsResults,.mkwsRecords');
336 var blanket = findnode('.mkwsBlanket');
337 var motd = findnode('.mkwsMOTD');
341 if (targets) targets.css('display', 'block');
342 if (results) results.css('display', 'none');
343 if (blanket) blanket.css('display', 'none');
344 if (motd) motd.css('display', 'none');
347 if (targets) targets.css('display', 'none');
348 if (results) results.css('display', 'block');
349 if (blanket) blanket.css('display', 'block');
350 if (motd) motd.css('display', 'none');
353 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
354 if (targets) targets.css('display', 'none');
355 if (results) results.css('display', 'none');
356 if (blanket) blanket.css('display', 'none');
357 if (motd) motd.css('display', 'none');
360 alert("Unknown view '" + view + "'");
363 that.switchView = switchView;
366 // detailed record drawing
367 that.showDetails = function(recId) {
368 var oldRecordId = m_currentRecordId;
369 m_currentRecordId = recId;
371 // remove current detailed view if any
372 findnode('#' + recordDetailsId(oldRecordId)).remove();
374 // if the same clicked, just hide
375 if (recId == oldRecordId) {
376 m_currentRecordId = '';
377 m_currentRecordData = null;
380 // request the record
381 log("showDetails() requesting record '" + recId + "'");
387 * All the HTML stuff to render the search forms and
390 function mkwsHtmlAll() {
392 if (m_config.show_lang)
395 log("HTML search form");
396 findnode('.mkwsSearch').html('\
397 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
398 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + m_config.query_width + '" />\
399 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
403 // If the team has a .mkwsResults, populate it in the usual
404 // way. If not, assume that it's a smarter application that
405 // defines its own subcomponents, some or all of the
412 findnode(".mkwsResults").html('\
413 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
415 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
416 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
418 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
419 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
420 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
421 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
422 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
427 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
433 var facets = m_config.facets;
434 acc.push('<div class="title">' + M('Termlists') + '</div>');
435 for (var i = 0; i < facets.length; i++) {
436 acc.push('<div class="mkwsFacet mkwsTeam_' + m_teamName + '" data-mkws-facet="' + facets[i] + '">');
439 findnode(".mkwsTermlists").html(acc.join(''));
441 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
442 if (m_config.show_sort) {
443 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
445 if (m_config.show_perpage) {
446 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
448 ranking_data += '</form>';
449 findnode(".mkwsRanking").html(ranking_data);
453 findnode('.mkwsSearchForm').submit(function() {
454 var val = findnode('.mkwsQuery').val();
459 // on first page, hide the termlist
460 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
461 var container = findnode(".mkwsMOTDContainer");
462 if (container.length) {
463 // Move the MOTD from the provided element down into the container
464 findnode(".mkwsMOTD").appendTo(container);
469 function mkwsSetLang() {
470 var lang = mkws.getParameterByName("lang") || m_config.lang;
471 if (!lang || !mkws.locale_lang[lang]) {
474 m_config.lang = lang;
477 log("Locale language: " + (m_config.lang ? m_config.lang : "none"));
478 return m_config.lang;
482 /* create locale language menu */
483 function mkwsHtmlLang() {
484 var lang_default = "en";
485 var lang = m_config.lang || lang_default;
488 /* display a list of configured languages, or all */
489 var lang_options = m_config.lang_options || [];
490 var toBeIncluded = {};
491 for (var i = 0; i < lang_options.length; i++) {
492 toBeIncluded[lang_options[i]] = true;
495 for (var k in mkws.locale_lang) {
496 if (toBeIncluded[k] || lang_options.length == 0)
501 if (lang_options.length == 0 || toBeIncluded[lang_default])
502 list.push(lang_default);
504 log("Language menu for: " + list.join(", "));
508 for(var i = 0; i < list.length; i++) {
515 data += ' <span>' + l + '</span> ';
517 data += ' <a href="?lang=' + l + '">' + l + '</a> '
521 findnode(".mkwsLang").html(data);
525 function mkwsHtmlSort() {
526 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
527 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
529 for(var i = 0; i < m_config.sort_options.length; i++) {
530 var opt = m_config.sort_options[i];
532 var val = opt.length == 1 ? opt[0] : opt[1];
534 sort_html += '<option value="' + key + '"';
535 if (m_sortOrder == key || m_sortOrder == val) {
536 sort_html += ' selected="selected"';
538 sort_html += '>' + M(val) + '</option>';
540 sort_html += '</select>';
546 function mkwsHtmlPerpage() {
547 log("HTML perpage, m_perpage = " + m_perpage);
548 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
550 for(var i = 0; i < m_config.perpage_options.length; i++) {
551 var key = m_config.perpage_options[i];
553 perpage_html += '<option value="' + key + '"';
554 if (key == m_perpage) {
555 perpage_html += ' selected="selected"';
557 perpage_html += '>' + key + '</option>';
559 perpage_html += '</select>';
565 function mkwsHtmlSwitch() {
566 log("HTML switch for team " + m_teamName);
568 var node = findnode(".mkwsSwitch");
569 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
570 node.append($("<span/>", { text: " | " }));
571 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
574 var node = findnode(".mkwsTargets");
576 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
577 No information available yet.\
579 node.css("display", "none");
583 // Translation function. At present, this is properly a
584 // global-level function (hence the assignment to mkws.M) but we
585 // want to make it per-team so different teams can operate in
586 // different languages.
589 var lang = m_config.lang;
591 if (!lang || !mkws.locale_lang[lang])
594 return mkws.locale_lang[lang][word] || word;
596 mkws.M = M; // so the Handlebars helper can use it
599 // Finds the node of the specified class within the current team
600 // Multiple OR-clauses separated by commas are handled
601 // More complex cases may not work
603 function findnode(selector, teamName) {
604 teamName = teamName || m_teamName;
606 selector = $.map(selector.split(','), function(s, i) {
607 return s + '.mkwsTeam_' + teamName;
610 var node = $(selector);
611 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
614 that.findnode = findnode;
617 function renderDetails(data, marker) {
618 var template = loadTemplate("Record");
619 var details = template(data);
620 return '<div class="details mkwsTeam_' + m_teamName + '" ' +
621 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
623 that.renderDetails = renderDetails;
626 function loadTemplate(name) {
627 var template = m_template[name];
629 if (template === undefined) {
630 // Fall back to generic template if there is no team-specific one
631 var node = findnode(".mkwsTemplate_" + name);
633 node = findnode(".mkwsTemplate_" + name, "ALL");
636 var source = node.html();
638 source = defaultTemplate(name);
641 template = Handlebars.compile(source);
642 log("compiled template '" + name + "'");
643 m_template[name] = template;
648 that.loadTemplate = loadTemplate;
651 function defaultTemplate(name) {
652 if (name === 'Record') {
656 <th>{{translate "Title"}}</th>\
659 {{#if md-title-remainder}}\
660 ({{md-title-remainder}})\
662 {{#if md-title-responsibility}}\
663 <i>{{md-title-responsibility}}</i>\
669 <th>{{translate "Date"}}</th>\
670 <td>{{md-date}}</td>\
675 <th>{{translate "Author"}}</th>\
676 <td>{{md-author}}</td>\
679 {{#if md-electronic-url}}\
681 <th>{{translate "Links"}}</th>\
683 {{#each md-electronic-url}}\
684 <a href="{{this}}">Link{{index1}}</a>\
689 {{#if-any location having="md-subject"}}\
691 <th>{{translate "Subject"}}</th>\
693 {{#first location having="md-subject"}}\
695 {{#commaList md-subject}}\
696 {{this}}{{/commaList}}\
703 <th>{{translate "Locations"}}</th>\
705 {{#commaList location}}\
706 {{attr "@name"}}{{/commaList}}\
711 } else if (name === "Summary") {
713 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
716 {{#if md-title-remainder}}\
717 <span>{{md-title-remainder}}</span>\
719 {{#if md-title-responsibility}}\
720 <span><i>{{md-title-responsibility}}</i></span>\
723 } else if (name === "Image") {
725 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
726 {{#first md-thumburl}}\
727 <img src="{{this}}" alt="{{../md-title}}"/>\
734 var s = "There is no default '" + name +"' template!";