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) + " (+" +
51 ((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, '_');
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 + ")");
169 removeMatchingFilters(function(f) { return f.id });
175 that.delimitQuery = function(field, value)
177 log("delimitQuery(field=" + field + ", value=" + value + ")");
178 removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
184 function removeMatchingFilters(matchFn) {
186 for (var i in m_filters) {
187 var filter = m_filters[i];
188 if (matchFn(filter)) {
189 log("removeMatchingFilters() removing filter " + $.toJSON(filter));
191 log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
192 newFilters.push(filter);
195 m_filters = newFilters;
199 that.showPage = function(pageNum)
201 m_currentPage = pageNum;
202 m_paz.showPage(m_currentPage - 1);
206 that.pagerNext = function() {
207 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
214 that.pagerPrev = function() {
215 if (m_paz.showPrev() != false)
220 that.reShow = function() {
221 m_paz.show(0, m_perpage, m_sortOrder);
228 m_totalRecordCount = 0;
230 that.resetPage = resetPage;
233 function newSearch(query, sortOrder, targets)
235 log("newSearch: " + query);
237 if (mkws.config.use_service_proxy && !mkws.authenticated) {
238 alert("searching before authentication");
243 triggerSearch(query, sortOrder, targets);
244 switchView('records'); // In case it's configured to start off as hidden
249 function triggerSearch(query, sortOrder, targets)
252 queue("navi").publish();
257 // Continue to use previous query/sort-order unless new ones are specified
262 m_sortOrder = sortOrder;
265 m_filters.push({ id: targets, name: targets });
268 for (var i in m_filters) {
269 var filter = m_filters[i];
273 if (filter.id.match(/^[a-z:]+[=~]/)) {
274 log("filter '" + filter.id + "' already begins with SETTING OP");
276 filter.id = 'pz:id=' + filter.id;
278 pp2filter += filter.id;
282 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
288 params.limit = pp2limit;
291 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
292 "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 // switching view between targets and records
301 function switchView(view) {
302 var targets = findnode('.mkwsTargets');
303 var results = findnode('.mkwsResults,.mkwsRecords');
304 var blanket = findnode('.mkwsBlanket');
305 var motd = findnode('.mkwsMOTD');
309 if (targets) targets.css('display', 'block');
310 if (results) results.css('display', 'none');
311 if (blanket) blanket.css('display', 'none');
312 if (motd) motd.css('display', 'none');
315 if (targets) targets.css('display', 'none');
316 if (results) results.css('display', 'block');
317 if (blanket) blanket.css('display', 'block');
318 if (motd) motd.css('display', 'none');
321 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
322 if (targets) targets.css('display', 'none');
323 if (results) results.css('display', 'none');
324 if (blanket) blanket.css('display', 'none');
325 if (motd) motd.css('display', 'none');
328 alert("Unknown view '" + view + "'");
331 that.switchView = switchView;
334 // detailed record drawing
335 that.showDetails = function(recId) {
336 var oldRecordId = m_currentRecordId;
337 m_currentRecordId = recId;
339 // remove current detailed view if any
340 // ##### restrict to current team
341 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
344 detRecordDiv.parentNode.removeChild(detRecordDiv);
346 // if the same clicked, just hide
347 if (recId == oldRecordId) {
348 m_currentRecordId = '';
349 m_currentRecordData = null;
352 // request the record
353 log("showDetails() requesting record '" + recId + "'");
359 * All the HTML stuff to render the search forms and
362 function mkwsHtmlAll() {
364 if (mkws.config.show_lang)
367 log("HTML search form");
368 findnode('.mkwsSearch').html('\
369 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
370 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws.config.query_width + '" />\
371 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
375 // If the team has a .mkwsResults, populate it in the usual
376 // way. If not, assume that it's a smarter application that
377 // defines its own subcomponents, some or all of the
384 findnode(".mkwsResults").html('\
385 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
387 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
388 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
390 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
391 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
392 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
393 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
394 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
399 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
404 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
405 if (mkws.config.show_sort) {
406 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
408 if (mkws.config.show_perpage) {
409 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
411 ranking_data += '</form>';
412 findnode(".mkwsRanking").html(ranking_data);
416 findnode('.mkwsSearchForm').submit(function() {
417 var val = findnode('.mkwsQuery').val();
422 // on first page, hide the termlist
423 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
424 var container = findnode(".mkwsMOTDContainer");
425 if (container.length) {
426 // Move the MOTD from the provided element down into the container
427 findnode(".mkwsMOTD").appendTo(container);
432 function mkwsSetLang() {
433 var lang = getParameterByName("lang") || mkws.config.lang;
434 if (!lang || !mkws.locale_lang[lang]) {
435 mkws.config.lang = ""
437 mkws.config.lang = lang;
440 log("Locale language: " + (mkws.config.lang ? mkws.config.lang : "none"));
441 return mkws.config.lang;
445 /* create locale language menu */
446 function mkwsHtmlLang() {
447 var lang_default = "en";
448 var lang = mkws.config.lang || lang_default;
451 /* display a list of configured languages, or all */
452 var lang_options = mkws.config.lang_options || [];
453 var toBeIncluded = {};
454 for (var i = 0; i < lang_options.length; i++) {
455 toBeIncluded[lang_options[i]] = true;
458 for (var k in mkws.locale_lang) {
459 if (toBeIncluded[k] || lang_options.length == 0)
464 if (lang_options.length == 0 || toBeIncluded[lang_default])
465 list.push(lang_default);
467 log("Language menu for: " + list.join(", "));
471 for(var i = 0; i < list.length; i++) {
478 data += ' <span>' + l + '</span> ';
480 data += ' <a href="?lang=' + l + '">' + l + '</a> '
484 findnode(".mkwsLang").html(data);
488 function mkwsHtmlSort() {
489 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
490 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
492 for(var i = 0; i < mkws.config.sort_options.length; i++) {
493 var opt = mkws.config.sort_options[i];
495 var val = opt.length == 1 ? opt[0] : opt[1];
497 sort_html += '<option value="' + key + '"';
498 if (m_sortOrder == key || m_sortOrder == val) {
499 sort_html += ' selected="selected"';
501 sort_html += '>' + M(val) + '</option>';
503 sort_html += '</select>';
509 function mkwsHtmlPerpage() {
510 log("HTML perpage, m_perpage = " + m_perpage);
511 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
513 for(var i = 0; i < mkws.config.perpage_options.length; i++) {
514 var key = mkws.config.perpage_options[i];
516 perpage_html += '<option value="' + key + '"';
517 if (key == m_perpage) {
518 perpage_html += ' selected="selected"';
520 perpage_html += '>' + key + '</option>';
522 perpage_html += '</select>';
528 function mkwsHtmlSwitch() {
529 log("HTML switch for team " + m_teamName);
531 var node = findnode(".mkwsSwitch");
532 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
533 node.append($("<span/>", { text: " | " }));
534 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
537 var node = findnode(".mkwsTargets");
539 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
540 No information available yet.\
542 node.css("display", "none");
546 that.runAutoSearch = function() {
547 var node = findnode('.mkwsRecords,.mkwsTermlists');
548 var query = node.attr('autosearch');
552 if (query.match(/^!param!/)) {
553 var param = query.replace(/^!param!/, '');
554 query = getParameterByName(param);
555 log("obtained query '" + query + "' from param '" + param + "'");
557 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
559 } else if (query.match(/^!path!/)) {
560 var index = query.replace(/^!path!/, '');
561 var path = window.location.pathname.split('/');
562 query = path[path.length - index];
563 log("obtained query '" + query + "' from path-component '" + index + "'");
565 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
569 log("node=" + node + ", class='" + node.className + "', query=" + query);
571 var sortOrder = node.attr('sort');
572 var targets = node.attr('targets');
573 var s = "running auto search: '" + query + "'";
574 if (sortOrder) s += " sorted by '" + sortOrder + "'";
575 if (targets) s += " in targets '" + targets + "'";
578 newSearch(query, sortOrder, targets);
582 // This function is taken from a StackOverflow answer
583 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
584 function getParameterByName(name) {
585 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
586 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
587 results = regex.exec(location.search);
588 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
592 // Translation function. At present, this is properly a
593 // global-level function (hence the assignment to mkws.M) but we
594 // want to make it per-team so different teams can operate in
595 // different languages.
598 var lang = mkws.config.lang;
600 if (!lang || !mkws.locale_lang[lang])
603 return mkws.locale_lang[lang][word] || word;
605 mkws.M = M; // so the Handlebars helper can use it
608 // Finds the node of the specified class within the current team
609 // Multiple OR-clauses separated by commas are handled
610 // More complex cases may not work
612 function findnode(selector, teamName) {
613 teamName = teamName || m_teamName;
615 selector = $.map(selector.split(','), function(s, i) {
616 return s + '.mkwsTeam_' + teamName;
619 var node = $(selector);
620 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
625 function renderDetails(data, marker)
627 var template = loadTemplate("Record");
628 var details = template(data);
629 return '<div class="details mkwsTeam_' + m_teamName + '" ' +
630 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
632 that.renderDetails = renderDetails;
635 function loadTemplate(name)
637 var template = m_template[name];
639 if (template === undefined) {
640 // Fall back to generic template if there is no team-specific one
641 var node = findnode(".mkwsTemplate_" + name);
643 node = findnode(".mkwsTemplate_" + name, "ALL");
646 var source = node.html();
648 source = defaultTemplate(name);
651 template = Handlebars.compile(source);
652 log("compiled template '" + name + "'");
653 m_template[name] = template;
658 that.loadTemplate = loadTemplate;
661 function defaultTemplate(name)
663 if (name === 'Record') {
667 <th>{{translate "Title"}}</th>\
670 {{#if md-title-remainder}}\
671 ({{md-title-remainder}})\
673 {{#if md-title-responsibility}}\
674 <i>{{md-title-responsibility}}</i>\
680 <th>{{translate "Date"}}</th>\
681 <td>{{md-date}}</td>\
686 <th>{{translate "Author"}}</th>\
687 <td>{{md-author}}</td>\
690 {{#if md-electronic-url}}\
692 <th>{{translate "Links"}}</th>\
694 {{#each md-electronic-url}}\
695 <a href="{{this}}">Link{{index1}}</a>\
700 {{#if-any location having="md-subject"}}\
702 <th>{{translate "Subject"}}</th>\
704 {{#first location having="md-subject"}}\
706 {{#commaList md-subject}}\
707 {{this}}{{/commaList}}\
714 <th>{{translate "Locations"}}</th>\
716 {{#commaList location}}\
717 {{attr "@name"}}{{/commaList}}\
722 } else if (name === "Summary") {
724 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
727 {{#if md-title-remainder}}\
728 <span>{{md-title-remainder}}</span>\
730 {{#if md-title-responsibility}}\
731 <span><i>{{md-title-responsibility}}</i></span>\
736 var s = "There is no default '" + name +"' template!";
742 // The following PubSub code is modified from the jQuery manual:
743 // https://api.jquery.com/jQuery.Callbacks/
746 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
747 // team.queue("eventName").publish(arg1, arg2, ...);
750 var queue = function(id) {
752 var callbacks = $.Callbacks();
754 publish: callbacks.fire,
755 subscribe: callbacks.add,
756 unsubscribe: callbacks.remove