js/pz2.js

   1 /*
   2 ** $Id: pz2.js,v 1.4 2007-03-28 15:20:53 jakub Exp $
   3 ** pz2.js - pazpar2's javascript client library.
   4 */
   5
   6 //since explorer is flawed
   7 if (!window['Node']) {
   8     window.Node = new Object();
   9     Node.ELEMENT_NODE = 1;
  10     Node.ATTRIBUTE_NODE = 2;
  11     Node.TEXT_NODE = 3;
  12     Node.CDATA_SECTION_NODE = 4;
  13     Node.ENTITY_REFERENCE_NODE = 5;
  14     Node.ENTITY_NODE = 6;
  15     Node.PROCESSING_INSTRUCTION_NODE = 7;
  16     Node.COMMENT_NODE = 8;
  17     Node.DOCUMENT_NODE = 9;
  18     Node.DOCUMENT_TYPE_NODE = 10;
  19     Node.DOCUMENT_FRAGMENT_NODE = 11;
  20     Node.NOTATION_NODE = 12;
  21 }
  22 // check for jQuery
  23 if(typeof window.jQuery == "undefined"){
  24     throw new Error("pz2.js requires jQuery library");
  25 }
  26 // prevent execution of more than once
  27 if(typeof window.pz2 == "undefined") {
  28 window.undefined = window.undefined;
  29
  30 var pz2 = function(paramArray) {
  31     //for convenience
  32     __myself = this;
  33
  34     // at least one callback required
  35     if ( !paramArray )
  36         throw new Error("An array with parameters has to be suplied when instantiating a class");
  37
  38     // function callbacks
  39     __myself.statCallback = paramArray.onstat || null;
  40     __myself.showCallback = paramArray.onshow || null;
  41     __myself.termlistCallback = paramArray.onterm || null;
  42     __myself.recordCallback = paramArray.onrecord || null;
  43     __myself.bytargetCallback = paramArray.onbytarget || null;
  44
  45     // termlist keys
  46     __myself.termKeys = paramArray.termlist || "subject";
  47
  48     // some configurational stuff
  49     __myself.pz2String = "search.pz2";
  50     __myself.keepAlive = 50000;
  51
  52     __myself.sessionID = null;
  53     __myself.initStatusOK = false;
  54     __myself.pingStatusOK = false;
  55     __myself.searchStatusOK = false;
  56
  57     if ( paramArray.keepAlive < __myself.keepAlive )
  58         __myself.keepAlive = paramArray.keepAlive;
  59
  60     // for sorting
  61     __myself.currentSort = "relevance";
  62     // where are we?
  63     __myself.currentStart = 0;
  64     __myself.currentNum = 20;
  65
  66     // last full record retrieved
  67     __myself.currRecID = null;
  68     // current query
  69     __myself.currQuery = null;
  70
  71     //timers
  72     __myself.statTime = paramArray.stattime || 2000;
  73     __myself.statTimer = null;
  74     __myself.termTime = paramArray.termtime || 2000;
  75     __myself.termTimer = null;
  76     __myself.showTime = paramArray.showtime || 2000;
  77     __myself.showTimer = null;
  78     __myself.bytargetTime = paramArray.bytargettime || 1000;
  79     __myself.bytargetTimer = null;
  80
  81     // active clients, updated by stat and show
  82     // might be an issue since bytarget will poll accordingly
  83     __myself.activeClients = 1;
  84
  85     // error handling
  86     $(document).ajaxError(
  87     function (request, settings, exception) {
  88         if ( settings.responseXML && settings.responseXML.getElementsByTagName("error") )
  89             throw new Error( settings.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue);
  90     });
  91
  92     // auto init session?
  93     if (paramArray.autoInit !== false)
  94         __myself.init(__myself.keepAlive);
  95 };
  96 pz2.prototype = {
  97     init: function(keepAlive)
  98     {
  99         if ( keepAlive < __myself.keepAlive )
 100             __myself.keepAlive = keepAlive;
 101
 102         $.get( __myself.pz2String,
 103             { "command": "init" },
 104             function(data) {
 105                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 106                     __myself.initStatusOK = true;
 107                     __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
 108                     setTimeout(__myself.ping, __myself.keepAlive);
 109                 }
 110                 else
 111                     // if it gets here the http return code was 200 (pz2 errors are 417)
 112                     // but the response was invalid, it should never occur
 113                     setTimeout("__myself.init()", 1000);
 114             }
 115         );
 116     },
 117     // no need to ping explicitly
 118     ping: function()
 119     {
 120         if( !__myself.initStatusOK )
 121             return;
 122             // session is not initialized code here
 123
 124         $.get( __myself.pz2String,
 125             { "command": "ping", "session": __myself.sessionID },
 126             function(data) {
 127                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 128                     __myself.pingStatusOK = true;
 129                     setTimeout("__myself.ping()", __myself.keepAlive);
 130                 }
 131                 else
 132                     // if it gets here the http return code was 200 (pz2 errors are 417)
 133                     // but the response was invalid, it should never occur
 134                     setTimeout("__myself.ping()", 1000);
 135             }
 136         );
 137     },
 138     search: function(query, num, sort, filter)
 139     {
 140         clearTimeout(__myself.statTimer);
 141         clearTimeout(__myself.showTimer);
 142         clearTimeout(__myself.termTimer);
 143         clearTimeout(__myself.bytargetTimer);
 144
 145         if( !__myself.initStatusOK )
 146             return;
 147
 148         if( query !== undefined )
 149             __myself.currQuery = query;
 150         else
 151             throw new Error("You need to supply query to the search command");
 152
 153         if( filter !== undefined )
 154             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
 155         else
 156             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
 157
 158         $.get( __myself.pz2String,
 159             searchParams,
 160             function(data) {
 161                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 162                     __myself.searchStatusOK = true;
 163                     //piggyback search
 164                     __myself.show(0, num, sort);
 165                     if ( __myself.statCallback )
 166                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
 167                     if ( __myself.termlistCallback )
 168                         __myself.termlist();
 169                         //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
 170                     if ( __myself.bytargetCallback )
 171                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
 172                 }
 173                 else
 174                     // if it gets here the http return code was 200 (pz2 errors are 417)
 175                     // but the response was invalid, it should never occur
 176                     setTimeout("__myself.search(__myself.currQuery)", 1000);
 177             }
 178         );
 179     },
 180     stat: function()
 181     {
 182         if( !__myself.searchStatusOK )
 183             return;
 184         // if called explicitly takes precedence
 185         clearTimeout(__myself.statTimer);
 186
 187         $.get( __myself.pz2String,
 188             { "command": "stat", "session": __myself.sessionID },
 189             function(data) {
 190                 if ( data.getElementsByTagName("stat") ) {
 191                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 192                     __myself.activeClients = activeClients;
 193                     var stat = {
 194                     "activeclients": activeClients,
 195                     "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
 196                     "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
 197                     "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
 198                     "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
 199                     "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
 200                     "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
 201                     "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
 202                     "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
 203                     "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
 204                     };
 205                     __myself.statCallback(stat);
 206                     if (activeClients > 0)
 207                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
 208                 }
 209                 else
 210                     // if it gets here the http return code was 200 (pz2 errors are 417)
 211                     // but the response was invalid, it should never occur
 212                     __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
 213             }
 214         );
 215     },
 216     show: function(start, num, sort)
 217     {
 218         if( !__myself.searchStatusOK )
 219             return;
 220         // if called explicitly takes precedence
 221         clearTimeout(__myself.showTimer);
 222
 223         if( sort !== undefined )
 224             __myself.currentSort = sort;
 225         if( start !== undefined )
 226             __myself.currentStart = Number( start );
 227         if( num !== undefined )
 228             __myself.currentNum = Number( num );
 229
 230         $.get( __myself.pz2String,
 231             { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
 232               "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
 233             function(data) {
 234                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 235                     // first parse the status data send along with records
 236                     // this is strictly bound to the format
 237                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 238                     var show = {
 239                     "activeclients": activeClients,
 240                     "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
 241                     "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
 242                     "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
 243                     "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
 244                     "hits": []
 245                     };
 246                     // parse all the first-level nodes for all <hit> tags
 247                     var hits = data.getElementsByTagName("hit");
 248                     var hit = new Array();
 249                     for (i = 0; i < hits.length; i++) {
 250                         show.hits[i] = new Array();
 251                         for ( j = 0; j < hits[i].childNodes.length; j++) {
 252                             if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 253                                 var nodeName = hits[i].childNodes[j].nodeName;
 254                                 var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
 255                                 show.hits[i][nodeName] = nodeText;
 256                             }
 257                         }
 258                     }
 259                     __myself.showCallback(show);
 260                     if (activeClients > 0)
 261                         __myself.showTimer = setTimeout("__myself.show()", __myself.showTime);
 262                 }
 263                 else
 264                     // if it gets here the http return code was 200 (pz2 errors are 417)
 265                     // but the response was invalid, it should never occur
 266                     __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
 267             }
 268         );
 269     },
 270     record: function(id)
 271     {
 272         if( !__myself.searchStatusOK )
 273             return;
 274
 275         if( id !== undefined )
 276             __myself.currRecID = id;
 277
 278         $.get( __myself.pz2String,
 279             { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
 280             function(data) {
 281                 var recordNode;
 282                 var record = new Array();
 283                 if ( recordNode = data.getElementsByTagName("record")[0] ) {
 284                     for ( i = 0; i < recordNode.childNodes.length; i++) {
 285                         if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
 286                             var nodeName = recordNode.childNodes[i].nodeName;
 287                             var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
 288                             record[nodeName] = nodeText;
 289                         }
 290                     }
 291                     // the location is hard coded
 292                     var locationNodes = recordNode.getElementsByTagName("location");
 293                     record["location"] = new Array();
 294                     for ( i = 0; i < locationNodes.length; i++ ) {
 295                         record["location"][i] = {
 296                             "id": locationNodes[i].getAttribute("id"),
 297                             "name": locationNodes[i].getAttribute("name")
 298                         };
 299                         for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
 300                             if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 301                                 var nodeName = locationNodes[i].childNodes[j].nodeName;
 302                                 var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
 303                                 record["location"][i][nodeName] = nodeText;
 304                             }
 305                         }
 306                     }
 307                     __myself.recordCallback(record);
 308                 }
 309                 else
 310                     // if it gets here the http return code was 200 (pz2 errors are 417)
 311                     // but the response was invalid, it should never occur
 312                     setTimeout("__myself.record(__myself.currRecID)", 1000);
 313             }
 314         );
 315     },
 316     termlist: function()
 317     {
 318         if( !__myself.searchStatusOK )
 319             return;
 320         // if called explicitly takes precedence
 321         clearTimeout(__myself.termTimer);
 322
 323         $.get( __myself.pz2String,
 324             { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
 325             function(data) {
 326                 if ( data.getElementsByTagName("termlist") ) {
 327                     var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) };
 328                     var termLists = data.getElementsByTagName("list");
 329                     //for each termlist
 330                     for (i = 0; i < termLists.length; i++) {
 331                         var listName = termLists[i].getAttribute('name');
 332                         termList[listName] = new Array();
 333                         var terms = termLists[i].getElementsByTagName('term');
 334                         //for each term in the list
 335                         for (j = 0; j < terms.length; j++) {
 336                             var term = {
 337                                 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
 338                                 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
 339                             };
 340
 341                             var termIdNode = terms[j].getElementsByTagName("id");
 342                             if(terms[j].getElementsByTagName("id").length)
 343                                 term["id"] = termIdNode[0].childNodes[0].nodeValue;
 344
 345                             termList[listName][j] = term;
 346                         }
 347                     }
 348                     __myself.termlistCallback(termList);
 349                     if (termList["activeclients"] > 0)
 350                         __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime);
 351                 }
 352                 else
 353                     // if it gets here the http return code was 200 (pz2 errors are 417)
 354                     // but the response was invalid, it should never occur
 355                     __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
 356             }
 357         );
 358
 359     },
 360     bytarget: function()
 361     {
 362         if( !__myself.searchStatusOK )
 363             return;
 364         // if called explicitly takes precedence
 365         clearTimeout(__myself.bytargetTimer);
 366
 367         $.get( __myself.pz2String,
 368             { "command": "bytarget", "session": __myself.sessionID },
 369             function(data) {
 370                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 371                     var targetNodes = data.getElementsByTagName("target");
 372                     var bytarget = new Array();
 373                     for ( i = 0; i < targetNodes.length; i++) {
 374                         bytarget[i] = new Array();
 375                         for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
 376                             if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 377                                 var nodeName = targetNodes[i].childNodes[j].nodeName;
 378                                 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
 379                                 bytarget[i][nodeName] = nodeText;
 380                             }
 381                         }
 382                     }
 383                     __myself.bytargetCallback(bytarget);
 384                     if ( __myself.activeClients > 0 )
 385                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
 386                 }
 387                 else
 388                     // if it gets here the http return code was 200 (pz2 errors are 417)
 389                     // but the response was invalid, it should never occur
 390                     __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
 391             }
 392         );
 393     },
 394     // just for testing, probably shouldn't be here
 395     showNext: function(page)
 396     {
 397         var step = page || 1;
 398         __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
 399     },
 400     showPrev: function(page)
 401     {
 402         if (__myself.currentStart == 0 )
 403             return false;
 404         var step = page || 1;
 405         var newStart = __myself.currentStart - (step * __myself.currentNum );
 406         __myself.show( newStart > 0 ? newStart : 0 );
 407     },
 408     showPage: function(pageNum)
 409     {
 410         //var page = pageNum || 1;
 411         __myself.show(pageNum * __myself.currentNum);
 412     }
 413 };
 414 }