js/pz2.js

   1 /*
   2 ** $Id: pz2.js,v 1.11 2007-04-20 13:56:20 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(__myself.keepAlive);
 126 };
 127 pz2.prototype = {
 128     init: function(keepAlive)
 129     {
 130         if ( keepAlive < __myself.keepAlive )
 131             __myself.keepAlive = keepAlive;
 132
 133         $.get( __myself.pz2String,
 134             { "command": "init" },
 135             function(data) {
 136                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 137                     if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
 138                         throw new Error("Server's protocol not supported by the client");
 139                     __myself.initStatusOK = true;
 140                     __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
 141                     setTimeout(__myself.ping, __myself.keepAlive);
 142                 }
 143                 else
 144                     // if it gets here the http return code was 200 (pz2 errors are 417)
 145                     // but the response was invalid, it should never occur
 146                     setTimeout("__myself.init()", 1000);
 147             }
 148         );
 149     },
 150     // no need to ping explicitly
 151     ping: function()
 152     {
 153         if( !__myself.initStatusOK )
 154             return;
 155             // session is not initialized code here
 156
 157         $.get( __myself.pz2String,
 158             { "command": "ping", "session": __myself.sessionID },
 159             function(data) {
 160                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 161                     __myself.pingStatusOK = true;
 162                     setTimeout("__myself.ping()", __myself.keepAlive);
 163                 }
 164                 else
 165                     // if it gets here the http return code was 200 (pz2 errors are 417)
 166                     // but the response was invalid, it should never occur
 167                     setTimeout("__myself.ping()", 1000);
 168             }
 169         );
 170     },
 171     search: function(query, num, sort, filter)
 172     {
 173         clearTimeout(__myself.statTimer);
 174         clearTimeout(__myself.showTimer);
 175         clearTimeout(__myself.termTimer);
 176         clearTimeout(__myself.bytargetTimer);
 177
 178         __myself.showCounter = 0;
 179         __myself.termCounter = 0;
 180
 181         if( !__myself.initStatusOK )
 182             return;
 183
 184         if( query !== undefined )
 185             __myself.currQuery = query;
 186         else
 187             throw new Error("You need to supply query to the search command");
 188
 189         if( filter !== undefined )
 190             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
 191         else
 192             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
 193
 194         $.get( __myself.pz2String,
 195             searchParams,
 196             function(data) {
 197                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 198                     __myself.searchStatusOK = true;
 199                     //piggyback search
 200                     __myself.show(0, num, sort);
 201                     if ( __myself.statCallback )
 202                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
 203                     if ( __myself.termlistCallback )
 204                         //__myself.termlist();
 205                         __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
 206                     if ( __myself.bytargetCallback )
 207                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
 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                     setTimeout("__myself.search(__myself.currQuery)", 1000);
 213             }
 214         );
 215     },
 216     stat: function()
 217     {
 218         if( !__myself.searchStatusOK )
 219             return;
 220         // if called explicitly takes precedence
 221         clearTimeout(__myself.statTimer);
 222
 223         $.get( __myself.pz2String,
 224             { "command": "stat", "session": __myself.sessionID },
 225             function(data) {
 226                 if ( data.getElementsByTagName("stat") ) {
 227                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 228                     __myself.activeClients = activeClients;
 229                     var stat = {
 230                     "activeclients": activeClients,
 231                     "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
 232                     "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
 233                     "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
 234                     "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
 235                     "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
 236                     "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
 237                     "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
 238                     "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
 239                     "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
 240                     };
 241                     __myself.statCallback(stat);
 242                     if (activeClients > 0)
 243                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
 244                 }
 245                 else
 246                     // if it gets here the http return code was 200 (pz2 errors are 417)
 247                     // but the response was invalid, it should never occur
 248                     __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
 249             }
 250         );
 251     },
 252     show: function(start, num, sort)
 253     {
 254         if( !__myself.searchStatusOK )
 255             return;
 256         // if called explicitly takes precedence
 257         clearTimeout(__myself.showTimer);
 258
 259         if( sort !== undefined )
 260             __myself.currentSort = sort;
 261         if( start !== undefined )
 262             __myself.currentStart = Number( start );
 263         if( num !== undefined )
 264             __myself.currentNum = Number( num );
 265
 266         $.get( __myself.pz2String,
 267             { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
 268               "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
 269             function(data) {
 270                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 271                     // first parse the status data send along with records
 272                     // this is strictly bound to the format
 273                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 274                     var show = {
 275                     "activeclients": activeClients,
 276                     "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
 277                     "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
 278                     "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
 279                     "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
 280                     "hits": []
 281                     };
 282                     // parse all the first-level nodes for all <hit> tags
 283                     var hits = data.getElementsByTagName("hit");
 284                     var hit = new Array();
 285                     for (i = 0; i < hits.length; i++) {
 286                         show.hits[i] = new Array();
 287                         show.hits[i]['location'] = new Array();
 288                         for ( j = 0; j < hits[i].childNodes.length; j++) {
 289                             var locCount = 0;
 290                             if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 291                                 if (hits[i].childNodes[j].nodeName == 'location') {
 292                                     var locNode = hits[i].childNodes[j];
 293                                     var id = locNode.getAttribute('id');
 294                                     show.hits[i]['location'][id] = {
 295                                         "id": locNode.getAttribute("id"),
 296                                         "name": locNode.getAttribute("name")
 297                                     };
 298                                 }
 299                                 else {
 300                                     var nodeName = hits[i].childNodes[j].nodeName;
 301                                     var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
 302                                     show.hits[i][nodeName] = nodeText;
 303                                 }
 304                             }
 305                         }
 306                     }
 307                     __myself.showCallback(show);
 308                     __myself.showCounter++;
 309                     var delay = __myself.showTime;
 310                     if (__myself.showCounter > __myself.showFastCount)
 311                             delay *= 2;
 312                     if (activeClients > 0)
 313                         __myself.showTimer = setTimeout("__myself.show()", delay);
 314                 }
 315                 else
 316                     // if it gets here the http return code was 200 (pz2 errors are 417)
 317                     // but the response was invalid, it should never occur
 318                     __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
 319             }
 320         );
 321     },
 322     record: function(id)
 323     {
 324         if( !__myself.searchStatusOK )
 325             return;
 326
 327         if( id !== undefined )
 328             __myself.currRecID = id;
 329
 330         $.get( __myself.pz2String,
 331             { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
 332             function(data) {
 333                 var recordNode;
 334                 var record = new Array();
 335                 if ( recordNode = data.getElementsByTagName("record")[0] ) {
 336                     for ( i = 0; i < recordNode.childNodes.length; i++) {
 337                         if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
 338                             var nodeName = recordNode.childNodes[i].nodeName;
 339                             var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
 340                             record[nodeName] = nodeText;
 341                         }
 342                     }
 343                     // the location is hard coded
 344                     var locationNodes = recordNode.getElementsByTagName("location");
 345                     record["location"] = new Array();
 346                     for ( i = 0; i < locationNodes.length; i++ ) {
 347                         record["location"][i] = {
 348                             "id": locationNodes[i].getAttribute("id"),
 349                             "name": locationNodes[i].getAttribute("name")
 350                         };
 351                         for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
 352                             if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 353                                 var nodeName = locationNodes[i].childNodes[j].nodeName;
 354                                 var nodeText;
 355                                 if (locationNodes[i].childNodes[j].firstChild)
 356                                         nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
 357                                 else
 358                                         nodeText = '';
 359                                 record["location"][i][nodeName] = nodeText;
 360                             }
 361                         }
 362                     }
 363                     __myself.recordCallback(record);
 364                 }
 365                 else
 366                     // if it gets here the http return code was 200 (pz2 errors are 417)
 367                     // but the response was invalid, it should never occur
 368                     setTimeout("__myself.record(__myself.currRecID)", 1000);
 369             }
 370         );
 371     },
 372     termlist: function()
 373     {
 374         if( !__myself.searchStatusOK )
 375             return;
 376         // if called explicitly takes precedence
 377         clearTimeout(__myself.termTimer);
 378
 379         $.get( __myself.pz2String,
 380             { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
 381             function(data) {
 382                 if ( data.getElementsByTagName("termlist") ) {
 383                     var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) };
 384                     var termLists = data.getElementsByTagName("list");
 385                     //for each termlist
 386                     for (i = 0; i < termLists.length; i++) {
 387                         var listName = termLists[i].getAttribute('name');
 388                         termList[listName] = new Array();
 389                         var terms = termLists[i].getElementsByTagName('term');
 390                         //for each term in the list
 391                         for (j = 0; j < terms.length; j++) {
 392                             var term = {
 393                                 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
 394                                 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
 395                             };
 396
 397                             var termIdNode = terms[j].getElementsByTagName("id");
 398                             if(terms[j].getElementsByTagName("id").length)
 399                                 term["id"] = termIdNode[0].childNodes[0].nodeValue;
 400
 401                             termList[listName][j] = term;
 402                         }
 403                     }
 404
 405                     __myself.termlistCallback(termList);
 406                     __myself.termCounter++;
 407                     if (termList["activeclients"] > 0)
 408                         __myself.termTimer = setTimeout("__myself.termlist()", (__myself.termTime + __myself.termCounter*__myself.dumpFactor));
 409                 }
 410                 else
 411                     // if it gets here the http return code was 200 (pz2 errors are 417)
 412                     // but the response was invalid, it should never occur
 413                     __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
 414             }
 415         );
 416
 417     },
 418     bytarget: function()
 419     {
 420         if( !__myself.searchStatusOK )
 421             return;
 422         // if called explicitly takes precedence
 423         clearTimeout(__myself.bytargetTimer);
 424
 425         $.get( __myself.pz2String,
 426             { "command": "bytarget", "session": __myself.sessionID },
 427             function(data) {
 428                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 429                     var targetNodes = data.getElementsByTagName("target");
 430                     var bytarget = new Array();
 431                     for ( i = 0; i < targetNodes.length; i++) {
 432                         bytarget[i] = new Array();
 433                         for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
 434                             if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 435                                 var nodeName = targetNodes[i].childNodes[j].nodeName;
 436                                 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
 437                                 bytarget[i][nodeName] = nodeText;
 438                             }
 439                         }
 440                     }
 441                     __myself.bytargetCallback(bytarget);
 442                     if ( __myself.activeClients > 0 )
 443                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
 444                 }
 445                 else
 446                     // if it gets here the http return code was 200 (pz2 errors are 417)
 447                     // but the response was invalid, it should never occur
 448                     __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
 449             }
 450         );
 451     },
 452     // just for testing, probably shouldn't be here
 453     showNext: function(page)
 454     {
 455         var step = page || 1;
 456         __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
 457     },
 458     showPrev: function(page)
 459     {
 460         if (__myself.currentStart == 0 )
 461             return false;
 462         var step = page || 1;
 463         var newStart = __myself.currentStart - (step * __myself.currentNum );
 464         __myself.show( newStart > 0 ? newStart : 0 );
 465     },
 466     showPage: function(pageNum)
 467     {
 468         //var page = pageNum || 1;
 469         __myself.show(pageNum * __myself.currentNum);
 470     }
 471 };
 472 }