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