X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-core.js;h=8d19f3a0d133a010e6c50f5fcfabe0d754ef5861;hb=383378d6a66b3b00bb540e2c1738d18d470b557e;hp=4870c7c1e4ed23fe1dfe5ac82cb80bfbbcf9925c;hpb=c1e819f7760602c6638547dadcb371f512e3cd0c;p=mkws-moved-to-github.git diff --git a/src/mkws-core.js b/src/mkws-core.js index 4870c7c..8d19f3a 100644 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@ -11,10 +11,11 @@ // var mkws = { authenticated: false, - log_level: 1, // Will be overridden from mkws_config, but + log_level: 1, // Will be overridden from mkws.config, but // initial value allows jQuery popup to use logging. - paz: undefined, // will be set up during initialisation teams: {}, + widgetType2function: {}, + locale_lang: { "de": { "Authors": "Autoren", @@ -77,142 +78,95 @@ var mkws = { }; -// Define empty mkws_config for simple applications that don't define it. -if (mkws_config == null || typeof mkws_config != 'object') { - var mkws_config = {}; -} - - -// wrapper to call team() after page load -(function (j) { - mkws.log = function (string) { - if (!mkws.log_level) - return; - - if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ - return; - } +mkws.log = function(string) { + if (!mkws.log_level) + return; - // you need to disable use strict at the top of the file!!! - if (mkws.log_level >= 3) { - console.log(arguments.callee.caller); - } else if (mkws.log_level >= 2) { - console.log(">>> called from function " + arguments.callee.caller.name + ' <<<'); - } - console.log(string); + if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ + return; } - var log = mkws.log; - - - mkws.handleNodeWithTeam = function(node, callback) { - // First branch for DOM objects; second branch for jQuery objects - var classes = node.className || node.attr('class'); - if (!classes) { - // For some reason, if we try to proceed when classes is - // undefined, we don't get an error message, but this - // function and its callers, up several stack level, - // silently return. What a crock. - mkws.log("handleNodeWithTeam() called on node with no classes"); - return; - } - var list = classes.split(/\s+/) - var teamName, type; - - for (var i = 0; i < list.length; i++) { - var cname = list[i]; - if (cname.match(/^mkwsTeam_/)) { - teamName = cname.replace(/^mkwsTeam_/, ''); - } else if (cname.match(/^mkws/)) { - type = cname.replace(/^mkws/, ''); - } - } - callback.call(node, teamName, type); - } - - - mkws.resizePage = function () { - var list = ["mkwsSwitch", "mkwsLang"]; - - var width = mkws_config.responsive_design_width; - var parent = $(".mkwsTermlists").parent(); - - if ($(window).width() <= width && - parent.hasClass("mkwsTermlistContainer1")) { - log("changing from wide to narrow: " + $(window).width()); - $(".mkwsTermlistContainer1").hide(); - $(".mkwsTermlistContainer2").show(); - for (var tname in mkws.teams) { - $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname)); - for(var i = 0; i < list.length; i++) { - $("." + list[i] + ".mkwsTeam_" + tname).hide(); - } - } - } else if ($(window).width() > width && - parent.hasClass("mkwsTermlistContainer2")) { - log("changing from narrow to wide: " + $(window).width()); - $(".mkwsTermlistContainer1").show(); - $(".mkwsTermlistContainer2").hide(); - for (var tname in mkws.teams) { - $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname)); - for(var i = 0; i < list.length; i++) { - $("." + list[i] + ".mkwsTeam_" + tname).show(); - } - } - } - }; - - mkws.switchView = function(tname, view) { - mkws.teams[tname].switchView(view); + // 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); +}; - mkws.showDetails = function (tname, prefixRecId) { - mkws.teams[tname].showDetails(prefixRecId); - } - mkws.limitTarget = function (tname, id, name) { - mkws.teams[tname].limitTarget(id, name); - } +// 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) { + name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]"); + var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"), + results = regex.exec(location.search); + return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " ")); +} - mkws.limitQuery = function (tname, field, value) { - mkws.teams[tname].limitQuery(field, value); - } - mkws.delimitTarget = function (tname, id) { - mkws.teams[tname].delimitTarget(id); - } +mkws.registerWidgetType = function(name, fn) { + mkws.widgetType2function[name] = fn; + mkws.log("registered widget-type '" + name + "'"); +}; - mkws.delimitQuery = function (tname, field, value) { - mkws.teams[tname].delimitQuery(field, value); - } +mkws.promotionFunction = function(name) { + return mkws.widgetType2function[name]; +}; - mkws.showPage = function (tname, pageNum) { - mkws.teams[tname].showPage(pageNum); - } - mkws.pagerPrev = function (tname) { - mkws.teams[tname].pagerPrev(); - } +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", + 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 */ + lang_options: [], /* display languages links for given languages, [] for all */ + 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 */ + + dummy: "dummy" + }; - mkws.pagerNext = function (tname) { - mkws.teams[tname].pagerNext(); + mkws.config = mkws.objectInheritingFrom(config_default); + for (var k in overrides) { + mkws.config[k] = overrides[k]; } +}; - // 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) { - name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]"); - var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"), - results = regex.exec(location.search); - return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " ")); - } +// This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript" +// http://javascript.crockford.com/prototypal.html +// mkws.objectInheritingFrom behaves the same as Object.create, +// but since the latter is not available in IE8 we can't use it. +// +mkws.objectInheritingFrom = function(o) { + function F() {} + F.prototype = o; + return new F(); +} - mkws.defaultTemplate = function(name) - { - if (name === 'Record') { - return '\ +mkws.defaultTemplate = function(name) { + if (name === 'Record') { + return '\ \ \ \ @@ -270,8 +224,8 @@ if (mkws_config == null || typeof mkws_config != 'object') { \
{{translate "Title"}}
\ '; - } else if (name === "Summary") { - return '\ + } else if (name === "Summary") { + return '\ \ {{md-title}}\ \ @@ -282,63 +236,147 @@ if (mkws_config == null || typeof mkws_config != 'object') { {{md-title-responsibility}}\ {{/if}}\ '; - } - - var s = "There is no default '" + name +"' template!"; - alert(s); - return s; + } else if (name === "Image") { + return '\ + \ + {{#first md-thumburl}}\ + {{../md-title}}\ + {{/first}}\ +
\ + \ +'; } + var s = "There is no default '" + name +"' template!"; + alert(s); + return s; +}; - function defaultMkwsConfig() { - /* default mkws config */ - var config_default = { - use_service_proxy: true, - pazpar2_url: "//mkws.indexdata.com/service-proxy/", - service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth", - 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 */ - lang_options: [], /* display languages links for given languages, [] for all */ - 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 */ - - dummy: "dummy" - }; - - // Set global log_level flag early so that log() works - // Fall back to old "debug_level" setting for backwards compatibility - var tmp = mkws_config.log_level; - if (typeof(tmp) === 'undefined') tmp = mkws_config.debug_level; - - if (typeof(tmp) !== 'undefined') { - mkws.log_level = tmp; - } else if (typeof(config_default.log_level) !== 'undefined') { - mkws.log_level = config_default.log_level; - } - // make sure the mkws_config is a valid hash - if (!$.isPlainObject(mkws_config)) { - log("ERROR: mkws_config is not an JS object, ignore it...."); - mkws_config = {}; +// The following functions are dispatchers for team methods that +// are called from the UI using a team-name rather than implicit +// context. +mkws.switchView = function(tname, view) { + mkws.teams[tname].switchView(view); +}; + +mkws.showDetails = function(tname, prefixRecId) { + mkws.teams[tname].showDetails(prefixRecId); +}; + +mkws.limitTarget = function(tname, id, name) { + mkws.teams[tname].limitTarget(id, name); +}; + +mkws.limitQuery = function(tname, field, value) { + mkws.teams[tname].limitQuery(field, value); +}; + +mkws.limitCategory = function(tname, id) { + mkws.teams[tname].limitCategory(id); +}; + +mkws.delimitTarget = function(tname, id) { + mkws.teams[tname].delimitTarget(id); +}; + +mkws.delimitQuery = function(tname, field, value) { + mkws.teams[tname].delimitQuery(field, value); +}; + +mkws.showPage = function(tname, pageNum) { + mkws.teams[tname].showPage(pageNum); +}; + +mkws.pagerPrev = function(tname) { + mkws.teams[tname].pagerPrev(); +}; + +mkws.pagerNext = function(tname) { + mkws.teams[tname].pagerNext(); +}; + + +// wrapper to call team() after page load +(function(j) { + var log = mkws.log; + + function handleNodeWithTeam(node, callback) { + // First branch for DOM objects; second branch for jQuery objects + var classes = node.className || node.attr('class'); + if (!classes) { + // For some reason, if we try to proceed when classes is + // 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"); + return; } + var list = classes.split(/\s+/) + var teamName, type; - /* override standard config values by function parameters */ - for (var k in config_default) { - if (typeof mkws_config[k] === 'undefined') - mkws_config[k] = config_default[k]; - //log("Set config: " + k + ' => ' + mkws_config[k]); + for (var i = 0; i < list.length; i++) { + var cname = list[i]; + if (cname.match(/^mkwsTeam_/)) { + teamName = cname.replace(/^mkwsTeam_/, ''); + } else if (cname.match(/^mkws/)) { + type = cname.replace(/^mkws/, ''); + } } + + if (!teamName) teamName = "AUTO"; + callback.call(node, teamName, type); } + function resizePage() { + var list = ["mkwsSwitch", "mkwsLang"]; + + var parent = $(".mkwsTermlists").parent(); + var targetWidth = mkws.config.responsive_design_width; + var width = $(window).width(); + + if (mkws.width === undefined) { + // No state change, since we have no previous state + } else if (mkws.width <= targetWidth && width > targetWidth) { + log("narrow -> wide"); + } else if (mkws.width > targetWidth && width <= targetWidth) { + log("wide -> narrow"); + } else if (width > targetWidth) { + log("already wide"); + } else { + log("already narrow"); + } + mkws.width = width; + + if (width <= targetWidth && + parent.hasClass("mkwsTermlist-Container-wide")) { + log("changing from wide to narrow: " + width); + $(".mkwsTermlist-Container-wide").hide(); + $(".mkwsTermlist-Container-narrow").show(); + for (var tname in mkws.teams) { + mkws.teams[tname].queue("resize-narrow").publish(); + $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlist-Container-narrow.mkwsTeam_" + tname)); + for(var i = 0; i < list.length; i++) { + $("." + list[i] + ".mkwsTeam_" + tname).hide(); + } + } + } else if (width > targetWidth && + parent.hasClass("mkwsTermlist-Container-narrow")) { + log("changing from narrow to wide: " + width); + $(".mkwsTermlist-Container-wide").show(); + $(".mkwsTermlist-Container-narrow").hide(); + for (var tname in mkws.teams) { + mkws.teams[tname].queue("resize-wide").publish(); + $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlist-Container-wide.mkwsTeam_" + tname)); + for(var i = 0; i < list.length; i++) { + $("." + list[i] + ".mkwsTeam_" + tname).show(); + } + } + } + }; + + /* * Run service-proxy authentication in background (after page load). * The username/password is configured in the apache config file @@ -364,12 +402,19 @@ if (mkws_config == null || typeof mkws_config != 'object') { } var status = $(data).find("status"); if (status.text() != "OK") { - alert("service proxy auth repsonse status: " + status.text() + ", give up!"); + alert("service proxy auth response status: " + status.text() + ", give up!"); return; } log("Service proxy auth successfully done"); mkws.authenticated = true; + var authName = $(data).find("displayName").text(); + // You'd think there would be a better way to do this: + var realm = $(data).find("realm:not(realmAttributes realm)").text(); + for (var teamName in mkws.teams) { + mkws.teams[teamName].queue("authenticated").publish(authName, realm); + } + runAutoSearches(); }); } @@ -379,43 +424,67 @@ if (mkws_config == null || typeof mkws_config != 'object') { log("running auto searches"); for (var teamName in mkws.teams) { - mkws.teams[teamName].runAutoSearch(); + mkws.teams[teamName].queue("ready").publish(); } } - $(document).ready(function() { - log("on load ready"); - defaultMkwsConfig(); + function makeWidgetsWithin(level, node) { + node.find('[class^="mkws"],[class*=" mkws"]').each(function() { + handleNodeWithTeam(this, function(tname, type) { + var oldHTML = this.innerHTML; + var myTeam = mkws.teams[tname]; + var myWidget = widget(j, myTeam, type, this); + myTeam.addWidget(myWidget); + var newHTML = this.innerHTML; + if (newHTML !== oldHTML) { + log("widget " + tname + ":" + type + " HTML changed from '" + oldHTML + "' to '" + newHTML + "': reparse!"); + makeWidgetsWithin(level+1, $(this)); + } + }); + }); + } + - if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { - log("Reset query width: " + mkws_config.query_width); - mkws_config.query_width = 50; + $(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)) { + 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]; + mkws.locale_lang[lang] = mkws.config[key]; log("Added locally configured language '" + lang + "'"); } } } - 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(function(e) { mkws.resizePage() }); - // initial check after page load - $(document).ready(function() { mkws.resizePage() }); + if (mkws.config.query_width < 5 || mkws.config.query_width > 150) { + log("Reset query width: " + mkws.config.query_width); + mkws.config.query_width = 50; } // 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("adjust protocol independent links: " + mkws_config.pazpar2_url); + if (mkws.config.pazpar2_url.match(/^\/\//)) { + mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url; + log("adjust protocol independent links: " + mkws.config.pazpar2_url); + } + + 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); } // Backwards compatibility: set new magic class names on any @@ -432,43 +501,37 @@ if (mkws_config == null || typeof mkws_config != 'object') { } } - // For all MKWS-classed nodes that don't have a team - // specified, set the team to AUTO. - $('[class^="mkws"],[class*=" mkws"]').each(function () { - if (!this.className.match(/mkwsTeam_/)) { - log("adding AUTO team to node with class '" + this.className + "'"); - $(this).addClass('mkwsTeam_AUTO'); - } - }); - // Find all nodes with an MKWS class, and determine their team from // the mkwsTeam_* class. Make all team objects. var then = $.now(); - $('[class^="mkws"],[class*=" mkws"]').each(function () { - mkws.handleNodeWithTeam(this, function(tname, type) { + $('[class^="mkws"],[class*=" mkws"]').each(function() { + handleNodeWithTeam(this, function(tname, type) { if (!mkws.teams[tname]) { mkws.teams[tname] = team(j, tname); log("Made MKWS team '" + tname + "'"); } }); }); - // Second pass: make the individual widget objects. This has - // to be done separately, and after the team-creation, since - // that sometimes makes new widget nodes (e.g. creating - // mkwsTermlists inside mkwsResults. - $('[class^="mkws"],[class*=" mkws"]').each(function () { - mkws.handleNodeWithTeam(this, function(tname, type) { - var myTeam = mkws.teams[tname]; - var myWidget = widget(j, myTeam, type, this); - }); - }); + + makeWidgetsWithin(1, $(':root')); + var now = $.now(); log("Walking MKWS nodes took " + (now-then) + " ms"); - if (mkws_config.use_service_proxy) { - authenticateSession(mkws_config.service_proxy_auth, - mkws_config.service_proxy_auth_domain, - mkws_config.pazpar2_url); +// for (var tName in mkws.teams) { +// var myTeam = mkws.teams[tName] +// var types = myTeam.widgetTypes(); +// log("TEAM '" + tName + "' = " + myTeam + " has widget types " + types); +// for (var i = 0; i < types.length; i++) { +// var type = types[i]; +// log(" has widget of type '" + type + "': " + myTeam.widget(type)); +// } +// } + + if (mkws.config.use_service_proxy) { + authenticateSession(mkws.config.service_proxy_auth, + mkws.config.service_proxy_auth_domain, + mkws.config.pazpar2_url); } else { // raw pp2 runAutoSearches();