Copy mkws_config into mkws.config, and thereafter use that
[mkws-moved-to-github.git] / src / mkws-team.js
index 221c840..4202cb7 100644 (file)
@@ -1,10 +1,12 @@
 // 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 visible 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().
+// private scope.
+//
+// Some functions are visible as member-functions to be called from
+// outside code -- specifically, from generated HTML. These functions
+// are that.switchView(), showDetails(), limitTarget(), limitQuery(),
+// delimitTarget(), delimitQuery(), showPage(), pagerPrev(),
+// pagerNext().
 //
 function team($, teamName) {
     var that = {};
@@ -26,79 +28,77 @@ function team($, teamName) {
     var m_paz; // will be initialised below
     var m_template = {};
 
-    that.name = function() { return m_teamName; }
-    that.submitted = function() { return m_submitted; }
-    that.perpage = function() { return m_perpage; }
-    that.totalRecordCount = function() { return m_totalRecordCount; }
-    that.currentPage = function() { return m_currentPage; }
-    that.currentRecordId = function() { return m_currentRecordId; }
-    that.currentRecordData = function() { return m_currentRecordData; }
-    that.filters = function() { return m_filters; }
+    that.toString = function() { return '[Team ' + teamName + ']'; };
+
+    // Accessor methods for individual widgets: readers
+    that.name = function() { return m_teamName; };
+    that.submitted = function() { return m_submitted; };
+    that.perpage = function() { return m_perpage; };
+    that.totalRecordCount = function() { return m_totalRecordCount; };
+    that.currentPage = function() { return m_currentPage; };
+    that.currentRecordId = function() { return m_currentRecordId; };
+    that.currentRecordData = function() { return m_currentRecordData; };
+    that.filters = function() { return m_filters; };
 
+    // Accessor methods for individual widgets: writers
     that.set_sortOrder = function(val) { m_sortOrder = val };
     that.set_perpage = function(val) { m_perpage = val };
 
 
-    var log = function (s) {
+    function log(s) {
        var now = $.now();
-       var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
+       var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
+                        ((now - m_logTime.last)/1000).toFixed(3) + ") ");
        m_logTime.last = now;
-
        mkws.log(m_teamName + ": " + timestamp + s);
     }
     that.log = log;
 
     log("start running MKWS");
 
-    m_sortOrder = mkws_config.sort_default;
-    m_perpage = mkws_config.perpage_default;
+    m_sortOrder = mkws.config.sort_default;
+    m_perpage = mkws.config.perpage_default;
 
     log("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
     m_paz = new pz2({ "windowid": teamName,
-                     "pazpar2path": mkws_config.pazpar2_url,
-                     "usesessions" : mkws_config.use_service_proxy ? false : true,
+                     "pazpar2path": mkws.config.pazpar2_url,
+                     "usesessions" : mkws.config.use_service_proxy ? false : true,
                      "oninit": onInit,
                      "onbytarget": onBytarget,
                      "onstat": onStat,
-                     "onterm": (mkws_config.facets.length ? onTerm : undefined),
+                     "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(',')
+                     "termlist": mkws.config.facets.join(',')
                    });
 
 
-    //
     // pz2.js event handlers:
-    //
     function onInit() {
        log("init");
        m_paz.stat();
        m_paz.bytarget();
     }
 
-
     function onBytarget(data) {
        log("target");
        queue("targets").publish(data);
     }
 
-
     function onStat(data) {
        log("stat");
        queue("stat").publish(data);
     }
 
-
     function onTerm(data) {
        log("term");
        queue("termlists").publish(data);
     }
 
-
     function onShow(data, teamName) {
        log("show");
        m_totalRecordCount = data.merged;
@@ -106,14 +106,12 @@ function team($, teamName) {
        queue("records").publish(data);
     }
 
-
     function onRecord(data, args, teamName) {
        log("record");
        // FIXME: record is async!!
        clearTimeout(m_paz.recordTimer);
-       // ##### restrict to current team
-       var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
-       if (detRecordDiv) {
+       var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
+       if (detRecordDiv.length) {
            // in case on_show was faster to redraw element
            return;
        }
@@ -124,7 +122,7 @@ function team($, teamName) {
     }
 
 
-    // Used by promoteRecords() and onRecord()
+    // Used by the Records widget and onRecord()
     function recordElementId(s) {
        return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
     }
@@ -134,7 +132,6 @@ function team($, teamName) {
     function recordDetailsId(s) {
        return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
     }
-    that.recordElementId = recordElementId;
 
 
     that.targetFiltered = function(id) {
@@ -145,100 +142,86 @@ function team($, teamName) {
            }
        }
        return false;
-    }
-
-
-    ////////////////////////////////////////////////////////////////////////////////
-    ////////////////////////////////////////////////////////////////////////////////
-
-
-    // when search button pressed
-    function onFormSubmitEventHandler()
-    {
-       var val = findnode('.mkwsQuery').val();
-       newSearch(val);
-       return false;
-    }
-
-
-    function newSearch(query, sortOrder, targets)
-    {
-       log("newSearch: " + query);
-
-       if (mkws_config.use_service_proxy && !mkws.authenticated) {
-           alert("searching before authentication");
-           return;
-       }
-
-       m_filters = []
-       triggerSearch(query, sortOrder, targets);
-       switchView('records'); // In case it's configured to start off as hidden
-       m_submitted = true;
-    }
+    };
 
 
-    // limit by target functions
-    that.limitTarget  = function (id, name)
+    that.limitTarget = function(id, name)
     {
        log("limitTarget(id=" + id + ", name=" + name + ")");
        m_filters.push({ id: id, name: name });
        triggerSearch();
        return false;
-    }
+    };
 
 
-    // limit the query after clicking the facet
-    that.limitQuery = function (field, value)
+    that.limitQuery = function(field, value)
     {
        log("limitQuery(field=" + field + ", value=" + value + ")");
        m_filters.push({ field: field, value: value });
        triggerSearch();
        return false;
-    }
+    };
 
 
-    that.delimitTarget = function (id)
+    that.delimitTarget = function(id)
     {
        log("delimitTarget(id=" + id + ")");
-       var newFilters = [];
-       for (var i in m_filters) {
-           var filter = m_filters[i];
-           if (filter.id) {
-               log("delimitTarget() removing filter " + $.toJSON(filter));
-           } else {
-               log("delimitTarget() keeping filter " + $.toJSON(filter));
-               newFilters.push(filter);
-           }
-       }
-       m_filters = newFilters;
-
+       removeMatchingFilters(function(f) { return f.id });
        triggerSearch();
        return false;
-    }
+    };
 
 
-    that.delimitQuery = function (field, value)
+    that.delimitQuery = function(field, value)
     {
        log("delimitQuery(field=" + field + ", value=" + value + ")");
+       removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
+       triggerSearch();
+       return false;
+    };
+
+
+    function removeMatchingFilters(matchFn) {
        var newFilters = [];
        for (var i in m_filters) {
            var filter = m_filters[i];
-           if (filter.field &&
-               field == filter.field &&
-               value == filter.value) {
-               log("delimitQuery() removing filter " + $.toJSON(filter));
+           if (matchFn(filter)) {
+               log("removeMatchingFilters() removing filter " + $.toJSON(filter));
            } else {
-               log("delimitQuery() keeping filter " + $.toJSON(filter));
+               log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
                newFilters.push(filter);
            }
        }
        m_filters = newFilters;
-
-       triggerSearch();
-       return false;
     }
 
 
+    that.showPage = function(pageNum)
+    {
+       m_currentPage = pageNum;
+       m_paz.showPage(m_currentPage - 1);
+    };
+
+
+    that.pagerNext = function() {
+       if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
+            m_paz.showNext();
+            m_currentPage++;
+       }
+    };
+
+
+    that.pagerPrev = function() {
+       if (m_paz.showPrev() != false)
+            m_currentPage--;
+    };
+
+
+    that.reShow = function() {
+       m_paz.show(0, m_perpage, m_sortOrder);
+    };
+
+
     function resetPage()
     {
        m_currentPage = 1;
@@ -247,7 +230,23 @@ function team($, teamName) {
     that.resetPage = resetPage;
 
 
-    function triggerSearch (query, sortOrder, targets)
+    function newSearch(query, sortOrder, targets)
+    {
+       log("newSearch: " + query);
+
+       if (mkws.config.use_service_proxy && !mkws.authenticated) {
+           alert("searching before authentication");
+           return;
+       }
+
+       m_filters = []
+       triggerSearch(query, sortOrder, targets);
+       switchView('records'); // In case it's configured to start off as hidden
+       m_submitted = true;
+    }
+
+
+    function triggerSearch(query, sortOrder, targets)
     {
        resetPage();
        queue("navi").publish();
@@ -289,7 +288,8 @@ function team($, teamName) {
            params.limit = pp2limit;
        }
 
-       log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
+       log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
+           "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 
        // We can use: params.torusquery = "udb=NAME"
        // Note: that won't work when running against raw pazpar2
@@ -297,34 +297,6 @@ function team($, teamName) {
     }
 
 
-    that.reShow = function() {
-       m_paz.show(0, m_perpage, m_sortOrder);
-    }
-
-
-
-    that.showPage = function (pageNum)
-    {
-       m_currentPage = pageNum;
-       m_paz.showPage(m_currentPage - 1);
-    }
-
-
-    // simple paging functions
-    that.pagerNext = function () {
-       if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
-            m_paz.showNext();
-            m_currentPage++;
-       }
-    }
-
-
-    that.pagerPrev = function () {
-       if (m_paz.showPrev() != false)
-            m_currentPage--;
-    }
-
-
     // switching view between targets and records
     function switchView(view) {
        var targets = findnode('.mkwsTargets');
@@ -360,7 +332,7 @@ function team($, teamName) {
 
 
     // detailed record drawing
-    that.showDetails = function (recId) {
+    that.showDetails = function(recId) {
        var oldRecordId = m_currentRecordId;
        m_currentRecordId = recId;
 
@@ -380,7 +352,7 @@ function team($, teamName) {
        // request the record
        log("showDetails() requesting record '" + recId + "'");
        m_paz.record(recId);
-    }
+    };
 
 
     /*
@@ -389,13 +361,13 @@ function team($, teamName) {
      */
     function mkwsHtmlAll() {
        mkwsSetLang();
-       if (mkws_config.show_lang)
+       if (mkws.config.show_lang)
            mkwsHtmlLang();
 
        log("HTML search form");
        findnode('.mkwsSearch').html('\
 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
-  <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
+  <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws.config.query_width + '" />\
   <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
 </form>');
 
@@ -430,10 +402,10 @@ function team($, teamName) {
 </table>');
 
        var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
-       if (mkws_config.show_sort) {
+       if (mkws.config.show_sort) {
            ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
        }
-       if (mkws_config.show_perpage) {
+       if (mkws.config.show_perpage) {
            ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
        }
         ranking_data += '</form>';
@@ -441,7 +413,11 @@ function team($, teamName) {
 
        mkwsHtmlSwitch();
 
-       findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
+       findnode('.mkwsSearchForm').submit(function() {
+           var val = findnode('.mkwsQuery').val();
+           newSearch(val);
+           return false;
+       });
 
        // on first page, hide the termlist
        $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
@@ -454,26 +430,26 @@ function team($, teamName) {
 
 
     function mkwsSetLang()  {
-       var lang = getParameterByName("lang") || mkws_config.lang;
+       var lang = getParameterByName("lang") || mkws.config.lang;
        if (!lang || !mkws.locale_lang[lang]) {
-           mkws_config.lang = ""
+           mkws.config.lang = ""
        } else {
-           mkws_config.lang = lang;
+           mkws.config.lang = lang;
        }
 
-       log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
-       return mkws_config.lang;
+       log("Locale language: " + (mkws.config.lang ? mkws.config.lang : "none"));
+       return mkws.config.lang;
     }
 
 
     /* create locale language menu */
     function mkwsHtmlLang() {
        var lang_default = "en";
-       var lang = mkws_config.lang || lang_default;
+       var lang = mkws.config.lang || lang_default;
        var list = [];
 
        /* display a list of configured languages, or all */
-       var lang_options = mkws_config.lang_options || [];
+       var lang_options = mkws.config.lang_options || [];
        var toBeIncluded = {};
        for (var i = 0; i < lang_options.length; i++) {
            toBeIncluded[lang_options[i]] = true;
@@ -513,8 +489,8 @@ function team($, teamName) {
        log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
        var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
 
-       for(var i = 0; i < mkws_config.sort_options.length; i++) {
-           var opt = mkws_config.sort_options[i];
+       for(var i = 0; i < mkws.config.sort_options.length; i++) {
+           var opt = mkws.config.sort_options[i];
            var key = opt[0];
            var val = opt.length == 1 ? opt[0] : opt[1];
 
@@ -534,8 +510,8 @@ function team($, teamName) {
        log("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];
+       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 == m_perpage) {
@@ -600,7 +576,7 @@ function team($, teamName) {
        log(s);
 
        newSearch(query, sortOrder, targets);
-    }
+    };
 
 
     // This function is taken from a StackOverflow answer
@@ -619,7 +595,7 @@ function team($, teamName) {
     // different languages.
     //
     function M(word) {
-       var lang = mkws_config.lang;
+       var lang = mkws.config.lang;
 
        if (!lang || !mkws.locale_lang[lang])
            return word;
@@ -640,7 +616,9 @@ function team($, teamName) {
            return s + '.mkwsTeam_' + teamName;
        }).join(',');
 
-       return $(selector);
+       var node = $(selector);
+       //log('findnode(' + selector + ') found ' + node.length + ' nodes');
+       return node;
     }
 
 
@@ -648,7 +626,8 @@ function team($, teamName) {
     {
        var template = loadTemplate("Record");
        var details = template(data);
-       return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
+       return '<div class="details mkwsTeam_' + m_teamName + '" ' +
+           'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
     }
     that.renderDetails = renderDetails;
 
@@ -778,23 +757,10 @@ function team($, teamName) {
            };
        }
        return queues[id];
-    }
+    };
     that.queue = queue;
 
+    mkwsHtmlAll()
 
-    // main
-    (function() {
-       try {
-           mkwsHtmlAll()
-       }
-
-       catch (e) {
-           mkws_config.error = e.message;
-           // alert(e.message);
-       }
-    })();
-
-    // Bizarrely, 'that' is just an empty hash. All its state is in
-    // the closure variables defined earlier in this function.
     return that;
 };