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 var mkws = {
  13     authenticated: false,
  14     log_level: 1, // Will be overridden from mkws.config, but
  15                   // initial value allows jQuery popup to use logging.
  16     teams: {},
  17     widgetType2function: {},
  18
  19     locale_lang: {
  20         "de": {
  21             "Authors": "Autoren",
  22             "Subjects": "Schlagw&ouml;rter",
  23             "Sources": "Daten und Quellen",
  24             "source": "datenquelle",
  25             "Termlists": "Termlisten",
  26             "Next": "Weiter",
  27             "Prev": "Zur&uuml;ck",
  28             "Search": "Suche",
  29             "Sort by": "Sortieren nach",
  30             "and show": "und zeige",
  31             "per page": "pro Seite",
  32             "Displaying": "Zeige",
  33             "to": "von",
  34             "of": "aus",
  35             "found": "gefunden",
  36             "Title": "Titel",
  37             "Author": "Autor",
  38             "author": "autor",
  39             "Date": "Datum",
  40             "Subject": "Schlagwort",
  41             "subject": "schlagwort",
  42             "Location": "Ort",
  43             "Records": "Datens&auml;tze",
  44             "Targets": "Datenbanken",
  45
  46             "dummy": "dummy"
  47         },
  48
  49         "da": {
  50             "Authors": "Forfattere",
  51             "Subjects": "Emner",
  52             "Sources": "Kilder",
  53             "source": "kilder",
  54             "Termlists": "Termlists",
  55             "Next": "N&aelig;ste",
  56             "Prev": "Forrige",
  57             "Search": "S&oslash;g",
  58             "Sort by": "Sorter efter",
  59             "and show": "og vis",
  60             "per page": "per side",
  61             "Displaying": "Viser",
  62             "to": "til",
  63             "of": "ud af",
  64             "found": "fandt",
  65             "Title": "Title",
  66             "Author": "Forfatter",
  67             "author": "forfatter",
  68             "Date": "Dato",
  69             "Subject": "Emneord",
  70             "subject": "emneord",
  71             "Location": "Lokation",
  72             "Records": "Poster",
  73             "Targets": "Baser",
  74
  75             "dummy": "dummy"
  76         }
  77     }
  78 };
  79
  80
  81 mkws.log = function(string) {
  82     if (!mkws.log_level)
  83         return;
  84
  85     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
  86         return;
  87     }
  88
  89     // you need to disable use strict at the top of the file!!!
  90     if (mkws.log_level >= 3) {
  91         console.log(arguments.callee.caller);
  92     } else if (mkws.log_level >= 2) {
  93         console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
  94     }
  95     console.log(string);
  96 };
  97
  98
  99 // This function is taken from a StackOverflow answer
 100 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
 101 mkws.getParameterByName = function(name) {
 102     name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
 103     var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
 104         results = regex.exec(location.search);
 105     return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
 106 }
 107
 108
 109 mkws.registerWidgetType = function(name, fn) {
 110     mkws.widgetType2function[name] = fn;
 111     mkws.log("registered widget-type '" + name + "'");
 112 };
 113
 114 mkws.promotionFunction = function(name) {
 115     return mkws.widgetType2function[name];
 116 };
 117
 118
 119 mkws.setMkwsConfig = function(overrides) {
 120     // Set global log_level flag early so that mkws.log() works
 121     // Fall back to old "debug_level" setting for backwards compatibility
 122     var tmp = overrides.log_level;
 123     if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
 124     if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
 125
 126     var config_default = {
 127         use_service_proxy: true,
 128         pazpar2_url: "//mkws.indexdata.com/service-proxy/",
 129         service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
 130         lang: "",
 131         sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 132         perpage_options: [10, 20, 30, 50],
 133         sort_default: "relevance",
 134         perpage_default: 20,
 135         query_width: 50,
 136         show_lang: true,        /* show/hide language menu */
 137         show_sort: true,        /* show/hide sort menu */
 138         show_perpage: true,     /* show/hide perpage menu */
 139         lang_options: [],       /* display languages links for given languages, [] for all */
 140         facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
 141         responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
 142         log_level: 1,     /* log level for development: 0..2 */
 143
 144         dummy: "dummy"
 145     };
 146
 147     mkws.config = Object.create(config_default);
 148     for (var k in overrides) {
 149         mkws.config[k] = overrides[k];
 150     }
 151 };
 152
 153
 154 // The following functions are dispatchers for team methods that
 155 // are called from the UI using a team-name rather than implicit
 156 // context.
 157 mkws.switchView = function(tname, view) {
 158     mkws.teams[tname].switchView(view);
 159 };
 160
 161 mkws.showDetails = function(tname, prefixRecId) {
 162     mkws.teams[tname].showDetails(prefixRecId);
 163 };
 164
 165 mkws.limitTarget  = function(tname, id, name) {
 166     mkws.teams[tname].limitTarget(id, name);
 167 };
 168
 169 mkws.limitQuery  = function(tname, field, value) {
 170     mkws.teams[tname].limitQuery(field, value);
 171 };
 172
 173 mkws.delimitTarget = function(tname, id) {
 174     mkws.teams[tname].delimitTarget(id);
 175 };
 176
 177 mkws.delimitQuery = function(tname, field, value) {
 178     mkws.teams[tname].delimitQuery(field, value);
 179 };
 180
 181 mkws.showPage = function(tname, pageNum) {
 182     mkws.teams[tname].showPage(pageNum);
 183 };
 184
 185 mkws.pagerPrev = function(tname) {
 186     mkws.teams[tname].pagerPrev();
 187 };
 188
 189 mkws.pagerNext = function(tname) {
 190     mkws.teams[tname].pagerNext();
 191 };
 192
 193
 194 // wrapper to call team() after page load
 195 (function(j) {
 196     var log = mkws.log;
 197
 198     function handleNodeWithTeam(node, callback) {
 199         // First branch for DOM objects; second branch for jQuery objects
 200         var classes = node.className || node.attr('class');
 201         if (!classes) {
 202             // For some reason, if we try to proceed when classes is
 203             // undefined, we don't get an error message, but this
 204             // function and its callers, up several stack level,
 205             // silently return. What a crock.
 206             log("handleNodeWithTeam() called on node with no classes");
 207             return;
 208         }
 209         var list = classes.split(/\s+/)
 210         var teamName, type;
 211
 212         for (var i = 0; i < list.length; i++) {
 213             var cname = list[i];
 214             if (cname.match(/^mkwsTeam_/)) {
 215                 teamName = cname.replace(/^mkwsTeam_/, '');
 216             } else if (cname.match(/^mkws/)) {
 217                 type = cname.replace(/^mkws/, '');
 218             }
 219         }
 220         callback.call(node, teamName, type);
 221     }
 222
 223
 224     function resizePage() {
 225         var list = ["mkwsSwitch", "mkwsLang"];
 226
 227         var width = mkws.config.responsive_design_width;
 228         var parent = $(".mkwsTermlists").parent();
 229
 230         if ($(window).width() <= width &&
 231             parent.hasClass("mkwsTermlistContainer1")) {
 232             log("changing from wide to narrow: " + $(window).width());
 233             $(".mkwsTermlistContainer1").hide();
 234             $(".mkwsTermlistContainer2").show();
 235             for (var tname in mkws.teams) {
 236                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
 237                 for(var i = 0; i < list.length; i++) {
 238                     $("." + list[i] + ".mkwsTeam_" + tname).hide();
 239                 }
 240             }
 241         } else if ($(window).width() > width &&
 242                    parent.hasClass("mkwsTermlistContainer2")) {
 243             log("changing from narrow to wide: " + $(window).width());
 244             $(".mkwsTermlistContainer1").show();
 245             $(".mkwsTermlistContainer2").hide();
 246             for (var tname in mkws.teams) {
 247                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
 248                 for(var i = 0; i < list.length; i++) {
 249                     $("." + list[i] + ".mkwsTeam_" + tname).show();
 250                 }
 251             }
 252         }
 253     };
 254
 255
 256     /*
 257      * Run service-proxy authentication in background (after page load).
 258      * The username/password is configured in the apache config file
 259      * for the site.
 260      */
 261     function authenticateSession(auth_url, auth_domain, pp2_url) {
 262         log("Run service proxy auth URL: " + auth_url);
 263
 264         if (!auth_domain) {
 265             auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
 266             log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
 267         }
 268
 269         var request = new pzHttpRequest(auth_url, function(err) {
 270             alert("HTTP call for authentication failed: " + err)
 271             return;
 272         }, auth_domain);
 273
 274         request.get(null, function(data) {
 275             if (!$.isXMLDoc(data)) {
 276                 alert("service proxy auth response document is not valid XML document, give up!");
 277                 return;
 278             }
 279             var status = $(data).find("status");
 280             if (status.text() != "OK") {
 281                 alert("service proxy auth response status: " + status.text() + ", give up!");
 282                 return;
 283             }
 284
 285             log("Service proxy auth successfully done");
 286             mkws.authenticated = true;
 287             var authName = $(data).find("displayName").text();
 288             for (var teamName in mkws.teams) {
 289                 mkws.teams[teamName].queue("authenticated").publish(authName);
 290             }
 291
 292             runAutoSearches();
 293         });
 294     }
 295
 296
 297     function runAutoSearches() {
 298         log("running auto searches");
 299
 300         for (var teamName in mkws.teams) {
 301             mkws.teams[teamName].queue("ready").publish();
 302         }
 303     }
 304
 305     $(document).ready(function() {
 306         var saved_config;
 307         if (typeof mkws_config === 'undefined') {
 308             log("setting empty config");
 309             saved_config = {};
 310         } else {
 311             log("using config: " + $.toJSON(mkws_config));
 312             saved_config = mkws_config;
 313         }
 314         mkws.setMkwsConfig(saved_config);
 315
 316         for (var key in mkws.config) {
 317             if (mkws.config.hasOwnProperty(key)) {
 318                 if (key.match(/^language_/)) {
 319                     var lang = key.replace(/^language_/, "");
 320                     // Copy custom languages into list
 321                     mkws.locale_lang[lang] = mkws.config[key];
 322                     log("Added locally configured language '" + lang + "'");
 323                 }
 324             }
 325         }
 326
 327         if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
 328             log("Reset query width: " + mkws.config.query_width);
 329             mkws.config.query_width = 50;
 330         }
 331
 332         // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
 333         if (mkws.config.pazpar2_url.match(/^\/\//)) {
 334             mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
 335             log("adjust protocol independent links: " + mkws.config.pazpar2_url);
 336         }
 337
 338         if (mkws.config.responsive_design_width) {
 339             // Responsive web design - change layout on the fly based on
 340             // current screen width. Required for mobile devices.
 341             $(window).resize(resizePage);
 342             // initial check after page load
 343             $(document).ready(resizePage);
 344         }
 345
 346         // Backwards compatibility: set new magic class names on any
 347         // elements that have the old magic IDs.
 348         var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
 349                     "Results", "Records", "Targets", "Ranking",
 350                     "Termlists", "Stat", "MOTD" ];
 351         for (var i = 0; i < ids.length; i++) {
 352             var id = 'mkws' + ids[i];
 353             var node = $('#' + id);
 354             if (node.attr('id')) {
 355                 node.addClass(id);
 356                 log("added magic class to '" + node.attr('id') + "'");
 357             }
 358         }
 359
 360         // For all MKWS-classed nodes that don't have a team
 361         // specified, set the team to AUTO.
 362         $('[class^="mkws"],[class*=" mkws"]').each(function() {
 363             if (!this.className.match(/mkwsTeam_/)) {
 364                 log("adding AUTO team to node with class '" + this.className + "'");
 365                 $(this).addClass('mkwsTeam_AUTO');
 366             }
 367         });
 368
 369         // Find all nodes with an MKWS class, and determine their team from
 370         // the mkwsTeam_* class. Make all team objects.
 371         var then = $.now();
 372         $('[class^="mkws"],[class*=" mkws"]').each(function() {
 373             handleNodeWithTeam(this, function(tname, type) {
 374                 if (!mkws.teams[tname]) {
 375                     mkws.teams[tname] = team(j, tname);
 376                     log("Made MKWS team '" + tname + "'");
 377                 }
 378             });
 379         });
 380         // Second pass: make the individual widget objects. This has
 381         // to be done separately, and after the team-creation, since
 382         // that sometimes makes new widget nodes (e.g. creating
 383         // mkwsTermlists inside mkwsResults.
 384         $('[class^="mkws"],[class*=" mkws"]').each(function() {
 385             handleNodeWithTeam(this, function(tname, type) {
 386                 var myTeam = mkws.teams[tname];
 387                 var myWidget = widget(j, myTeam, type, this);
 388             });
 389         });
 390         var now = $.now();
 391         log("Walking MKWS nodes took " + (now-then) + " ms");
 392
 393         if (mkws.config.use_service_proxy) {
 394             authenticateSession(mkws.config.service_proxy_auth,
 395                                 mkws.config.service_proxy_auth_domain,
 396                                 mkws.config.pazpar2_url);
 397         } else {
 398             // raw pp2
 399             runAutoSearches();
 400         }
 401     });
 402 })(jQuery);