ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dona...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/types ZipFileSet.java ZipScanner.java
Date Tue, 16 Jan 2001 13:21:57 GMT
donaldp     01/01/16 05:21:57

  Added:       src/main/org/apache/tools/ant/types ZipFileSet.java
                        ZipScanner.java
  Log:
  Addition of ZipFileset facilities. Descibed by the author
  ---
   With these patches, Zip (and derivative tasks such as Jar and War) can
   merge the entries of multiple zip files into a single output zip file.
   The contents of an input zip file may be selectively extracted based on
   include/exclude patterns.
  
   An included zip file is specified using a <fileset> with a "src" attribute,
   as in:
  
     <target name="jartest">
         <jar jarfile="utils.jar">
           <fileset
         src="weblogic.jar"
         includes="weblogic/utils/"
         excludes="weblogic/utils/jars/,**/reflect/"
           />
          </jar>
      </target>
  
   In this example, a subset of the "weblogic/utils" directory is extracted
   from weblogic.jar, into utils.jar.
  
   The fileset may also contain "prefix" and "fullpath" attributes (the
   functionality of PrefixedFileSet has been retained in the new class
   ZipFileSet).  Prefixes apply to directory-based and zip-based filesets.
   The fullpath attributes applies only to a single file in a directory-based
   fileset.
  
   The War task may extract entries from a zip file for all of its filesets
   (including the files in "classes" and "lib").
  
   The motivation for this change is:
   1) There is significant overlap between "jlink" and "zip", and it seemed
      better to combine them.
   2) "jlink" does not support include/exclude patterns which are extremely
      useful for writing packaging-type tasks such as Zip/Jar/War.  This
      was my main motivation.
   3) By adding this functionality to the base task, it can also be used in
      derivative tasks such as Jar and War.
  ---
  Submitted By: Don Ferguson <don@bea.com>
  
  Revision  Changes    Path
  1.1                  jakarta-ant/src/main/org/apache/tools/ant/types/ZipFileSet.java
  
  Index: ZipFileSet.java
  ===================================================================
  /*
   * 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.types;
  
  import java.io.File;
  import java.util.Stack;
  import org.apache.tools.ant.BuildException;
  import org.apache.tools.ant.DirectoryScanner;
  import org.apache.tools.ant.Project;
  
  /**
   * A ZipFileSet is a FileSet with extra attributes useful in the context of 
   * Zip/Jar tasks.
   *
   * A ZipFileSet extends FileSets with the ability to extract a subset of the
   * entries of a Zip file for inclusion in another Zip file.  It also includes
   * a prefix attribute which is prepended to each entry in the output Zip file.
   *
   * At present, ZipFileSets are not surfaced in the public API.  FileSets
   * nested in a Zip task are instantiated as ZipFileSets, and their attributes
   * are only recognized in the context of the the Zip task.
   * It is not possible to define a ZipFileSet outside of the Zip task and
   * refer to it via a refid.  However a standard FileSet may be included by
   * reference in the Zip task, and attributes in the refering ZipFileSet
   * can augment FileSet definition.
   *
   * @author Don Ferguson <a href="mailto:don@bea.com">don@bea.com</a>
   */
  public class ZipFileSet extends FileSet {
  
      private String srcFileName = null;
      private String prefix         = "";
      private String fullpath       = "";
      private boolean hasDir        = false;
  
      /**
       * Set the directory for the fileset.  Prevents both "dir" and "src"
       * from being specified.
       */
      public void setDir(File dir) throws BuildException {
          if (srcFileName != null) {
              throw new BuildException("Cannot set both dir and src attributes");
          } else {
              super.setDir(dir);
              hasDir = true;
          }
      }
  
      /**
       * Set the source Zip file for the zipfileset.  Prevents both "dir" and "src"
       * from being specified.
       *
       * @param srcFileName The zip file from which to extract entries.
       */
      public void setSrc(String srcFileName) {
          if (hasDir) {
              throw new BuildException("Cannot set both dir and src attributes");
          }
          this.srcFileName = srcFileName;
      }
  
      /**
       * Get the zip file from which entries will be extracted.
       * References are not followed, since it is not possible
       * to have a reference to a ZipFileSet, only to a FileSet.
       */
      public String getSrc() {
          return srcFileName;
      }
  
      /**
       * Prepend this prefix to the path for each zip entry.
       * Does not perform reference test; the referenced file set
       * can be augmented with a prefix.
       *
       * @param prefix The prefix to prepend to entries in the zip file.
       */
      public void setPrefix(String prefix) {
          this.prefix = prefix;
      }
  
      /**
       * Return the prefix prepended to entries in the zip file.
       */
      public String getPrefix() {
          return prefix;
      }
  
      /**
       * Set the full pathname of the single entry in this fileset.
       *
       * @param prefix The prefix to prepend to entries in the zip file.
       */
      public void setFullpath(String fullpath) {
          this.fullpath = fullpath;
      }
  
      /**
       * Return the full pathname of the single entry in this fileset.
       */
      public String getFullpath() {
          return fullpath;
      }
  
      /**
       * Return the DirectoryScanner associated with this FileSet.
       * If the ZipFileSet defines a source Zip file, then a ZipScanner
       * is returned instead.
       */
      public DirectoryScanner getDirectoryScanner(Project p) {
          if (isReference()) {
              return getRef(p).getDirectoryScanner(p);
          }
          if (srcFileName != null) {
              ZipScanner zs = new ZipScanner();
              zs.setSrc(srcFileName);
              if (getDir(p) == null) {
                  super.setDir(new File("."));
              }
              setupDirectoryScanner(zs, p);
              zs.init();
              return zs;
          } else {
              return super.getDirectoryScanner(p);
          }
      }    
    
      /**
       * Performs the check for circular references and returns the
       * referenced FileSet.  
       */
      private FileSet getRef(Project p) {
          if (!checked) {
              Stack stk = new Stack();
              stk.push(this);
              dieOnCircularReference(stk, p);
          }
          
          Object o = ref.getReferencedObject(p);
          if (!(o instanceof FileSet)) {
              String msg = ref.getRefId()+" doesn\'t denote a fileset";
              throw new BuildException(msg);
          } else {
              return (FileSet) o;
          }
      }
      
  }
  
  
  
  1.1                  jakarta-ant/src/main/org/apache/tools/ant/types/ZipScanner.java
  
  Index: ZipScanner.java
  ===================================================================
  /*
   * 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.types;
  
  import org.apache.tools.ant.DirectoryScanner;
  import java.io.File;
  
  /**
   * ZipScanner accesses the pattern matching algorithm in DirectoryScanner,
   * which are protected methods that can only be accessed by subclassing.
   *
   * This implementation of FileScanner defines getIncludedFiles to return
   * only the Zip File which is being scanned, not the matching Zip entries.
   * Arguably, it should return the matching entries, however this would
   * complicate existing code which assumes that FileScanners return a
   * set of file system files that can be accessed directly.
   * 
   * @author Don Ferguson <a href="mailto:don@bea.com">don@bea.com</a>
   */
  public class ZipScanner extends DirectoryScanner {
  
      /**
       * The zip file which should be scanned.
       */
      protected String srcFile;
  
      /**
       * Sets the srcFile for scanning. This is the jar or zip file that is scanned
       * for matching entries.
       *
       * @param srcFile the (non-null) zip file name for scanning
       */
      public void setSrc(String srcFile) {
          this.srcFile = srcFile;
      }
  
      /**
       * Returns the zip file itself, not the matching entries within the zip file.
       * This keeps the uptodate test in the Zip task simple; otherwise we'd need
       * to treat zip filesets specially.
       *
       * @return the source file from which entries will be extracted.
       */
      public String[] getIncludedFiles() {
          String[] result = new String[1];
          result[0] = srcFile;
          return result;
      }
  
      /**
       * Returns an empty list of directories to create.
       */
      public String[] getIncludedDirectories() {
          return new String[0];
      }
  
      /**
       * Initialize DirectoryScanner data structures.
       */
      public void init() {
          if (includes == null) {
              // No includes supplied, so set it to 'matches all'
              includes = new String[1];
              includes[0] = "**";
          }
          if (excludes == null) {
              excludes = new String[0];
          }
      }
  
      /**
       * Matches a jar entry against the includes/excludes list,
       * normalizing the path separator.
       *
       * @param path the (non-null) path name to test for inclusion
       *
       * @return <code>true</code> if the path should be included
       *         <code>false</code> otherwise.
       */
      public boolean match(String path) {
          String vpath = path.replace('/', File.separatorChar).
              replace('\\', File.separatorChar);
          return isIncluded(vpath) && !isExcluded(vpath);
      }
  
  }
  
  
  

Mime
View raw message