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