www/masterkey/js/client.js

   1 /*
   2 ** $Id: client.js,v 1.13 2007-04-13 17:19:53 quinn Exp $
   3 ** MasterKey - pazpar2's javascript client .
   4 */
   5
   6 /* start with creating pz2 object and passing it event handlers*/
   7 var my_paz = new pz2( { "onshow": my_onshow,
   8                     //"showtime": 1000,
   9                     //"onstat": my_onstat,
  10                     "onterm": my_onterm,
  11                     "termlist": "xtargets,subject,author,date",
  12                     //"onbytarget": my_onbytarget,
  13                     "onrecord": my_onrecord } );
  14
  15 /* some state variable */
  16 var currentSort = 'relevance';
  17 var currentResultsPerPage = 20;
  18 var currentPage = 0;
  19 var curQuery = new pzQuery();
  20
  21 var currentDetailedId = null;
  22 var currentDetailedData = null;
  23
  24 var termStartup = true;
  25 var advancedOn = false;
  26
  27 /* wait until the DOM is ready and register basic handlers */
  28 $(document).ready( function() {
  29                     document.search.onsubmit = onFormSubmitEventHandler;
  30
  31                     document.search.query.value = '';
  32                     document.search.title.value = '';
  33                     document.search.author.value = '';
  34                     document.search.subject.value = '';
  35                     document.search.date.value = '';
  36
  37                     $('#advanced').click(toggleAdvanced);
  38
  39                     $('#sort').change(function(){
  40                         currentSort = this.value;
  41                         currentPage = 0;
  42                         my_paz.show(0, currentResultsPerPage, currentSort);
  43                     });
  44
  45                     $('#perpage').change(function(){
  46                         currentResultsPerPage = this.value;
  47                         currentPage = 0;
  48                         my_paz.show(0, currentResultsPerPage, currentSort);
  49                     });
  50 } );
  51
  52 /* search button event handler */
  53 function onFormSubmitEventHandler() {
  54     loadQueryFromForm();
  55     curQuery.clearFilter();
  56     fireSearch();
  57     drawBreadcrumb();
  58     $('div.content').show();
  59     $("div.leftbar").show();
  60     return false;
  61 }
  62
  63 /*
  64 *********************************************************************************
  65 ** pz2 Event Handlers ***********************************************************
  66 *********************************************************************************
  67 */
  68
  69 /*
  70 ** data.hits["md-title"], data.hits["md-author"], data.hits.recid, data.hits.count
  71 ** data.activeclients, data.merged, data.total, data.start, data.num
  72 */
  73 function my_onshow(data)
  74 {
  75     var recsBody = $('div.records');
  76     recsBody.empty();
  77
  78     for (var i = 0; i < data.hits.length; i++) {
  79         var title = data.hits[i]["md-title"] || 'N/A';
  80         var author = data.hits[i]["md-author"] || '';
  81         var id = data.hits[i].recid;
  82         var count = data.hits[i].count || 1;
  83
  84         var recBody = $('<div class="record" id="rec_'+id+'"></div>');
  85         var aTitle = $('<a class="recTitle">'+title+'</a>').appendTo(recBody);
  86         aTitle.click(function(){
  87                         var clickedId = this.parentNode.id.split('_')[1];
  88                         if(currentDetailedId == clickedId){
  89                             $(this.parentNode.lastChild).remove();
  90                             currentDetailedId = null;
  91                             return;
  92                         } else if (currentDetailedId != null) {
  93                             $(this.parentNode.lastChild).remove();
  94                             $('#rec_'+currentDetailedId).children('.detail').remove();
  95                         }
  96                         currentDetailedId = clickedId;
  97                         my_paz.record(currentDetailedId);
  98                         });
  99
 100         if( author ) {
 101             recBody.append('<i> by </i>');
 102             $('<a name="author" class="recAuthor">'+author+'</a>\n').click(function(){
 103                             refine(this.name, this.firstChild.nodeValue) }).appendTo(recBody);
 104         }
 105
 106         if( currentDetailedId == id ) {
 107             var detailBox = $('<div class="detail"></div>').appendTo(recBody);
 108             drawDetailedRec(detailBox);
 109         }
 110
 111         if( count > 1 ) {
 112             recBody.append('<span> ('+count+')</span>');
 113         }
 114
 115         recsBody.append('<div class="resultNum">'+(currentPage*currentResultsPerPage+i+1)+'.</a>');
 116         recsBody.append(recBody);
 117     }
 118     drawPager(data.merged, data.total);
 119 }
 120
 121 /*
 122 ** data.activeclients, data.hits, data.records, data.clients, data.searching
 123 */
 124 function my_onstat(data){}
 125
 126 /*
 127 ** data[listname]: name, freq, [id]
 128 */
 129 function my_onterm(data)
 130 {
 131     if(termStartup)
 132     {
 133         var termLists = $("#termlists");
 134
 135         for(var key in data){
 136             if (key == "activeclients")
 137                 continue;
 138             var listName = key;
 139             var listClass = "unselected";
 140
 141             if (key == "xtargets"){
 142                 listName = "resource";
 143                 listClass = "selected";
 144             }
 145
 146             var termList = $('<div class="termlist" id="term_'+key+'"/>').appendTo(termLists);
 147             var termTitle = $('<div class="termTitle"><a class="'+listClass+'">'+listName+'</a></div>').appendTo(termList);
 148             termTitle.click(function(){
 149                                 if( this.firstChild.className == "selected" ){
 150                                     this.firstChild.className = "unselected";
 151                                     $(this.nextSibling).hide();
 152                                 } else {
 153                                     this.firstChild.className = "selected";
 154                                     $(this.nextSibling).show();
 155                                 }
 156                             });
 157
 158             listEntries = $('<div class="termEntries"></div>');
 159             if (key != "xtargets") listEntries.hide();
 160             listEntries.appendTo(termList);
 161
 162             for(var i = 0; i < data[key].length; i++)
 163             {
 164                 if (key == "xtargets"){
 165                     var listItem = $('<a class="sub" name="xtarget" value="'+data[key][i].id+'">'+data[key][i].name +'<span> ('+data[key][i].freq+')</span>'+'</a>');
 166                     listItem.click(function(){
 167                         refine(this.name, this.attributes[0].nodeValue, this.firstChild.nodeValue) });
 168                     listItem.appendTo(listEntries);
 169                 } else {
 170                     var listItem = $('<a class="sub" name="'+key+'">'+data[key][i].name
 171                             /*+'<span> ('+data[key][i].freq+')</span>'*/+'</a>');
 172                     listItem.click(function(){ refine(this.name, this.firstChild.nodeValue) });
 173                     listItem.appendTo(listEntries);
 174                 }
 175             }
 176             $('<hr/>').appendTo(termLists);
 177         }
 178         termStartup = false;
 179     }
 180     else
 181     {
 182         for(var key in data){
 183             if (key == "activeclients")
 184                 continue;
 185             var listEntries = $('#term_'+key).children('.termEntries');
 186             if( data[key].length ) listEntries.empty();
 187
 188             for(var i = 0; i < data[key].length; i++){
 189                 if (key == "xtargets"){
 190                     var listItem = $('<a class="sub" name="xtarget" value="'+data[key][i].id+'">'+data[key][i].name+'<span> ('+data[key][i].freq+')</span>'+'</a>').click(function(){
 191                                     refine(this.name, this.attributes[0].nodeValue, this.firstChild.nodeValue) });
 192                     listItem.appendTo(listEntries);
 193                 } else {
 194                     var listItem = $('<a class="sub" name="'+key+'">'+data[key][i].name
 195                                 /*+'<span> ('+data[key][i].freq+')</span>'*/+'</a>').click(function(){
 196                                                                         refine(this.name, this.firstChild.nodeValue) });
 197                     listItem.appendTo(listEntries);
 198                 }
 199             }
 200         }
 201     }
 202 }
 203
 204 /*
 205 ** data["md-title"], data["md-date"], data["md-author"], data["md-subject"], data["location"][0].name
 206 */
 207 function my_onrecord(data)
 208 {
 209     currentDetailedData = data;
 210     drawDetailedRec();
 211 }
 212
 213 /*
 214 ** data[i].id, data[i].hits, data[i].diagnostic, data[i].records, data[i].state
 215 */
 216 function my_onbytarget(data){}
 217
 218 /*
 219 *********************************************************************************
 220 ** HELPER FUNCTIONS *************************************************************
 221 *********************************************************************************
 222 */
 223 function fireSearch()
 224 {
 225     $('div.showing').empty().text('No records to show.');
 226     $('div.pages').empty().html('&nbsp;');
 227     $('div.records').empty();
 228     currentDetailedId = null;
 229     if( !curQuery.totalLength() )
 230         return false;
 231     my_paz.search(curQuery.toCCL(), currentResultsPerPage, currentSort, curQuery.getFilterString() );
 232 }
 233
 234 function toggleAdvanced()
 235 {
 236     if(advancedOn){
 237         $("div.advanced").hide();
 238         $("div.search").height(73);
 239         advancedOn = false;
 240         $("#advanced").text("Advanced search");
 241     } else {
 242         $("div.search").height(173);
 243         $("div.advanced").show();
 244         advancedOn = true;
 245         $("#advanced").text("Simple search");
 246         loadFormFieldsFromQuery();
 247     }
 248 }
 249
 250 function drawDetailedRec(detailBox)
 251 {
 252     if( detailBox == undefined )
 253         detailBox = $('<div class="detail"></div>').appendTo($('#rec_'+currentDetailedId));
 254
 255     detailBox.append('Details:<hr/>');
 256     var detailTable = $('<table></table>');
 257     var recDate = currentDetailedData["md-date"];
 258     var recSubject = currentDetailedData["md-subject"];
 259     var recLocation = currentDetailedData["location"];
 260
 261     if( recDate )
 262         detailTable.append('<tr><td class="item">Published:</td><td>'+recDate+'</td></tr>');
 263     if( recSubject )
 264         detailTable.append('<tr><td class="item">Subject:</td><td>'+recSubject+'</td></tr>');
 265     if( recLocation )
 266         detailTable.append('<tr><td class="item">Available at:</td><td>&nbsp;</td></tr>');
 267
 268     for(var i=0; i < recLocation.length; i++)
 269     {
 270         detailTable.append('<tr><td class="item">&nbsp;</td><td>'+recLocation[i].name+'</td></tr>');
 271     }
 272
 273     detailTable.appendTo(detailBox);
 274 }
 275
 276 function refine(field, value, opt)
 277 {
 278     switch(field) {
 279         case "author":  curQuery.addTerm('au', value); break;
 280         case "title":   curQuery.addTerm('ti', value); break;
 281         case "date":    curQuery.addTerm('date', value); break;
 282         case "subject": curQuery.addTerm('su', value); break;
 283         case "xtarget": curQuery.setFilter(opt, value); break;
 284     }
 285
 286     if(advancedOn)
 287         loadFormFieldsFromQuery();
 288
 289     currentPage = 0;
 290     drawBreadcrumb();
 291     fireSearch();
 292 }
 293
 294 function loadQueryFromForm()
 295 {
 296     curQuery.reset();
 297     curQuery.simpleQuery = document.search.query.value;
 298
 299     if( advancedOn )
 300     {
 301         curQuery.addTermsFromList(document.search.author.value, 'au');
 302         curQuery.addTermsFromList(document.search.title.value, 'ti');
 303         curQuery.addTermsFromList(document.search.date.value, 'date');
 304         curQuery.addTermsFromList(document.search.subject.value, 'su');
 305     }
 306 }
 307
 308 function loadFormFieldsFromQuery()
 309 {
 310     document.search.author.value = '';
 311     document.search.title.value = '';
 312     document.search.date.value = '';
 313     document.search.subject.value = '';
 314
 315     for(var i = 0; i < curQuery.numTerms; i++)
 316     {
 317         switch( curQuery.getTermFieldByIdx(i) )
 318         {
 319             case "au": document.search.author.value += curQuery.getTermValueByIdx(i) + '; '; break;
 320             case "ti": document.search.title.value += curQuery.getTermValueByIdx(i) + '; '; break;
 321             case "date": document.search.date.value += curQuery.getTermValueByIdx(i) + '; '; break;
 322             case "su": document.search.subject.value += curQuery.getTermValueByIdx(i) + '; '; break;
 323         }
 324     }
 325 }
 326
 327 function drawPager(max, hits)
 328 {
 329     var firstOnPage = currentPage * currentResultsPerPage + 1;
 330     var lastOnPage = (firstOnPage + currentResultsPerPage - 1) < max ? (firstOnPage + currentResultsPerPage - 1) : max;
 331
 332     var results = $('div.showing');
 333     results.empty();
 334     results.append('Displaying: <b>'+firstOnPage+'</b> to <b>'+lastOnPage+
 335                             '</b> of <b>'+max+'</b> (total hits: '+hits+')');
 336     var pager = $('div.pages');
 337     pager.empty();
 338
 339     if ( currentPage > 0 ){
 340         $('<a class="previous_active">Previous</a>').click(function() { my_paz.showPrev(1); currentPage--; }).appendTo(pager.eq(0));
 341         $('<a class="previous_active">Previous</a>').click(function() { my_paz.showPrev(1); currentPage--; }).appendTo(pager.eq(1));
 342     }
 343     else
 344         pager.append('<a class="previous_inactive">Previous</a>');
 345
 346     var numPages = Math.ceil(max / currentResultsPerPage);
 347
 348     var start = ( currentPage - 5 > 0 ? currentPage - 5 : 1 );
 349     var stop =  ( start + 12 < numPages ? start + 12 : numPages );
 350
 351     if (start > 1) $('<span>... </span>').appendTo(pager);
 352
 353     for(var i = start; i <= stop; i++)
 354     {
 355         if( i == (currentPage + 1) ){
 356            $('<a class="select">'+i+'</a>').appendTo(pager);
 357            continue;
 358         }
 359         var pageLink = $('<a class="page">'+i+'</a>');
 360         var plClone = pageLink.clone();
 361
 362         pageLink.click(function() {
 363             my_paz.showPage(this.firstChild.nodeValue - 1);
 364             currentPage = (this.firstChild.nodeValue - 1);
 365             });
 366
 367         plClone.click(function() {
 368             my_paz.showPage(this.firstChild.nodeValue - 1);
 369             currentPage = (this.firstChild.nodeValue - 1);
 370             });
 371
 372         //nasty hack
 373         pager.eq(0).append(pageLink);
 374         pager.eq(1).append(plClone);
 375     }
 376
 377     if (stop < numPages) $('<span> ...</span>').appendTo(pager);
 378
 379     if ( currentPage < (numPages-1) ){
 380         $('<a class="next_active">Next</a>').click(function() { my_paz.showNext(1); currentPage++; }).appendTo(pager.eq(0));
 381         $('<a class="next_active">Next</a>').click(function() { my_paz.showNext(1); currentPage++; }).appendTo(pager.eq(1));
 382     }
 383     else
 384         pager.append('<a class="next_inactive">Next</a>');
 385 }
 386
 387 function drawBreadcrumb()
 388 {
 389     var bc = $("#breadcrumb");
 390     bc.empty();
 391
 392     if(curQuery.filterNums) $('<strong id="filter"><a>'+curQuery.getFilterName(0)+'</a>: </strong>').click(function() {
 393                                 curQuery.removeFilter(0);
 394                                 refine();
 395                                 }).appendTo(bc);
 396
 397     bc.append('<span>'+curQuery.simpleQuery+'</span>');
 398
 399     for(var i = 0; i < curQuery.numTerms; i++){
 400         bc.append('<strong> + </strong>');
 401         var bcLink = $('<a id="pos_'+i+'">'+curQuery.getTermValueByIdx(i)+'</a>').click(function() {
 402                                             curQuery.removeTermByIdx(this.id.split('_')[1]);
 403                                             refine();
 404                                             });
 405         bc.append(bcLink);
 406     }
 407 }