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