Config option to specify cookie domain for auth
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 380956a..4f4cc5c 100644 (file)
@@ -1,32 +1,22 @@
 /* A very simple client that shows a basic usage of the pz2.js
 */
 
-"use strict"; // HTML5: disable for debug >= 2
+"use strict"; // HTML5: disable for debug_level >= 2
 
 // Set up namespace and some state.
 var mkws = {};
 
-if (!mkws_config)
-    var mkws_config = {}; // for the guys who forgot to define mkws_config...
-
-// Wrapper for jQuery
-(function ($) {
-
 /*
  * global config object: mkws_config
  *
- * needs to be defined in the HTML header before
- * including this JS file
+ * Needs to be defined in the HTML header before including this JS file.
+ * Define empty mkws_config for simple applications that don't define it.
  */
+if (!mkws_config)
+    var mkws_config = {};
 
-if (typeof mkws_config.use_service_proxy === 'undefined')
-    mkws_config.use_service_proxy = true;
-
-var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
-var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
-
-mkws.pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
-mkws.usesessions = mkws_config.use_service_proxy ? false : true;
+// Wrapper for jQuery
+(function ($) {
 
 mkws.locale_lang = {
     "de": {
@@ -49,6 +39,7 @@ mkws.locale_lang = {
        "Date": "Datum",
        "Subject": "Schlagwort",
        "Location": "Ort",
+       // ### to add: Records, Targets
 
        "dummy": "dummy"
     },
@@ -73,6 +64,7 @@ mkws.locale_lang = {
        "Date": "Dato",
        "Subject": "Emneord",
        "Location": "Lokation",
+       // ### to add: Records, Targets
 
        "dummy": "dummy"
     }
@@ -83,8 +75,9 @@ mkws.debug_time = {
     "start": $.now(),
     "last": $.now()
 };
-mkws.debug = function (string) {
-    if (!mkws.debug)
+
+mkws.debug_function = function (string) {
+    if (!mkws.debug_level)
        return;
 
     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
@@ -96,14 +89,56 @@ mkws.debug = function (string) {
     mkws.debug_time.last = now;
 
     // you need to disable use strict at the top of the file!!!
-    if (mkws.debug >= 3) {
+    if (mkws.debug_level >= 3) {
        console.log(timestamp + arguments.callee.caller);
-    } else if (mkws.debug >= 2) {
+    } else if (mkws.debug_level >= 2) {
        console.log(timestamp + ">>> called from function " + arguments.callee.caller.name + ' <<<');
     }
     console.log(timestamp + string);
 }
-var debug = mkws.debug; // local alias
+var debug = mkws.debug_function; // local alias
+
+{
+    /* default mkws config */
+    var config_default = {
+       use_service_proxy: true,
+       service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth",
+       lang: "",
+       sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
+       perpage_options: [10, 20, 30, 50],
+       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 */
+       facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
+       responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
+       debug_level: 1,     /* debug level for development: 0..2 */
+
+       dummy: "dummy"
+    };
+
+    /* set global debug_level flag early */
+    if (typeof mkws_config.debug_level !== 'undefined') {
+       mkws.debug_level = mkws_config.debug_level;
+    } else if (typeof config_default.debug_level !== 'undefined') {
+       mkws.debug_level = config_default.debug_level;
+    }
+
+    /* override standard config values by function parameters */
+    for (var k in config_default) {
+       if (typeof mkws_config[k] === 'undefined')
+          mkws_config[k] = config_default[k];
+       debug("Set config: " + k + ' => ' + mkws_config[k]);
+    }
+}
+
+if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
+    debug("Reset query width: " + mkws_config.query_width);
+    mkws_config.query_width = 50;
+}
 
 for (var key in mkws_config) {
     if (mkws_config.hasOwnProperty(key)) {
@@ -111,6 +146,7 @@ for (var key in mkws_config) {
            var lang = key.replace(/^language_/, "");
            // Copy custom languages into list
            mkws.locale_lang[lang] = mkws_config[key];
+           debug("Added locally configured language '" + lang + "'");
        }
     }
 }
@@ -121,13 +157,13 @@ for (var key in mkws_config) {
 // autoInit is set to true on default
 var my_paz = new pz2( { "onshow": my_onshow,
                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
-                    "pazpar2path": mkws.pazpar2path,
+                    "pazpar2path": mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/",
                     "oninit": my_oninit,
                     "onstat": my_onstat,
                     "onterm": my_onterm,
                     "termlist": "xtargets,subject,author",
                     "onbytarget": my_onbytarget,
-                   "usesessions" : mkws.usesessions,
+                   "usesessions" : mkws_config.use_service_proxy ? false : true,
                     "showResponseType": '', // or "json" (for debugging?)
                     "onrecord": my_onrecord } );
 
@@ -171,7 +207,6 @@ function my_onshow(data) {
     for (var i = 0; i < data.hits.length; i++) {
         var hit = data.hits[i];
              html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
-            +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
             +'<a href="#" id="mkwsRec_'+hit.recid
             +'" onclick="mkws.showDetails(this.id);return false;"><b>'
             + hit["md-title"] +' </b></a>');
@@ -194,11 +229,11 @@ function my_onstat(data) {
     if (stat == null)
        return;
 
-    stat.innerHTML = '<span class="head">Status info</span>' +
+    stat.innerHTML = '<span class="head">' + M('Status info') + '</span>' +
        ' -- ' +
-       '<span class="clients">' + data.activeclients + '/' + data.clients + '</span>' +
+       '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
        ' -- ' +
-        '<span class="records">' + data.records + '/' + data.hits + '</span>';
+        '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>';
 }
 
 function my_onterm(data) {
@@ -271,8 +306,13 @@ function my_onbytarget(data) {
        return;
     }
 
-    var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
-        +'<td>Records</td><td>State</td></tr></thead><tbody>';
+    var table ='<table><thead><tr>' +
+       '<td>' + M('Target ID') + '</td>' +
+       '<td>' + M('Hits') + '</td>' +
+       '<td>' + M('Diags') + '</td>' +
+       '<td>' + M('Records') + '</td>' +
+       '<td>' + M('State') + '</td>' +
+       '</tr></thead><tbody>';
 
     for (var i = 0; i < data.length; i++ ) {
         table += "<tr><td>" + data[i].id +
@@ -515,14 +555,23 @@ function replaceHtml(el, html) {
 function renderDetails(data, marker)
 {
     var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
-    if (marker) details += '<tr><td>'+ marker + '</td></tr>';
+    if (marker) details += '<tr><td colspan="2">'+ marker + '</td></tr>';
+
+    var locations = [];
+    for (var i in data.location) {
+       locations.push(data.location[i]['@name']);
+    }
 
     details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
     details += renderField("Date", data["md-date"]);
     details += renderField("Author", data["md-author"]);
     details += renderField("URL", data["md-electronic-url"]);
     details += renderField("Subject", data["location"][0]["md-subject"]);
-    details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
+    if (locations.length == 0) {
+       details += '<tr><td colspan="2">No locations for record!</td></tr>';
+    } else {
+       details += renderField("Location" + (locations.length == 1 ? "" : "s"), locations);
+    }
     details += '</table></div>';
 
     return details;
@@ -533,19 +582,27 @@ function renderField(caption, data, data2, data3) {
        return "";
     }
 
-    if (caption == "URL") {
-       data = '<a href="' + data + '" target="_blank">' + data + '</a>';
+    var res = "";
+    for (var i = 0; i < data.length; i++) {
+       var s = data[i];
+       if (i > 0)
+           res += ", ";
+
+       if (caption == "URL")
+           s = '<a href="' + s + '" target="_blank">' + s + '</a>';
+
+       res += s
     }
 
     if (data2 != undefined) {
-       data = data + " (" + data2 + ")";
+       res = res + " (" + data2 + ")";
     }
 
     if (data3 != undefined) {
-       data = data + " <i>" + data3 + "</i>";
+       res = res + " <i>" + data3 + "</i>";
     }
 
-    return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
+    return '<tr><th>' + M(caption) + '</th><td>' + res + '</td></tr>';
 }
 
 
@@ -553,52 +610,10 @@ function renderField(caption, data, data2, data3) {
  * All the HTML stuff to render the search forms and
  * result pages.
  */
-function mkws_html_all(config) {
-
-    /* default mkws config */
-    /* ### No defaults given for:
-     * lang, responsive_design, service_proxy_auth, use_service_proxy
-     * and of course the optional language_* entries.
-     */
-    var mkws_config_default = {
-       sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
-       perpage: [10, 20, 30, 50],
-       sort_default: "relevance",
-       perpage_default: 20,
-       query_width: 50,
-       lang_menu: true,        /* show/hide language menu */
-       sort_menu: true,        /* show/hide sort menu */
-       perpage_menu: true,     /* show/hide perpage menu */
-       lang_display: [],       /* display languages links for given languages, [] for all */
-       facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
-       responsive_design_width: 980, /* a page with less pixel width considered as narrow */
-       debug: 1,     /* debug level for development: 0..2 */
-
-       dummy: "dummy"
-    };
-
-    /* set global debug flag early */
-    if (typeof config.debug !== 'undefined') {
-       mkws.debug = config.debug;
-    } else if (typeof mkws_config_default.debug !== 'undefined') {
-       mkws.debug = mkws_config_default.debug;
-    }
-
-    /* override standard config values by function parameters */
-    for (var k in mkws_config_default) {
-       if (typeof config[k] === 'undefined')
-          mkws_config[k] = mkws_config_default[k];
-       debug("Set config: " + k + ' => ' + mkws_config[k]);
-    }
-
-    if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
-       debug("Reset query width: " + mkws_config.query_width);
-       mkws_config.query_width = 50;
-    }
-
-    mkws_set_lang(mkws_config);
-    if (mkws_config.lang_menu)
-       mkws_html_lang(mkws_config);
+function mkws_html_all() {
+    mkws_set_lang();
+    if (mkws_config.show_lang)
+       mkws_html_lang();
 
     // For some reason, doing this programmatically results in
     // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
@@ -643,23 +658,24 @@ function mkws_html_all(config) {
     if ($("#mkwsRanking").length) {
        var ranking_data = '';
        ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
-       if (config.sort_menu) {
-           ranking_data +=  M('Sort by') + ' ' + mkws_html_sort(config) + ' ';
+       if (mkws_config.show_sort) {
+           ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
        }
-       if (config.perpage_menu) {
-           ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.';
+       if (mkws_config.show_perpage) {
+           ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
        }
         ranking_data += '</form>';
 
        $("#mkwsRanking").html(ranking_data);
     }
 
-    mkws_html_switch(config);
+    mkws_html_switch();
 
     if (mkws_config.use_service_proxy)
-       mkws_service_proxy_auth(config.service_proxy_auth);
+         mkws_service_proxy_auth(mkws_config.service_proxy_auth, 
+          mkws_config.service_proxy_auth_domain);
 
-    if (mkws_config.responsive_design) {
+    if (mkws_config.responsive_design_width) {
        // Responsive web design - change layout on the fly based on
        // current screen width. Required for mobile devices.
        $(window).resize( function(e) { mkws_resize_page() });
@@ -680,8 +696,8 @@ function mkws_html_all(config) {
     }
 }
 
-function mkws_set_lang(mkws_config)  {
-    var lang = $.parseQuerystring().lang || mkws_config.lang || "";
+function mkws_set_lang()  {
+    var lang = $.parseQuerystring().lang || mkws_config.lang;
     if (!lang || !mkws.locale_lang[lang]) {
        mkws_config.lang = ""
     } else {
@@ -692,12 +708,12 @@ function mkws_set_lang(mkws_config)  {
     return mkws_config.lang;
 }
 
-function mkws_html_switch(config) {
+function mkws_html_switch() {
     debug("HTML switch");
 
-    $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_records" onclick="mkws.switchView(\'records\')">' + M("Records") + '</a>'));
+    $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_records" onclick="mkws.switchView(\'records\')">' + M('Records') + '</a>'));
     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
-    $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_targets" onclick="mkws.switchView(\'targets\')">' + M("Targets") + '</a>'));
+    $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_targets" onclick="mkws.switchView(\'targets\')">' + M('Targets') + '</a>'));
 
     debug("HTML targets");
     $("#mkwsTargets").html('\
@@ -707,34 +723,35 @@ function mkws_html_switch(config) {
     $("#mkwsTargets").css("display", "none");
 }
 
-function mkws_html_sort(config) {
+function mkws_html_sort() {
     debug("HTML sort");
     var sort_html = '<select name="mkwsSort" id="mkwsSort">';
 
-    for(var i = 0; i < config.sort.length; i++) {
-       var key = config.sort[i][0];
-       var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
+    for(var i = 0; i < mkws_config.sort_options.length; i++) {
+       var opt = mkws_config.sort_options[i];
+       var key = opt[0];
+       var val = opt.length == 1 ? opt[0] : opt[1];
 
        sort_html += '<option value="' + key + '"';
-       if (key == config.sort_default) {
+       if (key == mkws_config.sort_default) {
            sort_html += ' selected="selected"';
        }
-       sort_html += '>' + val + '</option>';
+       sort_html += '>' + M(val) + '</option>';
     }
     sort_html += '</select>';
 
     return sort_html;
 }
 
-function mkws_html_perpage(config) {
+function mkws_html_perpage() {
     debug("HTML perpage");
     var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
 
-    for(var i = 0; i < config.perpage.length; i++) {
-       var key = config.perpage[i];
+    for(var i = 0; i < mkws_config.perpage_options.length; i++) {
+       var key = mkws_config.perpage_options[i];
 
        perpage_html += '<option value="' + key + '"';
-       if (key == config.perpage_default) {
+       if (key == mkws_config.perpage_default) {
            perpage_html += ' selected="selected"';
        }
        perpage_html += '>' + key + '</option>';
@@ -749,16 +766,13 @@ function mkws_html_perpage(config) {
  * The username/password is configured in the apache config file
  * for the site.
  */
-function mkws_service_proxy_auth(auth_url) {
-    if (!auth_url)
-       auth_url = "http://mkws.indexdata.com/service-proxy-auth";
-
+function mkws_service_proxy_auth(auth_url, auth_domain) {
     debug("Run service proxy auth URL: " + auth_url);
 
     var request = new pzHttpRequest(auth_url, function(err) {
-       alert("HTTP call for authentication failed: " + err)
-       return;
-    });
+         alert("HTTP call for authentication failed: " + err)
+         return;
+    }, auth_domain);
 
     request.get(null, function(data) {
        if (!$.isXMLDoc(data)) {
@@ -777,25 +791,25 @@ function mkws_service_proxy_auth(auth_url) {
 }
 
 /* create locale language menu */
-function mkws_html_lang(mkws_config) {
+function mkws_html_lang() {
     var lang_default = "en";
     var lang = mkws_config.lang || lang_default;
     var list = [];
 
     /* display a list of configured languages, or all */
-    var lang_display = mkws_config.lang_display || [];
+    var lang_options = mkws_config.lang_options || [];
     var hash = {};
-    for (var i = 0; i < lang_display.length; i++) {
-       hash[lang_display[i]] = 1;
+    for (var i = 0; i < lang_options.length; i++) {
+       hash[lang_options[i]] = 1;
     }
 
     for (var k in mkws.locale_lang) {
-       if (hash[k] == 1 || lang_display.length == 0)
+       if (hash[k] == 1 || lang_options.length == 0)
            list.push(k);
     }
 
     // add english link
-    if (lang_display.length == 0 || hash[lang_default] == 1)
+    if (lang_options.length == 0 || hash[lang_default] == 1)
         list.push(lang_default);
 
     debug("Language menu for: " + list.join(", "));
@@ -821,7 +835,7 @@ function mkws_html_lang(mkws_config) {
 function mkws_resize_page () {
     var list = ["mkwsSwitch"];
 
-    var width = mkws_config.responsive_design_width || 980;
+    var width = mkws_config.responsive_design_width;
     var parentId = $("#mkwsTermlists").parent().attr('id');
 
     if ($(window).width() <= width &&
@@ -852,7 +866,7 @@ function M(word) {
     if (!lang || !mkws.locale_lang[lang])
        return word;
 
-    return mkws.locale_lang[lang][word] ? mkws.locale_lang[lang][word] : word;
+    return mkws.locale_lang[lang][word] || word;
 }
 
 /*
@@ -1003,7 +1017,7 @@ function init_popup(obj) {
 /* magic */
 $(document).ready(function() {
     try {
-       mkws_html_all(mkws_config)
+       mkws_html_all()
     }
 
     catch (e) {