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
30 var m_config = Object.create(mkws.config);
32 that.toString = function() { return '[Team ' + teamName + ']'; };
34 // Accessor methods for individual widgets: readers
35 that.name = function() { return m_teamName; };
36 that.submitted = function() { return m_submitted; };
37 that.perpage = function() { return m_perpage; };
38 that.totalRecordCount = function() { return m_totalRecordCount; };
39 that.currentPage = function() { return m_currentPage; };
40 that.currentRecordId = function() { return m_currentRecordId; };
41 that.currentRecordData = function() { return m_currentRecordData; };
42 that.filters = function() { return m_filters; };
43 that.config = function() { return m_config; };
45 // Accessor methods for individual widgets: writers
46 that.set_sortOrder = function(val) { m_sortOrder = val };
47 that.set_perpage = function(val) { m_perpage = val };
50 // The following PubSub code is modified from the jQuery manual:
51 // https://api.jquery.com/jQuery.Callbacks/
54 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
55 // team.queue("eventName").publish(arg1, arg2, ...);
60 var callbacks = $.Callbacks();
62 publish: callbacks.fire,
63 subscribe: callbacks.add,
64 unsubscribe: callbacks.remove
74 var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
75 ((now - m_logTime.last)/1000).toFixed(3) + ") ");
77 mkws.log(m_teamName + ": " + timestamp + s);
78 that.queue("log").publish(m_teamName, timestamp, s);
83 log("start running MKWS");
85 m_sortOrder = m_config.sort_default;
86 m_perpage = m_config.perpage_default;
88 log("Create main pz2 object");
89 // create a parameters array and pass it to the pz2's constructor
90 // then register the form submit event with the pz2.search function
91 // autoInit is set to true on default
92 m_paz = new pz2({ "windowid": teamName,
93 "pazpar2path": m_config.pazpar2_url,
94 "usesessions" : m_config.use_service_proxy ? false : true,
96 "onbytarget": onBytarget,
98 "onterm": (m_config.facets.length ? onTerm : undefined),
100 "onrecord": onRecord,
101 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
102 "termlist": m_config.facets.join(',')
105 // pz2.js event handlers:
112 function onBytarget(data) {
114 queue("targets").publish(data);
117 function onStat(data) {
119 queue("stat").publish(data);
122 function onTerm(data) {
124 queue("termlists").publish(data);
127 function onShow(data, teamName) {
129 m_totalRecordCount = data.merged;
130 log("found " + m_totalRecordCount + " records");
131 queue("pager").publish(data);
132 queue("records").publish(data);
135 function onRecord(data, args, teamName) {
137 // FIXME: record is async!!
138 clearTimeout(m_paz.recordTimer);
139 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
140 if (detRecordDiv.length) {
141 // in case on_show was faster to redraw element
144 m_currentRecordData = data;
145 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
146 var html = renderDetails(m_currentRecordData);
147 $(recordDiv).append(html);
151 // Used by the Records widget and onRecord()
152 function recordElementId(s) {
153 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
155 that.recordElementId = recordElementId;
157 // Used by onRecord(), showDetails() and renderDetails()
158 function recordDetailsId(s) {
159 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
163 that.targetFiltered = function(id) {
164 for (var i = 0; i < m_filters.length; i++) {
165 if (m_filters[i].id === id ||
166 m_filters[i].id === 'pz:id=' + id) {
174 that.limitTarget = function(id, name) {
175 log("limitTarget(id=" + id + ", name=" + name + ")");
176 m_filters.push({ id: id, name: name });
182 that.limitQuery = function(field, value) {
183 log("limitQuery(field=" + field + ", value=" + value + ")");
184 m_filters.push({ field: field, value: value });
190 that.delimitTarget = function(id) {
191 log("delimitTarget(id=" + id + ")");
192 removeMatchingFilters(function(f) { return f.id });
198 that.delimitQuery = function(field, value) {
199 log("delimitQuery(field=" + field + ", value=" + value + ")");
200 removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
206 function removeMatchingFilters(matchFn) {
208 for (var i in m_filters) {
209 var filter = m_filters[i];
210 if (matchFn(filter)) {
211 log("removeMatchingFilters() removing filter " + $.toJSON(filter));
213 log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
214 newFilters.push(filter);
217 m_filters = newFilters;
221 that.showPage = function(pageNum) {
222 m_currentPage = pageNum;
223 m_paz.showPage(m_currentPage - 1);
227 that.pagerNext = function() {
228 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
235 that.pagerPrev = function() {
236 if (m_paz.showPrev() != false)
241 that.reShow = function() {
242 m_paz.show(0, m_perpage, m_sortOrder);
246 function resetPage() {
248 m_totalRecordCount = 0;
250 that.resetPage = resetPage;
253 function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
254 log("newSearch: " + query);
256 if (m_config.use_service_proxy && !mkws.authenticated) {
257 alert("searching before authentication");
262 triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
263 switchView('records'); // In case it's configured to start off as hidden
266 that.newSearch = newSearch;
269 function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
271 queue("navi").publish();
274 var pp2limit = limit || "";
276 // Continue to use previous query/sort-order unless new ones are specified
281 m_sortOrder = sortOrder;
287 m_filters.push({ id: targets, name: targets });
290 for (var i in m_filters) {
291 var filter = m_filters[i];
295 if (filter.id.match(/^[a-z:]+[=~]/)) {
296 log("filter '" + filter.id + "' already begins with SETTING OP");
298 filter.id = 'pz:id=' + filter.id;
300 pp2filter += filter.id;
304 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
310 params.limit = pp2limit;
313 params.maxrecs = maxrecs;
316 if (!mkws.config.use_service_proxy)
317 alert("can't narrow search by torusquery when Service Proxy is not in use");
318 params.torusquery = torusquery;
321 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
322 "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
324 // We can use: params.torusquery = "udb=NAME"
325 // Note: that won't work when running against raw pazpar2
326 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
330 // switching view between targets and records
331 function switchView(view) {
332 var targets = findnode('.mkwsTargets');
333 var results = findnode('.mkwsResults,.mkwsRecords');
334 var blanket = findnode('.mkwsBlanket');
335 var motd = findnode('.mkwsMOTD');
339 if (targets) targets.css('display', 'block');
340 if (results) results.css('display', 'none');
341 if (blanket) blanket.css('display', 'none');
342 if (motd) motd.css('display', 'none');
345 if (targets) targets.css('display', 'none');
346 if (results) results.css('display', 'block');
347 if (blanket) blanket.css('display', 'block');
348 if (motd) motd.css('display', 'none');
351 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
352 if (targets) targets.css('display', 'none');
353 if (results) results.css('display', 'none');
354 if (blanket) blanket.css('display', 'none');
355 if (motd) motd.css('display', 'none');
358 alert("Unknown view '" + view + "'");
361 that.switchView = switchView;
364 // detailed record drawing
365 that.showDetails = function(recId) {
366 var oldRecordId = m_currentRecordId;
367 m_currentRecordId = recId;
369 // remove current detailed view if any
370 findnode('#' + recordDetailsId(oldRecordId)).remove();
372 // if the same clicked, just hide
373 if (recId == oldRecordId) {
374 m_currentRecordId = '';
375 m_currentRecordData = null;
378 // request the record
379 log("showDetails() requesting record '" + recId + "'");
385 * All the HTML stuff to render the search forms and
388 function mkwsHtmlAll() {
390 if (m_config.show_lang)
393 log("HTML search form");
394 findnode('.mkwsSearch').html('\
395 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
396 <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + m_config.query_width + '" />\
397 <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
401 // If the team has a .mkwsResults, populate it in the usual
402 // way. If not, assume that it's a smarter application that
403 // defines its own subcomponents, some or all of the
410 findnode(".mkwsResults").html('\
411 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
413 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
414 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
416 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
417 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
418 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
419 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
420 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
425 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
430 // Can't be local, as the "Facet" widget also needs to consult this.
432 xtargets: [ "Sources", 16, false ],
433 subject: [ "Subjects", 10, true ],
434 author: [ "Authors", 10, true ]
438 var facets = m_config.facets;
439 acc.push('<div class="title">' + M('Termlists') + '</div>');
440 for (var i = 0; i < facets.length; i++) {
441 acc.push('<div class="mkwsFacet mkwsTeam_' + m_teamName + '" data-mkws-facet="' + facets[i] + '">');
444 findnode(".mkwsTermlists").html(acc.join(''));
446 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
447 if (m_config.show_sort) {
448 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
450 if (m_config.show_perpage) {
451 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
453 ranking_data += '</form>';
454 findnode(".mkwsRanking").html(ranking_data);
458 findnode('.mkwsSearchForm').submit(function() {
459 var val = findnode('.mkwsQuery').val();
464 // on first page, hide the termlist
465 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
466 var container = findnode(".mkwsMOTDContainer");
467 if (container.length) {
468 // Move the MOTD from the provided element down into the container
469 findnode(".mkwsMOTD").appendTo(container);
474 function mkwsSetLang() {
475 var lang = mkws.getParameterByName("lang") || m_config.lang;
476 if (!lang || !mkws.locale_lang[lang]) {
479 m_config.lang = lang;
482 log("Locale language: " + (m_config.lang ? m_config.lang : "none"));
483 return m_config.lang;
487 /* create locale language menu */
488 function mkwsHtmlLang() {
489 var lang_default = "en";
490 var lang = m_config.lang || lang_default;
493 /* display a list of configured languages, or all */
494 var lang_options = m_config.lang_options || [];
495 var toBeIncluded = {};
496 for (var i = 0; i < lang_options.length; i++) {
497 toBeIncluded[lang_options[i]] = true;
500 for (var k in mkws.locale_lang) {
501 if (toBeIncluded[k] || lang_options.length == 0)
506 if (lang_options.length == 0 || toBeIncluded[lang_default])
507 list.push(lang_default);
509 log("Language menu for: " + list.join(", "));
513 for(var i = 0; i < list.length; i++) {
520 data += ' <span>' + l + '</span> ';
522 data += ' <a href="?lang=' + l + '">' + l + '</a> '
526 findnode(".mkwsLang").html(data);
530 function mkwsHtmlSort() {
531 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
532 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
534 for(var i = 0; i < m_config.sort_options.length; i++) {
535 var opt = m_config.sort_options[i];
537 var val = opt.length == 1 ? opt[0] : opt[1];
539 sort_html += '<option value="' + key + '"';
540 if (m_sortOrder == key || m_sortOrder == val) {
541 sort_html += ' selected="selected"';
543 sort_html += '>' + M(val) + '</option>';
545 sort_html += '</select>';
551 function mkwsHtmlPerpage() {
552 log("HTML perpage, m_perpage = " + m_perpage);
553 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
555 for(var i = 0; i < m_config.perpage_options.length; i++) {
556 var key = m_config.perpage_options[i];
558 perpage_html += '<option value="' + key + '"';
559 if (key == m_perpage) {
560 perpage_html += ' selected="selected"';
562 perpage_html += '>' + key + '</option>';
564 perpage_html += '</select>';
570 function mkwsHtmlSwitch() {
571 log("HTML switch for team " + m_teamName);
573 var node = findnode(".mkwsSwitch");
574 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
575 node.append($("<span/>", { text: " | " }));
576 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
579 var node = findnode(".mkwsTargets");
581 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
582 No information available yet.\
584 node.css("display", "none");
588 // Translation function. At present, this is properly a
589 // global-level function (hence the assignment to mkws.M) but we
590 // want to make it per-team so different teams can operate in
591 // different languages.
594 var lang = m_config.lang;
596 if (!lang || !mkws.locale_lang[lang])
599 return mkws.locale_lang[lang][word] || word;
601 mkws.M = M; // so the Handlebars helper can use it
604 // Finds the node of the specified class within the current team
605 // Multiple OR-clauses separated by commas are handled
606 // More complex cases may not work
608 function findnode(selector, teamName) {
609 teamName = teamName || m_teamName;
611 selector = $.map(selector.split(','), function(s, i) {
612 return s + '.mkwsTeam_' + teamName;
615 var node = $(selector);
616 //log('findnode(' + selector + ') found ' + node.length + ' nodes');
619 that.findnode = findnode;
622 function renderDetails(data, marker) {
623 var template = loadTemplate("Record");
624 var details = template(data);
625 return '<div class="details mkwsTeam_' + m_teamName + '" ' +
626 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
628 that.renderDetails = renderDetails;
631 function loadTemplate(name) {
632 var template = m_template[name];
634 if (template === undefined) {
635 // Fall back to generic template if there is no team-specific one
636 var node = findnode(".mkwsTemplate_" + name);
638 node = findnode(".mkwsTemplate_" + name, "ALL");
641 var source = node.html();
643 source = defaultTemplate(name);
646 template = Handlebars.compile(source);
647 log("compiled template '" + name + "'");
648 m_template[name] = template;
653 that.loadTemplate = loadTemplate;
656 function defaultTemplate(name) {
657 if (name === 'Record') {
661 <th>{{translate "Title"}}</th>\
664 {{#if md-title-remainder}}\
665 ({{md-title-remainder}})\
667 {{#if md-title-responsibility}}\
668 <i>{{md-title-responsibility}}</i>\
674 <th>{{translate "Date"}}</th>\
675 <td>{{md-date}}</td>\
680 <th>{{translate "Author"}}</th>\
681 <td>{{md-author}}</td>\
684 {{#if md-electronic-url}}\
686 <th>{{translate "Links"}}</th>\
688 {{#each md-electronic-url}}\
689 <a href="{{this}}">Link{{index1}}</a>\
694 {{#if-any location having="md-subject"}}\
696 <th>{{translate "Subject"}}</th>\
698 {{#first location having="md-subject"}}\
700 {{#commaList md-subject}}\
701 {{this}}{{/commaList}}\
708 <th>{{translate "Locations"}}</th>\
710 {{#commaList location}}\
711 {{attr "@name"}}{{/commaList}}\
716 } else if (name === "Summary") {
718 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
721 {{#if md-title-remainder}}\
722 <span>{{md-title-remainder}}</span>\
724 {{#if md-title-responsibility}}\
725 <span><i>{{md-title-responsibility}}</i></span>\
728 } else if (name === "Image") {
730 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
731 {{#first md-thumburl}}\
732 <img src="{{this}}" alt="{{../md-title}}"/>\
739 var s = "There is no default '" + name +"' template!";