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 = Object.create(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 // https://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 queue("ready").subscribe(function() {
106 log("in 'ready' consumer");
107 that.runAutoSearch();
110 // pz2.js event handlers:
117 function onBytarget(data) {
119 queue("targets").publish(data);
122 function onStat(data) {
124 queue("stat").publish(data);
127 function onTerm(data) {
129 queue("termlists").publish(data);
132 function onShow(data, teamName) {
134 m_totalRecordCount = data.merged;
135 queue("pager").publish(data);
136 queue("records").publish(data);
139 function onRecord(data, args, teamName) {
141 // FIXME: record is async!!
142 clearTimeout(m_paz.recordTimer);
143 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
144 if (detRecordDiv.length) {
145 // in case on_show was faster to redraw element
148 m_currentRecordData = data;
149 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
150 var html = renderDetails(m_currentRecordData);
151 $(recordDiv).append(html);
155 // Used by the Records widget and onRecord()
156 function recordElementId(s) {
157 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
159 that.recordElementId = recordElementId;
161 // Used by onRecord(), showDetails() and renderDetails()
162 function recordDetailsId(s) {
163 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
167 that.targetFiltered = function(id) {
168 for (var i = 0; i < m_filters.length; i++) {
169 if (m_filters[i].id === id ||
170 m_filters[i].id === 'pz:id=' + id) {
178 that.limitTarget = function(id, name)
180 log("limitTarget(id=" + id + ", name=" + name + ")");
181 m_filters.push({ id: id, name: name });
187 that.limitQuery = function(field, value)
189 log("limitQuery(field=" + field + ", value=" + value + ")");
190 m_filters.push({ field: field, value: value });
196 that.delimitTarget = function(id)
198 log("delimitTarget(id=" + id + ")");
199 removeMatchingFilters(function(f) { return f.id });
205 that.delimitQuery = function(field, value)
207 log("delimitQuery(field=" + field + ", value=" + value + ")");
208 removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
214 function removeMatchingFilters(matchFn) {
216 for (var i in m_filters) {
217 var filter = m_filters[i];
218 if (matchFn(filter)) {
219 log("removeMatchingFilters() removing filter " + $.toJSON(filter));
221 log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
222 newFilters.push(filter);
225 m_filters = newFilters;
229 that.showPage = function(pageNum)
231 m_currentPage = pageNum;
232 m_paz.showPage(m_currentPage - 1);
236 that.pagerNext = function() {
237 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
244 that.pagerPrev = function() {
245 if (m_paz.showPrev() != false)
250 that.reShow = function() {
251 m_paz.show(0, m_perpage, m_sortOrder);
258 m_totalRecordCount = 0;
260 that.resetPage = resetPage;
263 function newSearch(query, sortOrder, targets)
265 log("newSearch: " + query);
267 if (m_config.use_service_proxy && !mkws.authenticated) {
268 alert("searching before authentication");
273 triggerSearch(query, sortOrder, targets);
274 switchView('records'); // In case it's configured to start off as hidden
279 function triggerSearch(query, sortOrder, targets)
282 queue("navi").publish();
287 // Continue to use previous query/sort-order unless new ones are specified
292 m_sortOrder = sortOrder;
295 m_filters.push({ id: targets, name: targets });
298 for (var i in m_filters) {
299 var filter = m_filters[i];
303 if (filter.id.match(/^[a-z:]+[=~]/)) {
304 log("filter '" + filter.id + "' already begins with SETTING OP");
306 filter.id = 'pz:id=' + filter.id;
308 pp2filter += filter.id;
312 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
318 params.limit = pp2limit;
321 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
322 "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
324 // We can use: params.torusquery = "udb=NAME"
325 // Note: that won't work when running against raw pazpar2
326 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
330 // switching view between targets and records
331 function switchView(view) {
332 var targets = findnode('.mkwsTargets');
333 var results = findnode('.mkwsResults,.mkwsRecords');
334 var blanket = findnode('.mkwsBlanket');
335 var motd = findnode('.mkwsMOTD');
339 if (targets) targets.css('display', 'block');
340 if (results) results.css('display', 'none');
341 if (blanket) blanket.css('display', 'none');
342 if (motd) motd.css('display', 'none');
345 if (targets) targets.css('display', 'none');
346 if (results) results.css('display', 'block');
347 if (blanket) blanket.css('display', 'block');
348 if (motd) motd.css('display', 'none');
351 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
352 if (targets) targets.css('display', 'none');
353 if (results) results.css('display', 'none');
354 if (blanket) blanket.css('display', 'none');
355 if (motd) motd.css('display', 'none');
358 alert("Unknown view '" + view + "'");
361 that.switchView = switchView;
364 // detailed record drawing
365 that.showDetails = function(recId) {
366 var oldRecordId = m_currentRecordId;
367 m_currentRecordId = recId;
369 // remove current detailed view if any
370 // ##### restrict to current team
371 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
374 detRecordDiv.parentNode.removeChild(detRecordDiv);
376 // if the same clicked, just hide
377 if (recId == oldRecordId) {
378 m_currentRecordId = '';
379 m_currentRecordData = null;
382 // request the record
383 log("showDetails() requesting record '" + recId + "'");
389 * All the HTML stuff to render the search forms and
392 function mkwsHtmlAll() {
394 if (m_config.show_lang)
397 log("HTML search form");
398 findnode('.mkwsSearch').html('\
399 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
400 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + m_config.query_width + '" />\
401 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
405 // If the team has a .mkwsResults, populate it in the usual
406 // way. If not, assume that it's a smarter application that
407 // defines its own subcomponents, some or all of the
414 findnode(".mkwsResults").html('\
415 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
417 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
418 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
420 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
421 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
422 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
423 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
424 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
429 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
434 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
435 if (m_config.show_sort) {
436 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
438 if (m_config.show_perpage) {
439 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
441 ranking_data += '</form>';
442 findnode(".mkwsRanking").html(ranking_data);
446 findnode('.mkwsSearchForm').submit(function() {
447 var val = findnode('.mkwsQuery').val();
452 // on first page, hide the termlist
453 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
454 var container = findnode(".mkwsMOTDContainer");
455 if (container.length) {
456 // Move the MOTD from the provided element down into the container
457 findnode(".mkwsMOTD").appendTo(container);
462 function mkwsSetLang() {
463 var lang = getParameterByName("lang") || m_config.lang;
464 if (!lang || !mkws.locale_lang[lang]) {
467 m_config.lang = lang;
470 log("Locale language: " + (m_config.lang ? m_config.lang : "none"));
471 return m_config.lang;
475 /* create locale language menu */
476 function mkwsHtmlLang() {
477 var lang_default = "en";
478 var lang = m_config.lang || lang_default;
481 /* display a list of configured languages, or all */
482 var lang_options = m_config.lang_options || [];
483 var toBeIncluded = {};
484 for (var i = 0; i < lang_options.length; i++) {
485 toBeIncluded[lang_options[i]] = true;
488 for (var k in mkws.locale_lang) {
489 if (toBeIncluded[k] || lang_options.length == 0)
494 if (lang_options.length == 0 || toBeIncluded[lang_default])
495 list.push(lang_default);
497 log("Language menu for: " + list.join(", "));
501 for(var i = 0; i < list.length; i++) {
508 data += ' <span>' + l + '</span> ';
510 data += ' <a href="?lang=' + l + '">' + l + '</a> '
514 findnode(".mkwsLang").html(data);
518 function mkwsHtmlSort() {
519 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
520 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
522 for(var i = 0; i < m_config.sort_options.length; i++) {
523 var opt = m_config.sort_options[i];
525 var val = opt.length == 1 ? opt[0] : opt[1];
527 sort_html += '<option value="' + key + '"';
528 if (m_sortOrder == key || m_sortOrder == val) {
529 sort_html += ' selected="selected"';
531 sort_html += '>' + M(val) + '</option>';
533 sort_html += '</select>';
539 function mkwsHtmlPerpage() {
540 log("HTML perpage, m_perpage = " + m_perpage);
541 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
543 for(var i = 0; i < m_config.perpage_options.length; i++) {
544 var key = m_config.perpage_options[i];
546 perpage_html += '<option value="' + key + '"';
547 if (key == m_perpage) {
548 perpage_html += ' selected="selected"';
550 perpage_html += '>' + key + '</option>';
552 perpage_html += '</select>';
558 function mkwsHtmlSwitch() {
559 log("HTML switch for team " + m_teamName);
561 var node = findnode(".mkwsSwitch");
562 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
563 node.append($("<span/>", { text: " | " }));
564 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
567 var node = findnode(".mkwsTargets");
569 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
570 No information available yet.\
572 node.css("display", "none");
576 that.runAutoSearch = function() {
577 var node = findnode('.mkwsRecords,.mkwsTermlists');
578 var query = node.attr('autosearch');
582 if (query.match(/^!param!/)) {
583 var param = query.replace(/^!param!/, '');
584 query = getParameterByName(param);
585 log("obtained query '" + query + "' from param '" + param + "'");
587 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
589 } else if (query.match(/^!path!/)) {
590 var index = query.replace(/^!path!/, '');
591 var path = window.location.pathname.split('/');
592 query = path[path.length - index];
593 log("obtained query '" + query + "' from path-component '" + index + "'");
595 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
599 log("node=" + node + ", class='" + node.className + "', query=" + query);
601 var sortOrder = node.attr('sort');
602 var targets = node.attr('targets');
603 var s = "running auto search: '" + query + "'";
604 if (sortOrder) s += " sorted by '" + sortOrder + "'";
605 if (targets) s += " in targets '" + targets + "'";
608 newSearch(query, sortOrder, targets);
612 // This function is taken from a StackOverflow answer
613 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
614 function getParameterByName(name) {
615 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
616 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
617 results = regex.exec(location.search);
618 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
622 // Translation function. At present, this is properly a
623 // global-level function (hence the assignment to mkws.M) but we
624 // want to make it per-team so different teams can operate in
625 // different languages.
628 var lang = m_config.lang;
630 if (!lang || !mkws.locale_lang[lang])
633 return mkws.locale_lang[lang][word] || word;
635 mkws.M = M; // so the Handlebars helper can use it
638 // Finds the node of the specified class within the current team
639 // Multiple OR-clauses separated by commas are handled
640 // More complex cases may not work
642 function findnode(selector, teamName) {
643 teamName = teamName || m_teamName;
645 selector = $.map(selector.split(','), function(s, i) {
646 return s + '.mkwsTeam_' + teamName;
649 var node = $(selector);
650 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
655 function renderDetails(data, marker)
657 var template = loadTemplate("Record");
658 var details = template(data);
659 return '<div class="details mkwsTeam_' + m_teamName + '" ' +
660 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
662 that.renderDetails = renderDetails;
665 function loadTemplate(name)
667 var template = m_template[name];
669 if (template === undefined) {
670 // Fall back to generic template if there is no team-specific one
671 var node = findnode(".mkwsTemplate_" + name);
673 node = findnode(".mkwsTemplate_" + name, "ALL");
676 var source = node.html();
678 source = defaultTemplate(name);
681 template = Handlebars.compile(source);
682 log("compiled template '" + name + "'");
683 m_template[name] = template;
688 that.loadTemplate = loadTemplate;
691 function defaultTemplate(name)
693 if (name === 'Record') {
697 <th>{{translate "Title"}}</th>\
700 {{#if md-title-remainder}}\
701 ({{md-title-remainder}})\
703 {{#if md-title-responsibility}}\
704 <i>{{md-title-responsibility}}</i>\
710 <th>{{translate "Date"}}</th>\
711 <td>{{md-date}}</td>\
716 <th>{{translate "Author"}}</th>\
717 <td>{{md-author}}</td>\
720 {{#if md-electronic-url}}\
722 <th>{{translate "Links"}}</th>\
724 {{#each md-electronic-url}}\
725 <a href="{{this}}">Link{{index1}}</a>\
730 {{#if-any location having="md-subject"}}\
732 <th>{{translate "Subject"}}</th>\
734 {{#first location having="md-subject"}}\
736 {{#commaList md-subject}}\
737 {{this}}{{/commaList}}\
744 <th>{{translate "Locations"}}</th>\
746 {{#commaList location}}\
747 {{attr "@name"}}{{/commaList}}\
752 } else if (name === "Summary") {
754 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
757 {{#if md-title-remainder}}\
758 <span>{{md-title-remainder}}</span>\
760 {{#if md-title-responsibility}}\
761 <span><i>{{md-title-responsibility}}</i></span>\
766 var s = "There is no default '" + name +"' template!";