Add team.widgetTypes function, returns sorted list of contained types.
[mkws-moved-to-github.git] / src / mkws-team.js
index 7c1f4ec..8872eb3 100644 (file)
@@ -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 + ']'; };
 
@@ -40,21 +41,46 @@ function team($, teamName) {
     that.currentRecordId = function() { return m_currentRecordId; };
     that.currentRecordData = function() { return m_currentRecordData; };
     that.filters = function() { return m_filters; };
+    that.config = function() { return m_config; };
 
     // Accessor methods for individual widgets: writers
     that.set_sortOrder = function(val) { m_sortOrder = val };
     that.set_perpage = function(val) { m_perpage = val };
 
 
+    // The following PubSub code is modified from the jQuery manual:
+    // 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]) {
+           var callbacks = $.Callbacks();
+           queues[id] = {
+               publish: callbacks.fire,
+               subscribe: callbacks.add,
+               unsubscribe: callbacks.remove
+           };
+       }
+       return queues[id];
+    };
+    that.queue = queue;
+
+
     function log(s) {
        var now = $.now();
        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.queue("log").publish(m_teamName, timestamp, s);
     }
     that.log = log;
 
+
     log("start running MKWS");
 
     m_sortOrder = m_config.sort_default;
@@ -77,7 +103,6 @@ function team($, teamName) {
                      "termlist": m_config.facets.join(',')
                    });
 
-
     // pz2.js event handlers:
     function onInit() {
        log("init");
@@ -91,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) {
@@ -103,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);
     }
@@ -146,8 +173,7 @@ function team($, teamName) {
     };
 
 
-    that.limitTarget = function(id, name)
-    {
+    that.limitTarget = function(id, name) {
        log("limitTarget(id=" + id + ", name=" + name + ")");
        m_filters.push({ id: id, name: name });
        triggerSearch();
@@ -155,8 +181,7 @@ function team($, teamName) {
     };
 
 
-    that.limitQuery = function(field, value)
-    {
+    that.limitQuery = function(field, value) {
        log("limitQuery(field=" + field + ", value=" + value + ")");
        m_filters.push({ field: field, value: value });
        triggerSearch();
@@ -164,8 +189,7 @@ function team($, teamName) {
     };
 
 
-    that.delimitTarget = function(id)
-    {
+    that.delimitTarget = function(id) {
        log("delimitTarget(id=" + id + ")");
        removeMatchingFilters(function(f) { return f.id });
        triggerSearch();
@@ -173,8 +197,7 @@ function team($, teamName) {
     };
 
 
-    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();
@@ -197,8 +220,7 @@ function team($, teamName) {
     }
 
 
-    that.showPage = function(pageNum)
-    {
+    that.showPage = function(pageNum) {
        m_currentPage = pageNum;
        m_paz.showPage(m_currentPage - 1);
     };
@@ -219,20 +241,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) {
@@ -241,19 +262,19 @@ function team($, teamName) {
        }
 
        m_filters = []
-       triggerSearch(query, sortOrder, targets);
+       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 = "";
+       var pp2limit = limit || "";
 
        // Continue to use previous query/sort-order unless new ones are specified
        if (query) {
@@ -262,6 +283,9 @@ function team($, teamName) {
        if (sortOrder) {
            m_sortOrder = sortOrder;
        }
+       if (perpage) {
+           m_perpage = perpage;
+       }
        if (targets) {
            m_filters.push({ id: targets, name: targets });
        }
@@ -288,6 +312,14 @@ function team($, teamName) {
        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) + ", " +
            "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
@@ -338,11 +370,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) {
@@ -402,6 +430,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() + ' ';
@@ -431,7 +468,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 {
@@ -544,52 +581,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
@@ -614,17 +605,22 @@ function team($, teamName) {
        teamName = teamName || m_teamName;
 
        selector = $.map(selector.split(','), function(s, i) {
-           return s + '.mkwsTeam_' + teamName;
+           if (teamName === 'AUTO') {
+               return (s + '.mkwsTeam_' + teamName + ',' +
+                       s + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])');
+           } else {
+               return s + '.mkwsTeam_' + teamName;
+           }
        }).join(',');
 
        var node = $(selector);
        //log('findnode(' + selector + ') found ' + node.length + ' nodes');
        return node;
     }
+    that.findnode = findnode;
 
 
-    function renderDetails(data, marker)
-    {
+    function renderDetails(data, marker) {
        var template = loadTemplate("Record");
        var details = template(data);
        return '<div class="details mkwsTeam_' + m_teamName + '" ' +
@@ -633,8 +629,7 @@ function team($, teamName) {
     that.renderDetails = renderDetails;
 
 
-    function loadTemplate(name)
-    {
+    function loadTemplate(name) {
        var template = m_template[name];
 
        if (template === undefined) {
@@ -659,8 +654,7 @@ function team($, teamName) {
     that.loadTemplate = loadTemplate;
 
 
-    function defaultTemplate(name)
-    {
+    function defaultTemplate(name) {
        if (name === 'Record') {
            return '\
 <table>\
@@ -732,6 +726,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!";
@@ -739,27 +742,28 @@ function team($, teamName) {
        return s;
     }
 
+    that.addWidget = function(w) {
+        if (!m_widgets[w.type]) {
+            m_widgets[w.type] = widget;
+            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 + "'");
+        }
+    }
 
-    // The following PubSub code is modified from the jQuery manual:
-    // https://api.jquery.com/jQuery.Callbacks/
-    //
-    // Use as:
-    // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
-    // team.queue("eventName").publish(arg1, arg2, ...);
+    that.widgetTypes = function() {
+        var keys = [];
+        for (var k in m_widgets) keys.push(k);
+        return keys.sort();
+    }
 
-    var queues = {};
-    var queue = function(id) {
-       if (!queues[id]) {
-           var callbacks = $.Callbacks();
-           queues[id] = {
-               publish: callbacks.fire,
-               subscribe: callbacks.add,
-               unsubscribe: callbacks.remove
-           };
-       }
-       return queues[id];
-    };
-    that.queue = queue;
+    that.widget = function(type) {
+        return m_widgets[type];
+    }
 
     mkwsHtmlAll()