1 // Factory function for team objects. As much as possible, this uses
2 // only member variables (prefixed "m_") and inner functions with
3 // private scope. Some functions are visibl as member-functions to be
4 // called from outside code -- specifically, from generated
5 // HTML. These functions are that.switchView(), showDetails(),
6 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
7 // pagerPrev(), pagerNext(), showPage().
9 function team($, teamName) {
11 var m_teamName = teamName;
12 var m_submitted = false;
13 var m_query; // initially undefined
14 var m_sortOrder; // will be set below
15 var m_perpage; // will be set below
17 var m_totalRecordCount = 0;
18 var m_currentPage = 1;
19 var m_currentRecordId = '';
20 var m_currentRecordData = null;
22 // Timestamps for logging
26 var m_paz; // will be initialised below
29 that.name = function() { return m_teamName; }
30 that.submitted = function() { return m_submitted; }
31 that.perpage = function() { return m_perpage; }
32 that.totalRecordCount = function() { return m_totalRecordCount; }
33 that.currentPage = function() { return m_currentPage; }
34 that.currentRecordId = function() { return m_currentRecordId; }
35 that.currentRecordData = function() { return m_currentRecordData; }
36 that.filters = function() { return m_filters; }
38 that.set_sortOrder = function(val) { m_sortOrder = val };
39 that.set_perpage = function(val) { m_perpage = val };
42 var log = function (s) {
44 var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
47 mkws.log(m_teamName + ": " + timestamp + s);
51 log("start running MKWS");
53 m_sortOrder = mkws_config.sort_default;
54 m_perpage = mkws_config.perpage_default;
56 log("Create main pz2 object");
57 // create a parameters array and pass it to the pz2's constructor
58 // then register the form submit event with the pz2.search function
59 // autoInit is set to true on default
60 m_paz = new pz2({ "windowid": teamName,
61 "pazpar2path": mkws_config.pazpar2_url,
62 "usesessions" : mkws_config.use_service_proxy ? false : true,
64 "onbytarget": onBytarget,
66 "onterm": (mkws_config.facets.length ? onTerm : undefined),
69 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
70 "termlist": mkws_config.facets.join(',')
75 // pz2.js event handlers:
84 function onBytarget(data) {
86 queue("targets").publish(data);
90 function onStat(data) {
92 queue("stat").publish(data);
96 function onTerm(data) {
98 queue("termlists").publish(data);
102 function onShow(data, teamName) {
104 m_totalRecordCount = data.merged;
105 queue("pager").publish(data);
106 queue("records").publish(data);
110 function onRecord(data, args, teamName) {
112 // FIXME: record is async!!
113 clearTimeout(m_paz.recordTimer);
114 // ##### restrict to current team
115 var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
117 // in case on_show was faster to redraw element
120 m_currentRecordData = data;
121 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
122 var html = renderDetails(m_currentRecordData);
123 $(recordDiv).append(html);
127 // Used by promoteRecords() and onRecord()
128 function recordElementId(s) {
129 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
131 that.recordElementId = recordElementId;
133 // Used by onRecord(), showDetails() and renderDetails()
134 function recordDetailsId(s) {
135 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
137 that.recordElementId = recordElementId;
140 that.targetFiltered = function(id) {
141 for (var i = 0; i < m_filters.length; i++) {
142 if (m_filters[i].id === id ||
143 m_filters[i].id === 'pz:id=' + id) {
151 ////////////////////////////////////////////////////////////////////////////////
152 ////////////////////////////////////////////////////////////////////////////////
155 // when search button pressed
156 function onFormSubmitEventHandler()
158 var val = findnode('.mkwsQuery').val();
164 function newSearch(query, sortOrder, targets)
166 log("newSearch: " + query);
168 if (mkws_config.use_service_proxy && !mkws.authenticated) {
169 alert("searching before authentication");
174 triggerSearch(query, sortOrder, targets);
175 switchView('records'); // In case it's configured to start off as hidden
180 // limit by target functions
181 that.limitTarget = function (id, name)
183 log("limitTarget(id=" + id + ", name=" + name + ")");
184 m_filters.push({ id: id, name: name });
190 // limit the query after clicking the facet
191 that.limitQuery = function (field, value)
193 log("limitQuery(field=" + field + ", value=" + value + ")");
194 m_filters.push({ field: field, value: value });
200 that.delimitTarget = function (id)
202 log("delimitTarget(id=" + id + ")");
204 for (var i in m_filters) {
205 var filter = m_filters[i];
207 log("delimitTarget() removing filter " + $.toJSON(filter));
209 log("delimitTarget() keeping filter " + $.toJSON(filter));
210 newFilters.push(filter);
213 m_filters = newFilters;
220 that.delimitQuery = function (field, value)
222 log("delimitQuery(field=" + field + ", value=" + value + ")");
224 for (var i in m_filters) {
225 var filter = m_filters[i];
227 field == filter.field &&
228 value == filter.value) {
229 log("delimitQuery() removing filter " + $.toJSON(filter));
231 log("delimitQuery() keeping filter " + $.toJSON(filter));
232 newFilters.push(filter);
235 m_filters = newFilters;
245 m_totalRecordCount = 0;
247 that.resetPage = resetPage;
250 function triggerSearch (query, sortOrder, targets)
253 queue("navi").publish();
258 // Continue to use previous query/sort-order unless new ones are specified
263 m_sortOrder = sortOrder;
266 m_filters.push({ id: targets, name: targets });
269 for (var i in m_filters) {
270 var filter = m_filters[i];
274 if (filter.id.match(/^[a-z:]+[=~]/)) {
275 log("filter '" + filter.id + "' already begins with SETTING OP");
277 filter.id = 'pz:id=' + filter.id;
279 pp2filter += filter.id;
283 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
289 params.limit = pp2limit;
292 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
294 // We can use: params.torusquery = "udb=NAME"
295 // Note: that won't work when running against raw pazpar2
296 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
300 that.reShow = function() {
301 m_paz.show(0, m_perpage, m_sortOrder);
306 that.showPage = function (pageNum)
308 m_currentPage = pageNum;
309 m_paz.showPage(m_currentPage - 1);
313 // simple paging functions
314 that.pagerNext = function () {
315 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
322 that.pagerPrev = function () {
323 if (m_paz.showPrev() != false)
328 // switching view between targets and records
329 function switchView(view) {
330 var targets = findnode('.mkwsTargets');
331 var results = findnode('.mkwsResults,.mkwsRecords');
332 var blanket = findnode('.mkwsBlanket');
333 var motd = findnode('.mkwsMOTD');
337 if (targets) targets.css('display', 'block');
338 if (results) results.css('display', 'none');
339 if (blanket) blanket.css('display', 'none');
340 if (motd) motd.css('display', 'none');
343 if (targets) targets.css('display', 'none');
344 if (results) results.css('display', 'block');
345 if (blanket) blanket.css('display', 'block');
346 if (motd) motd.css('display', 'none');
349 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
350 if (targets) targets.css('display', 'none');
351 if (results) results.css('display', 'none');
352 if (blanket) blanket.css('display', 'none');
353 if (motd) motd.css('display', 'none');
356 alert("Unknown view '" + view + "'");
359 that.switchView = switchView;
362 // detailed record drawing
363 that.showDetails = function (recId) {
364 var oldRecordId = m_currentRecordId;
365 m_currentRecordId = recId;
367 // remove current detailed view if any
368 // ##### restrict to current team
369 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
372 detRecordDiv.parentNode.removeChild(detRecordDiv);
374 // if the same clicked, just hide
375 if (recId == oldRecordId) {
376 m_currentRecordId = '';
377 m_currentRecordData = null;
380 // request the record
381 log("showDetails() requesting record '" + recId + "'");
387 * All the HTML stuff to render the search forms and
390 function mkwsHtmlAll() {
392 if (mkws_config.show_lang)
395 log("HTML search form");
396 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
398 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
399 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
400 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
405 // If the team has a .mkwsResults, populate it in the usual
406 // way. If not, assume that it's a smarter application that
407 // defines its own subcomponents, some or all of the
414 findnode(".mkwsResults").html('\
415 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
417 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
418 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
420 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
421 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
422 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
423 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
424 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
429 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
434 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
435 if (mkws_config.show_sort) {
436 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
438 if (mkws_config.show_perpage) {
439 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
441 ranking_data += '</form>';
442 findnode(".mkwsRanking").html(ranking_data);
446 findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
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") || mkws_config.lang;
460 if (!lang || !mkws.locale_lang[lang]) {
461 mkws_config.lang = ""
463 mkws_config.lang = lang;
466 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
467 return mkws_config.lang;
471 /* create locale language menu */
472 function mkwsHtmlLang() {
473 var lang_default = "en";
474 var lang = mkws_config.lang || lang_default;
477 /* display a list of configured languages, or all */
478 var lang_options = mkws_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 < mkws_config.sort_options.length; i++) {
519 var opt = mkws_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 < mkws_config.perpage_options.length; i++) {
540 var key = mkws_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 = mkws_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;
649 function renderDetails(data, marker)
651 var template = loadTemplate("Record");
652 var details = template(data);
653 return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
655 that.renderDetails = renderDetails;
658 function loadTemplate(name)
660 var template = m_template[name];
662 if (template === undefined) {
663 // Fall back to generic template if there is no team-specific one
664 var node = findnode(".mkwsTemplate_" + name);
666 node = findnode(".mkwsTemplate_" + name, "ALL");
669 var source = node.html();
671 source = mkws.defaultTemplate(name);
674 template = Handlebars.compile(source);
675 log("compiled template '" + name + "'");
676 m_template[name] = template;
681 that.loadTemplate = loadTemplate;
684 // The following PubSub code is modified from the jQuery manual:
685 // https://api.jquery.com/jQuery.Callbacks/
688 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
689 // team.queue("eventName").publish(arg1, arg2, ...);
692 var queue = function(id) {
694 var callbacks = $.Callbacks();
696 publish: callbacks.fire,
697 subscribe: callbacks.add,
698 unsubscribe: callbacks.remove
713 mkws_config.error = e.message;
718 // Bizarrely, 'that' is just an empty hash. All its state is in
719 // the closure variables defined earlier in this function.