Add utility method findnode(), limited to elements in present team.
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 40d703f..cd0a18e 100644 (file)
@@ -172,13 +172,15 @@ if (mkws_config == null || typeof mkws_config != 'object') {
 
 
 // Factory function for widget objects.
-function widget($, team, node) {
+function widget($, team, type, node) {
     var that = {
        team: team,
+       type: type,
        node: node
     };
 
-    // ### More to do here, surely
+    // ### More to do here, surely: e.g. wiring into the team
+    mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node);
 
     return that;
 }
@@ -226,11 +228,13 @@ function team($, teamName) {
     m_sort = mkws_config.sort_default;
     debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort");
 
+    // ### should be in global code
     if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
        debug("Reset query width: " + mkws_config.query_width);
        mkws_config.query_width = 50;
     }
 
+    // ### should be in global code
     for (var key in mkws_config) {
        if (mkws_config.hasOwnProperty(key)) {
            if (key.match(/^language_/)) {
@@ -270,6 +274,12 @@ function team($, teamName) {
     }
 
 
+    // Finds the node of the specified class within the current team
+    function findnode(s) {
+        return $(s + '.mkwsTeam_' + m_teamName);
+    }
+
+
     //
     // pz2.js event handlers:
     //
@@ -284,12 +294,12 @@ function team($, teamName) {
        debug("show");
        m_totalRec = data.merged;
 
-       var pager = $(".mkwsPager.mkwsTeam_" + m_teamName);
+       var pager = findnode(".mkwsPager");
        if (pager.length) {
            pager.html(drawPager(data))
        }
 
-       var results = $(".mkwsRecords.mkwsTeam_" + m_teamName);
+       var results = findnode(".mkwsRecords");
        if (!results.length)
            return;
 
@@ -319,7 +329,7 @@ function team($, teamName) {
 
     function my_onstat(data, teamName) {
        debug("stat");
-       var stat = $('.mkwsStat.mkwsTeam_' + teamName);
+       var stat = findnode('.mkwsStat');
        if (stat.length === 0)
            return;
 
@@ -333,7 +343,7 @@ function team($, teamName) {
 
     function my_onterm(data, teamName) {
        debug("term");
-       var node = $(".mkwsTermlists.mkwsTeam_" + teamName);
+       var node = findnode(".mkwsTermlists");
        if (node.length == 0) return;
 
        // no facets: this should never happen
@@ -417,7 +427,7 @@ function team($, teamName) {
 
     function my_onbytarget(data, teamName) {
        debug("target");
-       var targetDiv = $('.mkwsBytarget.mkwsTeam_' + teamName);
+       var targetDiv = findnode('.mkwsBytarget');
        if (!targetDiv) {
            return;
        }
@@ -447,10 +457,11 @@ function team($, teamName) {
 
 
     // when search button pressed
+    // ### This is closure, so can always just operate on its own team
     function onFormSubmitEventHandler()
     {
        mkws.handle_node_with_team(this, function (tname) {
-           var val = $('.mkwsQuery.mkwsTeam_' + tname).val();
+           var val = findnode('.mkwsQuery').val();
            mkws.teams[tname].newSearch(val);
        });
 
@@ -458,6 +469,8 @@ function team($, teamName) {
     }
 
 
+    // ### won't need to be externally visible once onFormSubmitEventHandler() is fixed.
+    // ### doesn't need windowid
     that.newSearch = function(query, sort, targets, windowid)
     {
        debug("newSearch: " + query);
@@ -494,6 +507,7 @@ function team($, teamName) {
     }
 
 
+    // ### doesn't need windowid
     function triggerSearch (query, sort, targets, windowid)
     {
        var pp2filter = "";
@@ -546,12 +560,12 @@ function team($, teamName) {
 
     function loadSelect ()
     {
-       var node = $('.mkwsSort.mkwsTeam_' + m_teamName);
+       var node = findnode('.mkwsSort');
        if (node.length && node.val() != m_sort) {
            debug("changing m_sort from " + m_sort + " to " + node.val());
            m_sort = node.val();
        }
-       node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
+       node = findnode('.mkwsPerpage');
        if (node.length && node.val() != m_perpage) {
            debug("changing m_perpage from " + m_perpage + " to " + node.val());
            m_perpage = node.val();
@@ -635,7 +649,7 @@ function team($, teamName) {
 
     function redraw_navi ()
     {
-       var navi = $('.mkwsNavi.mkwsTeam_' + m_teamName);
+       var navi = findnode('.mkwsNavi');
        if (!navi) return;
 
        var text = "";
@@ -736,10 +750,11 @@ function team($, teamName) {
 
     // switching view between targets and records
     that.switchView = function(view) {
-       var targets = $('.mkwsTargets.mkwsTeam_' + m_teamName);
+       var targets = findnode('.mkwsTargets');
+       // ### Fix next line to use findnode()
        var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName);
-       var blanket = $('.mkwsBlanket.mkwsTeam_' + m_teamName);
-       var motd    = $('.mkwsMOTD.mkwsTeam_' + m_teamName);
+       var blanket = findnode('.mkwsBlanket');
+       var motd    = findnode('.mkwsMOTD');
 
        switch(view) {
         case 'targets':
@@ -805,9 +820,9 @@ function team($, teamName) {
 
        if (template === undefined) {
            // Fall back to generic template if there is no team-specific one
-           var node = $(".mkwsTemplate_" + name + ".mkwsTeam_" + m_teamName)
+           var node = findnode(".mkwsTemplate_" + name);
            if (!node.length) {
-               node = $(".mkwsTemplate_" + name + ".mkwsTeam_ALL")
+               node = $(".mkwsTemplate_" + name + ".mkwsTeam_ALL");
            }
 
            var source = node.html();
@@ -909,22 +924,19 @@ function team($, teamName) {
      * All the HTML stuff to render the search forms and
      * result pages.
      */
+    // ### This and other multi-word identifiers should be camelCase
     function mkws_html_all() {
        mkws_set_lang();
        if (mkws_config.show_lang)
            mkws_html_lang();
 
        debug("HTML search form");
-       // ### There is only one match here by design: fix not to bother looping
-       $('.mkwsSearch.mkwsTeam_' + m_teamName).each(function (i, obj) {
-           var node = this;
-           mkws.handle_node_with_team(this, function(tname) {
-               $(node).html('\
+       mkws.handle_node_with_team(findnode('.mkwsSearch'), function(tname) {
+           this.html('\
 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
   <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
   <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
 </form>');
-           });
        });
 
        debug("HTML records");
@@ -959,7 +971,7 @@ function team($, teamName) {
 </table>');
        }
 
-       var node = $(".mkwsRanking.mkwsTeam_" + m_teamName);
+       var node = findnode(".mkwsRanking");
        if (node.length) {
            var ranking_data = '';
            ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
@@ -985,26 +997,21 @@ function team($, teamName) {
            $(document).ready(function() { mkws.resize_page() });
        }
 
-       $('.mkwsSearchForm.mkwsTeam_' + m_teamName).each(function (i, obj) {
-           debug("adding search-forms for team '" + m_teamName + "'");
-           var node = this;
-           mkws.handle_node_with_team(this, function(tname) {
-               debug("adding search-form '" + tname + "' for team '" + m_teamName + "'");
-               $(node).submit(onFormSubmitEventHandler);
-           });
-       });
-
-       node = $('.mkwsSort.mkwsTeam_' + m_teamName);
+       var node;
+       node = findnode('.mkwsSearchForm');
+       if (node.length)
+           node.submit(onFormSubmitEventHandler);
+       node = findnode('.mkwsSort');
        if (node.length)
            node.change(onSelectDdChange);
-       node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
+       node = findnode('.mkwsPerpage');
        if (node.length)
            node.change(onSelectDdChange);
 
        // on first page, hide the termlist
-       $(document).ready(function() { $(".mkwsTermlists.mkwsTeam_" + m_teamName).hide(); });
-       var motd = $(".mkwsMOTD.mkwsTeam_" + m_teamName);
-        var container = $(".mkwsMOTDContainer.mkwsTeam_" + m_teamName);
+       $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
+       var motd = findnode(".mkwsMOTD");
+        var container = findnode(".mkwsMOTDContainer");
        if (motd.length && container.length) {
            // Move the MOTD from the provided element down into the container
            motd.appendTo(container);
@@ -1041,13 +1048,13 @@ function team($, teamName) {
     function mkws_html_switch() {
        debug("HTML switch for team " + m_teamName);
 
-       var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName);
+       var node = findnode(".mkwsSwitch");
        node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
        node.append($("<span/>", { text: " | " }));
        node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
 
        debug("HTML targets");
-       var node = $(".mkwsTargets.mkwsTeam_" + m_teamName);
+       var node = findnode(".mkwsTargets");
        node.html('\
 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
   No information available yet.\
@@ -1135,13 +1142,13 @@ function team($, teamName) {
            }
        }
 
-       $(".mkwsLang.mkwsTeam_" + m_teamName).html(data);
+       findnode(".mkwsLang").html(data);
     }
 
 
     that.run_auto_search = function() {
        // ### should check mkwsTermlist as well, for facet-only teams
-       var node = $('.mkwsRecords.mkwsTeam_' + m_teamName);
+       var node = findnode('.mkwsRecords');
        var query = node.attr('autosearch');
        if (!query)
            return;
@@ -1178,6 +1185,7 @@ function team($, teamName) {
 
     // This function is taken from a StackOverflow answer
     // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
+    // ### should we unify this and parseQuerystring()?
     function getParameterByName(name) {
        name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
        var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
@@ -1238,16 +1246,28 @@ function team($, teamName) {
 
 
     mkws.handle_node_with_team = function(node, callback) {
-       var classes = node.className;
+       // First branch for DOM objects; second branch for jQuery objects
+       var classes = node.className || node.attr('class');
+       if (!classes) {
+           // For some reason, if we try to proceed when classes is
+           // undefined, we don't get an error message, but this
+           // function and its callers, up several stack level,
+           // silently return. What a crock.
+           mkws.debug("handle_node_with_team() called on node with no classes");
+           return;
+       }
        var list = classes.split(/\s+/)
-       var tname;
+       var teamName, type;
+
        for (var i = 0; i < list.length; i++) {
            var cname = list[i];
            if (cname.match(/^mkwsTeam_/)) {
-               tname = cname.replace(/^mkwsTeam_/, '');
+               teamName = cname.replace(/^mkwsTeam_/, '');
+           } else if (cname.match(/^mkws/)) {
+               type = cname.replace(/^mkws/, '');
            }
        }
-       callback.call(this, tname);
+       callback.call(node, teamName, type);
     }
 
 
@@ -1441,13 +1461,13 @@ function team($, teamName) {
        // the mkwsTeam_* class. Make all team objects.
        var then = $.now();
        $('[class^="mkws"],[class*=" mkws"]').each(function () {
-           mkws.handle_node_with_team(this, function(tname) {
+           mkws.handle_node_with_team(this, function(tname, type) {
                if (!mkws.teams[tname]) {
                    mkws.teams[tname] = team(j, tname);
                    debug("Made MKWS team '" + tname + "'");
                }
-               var myTeam = mkws.teams[tname]
-               var myWidget = widget(j, myTeam, this)
+               var myTeam = mkws.teams[tname];
+               var myWidget = widget(j, myTeam, type, this);
            });
        });
        var now = $.now();