|
|
|
@@ -0,0 +1,309 @@ |
|
|
|
/* |
|
|
|
* The Apache Software License, Version 1.1 |
|
|
|
* |
|
|
|
* Copyright (c) 2000 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 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.optional.vss; |
|
|
|
|
|
|
|
import org.apache.tools.ant.*; |
|
|
|
|
|
|
|
import java.io.File; |
|
|
|
|
|
|
|
/** |
|
|
|
* Task to perform GET commands to Microsoft Visual Source Safe. |
|
|
|
* <p> |
|
|
|
* The following attributes are interpretted: |
|
|
|
* <table border="1"> |
|
|
|
* <tr> |
|
|
|
* <th>Attribute</th> |
|
|
|
* <th>Values</th> |
|
|
|
* <th>Required</th> |
|
|
|
* </tr> |
|
|
|
* <tr> |
|
|
|
* <td>login</td> |
|
|
|
* <td>username,password</td> |
|
|
|
* <td>No</td> |
|
|
|
* <tr> |
|
|
|
* <tr> |
|
|
|
* <td>vsspath</td> |
|
|
|
* <td>SourceSafe path</td> |
|
|
|
* <td>Yes</td> |
|
|
|
* <tr> |
|
|
|
* <tr> |
|
|
|
* <td>localpath</td> |
|
|
|
* <td>Override the working directory and get to the specified path</td> |
|
|
|
* <td>No</td> |
|
|
|
* <tr> |
|
|
|
* <tr> |
|
|
|
* <td>writable</td> |
|
|
|
* <td>true or false</td> |
|
|
|
* <td>No</td> |
|
|
|
* <tr> |
|
|
|
* <tr> |
|
|
|
* <td>recursive</td> |
|
|
|
* <td>true or false</td> |
|
|
|
* <td>No</td> |
|
|
|
* <tr> |
|
|
|
* <tr> |
|
|
|
* <td>version</td> |
|
|
|
* <td>a version number to get</td> |
|
|
|
* <td>No</td> |
|
|
|
* <tr> |
|
|
|
* <tr> |
|
|
|
* <td>date</td> |
|
|
|
* <td>a date stamp to get at</td> |
|
|
|
* <td>No</td> |
|
|
|
* <tr> |
|
|
|
* <tr> |
|
|
|
* <td>label</td> |
|
|
|
* <td>a label to get for</td> |
|
|
|
* <td>No</td> |
|
|
|
* <tr> |
|
|
|
* </table> |
|
|
|
* <p>Note that only one of version, date or label should be specified</p> |
|
|
|
* |
|
|
|
* @author Craig Cottingham |
|
|
|
* @author Andrew Everitt |
|
|
|
*/ |
|
|
|
public class MSVSSGET extends MSVSS { |
|
|
|
|
|
|
|
private String m_LocalPath = null; |
|
|
|
private boolean m_Recursive = false; |
|
|
|
private boolean m_Writable = false; |
|
|
|
private String m_Version = null; |
|
|
|
private String m_Date = null; |
|
|
|
private String m_Label = null; |
|
|
|
|
|
|
|
/** |
|
|
|
* Executes the task. |
|
|
|
* <p> |
|
|
|
* Builds a command line to execute ss and then calls Exec's run method |
|
|
|
* to execute the command line. |
|
|
|
*/ |
|
|
|
public void execute() throws BuildException { |
|
|
|
StringBuffer commandLine = new StringBuffer(); |
|
|
|
int result = 0; |
|
|
|
|
|
|
|
// first off, make sure that we've got a command and a vssdir ... |
|
|
|
if (getVsspath() == null) { |
|
|
|
String msg = "vsspath attribute must be set!"; |
|
|
|
throw new BuildException(msg); |
|
|
|
} |
|
|
|
|
|
|
|
// now look for illegal combinations of things ... |
|
|
|
|
|
|
|
// build the command line from what we got the format is |
|
|
|
// ss Get VSS items [-G] [-H] [-I-] [-N] [-O] [-R] [-V] [-W] [-Y] [-?] |
|
|
|
// as specified in the SS.EXE help |
|
|
|
commandLine.append(SS_EXE).append(' ').append(COMMAND_GET); |
|
|
|
|
|
|
|
// VSS items |
|
|
|
commandLine.append(getVsspath()); |
|
|
|
// -GL |
|
|
|
commandLine.append(getLocalpathCommand()); |
|
|
|
// -I- |
|
|
|
commandLine.append(" -I-"); // ignore all errors |
|
|
|
// -R |
|
|
|
commandLine.append(getRecursiveCommand()); |
|
|
|
// -V |
|
|
|
commandLine.append(getVersionCommand()); |
|
|
|
// -W |
|
|
|
commandLine.append(getWritableCommand()); |
|
|
|
// -Y |
|
|
|
commandLine.append(getLoginCommand()); |
|
|
|
|
|
|
|
result = run(commandLine.toString()); |
|
|
|
if ( result != 0 ) { |
|
|
|
String msg = "Failed executing: " + commandLine.toString(); |
|
|
|
throw new BuildException(msg); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Set the local path. |
|
|
|
*/ |
|
|
|
public void setLocalpath(String localPath) { |
|
|
|
m_LocalPath = project.translatePath(localPath); |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Builds and returns the -GL flag command if required |
|
|
|
* <p> |
|
|
|
* The localpath is created if it didn't exist |
|
|
|
*/ |
|
|
|
public String getLocalpathCommand() { |
|
|
|
if (m_LocalPath == null) { |
|
|
|
return ""; |
|
|
|
} else { |
|
|
|
// make sure m_LocalDir exists, create it if it doesn't |
|
|
|
File dir = project.resolveFile(m_LocalPath); |
|
|
|
if (!dir.exists()) { |
|
|
|
boolean done = dir.mkdirs(); |
|
|
|
if (done == false) { |
|
|
|
String msg = "Directory " + m_LocalPath + " creation was not " + |
|
|
|
"succesful for an unknown reason"; |
|
|
|
throw new BuildException(msg); |
|
|
|
} |
|
|
|
project.log("Created dir: " + dir.getAbsolutePath()); |
|
|
|
} |
|
|
|
|
|
|
|
return new String(" " + FLAG_OVERRIDE_WORKING_DIR + m_LocalPath); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Set behaviour recursive or non-recursive |
|
|
|
*/ |
|
|
|
public void setRecursive(String recursive) { |
|
|
|
m_Recursive = Project.toBoolean(recursive); |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the 'recursive' command if the attribute was 'true', otherwise an empty string |
|
|
|
*/ |
|
|
|
public String getRecursiveCommand() { |
|
|
|
if ( !m_Recursive ) { |
|
|
|
return ""; |
|
|
|
} else { |
|
|
|
return new String(" " + FLAG_RECURSION); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Set behaviour, used in get command to make files that are 'got' writable |
|
|
|
*/ |
|
|
|
public final void setWritable(String argWritable) { |
|
|
|
m_Writable = Project.toBoolean(argWritable); |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the 'make writable' command if the attribute was 'true', otherwise an empty string |
|
|
|
*/ |
|
|
|
public String getWritableCommand() { |
|
|
|
if ( !m_Writable ) { |
|
|
|
return ""; |
|
|
|
} else { |
|
|
|
return new String(" " + FLAG_WRITABLE); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Set the stored version string |
|
|
|
* <p> |
|
|
|
* Note we assume that if the supplied string has the value "null" that something |
|
|
|
* went wrong and that the string value got populated from a null object. This |
|
|
|
* happens if a ant variable is used e.g. version="${ver_server}" when ver_server |
|
|
|
* has not been defined to ant! |
|
|
|
*/ |
|
|
|
public void setVersion(String version) { |
|
|
|
if (version.equals("") || version.equals("null") ) { |
|
|
|
m_Version = null; |
|
|
|
} else { |
|
|
|
m_Version = version; |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Set the stored date string |
|
|
|
* <p> |
|
|
|
* Note we assume that if the supplied string has the value "null" that something |
|
|
|
* went wrong and that the string value got populated from a null object. This |
|
|
|
* happens if a ant variable is used e.g. date="${date}" when date |
|
|
|
* has not been defined to ant! |
|
|
|
*/ |
|
|
|
public void setDate(String date) { |
|
|
|
if (date.equals("") || date.equals("null") ) { |
|
|
|
m_Date = null; |
|
|
|
} else { |
|
|
|
m_Date = date; |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Set the labeled version to operate on in SourceSafe |
|
|
|
* <p> |
|
|
|
* Note we assume that if the supplied string has the value "null" that something |
|
|
|
* went wrong and that the string value got populated from a null object. This |
|
|
|
* happens if a ant variable is used e.g. label="${label_server}" when label_server |
|
|
|
* has not been defined to ant! |
|
|
|
*/ |
|
|
|
public void setLabel(String label) { |
|
|
|
if ( label.equals("") || label.equals("null") ) { |
|
|
|
m_Label = null; |
|
|
|
} else { |
|
|
|
m_Label = label; |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Simple order of priority. Returns the first specified of version, date, label |
|
|
|
* If none of these was specified returns "" |
|
|
|
*/ |
|
|
|
public String getVersionCommand() { |
|
|
|
|
|
|
|
if ( m_Version != null) { |
|
|
|
return new String(" " + FLAG_VERSION + m_Version); |
|
|
|
} |
|
|
|
|
|
|
|
if ( m_Date != null) { |
|
|
|
return new String(" " + FLAG_VERSION_DATE + m_Date); |
|
|
|
} |
|
|
|
|
|
|
|
if (m_Label != null) { |
|
|
|
return new String(" " + FLAG_VERSION_LABEL + m_Label); |
|
|
|
} |
|
|
|
|
|
|
|
return ""; |
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
|
Stefan Bodewig