js/pz2.js

   1 /*
   2 ** $Id: pz2.js,v 1.12 2007-05-02 19:32:13 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     //supported pazpar2's protocol version
  39     __myself.suppProtoVer = '1';
  40     __myself.errorHandler = paramArray.errorhandler || null;
  41
  42     // function callbacks
  43     __myself.statCallback = paramArray.onstat || null;
  44     __myself.showCallback = paramArray.onshow || null;
  45     __myself.termlistCallback = paramArray.onterm || null;
  46     __myself.recordCallback = paramArray.onrecord || null;
  47     __myself.bytargetCallback = paramArray.onbytarget || null;
  48
  49     // termlist keys
  50     __myself.termKeys = paramArray.termlist || "subject";
  51
  52     // some configurational stuff
  53     __myself.pz2String = "search.pz2";
  54     __myself.keepAlive = 50000;
  55
  56     __myself.sessionID = null;
  57     __myself.initStatusOK = false;
  58     __myself.pingStatusOK = false;
  59     __myself.searchStatusOK = false;
  60
  61     if ( paramArray.keepAlive < __myself.keepAlive )
  62         __myself.keepAlive = paramArray.keepAlive;
  63
  64     // for sorting
  65     __myself.currentSort = "relevance";
  66     // where are we?
  67     __myself.currentStart = 0;
  68     __myself.currentNum = 20;
  69
  70     // last full record retrieved
  71     __myself.currRecID = null;
  72     // current query
  73     __myself.currQuery = null;
  74
  75     //timers
  76     __myself.statTime = paramArray.stattime || 2000;
  77     __myself.statTimer = null;
  78     __myself.termTime = paramArray.termtime || 1000;
  79     __myself.termTimer = null;
  80     __myself.showTime = paramArray.showtime || 1000;
  81     __myself.showTimer = null;
  82     __myself.showFastCount = 4;
  83     __myself.bytargetTime = paramArray.bytargettime || 1000;
  84     __myself.bytargetTimer = null;
  85
  86     //useful?
  87     __myself.dumpFactor = 500;
  88     __myself.showCounter = 0;
  89     __myself.termCounter = 0;
  90
  91     // active clients, updated by stat and show
  92     // might be an issue since bytarget will poll accordingly
  93     __myself.activeClients = 1;
  94
  95     // error handling
  96     $(document).ajaxError(
  97     function (ajaxError, xhr, reqSettings, prevException)
  98     {
  99         if ( xhr.responseXML && xhr.responseXML.getElementsByTagName("error").length )
 100         {
 101             var errMsg = xhr.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
 102             var errCode = xhr.responseXML.getElementsByTagName("error")[0].getAttribute("code");
 103
 104             var err = new Error(errMsg);
 105             err.code = errCode;
 106
 107             if (__myself.errorHandler) {
 108                 __myself.errorHandler(err);
 109             }
 110             else {
 111                 throw err;
 112             }
 113         }
 114         // ensure the errors are propagated
 115         else if (prevException != undefined ) {
 116             throw prevException;
 117         }
 118         else {
 119                 throw new Error("XMLHttpRequest error. STATUS: " + xhr.status + " STATUS TEXT: " + xhr.statusText);
 120         }
 121     });
 122
 123     // auto init session?
 124     if (paramArray.autoInit !== false)
 125         __myself.init();
 126 };
 127 pz2.prototype = {
 128     init: function ( sessionId )
 129     {
 130         if ( sessionId != undefined ) {
 131             __myself.initStatusOK = true;
 132             __myself.sessionID = sessionId;
 133             __myself.ping();
 134         } else {
 135             $.get( __myself.pz2String,
 136                 { "command": "init" },
 137                 function(data) {
 138                     if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 139                         if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
 140                             throw new Error("Server's protocol not supported by the client");
 141                         __myself.initStatusOK = true;
 142                         __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
 143                         setTimeout("__myself.ping()", __myself.keepAlive);
 144                     }
 145                     else
 146                         // if it gets here the http return code was 200 (pz2 errors are 417)
 147                         // but the response was invalid, it should never occur
 148                         setTimeout("__myself.init()", 1000);
 149                 }
 150             );
 151         }
 152     },
 153     // no need to ping explicitly
 154     ping: function ()
 155     {
 156         if( !__myself.initStatusOK )
 157             return;
 158             // session is not initialized code here
 159
 160         $.get( __myself.pz2String,
 161             { "command": "ping", "session": __myself.sessionID },
 162             function(data) {
 163                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 164                     __myself.pingStatusOK = true;
 165                     setTimeout("__myself.ping()", __myself.keepAlive);
 166                 }
 167                 else
 168                     // if it gets here the http return code was 200 (pz2 errors are 417)
 169                     // but the response was invalid, it should never occur
 170                     setTimeout("__myself.ping()", 1000);
 171             }
 172         );
 173     },
 174     search: function (query, num, sort, filter)
 175     {
 176         clearTimeout(__myself.statTimer);
 177         clearTimeout(__myself.showTimer);
 178         clearTimeout(__myself.termTimer);
 179         clearTimeout(__myself.bytargetTimer);
 180
 181         __myself.showCounter = 0;
 182         __myself.termCounter = 0;
 183
 184         if( !__myself.initStatusOK )
 185             return;
 186
 187         if( query !== undefined )
 188             __myself.currQuery = query;
 189         else
 190             throw new Error("You need to supply query to the search command");
 191
 192         if( filter !== undefined )
 193             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
 194         else
 195             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
 196
 197         $.get( __myself.pz2String,
 198             searchParams,
 199             function(data) {
 200                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 201                     __myself.searchStatusOK = true;
 202                     //piggyback search
 203                     __myself.show(0, num, sort);
 204                     if ( __myself.statCallback )
 205                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
 206                     if ( __myself.termlistCallback )
 207                         //__myself.termlist();
 208                         __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
 209                     if ( __myself.bytargetCallback )
 210                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
 211                 }
 212                 else
 213                     // if it gets here the http return code was 200 (pz2 errors are 417)
 214                     // but the response was invalid, it should never occur
 215                     setTimeout("__myself.search(__myself.currQuery)", 1000);
 216             }
 217         );
 218     },
 219     stat: function()
 220     {
 221         if( !__myself.searchStatusOK )
 222             return;
 223         // if called explicitly takes precedence
 224         clearTimeout(__myself.statTimer);
 225
 226         $.get( __myself.pz2String,
 227             { "command": "stat", "session": __myself.sessionID },
 228             function(data) {
 229                 if ( data.getElementsByTagName("stat") ) {
 230                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 231                     __myself.activeClients = activeClients;
 232                     var stat = {
 233                     "activeclients": activeClients,
 234                     "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
 235                     "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
 236                     "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
 237                     "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
 238                     "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
 239                     "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
 240                     "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
 241                     "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
 242                     "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
 243                     };
 244                     __myself.statCallback(stat);
 245                     if (activeClients > 0)
 246                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
 247                 }
 248                 else
 249                     // if it gets here the http return code was 200 (pz2 errors are 417)
 250                     // but the response was invalid, it should never occur
 251                     __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
 252             }
 253         );
 254     },
 255     show: function(start, num, sort)
 256     {
 257         if( !__myself.searchStatusOK )
 258             return;
 259         // if called explicitly takes precedence
 260         clearTimeout(__myself.showTimer);
 261
 262         if( sort !== undefined )
 263             __myself.currentSort = sort;
 264         if( start !== undefined )
 265             __myself.currentStart = Number( start );
 266         if( num !== undefined )
 267             __myself.currentNum = Number( num );
 268
 269         $.get( __myself.pz2String,
 270             { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
 271               "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
 272             function(data) {
 273                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 274                     // first parse the status data send along with records
 275                     // this is strictly bound to the format
 276                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 277                     var show = {
 278                     "activeclients": activeClients,
 279                     "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
 280                     "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
 281                     "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
 282                     "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
 283                     "hits": []
 284                     };
 285                     // parse all the first-level nodes for all <hit> tags
 286                     var hits = data.getElementsByTagName("hit");
 287                     var hit = new Array();
 288                     for (i = 0; i < hits.length; i++) {
 289                         show.hits[i] = new Array();
 290                         show.hits[i]['location'] = new Array();
 291                         for ( j = 0; j < hits[i].childNodes.length; j++) {
 292                             var locCount = 0;
 293                             if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 294                                 if (hits[i].childNodes[j].nodeName == 'location') {
 295                                     var locNode = hits[i].childNodes[j];
 296                                     var id = locNode.getAttribute('id');
 297                                     show.hits[i]['location'][id] = {
 298                                         "id": locNode.getAttribute("id"),
 299                                         "name": locNode.getAttribute("name")
 300                                     };
 301                                 }
 302                                 else {
 303                                     var nodeName = hits[i].childNodes[j].nodeName;
 304                                     var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
 305                                     show.hits[i][nodeName] = nodeText;
 306                                 }
 307                             }
 308                         }
 309                     }
 310                     __myself.showCallback(show);
 311                     __myself.showCounter++;
 312                     var delay = __myself.showTime;
 313                     if (__myself.showCounter > __myself.showFastCount)
 314                             delay *= 2;
 315                     if (activeClients > 0)
 316                         __myself.showTimer = setTimeout("__myself.show()", delay);
 317                 }
 318                 else
 319                     // if it gets here the http return code was 200 (pz2 errors are 417)
 320                     // but the response was invalid, it should never occur
 321                     __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
 322             }
 323         );
 324     },
 325     record: function(id)
 326     {
 327         if( !__myself.searchStatusOK )
 328             return;
 329
 330         if( id !== undefined )
 331             __myself.currRecID = id;
 332
 333         $.get( __myself.pz2String,
 334             { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
 335             function(data) {
 336                 var recordNode;
 337                 var record = new Array();
 338                 if ( recordNode = data.getElementsByTagName("record")[0] ) {
 339                     for ( i = 0; i < recordNode.childNodes.length; i++) {
 340                         if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
 341                             var nodeName = recordNode.childNodes[i].nodeName;
 342                             var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
 343                             record[nodeName] = nodeText;
 344                         }
 345                     }
 346                     // the location is hard coded
 347                     var locationNodes = recordNode.getElementsByTagName("location");
 348                     record["location"] = new Array();
 349                     for ( i = 0; i < locationNodes.length; i++ ) {
 350                         record["location"][i] = {
 351                             "id": locationNodes[i].getAttribute("id"),
 352                             "name": locationNodes[i].getAttribute("name")
 353                         };
 354                         for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
 355                             if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 356                                 var nodeName = locationNodes[i].childNodes[j].nodeName;
 357                                 var nodeText;
 358                                 if (locationNodes[i].childNodes[j].firstChild)
 359                                         nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
 360                                 else
 361                                         nodeText = '';
 362                                 record["location"][i][nodeName] = nodeText;
 363                             }
 364                         }
 365                     }
 366                     __myself.recordCallback(record);
 367                 }
 368                 else
 369                     // if it gets here the http return code was 200 (pz2 errors are 417)
 370                     // but the response was invalid, it should never occur
 371                     setTimeout("__myself.record(__myself.currRecID)", 1000);
 372             }
 373         );
 374     },
 375     termlist: function()
 376     {
 377         if( !__myself.searchStatusOK )
 378             return;
 379         // if called explicitly takes precedence
 380         clearTimeout(__myself.termTimer);
 381
 382         $.get( __myself.pz2String,
 383             { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
 384             function(data) {
 385                 if ( data.getElementsByTagName("termlist") ) {
 386                     var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) };
 387                     var termLists = data.getElementsByTagName("list");
 388                     //for each termlist
 389                     for (i = 0; i < termLists.length; i++) {
 390                         var listName = termLists[i].getAttribute('name');
 391                         termList[listName] = new Array();
 392                         var terms = termLists[i].getElementsByTagName('term');
 393                         //for each term in the list
 394                         for (j = 0; j < terms.length; j++) {
 395                             var term = {
 396                                 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
 397                                 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
 398                             };
 399
 400                             var termIdNode = terms[j].getElementsByTagName("id");
 401                             if(terms[j].getElementsByTagName("id").length)
 402                                 term["id"] = termIdNode[0].childNodes[0].nodeValue;
 403
 404                             termList[listName][j] = term;
 405                         }
 406                     }
 407
 408                     __myself.termlistCallback(termList);
 409                     __myself.termCounter++;
 410                     if (termList["activeclients"] > 0)
 411                         __myself.termTimer = setTimeout("__myself.termlist()", (__myself.termTime + __myself.termCounter*__myself.dumpFactor));
 412                 }
 413                 else
 414                     // if it gets here the http return code was 200 (pz2 errors are 417)
 415                     // but the response was invalid, it should never occur
 416                     __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
 417             }
 418         );
 419
 420     },
 421     bytarget: function()
 422     {
 423         if( !__myself.searchStatusOK )
 424             return;
 425         // if called explicitly takes precedence
 426         clearTimeout(__myself.bytargetTimer);
 427
 428         $.get( __myself.pz2String,
 429             { "command": "bytarget", "session": __myself.sessionID },
 430             function(data) {
 431                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 432                     var targetNodes = data.getElementsByTagName("target");
 433                     var bytarget = new Array();
 434                     for ( i = 0; i < targetNodes.length; i++) {
 435                         bytarget[i] = new Array();
 436                         for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
 437                             if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 438                                 var nodeName = targetNodes[i].childNodes[j].nodeName;
 439                                 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
 440                                 bytarget[i][nodeName] = nodeText;
 441                             }
 442                         }
 443                     }
 444                     __myself.bytargetCallback(bytarget);
 445                     if ( __myself.activeClients > 0 )
 446                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
 447                 }
 448                 else
 449                     // if it gets here the http return code was 200 (pz2 errors are 417)
 450                     // but the response was invalid, it should never occur
 451                     __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
 452             }
 453         );
 454     },
 455     // just for testing, probably shouldn't be here
 456     showNext: function(page)
 457     {
 458         var step = page || 1;
 459         __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
 460     },
 461     showPrev: function(page)
 462     {
 463         if (__myself.currentStart == 0 )
 464             return false;
 465         var step = page || 1;
 466         var newStart = __myself.currentStart - (step * __myself.currentNum );
 467         __myself.show( newStart > 0 ? newStart : 0 );
 468     },
 469     showPage: function(pageNum)
 470     {
 471         //var page = pageNum || 1;
 472         __myself.show(pageNum * __myself.currentNum);
 473     }
 474 };
 475 }