src/main/org/apache/tools/ant/taskdefs/Get.java - ant - Git at Google

 /*
  * The Apache Software License, Version 1.1
  *
  * Copyright (c) 1999 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. 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.
  *
  * 3. The end-user documentation included with the redistribution, if
  *    any, must include the following acknowlegement:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowlegement may appear in the software itself,
  *    if and wherever such third-party acknowlegements normally appear.
  *
  * 4. The names "The Jakarta Project", "Ant", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
  *    from this software without prior written permission. For written
  *    permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache"
  *    nor may "Apache" appear in their names without prior written
  *    permission of the Apache Group.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
  * ITS 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.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  */

 package org.apache.tools.ant.taskdefs;

 import java.io.*;
 import java.net.*;
 import java.util.*;
 import org.apache.tools.ant.*;

 /**
  * Get a particular file from a URL source.
  * Options include verbose reporting, timestamp based fetches and controlling
  * actions on failures. NB: access through a firewall only works if the whole
  * Java runtime is correctly configured.
  *
  * @author costin@dnt.ro
  */
 public class Get extends Task {
     private URL source; // required
     private File dest; // required
     private boolean verbose = false;
     private boolean useTimestamp = false; //off by default
     private boolean ignoreErrors = false;

     /**
      * Does the work.
      *
      * @exception BuildException Thrown in unrecoverable error.
      */
     public void execute() throws BuildException {
         if (source == null) {
             throw new BuildException("src attribute is required", location);
         }

         if (dest == null) {
             throw new BuildException("dest attribute is required", location);
         }

         if (dest.exists() && dest.isDirectory()) {
             throw new BuildException("The specified destination is a directory",
                                      location);
         }

         if (dest.exists() && !dest.canWrite()) {
             throw new BuildException("Can't write to " + dest.getAbsolutePath(),
                                      location);
         }

         try {

             log("Getting: " + source);

             //set the timestamp to the file date.
             long timestamp=0;

             boolean hasTimestamp=false;
             if(useTimestamp && dest.exists()) {
                 timestamp=dest.lastModified();
                 if (verbose)  {
                     Date t=new Date(timestamp);
                     log("local file date : "+t.toString());
                 }

                 hasTimestamp=true;
             }

             //set up the URL connection
             URLConnection connection=source.openConnection();
             //modify the headers
             //NB: things like user authentication could go in here too.
             if(useTimestamp && hasTimestamp) {
                 connection.setIfModifiedSince(timestamp);
             }

             //connect to the remote site (may take some time)
             connection.connect();
             //next test for a 304 result (HTTP only)
             if(connection instanceof HttpURLConnection)  {
                 HttpURLConnection httpConnection=(HttpURLConnection)connection;
                 if(httpConnection.getResponseCode()==HttpURLConnection.HTTP_NOT_MODIFIED)  {
                     //not modified so no file download. just return instead
                     //and trace out something so the user doesn't think that the
                     //download happened when it didnt
                     log("Not modified - so not downloaded");
                     return;
                 }
             }

             //REVISIT: at this point even non HTTP connections may support the if-modified-since
             //behaviour -we just check the date of the content and skip the write if it is not
             //newer. Some protocols (FTP) dont include dates, of course.

             FileOutputStream fos = new FileOutputStream(dest);

             InputStream is=null;
             for( int i=0; i< 3 ; i++ ) {
                 try {
                     is = connection.getInputStream();
                     break;
                 } catch( IOException ex ) {
                     log( "Error opening connection " + ex );
                 }
             }
             if( is==null ) {
                 log( "Can't get " + source + " to " + dest);
                 if(ignoreErrors)
                     return;
                 throw new BuildException( "Can't get " + source + " to " + dest,
                                           location);
             }

             byte[] buffer = new byte[100 * 1024];
             int length;

             while ((length = is.read(buffer)) >= 0) {
                 fos.write(buffer, 0, length);
                 if (verbose) System.out.print(".");
             }
             if(verbose) System.out.println();
             fos.close();
             is.close();

             //if (and only if) the use file time option is set, then the
             //saved file now has its timestamp set to that of the downloaded file
             if(useTimestamp)  {
                 long remoteTimestamp=connection.getLastModified();
                 if (verbose)  {
                     Date t=new Date(remoteTimestamp);
                     log("last modified = "+t.toString()
                         +((remoteTimestamp==0)?" - using current time instead":""));
                 }
                 if(remoteTimestamp!=0)
                     touchFile(dest,remoteTimestamp);
             }


         } catch (IOException ioe) {
             log("Error getting " + source + " to " + dest );
             if(ignoreErrors)
                 return;
             throw new BuildException(ioe, location);
         }
     }

     /**
      * set the timestamp of a named file to a specified time.
      *
      * @param filename
      * @param time in milliseconds since the start of the era
      * @return true if it succeeded. False means that this is a
      * java1.1 system and that file times can not be set
      *@exception BuildException Thrown in unrecoverable error. Likely
      *this comes from file access failures.
      */
     protected boolean touchFile(File file, long timemillis)
         throws BuildException  {

         if (project.getJavaVersion() != Project.JAVA_1_1) {
             Touch touch = (Touch) project.createTask("touch");
             touch.setOwningTarget(target);
             touch.setTaskName(getTaskName());
             touch.setLocation(getLocation());
             touch.setFile(file);
             touch.setMillis(timemillis);
             touch.touch();
             return true;

         } else {
             return false;
         }
     }

     /**
      * Set the URL.
      *
      * @param u URL for the file.
      */
     public void setSrc(URL u) {
         this.source = u;
     }

     /**
      * Where to copy the source file.
      *
      * @param dest Path to file.
      */
     public void setDest(File dest) {
         this.dest = dest;
     }

     /**
      * Be verbose, if set to "<CODE>true</CODE>".
      *
      * @param v if "true" then be verbose
      */
     public void setVerbose(boolean v) {
         verbose = v;
     }

     /**
      * Don't stop if get fails if set to "<CODE>true</CODE>".
      *
      * @param v if "true" then don't report download errors up to ant
      */
     public void setIgnoreErrors(boolean v) {
         ignoreErrors = v;
     }

     /**
      * Use timestamps, if set to "<CODE>true</CODE>".
      *
      * <p>In this situation, the if-modified-since header is set so that the file is
      * only fetched if it is newer than the local file (or there is no local file)
      * This flag is only valid on HTTP connections, it is ignored in other cases.
      * When the flag is set, the local copy of the downloaded file will also
      * have its timestamp set to the remote file time.
      * <br>
      * Note that remote files of date 1/1/1970 (GMT) are treated as 'no timestamp', and
      * web servers often serve files with a timestamp in the future by replacing their timestamp
      * with that of the current time. Also, inter-computer clock differences can cause no end of
      * grief.
      * @param v "true" to enable file time fetching
      */
     public void setUseTimestamp(boolean v) {
         if (project.getJavaVersion() != Project.JAVA_1_1) {
             useTimestamp = v;
         }
     }

 }
	/*
	* The Apache Software License, Version 1.1
	*
	* Copyright (c) 1999 The Apache Software Foundation. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. 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.
	*
	* 3. The end-user documentation included with the redistribution, if
	* any, must include the following acknowlegement:
	* "This product includes software developed by the
	* Apache Software Foundation (http://www.apache.org/)."
	* Alternately, this acknowlegement may appear in the software itself,
	* if and wherever such third-party acknowlegements normally appear.
	*
	* 4. The names "The Jakarta Project", "Ant", and "Apache Software
	* Foundation" must not be used to endorse or promote products derived
	* from this software without prior written permission. For written
	* permission, please contact apache@apache.org.
	*
	* 5. Products derived from this software may not be called "Apache"
	* nor may "Apache" appear in their names without prior written
	* permission of the Apache Group.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
	* ITS 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.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Apache Software Foundation. For more
	* information on the Apache Software Foundation, please see
	* <http://www.apache.org/>.
	*/

	package org.apache.tools.ant.taskdefs;

	import java.io.*;
	import java.net.*;
	import java.util.*;
	import org.apache.tools.ant.*;

	/**
	* Get a particular file from a URL source.
	* Options include verbose reporting, timestamp based fetches and controlling
	* actions on failures. NB: access through a firewall only works if the whole
	* Java runtime is correctly configured.
	*
	* @author costin@dnt.ro
	*/
	public class Get extends Task {
	private URL source; // required
	private File dest; // required
	private boolean verbose = false;
	private boolean useTimestamp = false; //off by default
	private boolean ignoreErrors = false;

	/**
	* Does the work.
	*
	* @exception BuildException Thrown in unrecoverable error.
	*/
	public void execute() throws BuildException {
	if (source == null) {
	throw new BuildException("src attribute is required", location);
	}

	if (dest == null) {
	throw new BuildException("dest attribute is required", location);
	}

	if (dest.exists() && dest.isDirectory()) {
	throw new BuildException("The specified destination is a directory",
	location);
	}

	if (dest.exists() && !dest.canWrite()) {
	throw new BuildException("Can't write to " + dest.getAbsolutePath(),
	location);
	}

	try {

	log("Getting: " + source);

	//set the timestamp to the file date.
	long timestamp=0;

	boolean hasTimestamp=false;
	if(useTimestamp && dest.exists()) {
	timestamp=dest.lastModified();
	if (verbose) {
	Date t=new Date(timestamp);
	log("local file date : "+t.toString());
	}

	hasTimestamp=true;
	}

	//set up the URL connection
	URLConnection connection=source.openConnection();
	//modify the headers
	//NB: things like user authentication could go in here too.
	if(useTimestamp && hasTimestamp) {
	connection.setIfModifiedSince(timestamp);
	}

	//connect to the remote site (may take some time)
	connection.connect();
	//next test for a 304 result (HTTP only)
	if(connection instanceof HttpURLConnection) {
	HttpURLConnection httpConnection=(HttpURLConnection)connection;
	if(httpConnection.getResponseCode()==HttpURLConnection.HTTP_NOT_MODIFIED) {
	//not modified so no file download. just return instead
	//and trace out something so the user doesn't think that the
	//download happened when it didnt
	log("Not modified - so not downloaded");
	return;
	}
	}

	//REVISIT: at this point even non HTTP connections may support the if-modified-since
	//behaviour -we just check the date of the content and skip the write if it is not
	//newer. Some protocols (FTP) dont include dates, of course.

	FileOutputStream fos = new FileOutputStream(dest);

	InputStream is=null;
	for( int i=0; i< 3 ; i++ ) {
	try {
	is = connection.getInputStream();
	break;
	} catch( IOException ex ) {
	log( "Error opening connection " + ex );
	}
	}
	if( is==null ) {
	log( "Can't get " + source + " to " + dest);
	if(ignoreErrors)
	return;
	throw new BuildException( "Can't get " + source + " to " + dest,
	location);
	}

	byte[] buffer = new byte[100 * 1024];
	int length;

	while ((length = is.read(buffer)) >= 0) {
	fos.write(buffer, 0, length);
	if (verbose) System.out.print(".");
	}
	if(verbose) System.out.println();
	fos.close();
	is.close();

	//if (and only if) the use file time option is set, then the
	//saved file now has its timestamp set to that of the downloaded file
	if(useTimestamp) {
	long remoteTimestamp=connection.getLastModified();
	if (verbose) {
	Date t=new Date(remoteTimestamp);
	log("last modified = "+t.toString()
	+((remoteTimestamp==0)?" - using current time instead":""));
	}
	if(remoteTimestamp!=0)
	touchFile(dest,remoteTimestamp);
	}



	} catch (IOException ioe) {
	log("Error getting " + source + " to " + dest );
	if(ignoreErrors)
	return;
	throw new BuildException(ioe, location);
	}
	}

	/**
	* set the timestamp of a named file to a specified time.
	*
	* @param filename
	* @param time in milliseconds since the start of the era
	* @return true if it succeeded. False means that this is a
	* java1.1 system and that file times can not be set
	*@exception BuildException Thrown in unrecoverable error. Likely
	*this comes from file access failures.
	*/
	protected boolean touchFile(File file, long timemillis)
	throws BuildException {

	if (project.getJavaVersion() != Project.JAVA_1_1) {
	Touch touch = (Touch) project.createTask("touch");
	touch.setOwningTarget(target);
	touch.setTaskName(getTaskName());
	touch.setLocation(getLocation());
	touch.setFile(file);
	touch.setMillis(timemillis);
	touch.touch();
	return true;

	} else {
	return false;
	}
	}

	/**
	* Set the URL.
	*
	* @param u URL for the file.
	*/
	public void setSrc(URL u) {
	this.source = u;
	}

	/**
	* Where to copy the source file.
	*
	* @param dest Path to file.
	*/
	public void setDest(File dest) {
	this.dest = dest;
	}

	/**
	* Be verbose, if set to "<CODE>true</CODE>".
	*
	* @param v if "true" then be verbose
	*/
	public void setVerbose(boolean v) {
	verbose = v;
	}

	/**
	* Don't stop if get fails if set to "<CODE>true</CODE>".
	*
	* @param v if "true" then don't report download errors up to ant
	*/
	public void setIgnoreErrors(boolean v) {
	ignoreErrors = v;
	}

	/**
	* Use timestamps, if set to "<CODE>true</CODE>".
	*
	* <p>In this situation, the if-modified-since header is set so that the file is
	* only fetched if it is newer than the local file (or there is no local file)
	* This flag is only valid on HTTP connections, it is ignored in other cases.
	* When the flag is set, the local copy of the downloaded file will also
	* have its timestamp set to the remote file time.
	* <br>
	* Note that remote files of date 1/1/1970 (GMT) are treated as 'no timestamp', and
	* web servers often serve files with a timestamp in the future by replacing their timestamp
	* with that of the current time. Also, inter-computer clock differences can cause no end of
	* grief.
	* @param v "true" to enable file time fetching
	*/
	public void setUseTimestamp(boolean v) {
	if (project.getJavaVersion() != Project.JAVA_1_1) {
	useTimestamp = v;
	}
	}

	}