Added method to set iPhone App mode
[pazpar2-moved-to-github.git] / www / iphone / example_client.js
1 /* A very simple client that shows a basic usage of the pz2.js
2 */
3
4 // create a parameters array and pass it to the pz2's constructor
5 // then register the form submit event with the pz2.search function
6 // autoInit is set to true on default
7 var usesessions = true;
8 var pazpar2path = '/pazpar2/search.pz2';
9 var showResponseType = '';
10 if (document.location.hash == '#useproxy') {
11     usesessions = false;
12     pazpar2path = '/service-proxy/';
13     showResponseType = 'json';
14 }
15
16 my_paz = new pz2( { "onshow": my_onshow,
17                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
18                     "pazpar2path": pazpar2path,
19                     "oninit": my_oninit,
20                     "onstat": my_onstat,
21                     "onterm": my_onterm_iphone,
22                     "termlist": "xtargets,subject,author",
23                     "onbytarget": my_onbytarget,
24                             "usesessions" : usesessions,
25                     "showResponseType": showResponseType,
26                     "onrecord": my_onrecord } );
27 // some state vars
28 var curPage = 1;
29 var recPerPage = 20;
30 var totalRec = 0;
31 var curDetRecId = '';
32 var curDetRecData = null;
33 var curSort = 'relevance';
34 var curFilter = null;
35 var submitted = false;
36 var SourceMax = 16;
37 var SubjectMax = 10;
38 var AuthorMax = 10;
39 var tab = "recordview"; 
40
41
42 //
43 // pz2.js event handlers:
44 //
45 function my_oninit() {
46     my_paz.stat();
47     my_paz.bytarget();
48 }
49
50 function my_onshow(data) {
51     totalRec = data.merged;
52     // move it out
53     var pager = document.getElementById("pager");
54     pager.innerHTML = "";
55     pager.innerHTML +='<hr/><div style="float: right">Displaying: ' 
56                     + (data.start + 1) + ' to ' + (data.start + data.num) +
57                      ' of ' + data.merged + ' (found: ' 
58                      + data.total + ')</div>';
59     drawPager(pager);
60     // navi
61     var results = document.getElementById("results");
62   
63     var html = [];
64     for (var i = 0; i < data.hits.length; i++) {
65         var hit = data.hits[i];
66               html.push('<li id="recdiv_'+hit.recid+'" >'
67            /* +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>' */
68             +'<a href="#" id="rec_'+hit.recid
69             +'" onclick="showDetails(this.id);return false;">' 
70             + hit["md-title"] +'</a> '); 
71               if (hit["md-title-responsibility"] !== undefined) {
72             html.push('<a href="#">'+hit["md-title-responsibility"]+'</a> ');
73               if (hit["md-title-remainder"] !== undefined) {
74                 html.push('<a href="#">' + hit["md-title-remainder"] + ' </a> ');
75               }
76         }
77         if (hit.recid == curDetRecId) {
78             html.push(renderDetails(curDetRecData));
79         }
80         html.push('</div>');
81     }
82     replaceHtml(results, html.join(''));
83 }
84
85 function my_onstat(data) {
86     var stat = document.getElementById("stat");
87     if (stat == null)
88         return;
89     
90     stat.innerHTML = '<b> .:STATUS INFO</b> -- Active clients: '
91                         + data.activeclients
92                         + '/' + data.clients + ' -- </span>'
93                         + '<span>Retrieved records: ' + data.records
94                         + '/' + data.hits + ' :.</span>';
95 }
96
97 function showhide(newtab) {
98         var showtermlist = false;
99         if (newtab != null)
100                 tab = newtab;
101
102         if (tab == "recordview") {
103                 document.getElementById("recordview").style.display = '';
104         }
105         else 
106                 document.getElementById("recordview").style.display = 'none';
107
108         if (tab == "xtargets") {
109                 document.getElementById("term_xtargets").style.display = '';
110                 showtermlist = true;
111         }
112         else
113                 document.getElementById("term_xtargets").style.display = 'none';
114         if (tab == "subjects") {
115                 document.getElementById("term_subjects").style.display = '';
116                 showtermlist = true;
117         }
118         else
119                 document.getElementById("term_subjects").style.display = 'none';
120         if (tab == "authors") {
121                 document.getElementById("term_authors").style.display = '';
122                 showtermlist = true;
123         }
124         else
125                 document.getElementById("term_authors").style.display = 'none';
126
127         if (showtermlist == false) 
128                 document.getElementById("termlist").style.display = 'none';
129         else 
130                 document.getElementById("termlist").style.display = '';
131 }
132
133 function my_onterm(data) {
134     var termlists = [];
135     
136     termlists.push('<div id="term_xtargets" >');
137     termlists.push('<div class="termtitle">.::Sources</div>');
138     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
139         termlists.push('<a href="#" target_id='+data.xtargets[i].id
140             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name 
141         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
142     }
143     termlists.push('</div>');
144      
145     termlists.push('<div id="term_subjects" >');
146     termlists.push('<div id="subjects" class="termtitle">.::Subjects</div>');
147     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
148         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  (' 
149               + data.subject[i].freq + ')</span><br/>');
150     }
151     termlists.push('</div>');
152             
153     termlists.push('<div id="term_authors" >');
154     termlists.push('<div class="termtitle">.::Authors</div>');
155     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
156         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">' 
157                             + data.author[i].name 
158                             + ' </a><span> (' 
159                             + data.author[i].freq 
160                             + ')</span><br/>');
161     }
162     termlists.push('</div>');
163     var termlist = document.getElementById("termlist");
164     replaceHtml(termlist, termlists.join(''));
165     var d;
166 /*
167     for (d in ("xtargets", "subjects", "authors")) {
168         alert(d);
169         if (tab == d)
170                 document.getElementById("term_" + d).style.display = '';
171         else 
172                 document.getElementById("term_" +d ).style.display = 'none';
173     }
174 */
175     showhide();
176 }
177
178 function serialize(array) {
179         var t = typeof (obj);
180         if (t != "object" || obj === null) {
181                 // simple data type
182                 return String(obj);
183         } else {
184                 // recurse array or object
185                 var n, v, json = [], arr = (obj && obj.constructor == Array);
186                 for (n in obj) {
187                         v = obj[n];
188                         t = typeof (v);
189                         if (t == "string")
190                                 v = '"' + v + '"';
191                         else if (t == "object" && v !== null)
192                                 v = JSON.stringify(v);
193                         json.push((arr ? "" : '"' + n + '":') + String(v));
194                 }
195                 return (arr ? "" : "") + String(json) + (arr ? "]" : "}");
196         }
197 }
198
199 var termlist = {};
200 function my_onterm_iphone(data) {
201     my_onterm(data);
202     var targets = "";
203     for (var i = 0; i < data.xtargets.length; i++ ) {
204         
205         targets = targets + data.xtargets[i].id + "|" + data.xtargets[i].name + "|" + data.xtargets[i].freq + "\n";
206     }
207     termlist["xtargets"] = targets;
208     var subjects = "";
209     for (var i = 0; i < data.subject.length; i++ ) {
210         subjects = subjects + "-" + "|" + data.subject[i].name + "|" + data.subject[i].freq + "\n";
211     }
212     termlist["subjects"] = subjects;
213     var authors = "";
214     for (var i = 0; i < data.author.length; i++ ) {
215         authors = authors + "-" + "|" + data.author[i].name + "|" + data.author[i].freq + "\n";
216     }
217     termlist["authors"] = authors;
218     //document.getElementById("log").innerHTML = targets + "\n" + subjects + "\n" + authors;
219     callback.send("termlist", "refresh");
220 }
221
222 function getTargets() {
223         return termlist['xtargets'];
224 }
225
226 function getSubjects() {
227         return termlist['subjects'];
228 }
229
230 function getAuthors() {
231         return termlist['authors'];
232 }
233
234 function my_onrecord(data) {
235     // FIXME: record is async!!
236     clearTimeout(my_paz.recordTimer);
237     // in case on_show was faster to redraw element
238     var detRecordDiv = document.getElementById('det_'+data.recid);
239     if (detRecordDiv) return;
240     curDetRecData = data;
241     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
242     var html = renderDetails(curDetRecData);
243     recordDiv.innerHTML += html;
244 }
245
246 function my_onrecord_iphone(data) {
247     my_onrecord(data);
248     callback.send("record", data.recid, data, data.xtargets[i].freq);
249 }
250
251
252 function my_onbytarget(data) {
253     var targetDiv = document.getElementById("bytarget");
254     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
255         +'<td>Records</td><td>State</td></tr></thead><tbody>';
256     
257     for (var i = 0; i < data.length; i++ ) {
258         table += "<tr><td>" + data[i].id +
259             "</td><td>" + data[i].hits +
260             "</td><td>" + data[i].diagnostic +
261             "</td><td>" + data[i].records +
262             "</td><td>" + data[i].state + "</td></tr>";
263     }
264
265     table += '</tbody></table>';
266     targetDiv.innerHTML = table;
267 }
268
269 ////////////////////////////////////////////////////////////////////////////////
270 ////////////////////////////////////////////////////////////////////////////////
271
272 // wait until the DOM is ready
273 function domReady () 
274
275     document.search.onsubmit = onFormSubmitEventHandler;
276     document.search.query.value = '';
277     document.select.sort.onchange = onSelectDdChange;
278     document.select.perpage.onchange = onSelectDdChange;
279     applicationMode(true);
280 }
281  
282 function applicationMode(newmode) 
283 {
284         var searchdiv = document.getElementById("searchForm");
285         if (newmode)
286                 inApp = newmode;
287         if (inApp) {
288         document.getElementById("heading").style.display="none";
289                 searchdiv.style.display = 'none';
290         }
291         else { 
292                 searchdiv.style.display = '';
293                 document.search.onsubmit = onFormSubmit;
294         }
295         callback.init();
296 }
297 // when search button pressed
298 function onFormSubmitEventHandler() 
299 {
300     resetPage();
301     loadSelect();
302     triggerSearch();
303     submitted = true;
304     return false;
305 }
306
307 function onSelectDdChange()
308 {
309     if (!submitted) return false;
310     resetPage();
311     loadSelect();
312     my_paz.show(0, recPerPage, curSort);
313     return false;
314 }
315
316 function resetPage()
317 {
318     curPage = 1;
319     totalRec = 0;
320 }
321
322 function triggerSearch ()
323 {
324     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
325 }
326
327 function loadSelect ()
328 {
329     curSort = document.select.sort.value;
330     recPerPage = document.select.perpage.value;
331 }
332
333 // limit the query after clicking the facet
334 function limitQuery (field, value)
335 {
336     document.search.query.value += ' and ' + field + '="' + value + '"';
337     onFormSubmitEventHandler();
338     showhide("recordview");
339 }
340
341 // limit by target functions
342 function limitTarget (id, name)
343 {
344     var navi = document.getElementById('navi');
345     navi.innerHTML = 
346         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
347         + name + '</a>';
348     navi.innerHTML += '<hr/>';
349     curFilter = 'pz:id=' + id;
350     resetPage();
351     loadSelect();
352     triggerSearch();
353     showhide("recordview");
354     return false;
355 }
356
357 function delimitTarget ()
358 {
359     var navi = document.getElementById('navi');
360     navi.innerHTML = '';
361     curFilter = null; 
362     resetPage();
363     loadSelect();
364     triggerSearch();
365     return false;
366 }
367
368 function drawPager (pagerDiv)
369 {
370     //client indexes pages from 1 but pz2 from 0
371     var onsides = 6;
372     var pages = Math.ceil(totalRec / recPerPage);
373     
374     var firstClkbl = ( curPage - onsides > 0 ) 
375         ? curPage - onsides
376         : 1;
377
378     var lastClkbl = firstClkbl + 2*onsides < pages
379         ? firstClkbl + 2*onsides
380         : pages;
381
382     var prev = '<span id="prev">&#60;&#60; Prev</span><b> | </b>';
383     if (curPage > 1)
384         var prev = '<a href="#" id="prev" onclick="pagerPrev();">'
385         +'&#60;&#60; Prev</a><b> | </b>';
386
387     var middle = '';
388     for(var i = firstClkbl; i <= lastClkbl; i++) {
389         var numLabel = i;
390         if(i == curPage)
391             numLabel = '<b>' + i + '</b>';
392
393         middle += '<a href="#" onclick="showPage(' + i + ')"> '
394             + numLabel + ' </a>';
395     }
396     
397     var next = '<b> | </b><span id="next">Next &#62;&#62;</span>';
398     if (pages - curPage > 0)
399     var next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
400         +'Next &#62;&#62;</a>';
401
402     predots = '';
403     if (firstClkbl > 1)
404         predots = '...';
405
406     postdots = '';
407     if (lastClkbl < pages)
408         postdots = '...';
409
410     pagerDiv.innerHTML += '<div style="float: clear">' 
411         + prev + predots + middle + postdots + next + '</div><hr/>';
412 }
413
414 function showPage (pageNum)
415 {
416     curPage = pageNum;
417     my_paz.showPage( curPage - 1 );
418 }
419
420 // simple paging functions
421
422 function pagerNext() {
423     if ( totalRec - recPerPage*curPage > 0) {
424         my_paz.showNext();
425         curPage++;
426     }
427 }
428
429 function pagerPrev() {
430     if ( my_paz.showPrev() != false )
431         curPage--;
432 }
433
434 // swithing view between targets and records
435
436 function switchView(view) {
437     
438     var targets = document.getElementById('targetview');
439     var records = document.getElementById('recordview');
440     
441     switch(view) {
442         case 'targetview':
443             targets.style.display = "block";            
444             records.style.display = "none";
445             break;
446         case 'recordview':
447             targets.style.display = "none";            
448             records.style.display = "block";
449             break;
450         default:
451             alert('Unknown view.');
452     }
453 }
454
455 // detailed record drawing
456 function showDetails (prefixRecId) {
457     var recId = prefixRecId.replace('rec_', '');
458     var oldRecId = curDetRecId;
459     curDetRecId = recId;
460     
461     // remove current detailed view if any
462     var detRecordDiv = document.getElementById('det_'+oldRecId);
463     // lovin DOM!
464     if (detRecordDiv)
465       detRecordDiv.parentNode.removeChild(detRecordDiv);
466
467     // if the same clicked, just hide
468     if (recId == oldRecId) {
469         curDetRecId = '';
470         curDetRecData = null;
471         return;
472     }
473     // request the record
474     my_paz.record(recId);
475 }
476
477 function replaceHtml(el, html) {
478   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
479   /*@cc_on // Pure innerHTML is slightly faster in IE
480     oldEl.innerHTML = html;
481     return oldEl;
482     @*/
483   var newEl = oldEl.cloneNode(false);
484   newEl.innerHTML = html;
485   oldEl.parentNode.replaceChild(newEl, oldEl);
486   /* Since we just removed the old element from the DOM, return a reference
487      to the new element, which can be used to restore variable references. */
488   return newEl;
489 };
490
491 function renderDetails(data, marker)
492 {
493     var details = '<div class="details" id="det_'+data.recid+'"><table>';
494     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
495     if (data["md-title"] != undefined) {
496         details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
497         if (data["md-title-remainder"] !== undefined) {
498               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
499         }
500         if (data["md-title-responsibility"] !== undefined) {
501               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
502         }
503           details += '</td></tr>';
504     }
505     if (data["md-date"] != undefined)
506         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
507     if (data["md-author"] != undefined)
508         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
509     if (data["md-electronic-url"] != undefined)
510         details += '<tr><td><b>URL</b></td><td><b>:</b> <a href="' + data["md-electronic-url"] + '" target="_blank">' + data["md-electronic-url"] + '</a>' + '</td></tr>';
511     if (data["location"][0]["md-subject"] != undefined)
512         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
513     if (data["location"][0]["@name"] != undefined)
514         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
515     details += '</table></div>';
516     return details;
517 }
518  //EOF