/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.taskdefs.optional.clearcase;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.taskdefs.Execute;
import org.apache.tools.ant.types.Commandline;
/**
* Performs ClearCase checkin.
*
* <p>
* The following attributes are interpreted:
* <table border="1">
* <tr>
* <th>Attribute</th>
* <th>Values</th>
* <th>Required</th>
* </tr>
* <tr>
* <td>viewpath</td>
* <td>Path to the ClearCase view file or directory that the command will operate on</td>
* <td>No</td>
* </tr>
* <tr>
* <td>comment</td>
* <td>Specify a comment. Only one of comment or cfile may be used.</td>
* <td>No</td>
* </tr>
* <tr>
* <td>commentfile</td>
* <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
* <td>No</td>
* </tr>
* <tr>
* <td>nowarn</td>
* <td>Suppress warning messages</td>
* <td>No</td>
* </tr>
* <tr>
* <td>preservetime</td>
* <td>Preserve the modification time</td>
* <td>No</td>
* </tr>
* <tr>
* <td>keepcopy</td>
* <td>Keeps a copy of the file with a .keep extension</td>
* <td>No</td>
* </tr>
* <tr>
* <td>identical</td>
* <td>Allows the file to be checked in even if it is identical to the original</td>
* <td>No</td>
* </tr>
* <tr>
* <td>failonerr</td>
* <td>Throw an exception if the command fails. Default is true</td>
* <td>No</td>
* </tr>
* </table>
*
*/
public class CCCheckin extends ClearCase {
/**
* -c flag -- comment to attach to the file
*/
public static final String FLAG_COMMENT = "-c";
/**
* -cfile flag -- file containing a comment to attach to the file
*/
public static final String FLAG_COMMENTFILE = "-cfile";
/**
* -nc flag -- no comment is specified
*/
public static final String FLAG_NOCOMMENT = "-nc";
/**
* -nwarn flag -- suppresses warning messages
*/
public static final String FLAG_NOWARN = "-nwarn";
/**
* -ptime flag -- preserves the modification time
*/
public static final String FLAG_PRESERVETIME = "-ptime";
/**
* -keep flag -- keeps a copy of the file with a .keep extension
*/
public static final String FLAG_KEEPCOPY = "-keep";
/**
* -identical flag -- allows the file to be checked in even if it is identical to the original
*/
public static final String FLAG_IDENTICAL = "-identical";
private String mComment = null;
private String mCfile = null;
private boolean mNwarn = false;
private boolean mPtime = false;
private boolean mKeep = false;
private boolean mIdentical = true;
/**
* Executes the task.
* <p>
* Builds a command line to execute cleartool and then calls Exec's run method
* to execute the command line.
* @throws BuildException if the command fails and failonerr is set to true
*/
@Override
public void execute() throws BuildException {
Commandline commandLine = new Commandline();
Project aProj = getProject();
// Default the viewpath to basedir if it is not specified
if (getViewPath() == null) {
setViewPath(aProj.getBaseDir().getPath());
}
// build the command line from what we got. the format is
// cleartool checkin [options...] [viewpath ...]
// as specified in the CLEARTOOL.EXE help
commandLine.setExecutable(getClearToolCommand());
commandLine.createArgument().setValue(COMMAND_CHECKIN);
checkOptions(commandLine);
if (!getFailOnErr()) {
getProject().log("Ignoring any errors that occur for: "
+ getViewPathBasename(), Project.MSG_VERBOSE);
}
int result = run(commandLine);
if (Execute.isFailure(result) && getFailOnErr()) {
throw new BuildException("Failed executing: " + commandLine, getLocation());
}
}
/**
* Check the command line options.
*/
private void checkOptions(Commandline cmd) {
if (getComment() != null) {
// -c
getCommentCommand(cmd);
} else {
if (getCommentFile() != null) {
// -cfile
getCommentFileCommand(cmd);
} else {
cmd.createArgument().setValue(FLAG_NOCOMMENT);
}
}
if (getNoWarn()) {
// -nwarn
cmd.createArgument().setValue(FLAG_NOWARN);
}
if (getPreserveTime()) {
// -ptime
cmd.createArgument().setValue(FLAG_PRESERVETIME);
}
if (getKeepCopy()) {
// -keep
cmd.createArgument().setValue(FLAG_KEEPCOPY);
}
if (getIdentical()) {
// -identical
cmd.createArgument().setValue(FLAG_IDENTICAL);
}
// viewpath
cmd.createArgument().setValue(getViewPath());
}
/**
* Sets the comment string.
*
* @param comment the comment string
*/
public void setComment(String comment) {
mComment = comment;
}
/**
* Get comment string
*
* @return String containing the comment
*/
public String getComment() {
return mComment;
}
/**
* Specifies a file containing a comment.
*
* @param cfile the path to the comment file
*/
public void setCommentFile(String cfile) {
mCfile = cfile;
}
/**
* Get comment file
*
* @return String containing the path to the comment file
*/
public String getCommentFile() {
return mCfile;
}
/**
* If true, suppress warning messages.
*
* @param nwarn the status to set the flag to
*/
public void setNoWarn(boolean nwarn) {
mNwarn = nwarn;
}
/**
* Get nowarn flag status
*
* @return boolean containing status of nwarn flag
*/
public boolean getNoWarn() {
return mNwarn;
}
/**
* If true, preserve the modification time.
*
* @param ptime the status to set the flag to
*/
public void setPreserveTime(boolean ptime) {
mPtime = ptime;
}
/**
* Get preservetime flag status
*
* @return boolean containing status of preservetime flag
*/
public boolean getPreserveTime() {
return mPtime;
}
/**
* If true, keeps a copy of the file with a .keep extension.
*
* @param keep the status to set the flag to
*/
public void setKeepCopy(boolean keep) {
mKeep = keep;
}
/**
* Get keepcopy flag status
*
* @return boolean containing status of keepcopy flag
*/
public boolean getKeepCopy() {
return mKeep;
}
/**
* If true, allows the file to be checked in even
* if it is identical to the original.
*
* @param identical the status to set the flag to
*/
public void setIdentical(boolean identical) {
mIdentical = identical;
}
/**
* Get identical flag status
*
* @return boolean containing status of identical flag
*/
public boolean getIdentical() {
return mIdentical;
}
/**
* Get the 'comment' command
*
* @param cmd containing the command line string with or
* without the comment flag and string appended
*/
private void getCommentCommand(Commandline cmd) {
if (getComment() != null) {
/* Had to make two separate commands here because if a space is
inserted between the flag and the value, it is treated as a
Windows filename with a space and it is enclosed in double
quotes ("). This breaks clearcase.
*/
cmd.createArgument().setValue(FLAG_COMMENT);
cmd.createArgument().setValue(getComment());
}
}
/**
* Get the 'commentfile' command
*
* @param cmd containing the command line string with or
* without the commentfile flag and file appended
*/
private void getCommentFileCommand(Commandline cmd) {
if (getCommentFile() != null) {
/* Had to make two separate commands here because if a space is
inserted between the flag and the value, it is treated as a
Windows filename with a space and it is enclosed in double
quotes ("). This breaks clearcase.
*/
cmd.createArgument().setValue(FLAG_COMMENTFILE);
cmd.createArgument().setValue(getCommentFile());
}
}
}