www/pz2_js/pz2.js

   1 // check for jQuery
   2 if(typeof window.jQuery == "undefined")
   3     throw new Error("pz2.js requires jQuery library");
   4 // prevent execution of more than once
   5 if(typeof window.pz2 == "undefined") {
   6 window.undefined = window.undefined;
   7
   8 var pz2 = function(paramArray) {
   9     //for convenience
  10     __myself = this;
  11
  12     // at least one callback required
  13     if ( !paramArray )
  14         throw new Error("An array with parameters has to be suplied when instantiating a class");
  15
  16     // function callbacks
  17     __myself.statCallback = paramArray.onstat || null;
  18     __myself.showCallback = paramArray.onshow || null;
  19     __myself.termlistCallback = paramArray.onterm || null;
  20     __myself.recordCallback = paramArray.onrecord || null;
  21     __myself.bytargetCallback = paramArray.onbytarget || null;
  22
  23     // termlist keys
  24     __myself.termKeys = paramArray.termlist || "subject";
  25
  26     // some configurational stuff
  27     __myself.pz2String = "search.pz2";
  28     __myself.keepAlive = 50000;
  29
  30     __myself.sessionID = null;
  31     __myself.initStatusOK = false;
  32     __myself.pingStatusOK = false;
  33     __myself.searchStatusOK = false;
  34
  35     if ( paramArray.keepAlive < __myself.keepAlive )
  36         __myself.keepAlive = paramArray.keepAlive;
  37
  38     // for sorting
  39     __myself.currentSort = "relevance";
  40     // where are we?
  41     __myself.currentStart = 0;
  42     __myself.currentNum = 20;
  43
  44     // last full record retrieved
  45     __myself.currRecID = null;
  46     // current query
  47     __myself.currQuery = null;
  48
  49     //timers
  50     __myself.statTime = paramArray.stattime || 2000;
  51     __myself.statTimer = null;
  52     __myself.termTime = paramArray.termtime || 1000;
  53     __myself.termTimer = null;
  54     __myself.showTime = paramArray.showtime || 1000;
  55     __myself.showTimer = null;
  56     __myself.bytargetTime = paramArray.bytargettime || 1000;
  57     __myself.bytargetTimer = null;
  58
  59     // active clients, updated by stat and show
  60     // might be an issue since bytarget will poll accordingly
  61     __myself.activeClients = 1;
  62
  63     // error handling
  64     $(document).ajaxError(
  65     function (request, settings, exception) {
  66         if ( settings.responseXML && settings.responseXML.getElementsByTagName("error") )
  67             throw new Error( settings.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue);
  68     });
  69
  70     // auto init session?
  71     if (paramArray.autoInit !== false)
  72         __myself.init(__myself.keepAlive);
  73 }
  74 pz2.prototype = {
  75     init: function(keepAlive)
  76     {
  77         if ( keepAlive < __myself.keepAlive )
  78             __myself.keepAlive = keepAlive;
  79
  80         $.get( __myself.pz2String,
  81             { "command": "init" },
  82             function(data) {
  83                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
  84                     __myself.initStatusOK = true;
  85                     __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
  86                     setTimeout(__myself.ping, __myself.keepAlive);
  87                 }
  88                 else
  89                     // if it gets here the http return code was 200 (pz2 errors are 417)
  90                     // but the response was invalid, it should never occur
  91                     setTimeout("__myself.init()", 1000)
  92             }
  93         );
  94     },
  95     // no need to ping explicitly
  96     ping: function()
  97     {
  98         if( !__myself.initStatusOK )
  99             return;
 100             // session is not initialized code here
 101
 102         $.get( __myself.pz2String,
 103             { "command": "ping", "session": __myself.sessionID },
 104             function(data) {
 105                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 106                     __myself.pingStatusOK = true;
 107                     setTimeout("__myself.ping()", __myself.keepAlive);
 108                 }
 109                 else
 110                     // if it gets here the http return code was 200 (pz2 errors are 417)
 111                     // but the response was invalid, it should never occur
 112                     setTimeout("__myself.ping()", 1000)
 113             }
 114         );
 115     },
 116     search: function(query, num, sort)
 117     {
 118         clearTimeout(__myself.statTimer);
 119         clearTimeout(__myself.showTimer);
 120         clearTimeout(__myself.termTimer);
 121         clearTimeout(__myself.bytargetTimer);
 122
 123         if( !__myself.initStatusOK )
 124             return;
 125
 126         if( query !== undefined )
 127             __myself.currQuery = query;
 128         else
 129             throw new Error("You need to supply query to the search command");
 130
 131         $.get( __myself.pz2String,
 132             { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery },
 133             function(data) {
 134                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 135                     __myself.searchStatusOK = true;
 136                     //piggyback search
 137                     __myself.show(0, num, sort)
 138                     if ( __myself.statCallback )
 139                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
 140                     if ( __myself.termlistCallback )
 141                         __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
 142                     if ( __myself.bytargetCallback )
 143                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
 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.search(__myself.currQuery)", 1000);
 149             }
 150         );
 151     },
 152     stat: function()
 153     {
 154         if( !__myself.searchStatusOK )
 155             return;
 156         // if called explicitly takes precedence
 157         clearTimeout(__myself.statTimer);
 158
 159         $.get( __myself.pz2String,
 160             { "command": "stat", "session": __myself.sessionID },
 161             function(data) {
 162                 if ( data.getElementsByTagName("stat") ) {
 163                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 164                     __myself.activeClients = activeClients;
 165                     var stat = {
 166                     "activeclients": activeClients,
 167                     "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
 168                     "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
 169                     "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
 170                     "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
 171                     "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
 172                     "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
 173                     "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
 174                     "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
 175                     "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
 176                     }
 177                     __myself.statCallback(stat);
 178                     if (activeClients > 0)
 179                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
 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                     __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4)
 185             }
 186         );
 187     },
 188     show: function(start, num, sort)
 189     {
 190         if( !__myself.searchStatusOK )
 191             return;
 192         // if called explicitly takes precedence
 193         clearTimeout(__myself.showTimer);
 194
 195         if( sort !== undefined )
 196             __myself.currentSort = sort;
 197         if( start !== undefined )
 198             __myself.currentStart = Number( start );
 199         if( num !== undefined )
 200             __myself.currentNum = Number( num );
 201
 202         $.get( __myself.pz2String,
 203             { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
 204               "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
 205             function(data) {
 206                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 207                     // first parse the status data send along with records
 208                     // this is strictly bound to the format
 209                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
 210                     var show = {
 211                     "activeclients": activeClients,
 212                     "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
 213                     "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
 214                     "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
 215                     "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
 216                     "hits": []
 217                     }
 218                     // parse all the first-level nodes for all <hit> tags
 219                     var hits = data.getElementsByTagName("hit");
 220                     var hit = new Array();
 221                     for (i = 0; i < hits.length; i++) {
 222                         show.hits[i] = new Array();
 223                         for ( j = 0; j < hits[i].childNodes.length; j++) {
 224                             if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 225                                 var nodeName = hits[i].childNodes[j].nodeName;
 226                                 var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
 227                                 show.hits[i][nodeName] = nodeText;
 228                             }
 229                         }
 230                     }
 231                     __myself.showCallback(show);
 232                     if (activeClients > 0)
 233                         __myself.showTimer = setTimeout("__myself.show()", __myself.showTime);
 234                 }
 235                 else
 236                     // if it gets here the http return code was 200 (pz2 errors are 417)
 237                     // but the response was invalid, it should never occur
 238                     __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
 239             }
 240         );
 241     },
 242     record: function(id)
 243     {
 244         if( !__myself.searchStatusOK )
 245             return;
 246
 247         if( id !== undefined )
 248             __myself.currRecID = id;
 249
 250         $.get( __myself.pz2String,
 251             { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
 252             function(data) {
 253                 var recordNode;
 254                 var record = new Array();
 255                 if ( recordNode = data.getElementsByTagName("record")[0] ) {
 256                     for ( i = 0; i < recordNode.childNodes.length; i++) {
 257                         if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
 258                             var nodeName = recordNode.childNodes[i].nodeName;
 259                             var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
 260                             record[nodeName] = nodeText;
 261                         }
 262                     }
 263                     // the location is hard coded
 264                     var locationNodes = recordNode.getElementsByTagName("location");
 265                     record["location"] = new Array();
 266                     for ( i = 0; i < locationNodes.length; i++ ) {
 267                         record["location"][i] = {
 268                             "id": locationNodes[i].getAttribute("id"),
 269                             "name": locationNodes[i].getAttribute("name")
 270                         };
 271                         for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
 272                             if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 273                                 var nodeName = locationNodes[i].childNodes[j].nodeName;
 274                                 var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
 275                                 record["location"][i][nodeName] = nodeText;
 276                             }
 277                         }
 278                     }
 279                     __myself.recordCallback(record);
 280                 }
 281                 else
 282                     // if it gets here the http return code was 200 (pz2 errors are 417)
 283                     // but the response was invalid, it should never occur
 284                     setTimeout("__myself.record(__myself.currRecID)", 1000);
 285             }
 286         );
 287     },
 288     termlist: function()
 289     {
 290         if( !__myself.searchStatusOK )
 291             return;
 292         // if called explicitly takes precedence
 293         clearTimeout(__myself.termTimer);
 294
 295         $.get( __myself.pz2String,
 296             { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
 297             function(data) {
 298                 if ( data.getElementsByTagName("termlist") ) {
 299                     var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) }
 300                     var termLists = data.getElementsByTagName("list");
 301                     //for each termlist
 302                     for (i = 0; i < termLists.length; i++) {
 303                         var listName = termLists[i].getAttribute('name');
 304                         termList[listName] = new Array();
 305                         var terms = termLists[i].getElementsByTagName('term');
 306                         //for each term in the list
 307                         for (j = 0; j < terms.length; j++) {
 308                             var term = {
 309                                 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
 310                                 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue,
 311                             }
 312                             termList[listName][j] = term;
 313                         }
 314                     }
 315                     __myself.termlistCallback(termList);
 316                     if (termList["activeclients"] > 0)
 317                         __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime);
 318                 }
 319                 else
 320                     // if it gets here the http return code was 200 (pz2 errors are 417)
 321                     // but the response was invalid, it should never occur
 322                     __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
 323             }
 324         );
 325
 326     },
 327     bytarget: function()
 328     {
 329         if( !__myself.searchStatusOK )
 330             return;
 331         // if called explicitly takes precedence
 332         clearTimeout(__myself.bytargetTimer);
 333
 334         $.get( __myself.pz2String,
 335             { "command": "bytarget", "session": __myself.sessionID },
 336             function(data) {
 337                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
 338                     var targetNodes = data.getElementsByTagName("target");
 339                     var bytarget = new Array();
 340                     for ( i = 0; i < targetNodes.length; i++) {
 341                         bytarget[i] = new Array();
 342                         for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
 343                             if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
 344                                 var nodeName = targetNodes[i].childNodes[j].nodeName;
 345                                 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
 346                                 bytarget[i][nodeName] = nodeText;
 347                             }
 348                         }
 349                     }
 350                     __myself.bytargetCallback(bytarget);
 351                     if ( __myself.activeClients > 0 )
 352                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
 353                 }
 354                 else
 355                     // if it gets here the http return code was 200 (pz2 errors are 417)
 356                     // but the response was invalid, it should never occur
 357                     __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
 358             }
 359         );
 360     },
 361     // just for testing, probably shouldn't be here
 362     showNext: function(page)
 363     {
 364         var step = page || 1;
 365         __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
 366     },
 367     showPrev: function(page)
 368     {
 369         if (__myself.currentStart == 0 )
 370             return false;
 371         var step = page || 1;
 372         var newStart = __myself.currentStart - (step * __myself.currentNum );
 373         __myself.show( newStart > 0 ? newStart : 0 );
 374     }
 375 };
 376 }