js/pz2.js

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