The third debug() function in mkws.js, inside the jQuery plugin, is
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 52a2270..8fc2d89 100644 (file)
@@ -66,18 +66,11 @@ Handlebars.registerHelper('commaList', function(items, options) {
 
 
 
-// Some functions are visible to be called from outside code, namely
-// generated HTML: that.switchView(), showDetails(), limitTarget(),
-// limitQuery(), delimitTarget(), delimitQuery(), pagerPrev(),
-// pagerNext(), showPage(). Also mkws.M() is made available for the
-// Handlebars helper 'translate'
-
-
-// Set up global mkws object. Contains a hash of team objects,
-// indexed by windowid.
+// Set up global mkws object. Contains truly global state such as SP
+// authentication, and a hash of team objects, indexed by windowid.
+//
 var mkws = {
     authenticated: false,
-    debug_function: undefined, // will be set during initialisation
     debug_level: undefined, // will be initialised from mkws_config
     paz: undefined, // will be set up during initialisation
     teams: {},
@@ -149,16 +142,24 @@ if (mkws_config == null || typeof mkws_config != 'object') {
 }
 
 
-// wrapper for jQuery lib
+// Factory function for team objects. As much as possible, this uses
+// only member variables (prefixed "m_") and inner functions with
+// private scope. Some functions are visibl as member-functions to be
+// called from outside code -- specifically, from generated
+// HTML. These functions are that.switchView(), showDetails(),
+// limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
+// pagerPrev(), pagerNext(), showPage(). Also mkws.M() is made
+// available for the Handlebars helper 'translate'
+//
 function team($, teamName) {
     var that = {};
     var m_teamName = teamName;
     var m_submitted = false;
     var m_query; // initially undefined
     var m_sort; // will be set below
+    var m_perpage; // will be set below
     var m_filters = [];
     var m_totalRec = 0;
-    var m_recPerPage = 20;
     var m_curPage = 1;
     var m_curDetRecId = '';
     var m_curDetRecData = null;
@@ -170,33 +171,14 @@ function team($, teamName) {
     var m_paz; // will be initialised below
 
 
-    // if (console && console.log) // disabled, will fail in IE8
-    // console.log("run team(" + (teamName ? teamName : "") + ")");
-
-
-    // Needs to be defined inside team() so it can see m_debug_time
-    // ### member access won't work: there is only one instance of this function
-    mkws.debug_function = function (string) {
-       if (!mkws.debug_level)
-           return;
-
-       if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
-           return;
-       }
-
+    var debug = function (s) {
        var now = $.now();
        var timestamp = ((now - m_debug_time.start)/1000).toFixed(3) + " (+" + ((now - m_debug_time.last)/1000).toFixed(3) + ") "
        m_debug_time.last = now;
 
-       // you need to disable use strict at the top of the file!!!
-       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(m_teamName + ": " + timestamp + string);
+       mkws.debug(m_teamName + ": " + timestamp + s);
     }
-    var debug = mkws.debug_function; // local alias
+
     debug("start running MKWS");
 
     m_sort = mkws_config.sort_default;
@@ -242,7 +224,7 @@ function team($, teamName) {
                      "onrecord": my_onrecord });
 
     if (!isNaN(parseInt(mkws_config.perpage_default))) {
-       m_recPerPage = parseInt(mkws_config.perpage_default);
+       m_perpage = parseInt(mkws_config.perpage_default);
     }
 
 
@@ -452,7 +434,7 @@ function team($, teamName) {
 
        m_filters = []
        redraw_navi();
-       resetPage(); // ### the globals it resents should be indexed by windowid
+       resetPage();
        loadSelect();
        triggerSearch(query, sort, targets, windowid);
        that.switchView('records'); // In case it's configured to start off as hidden
@@ -465,7 +447,7 @@ function team($, teamName) {
        if (!m_submitted) return false;
        resetPage();
        loadSelect();
-       m_paz.show(0, m_recPerPage, m_sort);
+       m_paz.show(0, m_perpage, m_sort);
        return false;
     }
 
@@ -521,7 +503,7 @@ function team($, teamName) {
        }
        debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 
-       m_paz.search(m_query, m_recPerPage, m_sort, pp2filter, undefined, params);
+       m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
     }
 
 
@@ -533,9 +515,9 @@ function team($, teamName) {
            m_sort = node.val();
        }
        node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
-       if (node.length && node.val() != m_recPerPage) {
-           debug("changing m_recPerPage from " + m_recPerPage + " to " + node.val());
-           m_recPerPage = node.val();
+       if (node.length && node.val() != m_perpage) {
+           debug("changing m_perpage from " + m_perpage + " to " + node.val());
+           m_perpage = node.val();
        }
     }
 
@@ -648,7 +630,7 @@ function team($, teamName) {
 
        //client indexes pages from 1 but pz2 from 0
        var onsides = 6;
-       var pages = Math.ceil(m_totalRec / m_recPerPage);
+       var pages = Math.ceil(m_totalRec / m_perpage);
 
        var firstClkbl = (m_curPage - onsides > 0)
             ? m_curPage - onsides
@@ -660,7 +642,7 @@ function team($, teamName) {
 
        var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
        if (m_curPage > 1)
-            prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
+            prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
             +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 
        var middle = '';
@@ -669,13 +651,13 @@ function team($, teamName) {
             if(i == m_curPage)
                numLabel = '<b>' + i + '</b>';
 
-            middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
+            middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
                + numLabel + ' </a>';
        }
 
        var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
        if (pages - m_curPage > 0)
-            next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
+            next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
             + M('Next') + ' &#62;&#62;</a>';
 
        var predots = '';
@@ -693,7 +675,7 @@ function team($, teamName) {
     }
 
 
-    mkws.showPage = function (pageNum)
+    that.showPage = function (pageNum)
     {
        m_curPage = pageNum;
        m_paz.showPage(m_curPage - 1);
@@ -701,15 +683,15 @@ function team($, teamName) {
 
 
     // simple paging functions
-    mkws.pagerNext = function () {
-       if (m_totalRec - m_recPerPage*m_curPage > 0) {
+    that.pagerNext = function () {
+       if (m_totalRec - m_perpage*m_curPage > 0) {
             m_paz.showNext();
             m_curPage++;
        }
     }
 
 
-    mkws.pagerPrev = function () {
+    that.pagerPrev = function () {
        if (m_paz.showPrev() != false)
             m_curPage--;
     }
@@ -1039,14 +1021,14 @@ function team($, teamName) {
 
 
     function mkws_html_perpage() {
-       debug("HTML perpage");
+       debug("HTML perpage, m_perpage = " + m_perpage);
        var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
 
        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 == mkws_config.perpage_default) {
+           if (key == m_perpage) {
                perpage_html += ' selected="selected"';
            }
            perpage_html += '>' + key + '</option>';
@@ -1134,16 +1116,8 @@ function team($, teamName) {
  * implement jQuery plugin $.pazpar2({})
  */
 function _mkws_jquery_plugin ($) {
-    var debug_level = 1;
-
     function debug (string) {
-       if (!debug_level)
-           return;
-
-       if (typeof console === "undefined" || typeof console.log === "undefined")
-           return;
-
-       console.log("jquery.pazpar2: " + string);
+       mkws.debug("jquery.pazpar2: " + string);
     }
 
     function init_popup(obj) {
@@ -1275,12 +1249,24 @@ function _mkws_jquery_plugin ($) {
 
 // wrapper to call team() after page load
 (function (j) {
-    function log(s) {
-        if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
-            return;
-        }
-       console.log(s);
+    mkws.debug = function (string) {
+       if (!mkws.debug_level)
+           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_level >= 3) {
+           console.log(arguments.callee.caller);
+       } else if (mkws.debug_level >= 2) {
+           console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
+       }
+       console.log(string);
     }
+    var debug = mkws.debug;
+
 
     // enable before page load, so we could call it before mkws() runs
     _mkws_jquery_plugin(j);
@@ -1308,7 +1294,7 @@ function _mkws_jquery_plugin ($) {
 
        if ($(window).width() <= width &&
            parent.hasClass("mkwsTermlistContainer1")) {
-           log("changing from wide to narrow: " + $(window).width());
+           debug("changing from wide to narrow: " + $(window).width());
            $(".mkwsTermlistContainer1").hide();
            $(".mkwsTermlistContainer2").show();
            for (var tname in mkws.teams) {
@@ -1319,7 +1305,7 @@ function _mkws_jquery_plugin ($) {
            }
        } else if ($(window).width() > width &&
                   parent.hasClass("mkwsTermlistContainer2")) {
-           log("changing from narrow to wide: " + $(window).width());
+           debug("changing from narrow to wide: " + $(window).width());
            $(".mkwsTermlistContainer1").show();
            $(".mkwsTermlistContainer2").hide();
            for (var tname in mkws.teams) {
@@ -1356,6 +1342,18 @@ function _mkws_jquery_plugin ($) {
        mkws.teams[tname].delimitQuery(field, value);
     }
 
+    mkws.showPage = function (tname, pageNum) {
+       mkws.teams[tname].showPage(pageNum);
+    }
+
+    mkws.pagerPrev = function (tname) {
+       mkws.teams[tname].pagerPrev();
+    }
+
+    mkws.pagerNext = function (tname) {
+       mkws.teams[tname].pagerNext();
+    }
+
 
     function default_mkws_config() {
        /* default mkws config */
@@ -1408,11 +1406,11 @@ function _mkws_jquery_plugin ($) {
      * for the site.
      */
     function authenticate_session(auth_url, auth_domain, pp2_url) {
-       log("Run service proxy auth URL: " + auth_url);
+       debug("Run service proxy auth URL: " + auth_url);
 
        if (!auth_domain) {
            auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
-           log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
+           debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
        }
 
        var request = new pzHttpRequest(auth_url, function(err) {
@@ -1431,7 +1429,7 @@ function _mkws_jquery_plugin ($) {
                return;
            }
 
-           log("Service proxy auth successfully done");
+           debug("Service proxy auth successfully done");
            mkws.authenticated = true;
            run_auto_searches();
        });
@@ -1439,13 +1437,13 @@ function _mkws_jquery_plugin ($) {
 
 
     function run_auto_searches() {
-       log("running auto searches");
+       debug("running auto searches");
 
        for (var teamName in mkws.teams) {
            // ### should check mkwsTermlist as well, for facet-only teams
            var node = $('.mkwsRecords.mkwsTeam_' + teamName);
            var query = node.attr('autosearch');
-           log("teamName '" + teamName + "', node=" + node + ", class='" + node.className + "', query=" + query);
+           debug("teamName '" + teamName + "', node=" + node + ", class='" + node.className + "', query=" + query);
 
            if (query) {
                var sort = node.attr('sort');
@@ -1454,9 +1452,9 @@ function _mkws_jquery_plugin ($) {
                if (teamName) s += " [teamName '" + teamName + "']";
                if (sort) s += " sorted by '" + sort + "'";
                if (targets) s += " in targets '" + targets + "'";
-               log(s);
+               debug(s);
                var team = mkws.teams[teamName];
-               log($.toJSON(team));
+               debug($.toJSON(team));
                team.newSearch(query, sort, targets, teamName);
            }
        }
@@ -1464,7 +1462,7 @@ function _mkws_jquery_plugin ($) {
 
 
     $(document).ready(function() {
-       log("on load ready");
+       debug("on load ready");
        default_mkws_config();
 
        // Backwards compatibility: set new magic class names on any
@@ -1477,7 +1475,7 @@ function _mkws_jquery_plugin ($) {
            var node = $('#' + id);
            if (node.attr('id')) {
                node.addClass(id);
-               log("added magic class to '" + node.attr('id') + "'");
+               debug("added magic class to '" + node.attr('id') + "'");
            }
        }
 
@@ -1485,7 +1483,7 @@ function _mkws_jquery_plugin ($) {
        // specified, set the team to AUTO.
        $('[class^="mkws"],[class*=" mkws"]').each(function () {
            if (!this.className.match(/mkwsTeam_/)) {
-               log("adding AUTO team to node with class '" + this.className + "'");
+               debug("adding AUTO team to node with class '" + this.className + "'");
                $(this).addClass('mkwsTeam_AUTO');
            }
        });
@@ -1497,7 +1495,7 @@ function _mkws_jquery_plugin ($) {
            mkws.handle_node_with_team(node, function(tname) {
                if (!mkws.teams[tname]) {
                    mkws.teams[tname] = team(j, tname);
-                   log("Made MKWS team '" + tname + "'");
+                   debug("Made MKWS team '" + tname + "'");
                }
            });
        });