X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=src%2Fmkws-core.js;h=2b258073e28781efebf914a04e91f18a10cf3f99;hp=ca9a9f0651a3c9cc9b1af19be2c3b1f7d62ba26f;hb=7b6b1d731e85c96c95101e444364eca4ab03782c;hpb=793b65b52e9ce291ebbae509a0357068a211880d diff --git a/src/mkws-core.js b/src/mkws-core.js index ca9a9f0..2b25807 100644 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@ -3,7 +3,7 @@ * See the file LICENSE for details */ -"use strict"; // HTML5: disable for log_level >= 2 +"use strict"; // Set up global mkws object. Contains truly global state such as SP @@ -14,11 +14,13 @@ 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. + logger: undefined, + log_level: "info", teams: {}, widgetType2function: {}, + defaultTemplates: {}, locale_lang: { "de": { @@ -26,7 +28,7 @@ window.mkws = { "Subjects": "Schlagwörter", "Sources": "Daten und Quellen", "source": "datenquelle", - "Termlists": "Termlisten", + "Facets": "Termlisten", "Next": "Weiter", "Prev": "Zurück", "Search": "Suche", @@ -55,7 +57,7 @@ window.mkws = { "Subjects": "Emner", "Sources": "Kilder", "source": "kilder", - "Termlists": "Termlists", + "Facets": "Termlists", "Next": "Næste", "Prev": "Forrige", "Search": "Søg", @@ -88,41 +90,52 @@ if (typeof(mkws_jQuery) !== "undefined") { mkws.$ = jQuery; } -mkws.log = function(string) { - if (!mkws.log_level) - return; +// It's ridiculous that JSNLog doesn't provide this +mkws.stringToLevel = function(s) { + if (s === 'trace') { + return JL.getTraceLevel(); + } else if (s === 'debug') { + return JL.getDebugLevel(); + } else if (s === 'info') { + return JL.getInfoLevel(); + } else if (s === 'warn') { + return JL.getWarnLevel(); + } else if (s === 'error') { + return JL.getErrorLevel(); + } else if (s === 'fatal') { + return JL.getFatalLevel(); + } else { + throw "bad log-level '" + s + "'"; + } +} - if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ +mkws.logger = JL('mkws'); +var consoleAppender = JL.createConsoleAppender('consoleAppender'); +mkws.logger.setOptions({ "appenders": [consoleAppender], + "level": mkws.stringToLevel(mkws.log_level) }); + + +function _log(fn, string) { + if (!mkws.log_level) 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); }; -// 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 + "'"); -} +mkws.trace = function(x) { _log(mkws.logger.trace, x) }; +mkws.debug = function(x) { _log(mkws.logger.debug, x) }; +mkws.info = function(x) { _log(mkws.logger.info, x) }; +mkws.warn = function(x) { _log(mkws.logger.warn, x) }; +mkws.error = function(x) { _log(mkws.logger.error, x) }; +mkws.fatal = function(x) { _log(mkws.logger.fatal, x) }; // Translation function. @@ -148,8 +161,13 @@ mkws.getParameterByName = function(name, url) { mkws.registerWidgetType = function(name, fn) { + if(mkws._old2new.hasOwnProperty(name)) { + mkws.warn("registerWidgetType old widget name: " + name + " => " + mkws._old2new[name]); + name = mkws._old2new[name]; + } + mkws.widgetType2function[name] = fn; - mkws.log("registered widget-type '" + name + "'"); + mkws.info("registered widget-type '" + name + "'"); }; mkws.promotionFunction = function(name) { @@ -158,26 +176,24 @@ 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 + // Set global log_level flag early so that _log() works 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: 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, + 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 */ @@ -186,6 +202,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" }; @@ -209,110 +226,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}}\ -{{#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 '\ - \ - {{#mkws-first md-thumburl}}\ - {{../md-title}}\ - {{/mkws-first}}\ -
\ - \ -'; - } else if (name === 'Facet') { - return '\ -{{term}}\ -{{count}}\ -'; - } - - return null; -}; - - // The following functions are dispatchers for team methods that // are called from the UI using a team-name rather than implicit // context. @@ -357,9 +270,73 @@ mkws.pagerNext = function(tname) { }; +mkws.pazpar2_url = function() { + if (mkws.config.pazpar2_url) { + mkws.info("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.info("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.debug("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.debug("Generated new window token '" + token + "'"); +} + +window.name = window.location.hostname + window.location.pathname + '/' + token; +mkws.info("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 @@ -369,7 +346,7 @@ mkws.pagerNext = function(tname) { // undefined, we don't get an error message, but this // function and its callers, up several stack level, // silently return. What a crock. - log("handleNodeWithTeam() called on node with no classes"); + mkws.fatal("handleNodeWithTeam() called on node with no classes"); return; } var list = classes.split(/\s+/) @@ -377,10 +354,19 @@ 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(); } } @@ -389,10 +375,10 @@ mkws.pagerNext = function(tname) { 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 (node.getAttribute("autosearch")) { if (mkws.autoHasAuto || mkws.teams["AUTO"] && mkws.teams["AUTO"].config["query"]) { - log("AUTO team already has a query, using unique team"); + mkws.warn("AUTO team already has a query, using unique team"); teamName = "UNIQUE"; } mkws.autoHasAuto = true; @@ -423,12 +409,12 @@ mkws.pagerNext = function(tname) { mkws.width = width; if (from) { - log("changing from " + from + " to " + to + ": " + width); + mkws.info("changing from " + from + " to " + to + ": " + width); 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.node.hide(); } @@ -449,11 +435,12 @@ mkws.pagerNext = function(tname) { * for the site. */ function authenticateSession(auth_url, auth_domain, pp2_url) { - log("service proxy authentication on URL: " + auth_url); + mkws.authenticating = true; + mkws.info("service proxy authentication on URL: " + auth_url); if (!auth_domain) { auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2'); - log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'"); + mkws.info("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'"); } var request = new pzHttpRequest(auth_url, function(err) { @@ -462,6 +449,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; @@ -473,7 +461,7 @@ mkws.pagerNext = function(tname) { return; } - log("service proxy authentication successful"); + mkws.info("service proxy authentication successful"); mkws.authenticated = true; var authName = $(data).find("displayName").text(); // You'd think there would be a better way to do this: @@ -488,7 +476,7 @@ mkws.pagerNext = function(tname) { function runAutoSearches() { - log("running auto searches"); + mkws.info("running auto searches"); for (var teamName in mkws.teams) { mkws.teams[teamName].queue("ready").publish(); @@ -501,7 +489,7 @@ mkws.pagerNext = function(tname) { // 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. @@ -515,9 +503,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; } @@ -533,16 +526,15 @@ mkws.pagerNext = function(tname) { 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.info("widget " + type + " HTML changed: reparsing"); makeWidgetsWithin(level+1, $(this)); } }); @@ -551,36 +543,30 @@ 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.info(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"); + mkws.warn("no widgets found"); return; } @@ -588,10 +574,10 @@ mkws.pagerNext = function(tname) { mkws.autoHasAuto = false; var saved_config; if (typeof mkws_config === 'undefined') { - log("setting empty config"); + mkws.info("setting empty config"); saved_config = {}; } else { - log("using config: " + $.toJSON(mkws_config)); + mkws.info("using config: " + $.toJSON(mkws_config)); saved_config = mkws_config; } mkws.setMkwsConfig(saved_config); @@ -602,7 +588,7 @@ mkws.pagerNext = function(tname) { var lang = key.replace(/^language_/, ""); // Copy custom languages into list mkws.locale_lang[lang] = mkws.config[key]; - log("added locally configured language '" + lang + "'"); + mkws.info("added locally configured language '" + lang + "'"); } } } @@ -614,17 +600,12 @@ mkws.pagerNext = function(tname) { 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; - } + mkws.info("using language: " + (mkws.config.lang ? mkws.config.lang : "none")); // 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); + mkws.info("adjusted protocol independent link to " + mkws.pazpar2_url()); } if (mkws.config.responsive_design_width) { @@ -639,49 +620,52 @@ 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"); - - /* - for (var tName in mkws.teams) { + mkws.info("walking MKWS nodes took " + (now-then) + " ms"); + 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.info("made PZ2 object"); + /* + myTeam.visitWidgets(function(t, w) { + mkws.debug(" 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; + mkws.info("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; + 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.info("generated sp_auth_url '" + s + "'"); + return s; } } - if (mkws.config.use_service_proxy) { - if (!mkws.authenticated) { - authenticateSession(sp_auth_url(mkws.config), - mkws.config.service_proxy_auth_domain, - mkws.config.pazpar2_url); - } - } else { - // raw pp2 + if (mkws.config.use_service_proxy && !mkws.authenticated && !mkws.authenticating) { + authenticateSession(sp_auth_url(mkws.config), + mkws.config.service_proxy_auth_domain, + mkws.pazpar2_url()); + } else if (!mkws.authenticating) { + // raw pp2 or we have a session already open runAutoSearches(); } @@ -690,7 +674,9 @@ mkws.pagerNext = function(tname) { }; $(document).ready(function() { - mkws.init(); + if (!window.mkws_noready && !mkws.authenticating && !mkws.active) { + mkws.init(); + } }); })(mkws.$);