Ok, here it is. The new and improved Cab task. This is still derived from MatchingTask - this still makes the most sense to me even though an external executable is invoked. I didn't want to expose the Exec* properties, so I used an instance of ExecTask as a delegate instead. IOW, I've got full reuse and the interface I want. I also threw in a couple new features while I was at it.
Here's the docs. The cab task creates Microsoft cab archive files. It is invoked similar to the jar or zip tasks. This task will only work on Windows, and will be silently ignored on other platforms. Required parameters: - cabfile: the name of the cab file to create. - basedir: the directory to start archiving files from. Optional parameters: - verbose: set to "yes" if you want to see the output from the cabarc tool. defaults to "no". - compress: set to "no" to store files without compressing. defaults to "yes". - options: use to set additional command-line options for the cabarc tool. should not normally be necessary. The cab task also supports the full set of MatchingTask parameters including "includes", "excludes", and "defaultexcludes". Roger Vaughn
/* * 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 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(String cabFilename) { cabFile = project.resolveFile(cabFilename); } /** * This is the base directory to look in for * things to cab. */ public void setBasedir(String baseDirname) { baseDir = project.resolveFile(baseDirname); } /** * Sets whether we want to compress the files or only store them. */ public void setCompress(String compress) { doCompress = project.toBoolean(compress); } /** * Sets whether we want to see or suppress cabarc output. */ public void setVerbose(String verbose) { doVerbose = project.toBoolean(verbose); } /** * Sets additional cabarc options that aren't supported directly. */ public void setOptions(String options) { cmdOptions = options; } /* * 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(String[] files) { boolean upToDate = true; for (int i=0; i<files.length && upToDate; i++) if (new File(baseDir,files[i]).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; } protected File createListFile(String[] files) throws IOException { File listFile = File.createTempFile("ant", null); listFile.deleteOnExit(); PrintWriter writer = new PrintWriter(new FileOutputStream(listFile)); for (int i = 0; i < files.length; i++) { writer.println(files[i]); } writer.close(); return listFile; } 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(); DirectoryScanner ds = super.getDirectoryScanner(baseDir); String[] files = ds.getIncludedFiles(); String[] dirs = ds.getIncludedDirectories(); // 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); } } }
