Eliminate config parameter altogether from mkws_html_perpage()
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 144d2de..62b38cf 100644 (file)
@@ -1,7 +1,7 @@
 /* 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 = {};
@@ -22,10 +22,9 @@ if (!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/";
+var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "http://mkws.indexdata.com/service-proxy/";
 
-mkws.pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
+mkws.pazpar2path = pazpar2_url;
 mkws.usesessions = mkws_config.use_service_proxy ? false : true;
 
 mkws.locale_lang = {
@@ -49,6 +48,7 @@ mkws.locale_lang = {
        "Date": "Datum",
        "Subject": "Schlagwort",
        "Location": "Ort",
+       // ### to add: Records, Targets
 
        "dummy": "dummy"
     },
@@ -73,28 +73,38 @@ mkws.locale_lang = {
        "Date": "Dato",
        "Subject": "Emneord",
        "Location": "Lokation",
+       // ### to add: Records, Targets
 
        "dummy": "dummy"
     }
 };
 
-mkws.debug = function (string) {
-    if (!mkws.debug)
+// keep time state for debugging
+mkws.debug_time = {
+    "start": $.now(),
+    "last": $.now()
+};
+mkws.debug_function = function (string) {
+    if (!mkws.debug_level)
        return;
 
     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
        return;
     }
 
+    var now = $.now();
+    var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") "
+    mkws.debug_time.last = now;
+
     // you need to disable use strict at the top of the file!!!
-    if (mkws.debug >= 3) {
-       console.log(arguments.callee.caller);
-    } else if (mkws.debug >= 2) {
-       console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
+    if (mkws.debug_level >= 3) {
+       console.log(timestamp + arguments.callee.caller);
+    } else if (mkws.debug_level >= 2) {
+       console.log(timestamp + ">>> called from function " + arguments.callee.caller.name + ' <<<');
     }
-    console.log(string);
+    console.log(timestamp + string);
 }
-var debug = mkws.debug; // local alias
+var debug = mkws.debug_function; // local alias
 
 for (var key in mkws_config) {
     if (mkws_config.hasOwnProperty(key)) {
@@ -382,7 +392,7 @@ function drawPager (pagerDiv)
 
     var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
     if (curPage > 1)
-        prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
+        prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 
     var middle = '';
@@ -427,7 +437,7 @@ mkws.pagerNext = function () {
     }
 }
 
-function pagerPrev() {
+mkws.pagerPrev = function () {
     if ( my_paz.showPrev() != false )
         curPage--;
 }
@@ -435,6 +445,8 @@ function pagerPrev() {
 // switching view between targets and records
 
 mkws.switchView = function(view) {
+    debug("switchView: " + view);
+
     var targets = document.getElementById('mkwsTargets');
     var results = document.getElementById('mkwsResults') ||
                  document.getElementById('mkwsRecords');
@@ -542,37 +554,41 @@ function renderField(caption, data, data2, data3) {
  * All the HTML stuff to render the search forms and
  * result pages.
  */
-function mkws_html_all(config) {
+function mkws_html_all() {
 
     /* default mkws config */
-    var mkws_config_default = {
-       sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
-       perpage: [10, 20, 30, 50],
+    /* ### No defaults given for:
+     * lang, service_proxy_auth, use_service_proxy
+     * and of course the optional language_* entries.
+     */
+    var config_default = {
+       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,
-       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 */
+       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: 980, /* a page with less pixel width considered as narrow */
-       debug: 1,     /* debug level for development: 0..2 */
+       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 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;
+    /* 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 mkws_config_default) {
-       if (typeof config[k] === 'undefined')
-          mkws_config[k] = mkws_config_default[k];
+    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]);
     }
 
@@ -581,9 +597,9 @@ function mkws_html_all(config) {
        mkws_config.query_width = 50;
     }
 
-    mkws_set_lang(mkws_config);
-    if (mkws_config.lang_menu)
-       mkws_html_lang(mkws_config);
+    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.
@@ -628,23 +644,23 @@ 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);
 
-    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() });
@@ -665,7 +681,7 @@ function mkws_html_all(config) {
     }
 }
 
-function mkws_set_lang(mkws_config)  {
+function mkws_set_lang()  {
     var lang = $.parseQuerystring().lang || mkws_config.lang || "";
     if (!lang || !mkws.locale_lang[lang]) {
        mkws_config.lang = ""
@@ -677,20 +693,12 @@ function mkws_set_lang(mkws_config)  {
     return mkws_config.lang;
 }
 
-function mkws_html_switch(config) {
+function mkws_html_switch() {
     debug("HTML switch");
 
-    $("#mkwsSwitch").html($("<a/>", {
-       href: '#',
-       onclick: "mkws.switchView(\'records\')",
-       text: M("Records")
-    }));
+    $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_records" onclick="mkws.switchView(\'records\')">' + M('Records') + '</a>'));
     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
-    $("#mkwsSwitch").append($("<a/>", {
-       href: '#',
-       onclick: "mkws.switchView(\'targets\')",
-       text: M("Targets")
-    }));
+    $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_targets" onclick="mkws.switchView(\'targets\')">' + M('Targets') + '</a>'));
 
     debug("HTML targets");
     $("#mkwsTargets").html('\
@@ -700,16 +708,17 @@ 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>';
@@ -719,15 +728,15 @@ function mkws_html_sort(config) {
     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>';
@@ -770,25 +779,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(", "));
@@ -814,7 +823,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 &&
@@ -996,7 +1005,7 @@ function init_popup(obj) {
 /* magic */
 $(document).ready(function() {
     try {
-       mkws_html_all(mkws_config)
+       mkws_html_all()
     }
 
     catch (e) {