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 };
47 var log = function (s) {
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 ////////////////////////////////////////////////////////////////////////////////
157 ////////////////////////////////////////////////////////////////////////////////
160 // when search button pressed
161 function onFormSubmitEventHandler()
163 var val = findnode('.mkwsQuery').val();
169 function newSearch(query, sortOrder, targets)
171 log("newSearch: " + query);
173 if (mkws_config.use_service_proxy && !mkws.authenticated) {
174 alert("searching before authentication");
179 triggerSearch(query, sortOrder, targets);
180 switchView('records'); // In case it's configured to start off as hidden
185 // limit by target functions
186 that.limitTarget = function (id, name)
188 log("limitTarget(id=" + id + ", name=" + name + ")");
189 m_filters.push({ id: id, name: name });
195 // limit the query after clicking the facet
196 that.limitQuery = function (field, value)
198 log("limitQuery(field=" + field + ", value=" + value + ")");
199 m_filters.push({ field: field, value: value });
205 that.delimitTarget = function (id)
207 log("delimitTarget(id=" + id + ")");
209 for (var i in m_filters) {
210 var filter = m_filters[i];
212 log("delimitTarget() removing filter " + $.toJSON(filter));
214 log("delimitTarget() keeping filter " + $.toJSON(filter));
215 newFilters.push(filter);
218 m_filters = newFilters;
225 that.delimitQuery = function (field, value)
227 log("delimitQuery(field=" + field + ", value=" + value + ")");
229 for (var i in m_filters) {
230 var filter = m_filters[i];
232 field == filter.field &&
233 value == filter.value) {
234 log("delimitQuery() removing filter " + $.toJSON(filter));
236 log("delimitQuery() keeping filter " + $.toJSON(filter));
237 newFilters.push(filter);
240 m_filters = newFilters;
250 m_totalRecordCount = 0;
252 that.resetPage = resetPage;
255 function triggerSearch (query, sortOrder, targets)
258 queue("navi").publish();
263 // Continue to use previous query/sort-order unless new ones are specified
268 m_sortOrder = sortOrder;
271 m_filters.push({ id: targets, name: targets });
274 for (var i in m_filters) {
275 var filter = m_filters[i];
279 if (filter.id.match(/^[a-z:]+[=~]/)) {
280 log("filter '" + filter.id + "' already begins with SETTING OP");
282 filter.id = 'pz:id=' + filter.id;
284 pp2filter += filter.id;
288 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
294 params.limit = pp2limit;
297 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
299 // We can use: params.torusquery = "udb=NAME"
300 // Note: that won't work when running against raw pazpar2
301 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
305 that.reShow = function() {
306 m_paz.show(0, m_perpage, m_sortOrder);
311 that.showPage = function (pageNum)
313 m_currentPage = pageNum;
314 m_paz.showPage(m_currentPage - 1);
318 // simple paging functions
319 that.pagerNext = function () {
320 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
327 that.pagerPrev = function () {
328 if (m_paz.showPrev() != false)
333 // switching view between targets and records
334 function switchView(view) {
335 var targets = findnode('.mkwsTargets');
336 var results = findnode('.mkwsResults,.mkwsRecords');
337 var blanket = findnode('.mkwsBlanket');
338 var motd = findnode('.mkwsMOTD');
342 if (targets) targets.css('display', 'block');
343 if (results) results.css('display', 'none');
344 if (blanket) blanket.css('display', 'none');
345 if (motd) motd.css('display', 'none');
348 if (targets) targets.css('display', 'none');
349 if (results) results.css('display', 'block');
350 if (blanket) blanket.css('display', 'block');
351 if (motd) motd.css('display', 'none');
354 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
355 if (targets) targets.css('display', 'none');
356 if (results) results.css('display', 'none');
357 if (blanket) blanket.css('display', 'none');
358 if (motd) motd.css('display', 'none');
361 alert("Unknown view '" + view + "'");
364 that.switchView = switchView;
367 // detailed record drawing
368 that.showDetails = function (recId) {
369 var oldRecordId = m_currentRecordId;
370 m_currentRecordId = recId;
372 // remove current detailed view if any
373 // ##### restrict to current team
374 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
377 detRecordDiv.parentNode.removeChild(detRecordDiv);
379 // if the same clicked, just hide
380 if (recId == oldRecordId) {
381 m_currentRecordId = '';
382 m_currentRecordData = null;
385 // request the record
386 log("showDetails() requesting record '" + recId + "'");
392 * All the HTML stuff to render the search forms and
395 function mkwsHtmlAll() {
397 if (mkws_config.show_lang)
400 log("HTML search form");
401 findnode('.mkwsSearch').html('\
402 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
403 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
404 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
408 // If the team has a .mkwsResults, populate it in the usual
409 // way. If not, assume that it's a smarter application that
410 // defines its own subcomponents, some or all of the
417 findnode(".mkwsResults").html('\
418 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
420 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
421 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
423 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
424 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
425 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
426 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
427 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
432 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
437 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
438 if (mkws_config.show_sort) {
439 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
441 if (mkws_config.show_perpage) {
442 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
444 ranking_data += '</form>';
445 findnode(".mkwsRanking").html(ranking_data);
449 findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
451 // on first page, hide the termlist
452 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
453 var container = findnode(".mkwsMOTDContainer");
454 if (container.length) {
455 // Move the MOTD from the provided element down into the container
456 findnode(".mkwsMOTD").appendTo(container);
461 function mkwsSetLang() {
462 var lang = getParameterByName("lang") || mkws_config.lang;
463 if (!lang || !mkws.locale_lang[lang]) {
464 mkws_config.lang = ""
466 mkws_config.lang = lang;
469 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
470 return mkws_config.lang;
474 /* create locale language menu */
475 function mkwsHtmlLang() {
476 var lang_default = "en";
477 var lang = mkws_config.lang || lang_default;
480 /* display a list of configured languages, or all */
481 var lang_options = mkws_config.lang_options || [];
482 var toBeIncluded = {};
483 for (var i = 0; i < lang_options.length; i++) {
484 toBeIncluded[lang_options[i]] = true;
487 for (var k in mkws.locale_lang) {
488 if (toBeIncluded[k] || lang_options.length == 0)
493 if (lang_options.length == 0 || toBeIncluded[lang_default])
494 list.push(lang_default);
496 log("Language menu for: " + list.join(", "));
500 for(var i = 0; i < list.length; i++) {
507 data += ' <span>' + l + '</span> ';
509 data += ' <a href="?lang=' + l + '">' + l + '</a> '
513 findnode(".mkwsLang").html(data);
517 function mkwsHtmlSort() {
518 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
519 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
521 for(var i = 0; i < mkws_config.sort_options.length; i++) {
522 var opt = mkws_config.sort_options[i];
524 var val = opt.length == 1 ? opt[0] : opt[1];
526 sort_html += '<option value="' + key + '"';
527 if (m_sortOrder == key || m_sortOrder == val) {
528 sort_html += ' selected="selected"';
530 sort_html += '>' + M(val) + '</option>';
532 sort_html += '</select>';
538 function mkwsHtmlPerpage() {
539 log("HTML perpage, m_perpage = " + m_perpage);
540 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
542 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
543 var key = mkws_config.perpage_options[i];
545 perpage_html += '<option value="' + key + '"';
546 if (key == m_perpage) {
547 perpage_html += ' selected="selected"';
549 perpage_html += '>' + key + '</option>';
551 perpage_html += '</select>';
557 function mkwsHtmlSwitch() {
558 log("HTML switch for team " + m_teamName);
560 var node = findnode(".mkwsSwitch");
561 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
562 node.append($("<span/>", { text: " | " }));
563 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
566 var node = findnode(".mkwsTargets");
568 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
569 No information available yet.\
571 node.css("display", "none");
575 that.runAutoSearch = function() {
576 var node = findnode('.mkwsRecords,.mkwsTermlists');
577 var query = node.attr('autosearch');
581 if (query.match(/^!param!/)) {
582 var param = query.replace(/^!param!/, '');
583 query = getParameterByName(param);
584 log("obtained query '" + query + "' from param '" + param + "'");
586 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
588 } else if (query.match(/^!path!/)) {
589 var index = query.replace(/^!path!/, '');
590 var path = window.location.pathname.split('/');
591 query = path[path.length - index];
592 log("obtained query '" + query + "' from path-component '" + index + "'");
594 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
598 log("node=" + node + ", class='" + node.className + "', query=" + query);
600 var sortOrder = node.attr('sort');
601 var targets = node.attr('targets');
602 var s = "running auto search: '" + query + "'";
603 if (sortOrder) s += " sorted by '" + sortOrder + "'";
604 if (targets) s += " in targets '" + targets + "'";
607 newSearch(query, sortOrder, targets);
611 // This function is taken from a StackOverflow answer
612 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
613 function getParameterByName(name) {
614 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
615 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
616 results = regex.exec(location.search);
617 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
621 // Translation function. At present, this is properly a
622 // global-level function (hence the assignment to mkws.M) but we
623 // want to make it per-team so different teams can operate in
624 // different languages.
627 var lang = mkws_config.lang;
629 if (!lang || !mkws.locale_lang[lang])
632 return mkws.locale_lang[lang][word] || word;
634 mkws.M = M; // so the Handlebars helper can use it
637 // Finds the node of the specified class within the current team
638 // Multiple OR-clauses separated by commas are handled
639 // More complex cases may not work
641 function findnode(selector, teamName) {
642 teamName = teamName || m_teamName;
644 selector = $.map(selector.split(','), function(s, i) {
645 return s + '.mkwsTeam_' + teamName;
652 function renderDetails(data, marker)
654 var template = loadTemplate("Record");
655 var details = template(data);
656 return '<div class="details mkwsTeam_' + m_teamName + '" 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!";
768 // The following PubSub code is modified from the jQuery manual:
769 // https://api.jquery.com/jQuery.Callbacks/
772 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
773 // team.queue("eventName").publish(arg1, arg2, ...);
776 var queue = function(id) {
778 var callbacks = $.Callbacks();
780 publish: callbacks.fire,
781 subscribe: callbacks.add,
782 unsubscribe: callbacks.remove
797 mkws_config.error = e.message;
802 // Bizarrely, 'that' is just an empty hash. All its state is in
803 // the closure variables defined earlier in this function.