-/* 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) {
- //
- if ( callbackArr == null )
- return null;
-
+var pz2 = function(paramArray) {
//for convenience
- myself = this;
+ __myself = this;
+
+ // at least one callback required
+ if ( !paramArray )
+ throw new Error("An array with parameters has to be suplied when instantiating a class");
- myself.pz2String = "search.pz2";
- myself.sessionID;
- myself.initStatus = 0;
- myself.pingStatus = 0;
- myself.keepAlive = 50000;
+ // function callbacks
+ __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 = paramArray.termlist || "subject";
+
+ // some configurational stuff
+ __myself.pz2String = "search.pz2";
+ __myself.keepAlive = 50000;
+
+ __myself.sessionID = null;
+ __myself.initStatusOK = false;
+ __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";
- myself.sortKeywords = [ "relevance", "title", "author" ];
-
- // function callbacks
- myself.statCallback = callbackArr.onstat;
- myself.showCallback = callbackArr.onshow;
- myself.termlistCallback = callbackArr.onterm;
+ __myself.currentSort = "relevance";
+ // where are we?
+ __myself.currentStart = 0;
+ __myself.currentNum = 20;
+
+ // last full record retrieved
+ __myself.currRecID = null;
+ // current query
+ __myself.currQuery = null;
//timers
- myself.statTime = 2000;
- myself.statTimer;
- myself.termTime = 1000;
- myself.termTimer;
- myself.showTime = 1000;
- myself.showTimer;
-
- if (autoInit == true)
- myself.init(myself.keepAlive);
-}
+ __myself.statTime = paramArray.stattime || 2000;
+ __myself.statTimer = null;
+ __myself.termTime = paramArray.termtime || 2000;
+ __myself.termTimer = null;
+ __myself.showTime = paramArray.showtime || 2000;
+ __myself.showTimer = null;
+ __myself.bytargetTime = paramArray.bytargettime || 1000;
+ __myself.bytargetTimer = null;
+
+ // active clients, updated by stat and show
+ // might be an issue since bytarget will poll accordingly
+ __myself.activeClients = 1;
+
+ // error handling
+ $(document).ajaxError(
+ function (request, settings, exception) {
+ if ( settings.responseXML && settings.responseXML.getElementsByTagName("error") )
+ throw new Error( settings.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue);
+ });
+
+ // auto init session?
+ if (paramArray.autoInit !== false)
+ __myself.init(__myself.keepAlive);
+};
pz2.prototype = {
- init: function(keepAlive) {
- if ( keepAlive < myself.keepAlive ) myself.keepAlive = keepAlive;
- $.get( myself.pz2String,
- { command: "init" },
+ init: function(keepAlive)
+ {
+ if ( keepAlive < __myself.keepAlive )
+ __myself.keepAlive = keepAlive;
+
+ $.get( __myself.pz2String,
+ { "command": "init" },
function(data) {
- if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" )
- myself.initStatus = 1;
- myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
- setTimeout(myself.ping, myself.keepAlive);
+ if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
+ __myself.initStatusOK = true;
+ __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
+ setTimeout(__myself.ping, __myself.keepAlive);
+ }
+ 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);
}
);
},
// no need to ping explicitly
- ping: function() {
- if( !myself.initStatus )
+ ping: function()
+ {
+ if( !__myself.initStatusOK )
return;
// session is not initialized code here
- $.get( myself.pz2String,
- { command: "ping", session: myself.sessionID },
+
+ $.get( __myself.pz2String,
+ { "command": "ping", "session": __myself.sessionID },
function(data) {
if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
- myself.pingStatus = 1;
- setTimeout(myself.ping, myself.keepAlive);
+ __myself.pingStatusOK = true;
+ setTimeout("__myself.ping()", __myself.keepAlive);
}
else
- location = "?";
+ // 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);
}
);
},
- search: function(query, num, sort) {
- clearTimeout(myself.statTimer);
- clearTimeout(myself.showTimer);
- clearTimeout(myself.termTimer);
- if( !myself.initStatus )
+ search: function(query, num, sort, filter)
+ {
+ clearTimeout(__myself.statTimer);
+ clearTimeout(__myself.showTimer);
+ clearTimeout(__myself.termTimer);
+ clearTimeout(__myself.bytargetTimer);
+
+ if( !__myself.initStatusOK )
return;
- $.get( myself.pz2String,
- { command: "search", session: myself.sessionID, query: query },
+
+ if( query !== undefined )
+ __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,
+ searchParams,
function(data) {
if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
- myself.searchStatus = 1;
+ __myself.searchStatusOK = true;
//piggyback search
- 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.show(0, num, sort);
+ if ( __myself.statCallback )
+ __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
+ if ( __myself.termlistCallback )
+ __myself.termlist();
+ //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
+ if ( __myself.bytargetCallback )
+ __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
}
else
- location = "?";
+ // 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.search(__myself.currQuery)", 1000);
}
);
},
- // callback, not to be called explicitly
- stat: function() {
- if( !myself.searchStatus )
+ stat: function()
+ {
+ if( !__myself.searchStatusOK )
return;
- $.get( myself.pz2String,
- { command: "stat", session: myself.sessionID },
+ // if called explicitly takes precedence
+ clearTimeout(__myself.statTimer);
+
+ $.get( __myself.pz2String,
+ { "command": "stat", "session": __myself.sessionID },
function(data) {
if ( data.getElementsByTagName("stat") ) {
var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
+ __myself.activeClients = activeClients;
var stat = {
"activeclients": activeClients,
"hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
"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);
+ };
+ __myself.statCallback(stat);
if (activeClients > 0)
- myself.statTimer = setTimeout(myself.stat, myself.statTime);
+ __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
}
else
- myself.statTimer = setTimeout(myself.stat, myself.statTime / 4)
- //location = "?";
- // some error handling
+ // 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);
}
);
},
- //callback not to be called explicitly
- show: function(start, num, sort) {
- clearTimeout(myself.showTimer);
- if( !myself.searchStatus )
+ show: function(start, num, sort)
+ {
+ if( !__myself.searchStatusOK )
return;
- if ( myself.sortKeywords.some( function(element, index, arr) { if (element == sort) return true; else return false; } ) )
- myself.currentSort = sort;
- $.get( myself.pz2String,
- { "command": "show", "session": myself.sessionID, "start": start, "num": num, "sort": myself.currentSort, "block": 1 },
+ // if called explicitly takes precedence
+ clearTimeout(__myself.showTimer);
+
+ if( sort !== undefined )
+ __myself.currentSort = sort;
+ if( start !== undefined )
+ __myself.currentStart = Number( start );
+ if( num !== undefined )
+ __myself.currentNum = Number( num );
+
+ $.get( __myself.pz2String,
+ { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
+ "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
function(data) {
if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
+ // first parse the status data send along with records
+ // this is strictly bound to the format
var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
var show = {
"activeclients": activeClients,
"merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
"total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
"start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
- "num": Number( data.getElementsByTagName("num")[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();
+ for (i = 0; i < hits.length; i++) {
+ show.hits[i] = new Array();
+ for ( j = 0; j < hits[i].childNodes.length; j++) {
+ if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
+ var nodeName = hits[i].childNodes[j].nodeName;
+ var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
+ show.hits[i][nodeName] = nodeText;
+ }
+ }
}
- //TODO include records
- myself.showCallback(show);
+ __myself.showCallback(show);
if (activeClients > 0)
- myself.showTimer = setTimeout("myself.show(" + start + "," + num + "," + sort + ")", myself.showTime);
+ __myself.showTimer = setTimeout("__myself.show()", __myself.showTime);
}
else
- myself.showTimer = setTimeout("myself.show(" + start + "," + num + "," + sort + ")", myself.showTime / 4);
- // location = "?";
- // some error handling
+ // if it gets here the http return code was 200 (pz2 errors are 417)
+ // but the response was invalid, it should never occur
+ __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
}
);
},
- record: function(id) {
+ record: function(id)
+ {
+ if( !__myself.searchStatusOK )
+ return;
+
+ if( id !== undefined )
+ __myself.currRecID = id;
+
+ $.get( __myself.pz2String,
+ { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
+ function(data) {
+ var recordNode;
+ var record = new Array();
+ if ( recordNode = data.getElementsByTagName("record")[0] ) {
+ for ( i = 0; i < recordNode.childNodes.length; i++) {
+ if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
+ var nodeName = recordNode.childNodes[i].nodeName;
+ var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
+ 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);
+ }
+ 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.record(__myself.currRecID)", 1000);
+ }
+ );
},
- termlist: function(name) {
- if( !myself.searchStatus )
+ termlist: function()
+ {
+ if( !__myself.searchStatusOK )
return;
- $.get( myself.pz2String,
- { "command": "termlist", "session": myself.sessionID, "name": "author" },
+ // if called explicitly takes precedence
+ clearTimeout(__myself.termTimer);
+
+ $.get( __myself.pz2String,
+ { "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++) {
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;
}
}
- myself.termlistCallback(termList);
+ __myself.termlistCallback(termList);
if (termList["activeclients"] > 0)
- myself.termTimer = setTimeout("myself.termlist(" + name + ")" , myself.termTime);
+ __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime);
}
else
- myself.termTimer = setTimeout("myself.termlist(" + name + ")" , myself.termTime / 4);
- //location = "?";
- // some error handling
+ // if it gets here the http return code was 200 (pz2 errors are 417)
+ // but the response was invalid, it should never occur
+ __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
}
);
},
- bytarget: function() {
+ bytarget: function()
+ {
+ if( !__myself.searchStatusOK )
+ return;
+ // if called explicitly takes precedence
+ clearTimeout(__myself.bytargetTimer);
+
+ $.get( __myself.pz2String,
+ { "command": "bytarget", "session": __myself.sessionID },
+ function(data) {
+ if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
+ var targetNodes = data.getElementsByTagName("target");
+ var bytarget = new Array();
+ for ( i = 0; i < targetNodes.length; i++) {
+ bytarget[i] = new Array();
+ for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
+ if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
+ var nodeName = targetNodes[i].childNodes[j].nodeName;
+ var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
+ bytarget[i][nodeName] = nodeText;
+ }
+ }
+ }
+ __myself.bytargetCallback(bytarget);
+ if ( __myself.activeClients > 0 )
+ __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
+ }
+ 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.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);
}
};
}
projects / pazpar2-moved-to-github.git / blobdiff