Pager rewrite for bookmark/history support.
[mkdru-moved-to-drupal.org.git] / mkdru.client.js
index 1787621..a672f21 100644 (file)
 // Set up namespace and some state.
 var mkdru = {
   // Settings to pass to pz2.js
-  usesessions: true,
-  showResponseType: '',
+  usesessions: Drupal.settings.mkdru.use_sessions === '1',
+  //   showResponseType: 'json',
   // Variables
-  curPage: 1,
-  recPerPage: 20,
-  totalRec: 0,
-  curSort: 'relevance',
-  curFilter: null,
   submitted: false,
-  sourceMax: 16, // facets
-  subjectMax: 10,
-  authorMax: 10,
   pz2: null,
-  pazpar2Path: '/pazpar2/search.pz2',
+  totalRec: 0,
+  pagerRange: 6,
+  sourceMax: Drupal.settings.mkdru.source_max,
+  subjectMax: Drupal.settings.mkdru.subject_max,
+  authorMax: Drupal.settings.mkdru.author_max,
+  pazpar2Path: Drupal.settings.mkdru.pz2_path,
+  // State
+  defaultState: {
+    page: 1,
+    perpage: 20,
+    sort: 'relevance',
+    filter: null,
+    query:null
+  },
+  state: {}
 };
 
 
 
+// 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]";
+},
+
+
+
 // pz2.js event handlers:
 mkdru.pz2Init = function () {
-  mkdru.pz2.stat();
-  mkdru.pz2.bytarget();
+  if (mkdru.state.query) mkdru.triggerSearch();
+  //mkdru.pz2.stat();
+  //mkdru.pz2.bytarget();
 };
 
 mkdru.pz2Show = function (data) {
   mkdru.totalRec = data.merged;
-  $('#mkdru-pager').html(Drupal.theme('mkdruPager', data, mkdru.curPage,
-                                      Math.ceil(mkdru.totalRec / mkdru.recPerPage)));
-  $('.mkdru-next').bind('click', mkdru.nextPage);
-  $('.mkdru-prev').bind('click', mkdru.prevPage);
+  $('.mkdru-pager').html(mkdru.generatePager());
+  var countsHtml = Drupal.t('Displaying: ') + (data.start + 1) + 
+    Drupal.t(' to ') + (data.start + data.num) + Drupal.t(' of ')
+    + data.merged + Drupal.t(' (found: ') + data.total + ')';
+  $('.mkdru-counts').html(countsHtml);
 
   var html = "";
   for (var i = 0; i < data.hits.length; i++) {
     html += Drupal.theme('mkdruResult', data.hits[i], 
-                         i + 1 + mkdru.recPerPage * 
-                         (mkdru.curPage - 1));
+      i + 1 + mkdru.state.perpage * (mkdru.state.page - 1),
+      "#" + $.param.fragment($.param.fragment(
+        window.location.href, {recid: data.hits[i].recid})) + "\n"
+    );
   }
-  $('#mkdru-results').html(html);
+  $('.mkdru-result-list').html(html);
+  $('.mkdru-results').show();
 };
 
 mkdru.pz2Status = function (data) {
 };
 
 mkdru.pz2Term = function (data) {
-    var html = "";
-    for (var i = 0; i < data.xtargets.length && i < mkdru.SourceMax; i++ ) {
-      html += Drupal.theme('mkdruTerm', data.xtargets[i].name, data.xtargets[i].freq, 
-                           'mkdru-facet-link-source', data.xtargets[i].id);
+  var html = "";
+  for (var i = 0; i < data.xtargets.length && i < mkdru.sourceMax; i++ ) {
+    html += Drupal.theme('mkdruTerm', data.xtargets[i].name, data.xtargets[i].freq, 
+                          'mkdru-facet-source', data.xtargets[i].id);
+  }
+  $('.mkdru-facet-sources').html(html);
+
+  html = "";
+  for (var i = 0; i < data.subject.length && i < mkdru.subjectMax; i++ ) {
+    html += Drupal.theme('mkdruTerm', data.subject[i].name, data.subject[i].freq, 
+                          'mkdru-facet-subject', data.subject[i].id);
+  }
+  $('.mkdru-facet-subjects').html(html);
+
+  html = "";
+  for (var i = 0; i < data.author.length && i < mkdru.authorMax; i++ ) {
+    html += Drupal.theme('mkdruTerm', data.author[i].name, data.author[i].freq, 
+                          'mkdru-facet-author', data.author[i].id);
+  }
+  $('.mkdru-facet-authors').html(html);
+
+  $('.mkdru-facet-source').bind('click', function (e) {
+    mkdru.limitTarget(this.getAttribute('target_id'), this.firstChild.nodeValue);
+    return false;
+  });
+
+  $('.mkdru-facet-subject').bind('click', function (e) {
+    mkdru.limitQuery('su', this.firstChild.nodeValue);
+    return false;
+  });
+
+  $('.mkdru-facet-author').bind('click', function (e) {
+    mkdru.limitQuery('au', this.firstChild.nodeValue);
+    return false;
+  });
+};
+
+mkdru.pz2ByTarget = function (data) {
+  
+};
+
+mkdru.pz2Record = function (data) {
+  clearTimeout(mkdru.pz2.showTimer);
+  $('.mkdru-results').hide();
+  $('.mkdru-detail').html(Drupal.theme('mkdruDetail', data));
+  $('.mkdru-detail-back').bind('click', function () {$.bbq.removeState('recid');});
+  $('.mkdru-detail').show();
+  clearTimeout(mkdru.pz2.recordTimer);
+};
+
+
+
+// State and URL handling 
+
+// populate state from an object and fill in the blanks with defaults
+mkdru.stateFromObject = function (obj) {
+  for (var key in mkdru.defaultState) {
+    if (typeof(obj[key]) != "undefined") {
+      mkdru.state[key] = obj[key];
     }
-    $('#mkdru-sources').html(html);
+    else {
+      mkdru.state[key] = mkdru.defaultState[key];
+    }
+  }
+};
+
+// populate state from current window's hash string
+mkdru.stateFromHash = function () {
+  mkdru.stateFromObject($.deparam.fragment());
+};
 
-    html = "";
-    for (var i = 0; i < data.subject.length && i < mkdru.SubjectMax; i++ ) {
-      html += Drupal.theme('mkdruTerm', data.subject[i].name, data.subject[i].freq, 
-                           'mkdru-facet-link-subject', data.subject[i].id);
+// set current window's hash string from state
+mkdru.hashFromState = function () {
+  // only include non-default settings in the URL
+  var alteredState = {};
+  for (var key in mkdru.defaultState) {
+    if (mkdru.state[key] != mkdru.defaultState[key]) {
+      alteredState[key] = mkdru.state[key];
     }
-    $('#mkdru-subjects').html(html);
+  }
+  $.bbq.pushState(alteredState);
+};
 
-    html = "";
-    for (var i = 0; i < data.author.length && i < mkdru.AuthorMax; i++ ) {
-      html += Drupal.theme('mkdruTerm', data.author[i].name, data.author[i].freq, 
-                           'mkdru-facet-link-author', data.author[i].id);
+// update mkdru_form theme's ui to match state
+mkdru.uiFromState = function () {
+  for (var key in mkdru.state) {
+    switch(key) {
+    case 'query':
+      $('.mkdru-search input:text').attr('value', mkdru.state[key]);
+      break;
+    case 'perpage':
+      $('.mkdru-perpage').attr('value', mkdru.state[key]);
+      break;
+    case 'sort':
+      $('.mkdru-sort').attr('value', mkdru.state[key]);
+      break;
     }
-    $('#mkdru-authors').html(html);
+  }
 };
 
-mkdru.pz2ByTarget = function (data) {
-  
+mkdru.hashChange = function () {
+  var hash = $.deparam.fragment();
+  // Request for details
+  if (typeof(hash.recid) !== "undefined") {
+    mkdru.pz2.record(hash.recid);
+  }
+  // Other internal link
+  else {
+    mkdru.stateFromObject($.deparam.fragment());
+    mkdru.pz2.showPage(mkdru.state.page-1);
+    $('.mkdru-detail').hide();
+    $('.mkdru-results').show();
+  }
 };
 
 
 
 // UI functions:
 mkdru.submitQuery = function () {
+  mkdru.state.query = $('.mkdru-search input:text').attr('value');
+  mkdru.resetPage();
+  mkdru.pollDropDowns();
+  mkdru.hashFromState();
+  mkdru.search();
   mkdru.submitted = true;
-//   mkdru.resetPage();
-//   mkdru.pollDropDowns();
+  return false;
+};
+
+mkdru.triggerSearch = function () {
   mkdru.search();
+  mkdru.submitted = true;
 };
 
 mkdru.search = function () {
-  mkdru.pz2.search($('.mkdru-search input:text').attr('value'),
-                   mkdru.recPerPage, mkdru.curSort, mkdru.curFilter);
+  mkdru.pz2.search(mkdru.state.query, mkdru.state.perpage, mkdru.state.sort,
+      mkdru.state.filter);
 };
 
 mkdru.pollDropDowns = function () {
-  mkdru.recPerPage = $('#mkdru-perpage').value;
-  mkdru.curSort = $('#mkdru-sort').value;
+  mkdru.state.perpage = $('.mkdru-perpage').attr('value');
+  mkdru.state.sort = $('.mkdru-sort').attr('value');
   if (!mkdru.submitted) return false;
   mkdru.resetPage();
-  mkdru.pz2.show(0, mkdru.recPerPage, mkdru.curSort);
+  mkdru.hashFromState();
+  mkdru.pz2.show(0, mkdru.state.perpage, mkdru.state.sort);
+  return false;
 };
 
 mkdru.limitQuery = function (field, value) {
-  
+  $('.mkdru-search input:text').attr('value', function () {
+    return this.value += ' and ' + field + '="' + value + '"';
+  });
+  mkdru.submitQuery();
+};
+
+mkdru.limitTarget = function (id, name) {
+  var navi = document.getElementById('mkdru-navi');
+  navi.innerHTML = 
+        'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
+        + name + '</a>';
+  navi.innerHTML += '<hr/>';
+  mkdru.state.filter = 'pz:id=' + id;
+  mkdru.resetPage();
+  mkdru.pollDropDowns();
+  mkdru.search();
+  return false;
+};
+
+mkdru.generatePager = function () {
+  var total = Math.ceil(mkdru.totalRec / mkdru.state.perpage);
+  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;  
+  var prev = null;
+  var next = null;
+  var pages = [];
+
+  if ((mkdru.state.page - 1) >= first) {
+    prev = "#" + $.param.fragment($.param.fragment(
+               window.location.href, {page: mkdru.state.page - 1}))
+  }
+  if ((mkdru.state.page + 1) <= total) {
+    next = "#" + $.param.fragment($.param.fragment(
+               window.location.href, {page: mkdru.state.page + 1}))
+  }
+
+  for (var i = first; i <= last; i++) {
+    pages.push("#" + $.param.fragment($.param.fragment(
+               window.location.href, {page: i})));
+  }
+
+  return Drupal.theme('mkdruPager', pages, first, mkdru.state.page,
+                      total, prev, next);
 };
 
 mkdru.resetPage = function () {
-  mkdru.curPage = 1;
+  mkdru.state.page = 1;
   mkdru.totalRec = 0;
 };
 
 mkdru.showPage = function (pageNum) {
-  mkdru.curPage = pageNum;
+  mkdru.state.page = pageNum;
   mkdru.pz2.showPage(pageNum-1);
 };
 
-mkdru.nextPage = function () {
-  if (mkdru.totalRec - mkdru.recPerPage * mkdru.curPage > 0) {
-    mkdru.pz2.showNext();
-    mkdru.curPage++;
-  }
-};
-
-mkdru.prevPage = function () {
-  if (mkdru.pz2.showPrev() != false) {
-    mkdru.curPage--;
-  }
-};
 
 
 // wait until the DOM is ready, bind events
 // and instantiate pz2 library
 $(document).ready(function () {
-  $('.mkdru-search input:button').bind('click', mkdru.submitQuery);
+  $(window).bind( 'hashchange', mkdru.hashChange);
+  $('.mkdru-search').bind('submit', mkdru.submitQuery);
   $('.mkdru-search input:text').attr('value', '');
-  $('#mkdru-perpage').bind('change', function () { mkdru.pollDropDowns() });
-  $('#mkdru-sort').bind('change', function () { mkdru.pollDropDowns() });
+  $('.mkdru-perpage').bind('change', function () { mkdru.pollDropDowns() });
+  $('.mkdru-sort').bind('change', function () { mkdru.pollDropDowns() });
+
   mkdru.pz2 = new pz2( { "onshow": mkdru.pz2Show,
               "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
               "pazpar2path": mkdru.pazpar2path,
@@ -139,5 +290,22 @@ $(document).ready(function () {
               "onbytarget": mkdru.pz2ByTarget,
               "usesessions" : mkdru.usesessions,
               "showResponseType": mkdru.showResponseType,
-              "onrecord": mkdru.pz2Record } );
-});
\ No newline at end of file
+              "onrecord": mkdru.pz2Record,
+              "autoInit": false } );
+
+  // initialise state to hash string or defaults
+  mkdru.stateFromHash();
+  // and update UI to match
+  mkdru.uiFromState();
+
+  // ting thing
+  if (typeof(Drupal.settings.mkdru.query) !== "undefined") {
+    mkdru.state.query = Drupal.settings.mkdru.query
+  }
+
+  if (mkdru.usesessions) {
+    mkdru.pz2.init();
+  } else if (mkdru.state.query) {
+    mkdru.triggerSearch(); 
+  }
+});