www/pz2_js/pz2.js

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