X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=src%2Fmkws-team.js;h=4e91fce55e69641c813970d1a3e29b1ada3b6254;hp=7c95c86a36c55c121c55ccc92cdc400a1f45e183;hb=ca8a466132753c8239f41680cb21edee8c7f4262;hpb=6030b5f69deeebd240fba34de5a7666461179c4f diff --git a/src/mkws-team.js b/src/mkws-team.js index 7c95c86..4e91fce 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,21 +26,23 @@ 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 object + 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 @@ -163,63 +165,53 @@ 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) { 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) { 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.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.delimitTarget = function(id) { log("delimitTarget(id=" + id + ")"); - removeMatchingFilters(function(f) { return f.id }); - triggerSearch(); + m_filterSet.removeMatching(function(f) { return f.type === 'target' }); + if (m_query) 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(); + m_filterSet.removeMatching(function(f) { return f.type == 'field' && + field == f.field && value == f.value }); + if (m_query) 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.showPage = function(pageNum) { m_currentPage = pageNum; m_paz.showPage(m_currentPage - 1); @@ -261,7 +253,7 @@ function team($, teamName) { return; } - m_filters = [] + 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; @@ -273,59 +265,31 @@ function team($, teamName) { 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, '\\$&'); - } - } + 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 (maxrecs) { - params.maxrecs = maxrecs; - } + 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) + ", " + + 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); } @@ -339,23 +303,16 @@ function team($, teamName) { 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'); + if (targets) $(targets).show(); + if (results) $(results).hide(); + if (blanket) $(blanket).hide(); + if (motd) $(motd).hide(); 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'); + if (targets) $(targets).hide(); + if (results) $(results).show(); + if (blanket) $(blanket).show(); + if (motd) $(motd).hide(); break; default: alert("Unknown view '" + view + "'"); @@ -384,244 +341,23 @@ function team($, teamName) { }; - /* - * 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('\ -\ - \ - \ - \ - \ - \ - \ - \ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
'); - - 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 (m_config.show_sort) { - ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' '; - } - if (m_config.show_perpage) { - ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.'; - } - ranking_data += '
'; - findnode(".mkwsRanking").html(ranking_data); - - mkwsHtmlSwitch(); - - findnode('.mkwsSearchForm').submit(function() { - var val = widgetNode('Query').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 = mkws.getParameterByName("lang") || m_config.lang; - if (!lang || !mkws.locale_lang[lang]) { - m_config.lang = "" - } else { - m_config.lang = 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 = m_config.lang || lang_default; - var list = []; - - /* display a list of configured languages, or all */ - var lang_options = m_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"); - } - - - // 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 = m_config.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 - - // 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) { - if (teamName === 'AUTO') { - return (s + '.mkwsTeam_' + teamName + ',' + - s + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])'); - } else { - 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'); return node; } - that.findnode = findnode; - // This much simpler and more efficient function should be usable - // in place of most uses of findnode. function widgetNode(type) { var w = that.widget(type); return w ? $(w.node) : undefined; @@ -636,19 +372,30 @@ function team($, teamName) { that.renderDetails = renderDetails; + 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); @@ -661,118 +408,49 @@ function team($, teamName) { that.loadTemplate = loadTemplate; - function defaultTemplate(name) { - if (name === 'Record') { - return '\ -\ - \ - \ - \ - \ - {{#if md-date}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if md-author}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if md-electronic-url}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if-any location having="md-subject"}}\ - \ - \ - \ - \ - {{/if-any}}\ - \ - \ - \ - \ -
{{translate "Title"}}\ - {{md-title}}\ - {{#if md-title-remainder}}\ - ({{md-title-remainder}})\ - {{/if}}\ - {{#if md-title-responsibility}}\ - {{md-title-responsibility}}\ - {{/if}}\ -
{{translate "Date"}}{{md-date}}
{{translate "Author"}}{{md-author}}
{{translate "Links"}}\ - {{#each md-electronic-url}}\ - Link{{index1}}\ - {{/each}}\ -
{{translate "Subject"}}\ - {{#first location having="md-subject"}}\ - {{#if md-subject}}\ - {{#commaList md-subject}}\ - {{this}}{{/commaList}}\ - {{/if}}\ - {{/first}}\ -
{{translate "Locations"}}\ - {{#commaList location}}\ - {{attr "@name"}}{{/commaList}}\ -
\ -'; - } else if (name === "Summary") { - return '\ -\ - {{md-title}}\ -\ -{{#if md-title-remainder}}\ - {{md-title-remainder}}\ -{{/if}}\ -{{#if md-title-responsibility}}\ - {{md-title-responsibility}}\ -{{/if}}\ -'; - } else if (name === "Image") { - return '\ - \ - {{#first md-thumburl}}\ - {{../md-title}}\ - {{/first}}\ -
\ -
\ -'; - } - - var s = "There is no default '" + name +"' template!"; - alert(s); - return s; - } - that.addWidget = function(w) { - if (!m_widgets[w.type]) { - m_widgets[w.type] = w; - 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 + "'"); + if (m_widgets[w.type] === undefined) { + m_widgets[w.type] = [ w ]; + log("Added '" + w.type + "' widget to team '" + m_teamName + "'"); } else { - m_widgets[w.type] += 1; - log("Registered '" + w.type + "' widget #" + m_widgets[w.type] + "' in team '" + m_teamName + "'"); + m_widgets[w.type].push(w); + log("Added '" + w.type + "' widget #" + m_widgets[w.type].length + "' to team '" + m_teamName + "'"); + } + } + + that.widget = function(type) { + var list = m_widgets[type]; + + if (!list) + return undefined; + if (list.length > 1) { + alert("widget('" + type + "') finds " + list.length + " widgets: using first"); } + return list[0]; } - that.widgetTypes = function() { - var keys = []; - for (var k in m_widgets) keys.push(k); - return keys.sort(); + that.visitWidgets = function(callback) { + for (var type in m_widgets) { + var list = m_widgets[type]; + for (var i = 0; i < list.length; i++) { + var res = callback(type, list[i]); + if (res !== undefined) { + return res; + } + } + } + return undefined; } - that.widget = function(type) { - return m_widgets[type]; + + var lang = mkws.getParameterByName("lang") || mkws.config.lang; + if (!lang || !mkws.locale_lang[lang]) { + mkws.config.lang = "" + } else { + mkws.config.lang = lang; } - mkwsHtmlAll() + log("Locale language: " + (mkws.config.lang ? mkws.config.lang : "none")); return that; };