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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
/**
* \cond LICENSE
* Arara -- the cool TeX automation tool
* Copyright (c) 2012, Paulo Roberto Massa Cereda
* 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. Neither the name of the project's author nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS 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
* COPYRIGHT HOLDER OR 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.
* \endcond
*
* CommandTrigger: This class is responsible for running the arara commands.
*/
// package definition
package com.github.arara.utils;
// needed imports
import com.github.arara.exception.AraraException;
import com.github.arara.model.AraraCommand;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.List;
import org.apache.commons.exec.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Implements an environment for running the arara commands.
*
* @author Paulo Roberto Massa Cereda
* @version 3.0a
* @since 3.0
*/
public class CommandTrigger {
// the logger
final static Logger logger = LoggerFactory.getLogger(CommandTrigger.class);
// the localization class
final static AraraLocalization localization = AraraLocalization.getInstance();
// the commands list
private List<AraraCommand> commands;
// flag to determine verbose output
private boolean showVerboseOutput;
// value for the execution timeout
private long executionTimeout;
/**
* Constructor.
*
* @param commands The commands list.
*/
public CommandTrigger(List<AraraCommand> commands) {
// set the list
this.commands = commands;
}
/**
* Setter for the execution timeout.
*
* @param executionTimeout The execution timeout.
*/
public void setExecutionTimeout(long executionTimeout) {
// set the value
this.executionTimeout = executionTimeout;
}
/**
* Setter for the verbose mode.
*
* @param verbose A flag to indicate the verbose mode.
*/
public void setVerbose(boolean verbose) {
// set the flag
showVerboseOutput = verbose;
}
/**
* Executes the arara commands provided in the list.
*
* @return A boolean value about the execution. To be honest, I don't think
* it's necessary to return an actual value, but I kept it for possible
* future use.
* @throws AraraException Raised when the command is not found in the
* underlying system.
*/
public boolean execute() throws AraraException {
// log action
logger.info(localization.getMessage("Log_ReadyToRunCommands"));
// for every command in the list
for (AraraCommand currentAraraCommand : commands) {
// print a message
System.out.print(localization.getMessage("Msg_RunningCommand", currentAraraCommand.getName()).concat(" "));
// if verbose
if (showVerboseOutput) {
// add two lines
System.out.println("\n");
}
// log action
logger.info(localization.getMessage("Log_CommandName", currentAraraCommand.getName()));
// log command
logger.trace(localization.getMessage("Log_Command", currentAraraCommand.getCommand()));
// if the execution was ok
//if (runCommand(currentAraraCommand)) {
if (runCommand(currentAraraCommand)) {
// print a message
System.out.println(localization.getMessage("Msg_Success"));
// log action
logger.info(localization.getMessage("Log_CommandSuccess", currentAraraCommand.getName()));
} else {
// something bad happened, print message
System.out.println(localization.getMessage("Msg_Failure"));
// log action
logger.warn(localization.getMessage("Log_CommandFailure", currentAraraCommand.getName()));
// and return false
return false;
}
// if verbose
if (showVerboseOutput) {
// add one line to the output
System.out.println("");
}
}
// log action
logger.info(localization.getMessage("Log_AllCommandsSuccess"));
// everything went ok, simply return true
return true;
}
/**
* Run the arara command.
*
* @param command The Arara command.
* @return A boolean indicating if the execution was successful.
* @throws AraraException Throws an exception in case the command was not
* found.
*/
private boolean runCommand(AraraCommand command) throws AraraException {
// create a new byte array for the output logger
ByteArrayOutputStream stringLogger = new ByteArrayOutputStream();
// let's try
try {
// set a query
String query = command.getCommand();
// create a new command line from the query
CommandLine commandLine = CommandLine.parse(query);
// create a new tee
TeeOutputStream tee;
// create a new execution handler
PumpStreamHandler streamHandler;
// if verbose
if (showVerboseOutput) {
// the new tee should include the normal output
// and the log
tee = new TeeOutputStream(System.out, stringLogger);
// verbose mode enables input mode as well
streamHandler = new PumpStreamHandler(tee, tee, System.in);
} else {
// no verbose, so include only the log output
tee = new TeeOutputStream(stringLogger);
// define the handler only with the log output
streamHandler = new PumpStreamHandler(tee);
}
// create a new executor
DefaultExecutor executor = new DefaultExecutor();
// set the handler
executor.setStreamHandler(streamHandler);
// check if there should be an execution timeout
if (executionTimeout > 0) {
// create a new watch dog
ExecuteWatchdog watchDog = new ExecuteWatchdog(executionTimeout);
// add it to the execution
executor.setWatchdog(watchDog);
}
// set the shutdown hook
ShutdownHookProcessDestroyer processDestroyer = new ShutdownHookProcessDestroyer();
// add it to the executor
executor.setProcessDestroyer(processDestroyer);
// execute the command and get the exit code
int exitValue = executor.execute(commandLine);
// if we are in verbose mode
if (showVerboseOutput) {
// print the output status
System.out.print(localization.getMessage("Msg_Status").concat(" "));
}
// add the output to the logger
logger.trace(localization.getMessage("Log_OutputLogging"));
logger.trace(stringLogger.toString());
// return the status as a boolean
return (exitValue == 0 ? true : false);
} catch (ExecuteException executeException) {
// in case of an error, or the watchdog in action,
// the logger addition is not reached, so we need
// to replicate it here
logger.trace(localization.getMessage("Log_OutputLogging"));
logger.trace(stringLogger.toString());
// something bad happened, return false
return false;
} catch (IOException ioException) {
// log error
logger.error(localization.getMessage("Log_CommandNotFound", command.getName(), command.getCommand()));
// command not found, throw exception
throw new AraraException(localization.getMessage("Error_CommandNotFound", command.getName(), command.getCommand()));
}
}
}
|