bodewig 00/08/03 03:12:16
Modified: . build.xml
docs index.html
src/main/org/apache/tools/ant/taskdefs defaults.properties
Added: src/main/org/apache/tools/ant/taskdefs/optional Cab.java
Log:
New optional task <cab> to create Microsoft CAB archives.
Submitted by: Roger Vaughn <[EMAIL PROTECTED]>
Revision Changes Path
1.54 +1 -0 jakarta-ant/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-ant/build.xml,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -r1.53 -r1.54
--- build.xml 2000/08/03 08:37:25 1.53
+++ build.xml 2000/08/03 10:12:02 1.54
@@ -83,6 +83,7 @@
<exclude name="**/EjbJar.java" unless="jdk1.2+" />
<exclude name="**/*DeploymentTool.java" unless="jdk1.2+" />
<exclude name="**/junit/*" unless="junit.present" />
+ <exclude name="**/Cab.java" unless="jdk1.2+" />
</javac>
<copydir src="${src.dir}" dest="${build.classes}">
1.65 +53 -0 jakarta-ant/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/index.html,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -r1.64 -r1.65
--- index.html 2000/08/03 09:43:17 1.64
+++ index.html 2000/08/03 10:12:07 1.65
@@ -3302,12 +3302,65 @@
<hr>
<h2><a name="optionaltasks">Optional tasks</a></h2>
<ul>
+ <li><a href="#cab">Cab</a></li>
<li><a href="#netrexxc">NetRexxC</a></li>
<li><a href="#renameexts">RenameExtensions</a></li>
<li><a href="#script">Script</a></li>
<li><a href="#vssget">VssGet</a></li>
<li><a href="ejb.html">EJB Tasks</a></li>
</ul>
+<hr>
+<h2><a name="cab">Cab</a></h2>
+<h3><b>Description:</b></h3>
+<p>The cab task creates Microsoft cab archive files. It is invoked
+similar to the <a href="#jar">jar</a> or <a href="#zip">zip</a> tasks.
+This task will only work on Windows, and will be silently ignored on
+other platforms. You must have the Microsoft cabarc tool available in
+your executable path.</p>
+<p>See the section on <a href="#directorybasedtasks">directory based
+tasks</a>, on how the inclusion/exclusion of files works, and how to
+write patterns. The patterns are relative to the <i>basedir</i>
+directory.</p>
+<h3>Parameters:</h3>
+<table border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <td valign="top"><b>Attribute</b></td>
+ <td valign="top"><b>Description</b></td>
+ <td align="center" valign="top"><b>Required</b></td>
+ </tr>
+ <tr>
+ <td valign="top">cabfile</td>
+ <td valign="top">the name of the cab file to create.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">basedir</td>
+ <td valign="top">the directory to start archiving files from.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">verbose</td>
+ <td valign="top">set to "yes" if you want to see the output from
+ the cabarc tool. defaults to "no".</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">compress</td>
+ <td valign="top">set to "no" to store files without compressing.
+ defaults to "yes".</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">options</td>
+ <td valign="top">use to set additional command-line options for
+ the cabarc tool. should not normally be necessary.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+</table>
+<h3>Examples</h3>
+<blockquote>
+ <p>None yet available</p>
+</blockquote>
<hr>
<h2><a name="netrexxc">NetRexxC</a></h2>
<h3><b>Description:</b></h3>
1.31 +1 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties
Index: defaults.properties
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- defaults.properties 2000/08/03 08:46:29 1.30
+++ defaults.properties 2000/08/03 10:12:10 1.31
@@ -53,6 +53,7 @@
ejbjar=org.apache.tools.ant.taskdefs.optional.ejb.EjbJar
mparse=org.apache.tools.ant.taskdefs.optional.metamata.MParse
junit=org.apache.tools.ant.taskdefs.optional.junit.JUnitTask
+cab=org.apache.tools.ant.taskdefs.optional.Cab
# deprecated ant tasks (kept for back compatibility)
javadoc2=org.apache.tools.ant.taskdefs.Javadoc
1.1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Cab.java
Index: Cab.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", "Tomcat", 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 [EMAIL PROTECTED]
*
* 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.optional;
import org.apache.tools.ant.*;
import org.apache.tools.ant.taskdefs.*;
import org.apache.tools.ant.types.*;
import java.io.*;
import java.util.Enumeration;
import java.util.StringTokenizer;
import java.util.Vector;
/**
* Create a CAB archive.
*
* @author Roger Vaughn <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
*/
public class Cab extends MatchingTask {
private File cabFile;
private File baseDir;
private Vector filesets = new Vector();
private boolean doCompress = true;
private boolean doVerbose = false;
private String cmdOptions;
protected String archiveType = "cab";
private static String myos;
private static boolean isWindows;
static {
myos = System.getProperty("os.name");
isWindows = myos.toLowerCase().indexOf("windows") >= 0;
}
/**
* This is the name/location of where to
* create the .cab file.
*/
public void setCabfile(File cabFile) {
cabFile = cabFile;
}
/**
* This is the base directory to look in for
* things to cab.
*/
public void setBasedir(File baseDir) {
this.baseDir = baseDir;
}
/**
* Sets whether we want to compress the files or only store them.
*/
public void setCompress(boolean compress) {
doCompress = compress;
}
/**
* Sets whether we want to see or suppress cabarc output.
*/
public void setVerbose(boolean verbose) {
doVerbose = verbose;
}
/**
* Sets additional cabarc options that aren't supported directly.
*/
public void setOptions(String options) {
cmdOptions = options;
}
/**
* Adds a set of files (nested fileset attribute).
*/
public void addFileset(FileSet set) {
filesets.addElement(set);
}
/**
* Adds a reference to a set of files (nested filesetref element).
*/
public void addFilesetref(Reference ref) {
filesets.addElement(ref);
}
/*
* I'm not fond of this pattern: "sub-method expected to throw
* task-cancelling exceptions". It feels too much like programming
* for side-effects to me...
*/
protected void checkConfiguration() throws BuildException {
if (baseDir == null) {
throw new BuildException("basedir attribute must be set!");
}
if (!baseDir.exists()) {
throw new BuildException("basedir does not exist!");
}
if (cabFile == null) {
throw new BuildException("cabfile attribute must be set!");
}
}
/**
* Create a new exec delegate. The delegate task is populated so that
* it appears in the logs to be the same task as this one.
*/
protected ExecTask createExec() throws BuildException
{
ExecTask exec = (ExecTask)project.createTask("exec");
exec.setOwningTarget(this.getOwningTarget());
exec.setTaskName(this.getTaskName());
exec.setDescription(this.getDescription());
return exec;
}
/**
* Check to see if the target is up to date with respect to input files.
* @return true if the cab file is newer than its dependents.
*/
protected boolean isUpToDate(Vector files)
{
boolean upToDate = true;
for (int i=0; i<files.size() && upToDate; i++)
{
String file = files.elementAt(i).toString();
if (new File(baseDir,file).lastModified() >
cabFile.lastModified())
upToDate = false;
}
return upToDate;
}
/**
* Create the cabarc command line to use.
*/
protected Commandline createCommand(File listFile)
{
Commandline command = new Commandline();
command.setExecutable("cabarc");
command.addValue("-r");
command.addValue("-p");
if (!doCompress)
{
command.addValue("-m");
command.addValue("none");
}
if (cmdOptions != null)
{
command.addValue(cmdOptions);
}
command.addValue("n");
command.addValue(cabFile.getAbsolutePath());
command.addValue("@" + listFile.getAbsolutePath());
return command;
}
/**
* Creates a list file. This temporary file contains a list of all files
* to be included in the cab, one file per line.
*/
protected File createListFile(Vector files)
throws IOException
{
File listFile = File.createTempFile("ant", null);
listFile.deleteOnExit();
PrintWriter writer = new PrintWriter(new FileOutputStream(listFile));
for (int i = 0; i < files.size(); i++)
{
writer.println(files.elementAt(i).toString());
}
writer.close();
return listFile;
}
/**
* Append all files found by a directory scanner to a vector.
*/
protected void appendFiles(Vector files, DirectoryScanner ds)
{
String[] dsfiles = ds.getIncludedFiles();
for (int i = 0; i < dsfiles.length; i++)
{
files.addElement(dsfiles[i]);
}
}
/**
* Get the complete list of files to be included in the cab. Filenames
* are gathered from filesets if any have been added, otherwise from the
* traditional include parameters.
*/
protected Vector getFileList() throws BuildException
{
Vector files = new Vector();
if (filesets.size() == 0)
{
// get files from old methods - includes and nested include
appendFiles(files, super.getDirectoryScanner(baseDir));
}
else
{
// get files from filesets
for (int i = 0; i < filesets.size(); i++)
{
Object o = filesets.elementAt(i);
FileSet fs;
if (o instanceof FileSet)
{
fs = (FileSet)o;
}
else if (o instanceof Reference)
{
Reference r = (Reference)o;
o = r.getReferencedObject(project);
if (o instanceof FileSet)
{
fs = (FileSet)o;
}
else
{
throw new BuildException(
r.getRefId() + " does not denote a fileset",
location);
}
}
else
{
throw new BuildException(
"nested element is not a FileSet or Reference",
location);
}
if (fs != null)
{
appendFiles(files, fs.getDirectoryScanner(project));
}
}
}
return files;
}
public void execute() throws BuildException {
// we must be on Windows to continue
if (!isWindows)
{
log("cannot run on non-Windows platforms: " + myos,
Project.MSG_VERBOSE);
return;
}
checkConfiguration();
Vector files = getFileList();
// quick exit if the target is up to date
if (isUpToDate(files)) return;
log("Building "+ archiveType +": "+ cabFile.getAbsolutePath());
try {
File listFile = createListFile(files);
ExecTask exec = createExec();
// die if cabarc fails
exec.setFailonerror(true);
exec.setDir(baseDir);
if (!doVerbose)
{
File outFile = File.createTempFile("ant", null);
outFile.deleteOnExit();
exec.setOutput(outFile);
}
exec.setCommand(createCommand(listFile));
exec.execute();
} catch (IOException ioe) {
String msg = "Problem creating " + cabFile + " " +
ioe.getMessage();
throw new BuildException(msg);
}
}
}
