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
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkExecutableRunner.cxx
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
#include "vtkExecutableRunner.h"
#include "vtkObjectFactory.h"
#include <algorithm>
#include <cctype>
#include <regex>
#include <string>
#include <vector>
namespace details
{
// trim strings. This should go in vtksys at some point
static inline void ltrim(std::string& s)
{
s.erase(s.begin(),
std::find_if(s.begin(), s.end(), [](unsigned char ch) { return !std::isspace(ch); }));
}
static inline void rtrim(std::string& s)
{
s.erase(
std::find_if(s.rbegin(), s.rend(), [](unsigned char ch) { return !std::isspace(ch); }).base(),
s.end());
}
std::vector<std::string> ParseCommand(std::string command)
{
std::vector<std::string> res;
// Extract program name using regex
// regex recognize pattern such as `exec`, `./exec`, `/d1/d_2/exec`, `/d1/d\ 2/exec`, or `"/d1/d
// 2/exec"`. There is only one capturing group and that is the executable without the "
// characters, when this technique is used to escape the spaces.
std::regex programRegex = std::regex(R"~(^\.?(?:\/?(?:[^\s\\"]+(?:\\ )*)+)+|^"([^"]+)")~");
std::smatch match;
if (std::regex_search(command, match, programRegex))
{
// If escape group with '"' matched
if (match[1].matched)
{
res.emplace_back(match[1].str());
}
else
{
res.emplace_back(match[0].str());
}
command = command.substr(match[0].length(), command.length());
}
// Extract arguments. Split by space except if surrounded by the '"' character.
std::regex argRegex = std::regex(R"~(\s*([^\s"]+|"([^"]*)"))~");
while (std::regex_search(command, match, argRegex))
{
// If escape group for arguments with '"' matched
if (match[2].matched)
{
res.emplace_back(match[2].str());
}
else if (match[1].matched)
{
res.emplace_back(match[1].str());
}
command = command.substr(match[0].length(), command.length());
}
return res;
}
}
//------------------------------------------------------------------------------
vtkStandardNewMacro(vtkExecutableRunner);
//------------------------------------------------------------------------------
void vtkExecutableRunner::Execute()
{
std::string command = this->Command;
details::ltrim(command);
if (!command.empty())
{
std::vector<std::string> parsed = details::ParseCommand(command);
// get a vector of C string for vtksys
const auto size = parsed.size();
std::vector<const char*> stringViewC(size + 1);
for (std::size_t i = 0; i < size; ++i)
{
stringViewC[i] = parsed[i].c_str();
}
stringViewC[size] = nullptr;
// Configure and launch process
vtksysProcess* process = vtksysProcess_New();
vtksysProcess_SetCommand(process, &stringViewC[0]);
vtksysProcess_SetPipeShared(process, vtksysProcess_Pipe_STDOUT, 0);
vtksysProcess_SetPipeShared(process, vtksysProcess_Pipe_STDERR, 0);
vtksysProcess_SetTimeout(process, this->Timeout);
vtksysProcess_Execute(process);
// Get ouput streams
int pipe;
std::string out;
std::string err;
// While loop needed because there is a limit to the buffer size of
// the vtksysProcess streams. If output is too big we have to append.
do
{
char* cp;
int length = 0;
pipe = vtksysProcess_WaitForData(process, &cp, &length, nullptr);
switch (pipe)
{
case vtksysProcess_Pipe_STDOUT:
out.append(std::string(cp, length));
break;
case vtksysProcess_Pipe_STDERR:
err.append(std::string(cp, length));
break;
}
} while (pipe != vtksysProcess_Pipe_None);
// Exit properly
this->ReturnValue = this->ExitProcess(process);
vtksysProcess_Delete(process);
// Trim last whitespaces
if (this->RightTrimResult)
{
details::rtrim(out);
details::rtrim(err);
}
this->SetStdOut(out);
this->SetStdErr(err);
}
}
//------------------------------------------------------------------------------
int vtkExecutableRunner::ExitProcess(vtksysProcess* process)
{
vtksysProcess_WaitForExit(process, &this->Timeout);
int state = vtksysProcess_GetState(process);
int code = -1;
switch (state)
{
case vtksysProcess_State_Error:
vtkErrorMacro(
"Child process administration error: " << vtksysProcess_GetErrorString(process));
break;
case vtksysProcess_State_Exception:
vtkErrorMacro(
"Child process exited abnormally: " << vtksysProcess_GetExceptionString(process));
break;
case vtksysProcess_State_Expired:
vtkErrorMacro("Child process's timeout expired.");
break;
case vtksysProcess_State_Killed:
vtkErrorMacro("Child process terminated by Kill method.");
break;
case vtksysProcess_State_Exited:
code = vtksysProcess_GetExitValue(process);
vtkDebugMacro("Child process returned with value: " << code);
if (code)
{
vtkWarningMacro("Child process exited with error code: " << code);
}
break;
default:
break;
}
return code;
}
//------------------------------------------------------------------------------
void vtkExecutableRunner::PrintSelf(ostream& os, vtkIndent indent)
{
this->Superclass::PrintSelf(os, indent);
os << indent << "Command: " << this->GetCommand() << std::endl;
os << indent << "Timeout: " << this->GetTimeout() << std::endl;
os << indent << "RightTrimResult: " << this->GetRightTrimResult() << std::endl;
}
|
