mkdru.removeLimits() no longer leaves dangling limit_subject
[mkdru-moved-to-drupal.org.git] / mkdru.client.js
index dae3fa7..5c2d0d0 100644 (file)
@@ -2,34 +2,43 @@
 var mkdru = {
   // Settings to pass to pz2.js
   useSessions: Drupal.settings.mkdru.use_sessions === '1',
-  //   showResponseType: 'json',
   // Variables
   active: false,
   pz2: null,
   totalRec: 0,
   pagerRange: 6,
   pazpar2Path: Drupal.settings.mkdru.pz2_path,
+  facetContainerSelector: Drupal.settings.mkdru.facetContainerSelector,
   // Facets
   facets: {
     source: {
+      displayName: Drupal.settings.mkdru.source_dname || "Source",
+      orderWeight: Drupal.settings.mkdru.source_weight || 1,
       pz2Name: 'xtargets',
-      max: Drupal.settings.mkdru.source_max
+      max: Drupal.settings.mkdru.source_max || 10
     },
     subject: {
+      displayName: Drupal.settings.mkdru.subject_dname || "Subject",
+      orderWeight: Drupal.settings.mkdru.source_weight || 2,
       pz2Name: 'subject',
-      max: Drupal.settings.mkdru.subject_max
+      max: Drupal.settings.mkdru.subject_max || 10,
+      multiLimit: true,
+      limiter: 'su'
     },
     author: {
+      displayName: Drupal.settings.mkdru.author_dname || "Author",
+      orderWeight: Drupal.settings.mkdru.source_weight || 3,
       pz2Name: 'author',
-      max: Drupal.settings.mkdru.author_max
+      max: Drupal.settings.mkdru.author_max || 10,
+      multiLimit: false,
+      limiter: 'au'
     }
   },
-  // State
+  // State; Keys limit_{facet key} will also be initialised
   defaultState: {
     page: 1,
     perpage: 20,
     sort: 'relevance',
-    filter: null,
     query:'',
     recid:null
   },
@@ -39,6 +48,9 @@ var mkdru = {
 
 
 
+// Wrapper for jQuery
+(function ($) {
+
 // So we can use jQuery BBQ with Drupal 6 and its 1.2.6 jQuery
 if (!$.isArray) $.isArray = function(obj) {
   return Object.prototype.toString.call(obj) === "[object Array]";
@@ -109,18 +121,49 @@ mkdru.pz2Status = function (data) {
   $('.mkdru-status').html(Drupal.theme('mkdruStatus', data.activeclients, data.clients));
 };
 
+mkdru.contains = function (hash, key, value) {
+  if (hash[key]) {
+    if (hash[key].length) {
+      for (var i=0; i<hash[key].length; i++) {
+        if (hash[key][i] === value) {
+          return true;
+        }
+      }
+    } else {
+      return hash[key] === value;
+    }
+  }
+  return false;
+}
+
 mkdru.pz2Term = function (data) {
+  // if signaled, prepare container client-side
+  if (mkdru.facetContainerSelector) {
+    $(mkdru.facetContainerSelector).html(Drupal.theme('mkdruFacetContainer',
+      data, mkdru.facets));
+  }
+  // map all facets against selected, for simple rendering 
+  var hash = $.deparam.fragment();
+  for (var key in hash) {
+    if (key.indexOf('limit') == 0) //always wrap in array
+      hash[key.substr(6)] = hash[key].split(';');
+    delete hash[key];
+  }
   for (var facet in mkdru.facets) {
-    // facet is limited
-    if (mkdru.state['limit_' + facet]) {
-      $('.mkdru-facet-' + facet).html(Drupal.theme('mkdruFacetLimit',
-                                 data[mkdru.facets[facet].pz2Name][0],
-                                 mkdru.hashAddDelOne(null, null, 'limit_' + facet)));
-    } else {
-      $('.mkdru-facet-' + facet).html(Drupal.theme('mkdruFacet',
-                                 data[mkdru.facets[facet].pz2Name],
-                                 facet, mkdru.facets[facet].max));
+    var terms = data[mkdru.facets[facet].pz2Name];
+    for (var i=0; i<terms.length; i++) {
+      var term = terms[i];
+      var value = facet == "source" ? term.id : term.name;
+      if (mkdru.contains(hash, facet, value)) { //enabled
+        term.hashQuery = mkdru.removeLimit(facet, value);
+        term.selected = true;
+      } else { //disabled
+        term.hashQuery = mkdru.addLimit(facet, value);
+        term.selected = false;
+      }
     }
+    $('.mkdru-facet-' + facet).html(
+        Drupal.theme('mkdruFacet', terms, facet, mkdru.facets[facet].max, hash));
   }
 };
 
@@ -184,29 +227,74 @@ mkdru.uiFromState = function () {
 };
 
 mkdru.hashChange = function () {
+  // do we need to restart the search?
+  var searchTrigger = false;
+  // shallow copy of state so we can see what changed.
+  var oldState = $.extend({}, mkdru.state);
   mkdru.stateFromHash();
-  // Request for details
-  if (mkdru.state.recid) {
+  // only have to compare values since all keys are initialised
+  for (key in mkdru.state) {
+    var changed = (mkdru.state[key] != oldState[key]);
+    if (key.substring(0,5) === 'limit' && changed)
+      searchTrigger = true;
+    if (key === 'page' && changed)
+      mkdru.pz2.showPage(mkdru.state.page-1);
+    if (key === 'query' && changed)
+      searchTrigger = true;
+  }
+  if (searchTrigger)
+    mkdru.search();
+  // request for record detail
+  if (mkdru.state.recid && (mkdru.state.recid != oldState.recid)) {
     mkdru.pz2.record(mkdru.state.recid);
   }
-  // Other internal link
   else {
-    // may need to run search again to limit targets
-    for (key in mkdru.state) {
-      if (key.substring(0,5) === 'limit') {
-        mkdru.search();
+    $('.mkdru-detail').hide();
+    $('.mkdru-results').show();
+  }
+};
+
+// return link to limit facet
+mkdru.addLimit = function (facet, limit) {
+  var newHash = $.deparam.fragment();
+  delete newHash['page'];
+  if ((typeof(newHash['limit_' + facet]) === 'undefined')
+       || !mkdru.facets[facet].multiLimit) {
+    newHash['limit_' + facet] = limit;
+  }
+  else {
+    newHash['limit_' + facet] += ';' + limit;
+  }
+  return $.param.fragment("#", newHash);
+};
+
+// return link to remove limit from facet
+mkdru.removeLimit = function (facet, limit) {
+  var newHash = $.deparam.fragment();
+  delete newHash['page'];
+  if (!newHash['limit_' + facet].indexOf(';')
+      || !mkdru.facets[facet].multiLimit) {
+    delete newHash['limit_' + facet];
+  }
+  else {
+    var limits = newHash['limit_' + facet].split(';');
+    for (var i = 0; i < limits.length; i++) {
+      if (limits[i] == limit) {
+        limits.splice(i, 1);
+        if (limits.length < 1)
+          delete newHash['limit_' + facet];
+        else
+          newHash['limit_' + facet] = limits.join(';');
         break;
       }
     }
-    mkdru.pz2.showPage(mkdru.state.page-1);
-    $('.mkdru-detail').hide();
-    $('.mkdru-results').show();
   }
+  return $.param.fragment("#", newHash);
 };
 
 
 
-//form submit handler
+// form submit handler
 mkdru.submitQuery = function () {
   // new query, back to defaults (shallow copy)
   mkdru.state = $.extend({}, mkdru.defaultState);
@@ -218,7 +306,7 @@ mkdru.submitQuery = function () {
   return false;
 };
 
-//criteria drop-down (perpage, sort) handler
+// criteria drop-down (perpage, sort) handler
 mkdru.submitCriteria = function () {
   mkdru.pollDropDowns();
   //search is not ON, do nothing
@@ -235,17 +323,24 @@ mkdru.search = function () {
   var query = mkdru.state.query;
 
   // facet limit implementation
-  if (mkdru.state.limit_source) {
-    filter = 'pz:id=' + mkdru.state.limit_source;
-  }
-  if (mkdru.state.limit_subject) {
-    query += ' and su="' + mkdru.state.limit_subject + '"';
-  }
-  if (mkdru.state.limit_author) {
-    query += ' and au="' + mkdru.state.limit_author + '"';
+  for (var facet in mkdru.facets) {
+    // facet is limited
+    if (mkdru.state['limit_' + facet]) {
+      if (facet == "source") {
+        filter = 'pz:id=' + mkdru.state.limit_source;
+      }
+      else {
+        var limits = mkdru.state['limit_' + facet].split(';');
+        for (var i = 0; i < limits.length; i++) {
+          // ex. query + and au="{limit_author}"
+          query += ' and ' + mkdru.facets[facet]['limiter'] + '="'
+                  + mkdru.state['limit_' + facet] + '"';
+        }
+      }
+    }
   }
+
   mkdru.pz2.search(query, mkdru.state.perpage, mkdru.state.sort, filter);
-  //inform others that the search is ON
   mkdru.active = true;
 };
 
@@ -255,7 +350,7 @@ mkdru.pollDropDowns = function () {
 };
 
 mkdru.generatePager = function () {
- // make sure page param is a number, otherwise pageing frwd will be broken
+  // cast page parameter to numeric so we can add to it
   if (typeof mkdru.state.page == "string") {
     mkdru.state.page = Number(mkdru.state.page);
   }
@@ -263,7 +358,7 @@ mkdru.generatePager = function () {
   var first = (mkdru.state.page - mkdru.pagerRange > 0)
       ? mkdru.state.page - mkdru.pagerRange : 1;
   var last = first + 2 * mkdru.pagerRange < total
-      ? first + 2 * mkdru.pagerRange : total;  
+      ? first + 2 * mkdru.pagerRange : total;
   var prev = null;
   var next = null;
   var pages = [];
@@ -325,7 +420,10 @@ $(document).ready(function () {
   // ting thing
   if (typeof(Drupal.settings.mkdru.query) !== "undefined") {
     mkdru.state.query = Drupal.settings.mkdru.query
+    //force the hash to contain query
+    mkdru.hashFromState();
   }
+
   //not running against SP? init, otherwise authenticate
   if (mkdru.useSessions) {
     mkdru.pz2.init();
@@ -349,7 +447,7 @@ $(document).ready(function () {
     );
     authReq.get(params,
       function (data) {
-        var s = data.getElementsByTagName('status');          
+        var s = data.getElementsByTagName('status');
         if (s.length && Element_getTextContent(s[0]) == "OK") {
           mkdru.realm = data.getElementsByTagName('realm');
           mkdru.pz2Init();
@@ -360,15 +458,5 @@ $(document).ready(function () {
       }
     );
   }
-  //i'm not sure how this can work, does it assume the results set is active?
-  //what if no search has been executed?
-  //if (mkdru.state.recid) {
-  //  mkdru.pz2.record(mkdru.state.recid);
-  //}
-  //'mkdru.onInit/ deals with the following properly 
-  /// -- waiting for Pz2/SP to init first
-  //else if (mkdru.state.query) {
-  //  mkdru.search();
-  //}
 });
+})(jQuery);