X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=2484229c192c98d2ece24c55325de40e6b007323;hb=72516b553876f01f55df93e0001fdfc4fc51b0aa;hp=95c3b7467da4a4ff18715f28ed60d454cea9910f;hpb=bbaad7fa6b2a2484c7bbdd87b50bd144ab5c1796;p=mkws-moved-to-github.git diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index 95c3b74..2484229 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -72,7 +72,7 @@ Handlebars.registerHelper('index1', function(obj) { // Set up global mkws object. Contains truly global state such as SP -// authentication, and a hash of team objects, indexed by windowid. +// authentication, and a hash of team objects, indexed by team-name. // var mkws = { authenticated: false, @@ -172,13 +172,15 @@ if (mkws_config == null || typeof mkws_config != 'object') { // Factory function for widget objects. -function widget($, team, node) { +function widget($, team, type, node) { var that = { team: team, + type: type, node: node }; - // ### More to do here, surely + // ### More to do here, surely: e.g. wiring into the team + mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node); return that; } @@ -226,22 +228,6 @@ function team($, teamName) { m_sort = mkws_config.sort_default; debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort"); - if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { - debug("Reset query width: " + mkws_config.query_width); - mkws_config.query_width = 50; - } - - for (var key in mkws_config) { - if (mkws_config.hasOwnProperty(key)) { - if (key.match(/^language_/)) { - var lang = key.replace(/^language_/, ""); - // Copy custom languages into list - mkws.locale_lang[lang] = mkws_config[key]; - debug("Added locally configured language '" + lang + "'"); - } - } - } - // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp" if (mkws_config.pazpar2_url.match(/^\/\//)) { mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url; @@ -252,44 +238,59 @@ function team($, teamName) { // 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({ "onshow": my_onshow, + m_paz = new pz2({ "onshow": onShow, "windowid": teamName, "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way "pazpar2path": mkws_config.pazpar2_url, - "oninit": my_oninit, - "onstat": my_onstat, - "onterm": (mkws_config.facets.length ? my_onterm : undefined), + "oninit": onInit, + "onstat": onStat, + "onterm": (mkws_config.facets.length ? onTerm : undefined), "termlist": mkws_config.facets.join(','), - "onbytarget": my_onbytarget, + "onbytarget": onBytarget, "usesessions" : mkws_config.use_service_proxy ? false : true, "showResponseType": '', // or "json" (for debugging?) - "onrecord": my_onrecord }); + "onrecord": onRecord }); if (!isNaN(parseInt(mkws_config.perpage_default))) { m_perpage = parseInt(mkws_config.perpage_default); } + // 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 = selector.split(',').map(function(s) { + return s + '.mkwsTeam_' + teamName; + }).join(','); + + return $(selector); + } + + // // pz2.js event handlers: // - function my_oninit(teamName) { + function onInit(teamName) { debug("init"); m_paz.stat(); m_paz.bytarget(); } - function my_onshow(data, teamName) { + function onShow(data, teamName) { debug("show"); m_totalRec = data.merged; - var pager = $(".mkwsPager.mkwsTeam_" + m_teamName); + var pager = findnode(".mkwsPager"); if (pager.length) { pager.html(drawPager(data)) } - var results = $(".mkwsRecords.mkwsTeam_" + m_teamName); + var results = findnode(".mkwsRecords"); if (!results.length) return; @@ -317,9 +318,9 @@ function team($, teamName) { } - function my_onstat(data, teamName) { + function onStat(data, teamName) { debug("stat"); - var stat = $('.mkwsStat.mkwsTeam_' + teamName); + var stat = findnode('.mkwsStat'); if (stat.length === 0) return; @@ -331,14 +332,14 @@ function team($, teamName) { } - function my_onterm(data, teamName) { + function onTerm(data, teamName) { debug("term"); - var node = $(".mkwsTermlists.mkwsTeam_" + teamName); + var node = findnode(".mkwsTermlists"); if (node.length == 0) return; // no facets: this should never happen if (!mkws_config.facets || mkws_config.facets.length == 0) { - alert("my_onterm called even though we have no facets: " + $.toJSON(data)); + alert("onTerm called even though we have no facets: " + $.toJSON(data)); node.hide(); return; } @@ -352,11 +353,11 @@ function team($, teamName) { for(var i = 0; i < facets.length; i++) { if (facets[i] == "xtargets") { - add_single_facet(acc, "Sources", data.xtargets, 16, null); + addSingleFacet(acc, "Sources", data.xtargets, 16, null); } else if (facets[i] == "subject") { - add_single_facet(acc, "Subjects", data.subject, 10, "subject"); + addSingleFacet(acc, "Subjects", data.subject, 10, "subject"); } else if (facets[i] == "author") { - add_single_facet(acc, "Authors", data.author, 10, "author"); + addSingleFacet(acc, "Authors", data.author, 10, "author"); } else { alert("bad facet configuration: '" + facets[i] + "'"); } @@ -366,7 +367,7 @@ function team($, teamName) { } - function add_single_facet(acc, caption, data, max, pzIndex) { + function addSingleFacet(acc, caption, data, max, pzIndex) { acc.push('
'); acc.push('
' + M(caption) + '
'); for (var i = 0; i < data.length && i < max; i++) { @@ -376,7 +377,7 @@ function team($, teamName) { if (!pzIndex) { // Special case: target selection acc.push('target_id='+data[i].id+' '); - if (!target_filtered(data[i].id)) { + if (!targetFiltered(data[i].id)) { action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)'; } } else { @@ -390,7 +391,7 @@ function team($, teamName) { } - function target_filtered(id) { + function targetFiltered(id) { for (var i = 0; i < m_filters.length; i++) { if (m_filters[i].id === id || m_filters[i].id === 'pz:id=' + id) { @@ -401,7 +402,7 @@ function team($, teamName) { } - function my_onrecord(data, args, teamName) { + function onRecord(data, args, teamName) { debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName); // FIXME: record is async!! clearTimeout(m_paz.recordTimer); @@ -415,9 +416,9 @@ function team($, teamName) { } - function my_onbytarget(data, teamName) { + function onBytarget(data, teamName) { debug("target"); - var targetDiv = $('.mkwsBytarget.mkwsTeam_' + teamName); + var targetDiv = findnode('.mkwsBytarget'); if (!targetDiv) { return; } @@ -449,16 +450,13 @@ function team($, teamName) { // when search button pressed function onFormSubmitEventHandler() { - mkws.handle_node_with_team(this, function (tname) { - var val = $('.mkwsQuery.mkwsTeam_' + tname).val(); - mkws.teams[tname].newSearch(val); - }); - + var val = findnode('.mkwsQuery').val(); + newSearch(val); return false; } - that.newSearch = function(query, sort, targets, windowid) + function newSearch(query, sort, targets) { debug("newSearch: " + query); @@ -468,11 +466,11 @@ function team($, teamName) { } m_filters = [] - redraw_navi(); + redrawNavi(); resetPage(); loadSelect(); - triggerSearch(query, sort, targets, windowid); - that.switchView('records'); // In case it's configured to start off as hidden + triggerSearch(query, sort, targets); + switchView('records'); // In case it's configured to start off as hidden m_submitted = true; } @@ -494,7 +492,7 @@ function team($, teamName) { } - function triggerSearch (query, sort, targets, windowid) + function triggerSearch (query, sort, targets) { var pp2filter = ""; var pp2limit = ""; @@ -507,7 +505,6 @@ function team($, teamName) { m_sort = sort; } if (targets) { - // ### should support multiple |-separated targets m_filters.push({ id: targets, name: targets }); } @@ -533,9 +530,7 @@ function team($, teamName) { if (pp2limit) { params.limit = pp2limit; } - if (windowid) { - params.windowid = windowid; - } + debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params)); // We can use: params.torusquery = "udb=NAME" @@ -546,12 +541,12 @@ function team($, teamName) { function loadSelect () { - var node = $('.mkwsSort.mkwsTeam_' + m_teamName); + var node = findnode('.mkwsSort'); if (node.length && node.val() != m_sort) { debug("changing m_sort from " + m_sort + " to " + node.val()); m_sort = node.val(); } - node = $('.mkwsPerpage.mkwsTeam_' + m_teamName); + node = findnode('.mkwsPerpage'); if (node.length && node.val() != m_perpage) { debug("changing m_perpage from " + m_perpage + " to " + node.val()); m_perpage = node.val(); @@ -564,7 +559,7 @@ function team($, teamName) { { debug("limitTarget(id=" + id + ", name=" + name + ")"); m_filters.push({ id: id, name: name }); - redraw_navi(); + redrawNavi(); resetPage(); loadSelect(); triggerSearch(); @@ -577,7 +572,7 @@ function team($, teamName) { { debug("limitQuery(field=" + field + ", value=" + value + ")"); m_filters.push({ field: field, value: value }); - redraw_navi(); + redrawNavi(); resetPage(); loadSelect(); triggerSearch(); @@ -600,7 +595,7 @@ function team($, teamName) { } m_filters = newFilters; - redraw_navi(); + redrawNavi(); resetPage(); loadSelect(); triggerSearch(); @@ -625,7 +620,7 @@ function team($, teamName) { } m_filters = newFilters; - redraw_navi(); + redrawNavi(); resetPage(); loadSelect(); triggerSearch(); @@ -633,9 +628,9 @@ function team($, teamName) { } - function redraw_navi () + function redrawNavi () { - var navi = $('.mkwsNavi.mkwsTeam_' + m_teamName); + var navi = findnode('.mkwsNavi'); if (!navi) return; var text = ""; @@ -735,11 +730,11 @@ function team($, teamName) { // switching view between targets and records - that.switchView = function(view) { - var targets = $('.mkwsTargets.mkwsTeam_' + m_teamName); - var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName); - var blanket = $('.mkwsBlanket.mkwsTeam_' + m_teamName); - var motd = $('.mkwsMOTD.mkwsTeam_' + m_teamName); + function switchView(view) { + var targets = findnode('.mkwsTargets'); + var results = findnode('.mkwsResults,.mkwsRecords'); + var blanket = findnode('.mkwsBlanket'); + var motd = findnode('.mkwsMOTD'); switch(view) { case 'targets': @@ -767,6 +762,9 @@ function team($, teamName) { } + that.switchView = switchView; + + // detailed record drawing that.showDetails = function (prefixRecId) { var recId = prefixRecId.replace('mkwsRec_', ''); @@ -805,9 +803,9 @@ function team($, teamName) { if (template === undefined) { // Fall back to generic template if there is no team-specific one - var node = $(".mkwsTemplate_" + name + ".mkwsTeam_" + m_teamName) + var node = findnode(".mkwsTemplate_" + name); if (!node.length) { - node = $(".mkwsTemplate_" + name + ".mkwsTeam_ALL") + node = findnode(".mkwsTemplate_" + name, "ALL"); } var source = node.html(); @@ -909,22 +907,18 @@ function team($, teamName) { * All the HTML stuff to render the search forms and * result pages. */ - function mkws_html_all() { - mkws_set_lang(); + function mkwsHtmlAll() { + mkwsSetLang(); if (mkws_config.show_lang) - mkws_html_lang(); + mkwsHtmlLang(); debug("HTML search form"); - // ### There is only one match here by design: fix not to bother looping - $('.mkwsSearch.mkwsTeam_' + m_teamName).each(function (i, obj) { - var node = this; - mkws.handle_node_with_team(node, function(tname) { - $(node).html('\ + mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) { + this.html('\
\ \ \
'); - }); }); debug("HTML records"); @@ -937,8 +931,8 @@ function team($, teamName) { // .mkwsPager // .mkwsNavi // .mkwsRecords - if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) { - $(".mkwsResults.mkwsTeam_" + m_teamName).html('\ + if (findnode(".mkwsResults").length) { + findnode(".mkwsResults").html('\ \ \
\ @@ -959,52 +953,38 @@ function team($, teamName) {
'); } - var node = $(".mkwsRanking.mkwsTeam_" + m_teamName); + var node = findnode(".mkwsRanking"); if (node.length) { var ranking_data = ''; ranking_data += '
'; if (mkws_config.show_sort) { - ranking_data += M('Sort by') + ' ' + mkws_html_sort() + ' '; + ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' '; } if (mkws_config.show_perpage) { - ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.'; + ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.'; } ranking_data += '
'; node.html(ranking_data); } - mkws_html_switch(); - - // ### Should not be in the team code, since window size is global - if (mkws_config.responsive_design_width) { - // Responsive web design - change layout on the fly based on - // current screen width. Required for mobile devices. - $(window).resize(function(e) { mkws.resize_page() }); - // initial check after page load - $(document).ready(function() { mkws.resize_page() }); - } - - $('.mkwsSearchForm.mkwsTeam_' + m_teamName).each(function (i, obj) { - debug("adding search-forms for team '" + m_teamName + "'"); - var node = this; - mkws.handle_node_with_team(node, function(tname) { - debug("adding search-form '" + tname + "' for team '" + m_teamName + "'"); - $(node).submit(onFormSubmitEventHandler); - }); - }); + mkwsHtmlSwitch(); - node = $('.mkwsSort.mkwsTeam_' + m_teamName); + var node; + node = findnode('.mkwsSearchForm'); + if (node.length) + node.submit(onFormSubmitEventHandler); + node = findnode('.mkwsSort'); if (node.length) node.change(onSelectDdChange); - node = $('.mkwsPerpage.mkwsTeam_' + m_teamName); + node = findnode('.mkwsPerpage'); if (node.length) node.change(onSelectDdChange); // on first page, hide the termlist - $(document).ready(function() { $(".mkwsTermlists.mkwsTeam_" + m_teamName).hide(); }); - var motd = $(".mkwsMOTD.mkwsTeam_" + m_teamName); - var container = $(".mkwsMOTDContainer.mkwsTeam_" + m_teamName); + $(document).ready(function() { findnode(".mkwsTermlists").hide(); }); + var motd = findnode(".mkwsMOTD"); + var container = findnode(".mkwsMOTDContainer"); if (motd.length && container.length) { // Move the MOTD from the provided element down into the container motd.appendTo(container); @@ -1025,7 +1005,7 @@ function team($, teamName) { } - function mkws_set_lang() { + function mkwsSetLang() { var lang = parseQuerystring().lang || mkws_config.lang; if (!lang || !mkws.locale_lang[lang]) { mkws_config.lang = "" @@ -1038,16 +1018,16 @@ function team($, teamName) { } - function mkws_html_switch() { + function mkwsHtmlSwitch() { debug("HTML switch for team " + m_teamName); - var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName); + var node = findnode(".mkwsSwitch"); node.append($('' + M('Records') + '')); node.append($("", { text: " | " })); node.append($('' + M('Targets') + '')); debug("HTML targets"); - var node = $(".mkwsTargets.mkwsTeam_" + m_teamName); + var node = findnode(".mkwsTargets"); node.html('\
\ No information available yet.\ @@ -1056,7 +1036,7 @@ function team($, teamName) { } - function mkws_html_sort() { + function mkwsHtmlSort() { debug("HTML sort, m_sort = '" + m_sort + "'"); var sort_html = ''; @@ -1097,7 +1077,7 @@ function team($, teamName) { /* create locale language menu */ - function mkws_html_lang() { + function mkwsHtmlLang() { var lang_default = "en"; var lang = mkws_config.lang || lang_default; var list = []; @@ -1135,13 +1115,13 @@ function team($, teamName) { } } - $(".mkwsLang.mkwsTeam_" + m_teamName).html(data); + findnode(".mkwsLang").html(data); } - that.run_auto_search = function() { + that.runAutoSearch = function() { // ### should check mkwsTermlist as well, for facet-only teams - var node = $('.mkwsRecords.mkwsTeam_' + m_teamName); + var node = findnode('.mkwsRecords'); var query = node.attr('autosearch'); if (!query) return; @@ -1172,12 +1152,13 @@ function team($, teamName) { if (targets) s += " in targets '" + targets + "'"; debug(s); - this.newSearch(query, sort, targets, m_teamName); + newSearch(query, sort, 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 + // ### should we unify this and parseQuerystring()? function getParameterByName(name) { name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]"); var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"), @@ -1201,7 +1182,7 @@ function team($, teamName) { // main (function() { try { - mkws_html_all() + mkwsHtmlAll() } catch (e) { @@ -1237,21 +1218,33 @@ function team($, teamName) { var debug = mkws.debug; - mkws.handle_node_with_team = function(node, callback) { - var classes = node.className; + mkws.handleNodeWithTeam = function(node, callback) { + // First branch for DOM objects; second branch for jQuery objects + var classes = node.className || node.attr('class'); + if (!classes) { + // For some reason, if we try to proceed when classes is + // undefined, we don't get an error message, but this + // function and its callers, up several stack level, + // silently return. What a crock. + mkws.debug("handleNodeWithTeam() called on node with no classes"); + return; + } var list = classes.split(/\s+/) - var tname; + var teamName, type; + for (var i = 0; i < list.length; i++) { var cname = list[i]; if (cname.match(/^mkwsTeam_/)) { - tname = cname.replace(/^mkwsTeam_/, ''); + teamName = cname.replace(/^mkwsTeam_/, ''); + } else if (cname.match(/^mkws/)) { + type = cname.replace(/^mkws/, ''); } } - callback.call(this, tname); + callback.call(node, teamName, type); } - mkws.resize_page = function () { + mkws.resizePage = function () { var list = ["mkwsSwitch", "mkwsLang"]; var width = mkws_config.responsive_design_width; @@ -1320,7 +1313,7 @@ function team($, teamName) { } - function default_mkws_config() { + function defaultMkwsConfig() { /* default mkws config */ var config_default = { use_service_proxy: true, @@ -1370,7 +1363,7 @@ function team($, teamName) { * The username/password is configured in the apache config file * for the site. */ - function authenticate_session(auth_url, auth_domain, pp2_url) { + function authenticateSession(auth_url, auth_domain, pp2_url) { debug("Run service proxy auth URL: " + auth_url); if (!auth_domain) { @@ -1396,29 +1389,53 @@ function team($, teamName) { debug("Service proxy auth successfully done"); mkws.authenticated = true; - run_auto_searches(); + runAutoSearches(); }); } - function run_auto_searches() { + function runAutoSearches() { debug("running auto searches"); for (var teamName in mkws.teams) { - mkws.teams[teamName].run_auto_search(); + mkws.teams[teamName].runAutoSearch(); } } $(document).ready(function() { debug("on load ready"); - default_mkws_config(); + defaultMkwsConfig(); + + if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { + debug("Reset query width: " + mkws_config.query_width); + mkws_config.query_width = 50; + } + + for (var key in mkws_config) { + if (mkws_config.hasOwnProperty(key)) { + if (key.match(/^language_/)) { + var lang = key.replace(/^language_/, ""); + // Copy custom languages into list + mkws.locale_lang[lang] = mkws_config[key]; + debug("Added locally configured language '" + lang + "'"); + } + } + } + + if (mkws_config.responsive_design_width) { + // Responsive web design - change layout on the fly based on + // current screen width. Required for mobile devices. + $(window).resize(function(e) { mkws.resizePage() }); + // initial check after page load + $(document).ready(function() { mkws.resizePage() }); + } // Backwards compatibility: set new magic class names on any // elements that have the old magic IDs. var ids = [ "Switch", "Lang", "Search", "Pager", "Navi", "Results", "Records", "Targets", "Ranking", - "Termlists", "Stat" ]; + "Termlists", "Stat", "MOTD" ]; for (var i = 0; i < ids.length; i++) { var id = 'mkws' + ids[i]; var node = $('#' + id); @@ -1441,25 +1458,25 @@ function team($, teamName) { // the mkwsTeam_* class. Make all team objects. var then = $.now(); $('[class^="mkws"],[class*=" mkws"]').each(function () { - mkws.handle_node_with_team(this, function(tname) { + mkws.handleNodeWithTeam(this, function(tname, type) { if (!mkws.teams[tname]) { mkws.teams[tname] = team(j, tname); debug("Made MKWS team '" + tname + "'"); } - var myTeam = mkws.teams[tname] - var myWidget = widget(j, myTeam, this) + var myTeam = mkws.teams[tname]; + var myWidget = widget(j, myTeam, type, this); }); }); var now = $.now(); debug("Walking MKWS nodes took " + (now-then) + " ms"); if (mkws_config.use_service_proxy) { - authenticate_session(mkws_config.service_proxy_auth, - mkws_config.service_proxy_auth_domain, - mkws_config.pazpar2_url); + authenticateSession(mkws_config.service_proxy_auth, + mkws_config.service_proxy_auth_domain, + mkws_config.pazpar2_url); } else { // raw pp2 - run_auto_searches(); + runAutoSearches(); } }); })(jQuery);