X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-core.js;h=73f2b8db206fd74be30abddd0df38755ab63e71d;hb=6ec745d7d8ac73996838bf3e2c2c8b124cbaf31f;hp=98d32c0121e131c994bd741f59b25e44740f726e;hpb=d287f4680ff3ed663ccc5c01a7065713e9c52c84;p=mkws-moved-to-github.git diff --git a/src/mkws-core.js b/src/mkws-core.js index 98d32c0..73f2b8d 100644 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@ -14,6 +14,7 @@ window.mkws = { $: $, // Our own local copy of the jQuery object authenticated: false, + authenticating: false, active: false, log_level: 1, // Will be overridden from mkws.config, but // initial value allows jQuery popup to use logging. @@ -108,24 +109,6 @@ 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; @@ -167,8 +150,13 @@ 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: undefined, + pp2_hostname: "sp-mkws.indexdata.com", + pp2_path: "service-proxy", + service_proxy_auth: undefined, + sp_auth_path: "service-proxy/", + sp_auth_query: "command=auth&action=perconfig", + sp_auth_credentials: "XXX/XXX", // Should be undefined: see bug MKSP-125. lang: "", sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], perpage_options: [10, 20, 30, 50], @@ -251,6 +239,50 @@ mkws.pagerNext = function(tname) { }; +mkws.pazpar2_url = function() { + if (mkws.config.pazpar2_url) { + mkws.log("using pre-baked pazpar2_url '" + mkws.config.pazpar2_url + "'"); + return mkws.config.pazpar2_url; + } else { + var s = document.location.protocol + "//" + mkws.config.pp2_hostname + "/" + mkws.config.pp2_path + "/"; + mkws.log("generated pazpar2_url '" + s + "'"); + return s; + } +}; + + +// We put a session token 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 we get a new session when we need one. +// +// We want to use different sessions for different windows/tabs (so +// they don't receive each other's messages), different hosts and +// different paths on a host (since in general these will +// authenticate as different libraries). So the window name needs to +// include the hostname and the path from the URL, plus the token. +// +var token; +if (window.name) { + token = window.name.replace(/.*\//, ''); + mkws.log("Reusing existing window token '" + token + "'"); +} else { + // 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. + // + // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations. + // At one per second, it will take 116 million years to duplicate a token + token = Math.random().toString(36).slice(2, 12); + mkws.log("Generated new window token '" + token + "'"); +} + +window.name = window.location.hostname + window.location.pathname + '/' + token; +mkws.log("Using window.name '" + window.name + "'"); + + // wrapper to provide local copy of the jQuery object. (function($) { var log = mkws.log; @@ -343,6 +375,7 @@ mkws.pagerNext = function(tname) { * for the site. */ function authenticateSession(auth_url, auth_domain, pp2_url) { + mkws.authenticating = true; log("service proxy authentication on URL: " + auth_url); if (!auth_domain) { @@ -356,6 +389,7 @@ mkws.pagerNext = function(tname) { }, auth_domain); request.get(null, function(data) { + mkws.authenticating = false; if (!$.isXMLDoc(data)) { alert("Service Proxy authentication response is not a valid XML document"); return; @@ -445,29 +479,23 @@ mkws.pagerNext = function(tname) { } - // 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: + // The second "rootsel" parameter is passed to jQuery and is a DOM node + // or a selector string you would like to constrain the search for widgets to. + // + // This function has no side effects if run again on an operating session, + // even if the element/selector passed causes existing widgets to be reparsed: + // + // (TODO: that last bit isn't true and we currently have to avoid reinitialising + // widgets, MKWS-261) // // * 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", - "Results", "Records", "Targets", "Ranking", - "Termlists", "Stat", "MOTD" ]; - for (var i = 0; i < ids.length; i++) { - var id = 'mkws' + ids[i]; - var node = $('#' + id); - if (node.attr('id')) { - node.addClass(id); - log("added magic class to '" + node.attr('id') + "'"); - } - } + var greet = "MKWS initialised"; + if (rootsel) greet += " (limited to " + rootsel + ")" + if (message) greet += " :: " + message; + mkws.log(greet); // 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. @@ -516,9 +544,9 @@ mkws.pagerNext = function(tname) { } // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp" - if (mkws.config.pazpar2_url.match(/^\/\//)) { + if (mkws.pazpar2_url().match(/^\/\//)) { mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url; - log("adjusted protocol independent link to " + mkws.config.pazpar2_url); + log("adjusted protocol independent link to " + mkws.pazpar2_url()); } if (mkws.config.responsive_design_width) { @@ -533,7 +561,9 @@ mkws.pagerNext = function(tname) { var then = $.now(); // If we've made no widgets, return without starting an SP session // or marking MKWS active. - if (makeWidgetsWithin(1, rootsel) === false) return false; + if (makeWidgetsWithin(1, rootsel ? $(rootsel) : undefined) === false) { + return false; + } var now = $.now(); log("walking MKWS nodes took " + (now-then) + " ms"); @@ -548,11 +578,33 @@ mkws.pagerNext = function(tname) { } */ - if (mkws.config.use_service_proxy && !mkws.authenticated) { - authenticateSession(mkws.config.service_proxy_auth, + 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_auth_path; + var q = config.sp_auth_query; + if (q) { + s += '?' + q; + } + var c = config.sp_auth_credentials; + 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 && !mkws.authenticated && !mkws.authenticating) { + authenticateSession(sp_auth_url(mkws.config), mkws.config.service_proxy_auth_domain, - mkws.config.pazpar2_url); - } else { + mkws.pazpar2_url()); + } else if (!mkws.authenticating) { // raw pp2 or we have a session already open runAutoSearches(); } @@ -562,7 +614,9 @@ mkws.pagerNext = function(tname) { }; $(document).ready(function() { - mkws.init(); + if (!window.mkws_noready && !mkws.authenticating && !mkws.active) { + mkws.init(); + } }); })(mkws.$);