blob: 93a12f8e1c6a088d74851a10a69c7a5aaa1bd9c6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
/*
* Copyright 2003-2004 Apache Software Foundation
*
* Licensed 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;
/**
* TODO:
* comment field doesn't include all options yet
*/
/**
* Performs a ClearCase Unlock command.
*
* <p>
* The following attributes are interpreted:
* <table border="1">
* <tr>
* <th>Attribute</th>
* <th>Values</th>
* <th>Required</th>
* </tr>
* <tr>
* <td>comment</td>
* <td>Specifies how to populate comments fields</td>
* <td>No</td>
* <tr>
* <tr>
* <td>pname</td>
* <td>Specifies the object pathname to be unlocked.</td>
* <td>No</td>
* <tr>
* <td>objselect</td>
* <td>This variable is obsolete. Should use <i>objsel</i> instead.</td>
* <td>no</td>
* <tr>
* <tr>
* <td>objsel</td>
* <td>Specifies the object(s) to be unlocked.</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>
*
* @author Sean P. Kane (Based on work by: Curtis White)
*/
public class CCUnlock extends ClearCase {
private String mComment = null;
private String mPname = null;
private String mObjselect = null;
/**
* 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
*/
public void execute() throws BuildException {
Commandline commandLine = new Commandline();
Project aProj = getProject();
int result = 0;
// 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 lock [options...]
// as specified in the CLEARTOOL.EXE help
commandLine.setExecutable(getClearToolCommand());
commandLine.createArgument().setValue(COMMAND_UNLOCK);
// Check the command line options
checkOptions(commandLine);
// For debugging
// System.out.println(commandLine.toString());
if (!getFailOnErr()) {
getProject().log("Ignoring any errors that occur for: "
+ getOpType(), Project.MSG_VERBOSE);
}
result = run(commandLine);
if (Execute.isFailure(result) && getFailOnErr()) {
String msg = "Failed executing: " + commandLine.toString();
throw new BuildException(msg, getLocation());
}
}
/**
* Check the command line options.
*/
private void checkOptions(Commandline cmd) {
// ClearCase items
getCommentCommand(cmd);
if (getObjselect() == null && getPname() == null) {
throw new BuildException("Should select either an element "
+ "(pname) or an object (objselect)");
}
getPnameCommand(cmd);
// object selector
if (getObjselect() != null) {
cmd.createArgument().setValue(getObjselect());
}
}
/**
* Sets how comments should be written
* for the event record(s)
*
* @param comment comment method to use
*/
public void setComment(String comment) {
mComment = comment;
}
/**
* Get comment method
*
* @return String containing the desired comment method
*/
public String getComment() {
return mComment;
}
/**
* Sets the pathname to be locked
*
* @param pname pathname to be locked
*/
public void setPname(String pname) {
mPname = pname;
}
/**
* Get the pathname to be locked
*
* @return String containing the pathname to be locked
*/
public String getPname() {
return mPname;
}
/**
* Sets the object(s) to be locked
*
* @param objselect objects to be locked
*/
public void setObjselect(String objselect) {
mObjselect = objselect;
}
/**
* Sets the object(s) to be locked
*
* @param objsel objects to be locked
* @since ant 1.6.1
*/
public void setObjSel(String objsel) {
mObjselect = objsel;
}
/**
* Get list of objects to be locked
*
* @return String containing the objects to be locked
*/
public String getObjselect() {
return mObjselect;
}
/**
* Get the 'comment' command
*
* @param cmd containing the command line string with or without the
* comment flag and value appended
*/
private void getCommentCommand(Commandline cmd) {
if (getComment() == null) {
return;
} else {
/* 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 'pname' command
*
* @param cmd containing the command line string with or without the
* pname flag and value appended
*/
private void getPnameCommand(Commandline cmd) {
if (getPname() == null) {
return;
} else {
/* 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_PNAME);
cmd.createArgument().setValue(getPname());
}
}
/**
* Return which object/pname is being operated on
*
* @return String containing the object/pname being worked on
*/
private String getOpType() {
if (getPname() != null) {
return getPname();
} else {
return getObjselect();
}
}
/**
* -comment flag -- method to use for commenting events
*/
public static final String FLAG_COMMENT = "-comment";
/**
* -pname flag -- pathname to lock
*/
public static final String FLAG_PNAME = "-pname";
}
|