move the jquery plugins out of the _mkws() function,
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 15d5385..34ad96d 100644 (file)
@@ -1,5 +1,4 @@
-/* A very simple client that shows a basic usage of the pz2.js
-*/
+/*! MKWS, the MasterKey Widget Set. Copyright (C) 2013, Index Data */
 
 "use strict"; // HTML5: disable for debug_level >= 2
 
@@ -7,24 +6,19 @@
 var mkws = {
     sort: 'relevance',
     authenticated: false,
-    filters: [],
+    filters: []
 };
 
-/*
- * global config object: mkws_config
- *
- * 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.
- */
+// Define empty mkws_config for simple applications that don't define it.
 if (!mkws_config)
     var mkws_config = {};
 
-// Wrapper for jQuery
-(function ($) {
+// wrapper for jQuery lib
+function _mkws($) {
+    // if (console && console.log) console.log("run _mkws()");
 
-var pazpar2_url = mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/";
-mkws.pazpar2path = pazpar2_url;
-mkws.usesessions = mkws_config.use_service_proxy ? false : true;
+    // call this function only once
+    if (mkws.init) return;
 
 mkws.locale_lang = {
     "de": {
@@ -93,7 +87,7 @@ mkws.debug_function = function (string) {
     }
 
     var now = $.now();
-    var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") "
+    var timestamp = ((now - mkws.debug_time.start)/1000).toFixed(3) + " (+" + ((now - mkws.debug_time.last)/1000).toFixed(3) + ") "
     mkws.debug_time.last = now;
 
     // you need to disable use strict at the top of the file!!!
@@ -105,10 +99,11 @@ mkws.debug_function = function (string) {
     console.log(timestamp + string);
 }
 var debug = mkws.debug_function; // local alias
+debug("start running MKWS");
 
 
 Handlebars.registerHelper('json', function(obj) {
-    return JSON.stringify(obj);
+    return $.toJSON(obj);
 });
 
 
@@ -164,6 +159,7 @@ Handlebars.registerHelper('commaList', function(items, options) {
     /* default mkws config */
     var config_default = {
        use_service_proxy: true,
+       pazpar2_url: "http://mkws.indexdata.com/service-proxy/",
        service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth",
        lang: "",
        sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
@@ -200,6 +196,8 @@ Handlebars.registerHelper('commaList', function(items, options) {
 mkws.sort = mkws_config.sort_default;
 debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to mkws.sort");
 
+mkws.usesessions = mkws_config.use_service_proxy ? false : true;
+
 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
     debug("Reset query width: " + mkws_config.query_width);
     mkws_config.query_width = 50;
@@ -216,13 +214,13 @@ for (var key in mkws_config) {
     }
 }
 
-
+debug("Create main pz2 object");
 // create a parameters array and pass it to the pz2's constructor
 // then register the form submit event with the pz2.search function
 // 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,
                     "oninit": my_oninit,
                     "onstat": my_onstat,
                     "onterm": my_onterm,
@@ -423,7 +421,9 @@ function onFormSubmitEventHandler()
 
 function newSearch(query, sort, targets)
 {
-    if (!mkws.authenticated) {
+    debug("newSearch: " + query);
+
+    if (mkws_config.use_service_proxy && !mkws.authenticated) {
        alert("searching before authentication");
        return;
     }
@@ -487,7 +487,7 @@ function triggerSearch (query, sort, targets)
        }
     }
 
-    debug("triggerSearch(" + mkws.query + "): filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit);
+    debug("triggerSearch(" + mkws.query + "): filters = " + $.toJSON(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit);
     my_paz.search(mkws.query, recPerPage, mkws.sort, pp2filter, undefined, { limit: pp2limit });
 }
 
@@ -534,9 +534,9 @@ mkws.delimitQuery = function (field, value)
        if (filter.field &&
            field == filter.field &&
            value == filter.value) {
-           debug("delimitTarget() removing filter " + JSON.stringify(filter));
+           debug("delimitTarget() removing filter " + $.toJSON(filter));
        } else {
-           debug("delimitTarget() keeping filter " + JSON.stringify(filter));
+           debug("delimitTarget() keeping filter " + $.toJSON(filter));
            newFilters.push(filter);
        }
     }
@@ -557,9 +557,9 @@ mkws.delimitTarget = function (id)
     for (var i in mkws.filters) {
        var filter = mkws.filters[i];
        if (filter.id) {
-           debug("delimitTarget() removing filter " + JSON.stringify(filter));
+           debug("delimitTarget() removing filter " + $.toJSON(filter));
        } else {
-           debug("delimitTarget() keeping filter " + JSON.stringify(filter));
+           debug("delimitTarget() keeping filter " + $.toJSON(filter));
            newFilters.push(filter);
        }
     }
@@ -905,9 +905,14 @@ function mkws_html_all() {
 
     mkws_html_switch();
 
-    if (mkws_config.use_service_proxy)
+    if (mkws_config.use_service_proxy) {
          mkws_service_proxy_auth(mkws_config.service_proxy_auth,
-          mkws_config.service_proxy_auth_domain);
+                                 mkws_config.service_proxy_auth_domain,
+                                 mkws_config.pazpar2_url);
+    } else {
+       // raw pp2
+       run_auto_searches();
+    }
 
     if (mkws_config.responsive_design_width) {
        // Responsive web design - change layout on the fly based on
@@ -932,6 +937,8 @@ function mkws_html_all() {
 
 
 function run_auto_searches() {
+    debug("run auto searches");
+
     var node = $('#mkwsRecords');
     if (node.attr('autosearch')) {
        var query = node.attr('autosearch');
@@ -1016,9 +1023,14 @@ function mkws_html_perpage() {
  * The username/password is configured in the apache config file
  * for the site.
  */
-function mkws_service_proxy_auth(auth_url, auth_domain) {
+function mkws_service_proxy_auth(auth_url, auth_domain, pp2_url) {
     debug("Run service proxy auth URL: " + auth_url);
 
+    if (!auth_domain) {
+       auth_domain = pp2_url.replace(/^http:\/\/(.*?)\/.*/, '$1');
+       debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
+    }
+
     var request = new pzHttpRequest(auth_url, function(err) {
          alert("HTTP call for authentication failed: " + err)
          return;
@@ -1120,10 +1132,72 @@ function M(word) {
     return mkws.locale_lang[lang][word] || word;
 }
 
+// main
+(function() {
+    try {
+       mkws_html_all()
+    }
+
+    catch (e) {
+       mkws_config.error = e.message;
+       // alert(e.message);
+    }
+})();
+
+    // done
+    mkws.init = true;
+};
+
+
 /*
- * implement jQuery plugins
+ * implement jQuery plugin $.pazpar2({})
  */
-$.extend({
+function _mkws_jquery_plugin ($) {
+    function debug (string) { // delayed debug, internal variables are set after dom ready
+       setTimeout(function() { mkws.debug(string); }, 500);
+    }
+
+    function init_popup(obj) {
+       var config = obj ? obj : {};
+
+       var height = config.height || 760;
+       var width = config.width || 880;
+       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,
+         autoOpen: false,
+         height: height,
+         width: width,
+         modal: true,
+         resizable: true,
+         buttons: {
+                 Cancel: function() {
+                         $(this).dialog("close");
+                 }
+         },
+         close: function() { }
+       });
+
+       $(id_button)
+         .button()
+         .click(function() {
+                 $(id_popup).dialog("open");
+         });
+    };
+
+    $.extend({
+
     // implement $.parseQuerystring() for parsing URL parameters
     parseQuerystring: function() {
        var nvpair = {};
@@ -1136,9 +1210,6 @@ $.extend({
        return nvpair;
     },
 
-    debug2: function(string) { // delayed debug, internal variables are set after dom ready
-       setTimeout(function() { debug(string); }, 500);
-    },
 
     // service-proxy or pazpar2
     pazpar2: function(config) {
@@ -1210,71 +1281,27 @@ $.extend({
          </div>'
 
        if (config && config.layout == 'div') {
-           this.debug2("jquery plugin layout: div");
+           debug("jquery plugin layout: div");
            document.write(div);
        } else if (config && config.layout == 'popup') {
-           this.debug2("jquery plugin layout: popup with id: " + id_popup);
+           debug("jquery plugin layout: popup with id: " + id_popup);
            document.write(popup);
            $(document).ready( function() { init_popup(config); } );
        } else {
-           this.debug2("jquery plugin layout: table");
+           debug("jquery plugin layout: table");
            document.write(table);
        }
     }
 });
-
-function init_popup(obj) {
-    var config = obj ? obj : {};
-
-    var height = config.height || 760;
-    var width = config.width || 880;
-    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,
-      autoOpen: false,
-      height: height,
-      width: width,
-      modal: true,
-      resizable: true,
-      buttons: {
-             Cancel: function() {
-                     $(this).dialog("close");
-             }
-      },
-      close: function() { }
-    });
-
-    $(id_button)
-      .button()
-      .click(function() {
-             $(id_popup).dialog("open");
-      });
 };
 
+// wrapper to call _mkws after page load
+(function (j) {
+    // enable before page load, so we could call it before mkws() runs
+    _mkws_jquery_plugin(j);
 
-
-
-/* magic */
-$(document).ready(function() {
-    try {
-       mkws_html_all()
-    }
-
-    catch (e) {
-       mkws_config.error = e.message;
-       // alert(e.message);
-    }
-});
-
+    $(document).ready(function() {
+       // if (console && console.log) console.log("on load ready");
+       _mkws(j);
+    });
 })(jQuery);