/*** ***
License
This software is published under the BSD license as listed below.
 
Copyright (c) 2007 pennycms.com

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

 . Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer. 

 . Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution. 

 . Neither the name of the pennycms.com nor the names of its contributors 
   may be used to endorse or promote products derived from this software without 
   specific prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*** ***/

/*
url-loading object and a request queue built on top of it
*/

/* namespacing object */
var net=new Object();

net.READY_STATE_UNINITIALIZED=0;
net.READY_STATE_LOADING=1;
net.READY_STATE_LOADED=2;
net.READY_STATE_INTERACTIVE=3;
net.READY_STATE_COMPLETE=4;

/*--- content loader object for cross-browser requests ---*/
net.ContentLoader=function(url,onload,params,is_synch,method,contentType,onerror){
	this.req=null;
	net.currentLoader=this;
	this.onload=onload;
	this.onerror=(onerror)?onerror:this.defaultError;
	this.is_synch=is_synch;
//	this.is_synch=window.XMLHttpRequest?false:is_synch;
	this.loadXMLDoc(url,method,params,contentType,is_synch);
}

net.ContentLoader.prototype.loadXMLDoc=function(url,method,params,contentType,is_synch){
	if (!method){
		method="POST";
	} else {
		method=method.toUpperCase()
	}
	if (!contentType && method=="POST"){
		contentType='application/x-www-form-urlencoded';
	}
	if (window.XMLHttpRequest){
		this.req=new XMLHttpRequest();
	} else if (window.ActiveXObject){
		this.req=new ActiveXObject("Microsoft.XMLHTTP");
		if (!this.req) {
			this.req=new ActiveXObject("Msxml2.XMLHTTP");
		}
	}
	if (params) {
		if (params.indexOf("&")!=0) {
			params = "&"+params;
		}
	} else {
		params="";
	}
	if (this.req){
		try{
			var loader=this;
			
			this.req.open(method,url,is_synch);
			this.req.onreadystatechange=function(){
				net.ContentLoader.onReadyState.call(loader);
			}
			if (contentType){
				this.req.setRequestHeader('Content-Type', contentType);
			}
			this.req.send(params);
			if (isFirefox) {
				net.ContentLoader.onReadyState.call(loader);
			}
		}catch (err){
			this.onerror.call(this);
		}
	}
}

net.ContentLoader.onReadyState=function(){
	var req=this.req;
	var ready=req.readyState;
	if (ready==net.READY_STATE_COMPLETE){
		var httpStatus=req.status;
		if(httpStatus==200 || httpStatus==0){
			this.onload.call(this);
		}else{
			this.onerror.call(this);
		}
	}
}

net.ContentLoader.prototype.defaultError=function(){
//	window.status="net.ContentLoader:Error fetching data!";
/*
	alert("net.ContentLoader:Error fetching data!"
		+"\n\nreadyState:"+this.req.readyState
		+"\nstatus: "+this.req.status
		+"\nheaders: "+this.req.getAllResponseHeaders()
		+"\nText: "+this.req.responseText
		);
*/
}

/*--- queue system for efficient transfer of many small commands in a single request ---*/
net.cmdQueues=new Array();

net.CommandQueue=function(id,url,onUpdate,freq){
	this.id=id;
	net.cmdQueues[id]=this;
	this.url=url;
	this.queued=new Array();
	this.sent=new Array();
	this.onUpdate=onUpdate;
	if (freq){
		this.repeat(freq);
	}
	this.lastUpdateTime=0;
}

net.CommandQueue.STATUS_QUEUED=-1;
net.CommandQueue.STATE_UNINITIALIZED=net.READY_STATE_UNINITIALIZED;
net.CommandQueue.STATE_LOADING=net.READY_STATE_LOADING;
net.CommandQueue.STATE_LOADED=net.READY_STATE_LOADED;
net.CommandQueue.STATE_INTERACTIVE=net.READY_STATE_INTERACTIVE;
net.CommandQueue.STATE_COMPLETE=net.READY_STATE_COMPLETE;
net.CommandQueue.STATE_PROCESSED=5;

net.CommandQueue.PRIORITY_NORMAL=0;
net.CommandQueue.PRIORITY_IMMEDIATE=1;

net.CommandQueue.prototype.addCommand=function(command){
	if (this.isCommand(command)){
		this.queue.append(command,true);
		if (command.priority==net.CommandQueue.PRIORITY_IMMEDIATE){
			this.fireRequest();
		}
	}
}

net.CommandQueue.prototype.fireRequest=function(){
	if (!this.onUpdate && this.queued.length==0){
		return;
	}
	var data="lastUpdate="+this.lastUpdateTime+"&data=";
	for(var i=0;i<this.queued.length;i++){
		var cmd=this.queued[i];
		if (this.isCommand(cmd)){
			data+=cmd.toRequestString();
			this.sent[cmd.id]=cmd;
		}
	}
	this.queued=new Array();
	this.loader=new net.ContentLoader(
		this.url,
		net.CommandQueue.onload,
		net.CommandQueue.onerror,
		"POST",data
	);
}

net.CommandQueue.prototype.isCommand=function(obj){
	return (
		obj.implementsProp("id")
		&& obj.implementsProp("priority")
		&& obj.implementsFunc("toRequestString")
		&& obj.implementsFunc("parseResponse")
	);
}

net.CommandQueue.onload=function(){
	var xmlDoc=this.req.responseXML;
	var elDocRoot=xmlDoc.getElementsByTagName("responses")[0];
	var lastUpdate=elDocRoot.attributes.getNamedItem("updateTime");
	if (parseInt(lastUpdate)>this.lastUpdateTime){
		this.lastUpdateTime=lastUpdate;
	}
	if (elDocRoot){
		for(i=0;i<elDocRoot.childNodes.length;i++){
			elChild=elDocRoot.childNodes[i];
			if (elChild.nodeType==1){
				if (elChild.tagName=="command"){
					var attrs=elChild.attributes;
					var id=attrs.getNamedItem("id").value;
					var command=net.commandQueue.sent[id];
					if (command){
						command.parseResponse(elChild);
					}
				}else if (elChild.tagName=="update"){
					if (this.implementsFunc("onUpdate")){
						this.onUpdate.call(this,elChild);
					}
				}
			}
		}
	}
}

net.CommandQueue.onerror=function(){
	alert("problem sending the data to the server");
}

net.CommandQueue.prototype.repeat=function(freq){
	this.unrepeat();
	if (freq>0){
		this.freq=freq;
		var cmd="net.cmdQueues["+this.id+"].fireRequest()";
		this.repeater=setInterval(cmd,freq*1000);
	}
}
net.CommandQueue.prototype.unrepeat=function(){
	if (this.repeater){
		clearInterval(this.repeater);
	}
	this.repeater=null;
}
