Application: gvSIG desktop

package org.gvsig.remoteclient;

/**

 * <p></p>

 * 

 */

public interface IRasterClient {

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2009 Iver T.I.  {{Task}}

*/

package org.gvsig.remoteclient.ogc;

import java.util.HashMap;

import java.util.Hashtable;

import java.util.Iterator;

public abstract class OGCServiceInformation {

	public String online_resource = null;

	protected HashMap operationsGet = new HashMap();

	protected HashMap operationsPost = new HashMap();

	/**

	 * @return Returns the online_resource.

	 */

	 public String getOnline_resource() {

		return online_resource;

	}

	 public abstract OGCClientOperation createOperation(String name);

	 public abstract OGCClientOperation createOperation(String name, String onlineResource);

	/**

	 * Add a new supported operation

	 * @param operation

	 * The operation to support

	 * @param protocol

	 * The HTTP protocol (Get or Post)

	 */

	public void addOperation(String operation, int protocol){

		if (protocol == OGCClientOperation.PROTOCOL_GET){

			operationsGet.put(operation, createOperation(operation));			

		}else if (protocol == OGCClientOperation.PROTOCOL_POST){

			operationsPost.put(operation, createOperation(operation));

		}

	}

	/**

	 * Add a new supported operation

	 * @param operation

	 * The operation to support

	 * @param protocol

	 * The HTTP protocol (Get or Post)

	 * @param onlineResource

	 * The online resource

	 */

	public void addOperation(String operation, int protocol, String onlineResource){

		if (protocol == OGCClientOperation.PROTOCOL_GET){

			operationsGet.put(operation, createOperation(operation, onlineResource));

		}else if (protocol == OGCClientOperation.PROTOCOL_POST){

			operationsPost.put(operation, createOperation(operation, onlineResource));

		}

	}

	/**

	 * Gest the online resource for a concrete operation

	 * @param operation

	 * The operation

	 * @param protocol

	 * The HTTP protocol (Get or Post)

	 * @return

	 * The online resource

	 */

	public String getOnlineResource(String operation, int protocol){

		OGCClientOperation op = null;

		if (protocol == OGCClientOperation.PROTOCOL_GET){

			op = (OGCClientOperation)operationsGet.get(operation);

		}else if (protocol == OGCClientOperation.PROTOCOL_POST){

			op = (OGCClientOperation)operationsPost.get(operation);

		}

		if ((op == null) ||

				(op.getOnlineResource() == null) || 

				(op.getOnlineResource().equals(""))){

			return null;

		}

		return op.getOnlineResource();

	}

	/**

	 * Gets the online resource for a concrete operation.

	 * The default protocol is GET

	 * @param operation

	 * The operation

	 * @return

	 * The online resource

	 */

	public String getOnlineResource(String operation){

		return getOnlineResource(operation, OGCClientOperation.PROTOCOL_GET);

	}

	/**

	 * Get a hash map with the supported operations

	 * @return

	 */

	public Hashtable getSupportedOperationsByName(){

		Hashtable operations = new Hashtable();

		Iterator getIt = operationsGet.keySet().iterator();

		while (getIt.hasNext()){

			String id = (String)getIt.next();

			OGCClientOperation operation = (OGCClientOperation)operationsGet.get(id);

			operations.put(operation.getOperationName(),

					operation.getOnlineResource());

		}

		return operations;

	}

	public boolean isOperationSupported(String operationName){

	    if (operationsGet.containsKey(operationName)){

	        return true;

	    }

	    if (operationsPost.containsKey(operationName)){

            return true;

        }

	    return false;

	}	

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2009 Iver T.I.  {{Task}}

*/

package org.gvsig.remoteclient.ogc;

import java.util.Hashtable;

public abstract class OGCClientOperation {

	public static final int PROTOCOL_UNDEFINED = -1;

	public static final int PROTOCOL_GET = 0;

	public static final int PROTOCOL_POST = 1;

	protected String operationName;

	protected String onlineResource;

	public OGCClientOperation(String operationName) {

		super();

		this.operationName = operationName;		

	}		

	public OGCClientOperation(String operationName, String onlineResource) {

		this.onlineResource = onlineResource;

		this.operationName = operationName;

	}	

	public abstract Hashtable getOperations(); 

	/**

	 * @return Returns the onlineResource.

	 */

	public String getOnlineResource() {

		return onlineResource;

	}

	/**

	 * @param onlineResource The onlineResource to set.

	 */

	public void setOnlineResource(String onlineResource) {

		this.onlineResource = onlineResource;

	}	

	/**

	 * @return Returns the operationName.

	 */

	public String getOperationName() {

		return operationName;

	}

	/**

	 * @param operationName The operationName to set.

	 */

	public void setOperationName(String operationName) {

		this.operationName = operationName;

	}		

}

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package org.gvsig.remoteclient.ogc;

import java.io.File;

import java.io.FileInputStream;

import java.io.IOException;

import org.kxml2.io.KXmlParser;

import org.xmlpull.v1.XmlPullParserException;

import org.gvsig.compat.CompatLocator;

import org.gvsig.compat.net.Downloader;

import org.gvsig.remoteclient.utils.CapabilitiesTags;

public abstract class OGCProtocolHandler {

    protected static final Downloader downloader = CompatLocator.getDownloader();

    /**

     * procotol handler name

     */

    protected String name;

    /**

     * protocol handler version

     */

    protected String version;

    /**

     * host of the WMS to connect

     */

    protected String host;

    /**

     *  port number of the comunication channel of the WMS to connect

     */

    protected String port;    

    /**

     * @return Returns the host.

     */

    public String getHost() {

        return host;

    }

    /**

     * @param host The host to set.

     */

    public void setHost(String host) {

        this.host = host;

    }

    /**

     * @return Returns the name.

     */

    public String getName() {

        return name;

    }

    /**

     * @param name The name to set.

     */

    public void setName(String name) {

        this.name = name;

    }

    /**

     * @return Returns the port.

     */

    public String getPort() {

        return port;

    }

    /**

     * @param port The port to set.

     */

    public void setPort(String port) {

        this.port = port;

    }

    /**

     * @return Returns the version.

     */

    public String getVersion() {

        return version;

    }

    /**

     * @param version The version to set.

     */

    public void setVersion(String version) {

        this.version = version;

    }

    /**

     * parses the data retrieved by the Capabilities XML document

     */

    public abstract boolean parseCapabilities(File f);

    public abstract OGCServiceInformation getServiceInformation();

    /**

     * Just for not repeat code. Gets the correct separator according 

     * to the server URL

     * @param h

     * @return

     */

    protected static String getSymbol(String h) {

        String symbol;

        if (h.indexOf("?")==-1) 

            symbol = "?";

        else if (h.indexOf("?")!=h.length()-1)

            symbol = "&";

        else

            symbol = "";

        return symbol;

    }  

    /**

     * Parse an operation into a DcpType tag

     * @param parser

     * The KXMLParser

     * @param operation

     * The WFS operation to parse

     * @throws IOException 

     * @throws XmlPullParserException 

     */

    protected void parserDcpType(KXmlParser parser, String operation) throws XmlPullParserException, IOException {        

        int currentTag;

        boolean end = false;

        currentTag = parser.next();

        while (!end) 

        {

            switch(currentTag)

            {

            case KXmlParser.START_TAG:

                if(parser.getName().compareTo(CapabilitiesTags.HTTP)==0){

                    parseHTTPTag(parser, operation);

                }	         

                break;

            case KXmlParser.END_TAG:

                if (parser.getName().compareTo(CapabilitiesTags.DCPTYPE) == 0)

                    end = true;

                break;

            case KXmlParser.TEXT:                   

                break;

            }

            if (!end){

                currentTag = parser.next();

            }

        }     

    }

    /**

     * Parse an operation into a HTTP tag

     * @param parser

     * The KXMLParser

     * @param operation

     * The WFS operation to parse

     * @throws IOException 

     * @throws XmlPullParserException 

     */

    protected void parseHTTPTag(KXmlParser parser, String operation) throws XmlPullParserException, IOException {        

        int currentTag;

        boolean end = false;

        currentTag = parser.next();

        int protocol = -1;

        while (!end) 

        {

            switch(currentTag)

            {

            case KXmlParser.START_TAG:

                String value = null;

                if(parser.getName().compareTo(CapabilitiesTags.GET)==0){

                    protocol = OGCClientOperation.PROTOCOL_GET;

                    addOperationByAttribute(parser, operation, protocol);

                }else if(parser.getName().compareTo(CapabilitiesTags.POST)==0){

                    protocol = OGCClientOperation.PROTOCOL_POST;

                    addOperationByAttribute(parser, operation, protocol);

                }else if(parser.getName().compareTo(CapabilitiesTags.ONLINERESOURCE)==0){

                    addOperationByAttribute(parser, operation, protocol);

                }				

                break;

            case KXmlParser.END_TAG:

                if (parser.getName().compareTo(CapabilitiesTags.HTTP) == 0)

                    end = true;

                break;

            case KXmlParser.TEXT:                   

                break;

            }

            if (!end){

                currentTag = parser.next();

            }

        }     

    }

    /**

     * Add an operation and the online resource 

     * @param parser

     * The parser

     * @param operation

     * The operation to add

     * @param protocol

     * The parser to add

     */

    protected void addOperationByAttribute(KXmlParser parser, String operation, int protocol){

        String value = null;

        if (protocol > -1){

            for (int i=0 ; i<parser.getAttributeCount() ; i++){

                if ((parser.getAttributeName(i).toUpperCase().compareTo(CapabilitiesTags.ONLINERESOURCE.toUpperCase()) == 0) ||

                    (parser.getAttributeName(i).equals(CapabilitiesTags.XLINK_HREF))){					

                    value = parser.getAttributeValue(i);

                }

            }								

            if (value == null){

                getServiceInformation().addOperation(operation, protocol);

            }else{

                getServiceInformation().addOperation(operation, protocol, value);

            }

        }  

    }

    /**

     * Copy the file in a byte array

     * @param file

     * The file to copy

     * @return

     * An array of bytes

     * @throws IOException

     */

    protected byte[] fileToBytes(File file) throws IOException{

        FileInputStream fis = null;

        byte[] bytes = null;

        try{

            fis = new FileInputStream(file);

            long length = file.length(); 

            bytes = new byte[(int)file.length()];

            int offset = 0;

            int numRead = 0; 

            while (offset < bytes.length && (numRead=fis.read(bytes, offset, bytes.length-offset)) >= 0) 

            { 

                offset += numRead; 

            }

        }catch (IOException e) {

            throw e;

        }finally{

            if (fis != null){

                fis.close();

            }

        }         

        return bytes;

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2009 Iver T.I.  {{Task}}

 */

package org.gvsig.remoteclient.ogc.request;

import java.io.File;

import java.io.IOException;

import java.net.ConnectException;

import java.net.MalformedURLException;

import java.net.URL;

import java.net.UnknownHostException;

import org.gvsig.compat.CompatLocator;

import org.gvsig.compat.lang.StringUtils;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.remoteclient.RemoteClientStatus;

import org.gvsig.remoteclient.ogc.OGCClientOperation;

import org.gvsig.remoteclient.ogc.OGCProtocolHandler;

import org.gvsig.remoteclient.utils.Utilities;

import org.gvsig.remoteclient.wfs.WFSOperation;

public abstract class OGCRequest {

	protected RemoteClientStatus status = null;

	protected OGCProtocolHandler protocolHandler = null;

	protected boolean isDeleted = false;

	protected static final String XMLTAG_STARTCHARACTER = "<";

	protected static final String XMLTAG_FINISHCHARACTER = "</";

	protected static final String XMLTAG_ENDCHARACTER = ">";

	private static final StringUtils stringUtils = CompatLocator.getStringUtils();

	public OGCRequest(RemoteClientStatus status, OGCProtocolHandler protocolHandler) {

		super();

		this.status = status;

		this.protocolHandler = protocolHandler;

	}	

	/**

	 * Send a request to the server.

	 * @return

	 * The server reply

	 * @throws IOException 

	 * @throws UnknownHostException 

	 * @throws ConnectException 

	 */

	public File sendRequest(ICancellable cancel) throws ConnectException, UnknownHostException, IOException{

		//if the status is null is because is a GetCapabilities operation

		if (status != null){

			if (status.getProtocol() != OGCClientOperation.PROTOCOL_UNDEFINED){

				if (status.getProtocol() == OGCClientOperation.PROTOCOL_GET){

					String onlineResource = protocolHandler.getHost();

					String symbol = getSymbol(onlineResource);

					onlineResource = onlineResource + symbol;

					return sendHttpGetRequest(onlineResource, cancel);

				}else{

					String onlineResource = protocolHandler.getHost();

					return sendHttpPostRequest(onlineResource);

				}

			}

		}

		//if exists an online resource for the GET operation

		String onlineResource = protocolHandler.getServiceInformation().getOnlineResource(getOperationName(), WFSOperation.PROTOCOL_GET);

		if (onlineResource != null){

			String symbol = getSymbol(onlineResource);

			onlineResource = onlineResource + symbol;

			return sendHttpGetRequest(onlineResource, cancel);

		}

		//if exists an online resource for the POST operation

		onlineResource =  protocolHandler.getServiceInformation().getOnlineResource(getOperationName(), WFSOperation.PROTOCOL_POST);

		if (onlineResource != null){

			return sendHttpPostRequest(onlineResource);

		}

		//If the online resource doesn't exist, it tries with the server URL and GET

		onlineResource = protocolHandler.getHost();

		String symbol = getSymbol(onlineResource);

		onlineResource = onlineResource + symbol;

		return sendHttpGetRequest(onlineResource, cancel);

	}

	protected abstract String getHttpGetRequest(String onlineResource);

	protected abstract String getHttpPostRequest(String onlineResource);

	protected abstract String getTempFilePrefix();

	protected abstract String getOperationName();

	protected abstract String getSchemaLocation();	

	/**

	 * @return the URL used in the HTTP get operation

	 * @throws MalformedURLException

	 */

	public URL getURL() throws MalformedURLException{

		String onlineResource = protocolHandler.getServiceInformation().getOnlineResource(getOperationName(), WFSOperation.PROTOCOL_GET);

		if (onlineResource != null){

			String symbol = getSymbol(onlineResource);

			onlineResource = onlineResource + symbol;

			return new URL(getHttpGetRequest(onlineResource));

		}

		//If the online resource doesn't exist, it tries with the server URL and GET

		onlineResource = protocolHandler.getHost();

		String symbol = getSymbol(onlineResource);

		onlineResource = onlineResource + symbol;

		return new URL(getHttpGetRequest(onlineResource));

	}

	/**

	 * Send a Http request using the get protocol

	 * @param onlineResource

	 * @return

	 * @throws ConnectException

	 * @throws UnknownHostException

	 * @throws IOException

	 */

	private File sendHttpGetRequest(String onlineResource, ICancellable cancel) throws ConnectException, UnknownHostException, IOException{

		URL url = new URL(stringUtils.replaceAll(getHttpGetRequest(onlineResource), " ", "%20"));

		if (isDeleted()){

			Utilities.removeURL(url);

		}

		return Utilities.downloadFile(url, getTempFilePrefix(), cancel);		

	}

	/**

	 * Send a Http request using the post protocol

	 * @param onlineResource

	 * @return

	 * @throws ConnectException

	 * @throws UnknownHostException

	 * @throws IOException

	 */

	private File sendHttpPostRequest(String onlineResource) throws ConnectException, UnknownHostException, IOException{

		URL url = new URL(onlineResource);

		String data = getHttpPostRequest(onlineResource);

		if (isDeleted()){

			Utilities.removeURL(url+data);

		}

		return Utilities.downloadFile(url, data, getTempFilePrefix(), null);		

	}

	/**

	 * Just for not repeat code. Gets the correct separator according 

	 * to the server URL

	 * @param h

	 * @return

	 */

	protected static String getSymbol(String h) {

		String symbol;

		if (h.indexOf("?")==-1) 

			symbol = "?";

		else if (h.indexOf("?")!=h.length()-1)

			symbol = "&";

		else

			symbol = "";

		return symbol;

	}

	public boolean isDeleted() {

		return isDeleted;

	}

	public void setDeleted(boolean isDeleted) {

		this.isDeleted = isDeleted;

	}

	protected String createXMLStartTag(String tagName){

	    return XMLTAG_STARTCHARACTER + tagName + XMLTAG_ENDCHARACTER;

	}

   protected String createXMLEndtTag(String tagName){

        return XMLTAG_FINISHCHARACTER + tagName + XMLTAG_ENDCHARACTER;

    }

}

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id$

* $Log$

* Revision 1.1  2006-05-12 07:15:45  jaume

* *** empty log message ***

*

* Revision 1.1  2006/05/11 17:18:06  jaume

* Un planificador, monitorizador, de descargas que trabaja en segundo plano

*

*

*/

package org.gvsig.remoteclient.taskplanning;

/**

 * A simple FIFO task planner. The tasks returned by this planner are executed

 * enterely. It does not issue another task until the current is finished. 

 * @author jaume

 *

 */

public class FIFOTaskPlanner implements ITaskPlanner {

	IQueue queue;

	/**

	 * Creates a new instance of FIFOTaskPlanner that will work against the

	 * queue passed as paramenter 

	 * @param queue, the IQueue to be planned

	 */

	public FIFOTaskPlanner(IQueue queue) {

		this.queue = queue;

	}

	public IRunnableTask nextTask() {

		synchronized (this) {

			return (IRunnableTask) queue.getTasks().remove(0);

		}

	}

	/**

	 * FIFO plans have no previous tasks so, null is always returned.

	 */

	public IRunnableTask previousTask() {

		return null;

	}

}

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id$

* $Log$

* Revision 1.2  2006-05-12 07:45:49  jaume

* some warnings removed

*

* Revision 1.1  2006/05/12 07:15:45  jaume

* *** empty log message ***

*

* Revision 1.1  2006/05/11 17:18:06  jaume

* Un planificador, monitorizador, de descargas que trabaja en segundo plano

*

*

*/

package org.gvsig.remoteclient.taskplanning;

/**

 * <p>

 * ITaskPlanner provides an interface to program your own task planning. It gives

 * you operations for pick a task from the queue according on the criteria that

 * you designed.<br>

 * </p>

 * <p>

 * The simplest implementation of ITaskPlanner would be a FIFO task planner (see

 * FIFOTaskPlanner.java) which takes jobs from a task queue in the same order

 * they were put. But any kind of planner is possible (SJF, LIFO, RoundRobin, etc.). 

 * </p>

 * @author jaume dominguez faus - jaume.dominguez@iver.es

 *

 */

public interface ITaskPlanner {

	/**

	 * Takes the next task to be executed.

	 * @return IRunnableTask representing the next task to be executed

	 */

	public IRunnableTask nextTask();

	/**

	 * Takes the previous executed task. Notice that it may or may not have

	 * sense for specific implementations. For example, in a FIFO-like planner,

	 * the task is taken from the queue, executed until it is finished and 

	 * removed from the queue. So, there is no previous task.

	 * 

	 * @return IRunnableTask representing the previous executed task, or null

	 * if none.

	 * @deprecated (probably this is unuseful and i'll remove it)

	 */

	public IRunnableTask previousTask();

}

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id$

* $Log$

* Revision 1.2  2006-05-16 17:10:27  jaume

* *** empty log message ***

*

* Revision 1.1  2006/05/12 07:15:45  jaume

* *** empty log message ***

*

* Revision 1.1  2006/05/11 17:18:06  jaume

* Un planificador, monitorizador, de descargas que trabaja en segundo plano

*

*

*/

package org.gvsig.remoteclient.taskplanning;

import java.util.Vector;

/**

 *  <p>

 *  You should write your own concrete Queue implementation to hold the tasks in

 *  a specific kind of queue.<br>

 *  </p>

 *  <p>

 *  Following the contract, you should also write a task planner that does what 

 *  you desire. Task planners are a concrete class of the ITaskPlanner that would 

 *  plannify which is the next, the previous,.. task to be done. However, if

 *  you don't want to write anything special, just guess a simple FIFO queue<br>

 *  </p>

 *  

 *  @author jaume dominguez faus - jaume.dominguez@iver.es

 *  @see ITaskPlanner

 */

public interface IQueue {

	/**

	 * Adds a new task to the queue. The place where the new task will be put its

	 * left to the concrete implementation of this interface.

	 * @param IRunnableTask task

	 */

	IRunnableTask put(IRunnableTask task);

	/**

	 * Returns the next task by calling the task planner's nextTask() method.

	 * @return IRunnableTask with the next task to be executed.

	 */

	IRunnableTask take();

	/**

	 * Returns true if the Queue has no (more) jobs to do.

	 * @return

	 */

	boolean isEmpty();

	/**

	 * Returns the task planner currently defined by this queue.

	 * @return ITaskPlanner

	 */

	ITaskPlanner getTaskPlanner();

	/**

	 * Sets the TaskPlanner that will decide which of the tasks in the queue will

	 * be executed next. A null value should represent a FIFO planner. 

	 * @param planner

	 */

	void setTaskPlanner(ITaskPlanner planner);

	/**

	 * Causes the execution of this queue to be paused. The task currently in execution

	 * finishes and after it the planner will not issue more tasks until resume() is

	 * invoked.

	 */

	void pause();

	/**

	 * Causes the execution of this queue to be resumed. The execution will continue

	 * with the next task issued by the planner. It has no effect if the queue was not

	 * paused yet. 

	 */

	void resume();

	/**

	 * Returns the set of tasks in a Vector (thread-safe).

	 * @return Vector containing the tasks in this queue.

	 */

	Vector getTasks();

}

/*

 * Created on 01-oct-2005

 */

package org.gvsig.remoteclient.taskplanning.retrieving;

import java.io.File;

import java.net.MalformedURLException;

import java.util.Hashtable;

import java.util.TreeMap;

import org.gvsig.remoteclient.taskplanning.IQueue;

/**

 * pa administrar les tasques (la hist?ria aquella

 *  de que hi haja una cola per a cada servidor)

 * @author Luis W. Sevilla (sevilla_lui@gva.es)

 */

public class RequestManager {

	private boolean debug = true;

	private static RequestManager instance;

	private TreeMap serversTable = new TreeMap();

	private RequestManager() {} // Avoid public instantiation

	public static RequestManager getInstance() {

		if (instance == null)

			instance = new RequestManager();

		return instance;

	}

	public URLRetrieveTask addURLRequest(URLRequest request, RetrieveListener listener) {

		try {

			// TODO canviar per a quetorne el Request antic, que la request guarde el

			// seu estat aix? com la llista de listeners

			File f = getPreviousDownloadedURLRequest(request);

			if (f!=null) {

				// The file was already requested and it is in the cache or

				// the download is in process

				// Overwrite the file name with the file in the cache's one.

				request.setFileName(f.getAbsolutePath());

				System.out.println(request.getUrl()+" is cached at '"+f.getAbsolutePath()+"'");

				// get this server's task queue

				RetrieveQueue serverQueue = (RetrieveQueue) getQueue(request.getHost());

				// Look up the previous cached jobs

				URLRetrieveTask workingTask = serverQueue.getURLPreviousRequest(request);

				if (workingTask == null) {

					// Task already done. Notify listener

					if (debug)

						System.err.println("done job found: "+request.getUrl());

					RetrieveEvent event = new RetrieveEvent();

					event.setType(RetrieveEvent.REQUEST_FINISHED);

					listener.transferEventReceived(event);

				} else {

					// The task is working yet, will register the listener

					// TODO no va b?... perqu? la cola va buidant-se molt r?pidament

					// per a fer que vaja tamb? hi hauria que registrar en cache

					// lo que s'est? baixant al principi de l'execute();

					if (debug)

						System.err.println("working job found: "+request.getUrl());

					workingTask.addRetrieveListener(listener);

				}

			} else {

				// Pick an unrepeatable fileName

				String host = request.getHost();

				String fileName = request.getFileName();

				File tempDir = new File(tempDirectoryPath);

				if (!tempDir.exists())

					tempDir.mkdir();

				String fileNamePrefix = tempDirectoryPath + 

											File.separator + host + 

											"-" ;

				if (fileName.startsWith(fileNamePrefix))

					fileName = fileName.substring(fileNamePrefix.length(), fileName.length());

				// get this server's task queue

				RetrieveQueue serverQueue = (RetrieveQueue) getQueue(request.getHost());

				fileName = fileNamePrefix + fileName;

				request.setFileName(fileName);

				// TODO

				// jo ac? comprovaria quin protocol, m?tode, host, etc... i crearia un

				// objecte que tractara la desc?rrega segons el m?tode que li toca.

				// algo en plan Strategy's

				//

				// per exemple si fem URLRetrieveTask una abstracta i tenim

				// 

				// GET de tota la vida

				// serverQueue.put(new HTTPGetRetrieveTask(request, listener));

				//

				// POST

				// serverQueue.put(new HTTPPostRetrieveTask(request, listener));

				//

				// FTP

				// serverQueue.put(new FTPRetrieveTask(request, listener));

				//

				// ????Xarxa local?????

				// serverQueue.put(new SMBRetrieveTask(request, listener));

				// Enqueue the request and the listener will be notified when done.

				URLRetrieveTask task = new URLRetrieveTask(request, listener);

				return (URLRetrieveTask) serverQueue.put(task);

			}

		} catch (MalformedURLException e) {

			e.printStackTrace();

		}

		return null;

	}

	private IQueue getQueue(String hostName) {

		RetrieveQueue queue = null;

		if (serversTable.containsKey(hostName))

			queue = (RetrieveQueue) serversTable.get(hostName);

		else {

			// crea la cola

			queue = new RetrieveQueue(hostName);

			// pone la cola del server en marcha.

		}

		return queue;

	}

	private Hashtable downloadedFiles;

	private final String tempDirectoryPath = System.getProperty("java.io.tmpdir")+"tmp-andami";

	/**

     * Remove an URL from the system cache. The file will remain in the file

     * system for further eventual uses.

     * @param request

     */

	public void removeURLRequest(URLRequest request) {

		if (downloadedFiles != null && downloadedFiles.containsKey(request))

			downloadedFiles.remove(request);

	}

	/**

     * Adds an URL to the table of downloaded files for further uses. If the URL

     * already exists in the table its filePath value is updated to the new one and

     * the old file itself is removed from the file system.

     * 

     * @param url

     * @param filePath

     */

    protected void addDownloadedURLRequest(URLRequest request, String filePath){

        if (downloadedFiles==null)

            downloadedFiles = new Hashtable();

        String fileName = (String) downloadedFiles.put(request, filePath);

        if (fileName!=null){

            File f = new File(fileName);

            if (f.exists())

                f.delete();

        }

    }

    /**

     * Returns the content of this URL as a file from the file system.<br>

     * <p>

     * If the URL has been already downloaded in this session and notified 

     * to the system using the static <b>Utilities.addDownloadedURL(URL)</b>

     * method, it can be restored faster from the file system avoiding to

     * download it again.

     * </p>

     * @param url

     * @return File containing this URL's content or null if no file was found.

     */

    private File getPreviousDownloadedURLRequest(URLRequest request){

        File f = null;

        if (downloadedFiles!=null && downloadedFiles.containsKey(request)){

            String filePath = (String) downloadedFiles.get(request);

            f = new File(filePath);

        }

        return f;

    }

}

/*

 * Created on 01-oct-2005

 */

package org.gvsig.remoteclient.taskplanning.retrieving;

/**

 * @author jaume dominguez faus - jaume.dominguez@iver.es

 * Luis W. Sevilla (sevilla_lui@gva.es)

 */

public class RetrieveEvent {

	public static final int NOT_STARTED = 0;

	public static final int CONNECTING = 1;

	public static final int TRANSFERRING = 2;

	public static final int REQUEST_FINISHED = 3;

	public static final int REQUEST_FAILED = 4;

	public static final int REQUEST_CANCELLED = 5;

	public static final int POSTPROCESSING = 6;

	/**

	 * redundant; use REQUEST_FAILED

	 * @deprecated ?

	 */

	public static final int ERROR = 11;

	private int eventType;

	public void setType(int type) {

		eventType = type;

	}

	public int getType() {

		return eventType;

	}

}

/*

 * Created on 01-oct-2005

 */

package org.gvsig.remoteclient.taskplanning.retrieving;

import java.util.Date;

import java.util.Vector;

import org.gvsig.remoteclient.taskplanning.FIFOTaskPlanner;

import org.gvsig.remoteclient.taskplanning.IQueue;

import org.gvsig.remoteclient.taskplanning.IRunnableTask;

import org.gvsig.remoteclient.taskplanning.ITaskPlanner;

/**

 * @author jaume dominguez faus - jaume.dominguez@iver.es

 * 		   Luis W. Sevilla (sevilla_lui@gva.es)

 */

public class RetrieveQueue implements IQueue {

	private String hostName;

	private Date startTime;

	private Vector tasks = new Vector();

	private boolean waiting;

	private ITaskPlanner taskPlanner;

	private Worker worker;

	/**

	 * 

	 */

	public RetrieveQueue(String hName) {

		hostName = hName;

		startTime = new Date();

		worker = new Worker();

		new Thread(worker).start();

	}

	public IRunnableTask put(IRunnableTask task) {

		tasks.add(task);

		if (waiting) {

			synchronized (this) {

				notifyAll();

			}

		}

		return task;

	}

	public IRunnableTask take() {

		if (tasks.isEmpty()) {

			synchronized (this) {

				waiting = true;

				try {

					wait();

				} catch (InterruptedException ie) {

					waiting = false;

				}

			}

		}

		return getTaskPlanner().nextTask() ;

	}

	public boolean isEmpty() {

		synchronized (this) {

			return tasks.isEmpty() && !worker.r.isRunning();

		}

	}

	public ITaskPlanner getTaskPlanner() {

		if (taskPlanner == null) {

			taskPlanner = new FIFOTaskPlanner(this);

		}

		return taskPlanner;

	}

	public void setTaskPlanner(ITaskPlanner planner) {

		taskPlanner = planner;

	}

	public void pause() {

		waiting = true;

	}

	public void resume() {

		waiting = false;

	}

	public Vector getTasks() {

		return tasks;

	}

	private class Worker implements Runnable {

		URLRetrieveTask r;

		int i = 0; 

		public void run() {

			while (true) {

				r = (URLRetrieveTask) take();

				r.execute();

			}

		}

	}

	protected URLRetrieveTask getURLPreviousRequest(URLRequest request) {

		// Is the one currently running?

		/*URLRetrieveTask aux = (URLRetrieveTask) worker.r;

		if (request.equals(aux.getRequest())) {

				return aux;

		}*/	

		// Is one of those in the queue?

		for (int i = 0; i < tasks.size(); i++) {

			URLRetrieveTask task = (URLRetrieveTask) tasks.get(i);