mkdru.client.js

   1 // Set up namespace and some state.
   2 var mkdru = {
   3   // Settings to pass to pz2.js
   4   useSessions: Drupal.settings.mkdru.use_sessions === '1',
   5   // Variables
   6   active: false,
   7   pz2: null,
   8   totalRec: 0,
   9   pagerRange: 6,
  10   pazpar2Path: Drupal.settings.mkdru.pz2_path,
  11   facetContainerSelector: Drupal.settings.mkdru.facetContainerSelector,
  12   // Facets
  13   facets: {
  14     source: {
  15       displayName: Drupal.settings.mkdru.source_dname || "Source",
  16       orderWeight: Drupal.settings.mkdru.source_weight || 1,
  17       pz2Name: 'xtargets',
  18       max: Drupal.settings.mkdru.source_max || 10
  19     },
  20     subject: {
  21       displayName: Drupal.settings.mkdru.subject_dname || "Subject",
  22       orderWeight: Drupal.settings.mkdru.source_weight || 2,
  23       pz2Name: 'subject',
  24       max: Drupal.settings.mkdru.subject_max || 10,
  25       multiLimit: true,
  26       limiter: 'su'
  27     },
  28     author: {
  29       displayName: Drupal.settings.mkdru.author_dname || "Author",
  30       orderWeight: Drupal.settings.mkdru.source_weight || 3,
  31       pz2Name: 'author',
  32       max: Drupal.settings.mkdru.author_max || 10,
  33       multiLimit: false,
  34       limiter: 'au'
  35     }
  36   },
  37   // State; Keys limit_{facet key} will also be initialised
  38   defaultState: {
  39     page: 1,
  40     perpage: 20,
  41     sort: 'relevance',
  42     query:'',
  43     recid:null
  44   },
  45   state: {},
  46   realm: ''
  47 };
  48
  49
  50
  51 // Wrapper for jQuery
  52 (function ($) {
  53
  54 // So we can use jQuery BBQ with Drupal 6 and its 1.2.6 jQuery
  55 if (!$.isArray) $.isArray = function(obj) {
  56   return Object.prototype.toString.call(obj) === "[object Array]";
  57 };
  58
  59 // BBQ has no handy way to remove params without changing the hash.
  60 // This takes an object to add and an array of keys to delete.
  61 mkdru.hashAddDelMany = function (add, del) {
  62   var newHash = $.deparam.fragment();
  63   if (typeof(add) === 'object')
  64     $.extend(newHash, add);
  65   if ($.isArray(del))
  66     for (var i=0; i < del.length; i++)
  67       if (newHash[del[i]] !== 'undefined')
  68         delete newHash[del[i]];
  69   return $.param.fragment("#", newHash);
  70 }
  71
  72 // It's sometimes cumbersome that object literals can't take variable keys.
  73 mkdru.hashAddDelOne = function (key, value, del) {
  74   var toAdd;
  75   var toDel;
  76   if (key && value) {
  77     var toAdd = {};
  78     toAdd[key] = value;
  79   }
  80   if (del) {
  81     var toDel = [];
  82     toDel.push(del);
  83   }
  84   return mkdru.hashAddDelMany(toAdd, toDel);
  85 }
  86
  87
  88
  89 // pz2.js event handlers:
  90 mkdru.pz2Init = function () {
  91   if (mkdru.state.query) {
  92     mkdru.search();
  93   }
  94   mkdru.pz2.stat();
  95   //mkdru.pz2.bytarget();
  96 };
  97
  98 mkdru.pz2Show = function (data) {
  99   mkdru.totalRec = data.merged;
 100   $('.mkdru-pager').html(mkdru.generatePager());
 101   $('.mkdru-counts').html(Drupal.theme('mkdruCounts', data.start + 1,
 102                                       data.num, data.merged, data.total));
 103   var html = "";
 104   for (var i = 0; i < data.hits.length; i++) {
 105     html += Drupal.theme('mkdruResult', data.hits[i],
 106       i + 1 + mkdru.state.perpage * (mkdru.state.page - 1),
 107       "#" + $.param.fragment($.param.fragment(
 108         window.location.href, {recid: data.hits[i].recid})) + "\n"
 109     );
 110   }
 111   $('.mkdru-result-list').html(html);
 112   if (mkdru.state.recid) {
 113     mkdru.pz2.record(mkdru.state.recid);
 114   }
 115   else {
 116     $('.mkdru-results').show();
 117   }
 118 };
 119
 120 mkdru.pz2Status = function (data) {
 121   $('.mkdru-status').html(Drupal.theme('mkdruStatus', data.activeclients, data.clients));
 122 };
 123
 124 mkdru.contains = function (hash, key, value) {
 125   if (hash[key]) {
 126     if (hash[key].length) {
 127       for (var i=0; i<hash[key].length; i++) {
 128         if (hash[key][i] === value) {
 129           return true;
 130         }
 131       }
 132     } else {
 133       return hash[key] === value;
 134     }
 135   }
 136   return false;
 137 }
 138
 139 mkdru.pz2Term = function (data) {
 140   // if signaled, prepare container client-side
 141   if (mkdru.facetContainerSelector) {
 142     $(mkdru.facetContainerSelector).html(Drupal.theme('mkdruFacetContainer',
 143       data, mkdru.facets));
 144   }
 145   // map all facets against selected, for simple rendering
 146   var hash = $.deparam.fragment();
 147   for (var key in hash) {
 148     if (key.indexOf('limit') == 0 && hash[key])
 149       //always wrap in array
 150       hash[key.substr(6)] = hash[key].split(/;+/);
 151     delete hash[key];
 152   }
 153   for (var facet in mkdru.facets) {
 154     var terms = data[mkdru.facets[facet].pz2Name];
 155     for (var i=0; i<terms.length; i++) {
 156       var term = terms[i];
 157       var value = facet == "source" ? term.id : term.name;
 158       if (mkdru.contains(hash, facet, value)) { //enabled
 159         term.hashQuery = mkdru.removeLimit(facet, value);
 160         term.selected = true;
 161       } else { //disabled
 162         term.hashQuery = mkdru.addLimit(facet, value);
 163         term.selected = false;
 164       }
 165     }
 166     $('.mkdru-facet-' + facet).html(
 167         Drupal.theme('mkdruFacet', terms, facet, mkdru.facets[facet].max,
 168           hash[facet]));
 169   }
 170 };
 171
 172 mkdru.pz2ByTarget = function (data) {
 173
 174 };
 175
 176 mkdru.pz2Record = function (data) {
 177   clearTimeout(mkdru.pz2.showTimer);
 178   $('.mkdru-results').hide();
 179   $('.mkdru-detail').html(Drupal.theme('mkdruDetail', data,
 180                                        mkdru.hashAddDelOne(null, null, 'recid')));
 181   $('.mkdru-detail').show();
 182   clearTimeout(mkdru.pz2.recordTimer);
 183 };
 184
 185
 186
 187 // State and URL handling
 188
 189 // populate state from an object and fill in the blanks with defaults
 190 mkdru.stateFromObject = function (obj) {
 191   mkdru.state = $.extend({}, mkdru.defaultState);
 192   for (var key in mkdru.defaultState)
 193     if (typeof(obj[key]) != "undefined")
 194       mkdru.state[key] = obj[key];
 195 };
 196
 197 // populate state from current window's hash string
 198 mkdru.stateFromHash = function () {
 199   mkdru.stateFromObject($.deparam.fragment());
 200 };
 201
 202 // set current window's hash string from state
 203 mkdru.hashFromState = function () {
 204   // only include non-default settings in the URL
 205   var alteredState = {};
 206   for (var key in mkdru.defaultState) {
 207     if (mkdru.state[key] != mkdru.defaultState[key]) {
 208       alteredState[key] = mkdru.state[key];
 209     }
 210   }
 211   $.bbq.pushState(alteredState, 2);
 212 };
 213
 214 // update mkdru_form theme's ui to match state
 215 mkdru.uiFromState = function () {
 216   for (var key in mkdru.state) {
 217     switch(key) {
 218     case 'query':
 219       $('.mkdru-search input:text').attr('value', mkdru.state[key]);
 220       break;
 221     case 'perpage':
 222       $('.mkdru-perpage').attr('value', mkdru.state[key]);
 223       break;
 224     case 'sort':
 225       $('.mkdru-sort').attr('value', mkdru.state[key]);
 226       break;
 227     }
 228   }
 229 };
 230
 231 mkdru.hashChange = function () {
 232   // do we need to restart the search?
 233   var searchTrigger = false;
 234   // shallow copy of state so we can see what changed.
 235   var oldState = $.extend({}, mkdru.state);
 236   mkdru.stateFromHash();
 237   // only have to compare values since all keys are initialised
 238   for (key in mkdru.state) {
 239     var changed = (mkdru.state[key] != oldState[key]);
 240     if (key.substring(0,5) === 'limit' && changed)
 241       searchTrigger = true;
 242     if (key === 'page' && changed)
 243       mkdru.pz2.showPage(mkdru.state.page-1);
 244     if (key === 'query' && changed)
 245       searchTrigger = true;
 246   }
 247   if (searchTrigger)
 248     mkdru.search();
 249   // request for record detail
 250   if (mkdru.state.recid && (mkdru.state.recid != oldState.recid)) {
 251     mkdru.pz2.record(mkdru.state.recid);
 252   }
 253   else {
 254     $('.mkdru-detail').hide();
 255     $('.mkdru-results').show();
 256   }
 257 };
 258
 259 // return link to limit facet
 260 mkdru.addLimit = function (facet, limit) {
 261   var newHash = $.deparam.fragment();
 262   delete newHash['page'];
 263   if ((typeof(newHash['limit_' + facet]) === 'undefined')
 264        || !mkdru.facets[facet].multiLimit) {
 265     newHash['limit_' + facet] = limit;
 266   }
 267   else {
 268     newHash['limit_' + facet] += ';' + limit;
 269   }
 270   return $.param.fragment("#", newHash);
 271 };
 272
 273 // return link to remove limit from facet
 274 mkdru.removeLimit = function (facet, limit) {
 275   var newHash = $.deparam.fragment();
 276   delete newHash['page'];
 277   if (!newHash['limit_' + facet].indexOf(';')
 278       || !mkdru.facets[facet].multiLimit) {
 279     delete newHash['limit_' + facet];
 280   }
 281   else {
 282     var limits = newHash['limit_' + facet].split(';');
 283     for (var i = 0; i < limits.length; i++) {
 284       if (limits[i] == limit) {
 285         limits.splice(i, 1);
 286         if (limits.length < 1)
 287           delete newHash['limit_' + facet];
 288         else
 289           newHash['limit_' + facet] = limits.join(';');
 290         break;
 291       }
 292     }
 293   }
 294   return $.param.fragment("#", newHash);
 295 };
 296
 297
 298
 299 // form submit handler
 300 mkdru.submitQuery = function () {
 301   // new query, back to defaults (shallow copy)
 302   mkdru.state = $.extend({}, mkdru.defaultState);
 303   mkdru.state.query = $('.mkdru-search input:text').attr('value');
 304   mkdru.pollDropDowns();
 305   mkdru.hashFromState();
 306   mkdru.search();
 307   mkdru.active = true;
 308   return false;
 309 };
 310
 311 // criteria drop-down (perpage, sort) handler
 312 mkdru.submitCriteria = function () {
 313   mkdru.pollDropDowns();
 314   //search is not ON, do nothing
 315   if (!mkdru.active) return false;
 316   // pages mean different things now
 317   mkdru.state.page = 1;
 318   mkdru.hashFromState();
 319   mkdru.pz2.show(0, mkdru.state.perpage, mkdru.state.sort);
 320   return false;
 321 }
 322
 323 mkdru.search = function () {
 324   var filter = null;
 325   var query = mkdru.state.query;
 326
 327   // facet limit implementation
 328   for (var facet in mkdru.facets) {
 329     // facet is limited
 330     if (mkdru.state['limit_' + facet]) {
 331       if (facet == "source") {
 332         filter = 'pz:id=' + mkdru.state.limit_source;
 333       }
 334       else {
 335         var limits = mkdru.state['limit_' + facet].split(';');
 336         for (var i = 0; i < limits.length; i++) {
 337           // ex. query + and au="{limit_author}"
 338           query += ' and ' + mkdru.facets[facet]['limiter'] + '="'
 339                   + mkdru.state['limit_' + facet] + '"';
 340         }
 341       }
 342     }
 343   }
 344
 345   mkdru.pz2.search(query, mkdru.state.perpage, mkdru.state.sort, filter);
 346   mkdru.active = true;
 347 };
 348
 349 mkdru.pollDropDowns = function () {
 350   mkdru.state.perpage = $('.mkdru-perpage').attr('value');
 351   mkdru.state.sort = $('.mkdru-sort').attr('value');
 352 };
 353
 354 mkdru.generatePager = function () {
 355   // cast page parameter to numeric so we can add to it
 356   if (typeof mkdru.state.page == "string") {
 357     mkdru.state.page = Number(mkdru.state.page);
 358   }
 359   var total = Math.ceil(mkdru.totalRec / mkdru.state.perpage);
 360   var first = (mkdru.state.page - mkdru.pagerRange > 0)
 361       ? mkdru.state.page - mkdru.pagerRange : 1;
 362   var last = first + 2 * mkdru.pagerRange < total
 363       ? first + 2 * mkdru.pagerRange : total;
 364   var prev = null;
 365   var next = null;
 366   var pages = [];
 367
 368   if ((mkdru.state.page - 1) >= first) {
 369     prev = "#" + $.param.fragment($.param.fragment(
 370                window.location.href, {page: mkdru.state.page - 1}))
 371   }
 372   if ((mkdru.state.page + 1) <= total) {
 373     next = "#" + $.param.fragment($.param.fragment(
 374                window.location.href, {page: mkdru.state.page + 1}))
 375   }
 376
 377   for (var i = first; i <= last; i++) {
 378     pages.push("#" + $.param.fragment($.param.fragment(
 379                window.location.href, {page: i})));
 380   }
 381
 382   return Drupal.theme('mkdruPager', pages, first, mkdru.state.page,
 383                       total, prev, next);
 384 };
 385
 386
 387
 388 // wait until the DOM is ready, bind events
 389 // and instantiate pz2 library
 390 $(document).ready(function () {
 391   $(window).bind( 'hashchange', mkdru.hashChange);
 392   $('.mkdru-search').bind('submit', mkdru.submitQuery);
 393   $('.mkdru-search input:text').attr('value', '');
 394   $('.mkdru-perpage').bind('change', mkdru.submitCriteria);
 395   $('.mkdru-sort').bind('change', mkdru.submitCriteria);
 396
 397   // generate termlist for pz2.js and populate facet limit state
 398   var termlist = [];
 399   for (var key in mkdru.facets) {
 400     termlist.push(mkdru.facets[key].pz2Name);
 401     mkdru.defaultState['limit_' + key] = null;
 402   }
 403
 404   mkdru.pz2 = new pz2( { "onshow": mkdru.pz2Show,
 405               "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
 406               "pazpar2path": mkdru.pazpar2Path,
 407               "oninit": mkdru.pz2Init,
 408               "onstat": mkdru.pz2Status,
 409               "onterm": mkdru.pz2Term,
 410               "termlist": termlist.join(','),
 411               "onbytarget": mkdru.pz2ByTarget,
 412               "usesessions" : mkdru.useSessions,
 413               "showResponseType": mkdru.showResponseType,
 414               "onrecord": mkdru.pz2Record,
 415               "autoInit": false } );
 416
 417   // initialise state to hash string or defaults
 418   mkdru.stateFromHash();
 419   // and update UI to match
 420   mkdru.uiFromState();
 421
 422   // ting thing
 423   if (typeof(Drupal.settings.mkdru.query) !== "undefined") {
 424     mkdru.state.query = Drupal.settings.mkdru.query
 425     //force the hash to contain query
 426     mkdru.hashFromState();
 427   }
 428
 429   //not running against SP? init, otherwise authenticate
 430   if (mkdru.useSessions) {
 431     mkdru.pz2.init();
 432   } else {
 433     //runnin against SP
 434     var user = Drupal.settings.mkdru.sp_user;
 435     var pass = Drupal.settings.mkdru.sp_pass;
 436     var params = {};
 437     params['command'] = 'auth';
 438     if (user && pass) {
 439       params['action'] = 'login';
 440       params['username'] = user;
 441       params['password'] = pass;
 442     } else {
 443       params['action'] = 'ipauth';
 444     }
 445     var authReq = new pzHttpRequest(mkdru.pazpar2Path,
 446       function (err) {
 447         alert("Authentication against metasearch gateway failed: " +err);
 448       }
 449     );
 450     authReq.get(params,
 451       function (data) {
 452         var s = data.getElementsByTagName('status');
 453         if (s.length && Element_getTextContent(s[0]) == "OK") {
 454           mkdru.realm = data.getElementsByTagName('realm');
 455           mkdru.pz2Init();
 456         } else {
 457           alert("Malformed response when authenticating against the metasearch"
 458             + " gateway");
 459         }
 460       }
 461     );
 462   }
 463 });
 464 })(jQuery);