added five asserts to make sure that the arguments of reclist_insert do exist
[pazpar2-moved-to-github.git] / www / pz2_js / pz2.js
index e8924b0..84e9893 100644 (file)
@@ -1,24 +1,44 @@
-/* prevent execution of more than once */
+//since explorer is flawed
+if (!window['Node']) {
+    window.Node = new Object();
+    Node.ELEMENT_NODE = 1;
+    Node.ATTRIBUTE_NODE = 2;
+    Node.TEXT_NODE = 3;
+    Node.CDATA_SECTION_NODE = 4;
+    Node.ENTITY_REFERENCE_NODE = 5;
+    Node.ENTITY_NODE = 6;
+    Node.PROCESSING_INSTRUCTION_NODE = 7;
+    Node.COMMENT_NODE = 8;
+    Node.DOCUMENT_NODE = 9;
+    Node.DOCUMENT_TYPE_NODE = 10;
+    Node.DOCUMENT_FRAGMENT_NODE = 11;
+    Node.NOTATION_NODE = 12;
+}
+// check for jQuery
+if(typeof window.jQuery == "undefined"){
+    throw new Error("pz2.js requires jQuery library");
+}
+// prevent execution of more than once
 if(typeof window.pz2 == "undefined") {
 window.undefined = window.undefined;
 
-var pz2 = function(callbackArr, autoInit, keepAlive) {
+var pz2 = function(paramArray) {
     //for convenience
     __myself = this;
 
     // at least one callback required
-    if ( !callbackArr )
-        throw new Error("Callback parameters array has to be suplied when instantiating a class");   
+    if ( !paramArray )
+        throw new Error("An array with parameters has to be suplied when instantiating a class");   
     
     // function callbacks
-    __myself.statCallback = callbackArr.onstat || null;
-    __myself.showCallback = callbackArr.onshow || null;
-    __myself.termlistCallback = callbackArr.onterm || null;
-    __myself.recordCallback = callbackArr.onrecord || null;
-    __myself.bytargetCallback = callbackArr.onbytarget || null;
+    __myself.statCallback = paramArray.onstat || null;
+    __myself.showCallback = paramArray.onshow || null;
+    __myself.termlistCallback = paramArray.onterm || null;
+    __myself.recordCallback = paramArray.onrecord || null;
+    __myself.bytargetCallback = paramArray.onbytarget || null;
 
     // termlist keys
-    __myself.termKeys = callbackArr.termlist || "subject";
+    __myself.termKeys = paramArray.termlist || "subject";
     
     // some configurational stuff
     __myself.pz2String = "search.pz2";
@@ -29,8 +49,8 @@ var pz2 = function(callbackArr, autoInit, keepAlive) {
     __myself.pingStatusOK = false;
     __myself.searchStatusOK = false;
 
-    if ( keepAlive < __myself.keepAlive )
-        __myself.keepAlive = keepAlive;
+    if ( paramArray.keepAlive < __myself.keepAlive )
+        __myself.keepAlive = paramArray.keepAlive;
 
     // for sorting
     __myself.currentSort = "relevance";
@@ -44,13 +64,13 @@ var pz2 = function(callbackArr, autoInit, keepAlive) {
     __myself.currQuery = null;
 
     //timers
-    __myself.statTime = 2000;
+    __myself.statTime = paramArray.stattime || 2000;
     __myself.statTimer = null;
-    __myself.termTime = 1000;
+    __myself.termTime = paramArray.termtime || 2000;
     __myself.termTimer = null;
-    __myself.showTime = 1000;
+    __myself.showTime = paramArray.showtime || 2000;
     __myself.showTimer = null;
-    __myself.bytargetTime = 1000;
+    __myself.bytargetTime = paramArray.bytargettime || 1000;
     __myself.bytargetTimer = null;
 
     // active clients, updated by stat and show
@@ -65,9 +85,9 @@ var pz2 = function(callbackArr, autoInit, keepAlive) {
     });
     
     // auto init session?
-    if (autoInit !== false)
+    if (paramArray.autoInit !== false)
         __myself.init(__myself.keepAlive);
-}
+};
 pz2.prototype = {
     init: function(keepAlive) 
     {
@@ -85,7 +105,7 @@ pz2.prototype = {
                 else
                     // if it gets here the http return code was 200 (pz2 errors are 417)
                     // but the response was invalid, it should never occur
-                    setTimeout("__myself.init()", 1000)
+                    setTimeout("__myself.init()", 1000);
             }
         );
     },
@@ -106,11 +126,11 @@ pz2.prototype = {
                 else
                     // if it gets here the http return code was 200 (pz2 errors are 417)
                     // but the response was invalid, it should never occur
-                    setTimeout("__myself.ping()", 1000)
+                    setTimeout("__myself.ping()", 1000);
             }
         );
     },
-    search: function(query, num, sort)
+    search: function(query, num, sort, filter)
     {
         clearTimeout(__myself.statTimer);
         clearTimeout(__myself.showTimer);
@@ -124,18 +144,24 @@ pz2.prototype = {
             __myself.currQuery = query;
         else
             throw new Error("You need to supply query to the search command");
-        
+
+        if( filter !== undefined )
+            var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
+        else
+            var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
+
         $.get( __myself.pz2String,
-            { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery },
+            searchParams,
             function(data) {
                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
                     __myself.searchStatusOK = true;
                     //piggyback search
-                    __myself.show(0, num, sort)
+                    __myself.show(0, num, sort);
                     if ( __myself.statCallback )
                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
                     if ( __myself.termlistCallback )
-                        __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
+                        __myself.termlist();
+                        //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
                     if ( __myself.bytargetCallback )
                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
                 }
@@ -170,7 +196,7 @@ pz2.prototype = {
                     "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
                     "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
                     "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
-                    }
+                    };
                     __myself.statCallback(stat);
                     if (activeClients > 0)
                         __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime); 
@@ -178,7 +204,7 @@ pz2.prototype = {
                 else
                     // if it gets here the http return code was 200 (pz2 errors are 417)
                     // but the response was invalid, it should never occur
-                    __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4)
+                    __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
             }
         );
     },
@@ -211,7 +237,7 @@ pz2.prototype = {
                     "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
                     "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
                     "hits": []
-                    }
+                    };
                     // parse all the first-level nodes for all <hit> tags
                     var hits = data.getElementsByTagName("hit");
                     var hit = new Array();
@@ -254,7 +280,23 @@ pz2.prototype = {
                         if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
                             var nodeName = recordNode.childNodes[i].nodeName;
                             var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
-                            record[nodeName] = nodeText;
+                            record[nodeName] = nodeText;                            
+                        }
+                    }
+                    // the location is hard coded
+                    var locationNodes = recordNode.getElementsByTagName("location");
+                    record["location"] = new Array();
+                    for ( i = 0; i < locationNodes.length; i++ ) {
+                        record["location"][i] = {
+                            "id": locationNodes[i].getAttribute("id"),
+                            "name": locationNodes[i].getAttribute("name")
+                        };
+                        for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
+                            if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
+                                var nodeName = locationNodes[i].childNodes[j].nodeName;
+                                var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
+                                record["location"][i][nodeName] = nodeText;                            
+                            }
                         }
                     }
                     __myself.recordCallback(record);
@@ -277,7 +319,7 @@ pz2.prototype = {
             { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
             function(data) {
                 if ( data.getElementsByTagName("termlist") ) {
-                    var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) }
+                    var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) };
                     var termLists = data.getElementsByTagName("list");
                     //for each termlist
                     for (i = 0; i < termLists.length; i++) {
@@ -288,8 +330,13 @@ pz2.prototype = {
                         for (j = 0; j < terms.length; j++) { 
                             var term = {
                                 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
-                                "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue,
-                            }
+                                "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
+                            };
+
+                            var termIdNode = terms[j].getElementsByTagName("id");
+                            if(terms[j].getElementsByTagName("id").length)
+                                term["id"] = termIdNode[0].childNodes[0].nodeValue;
+
                             termList[listName][j] = term;
                         }
                     }
@@ -338,6 +385,25 @@ pz2.prototype = {
                     __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
             }
         );
+    },
+    // just for testing, probably shouldn't be here
+    showNext: function(page)
+    {
+        var step = page || 1;
+        __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );     
+    },
+    showPrev: function(page)
+    {
+        if (__myself.currentStart == 0 )
+            return false;
+        var step = page || 1;
+        var newStart = __myself.currentStart - (step * __myself.currentNum );
+        __myself.show( newStart > 0 ? newStart : 0 );
+    },
+    showPage: function(pageNum)
+    {
+        //var page = pageNum || 1;
+        __myself.show(pageNum * __myself.currentNum);
     }
 };
 }