X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-team.js;h=aac101a658e47342bfeea1de3c140f93e609284b;hb=d7a665a570b5f836ccc509c872234743dd4005aa;hp=43f2fbfefd62517011177d704cf8fc83397d9135;hpb=ebd0ddf06cecbd7a63dbddc39425001d9b2599e4;p=mkws-moved-to-github.git diff --git a/src/mkws-team.js b/src/mkws-team.js index 43f2fbf..aac101a 100644 --- a/src/mkws-team.js +++ b/src/mkws-team.js @@ -1,3 +1,4 @@ +"use strict"; // Factory function for team objects. As much as possible, this uses // only member variables (prefixed "m_") and inner functions with // private scope. @@ -13,22 +14,30 @@ // mkws.makeTeam = function($, teamName) { var that = {}; + + // Member variables are separated into two categories + + // 1. Persistent state (to be coded in URL fragment) + var m_state = { + query: null, // initially undefined + sort: null, // will be set below + size: null, // will be set below + page: 1, + recid: '', + filters: filterSet(that) + } + + // 2. Internal state (not to be coded) var m_teamName = teamName; + var m_paz; // will be initialised below 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_widgets = {}; // Maps widget-type to array of widget objects @@ -42,19 +51,55 @@ mkws.makeTeam = function($, 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.query = function() { return m_query; }; + that.sortOrder = function() { return m_state.sort; }; + that.perpage = function() { return m_state.size; }; + that.query = function() { return m_state.query; }; that.totalRecordCount = function() { return m_totalRecordCount; }; - that.currentPage = function() { return m_currentPage; }; - that.currentRecordId = function() { return m_currentRecordId; }; + that.currentPage = function() { return m_state.page; }; + that.currentRecordId = function() { return m_state.recid; }; that.currentRecordData = function() { return m_currentRecordData; }; - that.filters = function() { return m_filterSet; }; + that.filters = function() { return m_state.filters; }; that.gotRecords = function() { return m_gotRecords; }; // Accessor methods for individual widgets: writers - that.set_sortOrder = function(val) { m_sortOrder = val }; - that.set_perpage = function(val) { m_perpage = val }; + that.set_sortOrder = function(val) { m_state.sort = val }; + that.set_perpage = function(val) { m_state.size = val }; + + m_state.sort = config.sort_default; + m_state.size = config.perpage_default; + + var m_default = $.extend(true, {}, m_state); + var tmp = m_default.filters; + delete m_default.filters; + $.extend(m_default, tmp.fragmentItems()); + + that.urlFragment = function() { + var s; + + // Expand the filterSet into a set of key=value properties + var state = $.extend(true, {}, m_state); + var tmp = state.filters; + delete state.filters; + $.extend(state, tmp.fragmentItems()); + + for (var key in state) { + if (state.hasOwnProperty(key) && + state[key] != m_default[key]) { + if (!s) { + var s = 'mkws'; + if (m_teamName !== 'AUTO') s += m_teamName; + s += '='; + } else { + s += "@"; + } + + // ### how do we need to quote this? + s += key + '=' + state[key]; + } + } + + return s; + } // The following PubSub code is modified from the jQuery manual: @@ -79,31 +124,33 @@ mkws.makeTeam = function($, teamName) { that.queue = queue; - function log(s) { + function _log(fn, 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); + fn.call(mkws.log, m_teamName + ": " + timestamp + s); that.queue("log").publish(m_teamName, timestamp, s); } - that.log = log; + that.trace = function(x) { _log(mkws.trace, x) }; + that.debug = function(x) { _log(mkws.debug, x) }; + that.info = function(x) { _log(mkws.info, x) }; + that.warn = function(x) { _log(mkws.warn, x) }; + that.error = function(x) { _log(mkws.error, x) }; + that.fatal = function(x) { _log(mkws.fatal, x) }; - log("making new widget team"); + that.info("making new widget team"); - m_sortOrder = config.sort_default; - m_perpage = config.perpage_default; - // pz2.js event handlers: function onInit() { - log("init"); + that.info("init"); m_paz.stat(); m_paz.bytarget(); } function onBytarget(data) { - log("bytarget"); + that.info("bytarget"); queue("targets").publish(data); } @@ -115,26 +162,26 @@ mkws.makeTeam = function($, teamName) { queue("firstrecords").publish(hitcount); } if (parseInt(data.activeclients[0], 10) === 0) { - log("complete"); + that.info("complete"); queue("complete").publish(hitcount); } } function onTerm(data) { - log("term"); + that.info("term"); queue("facets").publish(data); } function onShow(data, teamName) { - log("show"); + that.info("show"); m_totalRecordCount = data.merged; - log("found " + m_totalRecordCount + " records"); + that.info("found " + m_totalRecordCount + " records"); queue("pager").publish(data); queue("records").publish(data); } function onRecord(data, args, teamName) { - log("record"); + that.info("record"); // FIXME: record is async!! clearTimeout(m_paz.recordTimer); queue("record").publish(data); @@ -154,7 +201,7 @@ mkws.makeTeam = function($, teamName) { // then register the form submit event with the pz2.search function // autoInit is set to true on default that.makePz2 = function() { - log("m_queues=" + $.toJSON(m_queues)); + that.debug("m_queues=" + $.toJSON(m_queues)); var params = { "windowid": teamName, "pazpar2path": mkws.pazpar2_url(), @@ -166,26 +213,26 @@ mkws.makeTeam = function($, teamName) { params.oninit = onInit; if (m_queues.targets) { params.onbytarget = onBytarget; - log("setting bytarget callback"); + that.info("setting bytarget callback"); } - if (m_queues.stat) { + if (m_queues.stat || m_queues.firstrecords || m_queues.complete) { params.onstat = onStat; - log("setting stat callback"); + that.info("setting stat callback"); } if (m_queues.facets && config.facets.length) { params.onterm = onTerm; - log("setting term callback"); + that.info("setting term callback"); } if (m_queues.records) { - log("setting show callback"); + that.info("setting show callback"); params.onshow = onShow; // Record callback is subscribed from records callback - log("setting record callback"); + that.info("setting record callback"); params.onrecord = onRecord; } m_paz = new pz2(params); - log("created main pz2 object"); + that.info("created main pz2 object"); } @@ -202,81 +249,87 @@ mkws.makeTeam = function($, teamName) { that.targetFiltered = function(id) { - return m_filterSet.targetFiltered(id); + return m_state.filters.targetFiltered(id); }; that.limitTarget = function(id, name) { - log("limitTarget(id=" + id + ", name=" + name + ")"); - m_filterSet.add(targetFilter(id, name)); - if (m_query) triggerSearch(); + that.info("limitTarget(id=" + id + ", name=" + name + ")"); + m_state.filters.add(targetFilter(id, name)); + if (m_state.query) triggerSearch(); return false; }; that.limitQuery = function(field, value) { - log("limitQuery(field=" + field + ", value=" + value + ")"); - m_filterSet.add(fieldFilter(field, value)); - if (m_query) triggerSearch(); + that.info("limitQuery(field=" + field + ", value=" + value + ")"); + m_state.filters.add(fieldFilter(field, value)); + if (m_state.query) triggerSearch(); return false; }; that.limitCategory = function(id) { - log("limitCategory(id=" + id + ")"); + that.info("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(); + m_state.filters.removeMatching(function(f) { return f.type === 'category' }); + if (id !== '') m_state.filters.add(categoryFilter(id)); + if (m_state.query) triggerSearch(); return false; }; that.delimitTarget = function(id) { - log("delimitTarget(id=" + id + ")"); - m_filterSet.removeMatching(function(f) { return f.type === 'target' }); - if (m_query) triggerSearch(); + that.info("delimitTarget(id=" + id + ")"); + m_state.filters.removeMatching(function(f) { return f.type === 'target' }); + if (m_state.query) triggerSearch(); return false; }; that.delimitQuery = function(field, value) { - log("delimitQuery(field=" + field + ", value=" + value + ")"); - m_filterSet.removeMatching(function(f) { return f.type == 'field' && + that.info("delimitQuery(field=" + field + ", value=" + value + ")"); + m_state.filters.removeMatching(function(f) { return f.type == 'field' && field == f.field && value == f.value }); - if (m_query) triggerSearch(); + if (m_state.query) triggerSearch(); return false; }; that.showPage = function(pageNum) { - m_currentPage = pageNum; - m_paz.showPage(m_currentPage - 1); + m_state.page = pageNum; + m_paz.showPage(m_state.page - 1); + that.warn("fragment: " + that.urlFragment()); }; that.pagerNext = function() { - if (m_totalRecordCount - m_perpage*m_currentPage > 0) { + if (m_totalRecordCount - m_state.size * m_state.page > 0) { m_paz.showNext(); - m_currentPage++; + m_state.page++; + that.warn("fragment: " + that.urlFragment()); } }; that.pagerPrev = function() { - if (m_paz.showPrev() != false) - m_currentPage--; + if (m_paz.showPrev() != false) { + m_state.page--; + that.warn("fragment: " + that.urlFragment()); + } }; that.reShow = function() { resetPage(); - m_paz.show(0, m_perpage, m_sortOrder); + m_paz.show(0, m_state.size, m_state.sort); + // ### not really the right place for this but it will do for now. + that.warn("fragment: " + that.urlFragment()); }; function resetPage() { - m_currentPage = 1; + m_state.page = 1; m_totalRecordCount = 0; m_gotRecords = false; } @@ -284,14 +337,14 @@ mkws.makeTeam = function($, teamName) { function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) { - log("newSearch: " + query); + that.info("newSearch: " + query); if (config.use_service_proxy && !mkws.authenticated) { alert("searching before authentication"); return; } - m_filterSet.removeMatching(function(f) { return f.type !== 'category' }); + m_state.filters.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; @@ -301,17 +354,16 @@ mkws.makeTeam = function($, teamName) { function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) { resetPage(); - queue("navi").publish(); // 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_filterSet.add(targetFilter(targets, targets)); - - var pp2filter = m_filterSet.pp2filter(); - var pp2limit = m_filterSet.pp2limit(limit); - var pp2catLimit = m_filterSet.pp2catLimit(); + if (query) m_state.query = query; + if (sortOrder) m_state.sort = sortOrder; + if (perpage) m_state.size = perpage; + if (targets) m_state.filters.add(targetFilter(targets, targets)); + + var pp2filter = m_state.filters.pp2filter(); + var pp2limit = m_state.filters.pp2limit(limit); + var pp2catLimit = m_state.filters.pp2catLimit(); if (pp2catLimit) { pp2filter = pp2filter ? pp2filter + "," + pp2catLimit : pp2catLimit; } @@ -325,16 +377,21 @@ mkws.makeTeam = function($, teamName) { params.torusquery = torusquery; } - log("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " + + that.info("triggerSearch(" + m_state.query + "): filters = " + m_state.filters.toJSON() + ", " + "pp2filter = " + pp2filter + ", params = " + $.toJSON(params)); - m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params); + m_paz.search(m_state.query, m_state.size, m_state.sort, pp2filter, undefined, params); + queue("searchtriggered").publish(); + + // ### not really the right place for this but it will do for now. + that.warn("fragment: " + that.urlFragment()); } // fetch record details to be retrieved from the record queue that.fetchDetails = function(recId) { - log("fetchDetails() requesting record '" + recId + "'"); + that.info("fetchDetails() requesting record '" + recId + "'"); m_paz.record(recId); + that.warn("fragment: " + that.urlFragment()); }; @@ -367,20 +424,20 @@ mkws.makeTeam = function($, teamName) { // detailed record drawing that.showDetails = function(recId) { - var oldRecordId = m_currentRecordId; - m_currentRecordId = recId; + var oldRecordId = m_state.recid; + m_state.recid = recId; // remove current detailed view if any findnode('#' + recordDetailsId(oldRecordId)).remove(); // if the same clicked, just hide if (recId == oldRecordId) { - m_currentRecordId = ''; + m_state.recid = ''; m_currentRecordData = null; return; } // request the record - log("showDetails() requesting record '" + recId + "'"); + that.info("showDetails() requesting record '" + recId + "'"); m_paz.record(recId); }; @@ -397,7 +454,7 @@ mkws.makeTeam = function($, teamName) { } var node = $(selector); - //log('findnode(' + selector + ') found ' + node.length + ' nodes'); + //that.debug('findnode(' + selector + ') found ' + node.length + ' nodes'); return node; } @@ -418,7 +475,7 @@ mkws.makeTeam = function($, teamName) { that.registerTemplate = function(name, text) { if(mkws._old2new.hasOwnProperty(name)) { - mkws.log("Warning: registerTemplate old widget name: " + name + " => " + mkws._old2new[name]); + that.warn("registerTemplate: old widget name: " + name + " => " + mkws._old2new[name]); name = mkws._old2new[name]; } m_templateText[name] = text; @@ -427,7 +484,7 @@ mkws.makeTeam = function($, teamName) { function loadTemplate(name, fallbackString) { if(mkws._old2new.hasOwnProperty(name)) { - mkws.log("Warning loadTemplate: old widget name: " + name + " => " + mkws._old2new[name]); + that.warn("loadTemplate: old widget name: " + name + " => " + mkws._old2new[name]); name = mkws._old2new[name]; } @@ -442,7 +499,7 @@ mkws.makeTeam = function($, teamName) { if (!source) source = m_templateText[name]; if (source) { template = Handlebars.compile(source); - log("compiled template '" + name + "'"); + that.info("compiled template '" + name + "'"); } } //if (template === undefined) template = mkws_templatesbyteam[m_teamName][name]; @@ -457,7 +514,7 @@ mkws.makeTeam = function($, teamName) { return template; } else { - log("No MKWS template for " + name); + that.info("No MKWS template for " + name); return null; } } @@ -494,8 +551,7 @@ mkws.makeTeam = function($, teamName) { } } return undefined; - } - + }; return that; };