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(',')
80 // pz2.js event handlers:
89 function onBytarget(data) {
91 queue("targets").publish(data);
95 function onStat(data) {
97 queue("stat").publish(data);
101 function onTerm(data) {
103 queue("termlists").publish(data);
107 function onShow(data, teamName) {
109 m_totalRecordCount = data.merged;
110 queue("pager").publish(data);
111 queue("records").publish(data);
115 function onRecord(data, args, teamName) {
117 // FIXME: record is async!!
118 clearTimeout(m_paz.recordTimer);
119 // ##### restrict to current team
120 var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
122 // in case on_show was faster to redraw element
125 m_currentRecordData = data;
126 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
127 var html = renderDetails(m_currentRecordData);
128 $(recordDiv).append(html);
132 // Used by promoteRecords() and onRecord()
133 function recordElementId(s) {
134 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
136 that.recordElementId = recordElementId;
138 // Used by onRecord(), showDetails() and renderDetails()
139 function recordDetailsId(s) {
140 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
142 that.recordElementId = recordElementId;
145 that.targetFiltered = function(id) {
146 for (var i = 0; i < m_filters.length; i++) {
147 if (m_filters[i].id === id ||
148 m_filters[i].id === 'pz:id=' + id) {
156 that.limitTarget = function (id, name)
158 log("limitTarget(id=" + id + ", name=" + name + ")");
159 m_filters.push({ id: id, name: name });
165 that.limitQuery = function (field, value)
167 log("limitQuery(field=" + field + ", value=" + value + ")");
168 m_filters.push({ field: field, value: value });
174 that.delimitTarget = function (id)
176 log("delimitTarget(id=" + id + ")");
178 for (var i in m_filters) {
179 var filter = m_filters[i];
181 log("delimitTarget() removing filter " + $.toJSON(filter));
183 log("delimitTarget() keeping filter " + $.toJSON(filter));
184 newFilters.push(filter);
187 m_filters = newFilters;
194 that.delimitQuery = function (field, value)
196 log("delimitQuery(field=" + field + ", value=" + value + ")");
198 for (var i in m_filters) {
199 var filter = m_filters[i];
201 field == filter.field &&
202 value == filter.value) {
203 log("delimitQuery() removing filter " + $.toJSON(filter));
205 log("delimitQuery() keeping filter " + $.toJSON(filter));
206 newFilters.push(filter);
209 m_filters = newFilters;
216 that.showPage = function (pageNum)
218 m_currentPage = pageNum;
219 m_paz.showPage(m_currentPage - 1);
223 that.pagerNext = function () {
224 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
231 that.pagerPrev = function () {
232 if (m_paz.showPrev() != false)
237 that.reShow = function() {
238 m_paz.show(0, m_perpage, m_sortOrder);
245 m_totalRecordCount = 0;
247 that.resetPage = resetPage;
250 function newSearch(query, sortOrder, targets)
252 log("newSearch: " + query);
254 if (mkws_config.use_service_proxy && !mkws.authenticated) {
255 alert("searching before authentication");
260 triggerSearch(query, sortOrder, targets);
261 switchView('records'); // In case it's configured to start off as hidden
266 function triggerSearch (query, sortOrder, targets)
269 queue("navi").publish();
274 // Continue to use previous query/sort-order unless new ones are specified
279 m_sortOrder = sortOrder;
282 m_filters.push({ id: targets, name: targets });
285 for (var i in m_filters) {
286 var filter = m_filters[i];
290 if (filter.id.match(/^[a-z:]+[=~]/)) {
291 log("filter '" + filter.id + "' already begins with SETTING OP");
293 filter.id = 'pz:id=' + filter.id;
295 pp2filter += filter.id;
299 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
305 params.limit = pp2limit;
308 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
310 // We can use: params.torusquery = "udb=NAME"
311 // Note: that won't work when running against raw pazpar2
312 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
316 // switching view between targets and records
317 function switchView(view) {
318 var targets = findnode('.mkwsTargets');
319 var results = findnode('.mkwsResults,.mkwsRecords');
320 var blanket = findnode('.mkwsBlanket');
321 var motd = findnode('.mkwsMOTD');
325 if (targets) targets.css('display', 'block');
326 if (results) results.css('display', 'none');
327 if (blanket) blanket.css('display', 'none');
328 if (motd) motd.css('display', 'none');
331 if (targets) targets.css('display', 'none');
332 if (results) results.css('display', 'block');
333 if (blanket) blanket.css('display', 'block');
334 if (motd) motd.css('display', 'none');
337 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
338 if (targets) targets.css('display', 'none');
339 if (results) results.css('display', 'none');
340 if (blanket) blanket.css('display', 'none');
341 if (motd) motd.css('display', 'none');
344 alert("Unknown view '" + view + "'");
347 that.switchView = switchView;
350 // detailed record drawing
351 that.showDetails = function (recId) {
352 var oldRecordId = m_currentRecordId;
353 m_currentRecordId = recId;
355 // remove current detailed view if any
356 // ##### restrict to current team
357 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
360 detRecordDiv.parentNode.removeChild(detRecordDiv);
362 // if the same clicked, just hide
363 if (recId == oldRecordId) {
364 m_currentRecordId = '';
365 m_currentRecordData = null;
368 // request the record
369 log("showDetails() requesting record '" + recId + "'");
375 * All the HTML stuff to render the search forms and
378 function mkwsHtmlAll() {
380 if (mkws_config.show_lang)
383 log("HTML search form");
384 findnode('.mkwsSearch').html('\
385 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
386 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
387 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
391 // If the team has a .mkwsResults, populate it in the usual
392 // way. If not, assume that it's a smarter application that
393 // defines its own subcomponents, some or all of the
400 findnode(".mkwsResults").html('\
401 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
403 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
404 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
406 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
407 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
408 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
409 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
410 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
415 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
420 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
421 if (mkws_config.show_sort) {
422 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
424 if (mkws_config.show_perpage) {
425 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
427 ranking_data += '</form>';
428 findnode(".mkwsRanking").html(ranking_data);
432 findnode('.mkwsSearchForm').submit(function() {
433 var val = findnode('.mkwsQuery').val();
438 // on first page, hide the termlist
439 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
440 var container = findnode(".mkwsMOTDContainer");
441 if (container.length) {
442 // Move the MOTD from the provided element down into the container
443 findnode(".mkwsMOTD").appendTo(container);
448 function mkwsSetLang() {
449 var lang = getParameterByName("lang") || mkws_config.lang;
450 if (!lang || !mkws.locale_lang[lang]) {
451 mkws_config.lang = ""
453 mkws_config.lang = lang;
456 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
457 return mkws_config.lang;
461 /* create locale language menu */
462 function mkwsHtmlLang() {
463 var lang_default = "en";
464 var lang = mkws_config.lang || lang_default;
467 /* display a list of configured languages, or all */
468 var lang_options = mkws_config.lang_options || [];
469 var toBeIncluded = {};
470 for (var i = 0; i < lang_options.length; i++) {
471 toBeIncluded[lang_options[i]] = true;
474 for (var k in mkws.locale_lang) {
475 if (toBeIncluded[k] || lang_options.length == 0)
480 if (lang_options.length == 0 || toBeIncluded[lang_default])
481 list.push(lang_default);
483 log("Language menu for: " + list.join(", "));
487 for(var i = 0; i < list.length; i++) {
494 data += ' <span>' + l + '</span> ';
496 data += ' <a href="?lang=' + l + '">' + l + '</a> '
500 findnode(".mkwsLang").html(data);
504 function mkwsHtmlSort() {
505 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
506 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
508 for(var i = 0; i < mkws_config.sort_options.length; i++) {
509 var opt = mkws_config.sort_options[i];
511 var val = opt.length == 1 ? opt[0] : opt[1];
513 sort_html += '<option value="' + key + '"';
514 if (m_sortOrder == key || m_sortOrder == val) {
515 sort_html += ' selected="selected"';
517 sort_html += '>' + M(val) + '</option>';
519 sort_html += '</select>';
525 function mkwsHtmlPerpage() {
526 log("HTML perpage, m_perpage = " + m_perpage);
527 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
529 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
530 var key = mkws_config.perpage_options[i];
532 perpage_html += '<option value="' + key + '"';
533 if (key == m_perpage) {
534 perpage_html += ' selected="selected"';
536 perpage_html += '>' + key + '</option>';
538 perpage_html += '</select>';
544 function mkwsHtmlSwitch() {
545 log("HTML switch for team " + m_teamName);
547 var node = findnode(".mkwsSwitch");
548 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
549 node.append($("<span/>", { text: " | " }));
550 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
553 var node = findnode(".mkwsTargets");
555 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
556 No information available yet.\
558 node.css("display", "none");
562 that.runAutoSearch = function() {
563 var node = findnode('.mkwsRecords,.mkwsTermlists');
564 var query = node.attr('autosearch');
568 if (query.match(/^!param!/)) {
569 var param = query.replace(/^!param!/, '');
570 query = getParameterByName(param);
571 log("obtained query '" + query + "' from param '" + param + "'");
573 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
575 } else if (query.match(/^!path!/)) {
576 var index = query.replace(/^!path!/, '');
577 var path = window.location.pathname.split('/');
578 query = path[path.length - index];
579 log("obtained query '" + query + "' from path-component '" + index + "'");
581 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
585 log("node=" + node + ", class='" + node.className + "', query=" + query);
587 var sortOrder = node.attr('sort');
588 var targets = node.attr('targets');
589 var s = "running auto search: '" + query + "'";
590 if (sortOrder) s += " sorted by '" + sortOrder + "'";
591 if (targets) s += " in targets '" + targets + "'";
594 newSearch(query, sortOrder, targets);
598 // This function is taken from a StackOverflow answer
599 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
600 function getParameterByName(name) {
601 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
602 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
603 results = regex.exec(location.search);
604 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
608 // Translation function. At present, this is properly a
609 // global-level function (hence the assignment to mkws.M) but we
610 // want to make it per-team so different teams can operate in
611 // different languages.
614 var lang = mkws_config.lang;
616 if (!lang || !mkws.locale_lang[lang])
619 return mkws.locale_lang[lang][word] || word;
621 mkws.M = M; // so the Handlebars helper can use it
624 // Finds the node of the specified class within the current team
625 // Multiple OR-clauses separated by commas are handled
626 // More complex cases may not work
628 function findnode(selector, teamName) {
629 teamName = teamName || m_teamName;
631 selector = $.map(selector.split(','), function(s, i) {
632 return s + '.mkwsTeam_' + teamName;
639 function renderDetails(data, marker)
641 var template = loadTemplate("Record");
642 var details = template(data);
643 return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
645 that.renderDetails = renderDetails;
648 function loadTemplate(name)
650 var template = m_template[name];
652 if (template === undefined) {
653 // Fall back to generic template if there is no team-specific one
654 var node = findnode(".mkwsTemplate_" + name);
656 node = findnode(".mkwsTemplate_" + name, "ALL");
659 var source = node.html();
661 source = defaultTemplate(name);
664 template = Handlebars.compile(source);
665 log("compiled template '" + name + "'");
666 m_template[name] = template;
671 that.loadTemplate = loadTemplate;
674 function defaultTemplate(name)
676 if (name === 'Record') {
680 <th>{{translate "Title"}}</th>\
683 {{#if md-title-remainder}}\
684 ({{md-title-remainder}})\
686 {{#if md-title-responsibility}}\
687 <i>{{md-title-responsibility}}</i>\
693 <th>{{translate "Date"}}</th>\
694 <td>{{md-date}}</td>\
699 <th>{{translate "Author"}}</th>\
700 <td>{{md-author}}</td>\
703 {{#if md-electronic-url}}\
705 <th>{{translate "Links"}}</th>\
707 {{#each md-electronic-url}}\
708 <a href="{{this}}">Link{{index1}}</a>\
713 {{#if-any location having="md-subject"}}\
715 <th>{{translate "Subject"}}</th>\
717 {{#first location having="md-subject"}}\
719 {{#commaList md-subject}}\
720 {{this}}{{/commaList}}\
727 <th>{{translate "Locations"}}</th>\
729 {{#commaList location}}\
730 {{attr "@name"}}{{/commaList}}\
735 } else if (name === "Summary") {
737 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
740 {{#if md-title-remainder}}\
741 <span>{{md-title-remainder}}</span>\
743 {{#if md-title-responsibility}}\
744 <span><i>{{md-title-responsibility}}</i></span>\
749 var s = "There is no default '" + name +"' template!";
755 // The following PubSub code is modified from the jQuery manual:
756 // https://api.jquery.com/jQuery.Callbacks/
759 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
760 // team.queue("eventName").publish(arg1, arg2, ...);
763 var queue = function(id) {
765 var callbacks = $.Callbacks();
767 publish: callbacks.fire,
768 subscribe: callbacks.add,
769 unsubscribe: callbacks.remove
784 mkws_config.error = e.message;
789 // Bizarrely, 'that' is just an empty hash. All its state is in
790 // the closure variables defined earlier in this function.