X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=src%2Fmkws-team.js;h=a76c65cbe92e126caabeaef6bf2a98eb3bbe17f2;hp=3c57c40efeda3524d90204cdfe64f6af6e1c75f1;hb=75cab62e7f2b58dd8a073ea40122a0fe862f9a58;hpb=0d598f74114780898759a49ba1bdb7bd1e88a6db diff --git a/src/mkws-team.js b/src/mkws-team.js index 3c57c40..a76c65c 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 = ''; @@ -27,56 +27,82 @@ function team($, teamName) { }; 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 + ']'; } + 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_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 +116,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 +129,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); } @@ -132,186 +160,144 @@ function team($, teamName) { function recordDetailsId(s) { return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_'); } - that.recordElementId = recordElementId; 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); - } + }; - that.pagerNext = function () { + that.pagerNext = function() { if (m_totalRecordCount - m_perpage*m_currentPage > 0) { m_paz.showNext(); m_currentPage++; } - } + }; - that.pagerPrev = function () { + that.pagerPrev = function() { if (m_paz.showPrev() != false) m_currentPage--; - } + }; 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': @@ -341,16 +327,12 @@ function team($, teamName) { // 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) { @@ -361,7 +343,7 @@ function team($, teamName) { // request the record log("showDetails() requesting record '" + recId + "'"); m_paz.record(recId); - } + }; /* @@ -370,13 +352,13 @@ function team($, teamName) { */ function mkwsHtmlAll() { mkwsSetLang(); - if (mkws_config.show_lang) + if (m_config.show_lang) mkwsHtmlLang(); log("HTML search form"); findnode('.mkwsSearch').html('\
\ - \ + \ \
'); @@ -410,11 +392,20 @@ function team($, teamName) { \ '); + var acc = []; + var facets = m_config.facets; + acc.push('
' + M('Termlists') + '
'); + for (var i = 0; i < facets.length; i++) { + acc.push('
'); + acc.push('
'); + } + findnode(".mkwsTermlists").html(acc.join('')); + var ranking_data = '
'; - 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 += '
'; @@ -423,13 +414,16 @@ function team($, teamName) { mkwsHtmlSwitch(); findnode('.mkwsSearchForm').submit(function() { - var val = findnode('.mkwsQuery').val(); + var val = widgetNode('Query').val(); newSearch(val); return false; }); // on first page, hide the termlist - $(document).ready(function() { findnode(".mkwsTermlists").hide(); }); + $(document).ready(function() { + var t = widgetNode("Termlists"); + if (t) t.hide(); + }); var container = findnode(".mkwsMOTDContainer"); if (container.length) { // Move the MOTD from the provided element down into the container @@ -439,26 +433,46 @@ function team($, teamName) { 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; } + // set or re-set "lang" URL parameter + function lang_url(lang) { + var query = location.search; + // no query parameters? done + if (!query) { + return "?lang=" + lang; + } + + // parameter does not exists + if (!query.match(/[\?&]lang=/)) { + return query + "&lang=" + lang; + } + + // replace existing parameter + query = query.replace(/\?lang=([^&#;]*)/, "?lang=" + lang); + query = query.replace(/\&lang=([^&#;]*)/, "&lang=" + lang); + return query; + } + + // dynamic URL or static page? /path/foo?query=test /* 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; @@ -486,7 +500,7 @@ function team($, teamName) { if (lang == l) { data += ' ' + l + ' '; } else { - data += ' ' + l + ' ' + data += ' ' + l + ' ' } } @@ -498,8 +512,8 @@ function team($, teamName) { log("HTML sort, m_sortOrder = '" + m_sortOrder + "'"); var sort_html = ''; - 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 += '