X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=src%2Fmkws-team.js;h=2e6db95cecb8257f2f9c892999c599633bf4ed29;hb=ee50f2a77dd33e0f9bd357a65540365f41ad4728;hp=8258bd1d09e065ac189ca99f0ab23c2cf3b87e90;hpb=5b6dfafa13033d2fa76f3a08cd55498701fc0a83;p=mkws-moved-to-github.git
diff --git a/src/mkws-team.js b/src/mkws-team.js
index 8258bd1..2e6db95 100644
--- a/src/mkws-team.js
+++ b/src/mkws-team.js
@@ -5,749 +5,449 @@
// 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_teamName = teamName;
- var m_submitted = false;
- var m_query; // initially undefined
- var m_sortOrder; // will be set below
- var m_perpage; // will be set below
- var m_filters = [];
- var m_totalRecordCount = 0;
- var m_currentPage = 1;
- var m_currentRecordId = '';
- var m_currentRecordData = null;
- var m_logTime = {
- // Timestamps for logging
- "start": $.now(),
- "last": $.now()
- };
- var m_paz; // will be initialised below
- var m_template = {};
- var m_config = Object.create(mkws.config);
-
- 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.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:
- // https://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) + ") ");
- m_logTime.last = now;
- mkws.log(m_teamName + ": " + timestamp + s);
- that.queue("log").publish(m_teamName, timestamp, s);
+ var that = {};
+ var m_teamName = teamName;
+ var m_submitted = false;
+ var m_query; // initially undefined
+ var m_sortOrder; // will be set below
+ var m_perpage; // will be set below
+ var m_filterSet = filterSet(that);
+ var m_totalRecordCount = 0;
+ var m_currentPage = 1;
+ var m_currentRecordId = '';
+ var m_currentRecordData = null;
+ var m_logTime = {
+ // Timestamps for logging
+ "start": $.now(),
+ "last": $.now()
+ };
+ var m_paz; // will be initialised below
+ var m_templateText = {}; // widgets can register templates 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
+ var m_gotRecords = false;
+
+ 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_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
+ };
}
- that.log = log;
-
-
- log("start running MKWS");
-
- 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": m_config.pazpar2_url,
- "usesessions" : m_config.use_service_proxy ? false : true,
- "oninit": onInit,
- "onbytarget": onBytarget,
- "onstat": onStat,
- "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": m_config.facets.join(',')
- });
-
- // pz2.js event handlers:
- function onInit() {
- log("init");
- m_paz.stat();
- m_paz.bytarget();
+ 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) + ") ");
+ m_logTime.last = now;
+ mkws.log(m_teamName + ": " + timestamp + s);
+ that.queue("log").publish(m_teamName, timestamp, s);
+ }
+ that.log = log;
+
+
+ log("making new widget team");
+
+ m_sortOrder = m_config.sort_default;
+ m_perpage = m_config.perpage_default;
+
+ // 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": m_config.pazpar2_url,
+ "usesessions" : m_config.use_service_proxy ? false : true,
+ "oninit": onInit,
+ "onbytarget": onBytarget,
+ "onstat": onStat,
+ "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": m_config.facets.join(',')
+ });
+ log("created main pz2 object");
+
+ // pz2.js event handlers:
+ function onInit() {
+ log("init");
+ m_paz.stat();
+ m_paz.bytarget();
+ }
+
+ function onBytarget(data) {
+ log("bytarget");
+ queue("targets").publish(data);
+ }
+
+ function onStat(data) {
+ queue("stat").publish(data);
+ var hitcount = parseInt(data.hits[0], 10);
+ if (!m_gotRecords && hitcount > 0) {
+ m_gotRecords = true;
+ queue("firstrecords").publish(hitcount);
}
-
- function onBytarget(data) {
- log("target");
- queue("targets").publish(data);
- }
-
- function onStat(data) {
- log("stat");
- queue("stat").publish(data);
- }
-
- function onTerm(data) {
- log("term");
- queue("termlists").publish(data);
+ if (parseInt(data.activeclients[0], 10) === 0) {
+ queue("complete").publish(hitcount);
}
-
- function onShow(data, teamName) {
- log("show");
- m_totalRecordCount = data.merged;
- log("found " + m_totalRecordCount + " records");
- queue("pager").publish(data);
- queue("records").publish(data);
+ }
+
+ 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);
+ var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
+ if (detRecordDiv.length) {
+ // in case on_show was faster to redraw element
+ return;
}
+ m_currentRecordData = data;
+ var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
+ var html = renderDetails(m_currentRecordData);
+ $(recordDiv).append(html);
+ }
- function onRecord(data, args, teamName) {
- log("record");
- // FIXME: record is async!!
- clearTimeout(m_paz.recordTimer);
- var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
- if (detRecordDiv.length) {
- // in case on_show was faster to redraw element
- return;
- }
- m_currentRecordData = data;
- var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
- var html = renderDetails(m_currentRecordData);
- $(recordDiv).append(html);
- }
+ // Used by the Records widget and onRecord()
+ function recordElementId(s) {
+ return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
+ }
+ that.recordElementId = recordElementId;
- // Used by the Records widget and onRecord()
- function recordElementId(s) {
- return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
- }
- that.recordElementId = recordElementId;
+ // Used by onRecord(), showDetails() and renderDetails()
+ function recordDetailsId(s) {
+ return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
+ }
- // Used by onRecord(), showDetails() and renderDetails()
- function recordDetailsId(s) {
- return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
- }
+ that.targetFiltered = function(id) {
+ return m_filterSet.targetFiltered(id);
+ };
- 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;
- };
-
-
- that.limitTarget = function(id, name) {
- log("limitTarget(id=" + id + ", name=" + name + ")");
- m_filters.push({ id: id, name: name });
- triggerSearch();
- return false;
- };
-
-
- 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) {
- log("delimitTarget(id=" + id + ")");
- removeMatchingFilters(function(f) { return f.id });
- 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();
- 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.limitTarget = function(id, name) {
+ log("limitTarget(id=" + id + ", name=" + name + ")");
+ m_filterSet.add(targetFilter(id, name));
+ if (m_query) triggerSearch();
+ return false;
+ };
- that.showPage = function(pageNum) {
- m_currentPage = pageNum;
- m_paz.showPage(m_currentPage - 1);
- };
+ that.limitQuery = function(field, value) {
+ log("limitQuery(field=" + field + ", value=" + value + ")");
+ m_filterSet.add(fieldFilter(field, value));
+ if (m_query) triggerSearch();
+ return false;
+ };
- that.pagerNext = function() {
- if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
- m_paz.showNext();
- m_currentPage++;
- }
- };
+ 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.pagerPrev = function() {
- if (m_paz.showPrev() != false)
- m_currentPage--;
- };
+ that.delimitTarget = function(id) {
+ log("delimitTarget(id=" + id + ")");
+ m_filterSet.removeMatching(function(f) { return f.type === 'target' });
+ if (m_query) triggerSearch();
+ return false;
+ };
- that.reShow = function() {
- m_paz.show(0, m_perpage, m_sortOrder);
- };
-
-
- function resetPage() {
- m_currentPage = 1;
- m_totalRecordCount = 0;
- }
- that.resetPage = resetPage;
-
-
- 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 = 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, '\\$&');
- }
- }
-
- var params = {};
- 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));
-
- // 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);
- }
+ that.delimitQuery = function(field, value) {
+ log("delimitQuery(field=" + field + ", value=" + value + ")");
+ m_filterSet.removeMatching(function(f) { return f.type == 'field' &&
+ field == f.field && value == f.value });
+ if (m_query) triggerSearch();
+ return false;
+ };
- // 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');
-
- 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');
- 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');
- break;
- default:
- alert("Unknown view '" + view + "'");
- }
- }
- that.switchView = switchView;
-
-
- // detailed record drawing
- that.showDetails = function(recId) {
- var oldRecordId = m_currentRecordId;
- m_currentRecordId = recId;
-
- // remove current detailed view if any
- findnode('#' + recordDetailsId(oldRecordId)).remove();
-
- // if the same clicked, just hide
- if (recId == oldRecordId) {
- m_currentRecordId = '';
- m_currentRecordData = null;
- return;
- }
- // request the record
- log("showDetails() requesting record '" + recId + "'");
- m_paz.record(recId);
- };
-
-
- /*
- * 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('\
-
');
-
- 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('\
-