refactor to use single object mkws, part of jQuery rewrite MKWS-24
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 32b295b..3ae8ae0 100644 (file)
 if (!mkws_config)
     var mkws_config = {}; // for the guys who forgot to define mkws_config...
 
+// Set up namespace and some state.
+var mkws = {};
+
+
 if (typeof mkws_config.use_service_proxy === 'undefined')
     mkws_config.use_service_proxy = true;
 
-// global debug flag
-var mkws_debug;
 
 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/";
@@ -25,8 +27,13 @@ var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_prox
 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
 var usesessions = mkws_config.use_service_proxy ? false : true;
 
+var mkws_debug;
 
-var mkws_locale_lang = {
+
+// Wrapper for jQuery
+(function ($) {
+
+mkws.locale_lang = {
     "de": {
        "Authors": "Autoren",
        "Subjects": "Schlagwörter",
@@ -76,13 +83,30 @@ var mkws_locale_lang = {
     }
 };
 
+mkws.debug = function (string) {
+    if (!mkws_debug)
+       return;
+
+    if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
+       return;
+    }
+
+    // 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 + ' <<<');
+    }
+    console.log(string);
+}
+var debug = mkws.debug; // local alias
 
 for (var key in mkws_config) {
     if (mkws_config.hasOwnProperty(key)) {
        if (key.match(/^language_/)) {
            var lang = key.replace(/^language_/, "");
            // Copy custom languages into list
-           mkws_locale_lang[lang] = mkws_config[key];
+           mkws.locale_lang[lang] = mkws_config[key];
        }
     }
 }
@@ -102,6 +126,9 @@ var my_paz = new pz2( { "onshow": my_onshow,
                    "usesessions" : usesessions,
                     "showResponseType": '', // or "json" (for debugging?)
                     "onrecord": my_onrecord } );
+
+mkws.my_paz = my_paz; // export
+
 // some state vars
 var curPage = 1;
 var recPerPage = 20;
@@ -142,7 +169,7 @@ function my_onshow(data) {
              html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
             +'<a href="#" id="mkwsRec_'+hit.recid
-            +'" onclick="showDetails(this.id);return false;"><b>'
+            +'" onclick="mkws.showDetails(this.id);return false;"><b>'
             + hit["md-title"] +' </b></a>');
              if (hit["md-title-remainder"] !== undefined) {
                html.push('<span>' + hit["md-title-remainder"] + ' </span>');
@@ -201,20 +228,22 @@ function my_onterm(data) {
 }
 
 function add_single_facet(acc, caption, data, max, cclIndex) {
-    acc.push('<div class="facet">');
+    acc.push('<div class="facet" id="mkwsFacet' + caption + '">');
     acc.push('<div class="termtitle">' + M(caption) + '</div>');
     for (var i = 0; i < data.length && i < max; i++ ) {
+       acc.push('<div class="term">');
         acc.push('<a href="#" ');
        var action;
        if (!cclIndex) {
            // Special case: target selection
            acc.push('target_id='+data[i].id+' ');
-           action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
+           action = 'mkws.limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
        } else {
-           action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
+           action = 'mkws.limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
        }
        acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
-                + '<span> (' + data[i].freq + ')</span><br/>');
+                + ' <span>' + data[i].freq + '</span>');
+       acc.push('</div>');
     }
     acc.push('</div>');
 }
@@ -233,6 +262,11 @@ function my_onrecord(data) {
 
 function my_onbytarget(data) {
     var targetDiv = document.getElementById("mkwsBytarget");
+    if (!targetDiv) {
+       // No mkwsTargets div.
+       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>';
 
@@ -270,7 +304,7 @@ function onFormSubmitEventHandler()
     resetPage();
     loadSelect();
     triggerSearch();
-    switchView('records'); // In case it's configured to start off as hidden
+    mkws.switchView('records'); // In case it's configured to start off as hidden
     submitted = true;
     return false;
 }
@@ -306,18 +340,18 @@ function loadSelect ()
 }
 
 // limit the query after clicking the facet
-function limitQuery (field, value)
+mkws.limitQuery = function (field, value)
 {
-    document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"';
+    document.mkwsSearchForm.mkwsQuery.value += ' and ' + field + '="' + value + '"';
     onFormSubmitEventHandler();
 }
 
 // limit by target functions
-function limitTarget (id, name)
+mkws.limitTarget  = function (id, name)
 {
     var navi = document.getElementById('mkwsNavi');
     navi.innerHTML =
-        'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
+        'Source: <a class="crossout" href="#" onclick="mkws.delimitTarget();return false;">'
         + name + '</a>';
     curFilter = 'pz:id=' + id;
     resetPage();
@@ -326,7 +360,7 @@ function limitTarget (id, name)
     return false;
 }
 
-function delimitTarget ()
+mkws.delimitTarget = function ()
 {
     var navi = document.getElementById('mkwsNavi');
     navi.innerHTML = '';
@@ -362,13 +396,13 @@ function drawPager (pagerDiv)
         if(i == curPage)
             numLabel = '<b>' + i + '</b>';
 
-        middle += '<a href="#" onclick="showPage(' + i + ')"> '
+        middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
             + numLabel + ' </a>';
     }
 
     var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
     if (pages - curPage > 0)
-        next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
+        next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
         + M('Next') + ' &#62;&#62;</a>';
 
     var predots = '';
@@ -383,7 +417,7 @@ function drawPager (pagerDiv)
         + prev + predots + middle + postdots + next + '</div>';
 }
 
-function showPage (pageNum)
+mkws.showPage = function (pageNum)
 {
     curPage = pageNum;
     my_paz.showPage( curPage - 1 );
@@ -391,7 +425,7 @@ function showPage (pageNum)
 
 // simple paging functions
 
-function pagerNext() {
+mkws.pagerNext = function () {
     if ( totalRec - recPerPage*curPage > 0) {
         my_paz.showNext();
         curPage++;
@@ -405,7 +439,7 @@ function pagerPrev() {
 
 // switching view between targets and records
 
-function switchView(view) {
+mkws.switchView = function(view) {
     var targets = document.getElementById('mkwsTargets');
     var results = document.getElementById('mkwsResults') ||
                  document.getElementById('mkwsRecords');
@@ -437,7 +471,7 @@ function switchView(view) {
 }
 
 // detailed record drawing
-function showDetails (prefixRecId) {
+mkws.showDetails = function (prefixRecId) {
     var recId = prefixRecId.replace('mkwsRec_', '');
     var oldRecId = curDetRecId;
     curDetRecId = recId;
@@ -522,7 +556,6 @@ function mkws_html_all(config) {
        sort_default: "relevance",
        perpage_default: 20,
        query_width: 50,
-       switch_menu: false,     /* show/hide Records|Targets menu */
        lang_menu: true,        /* show/hide language menu */
        sort_menu: true,        /* show/hide sort menu */
        perpage_menu: true,     /* show/hide perpage menu */
@@ -638,8 +671,8 @@ function mkws_html_all(config) {
 }
 
 function mkws_set_lang(mkws_config)  {
-    var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
-    if (!lang || !mkws_locale_lang[lang]) {
+    var lang = $.parseQuerystring().lang || mkws_config.lang || "";
+    if (!lang || !mkws.locale_lang[lang]) {
        mkws_config.lang = ""
     } else {
        mkws_config.lang = lang;
@@ -654,13 +687,13 @@ function mkws_html_switch(config) {
 
     $("#mkwsSwitch").html($("<a/>", {
        href: '#',
-       onclick: "switchView(\'records\')",
+       onclick: "mkws.switchView(\'records\')",
        text: M("Records")
     }));
     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
     $("#mkwsSwitch").append($("<a/>", {
        href: '#',
-       onclick: "switchView(\'targets\')",
+       onclick: "mkws.switchView(\'targets\')",
        text: M("Targets")
     }));
 
@@ -670,11 +703,6 @@ function mkws_html_switch(config) {
        No information available yet.\
       </div>');
     $("#mkwsTargets").css("display", "none");
-
-    if (!config.switch_menu) {
-       debug("disable switch menu");
-        $("#mkwsSwitch").css("display", "none");
-    }
 }
 
 function mkws_html_sort(config) {
@@ -725,9 +753,12 @@ function mkws_service_proxy_auth(auth_url) {
 
     debug("Run service proxy auth URL: " + auth_url);
 
-    var request = new pzHttpRequest(auth_url);
+    var request = new pzHttpRequest(auth_url, function(err) {
+       alert("HTTP call for authentication failed: " + err)
+       return;
+    });
     request.get(null, function(data) {
-       if (!jQuery.isXMLDoc(data)) {
+       if (!$.isXMLDoc(data)) {
            alert("service proxy auth response document is not valid XML document, give up!");
            return;
        }
@@ -752,7 +783,7 @@ function mkws_html_lang(mkws_config) {
        hash[lang_display[i]] = 1;
     }
 
-    for (var k in mkws_locale_lang) {
+    for (var k in mkws.locale_lang) {
        if (hash[k] == 1 || lang_display.length == 0)
            list.push(k);
     }
@@ -812,17 +843,17 @@ function mkws_resize_page () {
 function M(word) {
     var lang = mkws_config.lang;
 
-    if (!lang || !mkws_locale_lang[lang])
+    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] ? mkws.locale_lang[lang][word] : word;
 }
 
 /*
  * implement jQuery plugins
  */
-jQuery.extend({
-    // implement jQuery.parseQuerystring() for parsing URL parameters
+$.extend({
+    // implement $.parseQuerystring() for parsing URL parameters
     parseQuerystring: function() {
        var nvpair = {};
        var qs = window.location.search.replace('?', '');
@@ -840,6 +871,9 @@ jQuery.extend({
 
     // service-proxy or pazpar2
     pazpar2: function(config) {
+       var id_popup = config.id_popup || "#mkwsPopup";
+       id_popup = id_popup.replace(/^#/, "");
+
        // simple layout
        var div = '<div id="mkwsSwitch"></div>\
        <div id="mkwsLang"></div>\
@@ -896,21 +930,21 @@ jQuery.extend({
 
        var popup = '\
          <div id="mkwsSearch"></div>\
-         <div id="mkwsPopup">\
+         <div id="' + id_popup + '">\
            <div id="mkwsSwitch"></div>\
            <div id="mkwsLang"></div>\
            <div id="mkwsResults"></div>\
            <div id="mkwsTargets"></div>\
            <div id="mkwsStat"></div>\
-         </div>\
-         <script> $(document).ready(function() { init_popup();});  </script>';
+         </div>'
 
        if (config && config.layout == 'div') {
            this.debug2("jquery plugin layout: div");
            document.write(div);
        } else if (config && config.layout == 'popup') {
-           this.debug2("jquery plugin layout: popup");
+           this.debug2("jquery plugin layout: popup with id: " + id_popup);
            document.write(popup);
+           $(document).ready( function() { init_popup(config); } );
        } else {
            this.debug2("jquery plugin layout: table");
            document.write(table);
@@ -918,14 +952,22 @@ jQuery.extend({
     }
 });
 
-function init_popup(config) {
-    if (!config)
-       config = {};
+function init_popup(obj) {
+    var config = obj ? obj : {};
 
     var height = config.height || 760;
     var width = config.width || 880;
-    var id_button = config.button || "input#mkwsButton";
-    var id_popup = config.popup || "#mkwsPopup";
+    var id_button = config.id_button || "input#mkwsButton";
+    var id_popup = config.id_popup || "#mkwsPopup";
+
+    debug("popup height: " + height + ", width: " + width);
+
+    // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
+    // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
+    if (!$.ui) {
+       debug("Error: jquery-ui.js is missing, did you included it after jquery core in the HTML file?");
+       return;
+    }
 
     $(id_popup).dialog({
       closeOnEscape: true,
@@ -949,23 +991,19 @@ function init_popup(config) {
       });
 };
 
-function debug(string) {
-    if (!mkws_debug)
-       return;
 
-    if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
-       return;
-    }
 
-    // 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 + ' <<<');
+
+/* magic */
+$(document).ready(function() {
+    try {
+       mkws_html_all(mkws_config)
     }
-    console.log(string);
-}
 
+    catch (e) {
+       mkws_config.error = e.message;
+       // alert(e.message);
+    }
+});
 
-/* magic */
-$(document).ready(function() { mkws_html_all(mkws_config) });
+})(jQuery);