X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-team.js;h=935bcaa24c1c8d9695e5db9573a6f0eb15e84a97;hb=1e59ea3b6c29afeaf938fdb47729d2ec5f2cf7fc;hp=100ce3ece7f15cdb780d48224351f6a654924265;hpb=ec689d378107f90be870c5843d1f6922eb90c655;p=mkws-moved-to-github.git
diff --git a/src/mkws-team.js b/src/mkws-team.js
index 100ce3e..935bcaa 100644
--- a/src/mkws-team.js
+++ b/src/mkws-team.js
@@ -5,8 +5,8 @@
// 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 = {};
@@ -15,7 +15,7 @@ function team($, teamName) {
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 = '';
@@ -26,57 +26,85 @@ function team($, teamName) {
"last": $.now()
};
var m_paz; // will be initialised below
- var m_template = {};
+ 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
that.set_sortOrder = function(val) { m_sortOrder = val };
that.set_perpage = function(val) { m_perpage = val };
+ // The following PubSub code is modified from the jQuery manual:
+ // 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]) {
+ var callbacks = $.Callbacks();
+ queues[id] = {
+ publish: callbacks.fire,
+ subscribe: callbacks.add,
+ unsubscribe: callbacks.remove
+ };
+ }
+ return queues[id];
+ };
+ that.queue = queue;
+
+
function log(s) {
var now = $.now();
- var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
+ var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
+ ((now - m_logTime.last)/1000).toFixed(3) + ") ");
m_logTime.last = now;
-
mkws.log(m_teamName + ": " + timestamp + s);
+ that.queue("log").publish(m_teamName, timestamp, s);
}
that.log = log;
+
log("start running MKWS");
- m_sortOrder = mkws_config.sort_default;
- m_perpage = mkws_config.perpage_default;
+ m_sortOrder = m_config.sort_default;
+ m_perpage = m_config.perpage_default;
log("Create main pz2 object");
// create a parameters array and pass it to the pz2's constructor
// then register the form submit event with the pz2.search function
// autoInit is set to true on default
m_paz = new pz2({ "windowid": teamName,
- "pazpar2path": mkws_config.pazpar2_url,
- "usesessions" : mkws_config.use_service_proxy ? false : true,
+ "pazpar2path": m_config.pazpar2_url,
+ "usesessions" : m_config.use_service_proxy ? false : true,
"oninit": onInit,
"onbytarget": onBytarget,
"onstat": onStat,
- "onterm": (mkws_config.facets.length ? onTerm : undefined),
+ "onterm": (m_config.facets.length ? onTerm : undefined),
"onshow": onShow,
"onrecord": onRecord,
"showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
- "termlist": mkws_config.facets.join(',')
+ "termlist": m_config.facets.join(',')
});
-
// pz2.js event handlers:
function onInit() {
log("init");
@@ -90,8 +118,9 @@ function team($, teamName) {
}
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) {
@@ -102,6 +131,7 @@ function team($, teamName) {
function onShow(data, teamName) {
log("show");
m_totalRecordCount = data.merged;
+ log("found " + m_totalRecordCount + " records");
queue("pager").publish(data);
queue("records").publish(data);
}
@@ -135,78 +165,54 @@ function team($, teamName) {
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)
- {
+ 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)
- {
+ 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.delimitTarget = function(id)
- {
- log("delimitTarget(id=" + id + ")");
- var newFilters = [];
- for (var i in m_filters) {
- var filter = m_filters[i];
- if (filter.id) {
- log("delimitTarget() removing filter " + $.toJSON(filter));
- } else {
- log("delimitTarget() keeping filter " + $.toJSON(filter));
- newFilters.push(filter);
- }
- }
- m_filters = newFilters;
+ 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;
+ };
+
- triggerSearch();
+ that.delimitTarget = function(id) {
+ log("delimitTarget(id=" + id + ")");
+ m_filterSet.removeMatching(function(f) { return f.type === 'target' });
+ if (m_query) triggerSearch();
return false;
};
- that.delimitQuery = function(field, value)
- {
+ that.delimitQuery = function(field, value) {
log("delimitQuery(field=" + field + ", value=" + value + ")");
- var newFilters = [];
- for (var i in m_filters) {
- var filter = m_filters[i];
- if (filter.field &&
- field == filter.field &&
- value == filter.value) {
- log("delimitQuery() removing filter " + $.toJSON(filter));
- } else {
- log("delimitQuery() keeping filter " + $.toJSON(filter));
- newFilters.push(filter);
- }
- }
- m_filters = newFilters;
-
- triggerSearch();
+ m_filterSet.removeMatching(function(f) { return f.type == 'field' &&
+ field == f.field && value == f.value });
+ if (m_query) triggerSearch();
return false;
};
- that.showPage = function(pageNum)
- {
+ that.showPage = function(pageNum) {
m_currentPage = pageNum;
m_paz.showPage(m_currentPage - 1);
};
@@ -227,90 +233,73 @@ function team($, teamName) {
that.reShow = function() {
+ resetPage();
m_paz.show(0, m_perpage, m_sortOrder);
};
- function resetPage()
- {
+ function resetPage() {
m_currentPage = 1;
m_totalRecordCount = 0;
}
that.resetPage = resetPage;
- function newSearch(query, sortOrder, targets)
- {
+ function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
log("newSearch: " + query);
- if (mkws_config.use_service_proxy && !mkws.authenticated) {
+ if (m_config.use_service_proxy && !mkws.authenticated) {
alert("searching before authentication");
return;
}
- m_filters = []
- triggerSearch(query, sortOrder, targets);
+ 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;
}
+ that.newSearch = newSearch;
- function triggerSearch(query, sortOrder, targets)
- {
+ function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
resetPage();
queue("navi").publish();
- var pp2filter = "";
- var pp2limit = "";
-
// Continue to use previous query/sort-order unless new ones are specified
- if (query) {
- m_query = query;
- }
- if (sortOrder) {
- m_sortOrder = sortOrder;
- }
- 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 (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) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
+ 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':
@@ -325,13 +314,6 @@ function team($, teamName) {
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');
- break;
default:
alert("Unknown view '" + view + "'");
}
@@ -345,11 +327,7 @@ function team($, teamName) {
m_currentRecordId = recId;
// remove current detailed view if any
- // ##### restrict to current team
- var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
- // lovin DOM!
- if (detRecordDiv)
- detRecordDiv.parentNode.removeChild(detRecordDiv);
+ findnode('#' + recordDetailsId(oldRecordId)).remove();
// if the same clicked, just hide
if (recId == oldRecordId) {
@@ -363,266 +341,33 @@ function team($, teamName) {
};
- /*
- * All the HTML stuff to render the search forms and
- * result pages.
- */
- function mkwsHtmlAll() {
- mkwsSetLang();
- if (mkws_config.show_lang)
- mkwsHtmlLang();
-
- log("HTML search form");
- findnode('.mkwsSearch').html('\
-');
-
- 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('\
-
\
-
\
-
\
- \
-
\
-
\
- \
- \
- \
- \
-
\
-
\
-
\
-
\
- \
-
\
-
\
-
');
-
- var ranking_data = '';
- 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 = 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 mkws_config.lang;
- }
-
-
- /* create locale language menu */
- function mkwsHtmlLang() {
- var lang_default = "en";
- var lang = mkws_config.lang || lang_default;
- var list = [];
-
- /* display a list of configured languages, or all */
- var lang_options = mkws_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 += ' ' + l + ' ';
- } else {
- data += ' ' + l + ' '
- }
- }
-
- findnode(".mkwsLang").html(data);
- }
-
-
- function mkwsHtmlSort() {
- log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
- var sort_html = '';
-
- return sort_html;
- }
-
-
- function mkwsHtmlPerpage() {
- log("HTML perpage, m_perpage = " + m_perpage);
- var perpage_html = '';
-
- return perpage_html;
- }
-
-
- function mkwsHtmlSwitch() {
- log("HTML switch for team " + m_teamName);
-
- var node = findnode(".mkwsSwitch");
- node.append($('' + M('Records') + ''));
- node.append($("", { text: " | " }));
- node.append($('' + M('Targets') + ''));
-
- log("HTML targets");
- var node = findnode(".mkwsTargets");
- node.html('\
-
\
- No information available yet.\
-
');
- node.css("display", "none");
- }
-
-
- that.runAutoSearch = function() {
- var node = findnode('.mkwsRecords,.mkwsTermlists');
- var query = node.attr('autosearch');
- if (!query)
- return;
-
- if (query.match(/^!param!/)) {
- var param = query.replace(/^!param!/, '');
- query = getParameterByName(param);
- log("obtained query '" + query + "' from param '" + param + "'");
- if (!query) {
- alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
- }
- } else if (query.match(/^!path!/)) {
- var index = query.replace(/^!path!/, '');
- var path = window.location.pathname.split('/');
- query = path[path.length - index];
- log("obtained query '" + query + "' from path-component '" + index + "'");
- if (!query) {
- alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
- }
- }
-
- log("node=" + node + ", class='" + node.className + "', query=" + query);
-
- var sortOrder = node.attr('sort');
- var targets = node.attr('targets');
- var s = "running auto search: '" + query + "'";
- if (sortOrder) s += " sorted by '" + sortOrder + "'";
- if (targets) s += " in targets '" + targets + "'";
- log(s);
-
- newSearch(query, sortOrder, targets);
- };
-
-
- // This function is taken from a StackOverflow answer
- // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
- function getParameterByName(name) {
- name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
- var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
- results = regex.exec(location.search);
- return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
- }
-
-
// 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 = mkws_config.lang;
+ mkws.M = function (word) {
+ var lang = mkws.config.lang;
+ log("in M('" + word + "'), lang=" + 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
+ };
+ var M = mkws.M;
// 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');
@@ -630,29 +375,44 @@ function team($, teamName) {
}
- function renderDetails(data, marker)
- {
+ 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);
- return '
' + details + '
';
+ return '
' + details + '
';
}
that.renderDetails = renderDetails;
- function loadTemplate(name)
- {
+ 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);
@@ -665,109 +425,49 @@ function team($, teamName) {
that.loadTemplate = loadTemplate;
- function defaultTemplate(name)
- {
- if (name === 'Record') {
- return '\
-