Re-order parameters to pz2 constructor.
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index d6d7ef9..65848c9 100644 (file)
@@ -72,7 +72,7 @@ Handlebars.registerHelper('index1', function(obj) {
 
 
 // Set up global mkws object. Contains truly global state such as SP
-// authentication, and a hash of team objects, indexed by windowid.
+// authentication, and a hash of team objects, indexed by team-name.
 //
 var mkws = {
     authenticated: false,
@@ -228,22 +228,8 @@ 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_/)) {
-               var lang = key.replace(/^language_/, "");
-               // Copy custom languages into list
-               mkws.locale_lang[lang] = mkws_config[key];
-               debug("Added locally configured language '" + lang + "'");
-           }
-       }
+    if (!isNaN(parseInt(mkws_config.perpage_default))) {
+       m_perpage = parseInt(mkws_config.perpage_default);
     }
 
     // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
@@ -256,42 +242,47 @@ function team($, teamName) {
     // 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
-    m_paz = new pz2({ "onshow": my_onshow,
-                     "windowid": teamName,
-                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
+    m_paz = new pz2({ "windowid": teamName,
                      "pazpar2path": mkws_config.pazpar2_url,
-                     "oninit": my_oninit,
-                     "onstat": my_onstat,
-                     "onterm": (mkws_config.facets.length ? my_onterm : undefined),
-                     "termlist": mkws_config.facets.join(','),
-                     "onbytarget": my_onbytarget,
                      "usesessions" : mkws_config.use_service_proxy ? false : true,
-                     "showResponseType": '', // or "json" (for debugging?)
-                     "onrecord": my_onrecord });
-
-    if (!isNaN(parseInt(mkws_config.perpage_default))) {
-       m_perpage = parseInt(mkws_config.perpage_default);
-    }
+                     "oninit": onInit,
+                     "onbytarget": onBytarget,
+                     "onstat": onStat,
+                     "onterm": (mkws_config.facets.length ? onTerm : undefined),
+                     "onshow": onShow,
+                     "onrecord": onRecord,
+                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
+                     "termlist": mkws_config.facets.join(','),
+                     "showResponseType": '' // or "json" (for debugging?)
+                   });
 
 
     // Finds the node of the specified class within the current team
+    // Multiple OR-clauses separated by commas are handled
+    // More complex cases may not work
+    //
     function findnode(selector, teamName) {
-       teamName ||= m_teamName;
-        return $(selector + '.mkwsTeam_' + m_teamName);
+       teamName = teamName || m_teamName;
+
+       selector = selector.split(',').map(function(s) {
+           return s + '.mkwsTeam_' + teamName;
+       }).join(',');
+
+       return $(selector);
     }
 
 
     //
     // pz2.js event handlers:
     //
-    function my_oninit(teamName) {
+    function onInit(teamName) {
        debug("init");
        m_paz.stat();
        m_paz.bytarget();
     }
 
 
-    function my_onshow(data, teamName) {
+    function onShow(data, teamName) {
        debug("show");
        m_totalRec = data.merged;
 
@@ -328,7 +319,7 @@ function team($, teamName) {
     }
 
 
-    function my_onstat(data, teamName) {
+    function onStat(data, teamName) {
        debug("stat");
        var stat = findnode('.mkwsStat');
        if (stat.length === 0)
@@ -342,14 +333,14 @@ function team($, teamName) {
     }
 
 
-    function my_onterm(data, teamName) {
+    function onTerm(data, teamName) {
        debug("term");
        var node = findnode(".mkwsTermlists");
        if (node.length == 0) return;
 
        // no facets: this should never happen
        if (!mkws_config.facets || mkws_config.facets.length == 0) {
-           alert("my_onterm called even though we have no facets: " + $.toJSON(data));
+           alert("onTerm called even though we have no facets: " + $.toJSON(data));
            node.hide();
            return;
        }
@@ -363,11 +354,11 @@ function team($, teamName) {
 
        for(var i = 0; i < facets.length; i++) {
            if (facets[i] == "xtargets") {
-               add_single_facet(acc, "Sources",  data.xtargets, 16, null);
+               addSingleFacet(acc, "Sources",  data.xtargets, 16, null);
            } else if (facets[i] == "subject") {
-               add_single_facet(acc, "Subjects", data.subject,  10, "subject");
+               addSingleFacet(acc, "Subjects", data.subject,  10, "subject");
            } else if (facets[i] == "author") {
-               add_single_facet(acc, "Authors",  data.author,   10, "author");
+               addSingleFacet(acc, "Authors",  data.author,   10, "author");
            } else {
                alert("bad facet configuration: '" + facets[i] + "'");
            }
@@ -377,7 +368,7 @@ function team($, teamName) {
     }
 
 
-    function add_single_facet(acc, caption, data, max, pzIndex) {
+    function addSingleFacet(acc, caption, data, max, pzIndex) {
        acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + m_teamName + '">');
        acc.push('<div class="termtitle">' + M(caption) + '</div>');
        for (var i = 0; i < data.length && i < max; i++) {
@@ -387,7 +378,7 @@ function team($, teamName) {
            if (!pzIndex) {
                // Special case: target selection
                acc.push('target_id='+data[i].id+' ');
-               if (!target_filtered(data[i].id)) {
+               if (!targetFiltered(data[i].id)) {
                    action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
                }
            } else {
@@ -401,7 +392,7 @@ function team($, teamName) {
     }
 
 
-    function target_filtered(id) {
+    function targetFiltered(id) {
        for (var i = 0; i < m_filters.length; i++) {
            if (m_filters[i].id === id ||
                m_filters[i].id === 'pz:id=' + id) {
@@ -412,7 +403,7 @@ function team($, teamName) {
     }
 
 
-    function my_onrecord(data, args, teamName) {
+    function onRecord(data, args, teamName) {
        debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName);
        // FIXME: record is async!!
        clearTimeout(m_paz.recordTimer);
@@ -426,7 +417,7 @@ function team($, teamName) {
     }
 
 
-    function my_onbytarget(data, teamName) {
+    function onBytarget(data, teamName) {
        debug("target");
        var targetDiv = findnode('.mkwsBytarget');
        if (!targetDiv) {
@@ -458,21 +449,15 @@ 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 = findnode('.mkwsQuery').val();
-           mkws.teams[tname].newSearch(val);
-       });
-
+       var val = findnode('.mkwsQuery').val();
+       newSearch(val);
        return false;
     }
 
 
-    // ### won't need to be externally visible once onFormSubmitEventHandler() is fixed.
-    // ### doesn't need windowid
-    that.newSearch = function(query, sort, targets, windowid)
+    function newSearch(query, sort, targets)
     {
        debug("newSearch: " + query);
 
@@ -482,11 +467,11 @@ function team($, teamName) {
        }
 
        m_filters = []
-       redraw_navi();
+       redrawNavi();
        resetPage();
        loadSelect();
-       triggerSearch(query, sort, targets, windowid);
-       that.switchView('records'); // In case it's configured to start off as hidden
+       triggerSearch(query, sort, targets);
+       switchView('records'); // In case it's configured to start off as hidden
        m_submitted = true;
     }
 
@@ -508,8 +493,7 @@ function team($, teamName) {
     }
 
 
-    // ### doesn't need windowid
-    function triggerSearch (query, sort, targets, windowid)
+    function triggerSearch (query, sort, targets)
     {
        var pp2filter = "";
        var pp2limit = "";
@@ -522,7 +506,6 @@ function team($, teamName) {
            m_sort = sort;
        }
        if (targets) {
-           // ### should support multiple |-separated targets
            m_filters.push({ id: targets, name: targets });
        }
 
@@ -548,9 +531,7 @@ function team($, teamName) {
        if (pp2limit) {
            params.limit = pp2limit;
        }
-       if (windowid) {
-           params.windowid = windowid;
-       }
+
        debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 
        // We can use: params.torusquery = "udb=NAME"
@@ -579,7 +560,7 @@ function team($, teamName) {
     {
        debug("limitTarget(id=" + id + ", name=" + name + ")");
        m_filters.push({ id: id, name: name });
-       redraw_navi();
+       redrawNavi();
        resetPage();
        loadSelect();
        triggerSearch();
@@ -592,7 +573,7 @@ function team($, teamName) {
     {
        debug("limitQuery(field=" + field + ", value=" + value + ")");
        m_filters.push({ field: field, value: value });
-       redraw_navi();
+       redrawNavi();
        resetPage();
        loadSelect();
        triggerSearch();
@@ -615,7 +596,7 @@ function team($, teamName) {
        }
        m_filters = newFilters;
 
-       redraw_navi();
+       redrawNavi();
        resetPage();
        loadSelect();
        triggerSearch();
@@ -640,7 +621,7 @@ function team($, teamName) {
        }
        m_filters = newFilters;
 
-       redraw_navi();
+       redrawNavi();
        resetPage();
        loadSelect();
        triggerSearch();
@@ -648,7 +629,7 @@ function team($, teamName) {
     }
 
 
-    function redraw_navi ()
+    function redrawNavi ()
     {
        var navi = findnode('.mkwsNavi');
        if (!navi) return;
@@ -750,10 +731,9 @@ function team($, teamName) {
 
 
     // switching view between targets and records
-    that.switchView = function(view) {
+    function switchView(view) {
        var targets = findnode('.mkwsTargets');
-       // ### Fix next line to use findnode()
-       var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName);
+       var results = findnode('.mkwsResults,.mkwsRecords');
        var blanket = findnode('.mkwsBlanket');
        var motd    = findnode('.mkwsMOTD');
 
@@ -783,6 +763,9 @@ function team($, teamName) {
     }
 
 
+    that.switchView = switchView;
+
+
     // detailed record drawing
     that.showDetails = function (prefixRecId) {
        var recId = prefixRecId.replace('mkwsRec_', '');
@@ -925,14 +908,13 @@ 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();
+    function mkwsHtmlAll() {
+       mkwsSetLang();
        if (mkws_config.show_lang)
-           mkws_html_lang();
+           mkwsHtmlLang();
 
        debug("HTML search form");
-       mkws.handle_node_with_team(findnode('.mkwsSearch'), function(tname) {
+       mkws.handleNodeWithTeam(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 + '" />\
@@ -950,8 +932,8 @@ function team($, teamName) {
        //      .mkwsPager
        //      .mkwsNavi
        //      .mkwsRecords
-       if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) {
-           $(".mkwsResults.mkwsTeam_" + m_teamName).html('\
+       if (findnode(".mkwsResults").length) {
+           findnode(".mkwsResults").html('\
 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
   <tr>\
     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
@@ -977,26 +959,17 @@ function team($, teamName) {
            var ranking_data = '';
            ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
            if (mkws_config.show_sort) {
-               ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
+               ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
            }
            if (mkws_config.show_perpage) {
-               ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
+               ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
            }
             ranking_data += '</form>';
 
            node.html(ranking_data);
        }
 
-       mkws_html_switch();
-
-       // ### Should not be in the team code, since window size is global
-       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() });
-           // initial check after page load
-           $(document).ready(function() { mkws.resize_page() });
-       }
+       mkwsHtmlSwitch();
 
        var node;
        node = findnode('.mkwsSearchForm');
@@ -1033,7 +1006,7 @@ function team($, teamName) {
     }
 
 
-    function mkws_set_lang()  {
+    function mkwsSetLang()  {
        var lang = parseQuerystring().lang || mkws_config.lang;
        if (!lang || !mkws.locale_lang[lang]) {
            mkws_config.lang = ""
@@ -1046,7 +1019,7 @@ function team($, teamName) {
     }
 
 
-    function mkws_html_switch() {
+    function mkwsHtmlSwitch() {
        debug("HTML switch for team " + m_teamName);
 
        var node = findnode(".mkwsSwitch");
@@ -1064,7 +1037,7 @@ function team($, teamName) {
     }
 
 
-    function mkws_html_sort() {
+    function mkwsHtmlSort() {
        debug("HTML sort, m_sort = '" + m_sort + "'");
        var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
 
@@ -1085,7 +1058,7 @@ function team($, teamName) {
     }
 
 
-    function mkws_html_perpage() {
+    function mkwsHtmlPerpage() {
        debug("HTML perpage, m_perpage = " + m_perpage);
        var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
 
@@ -1105,7 +1078,7 @@ function team($, teamName) {
 
 
     /* create locale language menu */
-    function mkws_html_lang() {
+    function mkwsHtmlLang() {
        var lang_default = "en";
        var lang = mkws_config.lang || lang_default;
        var list = [];
@@ -1147,7 +1120,7 @@ function team($, teamName) {
     }
 
 
-    that.run_auto_search = function() {
+    that.runAutoSearch = function() {
        // ### should check mkwsTermlist as well, for facet-only teams
        var node = findnode('.mkwsRecords');
        var query = node.attr('autosearch');
@@ -1180,7 +1153,7 @@ function team($, teamName) {
        if (targets) s += " in targets '" + targets + "'";
        debug(s);
 
-       this.newSearch(query, sort, targets, m_teamName);
+       newSearch(query, sort, targets);
     }
 
 
@@ -1210,7 +1183,7 @@ function team($, teamName) {
     // main
     (function() {
        try {
-           mkws_html_all()
+           mkwsHtmlAll()
        }
 
        catch (e) {
@@ -1246,7 +1219,7 @@ function team($, teamName) {
     var debug = mkws.debug;
 
 
-    mkws.handle_node_with_team = function(node, callback) {
+    mkws.handleNodeWithTeam = function(node, callback) {
        // First branch for DOM objects; second branch for jQuery objects
        var classes = node.className || node.attr('class');
        if (!classes) {
@@ -1254,7 +1227,7 @@ function team($, teamName) {
            // 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");
+           mkws.debug("handleNodeWithTeam() called on node with no classes");
            return;
        }
        var list = classes.split(/\s+/)
@@ -1272,7 +1245,7 @@ function team($, teamName) {
     }
 
 
-    mkws.resize_page = function () {
+    mkws.resizePage = function () {
        var list = ["mkwsSwitch", "mkwsLang"];
 
        var width = mkws_config.responsive_design_width;
@@ -1341,7 +1314,7 @@ function team($, teamName) {
     }
 
 
-    function default_mkws_config() {
+    function defaultMkwsConfig() {
        /* default mkws config */
        var config_default = {
            use_service_proxy: true,
@@ -1391,7 +1364,7 @@ function team($, teamName) {
      * The username/password is configured in the apache config file
      * for the site.
      */
-    function authenticate_session(auth_url, auth_domain, pp2_url) {
+    function authenticateSession(auth_url, auth_domain, pp2_url) {
        debug("Run service proxy auth URL: " + auth_url);
 
        if (!auth_domain) {
@@ -1417,23 +1390,47 @@ function team($, teamName) {
 
            debug("Service proxy auth successfully done");
            mkws.authenticated = true;
-           run_auto_searches();
+           runAutoSearches();
        });
     }
 
 
-    function run_auto_searches() {
+    function runAutoSearches() {
        debug("running auto searches");
 
        for (var teamName in mkws.teams) {
-           mkws.teams[teamName].run_auto_search();
+           mkws.teams[teamName].runAutoSearch();
        }
     }
 
 
     $(document).ready(function() {
        debug("on load ready");
-       default_mkws_config();
+       defaultMkwsConfig();
+
+       if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
+           debug("Reset query width: " + mkws_config.query_width);
+           mkws_config.query_width = 50;
+       }
+
+       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];
+                   debug("Added locally configured language '" + lang + "'");
+               }
+           }
+       }
+
+       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.resizePage() });
+           // initial check after page load
+           $(document).ready(function() { mkws.resizePage() });
+       }
 
        // Backwards compatibility: set new magic class names on any
        // elements that have the old magic IDs.
@@ -1462,7 +1459,7 @@ 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, type) {
+           mkws.handleNodeWithTeam(this, function(tname, type) {
                if (!mkws.teams[tname]) {
                    mkws.teams[tname] = team(j, tname);
                    debug("Made MKWS team '" + tname + "'");
@@ -1475,12 +1472,12 @@ function team($, teamName) {
        debug("Walking MKWS nodes took " + (now-then) + " ms");
 
        if (mkws_config.use_service_proxy) {
-           authenticate_session(mkws_config.service_proxy_auth,
-                                mkws_config.service_proxy_auth_domain,
-                                mkws_config.pazpar2_url);
+           authenticateSession(mkws_config.service_proxy_auth,
+                               mkws_config.service_proxy_auth_domain,
+                               mkws_config.pazpar2_url);
        } else {
            // raw pp2
-           run_auto_searches();
+           runAutoSearches();
        }
     });
 })(jQuery);