js/pz2.js

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