X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=src%2Fmkws-core.js;h=1d4d26ed32881c8ad5f69194e6eb66db31c16dc6;hp=718c3509adc8061f43ae607fd39b6d5c6c3e440e;hb=a400ffb90ea4c58ac7505052e00484421d7a4e7b;hpb=8ecc7b5621fa3f7191205e6ce93a8ef097e873bd diff --git a/src/mkws-core.js b/src/mkws-core.js index 718c350..1d4d26e 100644 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@ -16,6 +16,7 @@ window.mkws = { 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: {}, @@ -28,7 +29,7 @@ window.mkws = { "Subjects": "Schlagwörter", "Sources": "Daten und Quellen", "source": "datenquelle", - "Termlists": "Termlisten", + "Facets": "Termlisten", "Next": "Weiter", "Prev": "Zurück", "Search": "Suche", @@ -57,7 +58,7 @@ window.mkws = { "Subjects": "Emner", "Sources": "Kilder", "source": "kilder", - "Termlists": "Termlists", + "Facets": "Termlists", "Next": "Næste", "Prev": "Forrige", "Search": "Søg", @@ -90,41 +91,36 @@ if (typeof(mkws_jQuery) !== "undefined") { mkws.$ = jQuery; } -mkws.log = function(string) { - if (!mkws.log_level) - return; +mkws.logger = JL('mkws'); +var consoleAppender = JL.createConsoleAppender('consoleAppender'); +mkws.logger.setOptions({ "appenders": [consoleAppender]} ); + - if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ +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.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. @@ -150,6 +146,11 @@ mkws.getParameterByName = function(name, url) { 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 + "'"); }; @@ -161,26 +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: undefined, pp2_hostname: "sp-mkws.indexdata.com", - pp2_path: "service-proxy", + pp2_path: "service-proxy/", service_proxy_auth: undefined, - sp_auth_path: "service-proxy/", + sp_auth_path: undefined, sp_auth_query: "command=auth&action=perconfig", - sp_auth_credentials: "XXX/XXX", // Should be undefined: see bug MKSP-125. + 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 */ @@ -262,16 +260,69 @@ mkws.pazpar2_url = function() { 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 + "/"; + 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 @@ -289,10 +340,19 @@ mkws.pazpar2_url = function() { 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(); } } @@ -301,7 +361,7 @@ mkws.pazpar2_url = function() { 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"); @@ -339,8 +399,8 @@ mkws.pazpar2_url = function() { 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(); } @@ -415,7 +475,7 @@ mkws.pazpar2_url = function() { // 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. @@ -429,9 +489,14 @@ mkws.pazpar2_url = function() { 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; } @@ -447,16 +512,15 @@ mkws.pazpar2_url = 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)); } }); @@ -483,21 +547,6 @@ mkws.pazpar2_url = function() { if (message) greet += " :: " + message; mkws.log(greet); - // 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') + "'"); - } - } - // 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) { @@ -539,11 +588,6 @@ mkws.pazpar2_url = function() { 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.pazpar2_url().match(/^\/\//)) { mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url; @@ -568,16 +612,16 @@ mkws.pazpar2_url = function() { 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) { @@ -585,8 +629,9 @@ mkws.pazpar2_url = function() { return config.service_proxy_auth; } else { var s = '//'; - s += config.auth_hostname ? config.auth_hostname : config.pp2_hostname; - s += '/' + config.sp_auth_path; + 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;