From: Jason Skomorowski Date: Mon, 18 Aug 2014 13:19:57 +0000 (-0400) Subject: Merge branch 'master' into templateallthemarkup X-Git-Tag: 1.0.0~324^2~34 X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=commitdiff_plain;h=d287f4680ff3ed663ccc5c01a7065713e9c52c84;hp=-c Merge branch 'master' into templateallthemarkup --- d287f4680ff3ed663ccc5c01a7065713e9c52c84 diff --combined examples/htdocs/jasmine-local-popup.html index 12af4ac,d5758b3..cde7ac2 --- a/examples/htdocs/jasmine-local-popup.html +++ b/examples/htdocs/jasmine-local-popup.html @@@ -24,7 -24,6 +24,7 @@@ + @@@ -57,7 -56,7 +57,7 @@@ var jasmine_config = { search_query: "netbsd", expected_hits: 10, - active_clients: 12, + active_clients: 13, check_motd: false, check_sortby: true, show_record_url: true diff --combined src/mkws-core.js index 4d6550c,6f58a92..98d32c0 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@@ -14,11 -14,11 +14,12 @@@ window.mkws = { $: $, // Our own local copy of the jQuery object authenticated: false, + active: false, log_level: 1, // Will be overridden from mkws.config, but // initial value allows jQuery popup to use logging. teams: {}, widgetType2function: {}, + defaultTemplates: {}, locale_lang: { "de": { @@@ -182,7 -182,6 +183,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" }; @@@ -206,6 -205,110 +207,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. @@@ -418,7 -521,11 +419,11 @@@ 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) { @@@ -436,61 -543,20 +441,20 @@@ } }); }); + return true; } - function init(rootsel) { - mkws.autoHasAuto = false; - if (!rootsel) var rootsel = ':root'; - 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 + "'"); - } - } - } - - 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")); - - 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.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); - } - - 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); - } + // 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: + // + // * 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", @@@ -505,8 -571,71 +469,71 @@@ } } + // 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; + } + + // 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 + "'"); + } + } + } + + 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")); + + 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.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); + } + + 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, $(rootsel)); + // If we've made no widgets, return without starting an SP session + // or marking MKWS active. + if (makeWidgetsWithin(1, rootsel) === false) return false; var now = $.now(); log("walking MKWS nodes took " + (now-then) + " ms"); @@@ -521,17 -650,21 +548,21 @@@ } */ - if (mkws.config.use_service_proxy) { + if (mkws.config.use_service_proxy && !mkws.authenticated) { authenticateSession(mkws.config.service_proxy_auth, mkws.config.service_proxy_auth_domain, mkws.config.pazpar2_url); } else { - // raw pp2 + // raw pp2 or we have a session already open runAutoSearches(); } + + mkws.isActive = true; + return true; }; + $(document).ready(function() { - var widgetSelector = selectorForAllWidgets(); - if (widgetSelector && $(widgetSelector).length !== 0) init(); + mkws.init(); }); + })(mkws.$); diff --combined src/mkws-team.js index b2bf974,9abed73..4dccde4 --- a/src/mkws-team.js +++ b/src/mkws-team.js @@@ -293,7 -293,7 +293,7 @@@ function team($, teamName) if (maxrecs) params.maxrecs = maxrecs; if (torusquery) { if (!mkws.config.use_service_proxy) - alert("can't narrow search by torusquery when Service Proxy is not in use"); + alert("can't narrow search by torusquery when not authenticated"); params.torusquery = torusquery; } @@@ -389,34 -389,38 +389,34 @@@ function loadTemplate(name, fallbackString) { var template = m_template[name]; - - if (template === undefined) { - // Fall back to generic template if there is no team-specific one + if (template === undefined && Handlebars.compile) { var source; var node = $(".mkwsTemplate_" + name + " .mkwsTeam_" + that.name()); if (node && node.length < 1) { node = $(".mkwsTemplate_" + name); } - if (node) { - source = node.html(); - } - - // If the template is not defined in HTML, check the following - // in order: template registered in the team by a widget; - // fallback string provided on this invocation; global default. - if (!source) { - source = m_templateText[name]; - } - if (!source) { - source = fallbackString; - } - if (!source) { - source = mkws.defaultTemplate(name); + if (node) source = node.html(); + if (!source) source = m_templateText[name]; + if (source) { + template = Handlebars.compile(source); + log("compiled template '" + name + "'"); } - - if (!source) return null; - template = Handlebars.compile(source); - log("compiled template '" + name + "'"); + } + //if (template === undefined) template = mkws_templatesbyteam[m_teamName][name]; + if (template === undefined && Handlebars.templates) { + template = Handlebars.templates[name]; + } + if (template === undefined && mkws.defaultTemplates) { + template = mkws.defaultTemplates[name]; + } + if (template) { m_template[name] = template; + return template; } - - return template; + else { + mkws.log("No MKWS template for " + name); + return null; + } } that.loadTemplate = loadTemplate;