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 // Define empty mkws_config for simple applications that don't define it.
  82 if (mkws_config == null || typeof mkws_config != 'object') {
  83     var mkws_config = {};
  84 }
  85
  86
  87 mkws.log = function(string) {
  88     if (!mkws.log_level)
  89         return;
  90
  91     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
  92         return;
  93     }
  94
  95     // you need to disable use strict at the top of the file!!!
  96     if (mkws.log_level >= 3) {
  97         console.log(arguments.callee.caller);
  98     } else if (mkws.log_level >= 2) {
  99         console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
 100     }
 101     console.log(string);
 102 };
 103
 104
 105 mkws.registerWidgetType = function(name, fn) {
 106     mkws.widgetType2function[name] = fn;
 107     mkws.log("registered widget-type '" + name + "'");
 108 };
 109
 110 mkws.promotionFunction = function(name) {
 111     return mkws.widgetType2function[name];
 112 };
 113
 114
 115 mkws.defaultMkwsConfig = function() {
 116     /* default mkws config */
 117     var config_default = {
 118         use_service_proxy: true,
 119         pazpar2_url: "//mkws.indexdata.com/service-proxy/",
 120         service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
 121         lang: "",
 122         sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 123         perpage_options: [10, 20, 30, 50],
 124         sort_default: "relevance",
 125         perpage_default: 20,
 126         query_width: 50,
 127         show_lang: true,        /* show/hide language menu */
 128         show_sort: true,        /* show/hide sort menu */
 129         show_perpage: true,     /* show/hide perpage menu */
 130         lang_options: [],       /* display languages links for given languages, [] for all */
 131         facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
 132         responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
 133         log_level: 1,     /* log level for development: 0..2 */
 134
 135         dummy: "dummy"
 136     };
 137
 138     // Set global log_level flag early so that log() works
 139     // Fall back to old "debug_level" setting for backwards compatibility
 140     var tmp = mkws_config.log_level;
 141     if (typeof(tmp) === 'undefined') tmp = mkws_config.debug_level;
 142
 143     if (typeof(tmp) !== 'undefined') {
 144         mkws.log_level = tmp;
 145     } else if (typeof(config_default.log_level) !== 'undefined') {
 146         mkws.log_level = config_default.log_level;
 147     }
 148
 149     /* override standard config values by function parameters */
 150     for (var k in config_default) {
 151         if (typeof mkws_config[k] === 'undefined')
 152             mkws_config[k] = config_default[k];
 153         //log("Set config: " + k + ' => ' + mkws_config[k]);
 154     }
 155 };
 156
 157
 158 // wrapper to call team() after page load
 159 (function(j) {
 160     var log = mkws.log;
 161
 162     function handleNodeWithTeam(node, callback) {
 163         // First branch for DOM objects; second branch for jQuery objects
 164         var classes = node.className || node.attr('class');
 165         if (!classes) {
 166             // For some reason, if we try to proceed when classes is
 167             // undefined, we don't get an error message, but this
 168             // function and its callers, up several stack level,
 169             // silently return. What a crock.
 170             log("handleNodeWithTeam() called on node with no classes");
 171             return;
 172         }
 173         var list = classes.split(/\s+/)
 174         var teamName, type;
 175
 176         for (var i = 0; i < list.length; i++) {
 177             var cname = list[i];
 178             if (cname.match(/^mkwsTeam_/)) {
 179                 teamName = cname.replace(/^mkwsTeam_/, '');
 180             } else if (cname.match(/^mkws/)) {
 181                 type = cname.replace(/^mkws/, '');
 182             }
 183         }
 184         callback.call(node, teamName, type);
 185     }
 186
 187
 188     function resizePage() {
 189         var list = ["mkwsSwitch", "mkwsLang"];
 190
 191         var width = mkws_config.responsive_design_width;
 192         var parent = $(".mkwsTermlists").parent();
 193
 194         if ($(window).width() <= width &&
 195             parent.hasClass("mkwsTermlistContainer1")) {
 196             log("changing from wide to narrow: " + $(window).width());
 197             $(".mkwsTermlistContainer1").hide();
 198             $(".mkwsTermlistContainer2").show();
 199             for (var tname in mkws.teams) {
 200                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
 201                 for(var i = 0; i < list.length; i++) {
 202                     $("." + list[i] + ".mkwsTeam_" + tname).hide();
 203                 }
 204             }
 205         } else if ($(window).width() > width &&
 206                    parent.hasClass("mkwsTermlistContainer2")) {
 207             log("changing from narrow to wide: " + $(window).width());
 208             $(".mkwsTermlistContainer1").show();
 209             $(".mkwsTermlistContainer2").hide();
 210             for (var tname in mkws.teams) {
 211                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
 212                 for(var i = 0; i < list.length; i++) {
 213                     $("." + list[i] + ".mkwsTeam_" + tname).show();
 214                 }
 215             }
 216         }
 217     };
 218
 219
 220     // The following functions are dispatchers for team methods that
 221     // are called from the UI using a team-name rather than implicit
 222     // context. Apart from mkws.log, they are the ONLY public UI to
 223     // this module.
 224     mkws.switchView = function(tname, view) {
 225         mkws.teams[tname].switchView(view);
 226     };
 227
 228     mkws.showDetails = function(tname, prefixRecId) {
 229         mkws.teams[tname].showDetails(prefixRecId);
 230     };
 231
 232     mkws.limitTarget  = function(tname, id, name) {
 233         mkws.teams[tname].limitTarget(id, name);
 234     };
 235
 236     mkws.limitQuery  = function(tname, field, value) {
 237         mkws.teams[tname].limitQuery(field, value);
 238     };
 239
 240     mkws.delimitTarget = function(tname, id) {
 241         mkws.teams[tname].delimitTarget(id);
 242     };
 243
 244     mkws.delimitQuery = function(tname, field, value) {
 245         mkws.teams[tname].delimitQuery(field, value);
 246     };
 247
 248     mkws.showPage = function(tname, pageNum) {
 249         mkws.teams[tname].showPage(pageNum);
 250     };
 251
 252     mkws.pagerPrev = function(tname) {
 253         mkws.teams[tname].pagerPrev();
 254     };
 255
 256     mkws.pagerNext = function(tname) {
 257         mkws.teams[tname].pagerNext();
 258     };
 259
 260
 261     /*
 262      * Run service-proxy authentication in background (after page load).
 263      * The username/password is configured in the apache config file
 264      * for the site.
 265      */
 266     function authenticateSession(auth_url, auth_domain, pp2_url) {
 267         log("Run service proxy auth URL: " + auth_url);
 268
 269         if (!auth_domain) {
 270             auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
 271             log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
 272         }
 273
 274         var request = new pzHttpRequest(auth_url, function(err) {
 275             alert("HTTP call for authentication failed: " + err)
 276             return;
 277         }, auth_domain);
 278
 279         request.get(null, function(data) {
 280             if (!$.isXMLDoc(data)) {
 281                 alert("service proxy auth response document is not valid XML document, give up!");
 282                 return;
 283             }
 284             var status = $(data).find("status");
 285             if (status.text() != "OK") {
 286                 alert("service proxy auth response status: " + status.text() + ", give up!");
 287                 return;
 288             }
 289
 290             log("Service proxy auth successfully done");
 291             mkws.authenticated = true;
 292             var authName = $(data).find("displayName").text();
 293             for (var teamName in mkws.teams) {
 294                 mkws.teams[teamName].queue("authenticated").publish(authName);
 295             }
 296
 297             runAutoSearches();
 298         });
 299     }
 300
 301
 302     function runAutoSearches() {
 303         log("running auto searches");
 304
 305         for (var teamName in mkws.teams) {
 306             mkws.teams[teamName].runAutoSearch();
 307         }
 308     }
 309
 310
 311     $(document).ready(function() {
 312         mkws.defaultMkwsConfig();
 313
 314         if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
 315             log("Reset query width: " + mkws_config.query_width);
 316             mkws_config.query_width = 50;
 317         }
 318
 319         for (var key in mkws_config) {
 320             if (mkws_config.hasOwnProperty(key)) {
 321                 if (key.match(/^language_/)) {
 322                     var lang = key.replace(/^language_/, "");
 323                     // Copy custom languages into list
 324                     mkws.locale_lang[lang] = mkws_config[key];
 325                     log("Added locally configured language '" + lang + "'");
 326                 }
 327             }
 328         }
 329
 330         if (mkws_config.responsive_design_width) {
 331             // Responsive web design - change layout on the fly based on
 332             // current screen width. Required for mobile devices.
 333             $(window).resize(resizePage);
 334             // initial check after page load
 335             $(document).ready(resizePage);
 336         }
 337
 338         // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
 339         if (mkws_config.pazpar2_url.match(/^\/\//)) {
 340             mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
 341             log("adjust protocol independent links: " + mkws_config.pazpar2_url);
 342         }
 343
 344         // Backwards compatibility: set new magic class names on any
 345         // elements that have the old magic IDs.
 346         var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
 347                     "Results", "Records", "Targets", "Ranking",
 348                     "Termlists", "Stat", "MOTD" ];
 349         for (var i = 0; i < ids.length; i++) {
 350             var id = 'mkws' + ids[i];
 351             var node = $('#' + id);
 352             if (node.attr('id')) {
 353                 node.addClass(id);
 354                 log("added magic class to '" + node.attr('id') + "'");
 355             }
 356         }
 357
 358         // For all MKWS-classed nodes that don't have a team
 359         // specified, set the team to AUTO.
 360         $('[class^="mkws"],[class*=" mkws"]').each(function() {
 361             if (!this.className.match(/mkwsTeam_/)) {
 362                 log("adding AUTO team to node with class '" + this.className + "'");
 363                 $(this).addClass('mkwsTeam_AUTO');
 364             }
 365         });
 366
 367         // Find all nodes with an MKWS class, and determine their team from
 368         // the mkwsTeam_* class. Make all team objects.
 369         var then = $.now();
 370         $('[class^="mkws"],[class*=" mkws"]').each(function() {
 371             handleNodeWithTeam(this, function(tname, type) {
 372                 if (!mkws.teams[tname]) {
 373                     mkws.teams[tname] = team(j, tname);
 374                     log("Made MKWS team '" + tname + "'");
 375                 }
 376             });
 377         });
 378         // Second pass: make the individual widget objects. This has
 379         // to be done separately, and after the team-creation, since
 380         // that sometimes makes new widget nodes (e.g. creating
 381         // mkwsTermlists inside mkwsResults.
 382         $('[class^="mkws"],[class*=" mkws"]').each(function() {
 383             handleNodeWithTeam(this, function(tname, type) {
 384                 var myTeam = mkws.teams[tname];
 385                 var myWidget = widget(j, myTeam, type, this);
 386             });
 387         });
 388         var now = $.now();
 389         log("Walking MKWS nodes took " + (now-then) + " ms");
 390
 391         if (mkws_config.use_service_proxy) {
 392             authenticateSession(mkws_config.service_proxy_auth,
 393                                 mkws_config.service_proxy_auth_domain,
 394                                 mkws_config.pazpar2_url);
 395         } else {
 396             // raw pp2
 397             runAutoSearches();
 398         }
 399     });
 400 })(jQuery);