js/pz2.js

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