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 // pz2.js event handlers:
112 function onBytarget(data) {
114 queue("targets").publish(data);
117 function onStat(data) {
119 queue("stat").publish(data);
122 function onTerm(data) {
124 queue("termlists").publish(data);
127 function onShow(data, teamName) {
129 m_totalRecordCount = data.merged;
130 queue("pager").publish(data);
131 queue("records").publish(data);
134 function onRecord(data, args, teamName) {
136 // FIXME: record is async!!
137 clearTimeout(m_paz.recordTimer);
138 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
139 if (detRecordDiv.length) {
140 // in case on_show was faster to redraw element
143 m_currentRecordData = data;
144 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
145 var html = renderDetails(m_currentRecordData);
146 $(recordDiv).append(html);
150 // Used by the Records widget and onRecord()
151 function recordElementId(s) {
152 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
154 that.recordElementId = recordElementId;
156 // Used by onRecord(), showDetails() and renderDetails()
157 function recordDetailsId(s) {
158 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
162 that.targetFiltered = function(id) {
163 for (var i = 0; i < m_filters.length; i++) {
164 if (m_filters[i].id === id ||
165 m_filters[i].id === 'pz:id=' + id) {
173 that.limitTarget = function(id, name)
175 log("limitTarget(id=" + id + ", name=" + name + ")");
176 m_filters.push({ id: id, name: name });
182 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)
193 log("delimitTarget(id=" + id + ")");
194 removeMatchingFilters(function(f) { return f.id });
200 that.delimitQuery = function(field, value)
202 log("delimitQuery(field=" + field + ", value=" + value + ")");
203 removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
209 function removeMatchingFilters(matchFn) {
211 for (var i in m_filters) {
212 var filter = m_filters[i];
213 if (matchFn(filter)) {
214 log("removeMatchingFilters() removing filter " + $.toJSON(filter));
216 log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
217 newFilters.push(filter);
220 m_filters = newFilters;
224 that.showPage = function(pageNum)
226 m_currentPage = pageNum;
227 m_paz.showPage(m_currentPage - 1);
231 that.pagerNext = function() {
232 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
239 that.pagerPrev = function() {
240 if (m_paz.showPrev() != false)
245 that.reShow = function() {
246 m_paz.show(0, m_perpage, m_sortOrder);
253 m_totalRecordCount = 0;
255 that.resetPage = resetPage;
258 function newSearch(query, sortOrder, targets)
260 log("newSearch: " + query);
262 if (m_config.use_service_proxy && !mkws.authenticated) {
263 alert("searching before authentication");
268 triggerSearch(query, sortOrder, targets);
269 switchView('records'); // In case it's configured to start off as hidden
272 that.newSearch = newSearch;
275 function triggerSearch(query, sortOrder, targets)
278 queue("navi").publish();
283 // Continue to use previous query/sort-order unless new ones are specified
288 m_sortOrder = sortOrder;
291 m_filters.push({ id: targets, name: targets });
294 for (var i in m_filters) {
295 var filter = m_filters[i];
299 if (filter.id.match(/^[a-z:]+[=~]/)) {
300 log("filter '" + filter.id + "' already begins with SETTING OP");
302 filter.id = 'pz:id=' + filter.id;
304 pp2filter += filter.id;
308 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
314 params.limit = pp2limit;
317 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
318 "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
320 // We can use: params.torusquery = "udb=NAME"
321 // Note: that won't work when running against raw pazpar2
322 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
326 // switching view between targets and records
327 function switchView(view) {
328 var targets = findnode('.mkwsTargets');
329 var results = findnode('.mkwsResults,.mkwsRecords');
330 var blanket = findnode('.mkwsBlanket');
331 var motd = findnode('.mkwsMOTD');
335 if (targets) targets.css('display', 'block');
336 if (results) results.css('display', 'none');
337 if (blanket) blanket.css('display', 'none');
338 if (motd) motd.css('display', 'none');
341 if (targets) targets.css('display', 'none');
342 if (results) results.css('display', 'block');
343 if (blanket) blanket.css('display', 'block');
344 if (motd) motd.css('display', 'none');
347 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
348 if (targets) targets.css('display', 'none');
349 if (results) results.css('display', 'none');
350 if (blanket) blanket.css('display', 'none');
351 if (motd) motd.css('display', 'none');
354 alert("Unknown view '" + view + "'");
357 that.switchView = switchView;
360 // detailed record drawing
361 that.showDetails = function(recId) {
362 var oldRecordId = m_currentRecordId;
363 m_currentRecordId = recId;
365 // remove current detailed view if any
366 // ##### restrict to current team
367 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
370 detRecordDiv.parentNode.removeChild(detRecordDiv);
372 // if the same clicked, just hide
373 if (recId == oldRecordId) {
374 m_currentRecordId = '';
375 m_currentRecordData = null;
378 // request the record
379 log("showDetails() requesting record '" + recId + "'");
385 * All the HTML stuff to render the search forms and
388 function mkwsHtmlAll() {
390 if (m_config.show_lang)
393 log("HTML search form");
394 findnode('.mkwsSearch').html('\
395 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
396 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + m_config.query_width + '" />\
397 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
401 // If the team has a .mkwsResults, populate it in the usual
402 // way. If not, assume that it's a smarter application that
403 // defines its own subcomponents, some or all of the
410 findnode(".mkwsResults").html('\
411 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
413 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
414 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
416 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
417 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
418 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
419 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
420 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
425 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
430 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
431 if (m_config.show_sort) {
432 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
434 if (m_config.show_perpage) {
435 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
437 ranking_data += '</form>';
438 findnode(".mkwsRanking").html(ranking_data);
442 findnode('.mkwsSearchForm').submit(function() {
443 var val = findnode('.mkwsQuery').val();
448 // on first page, hide the termlist
449 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
450 var container = findnode(".mkwsMOTDContainer");
451 if (container.length) {
452 // Move the MOTD from the provided element down into the container
453 findnode(".mkwsMOTD").appendTo(container);
458 function mkwsSetLang() {
459 var lang = getParameterByName("lang") || m_config.lang;
460 if (!lang || !mkws.locale_lang[lang]) {
463 m_config.lang = lang;
466 log("Locale language: " + (m_config.lang ? m_config.lang : "none"));
467 return m_config.lang;
471 /* create locale language menu */
472 function mkwsHtmlLang() {
473 var lang_default = "en";
474 var lang = m_config.lang || lang_default;
477 /* display a list of configured languages, or all */
478 var lang_options = m_config.lang_options || [];
479 var toBeIncluded = {};
480 for (var i = 0; i < lang_options.length; i++) {
481 toBeIncluded[lang_options[i]] = true;
484 for (var k in mkws.locale_lang) {
485 if (toBeIncluded[k] || lang_options.length == 0)
490 if (lang_options.length == 0 || toBeIncluded[lang_default])
491 list.push(lang_default);
493 log("Language menu for: " + list.join(", "));
497 for(var i = 0; i < list.length; i++) {
504 data += ' <span>' + l + '</span> ';
506 data += ' <a href="?lang=' + l + '">' + l + '</a> '
510 findnode(".mkwsLang").html(data);
514 function mkwsHtmlSort() {
515 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
516 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
518 for(var i = 0; i < m_config.sort_options.length; i++) {
519 var opt = m_config.sort_options[i];
521 var val = opt.length == 1 ? opt[0] : opt[1];
523 sort_html += '<option value="' + key + '"';
524 if (m_sortOrder == key || m_sortOrder == val) {
525 sort_html += ' selected="selected"';
527 sort_html += '>' + M(val) + '</option>';
529 sort_html += '</select>';
535 function mkwsHtmlPerpage() {
536 log("HTML perpage, m_perpage = " + m_perpage);
537 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
539 for(var i = 0; i < m_config.perpage_options.length; i++) {
540 var key = m_config.perpage_options[i];
542 perpage_html += '<option value="' + key + '"';
543 if (key == m_perpage) {
544 perpage_html += ' selected="selected"';
546 perpage_html += '>' + key + '</option>';
548 perpage_html += '</select>';
554 function mkwsHtmlSwitch() {
555 log("HTML switch for team " + m_teamName);
557 var node = findnode(".mkwsSwitch");
558 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
559 node.append($("<span/>", { text: " | " }));
560 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
563 var node = findnode(".mkwsTargets");
565 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
566 No information available yet.\
568 node.css("display", "none");
572 that.runAutoSearch = function() {
573 var node = findnode('.mkwsRecords,.mkwsTermlists');
574 var query = node.attr('autosearch');
578 if (query.match(/^!param!/)) {
579 var param = query.replace(/^!param!/, '');
580 query = getParameterByName(param);
581 log("obtained query '" + query + "' from param '" + param + "'");
583 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
585 } else if (query.match(/^!path!/)) {
586 var index = query.replace(/^!path!/, '');
587 var path = window.location.pathname.split('/');
588 query = path[path.length - index];
589 log("obtained query '" + query + "' from path-component '" + index + "'");
591 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
595 log("node=" + node + ", class='" + node.className + "', query=" + query);
597 var sortOrder = node.attr('sort');
598 var targets = node.attr('targets');
599 var s = "running auto search: '" + query + "'";
600 if (sortOrder) s += " sorted by '" + sortOrder + "'";
601 if (targets) s += " in targets '" + targets + "'";
604 newSearch(query, sortOrder, targets);
608 // This function is taken from a StackOverflow answer
609 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
610 function getParameterByName(name) {
611 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
612 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
613 results = regex.exec(location.search);
614 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
618 // Translation function. At present, this is properly a
619 // global-level function (hence the assignment to mkws.M) but we
620 // want to make it per-team so different teams can operate in
621 // different languages.
624 var lang = m_config.lang;
626 if (!lang || !mkws.locale_lang[lang])
629 return mkws.locale_lang[lang][word] || word;
631 mkws.M = M; // so the Handlebars helper can use it
634 // Finds the node of the specified class within the current team
635 // Multiple OR-clauses separated by commas are handled
636 // More complex cases may not work
638 function findnode(selector, teamName) {
639 teamName = teamName || m_teamName;
641 selector = $.map(selector.split(','), function(s, i) {
642 return s + '.mkwsTeam_' + teamName;
645 var node = $(selector);
646 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
651 function renderDetails(data, marker)
653 var template = loadTemplate("Record");
654 var details = template(data);
655 return '<div class="details mkwsTeam_' + m_teamName + '" ' +
656 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
658 that.renderDetails = renderDetails;
661 function loadTemplate(name)
663 var template = m_template[name];
665 if (template === undefined) {
666 // Fall back to generic template if there is no team-specific one
667 var node = findnode(".mkwsTemplate_" + name);
669 node = findnode(".mkwsTemplate_" + name, "ALL");
672 var source = node.html();
674 source = defaultTemplate(name);
677 template = Handlebars.compile(source);
678 log("compiled template '" + name + "'");
679 m_template[name] = template;
684 that.loadTemplate = loadTemplate;
687 function defaultTemplate(name)
689 if (name === 'Record') {
693 <th>{{translate "Title"}}</th>\
696 {{#if md-title-remainder}}\
697 ({{md-title-remainder}})\
699 {{#if md-title-responsibility}}\
700 <i>{{md-title-responsibility}}</i>\
706 <th>{{translate "Date"}}</th>\
707 <td>{{md-date}}</td>\
712 <th>{{translate "Author"}}</th>\
713 <td>{{md-author}}</td>\
716 {{#if md-electronic-url}}\
718 <th>{{translate "Links"}}</th>\
720 {{#each md-electronic-url}}\
721 <a href="{{this}}">Link{{index1}}</a>\
726 {{#if-any location having="md-subject"}}\
728 <th>{{translate "Subject"}}</th>\
730 {{#first location having="md-subject"}}\
732 {{#commaList md-subject}}\
733 {{this}}{{/commaList}}\
740 <th>{{translate "Locations"}}</th>\
742 {{#commaList location}}\
743 {{attr "@name"}}{{/commaList}}\
748 } else if (name === "Summary") {
750 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
753 {{#if md-title-remainder}}\
754 <span>{{md-title-remainder}}</span>\
756 {{#if md-title-responsibility}}\
757 <span><i>{{md-title-responsibility}}</i></span>\
762 var s = "There is no default '" + name +"' template!";