triggerSearch correctly handles the targets parameter once more.
[mkws-moved-to-github.git] / src / mkws-team.js
index dcd0479..a76c65c 100644 (file)
@@ -5,8 +5,8 @@
 // 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().
+// limitCategory(), delimitTarget(), delimitQuery(), showPage(),
+// pagerPrev(), pagerNext().
 //
 function team($, teamName) {
     var that = {};
@@ -15,7 +15,7 @@ function team($, teamName) {
     var m_query; // initially undefined
     var m_sortOrder; // will be set below
     var m_perpage; // will be set below
-    var m_filters = [];
+    var m_filterSet = filterSet(that);
     var m_totalRecordCount = 0;
     var m_currentPage = 1;
     var m_currentRecordId = '';
@@ -27,7 +27,8 @@ function team($, teamName) {
     };
     var m_paz; // will be initialised below
     var m_template = {};
-    var m_config = Object.create(mkws.config);
+    var m_config = mkws.objectInheritingFrom(mkws.config);
+    var m_widgets = {}; // Maps widget-type to object
 
     that.toString = function() { return '[Team ' + teamName + ']'; };
 
@@ -39,7 +40,7 @@ function team($, teamName) {
     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.filters = function() { return m_filterSet; };
     that.config = function() { return m_config; };
 
     // Accessor methods for individual widgets: writers
@@ -48,12 +49,12 @@ function team($, teamName) {
 
 
     // The following PubSub code is modified from the jQuery manual:
-    // https://api.jquery.com/jQuery.Callbacks/
+    // http://api.jquery.com/jQuery.Callbacks/
     //
     // Use as:
     // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
     // team.queue("eventName").publish(arg1, arg2, ...);
-
+    //
     var queues = {};
     function queue(id) {
        if (!queues[id]) {
@@ -115,8 +116,9 @@ function team($, teamName) {
     }
 
     function onStat(data) {
-       log("stat");
        queue("stat").publish(data);
+       if (parseInt(data.activeclients[0], 10) === 0)
+           queue("complete").publish(parseInt(data.hits[0], 10));
     }
 
     function onTerm(data) {
@@ -127,6 +129,7 @@ function team($, teamName) {
     function onShow(data, teamName) {
        log("show");
        m_totalRecordCount = data.merged;
+       log("found " + m_totalRecordCount + " records");
        queue("pager").publish(data);
        queue("records").publish(data);
     }
@@ -160,69 +163,54 @@ function team($, teamName) {
 
 
     that.targetFiltered = function(id) {
-       for (var i = 0; i < m_filters.length; i++) {
-           if (m_filters[i].id === id ||
-               m_filters[i].id === 'pz:id=' + id) {
-               return true;
-           }
-       }
-       return false;
+       return m_filterSet.targetFiltered(id);
     };
 
 
-    that.limitTarget = function(id, name)
-    {
+    that.limitTarget = function(id, name) {
        log("limitTarget(id=" + id + ", name=" + name + ")");
-       m_filters.push({ id: id, name: name });
-       triggerSearch();
+       m_filterSet.add(targetFilter(id, name));
+       if (m_query) triggerSearch();
        return false;
     };
 
 
-    that.limitQuery = function(field, value)
-    {
+    that.limitQuery = function(field, value) {
        log("limitQuery(field=" + field + ", value=" + value + ")");
-       m_filters.push({ field: field, value: value });
-       triggerSearch();
+       m_filterSet.add(fieldFilter(field, value));
+        if (m_query) triggerSearch();
        return false;
     };
 
 
-    that.delimitTarget = function(id)
-    {
-       log("delimitTarget(id=" + id + ")");
-       removeMatchingFilters(function(f) { return f.id });
-       triggerSearch();
+    that.limitCategory = function(id) {
+       log("limitCategory(id=" + id + ")");
+        // Only one category filter at a time
+       m_filterSet.removeMatching(function(f) { return f.type === 'category' });
+        if (id !== '') m_filterSet.add(categoryFilter(id));
+        if (m_query) triggerSearch();
        return false;
     };
 
 
-    that.delimitQuery = function(field, value)
-    {
-       log("delimitQuery(field=" + field + ", value=" + value + ")");
-       removeMatchingFilters(function(f) { return f.field && field == f.field && value == f.value });
-       triggerSearch();
+    that.delimitTarget = function(id) {
+       log("delimitTarget(id=" + id + ")");
+       m_filterSet.removeMatching(function(f) { return f.type === 'target' });
+        if (m_query) triggerSearch();
        return false;
     };
 
 
-    function removeMatchingFilters(matchFn) {
-       var newFilters = [];
-       for (var i in m_filters) {
-           var filter = m_filters[i];
-           if (matchFn(filter)) {
-               log("removeMatchingFilters() removing filter " + $.toJSON(filter));
-           } else {
-               log("removeMatchingFilters() keeping filter " + $.toJSON(filter));
-               newFilters.push(filter);
-           }
-       }
-       m_filters = newFilters;
-    }
+    that.delimitQuery = function(field, value) {
+       log("delimitQuery(field=" + field + ", value=" + value + ")");
+       m_filterSet.removeMatching(function(f) { return f.type == 'field' &&
+                                                 field == f.field && value == f.value });
+        if (m_query) triggerSearch();
+       return false;
+    };
 
 
-    that.showPage = function(pageNum)
-    {
+    that.showPage = function(pageNum) {
        m_currentPage = pageNum;
        m_paz.showPage(m_currentPage - 1);
     };
@@ -243,20 +231,19 @@ function team($, teamName) {
 
 
     that.reShow = function() {
+       resetPage();
        m_paz.show(0, m_perpage, m_sortOrder);
     };
 
 
-    function resetPage()
-    {
+    function resetPage() {
        m_currentPage = 1;
        m_totalRecordCount = 0;
     }
     that.resetPage = resetPage;
 
 
-    function newSearch(query, sortOrder, targets)
-    {
+    function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
        log("newSearch: " + query);
 
        if (m_config.use_service_proxy && !mkws.authenticated) {
@@ -264,71 +251,53 @@ function team($, teamName) {
            return;
        }
 
-       m_filters = []
-       triggerSearch(query, sortOrder, targets);
+       m_filterSet.removeMatching(function(f) { return f.type !== 'category' });
+       triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
        switchView('records'); // In case it's configured to start off as hidden
        m_submitted = true;
     }
     that.newSearch = newSearch;
 
 
-    function triggerSearch(query, sortOrder, targets)
-    {
+    function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
        resetPage();
        queue("navi").publish();
 
-       var pp2filter = "";
-       var pp2limit = "";
-
        // Continue to use previous query/sort-order unless new ones are specified
-       if (query) {
-           m_query = query;
-       }
-       if (sortOrder) {
-           m_sortOrder = sortOrder;
-       }
-       if (targets) {
-           m_filters.push({ id: targets, name: targets });
-       }
-
-       for (var i in m_filters) {
-           var filter = m_filters[i];
-           if (filter.id) {
-               if (pp2filter)
-                   pp2filter += ",";
-               if (filter.id.match(/^[a-z:]+[=~]/)) {
-                   log("filter '" + filter.id + "' already begins with SETTING OP");
-               } else {
-                   filter.id = 'pz:id=' + filter.id;
-               }
-               pp2filter += filter.id;
-           } else {
-               if (pp2limit)
-                   pp2limit += ",";
-               pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
-           }
-       }
+       if (query) m_query = query;
+       if (sortOrder) m_sortOrder = sortOrder;
+       if (perpage) m_perpage = perpage;
+       if (targets) m_filterSet.add(targetFilter(targets, targets));
+
+       var pp2filter = m_filterSet.pp2filter();
+       var pp2limit = m_filterSet.pp2limit(limit);
+        var pp2catLimit = m_filterSet.pp2catLimit();
+       if (pp2catLimit) {
+            pp2filter = pp2filter ? pp2filter + "," + pp2catLimit : pp2catLimit;
+        }
 
        var params = {};
-       if (pp2limit) {
-           params.limit = pp2limit;
+       if (pp2limit) params.limit = pp2limit;
+       if (maxrecs) params.maxrecs = maxrecs;
+       if (torusquery) {
+           if (!mkws.config.use_service_proxy)
+               alert("can't narrow search by torusquery when Service Proxy is not in use");
+           params.torusquery = torusquery;
        }
 
-       log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", " +
+       log("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " +
            "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 
-       // We can use: params.torusquery = "udb=NAME"
-       // Note: that won't work when running against raw pazpar2
        m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
     }
 
 
     // switching view between targets and records
     function switchView(view) {
-       var targets = findnode('.mkwsTargets');
-       var results = findnode('.mkwsResults,.mkwsRecords');
-       var blanket = findnode('.mkwsBlanket');
-       var motd    = findnode('.mkwsMOTD');
+       var targets = widgetNode('Targets');
+       var results = widgetNode('Results') || widgetNode('Records');
+       var blanket = widgetNode('Blanket');
+       var motd    = widgetNode('MOTD');
 
        switch(view) {
         case 'targets':
@@ -363,11 +332,7 @@ function team($, teamName) {
        m_currentRecordId = recId;
 
        // remove current detailed view if any
-       // ##### restrict to current team
-       var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
-       // lovin DOM!
-       if (detRecordDiv)
-           detRecordDiv.parentNode.removeChild(detRecordDiv);
+       findnode('#' + recordDetailsId(oldRecordId)).remove();
 
        // if the same clicked, just hide
        if (recId == oldRecordId) {
@@ -427,6 +392,15 @@ function team($, teamName) {
   </tr>\
 </table>');
 
+       var acc = [];
+       var facets = m_config.facets;
+       acc.push('<div class="title">' + M('Termlists') + '</div>');
+       for (var i = 0; i < facets.length; i++) {
+           acc.push('<div class="mkwsFacet mkwsTeam_' + m_teamName + '" data-mkws-facet="' + facets[i] + '">');
+           acc.push('</div>');
+       }
+       findnode(".mkwsTermlists").html(acc.join(''));
+
        var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
        if (m_config.show_sort) {
            ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
@@ -440,13 +414,16 @@ function team($, teamName) {
        mkwsHtmlSwitch();
 
        findnode('.mkwsSearchForm').submit(function() {
-           var val = findnode('.mkwsQuery').val();
+           var val = widgetNode('Query').val();
            newSearch(val);
            return false;
        });
 
        // on first page, hide the termlist
-       $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
+       $(document).ready(function() {
+            var t = widgetNode("Termlists");
+            if (t) t.hide();
+        });
         var container = findnode(".mkwsMOTDContainer");
        if (container.length) {
            // Move the MOTD from the provided element down into the container
@@ -456,7 +433,7 @@ function team($, teamName) {
 
 
     function mkwsSetLang()  {
-       var lang = getParameterByName("lang") || m_config.lang;
+       var lang = mkws.getParameterByName("lang") || m_config.lang;
        if (!lang || !mkws.locale_lang[lang]) {
            m_config.lang = ""
        } else {
@@ -467,7 +444,27 @@ function team($, teamName) {
        return m_config.lang;
     }
 
+    // set or re-set "lang" URL parameter
+    function lang_url(lang) {
+       var query = location.search;
+       // no query parameters? done
+       if (!query) {
+           return "?lang=" + lang;
+       }
+
+       // parameter does not exists
+       if (!query.match(/[\?&]lang=/)) {
+            return query + "&lang=" + lang;
+        }
 
+       // replace existing parameter
+       query = query.replace(/\?lang=([^&#;]*)/, "?lang=" + lang);
+       query = query.replace(/\&lang=([^&#;]*)/, "&lang=" + lang);
+
+       return query;
+    }
+   
+       // dynamic URL or static page? /path/foo?query=test
     /* create locale language menu */
     function mkwsHtmlLang() {
        var lang_default = "en";
@@ -503,7 +500,7 @@ function team($, teamName) {
            if (lang == l) {
                data += ' <span>' + l + '</span> ';
            } else {
-               data += ' <a href="?lang=' + l + '">' + l + '</a> '
+               data += ' <a href="' + lang_url(l) + '">' + l + '</a> '
            }
        }
 
@@ -569,52 +566,6 @@ function team($, teamName) {
     }
 
 
-    that.runAutoSearch = function() {
-       var node = findnode('.mkwsRecords,.mkwsTermlists');
-       var query = node.attr('autosearch');
-       if (!query)
-           return;
-
-       if (query.match(/^!param!/)) {
-           var param = query.replace(/^!param!/, '');
-           query = getParameterByName(param);
-           log("obtained query '" + query + "' from param '" + param + "'");
-           if (!query) {
-               alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
-           }
-       } else if (query.match(/^!path!/)) {
-           var index = query.replace(/^!path!/, '');
-           var path = window.location.pathname.split('/');
-           query = path[path.length - index];
-           log("obtained query '" + query + "' from path-component '" + index + "'");
-           if (!query) {
-               alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
-           }
-       }
-
-       log("node=" + node + ", class='" + node.className + "', query=" + query);
-
-       var sortOrder = node.attr('sort');
-       var targets = node.attr('targets');
-       var s = "running auto search: '" + query + "'";
-       if (sortOrder) s += " sorted by '" + sortOrder + "'";
-       if (targets) s += " in targets '" + targets + "'";
-       log(s);
-
-       newSearch(query, sortOrder, targets);
-    };
-
-
-    // This function is taken from a StackOverflow answer
-    // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
-    function getParameterByName(name) {
-       name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
-       var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
-           results = regex.exec(location.search);
-       return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
-    }
-
-
     // Translation function. At present, this is properly a
     // global-level function (hence the assignment to mkws.M) but we
     // want to make it per-team so different teams can operate in
@@ -632,24 +583,31 @@ function team($, teamName) {
 
 
     // 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 = teamName || m_teamName;
 
-       selector = $.map(selector.split(','), function(s, i) {
-           return s + '.mkwsTeam_' + teamName;
-       }).join(',');
+       if (teamName === 'AUTO') {
+           selector = (selector + '.mkwsTeam_' + teamName + ',' +
+                       selector + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])');
+       } else {
+           selector = selector + '.mkwsTeam_' + teamName;
+       }
 
        var node = $(selector);
        //log('findnode(' + selector + ') found ' + node.length + ' nodes');
        return node;
     }
+    that.findnode = findnode;
+
 
+    // This much simpler and more efficient function should be usable
+    // in place of most uses of findnode.
+    function widgetNode(type) {
+        var w = that.widget(type);
+        return w ? $(w.node) : undefined;
+    }
 
-    function renderDetails(data, marker)
-    {
+    function renderDetails(data, marker) {
        var template = loadTemplate("Record");
        var details = template(data);
        return '<div class="details mkwsTeam_' + m_teamName + '" ' +
@@ -658,18 +616,20 @@ function team($, teamName) {
     that.renderDetails = renderDetails;
 
 
-    function loadTemplate(name)
-    {
+    function loadTemplate(name) {
        var template = m_template[name];
 
        if (template === undefined) {
            // Fall back to generic template if there is no team-specific one
-           var node = findnode(".mkwsTemplate_" + name);
-           if (!node.length) {
-               node = findnode(".mkwsTemplate_" + name, "ALL");
+           var source;
+           var node = widgetNode("Template_" + name);
+           if (!node) {
+               node = widgetNode("Template_" + name, "ALL");
            }
+            if (node) {
+               source = node.html();
+            }
 
-           var source = node.html();
            if (!source) {
                source = defaultTemplate(name);
            }
@@ -684,8 +644,7 @@ function team($, teamName) {
     that.loadTemplate = loadTemplate;
 
 
-    function defaultTemplate(name)
-    {
+    function defaultTemplate(name) {
        if (name === 'Record') {
            return '\
 <table>\
@@ -757,6 +716,15 @@ function team($, teamName) {
   <span><i>{{md-title-responsibility}}</i></span>\
 {{/if}}\
 ';
+       } else if (name === "Image") {
+           return '\
+      <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
+        {{#first md-thumburl}}\
+         <img src="{{this}}" alt="{{../md-title}}"/>\
+        {{/first}}\
+       <br/>\
+      </a>\
+';
        }
 
        var s = "There is no default '" + name +"' template!";
@@ -764,6 +732,28 @@ function team($, teamName) {
        return s;
     }
 
+    that.addWidget = function(w) {
+        if (!m_widgets[w.type]) {
+            m_widgets[w.type] = w;
+            log("Registered '" + w.type + "' widget in team '" + m_teamName + "'");
+        } else if (typeof(m_widgets[w.type]) !== 'number') {
+            m_widgets[w.type] = 2;
+            log("Registered duplicate '" + w.type + "' widget in team '" + m_teamName + "'");
+        } else {
+            m_widgets[w.type] += 1;
+            log("Registered '" + w.type + "' widget #" + m_widgets[w.type] + "' in team '" + m_teamName + "'");
+        }
+    }
+
+    that.widgetTypes = function() {
+        var keys = [];
+        for (var k in m_widgets) keys.push(k);
+        return keys.sort();
+    }
+
+    that.widget = function(type) {
+        return m_widgets[type];
+    }
 
     mkwsHtmlAll()