X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-team.js;h=17f0f1f770e2b0a94180d63f48499e22ff43239b;hb=24b694ad5605a6f9d2a662677fbfcf9e6b0b693c;hp=ff2a556989cd581b376bf280ea35272ec9872560;hpb=25f6788156cf1f1206eaa4988f5687630ab10226;p=mkws-moved-to-github.git

diff --git a/src/mkws-team.js b/src/mkws-team.js
index ff2a556..17f0f1f 100644
--- a/src/mkws-team.js
+++ b/src/mkws-team.js
@@ -1,3 +1,4 @@
+"use strict";
 // Factory function for team objects. As much as possible, this uses
 // only member variables (prefixed "m_") and inner functions with
 // private scope.
@@ -13,23 +14,30 @@
 //
 mkws.makeTeam = function($, teamName) {
   var that = {};
-  // Note: separate constants from state, which should be in an object
+
+  // Member variables are separated into two categories
+
+  // 1. Persistent state (to be coded in URL fragment)
+  var m_state = {
+    query: null,                // initially undefined
+    sort: null,                 // will be set below
+    size: null,                 // will be set below
+    page: 1,
+    recid: '',
+    filters: filterSet(that)
+  }
+
+  // 2. Internal state (not to be coded)
   var m_teamName = teamName;
+  var m_paz; // will be initialised below
   var m_submitted = false;
-  var m_query; // initially undefined
-  var m_sortOrder; // will be set below
-  var m_perpage; // will be set below
-  var m_filterSet = filterSet(that);
   var m_totalRecordCount = 0;
-  var m_currentPage = 1;
-  var m_currentRecordId = '';
   var m_currentRecordData = null;
   var m_logTime = {
     // Timestamps for logging
     "start": $.now(),
     "last": $.now()
   };
-  var m_paz; // will be initialised below
   var m_templateText = {}; // widgets can register templates to be compiled
   var m_template = {}; // compiled templates, from any source
   var m_widgets = {}; // Maps widget-type to array of widget objects
@@ -43,19 +51,98 @@ mkws.makeTeam = function($, teamName) {
   // Accessor methods for individual widgets: readers
   that.name = function() { return m_teamName; };
   that.submitted = function() { return m_submitted; };
-  that.sortOrder = function() { return m_sortOrder; };
-  that.perpage = function() { return m_perpage; };
-  that.query = function() { return m_query; };
+  that.sortOrder = function() { return m_state.sort; };
+  that.perpage = function() { return m_state.size; };
+  that.query = function() { return m_state.query; };
   that.totalRecordCount = function() { return m_totalRecordCount; };
-  that.currentPage = function() { return m_currentPage; };
-  that.currentRecordId = function() { return m_currentRecordId; };
+  that.currentPage = function() { return m_state.page; };
+  that.currentRecordId = function() { return m_state.recid; };
   that.currentRecordData = function() { return m_currentRecordData; };
-  that.filters = function() { return m_filterSet; };
+  that.filters = function() { return m_state.filters; };
   that.gotRecords = function() { return m_gotRecords; };
 
   // Accessor methods for individual widgets: writers
-  that.set_sortOrder = function(val) { m_sortOrder = val };
-  that.set_perpage = function(val) { m_perpage = val };
+  that.set_sortOrder = function(val) { m_state.sort = val };
+  that.set_perpage = function(val) { m_state.size = val };
+
+  m_state.sort = config.sort_default;
+  m_state.size = config.perpage_default;
+
+  var m_default = $.extend(true, {}, m_state);
+  var tmp = m_default.filters;
+  delete m_default.filters;
+  $.extend(m_default, tmp.fragmentItems());
+
+  that.urlFragment = function(overrides) {
+    var s;
+
+    // Expand the filterSet into a set of key=value properties 
+    var state = $.extend(true, {}, m_state, overrides ? overrides : {});
+    var tmp = state.filters;
+    delete state.filters;
+    $.extend(state, tmp.fragmentItems());
+
+    for (var key in state) {
+      if (state.hasOwnProperty(key) &&
+          state[key] != m_default[key]) {
+        if (!s) {
+          var s = 'mkws';
+          if (m_teamName !== 'AUTO') s += m_teamName;
+          s += '=';
+        } else {
+          s += "@";
+        }
+
+        // ### how do we need to quote this?
+        s += key + '=' + state[key];
+      }
+    }
+
+    return s;
+  }
+
+  // ### what quoting do we need to undo? Complement of previous function
+  that.parseFragment = function(s) {
+    var x = {};
+
+    var list = s.split('@');
+    for (var i in list) {
+      var a = list[i].split('=');
+      x[a[0]] = a[1];
+    }
+
+    return x;
+  }
+
+  that.handleChanges = function(oldState, newState) {
+    for (var key in newState) {
+      var val = newState[key];
+      if (newState.hasOwnProperty(key) &&
+          (!oldState || val != oldState[key])) {
+        that.warn("changed property " + key + ": " + 
+                  (oldState ? ("'" + oldState[key] + "'") : "undefined") +
+                  " -> '" + val + "'");
+        if (key === 'page') {
+          that.showPage(parseInt(val));
+        } else if (key === 'sort') {
+          that.set_sortOrder(val);
+          if (that.submitted()) {
+            that.reShow();
+          }
+        } else if (key === 'size') {
+          that.set_perpage(val);
+          if (that.submitted()) {
+            that.reShow();
+          }
+        } else if (key.indexOf('xt-') == 0) {
+          that.limitTarget(key.substring(3), val);
+        } else if (key.indexOf('xf-') == 0) {
+          var a = key.split('-');
+          that.limitQuery(a[1], a[2]);
+        }
+      }
+    }
+  };
 
 
   // The following PubSub code is modified from the jQuery manual:
@@ -98,9 +185,6 @@ mkws.makeTeam = function($, teamName) {
 
   that.info("making new widget team");
 
-  m_sortOrder = config.sort_default;
-  m_perpage = config.perpage_default;
- 
   // pz2.js event handlers:
   function onInit() {
     that.info("init");
@@ -208,22 +292,22 @@ mkws.makeTeam = function($, teamName) {
 
 
   that.targetFiltered = function(id) {
-    return m_filterSet.targetFiltered(id);
+    return m_state.filters.targetFiltered(id);
   };
 
 
   that.limitTarget = function(id, name) {
     that.info("limitTarget(id=" + id + ", name=" + name + ")");
-    m_filterSet.add(targetFilter(id, name));
-    if (m_query) triggerSearch();
+    m_state.filters.add(targetFilter(id, name));
+    if (m_state.query) triggerSearch();
     return false;
   };
 
 
   that.limitQuery = function(field, value) {
     that.info("limitQuery(field=" + field + ", value=" + value + ")");
-    m_filterSet.add(fieldFilter(field, value));
-    if (m_query) triggerSearch();
+    m_state.filters.add(fieldFilter(field, value));
+    if (m_state.query) triggerSearch();
     return false;
   };
 
@@ -231,58 +315,64 @@ mkws.makeTeam = function($, teamName) {
   that.limitCategory = function(id) {
     that.info("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();
+    m_state.filters.removeMatching(function(f) { return f.type === 'category' });
+    if (id !== '') m_state.filters.add(categoryFilter(id));
+    if (m_state.query) triggerSearch();
     return false;
   };
 
 
   that.delimitTarget = function(id) {
     that.info("delimitTarget(id=" + id + ")");
-    m_filterSet.removeMatching(function(f) { return f.type === 'target' });
-    if (m_query) triggerSearch();
+    m_state.filters.removeMatching(function(f) { return f.type === 'target' });
+    if (m_state.query) triggerSearch();
     return false;
   };
 
 
   that.delimitQuery = function(field, value) {
     that.info("delimitQuery(field=" + field + ", value=" + value + ")");
-    m_filterSet.removeMatching(function(f) { return f.type == 'field' &&
+    m_state.filters.removeMatching(function(f) { return f.type == 'field' &&
                                              field == f.field && value == f.value });
-    if (m_query) triggerSearch();
+    if (m_state.query) triggerSearch();
     return false;
   };
 
 
   that.showPage = function(pageNum) {
-    m_currentPage = pageNum;
-    m_paz.showPage(m_currentPage - 1);
+    m_state.page = pageNum;
+    m_paz.showPage(m_state.page - 1);
+    that.warn("fragment: " + that.urlFragment());
   };
 
 
   that.pagerNext = function() {
-    if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
+    if (m_totalRecordCount - m_state.size * m_state.page > 0) {
       m_paz.showNext();
-      m_currentPage++;
+      m_state.page++;
+      that.warn("fragment: " + that.urlFragment());
     }
   };
 
 
   that.pagerPrev = function() {
-    if (m_paz.showPrev() != false)
-      m_currentPage--;
+    if (m_paz.showPrev() != false) {
+      m_state.page--;
+      that.warn("fragment: " + that.urlFragment());
+    }
   };
 
 
   that.reShow = function() {
     resetPage();
-    m_paz.show(0, m_perpage, m_sortOrder);
+    m_paz.show(0, m_state.size, m_state.sort);
+    // ### not really the right place for this but it will do for now.
+    that.warn("fragment: " + that.urlFragment());
   };
 
 
   function resetPage() {
-    m_currentPage = 1;
+    m_state.page = 1;
     m_totalRecordCount = 0;
     m_gotRecords = false;
   }
@@ -297,7 +387,7 @@ mkws.makeTeam = function($, teamName) {
       return;
     }
 
-    m_filterSet.removeMatching(function(f) { return f.type !== 'category' });
+    m_state.filters.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;
@@ -309,14 +399,14 @@ mkws.makeTeam = function($, teamName) {
     resetPage();
 
     // Continue to use previous query/sort-order unless new ones are specified
-    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 (query) m_state.query = query;
+    if (sortOrder) m_state.sort = sortOrder;
+    if (perpage) m_state.size = perpage;
+    if (targets) m_state.filters.add(targetFilter(targets, targets));
+
+    var pp2filter = m_state.filters.pp2filter();
+    var pp2limit = m_state.filters.pp2limit(limit);
+    var pp2catLimit = m_state.filters.pp2catLimit();
     if (pp2catLimit) {
       pp2filter = pp2filter ? pp2filter + "," + pp2catLimit : pp2catLimit;
     }
@@ -330,17 +420,21 @@ mkws.makeTeam = function($, teamName) {
       params.torusquery = torusquery;
     }
 
-    that.info("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " +
+    that.info("triggerSearch(" + m_state.query + "): filters = " + m_state.filters.toJSON() + ", " +
         "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 
-    m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
+    m_paz.search(m_state.query, m_state.size, m_state.sort, pp2filter, undefined, params);
     queue("searchtriggered").publish();
+
+    // ### not really the right place for this but it will do for now.
+    that.warn("fragment: " + that.urlFragment());
   }
 
   // fetch record details to be retrieved from the record queue
   that.fetchDetails = function(recId) {
     that.info("fetchDetails() requesting record '" + recId + "'");
     m_paz.record(recId);
+    that.warn("fragment: " + that.urlFragment());
   };
 
 
@@ -373,15 +467,15 @@ mkws.makeTeam = function($, teamName) {
 
   // detailed record drawing
   that.showDetails = function(recId) {
-    var oldRecordId = m_currentRecordId;
-    m_currentRecordId = recId;
+    var oldRecordId = m_state.recid;
+    m_state.recid = recId;
 
     // remove current detailed view if any
     findnode('#' + recordDetailsId(oldRecordId)).remove();
 
     // if the same clicked, just hide
     if (recId == oldRecordId) {
-      m_currentRecordId = '';
+      m_state.recid = '';
       m_currentRecordData = null;
       return;
     }