X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=src%2Fmkws-core.js;h=1d4d26ed32881c8ad5f69194e6eb66db31c16dc6;hp=75c196e48c81c6805852bce7f0507a2725afaff4;hb=a400ffb90ea4c58ac7505052e00484421d7a4e7b;hpb=e1842f3ced89b3155f5918c896b902717a26e619 diff --git a/src/mkws-core.js b/src/mkws-core.js index 75c196e..1d4d26e 100644 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@ -9,13 +9,19 @@ // 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, + authenticating: false, + active: false, + logger: undefined, log_level: 1, // Will be overridden from mkws.config, but // initial value allows jQuery popup to use logging. teams: {}, widgetType2function: {}, + defaultTemplates: {}, locale_lang: { "de": { @@ -23,7 +29,7 @@ var mkws = { "Subjects": "Schlagwörter", "Sources": "Daten und Quellen", "source": "datenquelle", - "Termlists": "Termlisten", + "Facets": "Termlisten", "Next": "Weiter", "Prev": "Zurück", "Search": "Suche", @@ -52,7 +58,7 @@ var mkws = { "Subjects": "Emner", "Sources": "Kilder", "source": "kilder", - "Termlists": "Termlists", + "Facets": "Termlists", "Next": "Næste", "Prev": "Forrige", "Search": "Søg", @@ -78,26 +84,45 @@ var mkws = { } }; +// We may be using a separate copy +if (typeof(mkws_jQuery) !== "undefined") { + mkws.$ = mkws_jQuery; +} else { + mkws.$ = jQuery; +} + +mkws.logger = JL('mkws'); +var consoleAppender = JL.createConsoleAppender('consoleAppender'); +mkws.logger.setOptions({ "appenders": [consoleAppender]} ); + -mkws.log = function(string) { +function _log(fn, string) { if (!mkws.log_level) return; - if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ - return; - } - // you need to disable use strict at the top of the file!!! if (mkws.log_level >= 3) { // Works in Chrome; not sure about elsewhere console.trace(); } else if (mkws.log_level >= 2) { - console.log(">>> called from function " + arguments.callee.caller.name + ' <<<'); + } - console.log(string); + fn.call(mkws.logger, string); }; +mkws.log = function(x) { _log(mkws.logger.debug, x) }; +/* +trace("message with severity trace"); +debug("message with severity debug"); +info("message with severity info"); +warn("message with severity warn"); +error("message with severity error"); +fatal("message with severity fatal"); +*/ + + + // Translation function. mkws.M = function(word) { var lang = mkws.config.lang; @@ -111,15 +136,21 @@ mkws.M = function(word) { // This function is taken from a StackOverflow answer // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144 -mkws.getParameterByName = function(name) { +mkws.getParameterByName = function(name, url) { + if (!url) url = location.search; name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]"); var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"), - results = regex.exec(location.search); + results = regex.exec(url); return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " ")); } mkws.registerWidgetType = function(name, fn) { + if(mkws._old2new.hasOwnProperty(name)) { + mkws.log("Warning: registerWidgetType old widget name: " + name + " => " + mkws._old2new[name]); + name = mkws._old2new[name]; + } + mkws.widgetType2function[name] = fn; mkws.log("registered widget-type '" + name + "'"); }; @@ -131,21 +162,23 @@ mkws.promotionFunction = function(name) { mkws.setMkwsConfig = function(overrides) { // Set global log_level flag early so that mkws.log() works - // Fall back to old "debug_level" setting for backwards compatibility var tmp = overrides.log_level; - if (typeof(tmp) === 'undefined') tmp = overrides.debug_level; if (typeof(tmp) !== 'undefined') mkws.log_level = tmp; 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: undefined, + sp_auth_query: "command=auth&action=perconfig", + sp_auth_credentials: undefined, lang: "", sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], perpage_options: [10, 20, 30, 50], sort_default: "relevance", perpage_default: 20, - query_width: 50, show_lang: true, /* show/hide language menu */ show_sort: true, /* show/hide sort menu */ show_perpage: true, /* show/hide perpage menu */ @@ -154,6 +187,7 @@ mkws.setMkwsConfig = function(overrides) { facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */ responsive_design_width: undefined, /* a page with less pixel width considered as narrow */ log_level: 1, /* log level for development: 0..2 */ + template_vars: {}, /* values that may be exposed to templates */ dummy: "dummy" }; @@ -177,95 +211,6 @@ mkws.objectInheritingFrom = function(o) { } -mkws.defaultTemplate = function(name) { - if (name === 'Record') { - return '\ -\ - \ - \ - \ - \ - {{#if md-date}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if md-author}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if md-electronic-url}}\ - \ - \ - \ - \ - {{/if}}\ - {{#mkws-if-any location having="md-subject"}}\ - \ - \ - \ - \ - {{/mkws-if-any}}\ - \ - \ - \ - \ -
{{mkws-translate "Title"}}\ - {{md-title}}\ - {{#if md-title-remainder}}\ - ({{md-title-remainder}})\ - {{/if}}\ - {{#if md-title-responsibility}}\ - {{md-title-responsibility}}\ - {{/if}}\ -
{{mkws-translate "Date"}}{{md-date}}
{{mkws-translate "Author"}}{{md-author}}
{{mkws-translate "Links"}}\ - {{#each md-electronic-url}}\ - Link{{mkws-index1}}\ - {{/each}}\ -
{{mkws-translate "Subject"}}\ - {{#mkws-first location having="md-subject"}}\ - {{#if md-subject}}\ - {{#mkws-commaList md-subject}}\ - {{this}}{{/mkws-commaList}}\ - {{/if}}\ - {{/mkws-first}}\ -
{{mkws-translate "Locations"}}\ - {{#mkws-commaList location}}\ - {{mkws-attr "@name"}}{{/mkws-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 '\ - \ - {{#mkws-first md-thumburl}}\ - {{../md-title}}\ - {{/mkws-first}}\ -
\ - \ -'; - } - - var s = "There is no default '" + name +"' template!"; - alert(s); - return s; -}; - - // The following functions are dispatchers for team methods that // are called from the UI using a team-name rather than implicit // context. @@ -310,9 +255,74 @@ 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; + var _old2new = { // Maps old-style widget names to new-style + 'Authname': 'auth-name', + 'ConsoleBuilder': 'console-builder', + 'Coverart': 'cover-art', + 'GoogleImage': 'google-image', + 'MOTD': 'motd', + 'MOTDContainer': 'motd-container', + 'Perpage': 'per-page', + 'SearchForm': 'search-form', + 'ReferenceUniverse': 'reference-universe', + 'Termlists': 'facets' + }; + // Annoyingly, there is no built-in way to invert a hash + var _new2old = {}; + for (var key in _old2new) { + if(_old2new.hasOwnProperty(key)) { + _new2old[_old2new[key]] = key; + } + } + + mkws._old2new = _old2new; function handleNodeWithTeam(node, callback) { // First branch for DOM objects; second branch for jQuery objects @@ -330,14 +340,42 @@ mkws.pagerNext = function(tname) { for (var i = 0; i < list.length; i++) { var cname = list[i]; - if (cname.match(/^mkwsTeam_/)) { + if (cname.match(/^mkws-team-/)) { + // New-style teamnames of the form mkws-team-xyz + teamName = cname.replace(/^mkws-team-/, ''); + } else if (cname.match(/^mkwsTeam_/)) { + // Old-style teamnames of the form mkwsTeam_xyz teamName = cname.replace(/^mkwsTeam_/, ''); + } else if (cname.match(/^mkws-/)) { + // New-style names of the from mkws-foo-bar + type = cname.replace(/^mkws-/, ''); } else if (cname.match(/^mkws/)) { - type = cname.replace(/^mkws/, ''); + // Old-style names of the form mkwsFooBar + var tmp = cname.replace(/^mkws/, ''); + type = _old2new[tmp] || tmp.toLowerCase(); + } + } + + // 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.getAttribute("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; } } - if (!teamName) teamName = "AUTO"; + // Widgets on team "UNIQUE" get a random team + if (teamName === "UNIQUE") { + teamName = Math.floor(Math.random() * 100000000).toString(); + } + callback.call(node, teamName, type); } @@ -361,14 +399,14 @@ mkws.pagerNext = function(tname) { for (var tname in mkws.teams) { var team = mkws.teams[tname]; team.visitWidgets(function(t, w) { - var w1 = team.widget(t + "-Container-" + from); - var w2 = team.widget(t + "-Container-" + to); + var w1 = team.widget(t + "-container-" + from); + var w2 = team.widget(t + "-container-" + to); if (w1) { - w1.jqnode.hide(); + w1.node.hide(); } if (w2) { - w2.jqnode.show(); - w.jqnode.appendTo(w2.jqnode); + w2.node.show(); + w.node.appendTo(w2.node); } }); team.queue("resize-" + to).publish(); @@ -383,6 +421,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) { @@ -396,13 +435,15 @@ mkws.pagerNext = function(tname) { }, auth_domain); request.get(null, function(data) { + mkws.authenticating = false; 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; } @@ -430,11 +471,11 @@ mkws.pagerNext = function(tname) { function selectorForAllWidgets() { - if (mkws.config.scan_all_nodes) { + if (mkws.config && mkws.config.scan_all_nodes) { // This is the old version, which works by telling jQuery to // find every node that has a class beginning with "mkws". In // theory it should be slower than the class-based selector; but - // instrumentation suprisnigly shows this is consistently + // instrumentation suprisingly shows this is consistently // faster. It also has the advantage that any widgets of // non-registered types are logged as warnings rather than // silently ignored. @@ -448,9 +489,14 @@ mkws.pagerNext = function(tname) { var s = ""; for (var type in mkws.widgetType2function) { if (s) s += ','; - s += '.mkws' + type; - s += ',.mkws' + type + "-Container-wide"; - s += ',.mkws' + type + "-Container-narrow"; + s += '.mkws-' + type; + s += ',.mkws-' + type + "-container-wide"; + s += ',.mkws-' + type + "-container-narrow"; + // Annoyingly, we also need to recognise old-style names + var oldtype = _new2old[type] || type.charAt(0).toUpperCase() + type.slice(1); + s += ',.mkws' + oldtype; + s += ',.mkws' + oldtype + "-Container-wide"; + s += ',.mkws' + oldtype + "-Container-narrow"; } return s; } @@ -458,114 +504,165 @@ 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) { - myTeam = mkws.teams[tname] = team($, tname); - log("made MKWS team '" + tname + "'"); + myTeam = mkws.teams[tname] = mkws.makeTeam($, tname); } var oldHTML = this.innerHTML; - var myWidget = widget($, myTeam, type, this); + var myWidget = mkws.makeWidget($, myTeam, type, this); myTeam.addWidget(myWidget); var newHTML = this.innerHTML; if (newHTML !== oldHTML) { - log("widget " + tname + ":" + type + " HTML changed: reparsing"); + myTeam.log("widget " + type + " HTML changed: reparsing"); makeWidgetsWithin(level+1, $(this)); } }); }); + return true; } - $(document).ready(function() { - 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 + "'"); - } + // 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) { + 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. + if (!mkws.isActive) { + var widgetSelector = selectorForAllWidgets(); + if ($(widgetSelector).length < 1) { + mkws.log("no widgets found"); + return; } - } - 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")); + // 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 + "'"); + } + } + } - 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; - } + var lang = mkws.getParameterByName("lang") || mkws.config.lang; + if (!lang || !mkws.locale_lang[lang]) { + mkws.config.lang = "" + } else { + mkws.config.lang = 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; - log("adjusted protocol independent link to " + mkws.config.pazpar2_url); - } + log("using language: " + (mkws.config.lang ? mkws.config.lang : "none")); - 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); - } + // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp" + if (mkws.pazpar2_url().match(/^\/\//)) { + mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url; + log("adjusted protocol independent link to " + mkws.pazpar2_url()); + } - // 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') + "'"); + 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, $(':root')); + // If we've made no widgets, return without starting an SP session + // or marking MKWS active. + if (makeWidgetsWithin(1, rootsel ? $(rootsel) : undefined) === false) { + return false; + } var now = $.now(); log("walking MKWS nodes took " + (now-then) + " ms"); - - /* - for (var tName in mkws.teams) { + for (var tName in mkws.teams) { var myTeam = mkws.teams[tName] - log("team '" + tName + "' = " + myTeam + " ..."); - myTeam.visitWidgets(function(t, w) { - log(" has widget of type '" + t + "': " + w); - }); + myTeam.makePz2(); + myTeam.log("made PZ2 object"); + /* + myTeam.visitWidgets(function(t, w) { + log(" has widget of type '" + t + "': " + w); + }); + */ + } + + 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.sp_auth_hostname ? config.sp_auth_hostname : config.pp2_hostname; + s += '/'; + s += config.sp_auth_path ? config.sp_auth_path : config.pp2_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) { - authenticateSession(mkws.config.service_proxy_auth, + 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 { - // raw pp2 + mkws.pazpar2_url()); + } else if (!mkws.authenticating) { + // raw pp2 or we have a session already open runAutoSearches(); } + + mkws.isActive = true; + return true; + }; + + $(document).ready(function() { + if (!window.mkws_noready && !mkws.authenticating && !mkws.active) { + mkws.init(); + } }); -})(jQuery); + +})(mkws.$);