X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-core.js;h=f09bf1624beee49c9ce18e5853b82744409118f0;hb=cda252b2900ca0ec90ec32b7c3b7f963b1024187;hp=ccba3ef36908e0eb6557f9adc6121a4905c5b0e0;hpb=f477631050c31f1cff04dc341f8f927b764e9a33;p=mkws-moved-to-github.git
diff --git a/src/mkws-core.js b/src/mkws-core.js
index ccba3ef..f09bf16 100644
--- a/src/mkws-core.js
+++ b/src/mkws-core.js
@@ -10,6 +10,7 @@
// authentication, and a hash of team objects, indexed by team-name.
//
var mkws = {
+ $: $, // Our own local copy of the jQuery object
authenticated: false,
log_level: 1, // Will be overridden from mkws.config, but
// initial value allows jQuery popup to use logging.
@@ -77,6 +78,12 @@ var mkws = {
}
};
+// We may be using a separate copy
+if (typeof(mkws_jQuery) !== "undefined") {
+ mkws.$ = mkws_jQuery;
+} else {
+ mkws.$ = jQuery;
+}
mkws.log = function(string) {
if (!mkws.log_level)
@@ -97,6 +104,24 @@ mkws.log = function(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 + "'");
+}
+
+
// Translation function.
mkws.M = function(word) {
var lang = mkws.config.lang;
@@ -110,10 +135,11 @@ mkws.M = function(word) {
// 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) {
+mkws.getParameterByName = function(name, url) {
+ if (!url) url = location.search;
name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
var regex = new RegExp("[\\?&]" + name + "=([^]*)"),
- results = regex.exec(location.search);
+ results = regex.exec(url);
return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
}
@@ -137,7 +163,7 @@ mkws.setMkwsConfig = function(overrides) {
var config_default = {
use_service_proxy: true,
- pazpar2_url: "//mkws.indexdata.com/service-proxy/",
+ 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"]],
@@ -145,10 +171,11 @@ mkws.setMkwsConfig = function(overrides) {
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 */
+ show_lang: true, /* show/hide language menu */
+ show_sort: true, /* show/hide sort menu */
+ show_perpage: true, /* show/hide perpage menu */
+ show_switch: true, /* show/hide switch 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 */
@@ -184,10 +211,10 @@ mkws.defaultTemplate = function(name) {
\
{{md-title}}\
{{#if md-title-remainder}}\
- ({{md-title-remainder}})\
+ ({{md-title-remainder}})\
{{/if}}\
{{#if md-title-responsibility}}\
- {{md-title-responsibility}}\
+ {{md-title-responsibility}}\
{{/if}}\
| \
\
@@ -208,7 +235,7 @@ mkws.defaultTemplate = function(name) {
{{mkws-translate "Links"}} | \
\
{{#each md-electronic-url}}\
- Link{{mkws-index1}}\
+ Link{{mkws-index1}}\
{{/each}}\
| \
\
@@ -218,10 +245,10 @@ mkws.defaultTemplate = function(name) {
{{mkws-translate "Subject"}} | \
\
{{#mkws-first location having="md-subject"}}\
- {{#if md-subject}}\
- {{#mkws-commaList md-subject}}\
- {{this}}{{/mkws-commaList}}\
- {{/if}}\
+ {{#if md-subject}}\
+ {{#mkws-commaList md-subject}}\
+ {{this}}{{/mkws-commaList}}\
+ {{/if}}\
{{/mkws-first}}\
| \
\
@@ -230,7 +257,7 @@ mkws.defaultTemplate = function(name) {
{{mkws-translate "Locations"}} | \
\
{{#mkws-commaList location}}\
- {{mkws-attr "@name"}}{{/mkws-commaList}}\
+ {{mkws-attr "@name"}}{{/mkws-commaList}}\
| \
\
\
@@ -246,21 +273,36 @@ mkws.defaultTemplate = function(name) {
{{#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}}\
- \
+ \
{{/mkws-first}}\
-
\
+
\
\
';
+ } else if (name === 'Facet') {
+ return '\
+{{term}}\
+{{count}}\
+';
}
- var s = "There is no default '" + name +"' template!";
- alert(s);
- return s;
+ return null;
};
@@ -308,8 +350,8 @@ mkws.pagerNext = function(tname) {
};
-// wrapper to call team() after page load
-(function(j) {
+// wrapper to provide local copy of the jQuery object.
+(function($) {
var log = mkws.log;
function handleNodeWithTeam(node, callback) {
@@ -329,9 +371,9 @@ mkws.pagerNext = function(tname) {
for (var i = 0; i < list.length; i++) {
var cname = list[i];
if (cname.match(/^mkwsTeam_/)) {
- teamName = cname.replace(/^mkwsTeam_/, '');
+ teamName = cname.replace(/^mkwsTeam_/, '');
} else if (cname.match(/^mkws/)) {
- type = cname.replace(/^mkws/, '');
+ type = cname.replace(/^mkws/, '');
}
}
@@ -362,11 +404,11 @@ mkws.pagerNext = function(tname) {
var w1 = team.widget(t + "-Container-" + from);
var w2 = team.widget(t + "-Container-" + to);
if (w1) {
- $(w1.node).hide();
+ w1.node.hide();
}
if (w2) {
- $(w2.node).show();
- $(w.node).appendTo($(w2.node));
+ w2.node.show();
+ w.node.appendTo(w2.node);
}
});
team.queue("resize-" + to).publish();
@@ -381,7 +423,7 @@ mkws.pagerNext = function(tname) {
* for the site.
*/
function authenticateSession(auth_url, auth_domain, pp2_url) {
- log("Run service proxy auth URL: " + auth_url);
+ log("service proxy authentication on URL: " + auth_url);
if (!auth_domain) {
auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
@@ -395,22 +437,23 @@ mkws.pagerNext = function(tname) {
request.get(null, function(data) {
if (!$.isXMLDoc(data)) {
- alert("service proxy auth response document is not valid XML document, give up!");
- return;
+ alert("Service Proxy authentication response is not a valid XML document");
+ return;
}
var status = $(data).find("status");
if (status.text() != "OK") {
- alert("service proxy auth response status: " + status.text() + ", give up!");
- return;
+ var message = $(data).find("message");
+ alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")");
+ return;
}
- log("Service proxy auth successfully done");
+ log("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:
var realm = $(data).find("realm:not(realmAttributes realm)").text();
for (var teamName in mkws.teams) {
- mkws.teams[teamName].queue("authenticated").publish(authName, realm);
+ mkws.teams[teamName].queue("authenticated").publish(authName, realm);
}
runAutoSearches();
@@ -427,12 +470,45 @@ mkws.pagerNext = function(tname) {
}
+ function selectorForAllWidgets() {
+ if (mkws.config && mkws.config.scan_all_nodes) {
+ // 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
+ // faster. It also has the advantage that any widgets of
+ // non-registered types are logged as warnings rather than
+ // silently ignored.
+ return '[class^="mkws"],[class*=" mkws"]';
+ } else {
+ // This is the new version, which works by looking up the
+ // specific classes of all registered widget types and their
+ // resize containers. Because all it requires jQuery to do is
+ // some hash lookups in pre-built tables, it should be very
+ // fast; but it silently ignores widgets of unregistered types.
+ var s = "";
+ for (var type in mkws.widgetType2function) {
+ if (s) s += ',';
+ s += '.mkws' + type;
+ s += ',.mkws' + type + "-Container-wide";
+ s += ',.mkws' + type + "-Container-narrow";
+ }
+ return s;
+ }
+ }
+
+
function makeWidgetsWithin(level, node) {
- node.find('[class^="mkws"],[class*=" mkws"]').each(function() {
+ node.find(selectorForAllWidgets()).each(function() {
handleNodeWithTeam(this, function(tname, type) {
- var oldHTML = this.innerHTML;
var myTeam = mkws.teams[tname];
- var myWidget = widget(j, myTeam, type, this);
+ if (!myTeam) {
+ myTeam = mkws.teams[tname] = team($, tname);
+ log("made MKWS team '" + tname + "'");
+ }
+
+ var oldHTML = this.innerHTML;
+ var myWidget = widget($, myTeam, type, this);
myTeam.addWidget(myWidget);
var newHTML = this.innerHTML;
if (newHTML !== oldHTML) {
@@ -444,7 +520,8 @@ mkws.pagerNext = function(tname) {
}
- $(document).ready(function() {
+ function init(rootsel) {
+ if (!rootsel) var rootsel = ':root';
var saved_config;
if (typeof mkws_config === 'undefined') {
log("setting empty config");
@@ -457,12 +534,12 @@ mkws.pagerNext = function(tname) {
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 + "'");
- }
+ 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 + "'");
+ }
}
}
@@ -473,17 +550,17 @@ mkws.pagerNext = function(tname) {
mkws.config.lang = lang;
}
- log("Locale language: " + (mkws.config.lang ? mkws.config.lang : "none"));
+ 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: " + mkws.config.query_width);
+ 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("adjust protocol independent links: " + mkws.config.pazpar2_url);
+ log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
}
if (mkws.config.responsive_design_width) {
@@ -497,38 +574,27 @@ mkws.pagerNext = function(tname) {
// 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" ];
+ "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') + "'");
+ node.addClass(id);
+ log("added magic class to '" + node.attr('id') + "'");
}
}
- // 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() {
- handleNodeWithTeam(this, function(tname, type) {
- if (!mkws.teams[tname]) {
- mkws.teams[tname] = team(j, tname);
- log("Made MKWS team '" + tname + "'");
- }
- });
- });
-
- makeWidgetsWithin(1, $(':root'));
-
+ makeWidgetsWithin(1, $(rootsel));
var now = $.now();
- log("Walking MKWS nodes took " + (now-then) + " ms");
+
+ log("walking MKWS nodes took " + (now-then) + " ms");
/*
for (var tName in mkws.teams) {
var myTeam = mkws.teams[tName]
- log("TEAM '" + tName + "' = " + myTeam + " ...");
+ log("team '" + tName + "' = " + myTeam + " ...");
myTeam.visitWidgets(function(t, w) {
log(" has widget of type '" + t + "': " + w);
});
@@ -537,11 +603,15 @@ mkws.pagerNext = function(tname) {
if (mkws.config.use_service_proxy) {
authenticateSession(mkws.config.service_proxy_auth,
- mkws.config.service_proxy_auth_domain,
- mkws.config.pazpar2_url);
+ mkws.config.service_proxy_auth_domain,
+ mkws.config.pazpar2_url);
} else {
// raw pp2
runAutoSearches();
}
+ };
+ $(document).ready(function() {
+ var widgetSelector = selectorForAllWidgets();
+ if (widgetSelector && $(widgetSelector).length !== 0) init();
});
-})(jQuery);
+})(mkws.$);