Refactor to avoid redundant calls
[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   //   showResponseType: 'json',
6   // Variables
7   submitted: false,
8   pz2: null,
9   totalRec: 0,
10   pagerRange: 6,
11   sourceMax: Drupal.settings.mkdru.source_max,
12   subjectMax: Drupal.settings.mkdru.subject_max,
13   authorMax: Drupal.settings.mkdru.author_max,
14   pazpar2Path: Drupal.settings.mkdru.pz2_path,
15   // State
16   defaultState: {
17     page: 1,
18     perpage: 20,
19     sort: 'relevance',
20     filter: null,
21     query:null,
22     recid:null
23   },
24   state: {}
25 };
26
27
28
29 // So we can use jQuery BBQ with Drupal 6 and its 1.2.6 jQuery
30 if (!$.isArray) $.isArray = function(obj) {
31   return Object.prototype.toString.call(obj) === "[object Array]";
32 },
33
34
35
36 // pz2.js event handlers:
37 mkdru.pz2Init = function () {
38   if (mkdru.state.query) {
39     mkdru.search();
40   }
41   //mkdru.pz2.stat();
42   //mkdru.pz2.bytarget();
43 };
44
45 mkdru.pz2Show = function (data) {
46   mkdru.totalRec = data.merged;
47   $('.mkdru-pager').html(mkdru.generatePager());
48   var countsHtml = Drupal.t('Displaying: ') + (data.start + 1) + 
49     Drupal.t(' to ') + (data.start + data.num) + Drupal.t(' of ')
50     + data.merged + Drupal.t(' (found: ') + data.total + ')';
51   $('.mkdru-counts').html(countsHtml);
52
53   var html = "";
54   for (var i = 0; i < data.hits.length; i++) {
55     html += Drupal.theme('mkdruResult', data.hits[i], 
56       i + 1 + mkdru.state.perpage * (mkdru.state.page - 1),
57       "#" + $.param.fragment($.param.fragment(
58         window.location.href, {recid: data.hits[i].recid})) + "\n"
59     );
60   }
61   $('.mkdru-result-list').html(html);
62   if (mkdru.state.recid) {
63     mkdru.pz2.record(mkdru.state.recid);
64   }
65   else {
66     $('.mkdru-results').show();
67   }
68 };
69
70 mkdru.pz2Status = function (data) {
71 };
72
73 mkdru.pz2Term = function (data) {
74   var html = "";
75   for (var i = 0; i < data.xtargets.length && i < mkdru.sourceMax; i++ ) {
76     html += Drupal.theme('mkdruTerm', data.xtargets[i].name, data.xtargets[i].freq, 
77                           'mkdru-facet-source', data.xtargets[i].id);
78   }
79   $('.mkdru-facet-sources').html(html);
80
81   html = "";
82   for (var i = 0; i < data.subject.length && i < mkdru.subjectMax; i++ ) {
83     html += Drupal.theme('mkdruTerm', data.subject[i].name, data.subject[i].freq, 
84                           'mkdru-facet-subject', data.subject[i].id);
85   }
86   $('.mkdru-facet-subjects').html(html);
87
88   html = "";
89   for (var i = 0; i < data.author.length && i < mkdru.authorMax; i++ ) {
90     html += Drupal.theme('mkdruTerm', data.author[i].name, data.author[i].freq, 
91                           'mkdru-facet-author', data.author[i].id);
92   }
93   $('.mkdru-facet-authors').html(html);
94
95   $('.mkdru-facet-source').bind('click', function (e) {
96     mkdru.limitTarget(this.getAttribute('target_id'), this.firstChild.nodeValue);
97     return false;
98   });
99
100   $('.mkdru-facet-subject').bind('click', function (e) {
101     mkdru.limitQuery('su', this.firstChild.nodeValue);
102     return false;
103   });
104
105   $('.mkdru-facet-author').bind('click', function (e) {
106     mkdru.limitQuery('au', this.firstChild.nodeValue);
107     return false;
108   });
109 };
110
111 mkdru.pz2ByTarget = function (data) {
112   
113 };
114
115 mkdru.pz2Record = function (data) {
116   clearTimeout(mkdru.pz2.showTimer);
117   $('.mkdru-results').hide();
118   $('.mkdru-detail').html(Drupal.theme('mkdruDetail', data));
119   $('.mkdru-detail-back').bind('click', function () {$.bbq.removeState('recid');});
120   $('.mkdru-detail').show();
121   clearTimeout(mkdru.pz2.recordTimer);
122 };
123
124
125
126 // State and URL handling 
127
128 // populate state from an object and fill in the blanks with defaults
129 mkdru.stateFromObject = function (obj) {
130   for (var key in mkdru.defaultState) {
131     if (typeof(obj[key]) != "undefined") {
132       mkdru.state[key] = obj[key];
133     }
134     else {
135       mkdru.state[key] = mkdru.defaultState[key];
136     }
137   }
138 };
139
140 // populate state from current window's hash string
141 mkdru.stateFromHash = function () {
142   mkdru.stateFromObject($.deparam.fragment());
143 };
144
145 // set current window's hash string from state
146 mkdru.hashFromState = function () {
147   // only include non-default settings in the URL
148   var alteredState = {};
149   for (var key in mkdru.defaultState) {
150     if (mkdru.state[key] != mkdru.defaultState[key]) {
151       alteredState[key] = mkdru.state[key];
152     }
153   }
154   $.bbq.pushState(alteredState);
155 };
156
157 // update mkdru_form theme's ui to match state
158 mkdru.uiFromState = function () {
159   for (var key in mkdru.state) {
160     switch(key) {
161     case 'query':
162       $('.mkdru-search input:text').attr('value', mkdru.state[key]);
163       break;
164     case 'perpage':
165       $('.mkdru-perpage').attr('value', mkdru.state[key]);
166       break;
167     case 'sort':
168       $('.mkdru-sort').attr('value', mkdru.state[key]);
169       break;
170     }
171   }
172 };
173
174 mkdru.hashChange = function () {
175   mkdru.stateFromHash();
176   // Request for details
177   if (mkdru.state.recid) {
178     mkdru.pz2.record(mkdru.state.recid);
179   }
180   // Other internal link
181   else {
182     mkdru.pz2.showPage(mkdru.state.page-1);
183     $('.mkdru-detail').hide();
184     $('.mkdru-results').show();
185   }
186 };
187
188
189
190 //search bo handler ONLY
191 mkdru.submitQuery = function () {
192   mkdru.state.query = $('.mkdru-search input:text').attr('value');
193   mkdru.pollDropDowns();
194   mkdru.resetPage();
195   mkdru.hashFromState();
196   mkdru.search();
197   mkdru.submitted = true;
198   return false;
199 };
200
201 //criteria drop-downs (perpage,sort) handler ONLY
202 mkdru.submitCriteria = function () {
203   mkdru.pollDropDowns();
204   //search is not ON, do nothing
205   if (!mkdru.submitted) return false;
206   mkdru.resetPage();
207   mkdru.hashFromState();
208   mkdru.pz2.show(0, mkdru.state.perpage, mkdru.state.sort);
209   return false;
210 }
211
212 mkdru.search = function () {
213   mkdru.pz2.search(mkdru.state.query, mkdru.state.perpage, mkdru.state.sort,
214       mkdru.state.filter);
215   //inform others that the search is ON
216   mkdru.submitted = true;
217 };
218
219 mkdru.pollDropDowns = function () {
220   mkdru.state.perpage = $('.mkdru-perpage').attr('value');
221   mkdru.state.sort = $('.mkdru-sort').attr('value');
222 };
223
224 //TODO it's rude to mess with user's query, we should have a breadcrumb
225 mkdru.limitQuery = function (field, value) {
226   $('.mkdru-search input:text').attr('value', function () {
227     return this.value += ' and ' + field + '="' + value + '"';
228   });
229   mkdru.submitQuery();
230 };
231
232 mkdru.limitTarget = function (id, name) {
233   var navi = document.getElementById('mkdru-navi');
234   navi.innerHTML = 
235         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
236         + name + '</a>';
237   navi.innerHTML += '<hr/>';
238   mkdru.state.filter = 'pz:id=' + id;
239   mkdru.pollDropDowns();
240   mkdru.resetPage();
241   mkdru.hashFromState();
242   mkdru.search();
243   return false;
244 };
245
246 mkdru.generatePager = function () {
247  // make sure page param is a number, otherwise pageing frwd will be broken
248   if (typeof mkdru.state.page == "string") {
249     mkdru.state.page = Number(mkdru.state.page);
250   }
251   var total = Math.ceil(mkdru.totalRec / mkdru.state.perpage);
252   var first = (mkdru.state.page - mkdru.pagerRange > 0)
253       ? mkdru.state.page - mkdru.pagerRange : 1;
254   var last = first + 2 * mkdru.pagerRange < total
255       ? first + 2 * mkdru.pagerRange : total;  
256   var prev = null;
257   var next = null;
258   var pages = [];
259
260   if ((mkdru.state.page - 1) >= first) {
261     prev = "#" + $.param.fragment($.param.fragment(
262                window.location.href, {page: mkdru.state.page - 1}))
263   }
264   if ((mkdru.state.page + 1) <= total) {
265     next = "#" + $.param.fragment($.param.fragment(
266                window.location.href, {page: mkdru.state.page + 1}))
267   }
268
269   for (var i = first; i <= last; i++) {
270     pages.push("#" + $.param.fragment($.param.fragment(
271                window.location.href, {page: i})));
272   }
273
274   return Drupal.theme('mkdruPager', pages, first, mkdru.state.page,
275                       total, prev, next);
276 };
277
278 mkdru.resetPage = function () {
279   mkdru.state.page = 1;
280   mkdru.totalRec = 0;
281 };
282
283
284
285 // wait until the DOM is ready, bind events
286 // and instantiate pz2 library
287 $(document).ready(function () {
288   $(window).bind( 'hashchange', mkdru.hashChange);
289   $('.mkdru-search').bind('submit', mkdru.submitQuery);
290   $('.mkdru-search input:text').attr('value', '');
291   $('.mkdru-perpage').bind('change', mkdru.submitCriteria);
292   $('.mkdru-sort').bind('change', mkdru.submitCriteria);
293
294   mkdru.pz2 = new pz2( { "onshow": mkdru.pz2Show,
295               "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
296               "pazpar2path": mkdru.pazpar2path,
297               "oninit": mkdru.pz2Init,
298               "onstat": mkdru.pz2Status,
299               "onterm": mkdru.pz2Term,
300               "termlist": "xtargets,subject,author",
301               "onbytarget": mkdru.pz2ByTarget,
302               "usesessions" : mkdru.usesessions,
303               "showResponseType": mkdru.showResponseType,
304               "onrecord": mkdru.pz2Record,
305               "autoInit": false } );
306
307   // initialise state to hash string or defaults
308   mkdru.stateFromHash();
309   // and update UI to match
310   mkdru.uiFromState();
311
312   // ting thing
313   if (typeof(Drupal.settings.mkdru.query) !== "undefined") {
314     mkdru.state.query = Drupal.settings.mkdru.query
315   }
316
317   if (mkdru.usesessions) {
318     mkdru.pz2.init();
319   }
320   else if (mkdru.state.recid) {
321     mkdru.pz2.record(mkdru.state.recid);
322   }
323   else if (mkdru.state.query) {
324     mkdru.search();
325   }
326 });