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