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
31 that.toString = function() { return '[Team ' + teamName + ']'; }
33 // Accessor methods for individual widgets: readers
34 that.name = function() { return m_teamName; }
35 that.submitted = function() { return m_submitted; }
36 that.perpage = function() { return m_perpage; }
37 that.totalRecordCount = function() { return m_totalRecordCount; }
38 that.currentPage = function() { return m_currentPage; }
39 that.currentRecordId = function() { return m_currentRecordId; }
40 that.currentRecordData = function() { return m_currentRecordData; }
41 that.filters = function() { return m_filters; }
43 // Accessor methods for individual widgets: writers
44 that.set_sortOrder = function(val) { m_sortOrder = val };
45 that.set_perpage = function(val) { m_perpage = val };
50 var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
53 mkws.log(m_teamName + ": " + timestamp + s);
57 log("start running MKWS");
59 m_sortOrder = mkws_config.sort_default;
60 m_perpage = mkws_config.perpage_default;
62 log("Create main pz2 object");
63 // create a parameters array and pass it to the pz2's constructor
64 // then register the form submit event with the pz2.search function
65 // autoInit is set to true on default
66 m_paz = new pz2({ "windowid": teamName,
67 "pazpar2path": mkws_config.pazpar2_url,
68 "usesessions" : mkws_config.use_service_proxy ? false : true,
70 "onbytarget": onBytarget,
72 "onterm": (mkws_config.facets.length ? onTerm : undefined),
75 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
76 "termlist": mkws_config.facets.join(',')
80 // pz2.js event handlers:
87 function onBytarget(data) {
89 queue("targets").publish(data);
92 function onStat(data) {
94 queue("stat").publish(data);
97 function onTerm(data) {
99 queue("termlists").publish(data);
102 function onShow(data, teamName) {
104 m_totalRecordCount = data.merged;
105 queue("pager").publish(data);
106 queue("records").publish(data);
109 function onRecord(data, args, teamName) {
111 // FIXME: record is async!!
112 clearTimeout(m_paz.recordTimer);
113 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
114 if (detRecordDiv.length) {
115 // in case on_show was faster to redraw element
118 m_currentRecordData = data;
119 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
120 var html = renderDetails(m_currentRecordData);
121 $(recordDiv).append(html);
125 // Used by the Records widget and onRecord()
126 function recordElementId(s) {
127 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
129 that.recordElementId = recordElementId;
131 // Used by onRecord(), showDetails() and renderDetails()
132 function recordDetailsId(s) {
133 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
135 that.recordElementId = recordElementId;
138 that.targetFiltered = function(id) {
139 for (var i = 0; i < m_filters.length; i++) {
140 if (m_filters[i].id === id ||
141 m_filters[i].id === 'pz:id=' + id) {
149 that.limitTarget = function (id, name)
151 log("limitTarget(id=" + id + ", name=" + name + ")");
152 m_filters.push({ id: id, name: name });
158 that.limitQuery = function (field, value)
160 log("limitQuery(field=" + field + ", value=" + value + ")");
161 m_filters.push({ field: field, value: value });
167 that.delimitTarget = function (id)
169 log("delimitTarget(id=" + id + ")");
171 for (var i in m_filters) {
172 var filter = m_filters[i];
174 log("delimitTarget() removing filter " + $.toJSON(filter));
176 log("delimitTarget() keeping filter " + $.toJSON(filter));
177 newFilters.push(filter);
180 m_filters = newFilters;
187 that.delimitQuery = function (field, value)
189 log("delimitQuery(field=" + field + ", value=" + value + ")");
191 for (var i in m_filters) {
192 var filter = m_filters[i];
194 field == filter.field &&
195 value == filter.value) {
196 log("delimitQuery() removing filter " + $.toJSON(filter));
198 log("delimitQuery() keeping filter " + $.toJSON(filter));
199 newFilters.push(filter);
202 m_filters = newFilters;
209 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() {
231 m_paz.show(0, m_perpage, m_sortOrder);
238 m_totalRecordCount = 0;
240 that.resetPage = resetPage;
243 function newSearch(query, sortOrder, targets)
245 log("newSearch: " + query);
247 if (mkws_config.use_service_proxy && !mkws.authenticated) {
248 alert("searching before authentication");
253 triggerSearch(query, sortOrder, targets);
254 switchView('records'); // In case it's configured to start off as hidden
259 function triggerSearch (query, sortOrder, targets)
262 queue("navi").publish();
267 // Continue to use previous query/sort-order unless new ones are specified
272 m_sortOrder = sortOrder;
275 m_filters.push({ id: targets, name: targets });
278 for (var i in m_filters) {
279 var filter = m_filters[i];
283 if (filter.id.match(/^[a-z:]+[=~]/)) {
284 log("filter '" + filter.id + "' already begins with SETTING OP");
286 filter.id = 'pz:id=' + filter.id;
288 pp2filter += filter.id;
292 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
298 params.limit = pp2limit;
301 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
303 // We can use: params.torusquery = "udb=NAME"
304 // Note: that won't work when running against raw pazpar2
305 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
309 // switching view between targets and records
310 function switchView(view) {
311 var targets = findnode('.mkwsTargets');
312 var results = findnode('.mkwsResults,.mkwsRecords');
313 var blanket = findnode('.mkwsBlanket');
314 var motd = findnode('.mkwsMOTD');
318 if (targets) targets.css('display', 'block');
319 if (results) results.css('display', 'none');
320 if (blanket) blanket.css('display', 'none');
321 if (motd) motd.css('display', 'none');
324 if (targets) targets.css('display', 'none');
325 if (results) results.css('display', 'block');
326 if (blanket) blanket.css('display', 'block');
327 if (motd) motd.css('display', 'none');
330 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
331 if (targets) targets.css('display', 'none');
332 if (results) results.css('display', 'none');
333 if (blanket) blanket.css('display', 'none');
334 if (motd) motd.css('display', 'none');
337 alert("Unknown view '" + view + "'");
340 that.switchView = switchView;
343 // detailed record drawing
344 that.showDetails = function (recId) {
345 var oldRecordId = m_currentRecordId;
346 m_currentRecordId = recId;
348 // remove current detailed view if any
349 // ##### restrict to current team
350 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
353 detRecordDiv.parentNode.removeChild(detRecordDiv);
355 // if the same clicked, just hide
356 if (recId == oldRecordId) {
357 m_currentRecordId = '';
358 m_currentRecordData = null;
361 // request the record
362 log("showDetails() requesting record '" + recId + "'");
368 * All the HTML stuff to render the search forms and
371 function mkwsHtmlAll() {
373 if (mkws_config.show_lang)
376 log("HTML search form");
377 findnode('.mkwsSearch').html('\
378 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
379 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
380 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
384 // If the team has a .mkwsResults, populate it in the usual
385 // way. If not, assume that it's a smarter application that
386 // defines its own subcomponents, some or all of the
393 findnode(".mkwsResults").html('\
394 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
396 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
397 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
399 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
400 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
401 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
402 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
403 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
408 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
413 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
414 if (mkws_config.show_sort) {
415 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
417 if (mkws_config.show_perpage) {
418 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
420 ranking_data += '</form>';
421 findnode(".mkwsRanking").html(ranking_data);
425 findnode('.mkwsSearchForm').submit(function() {
426 var val = findnode('.mkwsQuery').val();
431 // on first page, hide the termlist
432 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
433 var container = findnode(".mkwsMOTDContainer");
434 if (container.length) {
435 // Move the MOTD from the provided element down into the container
436 findnode(".mkwsMOTD").appendTo(container);
441 function mkwsSetLang() {
442 var lang = getParameterByName("lang") || mkws_config.lang;
443 if (!lang || !mkws.locale_lang[lang]) {
444 mkws_config.lang = ""
446 mkws_config.lang = lang;
449 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
450 return mkws_config.lang;
454 /* create locale language menu */
455 function mkwsHtmlLang() {
456 var lang_default = "en";
457 var lang = mkws_config.lang || lang_default;
460 /* display a list of configured languages, or all */
461 var lang_options = mkws_config.lang_options || [];
462 var toBeIncluded = {};
463 for (var i = 0; i < lang_options.length; i++) {
464 toBeIncluded[lang_options[i]] = true;
467 for (var k in mkws.locale_lang) {
468 if (toBeIncluded[k] || lang_options.length == 0)
473 if (lang_options.length == 0 || toBeIncluded[lang_default])
474 list.push(lang_default);
476 log("Language menu for: " + list.join(", "));
480 for(var i = 0; i < list.length; i++) {
487 data += ' <span>' + l + '</span> ';
489 data += ' <a href="?lang=' + l + '">' + l + '</a> '
493 findnode(".mkwsLang").html(data);
497 function mkwsHtmlSort() {
498 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
499 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
501 for(var i = 0; i < mkws_config.sort_options.length; i++) {
502 var opt = mkws_config.sort_options[i];
504 var val = opt.length == 1 ? opt[0] : opt[1];
506 sort_html += '<option value="' + key + '"';
507 if (m_sortOrder == key || m_sortOrder == val) {
508 sort_html += ' selected="selected"';
510 sort_html += '>' + M(val) + '</option>';
512 sort_html += '</select>';
518 function mkwsHtmlPerpage() {
519 log("HTML perpage, m_perpage = " + m_perpage);
520 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
522 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
523 var key = mkws_config.perpage_options[i];
525 perpage_html += '<option value="' + key + '"';
526 if (key == m_perpage) {
527 perpage_html += ' selected="selected"';
529 perpage_html += '>' + key + '</option>';
531 perpage_html += '</select>';
537 function mkwsHtmlSwitch() {
538 log("HTML switch for team " + m_teamName);
540 var node = findnode(".mkwsSwitch");
541 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
542 node.append($("<span/>", { text: " | " }));
543 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
546 var node = findnode(".mkwsTargets");
548 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
549 No information available yet.\
551 node.css("display", "none");
555 that.runAutoSearch = function() {
556 var node = findnode('.mkwsRecords,.mkwsTermlists');
557 var query = node.attr('autosearch');
561 if (query.match(/^!param!/)) {
562 var param = query.replace(/^!param!/, '');
563 query = getParameterByName(param);
564 log("obtained query '" + query + "' from param '" + param + "'");
566 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
568 } else if (query.match(/^!path!/)) {
569 var index = query.replace(/^!path!/, '');
570 var path = window.location.pathname.split('/');
571 query = path[path.length - index];
572 log("obtained query '" + query + "' from path-component '" + index + "'");
574 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
578 log("node=" + node + ", class='" + node.className + "', query=" + query);
580 var sortOrder = node.attr('sort');
581 var targets = node.attr('targets');
582 var s = "running auto search: '" + query + "'";
583 if (sortOrder) s += " sorted by '" + sortOrder + "'";
584 if (targets) s += " in targets '" + targets + "'";
587 newSearch(query, sortOrder, targets);
591 // This function is taken from a StackOverflow answer
592 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
593 function getParameterByName(name) {
594 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
595 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
596 results = regex.exec(location.search);
597 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
601 // Translation function. At present, this is properly a
602 // global-level function (hence the assignment to mkws.M) but we
603 // want to make it per-team so different teams can operate in
604 // different languages.
607 var lang = mkws_config.lang;
609 if (!lang || !mkws.locale_lang[lang])
612 return mkws.locale_lang[lang][word] || word;
614 mkws.M = M; // so the Handlebars helper can use it
617 // Finds the node of the specified class within the current team
618 // Multiple OR-clauses separated by commas are handled
619 // More complex cases may not work
621 function findnode(selector, teamName) {
622 teamName = teamName || m_teamName;
624 selector = $.map(selector.split(','), function(s, i) {
625 return s + '.mkwsTeam_' + teamName;
628 var node = $(selector);
629 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
634 function renderDetails(data, marker)
636 var template = loadTemplate("Record");
637 var details = template(data);
638 return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
640 that.renderDetails = renderDetails;
643 function loadTemplate(name)
645 var template = m_template[name];
647 if (template === undefined) {
648 // Fall back to generic template if there is no team-specific one
649 var node = findnode(".mkwsTemplate_" + name);
651 node = findnode(".mkwsTemplate_" + name, "ALL");
654 var source = node.html();
656 source = defaultTemplate(name);
659 template = Handlebars.compile(source);
660 log("compiled template '" + name + "'");
661 m_template[name] = template;
666 that.loadTemplate = loadTemplate;
669 function defaultTemplate(name)
671 if (name === 'Record') {
675 <th>{{translate "Title"}}</th>\
678 {{#if md-title-remainder}}\
679 ({{md-title-remainder}})\
681 {{#if md-title-responsibility}}\
682 <i>{{md-title-responsibility}}</i>\
688 <th>{{translate "Date"}}</th>\
689 <td>{{md-date}}</td>\
694 <th>{{translate "Author"}}</th>\
695 <td>{{md-author}}</td>\
698 {{#if md-electronic-url}}\
700 <th>{{translate "Links"}}</th>\
702 {{#each md-electronic-url}}\
703 <a href="{{this}}">Link{{index1}}</a>\
708 {{#if-any location having="md-subject"}}\
710 <th>{{translate "Subject"}}</th>\
712 {{#first location having="md-subject"}}\
714 {{#commaList md-subject}}\
715 {{this}}{{/commaList}}\
722 <th>{{translate "Locations"}}</th>\
724 {{#commaList location}}\
725 {{attr "@name"}}{{/commaList}}\
730 } else if (name === "Summary") {
732 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
735 {{#if md-title-remainder}}\
736 <span>{{md-title-remainder}}</span>\
738 {{#if md-title-responsibility}}\
739 <span><i>{{md-title-responsibility}}</i></span>\
744 var s = "There is no default '" + name +"' template!";
750 // The following PubSub code is modified from the jQuery manual:
751 // https://api.jquery.com/jQuery.Callbacks/
754 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
755 // team.queue("eventName").publish(arg1, arg2, ...);
758 var queue = function(id) {
760 var callbacks = $.Callbacks();
762 publish: callbacks.fire,
763 subscribe: callbacks.add,
764 unsubscribe: callbacks.remove