src/mkws-core.js

   1 /*! MKWS, the MasterKey Widget Set.
   2  *  Copyright (C) 2013-2014 Index Data
   3  *  See the file LICENSE for details
   4  */
   5
   6 "use strict"; // HTML5: disable for log_level >= 2
   7
   8
   9 // Set up global mkws object. Contains truly global state such as SP
  10 // authentication, and a hash of team objects, indexed by team-name.
  11 //
  12 // We set it as a property of window to make the global explicit as
  13 // some things complain about an implicit global.
  14 window.mkws = {
  15   $: $, // Our own local copy of the jQuery object
  16   authenticated: false,
  17   authenticating: false,
  18   active: false,
  19   log_level: 1, // Will be overridden from mkws.config, but
  20                 // initial value allows jQuery popup to use logging.
  21   teams: {},
  22   widgetType2function: {},
  23
  24   locale_lang: {
  25     "de": {
  26       "Authors": "Autoren",
  27       "Subjects": "Schlagw&ouml;rter",
  28       "Sources": "Daten und Quellen",
  29       "source": "datenquelle",
  30       "Termlists": "Termlisten",
  31       "Next": "Weiter",
  32       "Prev": "Zur&uuml;ck",
  33       "Search": "Suche",
  34       "Sort by": "Sortieren nach",
  35       "and show": "und zeige",
  36       "per page": "pro Seite",
  37       "Displaying": "Zeige",
  38       "to": "von",
  39       "of": "aus",
  40       "found": "gefunden",
  41       "Title": "Titel",
  42       "Author": "Autor",
  43       "author": "autor",
  44       "Date": "Datum",
  45       "Subject": "Schlagwort",
  46       "subject": "schlagwort",
  47       "Location": "Ort",
  48       "Records": "Datens&auml;tze",
  49       "Targets": "Datenbanken",
  50
  51       "dummy": "dummy"
  52     },
  53
  54     "da": {
  55       "Authors": "Forfattere",
  56       "Subjects": "Emner",
  57       "Sources": "Kilder",
  58       "source": "kilder",
  59       "Termlists": "Termlists",
  60       "Next": "N&aelig;ste",
  61       "Prev": "Forrige",
  62       "Search": "S&oslash;g",
  63       "Sort by": "Sorter efter",
  64       "and show": "og vis",
  65       "per page": "per side",
  66       "Displaying": "Viser",
  67       "to": "til",
  68       "of": "ud af",
  69       "found": "fandt",
  70       "Title": "Title",
  71       "Author": "Forfatter",
  72       "author": "forfatter",
  73       "Date": "Dato",
  74       "Subject": "Emneord",
  75       "subject": "emneord",
  76       "Location": "Lokation",
  77       "Records": "Poster",
  78       "Targets": "Baser",
  79
  80       "dummy": "dummy"
  81     }
  82   }
  83 };
  84
  85 // We may be using a separate copy
  86 if (typeof(mkws_jQuery) !== "undefined") {
  87   mkws.$ = mkws_jQuery;
  88 } else {
  89   mkws.$ = jQuery;
  90 }
  91
  92 mkws.log = function(string) {
  93   if (!mkws.log_level)
  94     return;
  95
  96   if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
  97     return;
  98   }
  99
 100   // you need to disable use strict at the top of the file!!!
 101   if (mkws.log_level >= 3) {
 102     // Works in Chrome; not sure about elsewhere
 103     console.trace();
 104   } else if (mkws.log_level >= 2) {
 105     console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
 106   }
 107   console.log(string);
 108 };
 109
 110
 111 // Incredible that the standard JavaScript runtime doesn't define a
 112 // unique windowId. Instead, we have to make one up. And since there's
 113 // no global area shared between windows, the best we can do for
 114 // ensuring uniqueness is generating a random ID and crossing our
 115 // fingers. We stash this in window.name, as it's the only place to
 116 // keep data that is preserved across reloads and within-site
 117 // navigation. pz2.js picks this up and uses it as part of the
 118 // cookie-name, to ensure each tab gets its own session.
 119 if (window.name) {
 120   mkws.log("Using existing window.name '" + window.name + "'");
 121 } else {
 122   // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations.
 123   // At one per second, it will take 116 million years to duplicate a session
 124   window.name = Math.random().toString(36).slice(2, 12);
 125   mkws.log("Generated new window.name '" + window.name + "'");
 126 }
 127
 128
 129 // Translation function.
 130 mkws.M = function(word) {
 131   var lang = mkws.config.lang;
 132
 133   if (!lang || !mkws.locale_lang[lang])
 134     return word;
 135
 136   return mkws.locale_lang[lang][word] || word;
 137 };
 138
 139
 140 // This function is taken from a StackOverflow answer
 141 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
 142 mkws.getParameterByName = function(name, url) {
 143   if (!url) url = location.search;
 144   name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
 145   var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
 146   results = regex.exec(url);
 147   return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
 148 }
 149
 150
 151 mkws.registerWidgetType = function(name, fn) {
 152   mkws.widgetType2function[name] = fn;
 153   mkws.log("registered widget-type '" + name + "'");
 154 };
 155
 156 mkws.promotionFunction = function(name) {
 157   return mkws.widgetType2function[name];
 158 };
 159
 160
 161 mkws.setMkwsConfig = function(overrides) {
 162   // Set global log_level flag early so that mkws.log() works
 163   // Fall back to old "debug_level" setting for backwards compatibility
 164   var tmp = overrides.log_level;
 165   if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
 166   if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
 167
 168   var config_default = {
 169     use_service_proxy: true,
 170     pazpar2_url:        "//mkws.indexdata.com/service-proxy/",
 171     service_proxy_auth: undefined, // generally rolled from the next three properties
 172     // Was: //mkws.indexdata.com/service-proxy-auth
 173     pp2_hostname: "mkws.indexdata.com",
 174     sp_path: "service-proxy-auth",
 175     sp_auth_query: undefined, // Will be: "command=auth&action=perconfig",
 176     sp_auth_credentials: undefined,
 177     lang: "",
 178     sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 179     perpage_options: [10, 20, 30, 50],
 180     sort_default: "relevance",
 181     perpage_default: 20,
 182     query_width: 50,
 183     show_lang: true,    /* show/hide language menu */
 184     show_sort: true,    /* show/hide sort menu */
 185     show_perpage: true, /* show/hide perpage menu */
 186     show_switch: true,  /* show/hide switch menu */
 187     lang_options: [],   /* display languages links for given languages, [] for all */
 188     facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
 189     responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
 190     log_level: 1,     /* log level for development: 0..2 */
 191
 192     dummy: "dummy"
 193   };
 194
 195   mkws.config = mkws.objectInheritingFrom(config_default);
 196   for (var k in overrides) {
 197     mkws.config[k] = overrides[k];
 198   }
 199 };
 200
 201
 202 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
 203 // http://javascript.crockford.com/prototypal.html
 204 // mkws.objectInheritingFrom behaves the same as Object.create,
 205 // but since the latter is not available in IE8 we can't use it.
 206 //
 207 mkws.objectInheritingFrom = function(o) {
 208   function F() {}
 209   F.prototype = o;
 210   return new F();
 211 }
 212
 213
 214 mkws.defaultTemplate = function(name) {
 215   if (name === 'Record') {
 216     return '\
 217 <table>\
 218   <tr>\
 219     <th>{{mkws-translate "Title"}}</th>\
 220     <td>\
 221       {{md-title}}\
 222       {{#if md-title-remainder}}\
 223         ({{md-title-remainder}})\
 224       {{/if}}\
 225       {{#if md-title-responsibility}}\
 226         <i>{{md-title-responsibility}}</i>\
 227       {{/if}}\
 228     </td>\
 229   </tr>\
 230   {{#if md-date}}\
 231   <tr>\
 232     <th>{{mkws-translate "Date"}}</th>\
 233     <td>{{md-date}}</td>\
 234   </tr>\
 235   {{/if}}\
 236   {{#if md-author}}\
 237   <tr>\
 238     <th>{{mkws-translate "Author"}}</th>\
 239     <td>{{md-author}}</td>\
 240   </tr>\
 241   {{/if}}\
 242   {{#if md-electronic-url}}\
 243   <tr>\
 244     <th>{{mkws-translate "Links"}}</th>\
 245     <td>\
 246       {{#each md-electronic-url}}\
 247         <a href="{{this}}">Link{{mkws-index1}}</a>\
 248       {{/each}}\
 249     </td>\
 250   </tr>\
 251   {{/if}}\
 252   {{#mkws-if-any location having="md-subject"}}\
 253   <tr>\
 254     <th>{{mkws-translate "Subject"}}</th>\
 255     <td>\
 256       {{#mkws-first location having="md-subject"}}\
 257         {{#if md-subject}}\
 258           {{#mkws-commaList md-subject}}\
 259             {{this}}{{/mkws-commaList}}\
 260         {{/if}}\
 261       {{/mkws-first}}\
 262     </td>\
 263   </tr>\
 264   {{/mkws-if-any}}\
 265   <tr>\
 266     <th>{{mkws-translate "Locations"}}</th>\
 267     <td>\
 268       {{#mkws-commaList location}}\
 269         {{mkws-attr "@name"}}{{/mkws-commaList}}\
 270     </td>\
 271   </tr>\
 272 </table>\
 273 ';
 274   } else if (name === "Summary") {
 275     return '\
 276 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
 277   <b>{{md-title}}</b>\
 278 </a>\
 279 {{#if md-title-remainder}}\
 280   <span>{{md-title-remainder}}</span>\
 281 {{/if}}\
 282 {{#if md-title-responsibility}}\
 283   <span><i>{{md-title-responsibility}}</i></span>\
 284 {{/if}}\
 285 {{#if md-date}}, {{md-date}}\
 286 {{#if location}}\
 287 , {{#mkws-first location}}{{mkws-attr "@name"}}{{/mkws-first}}\
 288 {{/if}}\
 289 {{#if md-medium}}\
 290 <span>, {{md-medium}}</span>\
 291 {{/if}}\
 292 {{/if}}\
 293 ';
 294   } else if (name === "Image") {
 295     return '\
 296       <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
 297         {{#mkws-first md-thumburl}}\
 298           <img src="{{this}}" alt="{{../md-title}}"/>\
 299         {{/mkws-first}}\
 300         <br/>\
 301       </a>\
 302 ';
 303   } else if (name === 'Facet') {
 304     return '\
 305 <a href="#"\
 306 {{#if fn}}\
 307 onclick="mkws.{{fn}}(\'{{team}}\', \'{{field}}\', \'{{term}}\');return false;"\
 308 {{/if}}\
 309 >{{term}}</a>\
 310 <span>{{count}}</span>\
 311 ';
 312   }
 313
 314   return null;
 315 };
 316
 317
 318 // The following functions are dispatchers for team methods that
 319 // are called from the UI using a team-name rather than implicit
 320 // context.
 321 mkws.switchView = function(tname, view) {
 322   mkws.teams[tname].switchView(view);
 323 };
 324
 325 mkws.showDetails = function(tname, prefixRecId) {
 326   mkws.teams[tname].showDetails(prefixRecId);
 327 };
 328
 329 mkws.limitTarget  = function(tname, id, name) {
 330   mkws.teams[tname].limitTarget(id, name);
 331 };
 332
 333 mkws.limitQuery  = function(tname, field, value) {
 334   mkws.teams[tname].limitQuery(field, value);
 335 };
 336
 337 mkws.limitCategory  = function(tname, id) {
 338   mkws.teams[tname].limitCategory(id);
 339 };
 340
 341 mkws.delimitTarget = function(tname, id) {
 342   mkws.teams[tname].delimitTarget(id);
 343 };
 344
 345 mkws.delimitQuery = function(tname, field, value) {
 346   mkws.teams[tname].delimitQuery(field, value);
 347 };
 348
 349 mkws.showPage = function(tname, pageNum) {
 350   mkws.teams[tname].showPage(pageNum);
 351 };
 352
 353 mkws.pagerPrev = function(tname) {
 354   mkws.teams[tname].pagerPrev();
 355 };
 356
 357 mkws.pagerNext = function(tname) {
 358   mkws.teams[tname].pagerNext();
 359 };
 360
 361
 362 // wrapper to provide local copy of the jQuery object.
 363 (function($) {
 364   var log = mkws.log;
 365
 366   function handleNodeWithTeam(node, callback) {
 367     // First branch for DOM objects; second branch for jQuery objects
 368     var classes = node.className || node.attr('class');
 369     if (!classes) {
 370       // For some reason, if we try to proceed when classes is
 371       // undefined, we don't get an error message, but this
 372       // function and its callers, up several stack level,
 373       // silently return. What a crock.
 374       log("handleNodeWithTeam() called on node with no classes");
 375       return;
 376     }
 377     var list = classes.split(/\s+/)
 378     var teamName, type;
 379
 380     for (var i = 0; i < list.length; i++) {
 381       var cname = list[i];
 382       if (cname.match(/^mkwsTeam_/)) {
 383         teamName = cname.replace(/^mkwsTeam_/, '');
 384       } else if (cname.match(/^mkws/)) {
 385         type = cname.replace(/^mkws/, '');
 386       }
 387     }
 388
 389     // Widgets without a team are on team "AUTO"
 390     if (!teamName) {
 391       teamName = "AUTO";
 392       // Autosearch widgets don't join team AUTO if there is already an
 393       // autosearch on the team or the team has otherwise gotten a query
 394       if (node.hasAttribute("autosearch")) {
 395         if (mkws.autoHasAuto ||
 396             mkws.teams["AUTO"] && mkws.teams["AUTO"].config["query"]) {
 397           log("AUTO team already has a query, using unique team");
 398           teamName = "UNIQUE";
 399         }
 400         mkws.autoHasAuto = true;
 401       }
 402     }
 403
 404     // Widgets on team "UNIQUE" get a random team
 405     if (teamName === "UNIQUE") {
 406       teamName = Math.floor(Math.random() * 100000000).toString();
 407     }
 408
 409     callback.call(node, teamName, type);
 410   }
 411
 412
 413   function resizePage() {
 414     var threshhold = mkws.config.responsive_design_width;
 415     var width = $(window).width();
 416     var from, to, method;
 417
 418     if ((mkws.width === undefined || mkws.width > threshhold) &&
 419         width <= threshhold) {
 420       from = "wide"; to = "narrow"; method = "hide";
 421     } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
 422                width > threshhold) {
 423       from = "narrow"; to = "wide"; method = "show";
 424     }
 425     mkws.width = width;
 426
 427     if (from) {
 428       log("changing from " + from + " to " + to + ": " + width);
 429       for (var tname in mkws.teams) {
 430         var team = mkws.teams[tname];
 431         team.visitWidgets(function(t, w) {
 432           var w1 = team.widget(t + "-Container-" + from);
 433           var w2 = team.widget(t + "-Container-" + to);
 434           if (w1) {
 435             w1.node.hide();
 436           }
 437           if (w2) {
 438             w2.node.show();
 439             w.node.appendTo(w2.node);
 440           }
 441         });
 442         team.queue("resize-" + to).publish();
 443       }
 444     }
 445   };
 446
 447
 448   /*
 449    * Run service-proxy authentication in background (after page load).
 450    * The username/password is configured in the apache config file
 451    * for the site.
 452    */
 453   function authenticateSession(auth_url, auth_domain, pp2_url) {
 454     mkws.authenticating = true;
 455     log("service proxy authentication on URL: " + auth_url);
 456
 457     if (!auth_domain) {
 458       auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
 459       log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
 460     }
 461
 462     var request = new pzHttpRequest(auth_url, function(err) {
 463       alert("HTTP call for authentication failed: " + err)
 464       return;
 465     }, auth_domain);
 466
 467     request.get(null, function(data) {
 468       mkws.authenticating = false;
 469       if (!$.isXMLDoc(data)) {
 470         alert("Service Proxy authentication response is not a valid XML document");
 471         return;
 472       }
 473       var status = $(data).find("status");
 474       if (status.text() != "OK") {
 475         var message = $(data).find("message");
 476         alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")");
 477         return;
 478       }
 479
 480       log("service proxy authentication successful");
 481       mkws.authenticated = true;
 482       var authName = $(data).find("displayName").text();
 483       // You'd think there would be a better way to do this:
 484       var realm = $(data).find("realm:not(realmAttributes realm)").text();
 485       for (var teamName in mkws.teams) {
 486         mkws.teams[teamName].queue("authenticated").publish(authName, realm);
 487       }
 488
 489       runAutoSearches();
 490     });
 491   }
 492
 493
 494   function runAutoSearches() {
 495     log("running auto searches");
 496
 497     for (var teamName in mkws.teams) {
 498       mkws.teams[teamName].queue("ready").publish();
 499     }
 500   }
 501
 502
 503   function selectorForAllWidgets() {
 504     if (mkws.config && mkws.config.scan_all_nodes) {
 505       // This is the old version, which works by telling jQuery to
 506       // find every node that has a class beginning with "mkws". In
 507       // theory it should be slower than the class-based selector; but
 508       // instrumentation suprisnigly shows this is consistently
 509       // faster. It also has the advantage that any widgets of
 510       // non-registered types are logged as warnings rather than
 511       // silently ignored.
 512       return '[class^="mkws"],[class*=" mkws"]';
 513     } else {
 514       // This is the new version, which works by looking up the
 515       // specific classes of all registered widget types and their
 516       // resize containers. Because all it requires jQuery to do is
 517       // some hash lookups in pre-built tables, it should be very
 518       // fast; but it silently ignores widgets of unregistered types.
 519       var s = "";
 520       for (var type in mkws.widgetType2function) {
 521         if (s) s += ',';
 522         s += '.mkws' + type;
 523         s += ',.mkws' + type + "-Container-wide";
 524         s += ',.mkws' + type + "-Container-narrow";
 525       }
 526       return s;
 527     }
 528   }
 529
 530
 531   function makeWidgetsWithin(level, node) {
 532     if (node) var widgetNodes = node.find(selectorForAllWidgets());
 533     else widgetNodes = $(selectorForAllWidgets());
 534     // Return false if we parse no widgets
 535     if (widgetNodes.length < 1) return false;
 536     widgetNodes.each(function() {
 537       handleNodeWithTeam(this, function(tname, type) {
 538         var myTeam = mkws.teams[tname];
 539         if (!myTeam) {
 540           myTeam = mkws.teams[tname] = team($, tname);
 541           log("made MKWS team '" + tname + "'");
 542         }
 543
 544         var oldHTML = this.innerHTML;
 545         var myWidget = widget($, myTeam, type, this);
 546         myTeam.addWidget(myWidget);
 547         var newHTML = this.innerHTML;
 548         if (newHTML !== oldHTML) {
 549           log("widget " + tname + ":" + type + " HTML changed: reparsing");
 550           makeWidgetsWithin(level+1, $(this));
 551         }
 552       });
 553     });
 554     return true;
 555   }
 556
 557
 558   // The second "rootsel" parameter is passed to jQuery and is a DOM node
 559   // or a selector string you would like to constrain the search for widgets to.
 560   //
 561   // This function has no side effects if run again on an operating session,
 562   // even if the element/selector passed causes existing widgets to be reparsed:
 563   //
 564   // (TODO: that last bit isn't true and we currently have to avoid reinitialising
 565   // widgets, MKWS-261)
 566   //
 567   // * configuration is not regenerated
 568   // * authentication is not performed again
 569   // * autosearches are not re-run
 570   mkws.init = function(message, rootsel) {
 571     var greet = "MKWS initialised";
 572     if (rootsel) greet += " (limited to " + rootsel + ")"
 573     if (message) greet += " :: " + message;
 574     mkws.log(greet);
 575
 576     // TODO: Let's remove this soon
 577     // Backwards compatibility: set new magic class names on any
 578     // elements that have the old magic IDs.
 579     var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
 580                 "Results", "Records", "Targets", "Ranking",
 581                 "Termlists", "Stat", "MOTD" ];
 582     for (var i = 0; i < ids.length; i++) {
 583       var id = 'mkws' + ids[i];
 584       var node = $('#' + id);
 585       if (node.attr('id')) {
 586         node.addClass(id);
 587         log("added magic class to '" + node.attr('id') + "'");
 588       }
 589     }
 590
 591     // MKWS is not active until init() has been run against an object with widget nodes.
 592     // We only set initial configuration when MKWS is first activated.
 593     if (!mkws.isActive) {
 594       var widgetSelector = selectorForAllWidgets();
 595       if ($(widgetSelector).length < 1) {
 596         mkws.log("no widgets found");
 597         return;
 598       }
 599
 600       // Initial configuration
 601       mkws.autoHasAuto = false;
 602       var saved_config;
 603       if (typeof mkws_config === 'undefined') {
 604         log("setting empty config");
 605         saved_config = {};
 606       } else {
 607         log("using config: " + $.toJSON(mkws_config));
 608         saved_config = mkws_config;
 609       }
 610       mkws.setMkwsConfig(saved_config);
 611
 612       for (var key in mkws.config) {
 613         if (mkws.config.hasOwnProperty(key)) {
 614           if (key.match(/^language_/)) {
 615             var lang = key.replace(/^language_/, "");
 616             // Copy custom languages into list
 617             mkws.locale_lang[lang] = mkws.config[key];
 618             log("added locally configured language '" + lang + "'");
 619           }
 620         }
 621       }
 622
 623       var lang = mkws.getParameterByName("lang") || mkws.config.lang;
 624       if (!lang || !mkws.locale_lang[lang]) {
 625         mkws.config.lang = ""
 626       } else {
 627         mkws.config.lang = lang;
 628       }
 629
 630       log("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
 631
 632       if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
 633         log("reset query width to " + mkws.config.query_width);
 634         mkws.config.query_width = 50;
 635       }
 636
 637       // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
 638       if (mkws.config.pazpar2_url.match(/^\/\//)) {
 639         mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
 640         log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
 641       }
 642
 643       if (mkws.config.responsive_design_width) {
 644         // Responsive web design - change layout on the fly based on
 645         // current screen width. Required for mobile devices.
 646         $(window).resize(resizePage);
 647         // initial check after page load
 648         $(document).ready(resizePage);
 649       }
 650     }
 651
 652     var then = $.now();
 653     // If we've made no widgets, return without starting an SP session
 654     // or marking MKWS active.
 655     if (makeWidgetsWithin(1, rootsel ? $(rootsel) : undefined) === false) {
 656       return false;
 657     }
 658     var now = $.now();
 659
 660     log("walking MKWS nodes took " + (now-then) + " ms");
 661
 662     /*
 663       for (var tName in mkws.teams) {
 664       var myTeam = mkws.teams[tName]
 665       log("team '" + tName + "' = " + myTeam + " ...");
 666       myTeam.visitWidgets(function(t, w) {
 667       log("  has widget of type '" + t + "': " + w);
 668       });
 669       }
 670     */
 671
 672     function sp_auth_url(config) {
 673       if (config.service_proxy_auth) {
 674         mkws.log("using pre-baked sp_auth_url '" + config.service_proxy_auth + "'");
 675         return config.service_proxy_auth;
 676       } else {
 677         var s = '//';
 678         s += config.auth_hostname ? config.auth_hostname : config.pp2_hostname;
 679         s += '/' + config.sp_path;
 680         var q = config.sp_auth_query;
 681         if (q) {
 682           s += '?' + q;
 683         }
 684         var c = config.sp_auth_credentials;
 685         if (c) {
 686           s += ('&username=' + c.substr(0, c.indexOf('/')) +
 687                 '&password=' + c.substr(c.indexOf('/')+1));
 688         }
 689         mkws.log("generated sp_auth_url '" + s + "'");
 690         return s;
 691       }
 692     }
 693
 694     if (mkws.config.use_service_proxy && !mkws.authenticated && !mkws.authenticating) {
 695       authenticateSession(sp_auth_url(mkws.config),
 696                           mkws.config.service_proxy_auth_domain,
 697                           mkws.config.pazpar2_url);
 698     } else if (!mkws.authenticating) {
 699       // raw pp2 or we have a session already open
 700       runAutoSearches();
 701     }
 702
 703     mkws.isActive = true;
 704     return true;
 705   };
 706
 707   $(document).ready(function() {
 708     if (!window.mkws_noready && !mkws.authenticating && !mkws.active) {
 709        mkws.init();
 710     }
 711   });
 712
 713 })(mkws.$);