};
var m_paz; // will be initialised below
var m_template = {};
+ var m_config = mkws.objectInheritingFrom(mkws.config);
+ var m_widgets = {}; // Maps widget-type to object
+ 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.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.name = function() { return m_teamName; };
+ that.submitted = function() { return m_submitted; };
+ 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.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");
m_paz.stat();
m_paz.bytarget();
}
-
function onBytarget(data) {
log("target");
queue("targets").publish(data);
}
-
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) {
log("term");
queue("termlists").publish(data);
}
-
function onShow(data, teamName) {
log("show");
m_totalRecordCount = data.merged;
+ log("found " + m_totalRecordCount + " records");
queue("pager").publish(data);
queue("records").publish(data);
}
-
function onRecord(data, args, teamName) {
log("record");
// FIXME: record is async!!
clearTimeout(m_paz.recordTimer);
- // ##### restrict to current team
- var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
- if (detRecordDiv) {
+ var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
+ if (detRecordDiv.length) {
// in case on_show was faster to redraw element
return;
}
}
- // Used by promoteRecords() and onRecord()
+ // Used by the Records widget and onRecord()
function recordElementId(s) {
return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
}
function recordDetailsId(s) {
return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
}
- that.recordElementId = recordElementId;
that.targetFiltered = function(id) {
}
}
return false;
- }
-
-
- ////////////////////////////////////////////////////////////////////////////////
- ////////////////////////////////////////////////////////////////////////////////
-
-
- // when search button pressed
- function onFormSubmitEventHandler()
- {
- var val = findnode('.mkwsQuery').val();
- newSearch(val);
- return false;
- }
-
-
- function newSearch(query, sortOrder, targets)
- {
- log("newSearch: " + query);
-
- if (mkws_config.use_service_proxy && !mkws.authenticated) {
- alert("searching before authentication");
- return;
- }
-
- m_filters = []
- triggerSearch(query, sortOrder, targets);
- switchView('records'); // In case it's configured to start off as hidden
- m_submitted = true;
- }
+ };
- // limit by target functions
- that.limitTarget = function (id, name)
- {
+ that.limitTarget = function(id, name) {
log("limitTarget(id=" + id + ", name=" + name + ")");
m_filters.push({ id: id, name: name });
triggerSearch();
return false;
- }
+ };
- // limit the query after clicking the facet
- that.limitQuery = function (field, value)
- {
+ that.limitQuery = function(field, value) {
log("limitQuery(field=" + field + ", value=" + value + ")");
m_filters.push({ field: field, value: value });
triggerSearch();
return false;
- }
+ };
- that.delimitTarget = function (id)
- {
+ 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;
-
+ removeMatchingFilters(function(f) { return f.id });
triggerSearch();
return false;
- }
+ };
- that.delimitQuery = function (field, value)
- {
+ that.delimitQuery = function(field, value) {
log("delimitQuery(field=" + field + ", value=" + value + ")");
+ removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
+ triggerSearch();
+ return false;
+ };
+
+
+ function removeMatchingFilters(matchFn) {
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));
+ if (matchFn(filter)) {
+ log("removeMatchingFilters() removing filter " + $.toJSON(filter));
} else {
- log("delimitQuery() keeping filter " + $.toJSON(filter));
+ log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
newFilters.push(filter);
}
}
m_filters = newFilters;
-
- triggerSearch();
- return false;
}
- function resetPage()
- {
+ that.showPage = function(pageNum) {
+ m_currentPage = pageNum;
+ m_paz.showPage(m_currentPage - 1);
+ };
+
+
+ that.pagerNext = function() {
+ if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
+ m_paz.showNext();
+ m_currentPage++;
+ }
+ };
+
+
+ that.pagerPrev = function() {
+ if (m_paz.showPrev() != false)
+ m_currentPage--;
+ };
+
+
+ that.reShow = function() {
+ resetPage();
+ m_paz.show(0, m_perpage, m_sortOrder);
+ };
+
+
+ function resetPage() {
m_currentPage = 1;
m_totalRecordCount = 0;
}
that.resetPage = resetPage;
- function triggerSearch (query, sortOrder, targets)
- {
+ function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
+ log("newSearch: " + query);
+
+ if (m_config.use_service_proxy && !mkws.authenticated) {
+ alert("searching before authentication");
+ return;
+ }
+
+ m_filters = []
+ 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, maxrecs, perpage, limit, targets, torusquery) {
resetPage();
queue("navi").publish();
var pp2filter = "";
- var pp2limit = "";
+ var pp2limit = limit || "";
// Continue to use previous query/sort-order unless new ones are specified
if (query) {
if (sortOrder) {
m_sortOrder = sortOrder;
}
+ if (perpage) {
+ m_perpage = perpage;
+ }
if (targets) {
m_filters.push({ id: targets, name: targets });
}
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 = " + $.toJSON(m_filters) + ", " +
+ "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
// We can use: params.torusquery = "udb=NAME"
// Note: that won't work when running against raw pazpar2
}
- that.reShow = function() {
- m_paz.show(0, m_perpage, m_sortOrder);
- }
-
-
- that.showPage = function (pageNum)
- {
- m_currentPage = pageNum;
- m_paz.showPage(m_currentPage - 1);
- }
-
-
- that.pagerNext = function () {
- if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
- m_paz.showNext();
- m_currentPage++;
- }
- }
-
-
- that.pagerPrev = function () {
- if (m_paz.showPrev() != false)
- m_currentPage--;
- }
-
-
// switching view between targets and records
function switchView(view) {
var targets = findnode('.mkwsTargets');
// detailed record drawing
- that.showDetails = function (recId) {
+ that.showDetails = function(recId) {
var oldRecordId = m_currentRecordId;
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) {
// request the record
log("showDetails() requesting record '" + recId + "'");
m_paz.record(recId);
- }
+ };
/*
*/
function mkwsHtmlAll() {
mkwsSetLang();
- if (mkws_config.show_lang)
+ 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="' + mkws_config.query_width + '" />\
+ <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>');
</tr>\
</table>');
+ var acc = [];
+ var facets = m_config.facets;
+ acc.push('<div class="title">' + M('Termlists') + '</div>');
+ for (var i = 0; i < facets.length; i++) {
+ acc.push('<div class="mkwsFacet mkwsTeam_' + m_teamName + '" data-mkws-facet="' + facets[i] + '">');
+ acc.push('</div>');
+ }
+ findnode(".mkwsTermlists").html(acc.join(''));
+
var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
- if (mkws_config.show_sort) {
+ if (m_config.show_sort) {
ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
}
- if (mkws_config.show_perpage) {
+ if (m_config.show_perpage) {
ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
}
ranking_data += '</form>';
mkwsHtmlSwitch();
- findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
+ 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(); });
function mkwsSetLang() {
- var lang = getParameterByName("lang") || mkws_config.lang;
+ var lang = mkws.getParameterByName("lang") || m_config.lang;
if (!lang || !mkws.locale_lang[lang]) {
- mkws_config.lang = ""
+ m_config.lang = ""
} else {
- mkws_config.lang = lang;
+ m_config.lang = lang;
}
- log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
- return mkws_config.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 = mkws_config.lang || lang_default;
+ var lang = m_config.lang || lang_default;
var list = [];
/* display a list of configured languages, or all */
- var lang_options = mkws_config.lang_options || [];
+ var lang_options = m_config.lang_options || [];
var toBeIncluded = {};
for (var i = 0; i < lang_options.length; i++) {
toBeIncluded[lang_options[i]] = true;
log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
- for(var i = 0; i < mkws_config.sort_options.length; i++) {
- var opt = mkws_config.sort_options[i];
+ 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];
log("HTML perpage, m_perpage = " + m_perpage);
var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
- for(var i = 0; i < mkws_config.perpage_options.length; i++) {
- var key = mkws_config.perpage_options[i];
+ 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) {
}
- 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;
+ var lang = m_config.lang;
if (!lang || !mkws.locale_lang[lang])
return word;
teamName = teamName || m_teamName;
selector = $.map(selector.split(','), function(s, i) {
- return s + '.mkwsTeam_' + teamName;
+ if (teamName === 'AUTO') {
+ return (s + '.mkwsTeam_' + teamName + ',' +
+ s + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])');
+ } else {
+ return s + '.mkwsTeam_' + teamName;
+ }
}).join(',');
- return $(selector);
+ var node = $(selector);
+ //log('findnode(' + selector + ') found ' + node.length + ' nodes');
+ return node;
}
+ that.findnode = findnode;
- function renderDetails(data, marker)
- {
+ function renderDetails(data, marker) {
var template = loadTemplate("Record");
var details = template(data);
- return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
+ return '<div class="details mkwsTeam_' + m_teamName + '" ' +
+ 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
}
that.renderDetails = renderDetails;
- function loadTemplate(name)
- {
+ function loadTemplate(name) {
var template = m_template[name];
if (template === undefined) {
that.loadTemplate = loadTemplate;
- function defaultTemplate(name)
- {
+ function defaultTemplate(name) {
if (name === 'Record') {
return '\
<table>\
<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>\
+';
}
var s = "There is no default '" + name +"' template!";
return s;
}
-
- // The following PubSub code is modified from the jQuery manual:
- // https://api.jquery.com/jQuery.Callbacks/
- //
- // Use as:
- // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
- // team.queue("eventName").publish(arg1, arg2, ...);
-
- var queues = {};
- var queue = function(id) {
- if (!queues[id]) {
- var callbacks = $.Callbacks();
- queues[id] = {
- publish: callbacks.fire,
- subscribe: callbacks.add,
- unsubscribe: callbacks.remove
- };
- }
- return queues[id];
+ that.addWidget = function(w) {
+ if (!m_widgets[w.type]) {
+ m_widgets[w.type] = widget;
+ log("Registered '" + w.type + "' widget in team '" + m_teamName + "'");
+ } else if (typeof(m_widgets[w.type]) !== 'number') {
+ m_widgets[w.type] = 2;
+ log("Registered duplicate '" + w.type + "' widget in team '" + m_teamName + "'");
+ } else {
+ m_widgets[w.type] += 1;
+ log("Registered '" + w.type + "' widget #" + m_widgets[w.type] + "' in team '" + m_teamName + "'");
+ }
}
- that.queue = queue;
+ that.widgetTypes = function() {
+ var keys = [];
+ for (var k in m_widgets) keys.push(k);
+ return keys.sort();
+ }
- // main
- (function() {
- try {
- mkwsHtmlAll()
- }
+ that.widget = function(type) {
+ return m_widgets[type];
+ }
- catch (e) {
- mkws_config.error = e.message;
- // alert(e.message);
- }
- })();
+ mkwsHtmlAll()
- // Bizarrely, 'that' is just an empty hash. All its state is in
- // the closure variables defined earlier in this function.
return that;
};
projects / mkws-moved-to-github.git / blobdiff