* The class extends the 'exec' task as it operates by executing the ss.exe program * supplied with SourceSafe. By default the task expects ss.exe to be in the path, * you can override this be specifying the ssdir attribute. *
** This class provides set and get methods for 'login' and 'vsspath' attributes. It * also contains constants for the flags that can be passed to SS. *
* * @author Craig Cottingham * @author Andrew Everitt */ public abstract class MSVSS extends Task { private String m_SSDir = ""; private String m_vssLogin = null; private String m_vssPath = null; private String m_serverPath = null; /** * directory wheress.exe resides; optional.
* By default the task expects it to be in the PATH.
*
* @param dir the directory containing ss.exe
*/
public final void setSsdir(String dir) {
m_SSDir = Project.translatePath(dir);
}
/**
* Builds and returns the command string to execute ss.exe
*/
public final String getSSCommand() {
String toReturn = m_SSDir;
if (!toReturn.equals("") && !toReturn.endsWith("\\")) {
toReturn += "\\";
}
toReturn += SS_EXE;
return toReturn;
}
/**
* The login to use when accessing VSS, formatted as "username,password";
* optional.
* * You can omit the password if your database is not password protected. * if you have a password and omit it, Ant/VSS will hang. * * @param login the login string to use */ public final void setLogin(String login) { m_vssLogin = login; } /** * the appropriate login command if the 'login' attribute was specified, otherwise an empty string */ public void getLoginCommand(Commandline cmd) { if (m_vssLogin == null) { return; } else { cmd.createArgument().setValue(FLAG_LOGIN + m_vssLogin); } } /** * SourceSafe path which specifies the project/file(s) you wish to * perform the action on; required. You should not specify the leading dollar-sign - * it is prepended by Ant automatically. *
* Ant can't cope with a '$' sign in an attribute so we have to add it here.
* Also we strip off any 'vss://' prefix which is an XMS special and should probably be removed!
* @todo dont add a $ prefix if it has one
* @param vssPath
*/
public final void setVsspath(String vssPath) {
String projectPath;
if (vssPath.startsWith("vss://")) {
projectPath = vssPath.substring(5);
} else {
projectPath = vssPath;
}
if (projectPath.startsWith(PROJECT_PREFIX)) {
m_vssPath = projectPath;
} else {
m_vssPath = PROJECT_PREFIX + projectPath;
}
}
/**
* @return m_vssPath
*/
public String getVsspath() {
return m_vssPath;
}
/**
* Set the directory where srssafe.ini resides; optional.
* @param serverPath
*/
public final void setServerpath(String serverPath) {
m_serverPath = serverPath;
}
protected int run(Commandline cmd) {
try {
Execute exe = new Execute(new LogStreamHandler(this,
Project.MSG_INFO,
Project.MSG_WARN));
// If location of ss.ini is specified we need to set the
// environment-variable SSDIR to this value
if (m_serverPath != null) {
String[] env = exe.getEnvironment();
if (env == null) {
env = new String[0];
}
String[] newEnv = new String[env.length + 1];
for (int i = 0; i < env.length ; i++) {
newEnv[i] = env[i];
}
newEnv[env.length] = "SSDIR=" + m_serverPath;
exe.setEnvironment(newEnv);
}
exe.setAntRun(getProject());
exe.setWorkingDirectory(getProject().getBaseDir());
exe.setCommandline(cmd.getCommandline());
return exe.execute();
} catch (java.io.IOException e) {
throw new BuildException(e, getLocation());
}
}
/**
* Constant for the thing to execute
*/
private static final String SS_EXE = "ss";
/** */
public static final String PROJECT_PREFIX = "$";
/**
* The 'CP' command
*/
public static final String COMMAND_CP = "CP";
/**
* The 'Add' command
*/
public static final String COMMAND_ADD = "Add";
/**
* The 'Get' command
*/
public static final String COMMAND_GET = "Get";
/**
* The 'Checkout' command
*/
public static final String COMMAND_CHECKOUT = "Checkout";
/**
* The 'Checkin' command
*/
public static final String COMMAND_CHECKIN = "Checkin";
/**
* The 'Label' command
*/
public static final String COMMAND_LABEL = "Label";
/**
* The 'History' command
*/
public static final String COMMAND_HISTORY = "History";
/**
* The 'Create' command
*/
public static final String COMMAND_CREATE = "Create";
/** */
public static final String FLAG_LOGIN = "-Y";
/** */
public static final String FLAG_OVERRIDE_WORKING_DIR = "-GL";
/** */
public static final String FLAG_AUTORESPONSE_DEF = "-I-";
/** */
public static final String FLAG_AUTORESPONSE_YES = "-I-Y";
/** */
public static final String FLAG_AUTORESPONSE_NO = "-I-N";
/** */
public static final String FLAG_RECURSION = "-R";
/** */
public static final String FLAG_VERSION = "-V";
/** */
public static final String FLAG_VERSION_DATE = "-Vd";
/** */
public static final String FLAG_VERSION_LABEL = "-VL";
/** */
public static final String FLAG_WRITABLE = "-W";
/** */
public static final String VALUE_NO = "-N";
/** */
public static final String VALUE_YES = "-Y";
/** */
public static final String FLAG_QUIET = "-O-";
/** */
public static final String FLAG_CURRENT_TIME = "-GTC";
/** */
public static final String FLAG_MODIFIED_TIME = "-GTM";
/** */
public static final String FLAG_UPDATE_TIME = "-GTU";
}