X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-core.js;h=dd967a6eee64147625835cd4dd62b1809f4662f5;hb=df0de8aa67fe98e4900a88043049857bb1e1d5b0;hp=6bb98b39f4c86720db37b5b6b438b31ea4ee0df6;hpb=c91172c010df75d4da42bf86385a03b075ca1512;p=mkws-moved-to-github.git diff --git a/src/mkws-core.js b/src/mkws-core.js index 6bb98b3..dd967a6 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,25 +91,37 @@ 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); }; +// ### transitional placeholder function until we have promoted all invocations +mkws.log = function(x) { _log(mkws.logger.debug, "LEGACY LOG: " + x) }; + +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. mkws.M = function(word) { var lang = mkws.config.lang; @@ -133,12 +146,12 @@ 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]); + mkws.warn("Warning: 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) { @@ -147,7 +160,7 @@ mkws.promotionFunction = function(name) { mkws.setMkwsConfig = function(overrides) { - // Set global log_level flag early so that mkws.log() works + // Set global log_level flag early so that _log() works var tmp = overrides.log_level; if (typeof(tmp) !== 'undefined') mkws.log_level = tmp; @@ -155,17 +168,16 @@ mkws.setMkwsConfig = function(overrides) { 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 */ @@ -244,11 +256,11 @@ mkws.pagerNext = function(tname) { mkws.pazpar2_url = function() { if (mkws.config.pazpar2_url) { - mkws.log("using pre-baked pazpar2_url '" + 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.log("generated pazpar2_url '" + s + "'"); + var s = document.location.protocol + "//" + mkws.config.pp2_hostname + "/" + mkws.config.pp2_path; + mkws.info("generated pazpar2_url '" + s + "'"); return s; } }; @@ -268,7 +280,7 @@ mkws.pazpar2_url = function() { var token; if (window.name) { token = window.name.replace(/.*\//, ''); - mkws.log("Reusing existing window token '" + token + "'"); + 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 @@ -279,16 +291,15 @@ if (window.name) { // 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 + "'"); + mkws.debug("Generated new window token '" + token + "'"); } window.name = window.location.hostname + window.location.pathname + '/' + token; -mkws.log("Using window.name '" + window.name + "'"); +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', @@ -298,7 +309,8 @@ mkws.log("Using window.name '" + window.name + "'"); 'MOTDContainer': 'motd-container', 'Perpage': 'per-page', 'SearchForm': 'search-form', - 'ReferenceUniverse': 'reference-universe' + 'ReferenceUniverse': 'reference-universe', + 'Termlists': 'facets' }; // Annoyingly, there is no built-in way to invert a hash var _new2old = {}; @@ -318,7 +330,7 @@ mkws.log("Using window.name '" + window.name + "'"); // 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+/) @@ -350,7 +362,7 @@ mkws.log("Using window.name '" + window.name + "'"); 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; @@ -381,7 +393,7 @@ mkws.log("Using window.name '" + window.name + "'"); 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) { @@ -408,11 +420,11 @@ mkws.log("Using window.name '" + window.name + "'"); */ function authenticateSession(auth_url, auth_domain, pp2_url) { mkws.authenticating = true; - log("service proxy authentication on URL: " + auth_url); + 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) { @@ -433,7 +445,7 @@ mkws.log("Using window.name '" + window.name + "'"); 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: @@ -448,7 +460,7 @@ mkws.log("Using window.name '" + window.name + "'"); function runAutoSearches() { - log("running auto searches"); + mkws.info("running auto searches"); for (var teamName in mkws.teams) { mkws.teams[teamName].queue("ready").publish(); @@ -461,7 +473,7 @@ mkws.log("Using window.name '" + window.name + "'"); // 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. @@ -506,7 +518,7 @@ mkws.log("Using window.name '" + window.name + "'"); myTeam.addWidget(myWidget); var newHTML = this.innerHTML; if (newHTML !== oldHTML) { - myTeam.log("widget " + type + " HTML changed: reparsing"); + myTeam.info("widget " + type + " HTML changed: reparsing"); makeWidgetsWithin(level+1, $(this)); } }); @@ -531,14 +543,14 @@ mkws.log("Using window.name '" + window.name + "'"); var greet = "MKWS initialised"; if (rootsel) greet += " (limited to " + rootsel + ")" if (message) greet += " :: " + message; - mkws.log(greet); + 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; } @@ -546,10 +558,10 @@ mkws.log("Using window.name '" + window.name + "'"); 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); @@ -560,7 +572,7 @@ mkws.log("Using window.name '" + window.name + "'"); 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 + "'"); } } } @@ -572,17 +584,12 @@ mkws.log("Using window.name '" + window.name + "'"); 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.pazpar2_url().match(/^\/\//)) { mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url; - log("adjusted protocol independent link to " + mkws.pazpar2_url()); + mkws.info("adjusted protocol independent link to " + mkws.pazpar2_url()); } if (mkws.config.responsive_design_width) { @@ -602,26 +609,27 @@ mkws.log("Using window.name '" + window.name + "'"); } var now = $.now(); - log("walking MKWS nodes took " + (now-then) + " ms"); + mkws.info("walking MKWS nodes took " + (now-then) + " ms"); for (var tName in mkws.teams) { var myTeam = mkws.teams[tName] myTeam.makePz2(); - myTeam.log("made PZ2 object"); + myTeam.info("made PZ2 object"); /* myTeam.visitWidgets(function(t, w) { - log(" has widget of type '" + 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 + "'"); + 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_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; @@ -631,7 +639,7 @@ mkws.log("Using window.name '" + window.name + "'"); s += ('&username=' + c.substr(0, c.indexOf('/')) + '&password=' + c.substr(c.indexOf('/')+1)); } - mkws.log("generated sp_auth_url '" + s + "'"); + mkws.info("generated sp_auth_url '" + s + "'"); return s; } }