// Some functions are visible as member-functions to be called from
// outside code -- specifically, from generated HTML. These functions
// are that.switchView(), showDetails(), limitTarget(), limitQuery(),
-// delimitTarget(), delimitQuery(), showPage(), pagerPrev(),
-// pagerNext().
+// limitCategory(), delimitTarget(), delimitQuery(), showPage(),
+// pagerPrev(), pagerNext().
//
function team($, teamName) {
var that = {};
var m_query; // initially undefined
var m_sortOrder; // will be set below
var m_perpage; // will be set below
- var m_filters = [];
+ var m_filterSet = filterSet(that);
var m_totalRecordCount = 0;
var m_currentPage = 1;
var m_currentRecordId = '';
"last": $.now()
};
var m_paz; // will be initialised below
- var m_template = {};
- var m_config = Object.create(mkws.config);
+ var m_tempateText = {}; // widgets can register tempates to be compiled
+ var m_template = {}; // compiled templates, from any source
+ var m_config = mkws.objectInheritingFrom(mkws.config);
+ var m_widgets = {}; // Maps widget-type to array of widget objects
that.toString = function() { return '[Team ' + teamName + ']'; };
// Accessor methods for individual widgets: readers
that.name = function() { return m_teamName; };
that.submitted = function() { return m_submitted; };
+ that.sortOrder = function() { return m_sortOrder; };
that.perpage = function() { return m_perpage; };
that.totalRecordCount = function() { return m_totalRecordCount; };
that.currentPage = function() { return m_currentPage; };
that.currentRecordId = function() { return m_currentRecordId; };
that.currentRecordData = function() { return m_currentRecordData; };
- that.filters = function() { return m_filters; };
+ that.filters = function() { return m_filterSet; };
that.config = function() { return m_config; };
// Accessor methods for individual widgets: writers
// The following PubSub code is modified from the jQuery manual:
- // https://api.jquery.com/jQuery.Callbacks/
+ // http://api.jquery.com/jQuery.Callbacks/
//
// Use as:
// team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
// team.queue("eventName").publish(arg1, arg2, ...);
-
+ //
var queues = {};
function queue(id) {
if (!queues[id]) {
}
function onStat(data) {
- log("stat");
queue("stat").publish(data);
+ if (parseInt(data.activeclients[0], 10) === 0)
+ queue("complete").publish(parseInt(data.hits[0], 10));
}
function onTerm(data) {
that.targetFiltered = function(id) {
- for (var i = 0; i < m_filters.length; i++) {
- if (m_filters[i].id === id ||
- m_filters[i].id === 'pz:id=' + id) {
- return true;
- }
- }
- return false;
+ return m_filterSet.targetFiltered(id);
};
that.limitTarget = function(id, name) {
log("limitTarget(id=" + id + ", name=" + name + ")");
- m_filters.push({ id: id, name: name });
- triggerSearch();
+ m_filterSet.add(targetFilter(id, name));
+ if (m_query) triggerSearch();
return false;
};
that.limitQuery = function(field, value) {
log("limitQuery(field=" + field + ", value=" + value + ")");
- m_filters.push({ field: field, value: value });
- triggerSearch();
+ m_filterSet.add(fieldFilter(field, value));
+ if (m_query) triggerSearch();
+ return false;
+ };
+
+
+ that.limitCategory = function(id) {
+ log("limitCategory(id=" + id + ")");
+ // Only one category filter at a time
+ m_filterSet.removeMatching(function(f) { return f.type === 'category' });
+ if (id !== '') m_filterSet.add(categoryFilter(id));
+ if (m_query) triggerSearch();
return false;
};
that.delimitTarget = function(id) {
log("delimitTarget(id=" + id + ")");
- removeMatchingFilters(function(f) { return f.id });
- triggerSearch();
+ m_filterSet.removeMatching(function(f) { return f.type === 'target' });
+ if (m_query) triggerSearch();
return false;
};
that.delimitQuery = function(field, value) {
log("delimitQuery(field=" + field + ", value=" + value + ")");
- removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
- triggerSearch();
+ m_filterSet.removeMatching(function(f) { return f.type == 'field' &&
+ field == f.field && value == f.value });
+ if (m_query) triggerSearch();
return false;
};
- function removeMatchingFilters(matchFn) {
- var newFilters = [];
- for (var i in m_filters) {
- var filter = m_filters[i];
- if (matchFn(filter)) {
- log("removeMatchingFilters() removing filter " + $.toJSON(filter));
- } else {
- log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
- newFilters.push(filter);
- }
- }
- m_filters = newFilters;
- }
-
-
that.showPage = function(pageNum) {
m_currentPage = pageNum;
m_paz.showPage(m_currentPage - 1);
that.reShow = function() {
+ resetPage();
m_paz.show(0, m_perpage, m_sortOrder);
};
return;
}
- m_filters = []
+ m_filterSet.removeMatching(function(f) { return f.type !== 'category' });
triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
switchView('records'); // In case it's configured to start off as hidden
m_submitted = true;
resetPage();
queue("navi").publish();
- var pp2filter = "";
- var pp2limit = limit || "";
-
// Continue to use previous query/sort-order unless new ones are specified
- if (query) {
- m_query = query;
- }
- if (sortOrder) {
- m_sortOrder = sortOrder;
- }
- if (perpage) {
- m_perpage = perpage;
- }
- if (targets) {
- m_filters.push({ id: targets, name: targets });
- }
-
- for (var i in m_filters) {
- var filter = m_filters[i];
- if (filter.id) {
- if (pp2filter)
- pp2filter += ",";
- if (filter.id.match(/^[a-z:]+[=~]/)) {
- log("filter '" + filter.id + "' already begins with SETTING OP");
- } else {
- filter.id = 'pz:id=' + filter.id;
- }
- pp2filter += filter.id;
- } else {
- if (pp2limit)
- pp2limit += ",";
- pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
- }
- }
+ if (query) m_query = query;
+ if (sortOrder) m_sortOrder = sortOrder;
+ if (perpage) m_perpage = perpage;
+ if (targets) m_filterSet.add(targetFilter(targets, targets));
+
+ var pp2filter = m_filterSet.pp2filter();
+ var pp2limit = m_filterSet.pp2limit(limit);
+ var pp2catLimit = m_filterSet.pp2catLimit();
+ if (pp2catLimit) {
+ pp2filter = pp2filter ? pp2filter + "," + pp2catLimit : pp2catLimit;
+ }
var params = {};
- if (pp2limit) {
- params.limit = pp2limit;
- }
- if (maxrecs) {
- params.maxrecs = maxrecs;
- }
+ if (pp2limit) params.limit = pp2limit;
+ if (maxrecs) params.maxrecs = maxrecs;
if (torusquery) {
if (!mkws.config.use_service_proxy)
alert("can't narrow search by torusquery when Service Proxy is not in use");
params.torusquery = torusquery;
}
- log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
+ log("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " +
"pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
- // We can use: params.torusquery = "udb=NAME"
- // Note: that won't work when running against raw pazpar2
m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
}
// switching view between targets and records
function switchView(view) {
- var targets = findnode('.mkwsTargets');
- var results = findnode('.mkwsResults,.mkwsRecords');
- var blanket = findnode('.mkwsBlanket');
- var motd = findnode('.mkwsMOTD');
+ var targets = widgetNode('Targets');
+ var results = widgetNode('Results') || widgetNode('Records');
+ var blanket = widgetNode('Blanket');
+ var motd = widgetNode('MOTD');
switch(view) {
case 'targets':
- if (targets) targets.css('display', 'block');
- if (results) results.css('display', 'none');
- if (blanket) blanket.css('display', 'none');
- if (motd) motd.css('display', 'none');
+ if (targets) $(targets).show();
+ if (results) $(results).hide();
+ if (blanket) $(blanket).hide();
+ if (motd) $(motd).hide();
break;
case 'records':
- if (targets) targets.css('display', 'none');
- if (results) results.css('display', 'block');
- if (blanket) blanket.css('display', 'block');
- if (motd) motd.css('display', 'none');
- break;
- case 'none':
- alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
- if (targets) targets.css('display', 'none');
- if (results) results.css('display', 'none');
- if (blanket) blanket.css('display', 'none');
- if (motd) motd.css('display', 'none');
+ if (targets) $(targets).hide();
+ if (results) $(results).show();
+ if (blanket) $(blanket).show();
+ if (motd) $(motd).hide();
break;
default:
alert("Unknown view '" + view + "'");
};
- /*
- * All the HTML stuff to render the search forms and
- * result pages.
- */
- function mkwsHtmlAll() {
- mkwsSetLang();
- if (m_config.show_lang)
- mkwsHtmlLang();
-
- log("HTML search form");
- findnode('.mkwsSearch').html('\
-<form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
- <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + m_config.query_width + '" />\
- <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
-</form>');
-
- log("HTML records");
- // If the team has a .mkwsResults, populate it in the usual
- // way. If not, assume that it's a smarter application that
- // defines its own subcomponents, some or all of the
- // following:
- // .mkwsTermlists
- // .mkwsRanking
- // .mkwsPager
- // .mkwsNavi
- // .mkwsRecords
- findnode(".mkwsResults").html('\
-<table width="100%" border="0" cellpadding="6" cellspacing="0">\
- <tr>\
- <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
- <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
- </td>\
- <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
- <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
- <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
- <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
- <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
- </td>\
- </tr>\
- <tr>\
- <td colspan="2">\
- <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
- </td>\
- </tr>\
-</table>');
-
- var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
- if (m_config.show_sort) {
- ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
- }
- if (m_config.show_perpage) {
- ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
- }
- ranking_data += '</form>';
- findnode(".mkwsRanking").html(ranking_data);
-
- mkwsHtmlSwitch();
-
- findnode('.mkwsSearchForm').submit(function() {
- var val = findnode('.mkwsQuery').val();
- newSearch(val);
- return false;
- });
-
- // on first page, hide the termlist
- $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
- var container = findnode(".mkwsMOTDContainer");
- if (container.length) {
- // Move the MOTD from the provided element down into the container
- findnode(".mkwsMOTD").appendTo(container);
- }
- }
-
-
- function mkwsSetLang() {
- var lang = mkws.getParameterByName("lang") || m_config.lang;
- if (!lang || !mkws.locale_lang[lang]) {
- m_config.lang = ""
- } else {
- m_config.lang = lang;
- }
-
- log("Locale language: " + (m_config.lang ? m_config.lang : "none"));
- return m_config.lang;
- }
-
-
- /* create locale language menu */
- function mkwsHtmlLang() {
- var lang_default = "en";
- var lang = m_config.lang || lang_default;
- var list = [];
-
- /* display a list of configured languages, or all */
- var lang_options = m_config.lang_options || [];
- var toBeIncluded = {};
- for (var i = 0; i < lang_options.length; i++) {
- toBeIncluded[lang_options[i]] = true;
- }
-
- for (var k in mkws.locale_lang) {
- if (toBeIncluded[k] || lang_options.length == 0)
- list.push(k);
- }
-
- // add english link
- if (lang_options.length == 0 || toBeIncluded[lang_default])
- list.push(lang_default);
-
- log("Language menu for: " + list.join(", "));
-
- /* the HTML part */
- var data = "";
- for(var i = 0; i < list.length; i++) {
- var l = list[i];
-
- if (data)
- data += ' | ';
-
- if (lang == l) {
- data += ' <span>' + l + '</span> ';
- } else {
- data += ' <a href="?lang=' + l + '">' + l + '</a> '
- }
- }
-
- findnode(".mkwsLang").html(data);
- }
-
-
- function mkwsHtmlSort() {
- log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
- var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
-
- for(var i = 0; i < m_config.sort_options.length; i++) {
- var opt = m_config.sort_options[i];
- var key = opt[0];
- var val = opt.length == 1 ? opt[0] : opt[1];
-
- sort_html += '<option value="' + key + '"';
- if (m_sortOrder == key || m_sortOrder == val) {
- sort_html += ' selected="selected"';
- }
- sort_html += '>' + M(val) + '</option>';
- }
- sort_html += '</select>';
-
- return sort_html;
- }
-
-
- function mkwsHtmlPerpage() {
- log("HTML perpage, m_perpage = " + m_perpage);
- var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
-
- for(var i = 0; i < m_config.perpage_options.length; i++) {
- var key = m_config.perpage_options[i];
-
- perpage_html += '<option value="' + key + '"';
- if (key == m_perpage) {
- perpage_html += ' selected="selected"';
- }
- perpage_html += '>' + key + '</option>';
- }
- perpage_html += '</select>';
-
- return perpage_html;
- }
-
-
- function mkwsHtmlSwitch() {
- log("HTML switch for team " + m_teamName);
-
- var node = findnode(".mkwsSwitch");
- node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
- node.append($("<span/>", { text: " | " }));
- node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
-
- log("HTML targets");
- var node = findnode(".mkwsTargets");
- node.html('\
-<div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
- No information available yet.\
-</div>');
- node.css("display", "none");
- }
-
-
- // Translation function. At present, this is properly a
- // global-level function (hence the assignment to mkws.M) but we
- // want to make it per-team so different teams can operate in
- // different languages.
- //
- function M(word) {
- var lang = m_config.lang;
-
- if (!lang || !mkws.locale_lang[lang])
- return word;
-
- return mkws.locale_lang[lang][word] || word;
- }
- mkws.M = M; // so the Handlebars helper can use it
-
-
// Finds the node of the specified class within the current team
- // Multiple OR-clauses separated by commas are handled
- // More complex cases may not work
- //
function findnode(selector, teamName) {
teamName = teamName || m_teamName;
- selector = $.map(selector.split(','), function(s, i) {
- return s + '.mkwsTeam_' + teamName;
- }).join(',');
+ if (teamName === 'AUTO') {
+ selector = (selector + '.mkwsTeam_' + teamName + ',' +
+ selector + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])');
+ } else {
+ selector = selector + '.mkwsTeam_' + teamName;
+ }
var node = $(selector);
//log('findnode(' + selector + ') found ' + node.length + ' nodes');
}
+ function widgetNode(type) {
+ var w = that.widget(type);
+ return w ? $(w.node) : undefined;
+ }
+
function renderDetails(data, marker) {
var template = loadTemplate("Record");
var details = template(data);
that.renderDetails = renderDetails;
+ that.registerTemplate = function(name, text) {
+ m_tempateText[name] = text;
+ };
+
+
function loadTemplate(name) {
var template = m_template[name];
if (template === undefined) {
// Fall back to generic template if there is no team-specific one
- var node = findnode(".mkwsTemplate_" + name);
- if (!node.length) {
- node = findnode(".mkwsTemplate_" + name, "ALL");
+ var source;
+ var node = widgetNode("Template_" + name);
+ if (!node) {
+ node = widgetNode("Template_" + name, "ALL");
}
+ if (node) {
+ source = node.html();
+ }
- var source = node.html();
if (!source) {
- source = defaultTemplate(name);
+ source = m_tempateText[name];
+ }
+ if (!source) {
+ source = mkws.defaultTemplate(name);
}
template = Handlebars.compile(source);
that.loadTemplate = loadTemplate;
- function defaultTemplate(name) {
- if (name === 'Record') {
- return '\
-<table>\
- <tr>\
- <th>{{translate "Title"}}</th>\
- <td>\
- {{md-title}}\
- {{#if md-title-remainder}}\
- ({{md-title-remainder}})\
- {{/if}}\
- {{#if md-title-responsibility}}\
- <i>{{md-title-responsibility}}</i>\
- {{/if}}\
- </td>\
- </tr>\
- {{#if md-date}}\
- <tr>\
- <th>{{translate "Date"}}</th>\
- <td>{{md-date}}</td>\
- </tr>\
- {{/if}}\
- {{#if md-author}}\
- <tr>\
- <th>{{translate "Author"}}</th>\
- <td>{{md-author}}</td>\
- </tr>\
- {{/if}}\
- {{#if md-electronic-url}}\
- <tr>\
- <th>{{translate "Links"}}</th>\
- <td>\
- {{#each md-electronic-url}}\
- <a href="{{this}}">Link{{index1}}</a>\
- {{/each}}\
- </td>\
- </tr>\
- {{/if}}\
- {{#if-any location having="md-subject"}}\
- <tr>\
- <th>{{translate "Subject"}}</th>\
- <td>\
- {{#first location having="md-subject"}}\
- {{#if md-subject}}\
- {{#commaList md-subject}}\
- {{this}}{{/commaList}}\
- {{/if}}\
- {{/first}}\
- </td>\
- </tr>\
- {{/if-any}}\
- <tr>\
- <th>{{translate "Locations"}}</th>\
- <td>\
- {{#commaList location}}\
- {{attr "@name"}}{{/commaList}}\
- </td>\
- </tr>\
-</table>\
-';
- } else if (name === "Summary") {
- return '\
-<a href="#" id="{{_id}}" onclick="{{_onclick}}">\
- <b>{{md-title}}</b>\
-</a>\
-{{#if md-title-remainder}}\
- <span>{{md-title-remainder}}</span>\
-{{/if}}\
-{{#if md-title-responsibility}}\
- <span><i>{{md-title-responsibility}}</i></span>\
-{{/if}}\
-';
- } else if (name === "Image") {
- return '\
- <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
- {{#first md-thumburl}}\
- <img src="{{this}}" alt="{{../md-title}}"/>\
- {{/first}}\
- <br/>\
- </a>\
-';
- }
+ that.addWidget = function(w) {
+ if (m_widgets[w.type] === undefined) {
+ m_widgets[w.type] = [ w ];
+ log("Added '" + w.type + "' widget to team '" + m_teamName + "'");
+ } else {
+ m_widgets[w.type].push(w);
+ log("Added '" + w.type + "' widget #" + m_widgets[w.type].length + "' to team '" + m_teamName + "'");
+ }
+ }
+
+ that.widget = function(type) {
+ var list = m_widgets[type];
+
+ if (!list)
+ return undefined;
+ if (list.length > 1) {
+ alert("widget('" + type + "') finds " + list.length + " widgets: using first");
+ }
+ return list[0];
+ }
- var s = "There is no default '" + name +"' template!";
- alert(s);
- return s;
+ that.visitWidgets = function(callback) {
+ for (var type in m_widgets) {
+ var list = m_widgets[type];
+ for (var i = 0; i < list.length; i++) {
+ var res = callback(type, list[i]);
+ if (res !== undefined) {
+ return res;
+ }
+ }
+ }
+ return undefined;
}
- mkwsHtmlAll()
+ var lang = mkws.getParameterByName("lang") || mkws.config.lang;
+ if (!lang || !mkws.locale_lang[lang]) {
+ mkws.config.lang = ""
+ } else {
+ mkws.config.lang = lang;
+ }
+
+ log("Locale language: " + (mkws.config.lang ? mkws.config.lang : "none"));
return that;
};
projects / mkws-moved-to-github.git / blobdiff