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
32 // Accessor methods for individual widgets: readers
33 that.name = function() { return m_teamName; }
34 that.submitted = function() { return m_submitted; }
35 that.perpage = function() { return m_perpage; }
36 that.totalRecordCount = function() { return m_totalRecordCount; }
37 that.currentPage = function() { return m_currentPage; }
38 that.currentRecordId = function() { return m_currentRecordId; }
39 that.currentRecordData = function() { return m_currentRecordData; }
40 that.filters = function() { return m_filters; }
42 // Accessor methods for individual widgets: writers
43 that.set_sortOrder = function(val) { m_sortOrder = val };
44 that.set_perpage = function(val) { m_perpage = val };
49 var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
52 mkws.log(m_teamName + ": " + timestamp + s);
56 log("start running MKWS");
58 m_sortOrder = mkws_config.sort_default;
59 m_perpage = mkws_config.perpage_default;
61 log("Create main pz2 object");
62 // create a parameters array and pass it to the pz2's constructor
63 // then register the form submit event with the pz2.search function
64 // autoInit is set to true on default
65 m_paz = new pz2({ "windowid": teamName,
66 "pazpar2path": mkws_config.pazpar2_url,
67 "usesessions" : mkws_config.use_service_proxy ? false : true,
69 "onbytarget": onBytarget,
71 "onterm": (mkws_config.facets.length ? onTerm : undefined),
74 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
75 "termlist": mkws_config.facets.join(',')
79 // pz2.js event handlers:
86 function onBytarget(data) {
88 queue("targets").publish(data);
91 function onStat(data) {
93 queue("stat").publish(data);
96 function onTerm(data) {
98 queue("termlists").publish(data);
101 function onShow(data, teamName) {
103 m_totalRecordCount = data.merged;
104 queue("pager").publish(data);
105 queue("records").publish(data);
108 function onRecord(data, args, teamName) {
110 // FIXME: record is async!!
111 clearTimeout(m_paz.recordTimer);
112 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
113 if (detRecordDiv.length) {
114 // in case on_show was faster to redraw element
117 m_currentRecordData = data;
118 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
119 var html = renderDetails(m_currentRecordData);
120 $(recordDiv).append(html);
124 // Used by promoteRecords() and onRecord()
125 function recordElementId(s) {
126 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
128 that.recordElementId = recordElementId;
130 // Used by onRecord(), showDetails() and renderDetails()
131 function recordDetailsId(s) {
132 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
134 that.recordElementId = recordElementId;
137 that.targetFiltered = function(id) {
138 for (var i = 0; i < m_filters.length; i++) {
139 if (m_filters[i].id === id ||
140 m_filters[i].id === 'pz:id=' + id) {
148 that.limitTarget = function (id, name)
150 log("limitTarget(id=" + id + ", name=" + name + ")");
151 m_filters.push({ id: id, name: name });
157 that.limitQuery = function (field, value)
159 log("limitQuery(field=" + field + ", value=" + value + ")");
160 m_filters.push({ field: field, value: value });
166 that.delimitTarget = function (id)
168 log("delimitTarget(id=" + id + ")");
170 for (var i in m_filters) {
171 var filter = m_filters[i];
173 log("delimitTarget() removing filter " + $.toJSON(filter));
175 log("delimitTarget() keeping filter " + $.toJSON(filter));
176 newFilters.push(filter);
179 m_filters = newFilters;
186 that.delimitQuery = function (field, value)
188 log("delimitQuery(field=" + field + ", value=" + value + ")");
190 for (var i in m_filters) {
191 var filter = m_filters[i];
193 field == filter.field &&
194 value == filter.value) {
195 log("delimitQuery() removing filter " + $.toJSON(filter));
197 log("delimitQuery() keeping filter " + $.toJSON(filter));
198 newFilters.push(filter);
201 m_filters = newFilters;
208 that.showPage = function (pageNum)
210 m_currentPage = pageNum;
211 m_paz.showPage(m_currentPage - 1);
215 that.pagerNext = function () {
216 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
223 that.pagerPrev = function () {
224 if (m_paz.showPrev() != false)
229 that.reShow = function() {
230 m_paz.show(0, m_perpage, m_sortOrder);
237 m_totalRecordCount = 0;
239 that.resetPage = resetPage;
242 function newSearch(query, sortOrder, targets)
244 log("newSearch: " + query);
246 if (mkws_config.use_service_proxy && !mkws.authenticated) {
247 alert("searching before authentication");
252 triggerSearch(query, sortOrder, targets);
253 switchView('records'); // In case it's configured to start off as hidden
258 function triggerSearch (query, sortOrder, targets)
261 queue("navi").publish();
266 // Continue to use previous query/sort-order unless new ones are specified
271 m_sortOrder = sortOrder;
274 m_filters.push({ id: targets, name: targets });
277 for (var i in m_filters) {
278 var filter = m_filters[i];
282 if (filter.id.match(/^[a-z:]+[=~]/)) {
283 log("filter '" + filter.id + "' already begins with SETTING OP");
285 filter.id = 'pz:id=' + filter.id;
287 pp2filter += filter.id;
291 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
297 params.limit = pp2limit;
300 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
302 // We can use: params.torusquery = "udb=NAME"
303 // Note: that won't work when running against raw pazpar2
304 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
308 // switching view between targets and records
309 function switchView(view) {
310 var targets = findnode('.mkwsTargets');
311 var results = findnode('.mkwsResults,.mkwsRecords');
312 var blanket = findnode('.mkwsBlanket');
313 var motd = findnode('.mkwsMOTD');
317 if (targets) targets.css('display', 'block');
318 if (results) results.css('display', 'none');
319 if (blanket) blanket.css('display', 'none');
320 if (motd) motd.css('display', 'none');
323 if (targets) targets.css('display', 'none');
324 if (results) results.css('display', 'block');
325 if (blanket) blanket.css('display', 'block');
326 if (motd) motd.css('display', 'none');
329 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
330 if (targets) targets.css('display', 'none');
331 if (results) results.css('display', 'none');
332 if (blanket) blanket.css('display', 'none');
333 if (motd) motd.css('display', 'none');
336 alert("Unknown view '" + view + "'");
339 that.switchView = switchView;
342 // detailed record drawing
343 that.showDetails = function (recId) {
344 var oldRecordId = m_currentRecordId;
345 m_currentRecordId = recId;
347 // remove current detailed view if any
348 // ##### restrict to current team
349 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
352 detRecordDiv.parentNode.removeChild(detRecordDiv);
354 // if the same clicked, just hide
355 if (recId == oldRecordId) {
356 m_currentRecordId = '';
357 m_currentRecordData = null;
360 // request the record
361 log("showDetails() requesting record '" + recId + "'");
367 * All the HTML stuff to render the search forms and
370 function mkwsHtmlAll() {
372 if (mkws_config.show_lang)
375 log("HTML search form");
376 findnode('.mkwsSearch').html('\
377 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
378 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
379 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
383 // If the team has a .mkwsResults, populate it in the usual
384 // way. If not, assume that it's a smarter application that
385 // defines its own subcomponents, some or all of the
392 findnode(".mkwsResults").html('\
393 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
395 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
396 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
398 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
399 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
400 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
401 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
402 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
407 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
412 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
413 if (mkws_config.show_sort) {
414 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
416 if (mkws_config.show_perpage) {
417 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
419 ranking_data += '</form>';
420 findnode(".mkwsRanking").html(ranking_data);
424 findnode('.mkwsSearchForm').submit(function() {
425 var val = findnode('.mkwsQuery').val();
430 // on first page, hide the termlist
431 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
432 var container = findnode(".mkwsMOTDContainer");
433 if (container.length) {
434 // Move the MOTD from the provided element down into the container
435 findnode(".mkwsMOTD").appendTo(container);
440 function mkwsSetLang() {
441 var lang = getParameterByName("lang") || mkws_config.lang;
442 if (!lang || !mkws.locale_lang[lang]) {
443 mkws_config.lang = ""
445 mkws_config.lang = lang;
448 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
449 return mkws_config.lang;
453 /* create locale language menu */
454 function mkwsHtmlLang() {
455 var lang_default = "en";
456 var lang = mkws_config.lang || lang_default;
459 /* display a list of configured languages, or all */
460 var lang_options = mkws_config.lang_options || [];
461 var toBeIncluded = {};
462 for (var i = 0; i < lang_options.length; i++) {
463 toBeIncluded[lang_options[i]] = true;
466 for (var k in mkws.locale_lang) {
467 if (toBeIncluded[k] || lang_options.length == 0)
472 if (lang_options.length == 0 || toBeIncluded[lang_default])
473 list.push(lang_default);
475 log("Language menu for: " + list.join(", "));
479 for(var i = 0; i < list.length; i++) {
486 data += ' <span>' + l + '</span> ';
488 data += ' <a href="?lang=' + l + '">' + l + '</a> '
492 findnode(".mkwsLang").html(data);
496 function mkwsHtmlSort() {
497 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
498 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
500 for(var i = 0; i < mkws_config.sort_options.length; i++) {
501 var opt = mkws_config.sort_options[i];
503 var val = opt.length == 1 ? opt[0] : opt[1];
505 sort_html += '<option value="' + key + '"';
506 if (m_sortOrder == key || m_sortOrder == val) {
507 sort_html += ' selected="selected"';
509 sort_html += '>' + M(val) + '</option>';
511 sort_html += '</select>';
517 function mkwsHtmlPerpage() {
518 log("HTML perpage, m_perpage = " + m_perpage);
519 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
521 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
522 var key = mkws_config.perpage_options[i];
524 perpage_html += '<option value="' + key + '"';
525 if (key == m_perpage) {
526 perpage_html += ' selected="selected"';
528 perpage_html += '>' + key + '</option>';
530 perpage_html += '</select>';
536 function mkwsHtmlSwitch() {
537 log("HTML switch for team " + m_teamName);
539 var node = findnode(".mkwsSwitch");
540 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
541 node.append($("<span/>", { text: " | " }));
542 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
545 var node = findnode(".mkwsTargets");
547 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
548 No information available yet.\
550 node.css("display", "none");
554 that.runAutoSearch = function() {
555 var node = findnode('.mkwsRecords,.mkwsTermlists');
556 var query = node.attr('autosearch');
560 if (query.match(/^!param!/)) {
561 var param = query.replace(/^!param!/, '');
562 query = getParameterByName(param);
563 log("obtained query '" + query + "' from param '" + param + "'");
565 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
567 } else if (query.match(/^!path!/)) {
568 var index = query.replace(/^!path!/, '');
569 var path = window.location.pathname.split('/');
570 query = path[path.length - index];
571 log("obtained query '" + query + "' from path-component '" + index + "'");
573 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
577 log("node=" + node + ", class='" + node.className + "', query=" + query);
579 var sortOrder = node.attr('sort');
580 var targets = node.attr('targets');
581 var s = "running auto search: '" + query + "'";
582 if (sortOrder) s += " sorted by '" + sortOrder + "'";
583 if (targets) s += " in targets '" + targets + "'";
586 newSearch(query, sortOrder, targets);
590 // This function is taken from a StackOverflow answer
591 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
592 function getParameterByName(name) {
593 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
594 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
595 results = regex.exec(location.search);
596 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
600 // Translation function. At present, this is properly a
601 // global-level function (hence the assignment to mkws.M) but we
602 // want to make it per-team so different teams can operate in
603 // different languages.
606 var lang = mkws_config.lang;
608 if (!lang || !mkws.locale_lang[lang])
611 return mkws.locale_lang[lang][word] || word;
613 mkws.M = M; // so the Handlebars helper can use it
616 // Finds the node of the specified class within the current team
617 // Multiple OR-clauses separated by commas are handled
618 // More complex cases may not work
620 function findnode(selector, teamName) {
621 teamName = teamName || m_teamName;
623 selector = $.map(selector.split(','), function(s, i) {
624 return s + '.mkwsTeam_' + teamName;
627 var node = $(selector);
628 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
633 function renderDetails(data, marker)
635 var template = loadTemplate("Record");
636 var details = template(data);
637 return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
639 that.renderDetails = renderDetails;
642 function loadTemplate(name)
644 var template = m_template[name];
646 if (template === undefined) {
647 // Fall back to generic template if there is no team-specific one
648 var node = findnode(".mkwsTemplate_" + name);
650 node = findnode(".mkwsTemplate_" + name, "ALL");
653 var source = node.html();
655 source = defaultTemplate(name);
658 template = Handlebars.compile(source);
659 log("compiled template '" + name + "'");
660 m_template[name] = template;
665 that.loadTemplate = loadTemplate;
668 function defaultTemplate(name)
670 if (name === 'Record') {
674 <th>{{translate "Title"}}</th>\
677 {{#if md-title-remainder}}\
678 ({{md-title-remainder}})\
680 {{#if md-title-responsibility}}\
681 <i>{{md-title-responsibility}}</i>\
687 <th>{{translate "Date"}}</th>\
688 <td>{{md-date}}</td>\
693 <th>{{translate "Author"}}</th>\
694 <td>{{md-author}}</td>\
697 {{#if md-electronic-url}}\
699 <th>{{translate "Links"}}</th>\
701 {{#each md-electronic-url}}\
702 <a href="{{this}}">Link{{index1}}</a>\
707 {{#if-any location having="md-subject"}}\
709 <th>{{translate "Subject"}}</th>\
711 {{#first location having="md-subject"}}\
713 {{#commaList md-subject}}\
714 {{this}}{{/commaList}}\
721 <th>{{translate "Locations"}}</th>\
723 {{#commaList location}}\
724 {{attr "@name"}}{{/commaList}}\
729 } else if (name === "Summary") {
731 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
734 {{#if md-title-remainder}}\
735 <span>{{md-title-remainder}}</span>\
737 {{#if md-title-responsibility}}\
738 <span><i>{{md-title-responsibility}}</i></span>\
743 var s = "There is no default '" + name +"' template!";
749 // The following PubSub code is modified from the jQuery manual:
750 // https://api.jquery.com/jQuery.Callbacks/
753 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
754 // team.queue("eventName").publish(arg1, arg2, ...);
757 var queue = function(id) {
759 var callbacks = $.Callbacks();
761 publish: callbacks.fire,
762 subscribe: callbacks.add,
763 unsubscribe: callbacks.remove