js/pz2.js

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