X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-core.js;h=ca9a9f0651a3c9cc9b1af19be2c3b1f7d62ba26f;hb=84c68ae79ab0de97763320397b93c5ea14051370;hp=08bedf05e9f38a0fa0797f51a9abc1521c49bc2e;hpb=4f4e9e48d00fe5b92a9b873e5ca5d955ad9ee248;p=mkws-moved-to-github.git diff --git a/src/mkws-core.js b/src/mkws-core.js index 08bedf0..ca9a9f0 100644 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@ -9,9 +9,12 @@ // Set up global mkws object. Contains truly global state such as SP // authentication, and a hash of team objects, indexed by team-name. // -var mkws = { +// We set it as a property of window to make the global explicit as +// some things complain about an implicit global. +window.mkws = { $: $, // Our own local copy of the jQuery object authenticated: false, + active: false, log_level: 1, // Will be overridden from mkws.config, but // initial value allows jQuery popup to use logging. teams: {}, @@ -78,6 +81,12 @@ var mkws = { } }; +// We may be using a separate copy +if (typeof(mkws_jQuery) !== "undefined") { + mkws.$ = mkws_jQuery; +} else { + mkws.$ = jQuery; +} mkws.log = function(string) { if (!mkws.log_level) @@ -98,6 +107,24 @@ mkws.log = function(string) { }; +// Incredible that the standard JavaScript runtime doesn't define a +// unique windowId. Instead, we have to make one up. And since there's +// no global area shared between windows, the best we can do for +// ensuring uniqueness is generating a random ID and crossing our +// fingers. We stash this in window.name, as it's the only place to +// keep data that is preserved across reloads and within-site +// navigation. pz2.js picks this up and uses it as part of the +// cookie-name, to ensure each tab gets its own session. +if (window.name) { + mkws.log("Using existing window.name '" + window.name + "'"); +} else { + // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations. + // At one per second, it will take 116 million years to duplicate a session + window.name = Math.random().toString(36).slice(2, 12); + mkws.log("Generated new window.name '" + window.name + "'"); +} + + // Translation function. mkws.M = function(word) { var lang = mkws.config.lang; @@ -139,8 +166,12 @@ mkws.setMkwsConfig = function(overrides) { var config_default = { use_service_proxy: true, - pazpar2_url: "//mkws.indexdata.com/service-proxy/", - service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth", + pazpar2_url: "//mkws.indexdata.com/service-proxy/", + service_proxy_auth: undefined, // generally rolled from the next three properties + // Was: //mkws.indexdata.com/service-proxy-auth + pp2_hostname: "mkws.indexdata.com", + sp_path: "service-proxy-auth", + credentials: undefined, lang: "", sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], perpage_options: [10, 20, 30, 50], @@ -249,6 +280,14 @@ mkws.defaultTemplate = function(name) { {{#if md-title-responsibility}}\ {{md-title-responsibility}}\ {{/if}}\ +{{#if md-date}}, {{md-date}}\ +{{#if location}}\ +, {{#mkws-first location}}{{mkws-attr "@name"}}{{/mkws-first}}\ +{{/if}}\ +{{#if md-medium}}\ +, {{md-medium}}\ +{{/if}}\ +{{/if}}\ '; } else if (name === "Image") { return '\ @@ -270,9 +309,7 @@ onclick="mkws.{{fn}}(\'{{team}}\', \'{{field}}\', \'{{term}}\');return false;"\ '; } - var s = "There is no default '" + name +"' template!"; - alert(s); - return s; + return null; }; @@ -347,7 +384,26 @@ mkws.pagerNext = function(tname) { } } - if (!teamName) teamName = "AUTO"; + // Widgets without a team are on team "AUTO" + if (!teamName) { + teamName = "AUTO"; + // Autosearch widgets don't join team AUTO if there is already an + // autosearch on the team or the team has otherwise gotten a query + if (node.hasAttribute("autosearch")) { + if (mkws.autoHasAuto || + mkws.teams["AUTO"] && mkws.teams["AUTO"].config["query"]) { + log("AUTO team already has a query, using unique team"); + teamName = "UNIQUE"; + } + mkws.autoHasAuto = true; + } + } + + // Widgets on team "UNIQUE" get a random team + if (teamName === "UNIQUE") { + teamName = Math.floor(Math.random() * 100000000).toString(); + } + callback.call(node, teamName, type); } @@ -407,12 +463,13 @@ mkws.pagerNext = function(tname) { request.get(null, function(data) { if (!$.isXMLDoc(data)) { - alert("service proxy auth response document is not valid XML document, give up!"); + alert("Service Proxy authentication response is not a valid XML document"); return; } var status = $(data).find("status"); if (status.text() != "OK") { - alert("service proxy auth response status: " + status.text() + ", give up!"); + var message = $(data).find("message"); + alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")"); return; } @@ -468,7 +525,11 @@ mkws.pagerNext = function(tname) { function makeWidgetsWithin(level, node) { - node.find(selectorForAllWidgets()).each(function() { + if (node) var widgetNodes = node.find(selectorForAllWidgets()); + else widgetNodes = $(selectorForAllWidgets()); + // Return false if we parse no widgets + if (widgetNodes.length < 1) return false; + widgetNodes.each(function() { handleNodeWithTeam(this, function(tname, type) { var myTeam = mkws.teams[tname]; if (!myTeam) { @@ -486,60 +547,20 @@ mkws.pagerNext = function(tname) { } }); }); + return true; } - function init(rootsel) { - if (!rootsel) var rootsel = ':root'; - var saved_config; - if (typeof mkws_config === 'undefined') { - log("setting empty config"); - saved_config = {}; - } else { - log("using config: " + $.toJSON(mkws_config)); - saved_config = mkws_config; - } - mkws.setMkwsConfig(saved_config); - - 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]; - log("added locally configured language '" + lang + "'"); - } - } - } - - var lang = mkws.getParameterByName("lang") || mkws.config.lang; - if (!lang || !mkws.locale_lang[lang]) { - mkws.config.lang = "" - } else { - mkws.config.lang = lang; - } - - log("using language: " + (mkws.config.lang ? mkws.config.lang : "none")); - - if (mkws.config.query_width < 5 || mkws.config.query_width > 150) { - log("reset query width to " + mkws.config.query_width); - mkws.config.query_width = 50; - } - - // 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; - log("adjusted protocol independent link to " + mkws.config.pazpar2_url); - } - - 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(resizePage); - // initial check after page load - $(document).ready(resizePage); - } + // This function should have no side effects if run again on an operating session, even if + // the element/selector passed causes existing widgets to be reparsed: + // + // * configuration is not regenerated + // * authentication is not performed again + // * autosearches are not re-run + mkws.init = function(message, rootsel) { + if (message) mkws.log(message); + // TODO: Let's remove this soon // Backwards compatibility: set new magic class names on any // elements that have the old magic IDs. var ids = [ "Switch", "Lang", "Search", "Pager", "Navi", @@ -554,8 +575,71 @@ mkws.pagerNext = function(tname) { } } + // MKWS is not active until init() has been run against an object with widget nodes. + // We only set initial configuration when MKWS is first activated. + if (!mkws.isActive) { + var widgetSelector = selectorForAllWidgets(); + if ($(widgetSelector).length < 1) { + mkws.log("no widgets found"); + return; + } + + // Initial configuration + mkws.autoHasAuto = false; + var saved_config; + if (typeof mkws_config === 'undefined') { + log("setting empty config"); + saved_config = {}; + } else { + log("using config: " + $.toJSON(mkws_config)); + saved_config = mkws_config; + } + mkws.setMkwsConfig(saved_config); + + 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]; + log("added locally configured language '" + lang + "'"); + } + } + } + + var lang = mkws.getParameterByName("lang") || mkws.config.lang; + if (!lang || !mkws.locale_lang[lang]) { + mkws.config.lang = "" + } else { + mkws.config.lang = lang; + } + + log("using language: " + (mkws.config.lang ? mkws.config.lang : "none")); + + if (mkws.config.query_width < 5 || mkws.config.query_width > 150) { + log("reset query width to " + mkws.config.query_width); + mkws.config.query_width = 50; + } + + // 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; + log("adjusted protocol independent link to " + mkws.config.pazpar2_url); + } + + 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(resizePage); + // initial check after page load + $(document).ready(resizePage); + } + } + var then = $.now(); - makeWidgetsWithin(1, $(rootsel)); + // If we've made no widgets, return without starting an SP session + // or marking MKWS active. + if (makeWidgetsWithin(1, rootsel) === false) return false; var now = $.now(); log("walking MKWS nodes took " + (now-then) + " ms"); @@ -570,17 +654,43 @@ mkws.pagerNext = function(tname) { } */ + function sp_auth_url(config) { + if (config.service_proxy_auth) { + mkws.log("using pre-baked sp_auth_url '" + config.service_proxy_auth + "'"); + return config.service_proxy_auth; + } else { + var s = '//'; + s += config.auth_hostname ? config.auth_hostname : config.pp2_hostname; + s += '/' + config.sp_path + '?command=auth&action=perconfig'; + var c = config.credentials; + if (c) { + if (c) { + s += ('&username=' + c.substr(0, c.indexOf('/')) + + '&password=' + c.substr(c.indexOf('/')+1)); + } + } + mkws.log("generated sp_auth_url '" + s + "'"); + return s; + } + } + if (mkws.config.use_service_proxy) { - authenticateSession(mkws.config.service_proxy_auth, - mkws.config.service_proxy_auth_domain, - mkws.config.pazpar2_url); + if (!mkws.authenticated) { + authenticateSession(sp_auth_url(mkws.config), + mkws.config.service_proxy_auth_domain, + mkws.config.pazpar2_url); + } } else { // raw pp2 runAutoSearches(); } + + mkws.isActive = true; + return true; }; + $(document).ready(function() { - var widgetSelector = selectorForAllWidgets(); - if (widgetSelector && $(widgetSelector).length !== 0) init(); + mkws.init(); }); -})(jQuery); + +})(mkws.$);