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) //always wrap in array
 149       hash[key.substr(6)] = hash[key].split(';');
 150     delete hash[key];
 151   }
 152   for (var facet in mkdru.facets) {
 153     var terms = data[mkdru.facets[facet].pz2Name];
 154     for (var i=0; i<terms.length; i++) {
 155       var term = terms[i];
 156       var value = facet == "source" ? term.id : term.name;
 157       if (mkdru.contains(hash, facet, value)) { //enabled
 158         term.hashQuery = mkdru.removeLimit(facet, value);
 159         term.selected = true;
 160       } else { //disabled
 161         term.hashQuery = mkdru.addLimit(facet, value);
 162         term.selected = false;
 163       }
 164     }
 165     $('.mkdru-facet-' + facet).html(
 166         Drupal.theme('mkdruFacet', terms, facet, mkdru.facets[facet].max, hash));
 167   }
 168 };
 169
 170 mkdru.pz2ByTarget = function (data) {
 171
 172 };
 173
 174 mkdru.pz2Record = function (data) {
 175   clearTimeout(mkdru.pz2.showTimer);
 176   $('.mkdru-results').hide();
 177   $('.mkdru-detail').html(Drupal.theme('mkdruDetail', data,
 178                                        mkdru.hashAddDelOne(null, null, 'recid')));
 179   $('.mkdru-detail').show();
 180   clearTimeout(mkdru.pz2.recordTimer);
 181 };
 182
 183
 184
 185 // State and URL handling
 186
 187 // populate state from an object and fill in the blanks with defaults
 188 mkdru.stateFromObject = function (obj) {
 189   mkdru.state = $.extend({}, mkdru.defaultState);
 190   for (var key in mkdru.defaultState)
 191     if (typeof(obj[key]) != "undefined")
 192       mkdru.state[key] = obj[key];
 193 };
 194
 195 // populate state from current window's hash string
 196 mkdru.stateFromHash = function () {
 197   mkdru.stateFromObject($.deparam.fragment());
 198 };
 199
 200 // set current window's hash string from state
 201 mkdru.hashFromState = function () {
 202   // only include non-default settings in the URL
 203   var alteredState = {};
 204   for (var key in mkdru.defaultState) {
 205     if (mkdru.state[key] != mkdru.defaultState[key]) {
 206       alteredState[key] = mkdru.state[key];
 207     }
 208   }
 209   $.bbq.pushState(alteredState, 2);
 210 };
 211
 212 // update mkdru_form theme's ui to match state
 213 mkdru.uiFromState = function () {
 214   for (var key in mkdru.state) {
 215     switch(key) {
 216     case 'query':
 217       $('.mkdru-search input:text').attr('value', mkdru.state[key]);
 218       break;
 219     case 'perpage':
 220       $('.mkdru-perpage').attr('value', mkdru.state[key]);
 221       break;
 222     case 'sort':
 223       $('.mkdru-sort').attr('value', mkdru.state[key]);
 224       break;
 225     }
 226   }
 227 };
 228
 229 mkdru.hashChange = function () {
 230   // do we need to restart the search?
 231   var searchTrigger = false;
 232   // shallow copy of state so we can see what changed.
 233   var oldState = $.extend({}, mkdru.state);
 234   mkdru.stateFromHash();
 235   // only have to compare values since all keys are initialised
 236   for (key in mkdru.state) {
 237     var changed = (mkdru.state[key] != oldState[key]);
 238     if (key.substring(0,5) === 'limit' && changed)
 239       searchTrigger = true;
 240     if (key === 'page' && changed)
 241       mkdru.pz2.showPage(mkdru.state.page-1);
 242     if (key === 'query' && changed)
 243       searchTrigger = true;
 244   }
 245   if (searchTrigger)
 246     mkdru.search();
 247   // request for record detail
 248   if (mkdru.state.recid && (mkdru.state.recid != oldState.recid)) {
 249     mkdru.pz2.record(mkdru.state.recid);
 250   }
 251   else {
 252     $('.mkdru-detail').hide();
 253     $('.mkdru-results').show();
 254   }
 255 };
 256
 257 // return link to limit facet
 258 mkdru.addLimit = function (facet, limit) {
 259   var newHash = $.deparam.fragment();
 260   delete newHash['page'];
 261   if ((typeof(newHash['limit_' + facet]) === 'undefined')
 262        || !mkdru.facets[facet].multiLimit) {
 263     newHash['limit_' + facet] = limit;
 264   }
 265   else {
 266     newHash['limit_' + facet] += ';' + limit;
 267   }
 268   return $.param.fragment("#", newHash);
 269 };
 270
 271 // return link to remove limit from facet
 272 mkdru.removeLimit = function (facet, limit) {
 273   var newHash = $.deparam.fragment();
 274   delete newHash['page'];
 275   if (!newHash['limit_' + facet].indexOf(';')
 276       || !mkdru.facets[facet].multiLimit) {
 277     delete newHash['limit_' + facet];
 278   }
 279   else {
 280     var limits = newHash['limit_' + facet].split(';');
 281     for (var i = 0; i < limits.length; i++) {
 282       if (limits[i] == limit) {
 283         limits.splice(i, 1);
 284         if (limits.length < 1)
 285           delete newHash['limit_' + facet];
 286         else
 287           newHash['limit_' + facet] = limits.join(';');
 288         break;
 289       }
 290     }
 291   }
 292   return $.param.fragment("#", newHash);
 293 };
 294
 295
 296
 297 // form submit handler
 298 mkdru.submitQuery = function () {
 299   // new query, back to defaults (shallow copy)
 300   mkdru.state = $.extend({}, mkdru.defaultState);
 301   mkdru.state.query = $('.mkdru-search input:text').attr('value');
 302   mkdru.pollDropDowns();
 303   mkdru.hashFromState();
 304   mkdru.search();
 305   mkdru.active = true;
 306   return false;
 307 };
 308
 309 // criteria drop-down (perpage, sort) handler
 310 mkdru.submitCriteria = function () {
 311   mkdru.pollDropDowns();
 312   //search is not ON, do nothing
 313   if (!mkdru.active) return false;
 314   // pages mean different things now
 315   mkdru.state.page = 1;
 316   mkdru.hashFromState();
 317   mkdru.pz2.show(0, mkdru.state.perpage, mkdru.state.sort);
 318   return false;
 319 }
 320
 321 mkdru.search = function () {
 322   var filter = null;
 323   var query = mkdru.state.query;
 324
 325   // facet limit implementation
 326   for (var facet in mkdru.facets) {
 327     // facet is limited
 328     if (mkdru.state['limit_' + facet]) {
 329       if (facet == "source") {
 330         filter = 'pz:id=' + mkdru.state.limit_source;
 331       }
 332       else {
 333         var limits = mkdru.state['limit_' + facet].split(';');
 334         for (var i = 0; i < limits.length; i++) {
 335           // ex. query + and au="{limit_author}"
 336           query += ' and ' + mkdru.facets[facet]['limiter'] + '="'
 337                   + mkdru.state['limit_' + facet] + '"';
 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   mkdru.pz2 = new pz2( { "onshow": mkdru.pz2Show,
 403               "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
 404               "pazpar2path": mkdru.pazpar2Path,
 405               "oninit": mkdru.pz2Init,
 406               "onstat": mkdru.pz2Status,
 407               "onterm": mkdru.pz2Term,
 408               "termlist": termlist.join(','),
 409               "onbytarget": mkdru.pz2ByTarget,
 410               "usesessions" : mkdru.useSessions,
 411               "showResponseType": mkdru.showResponseType,
 412               "onrecord": mkdru.pz2Record,
 413               "autoInit": false } );
 414
 415   // initialise state to hash string or defaults
 416   mkdru.stateFromHash();
 417   // and update UI to match
 418   mkdru.uiFromState();
 419
 420   // ting thing
 421   if (typeof(Drupal.settings.mkdru.query) !== "undefined") {
 422     mkdru.state.query = Drupal.settings.mkdru.query
 423     //force the hash to contain query
 424     mkdru.hashFromState();
 425   }
 426
 427   //not running against SP? init, otherwise authenticate
 428   if (mkdru.useSessions) {
 429     mkdru.pz2.init();
 430   } else {
 431     //runnin against SP
 432     var user = Drupal.settings.mkdru.sp_user;
 433     var pass = Drupal.settings.mkdru.sp_pass;
 434     var params = {};
 435     params['command'] = 'auth';
 436     if (user && pass) {
 437       params['action'] = 'login';
 438       params['username'] = user;
 439       params['password'] = pass;
 440     } else {
 441       params['action'] = 'ipauth';
 442     }
 443     var authReq = new pzHttpRequest(mkdru.pazpar2Path,
 444       function (err) {
 445         alert("Authentication against metasearch gateway failed: " +err);
 446       }
 447     );
 448     authReq.get(params,
 449       function (data) {
 450         var s = data.getElementsByTagName('status');
 451         if (s.length && Element_getTextContent(s[0]) == "OK") {
 452           mkdru.realm = data.getElementsByTagName('realm');
 453           mkdru.pz2Init();
 454         } else {
 455           alert("Malformed response when authenticating against the metasearch"
 456             + " gateway");
 457         }
 458       }
 459     );
 460   }
 461 });
 462 })(jQuery);