X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=0a0f6321d24769baf9232b6034b31a8e9f10027f;hp=a96fd32fd08fb9b71bf8e0700ad5a7a4cd123dae;hb=cab59791c1404a649cd64c40d9fdccd27a8fbed4;hpb=23efd7251999817caf5e29ee9361e17c4b417dff diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index a96fd32..0a0f632 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -65,13 +65,19 @@ Handlebars.registerHelper('commaList', function(items, options) { }); +Handlebars.registerHelper('index1', function(obj) { + return obj.data.index + 1; +}); + + // Set up global mkws object. Contains truly global state such as SP // authentication, and a hash of team objects, indexed by windowid. // var mkws = { authenticated: false, - debug_level: undefined, // will be initialised from mkws_config + debug_level: 1, // Will be overridden from mkws_config, but + // initial value allows jQuery popup to use logging. paz: undefined, // will be set up during initialisation teams: {}, locale_lang: { @@ -136,12 +142,50 @@ var mkws = { }; +// The following PubSub code is modified from the jQuery manual: +// https://api.jquery.com/jQuery.Callbacks/ +// +// Use as: +// mkws.queue("eventName").subscribe(function(param1, param2 ...) { ... }); +// mkws.queue("eventName").publish(arg1, arg2, ...); + +(function() { + var queues = {}; + mkws.queue = function(id) { + if (!queues[id]) { + var callbacks = $.Callbacks(); + queues[id] = { + publish: callbacks.fire, + subscribe: callbacks.add, + unsubscribe: callbacks.remove + }; + } + return queues[id]; + } +}()); + + // Define empty mkws_config for simple applications that don't define it. if (mkws_config == null || typeof mkws_config != 'object') { var mkws_config = {}; } +// Factory function for widget objects. +function widget($, team, type, node) { + var that = { + team: team, + type: type, + node: node + }; + + // ### More to do here, surely: e.g. wiring into the team + mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node); + + return that; +} + + // Factory function for team objects. As much as possible, this uses // only member variables (prefixed "m_") and inner functions with // private scope. Some functions are visibl as member-functions to be @@ -168,6 +212,7 @@ function team($, teamName) { "last": $.now() }; var m_paz; // will be initialised below + var m_template = {}; var debug = function (s) { @@ -183,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; @@ -227,6 +256,21 @@ function team($, teamName) { } + // 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: // @@ -241,12 +285,12 @@ function team($, 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; @@ -276,7 +320,7 @@ function team($, teamName) { function my_onstat(data, teamName) { debug("stat"); - var stat = $('.mkwsStat.mkwsTeam_' + teamName); + var stat = findnode('.mkwsStat'); if (stat.length === 0) return; @@ -290,7 +334,7 @@ function team($, teamName) { function my_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 @@ -329,11 +373,13 @@ function team($, teamName) { for (var i = 0; i < data.length && i < max; i++) { acc.push('
'); acc.push('{{this}}
\ + Link{{index1}}\ {{/each}}\ \ \ @@ -805,7 +873,8 @@ function team($, teamName) { \ {{#first location having="md-subject"}}\ {{#if md-subject}}\ - {{md-subject}}\ + {{#commaList md-subject}}\ + {{this}}{{/commaList}}\ {{/if}}\ {{/first}}\ \ @@ -844,24 +913,19 @@ function team($, teamName) { * All the HTML stuff to render the search forms and * result pages. */ + // ### This and other multi-word identifiers should be camelCase function mkws_html_all() { mkws_set_lang(); if (mkws_config.show_lang) mkws_html_lang(); - // For some reason, doing this programmatically results in - // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML. 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.handle_node_with_team(findnode('.mkwsSearch'), function(tname) { + this.html('\
\ - \ - \ + \ + \
'); - }); }); debug("HTML records"); @@ -874,18 +938,18 @@ function team($, teamName) { // .mkwsPager // .mkwsNavi // .mkwsRecords - if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) { - $(".mkwsResults.mkwsTeam_" + m_teamName).html('\ + if (findnode(".mkwsResults").length) { + findnode(".mkwsResults").html('\ \ \ \ \ \ \ @@ -896,7 +960,7 @@ function team($, teamName) {
\ -
\ +
\ 		\ -
\ -
\ -
\ -
\ +
\ +
\ +
\ +
\
'); } - var node = $(".mkwsRanking.mkwsTeam_" + m_teamName); + var node = findnode(".mkwsRanking"); if (node.length) { var ranking_data = ''; ranking_data += '
'; @@ -922,26 +986,21 @@ function team($, teamName) { $(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); - }); - }); - - 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); @@ -978,13 +1037,13 @@ function team($, teamName) { function mkws_html_switch() { 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.\ @@ -1072,7 +1131,55 @@ function team($, teamName) { } } - $(".mkwsLang.mkwsTeam_" + m_teamName).html(data); + findnode(".mkwsLang").html(data); + } + + + that.run_auto_search = function() { + // ### should check mkwsTermlist as well, for facet-only teams + var node = findnode('.mkwsRecords'); + var query = node.attr('autosearch'); + if (!query) + return; + + if (query.match(/^!param!/)) { + var param = query.replace(/^!param!/, ''); + query = getParameterByName(param); + debug("obtained query '" + query + "' from param '" + param + "'"); + if (!query) { + alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter"); + } + } else if (query.match(/^!path!/)) { + var index = query.replace(/^!path!/, ''); + var path = window.location.pathname.split('/'); + query = path[path.length - index]; + debug("obtained query '" + query + "' from path-component '" + index + "'"); + if (!query) { + alert("This page has a MasterKey widget that needs a query specified by the path-component " + index); + } + } + + debug("node=" + node + ", class='" + node.className + "', query=" + query); + + var sort = node.attr('sort'); + var targets = node.attr('targets'); + var s = "running auto search: '" + query + "'"; + if (sort) s += " sorted by '" + sort + "'"; + if (targets) s += " in targets '" + targets + "'"; + debug(s); + + newSearch(query, sort, targets, m_teamName); + } + + + // 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 + "=([^&#]*)"), + results = regex.exec(location.search); + return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " ")); } @@ -1106,141 +1213,6 @@ function team($, teamName) { }; -/* - * implement jQuery plugin $.pazpar2({}) - */ -function _mkws_jquery_plugin ($) { - function debug (string) { - mkws.debug("jquery.pazpar2: " + string); - } - - function init_popup(obj) { - var config = obj ? obj : {}; - - var height = config.height || 760; - var width = config.width || 880; - var id_button = config.id_button || "input#mkwsButton"; - var id_popup = config.id_popup || "#mkwsPopup"; - - debug("popup height: " + height + ", width: " + width); - - // make sure that jquery-ui was loaded afte jQuery core lib, e.g.: - // - if (!$.ui) { - debug("Error: jquery-ui.js is missing, did you include it after jQuery core in the HTML file?"); - return; - } - - $(id_popup).dialog({ - closeOnEscape: true, - autoOpen: false, - height: height, - width: width, - modal: true, - resizable: true, - buttons: { - Cancel: function() { - $(this).dialog("close"); - } - }, - close: function() { } - }); - - $(id_button) - .button() - .click(function() { - $(id_popup).dialog("open"); - }); - }; - - $.extend({ - - // service-proxy or pazpar2 - pazpar2: function(config) { - var id_popup = config.id_popup || "#mkwsPopup"; - id_popup = id_popup.replace(/^#/, ""); - - // simple layout - var div = '\ -
\ -
\ -
\ -
\ -
\ -
'; - - // new table layout - var table = '\ -\ - \ -\ - \ - \ - \ - \ - \ - \ - \ - \ - \ - \ - \ - \ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
'; - - var popup = '\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
' - - if (config && config.layout == 'div') { - debug("jquery plugin layout: div"); - document.write(div); - } else if (config && config.layout == 'popup') { - debug("jquery plugin layout: popup with id: " + id_popup); - document.write(popup); - $(document).ready(function() { init_popup(config); }); - } else { - debug("jquery plugin layout: table"); - document.write(table); - } - } - }); -}; - - // wrapper to call team() after page load (function (j) { mkws.debug = function (string) { @@ -1262,21 +1234,29 @@ function _mkws_jquery_plugin ($) { var debug = mkws.debug; - // enable before page load, so we could call it before mkws() runs - _mkws_jquery_plugin(j); - - mkws.handle_node_with_team = function(node, callback) { - var classes = node.className; + // 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("handle_node_with_team() 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(tname); + callback.call(node, teamName, type); } @@ -1434,23 +1414,7 @@ function _mkws_jquery_plugin ($) { debug("running auto searches"); for (var teamName in mkws.teams) { - // ### should check mkwsTermlist as well, for facet-only teams - var node = $('.mkwsRecords.mkwsTeam_' + teamName); - var query = node.attr('autosearch'); - debug("teamName '" + teamName + "', node=" + node + ", class='" + node.className + "', query=" + query); - - if (query) { - var sort = node.attr('sort'); - var targets = node.attr('targets'); - var s = "running auto search: '" + query + "'"; - if (teamName) s += " [teamName '" + teamName + "']"; - if (sort) s += " sorted by '" + sort + "'"; - if (targets) s += " in targets '" + targets + "'"; - debug(s); - var team = mkws.teams[teamName]; - debug($.toJSON(team)); - team.newSearch(query, sort, targets, teamName); - } + mkws.teams[teamName].run_auto_search(); } } @@ -1459,11 +1423,27 @@ function _mkws_jquery_plugin ($) { debug("on load ready"); default_mkws_config(); + 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 + "'"); + } + } + } + // 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); @@ -1484,15 +1464,19 @@ function _mkws_jquery_plugin ($) { // Find all nodes with an class, and determine their team from // the mkwsTeam_* class. Make all team objects. + var then = $.now(); $('[class^="mkws"],[class*=" mkws"]').each(function () { - var node = this; - mkws.handle_node_with_team(node, function(tname) { + mkws.handle_node_with_team(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, 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,