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
|
/*
* This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "StartProcess.h"
#include "Errors.h"
#include "Log.h"
#include "Memory.h"
#include "Optional.h"
#ifndef BOOST_ALLOW_DEPRECATED_HEADERS
#define BOOST_ALLOW_DEPRECATED_HEADERS
#include <boost/process/args.hpp>
#include <boost/process/child.hpp>
#include <boost/process/env.hpp>
#include <boost/process/error.hpp>
#include <boost/process/exe.hpp>
#include <boost/process/io.hpp>
#include <boost/process/pipe.hpp>
#include <boost/process/search_path.hpp>
#undef BOOST_ALLOW_DEPRECATED_HEADERS
#endif
#include <fmt/ranges.h>
namespace bp = boost::process;
namespace Trinity
{
class AsyncProcessResultImplementation
: public AsyncProcessResult
{
std::string const executable;
std::vector<std::string> const args;
std::string const logger;
std::string const input_file;
bool const is_secure;
std::atomic<bool> was_terminated;
Optional<std::future<int>> futureResult;
Optional<bp::child> my_child;
public:
explicit AsyncProcessResultImplementation(std::string executable_, std::vector<std::string> args_,
std::string logger_, std::string input_file_,
bool secure)
: executable(std::move(executable_)), args(std::move(args_)),
logger(std::move(logger_)), input_file(std::move(input_file_)),
is_secure(secure), was_terminated(false) { }
AsyncProcessResultImplementation(AsyncProcessResultImplementation const&) = delete;
AsyncProcessResultImplementation& operator= (AsyncProcessResultImplementation const&) = delete;
AsyncProcessResultImplementation(AsyncProcessResultImplementation&&) = delete;
AsyncProcessResultImplementation& operator= (AsyncProcessResultImplementation&&) = delete;
~AsyncProcessResultImplementation() = default;
int32 StartProcess()
{
ASSERT(!my_child, "Process started already!");
#if TRINITY_COMPILER == TRINITY_COMPILER_MICROSOFT
#pragma warning(push)
#pragma warning(disable:4297)
/*
Silence warning with boost 1.83
boost/process/pipe.hpp(132,5): warning C4297: 'boost::process::basic_pipebuf<char,std::char_traits<char>>::~basic_pipebuf': function assumed not to throw an exception but does
boost/process/pipe.hpp(132,5): message : destructor or deallocator has a (possibly implicit) non-throwing exception specification
boost/process/pipe.hpp(124,6): message : while compiling class template member function 'boost::process::basic_pipebuf<char,std::char_traits<char>>::~basic_pipebuf(void)'
boost/process/pipe.hpp(304,42): message : see reference to class template instantiation 'boost::process::basic_pipebuf<char,std::char_traits<char>>' being compiled
*/
#endif
bp::ipstream outStream;
bp::ipstream errStream;
#if TRINITY_COMPILER == TRINITY_COMPILER_MICROSOFT
#pragma warning(pop)
#endif
if (is_secure)
{
TC_LOG_TRACE(logger, R"(Starting process "{}".)",
executable);
}
else
{
TC_LOG_TRACE(logger, R"(Starting process "{}" with arguments: "{}".)",
executable, fmt::join(args, " "));
}
// prepare file with only read permission (boost process opens with read_write)
auto inputFile = Trinity::make_unique_ptr_with_deleter<&::fclose>(!input_file.empty() ? fopen(input_file.c_str(), "rb") : nullptr);
std::error_code ec;
// Start the child process
if (inputFile)
{
my_child.emplace(
bp::exe = boost::filesystem::absolute(executable).string(),
bp::args = args,
bp::env = bp::environment(boost::this_process::environment()),
bp::std_in = inputFile.get(),
bp::std_out = outStream,
bp::std_err = errStream,
bp::error = ec
);
}
else
{
my_child.emplace(
bp::exe = boost::filesystem::absolute(executable).string(),
bp::args = args,
bp::env = bp::environment(boost::this_process::environment()),
bp::std_in = bp::close,
bp::std_out = outStream,
bp::std_err = errStream,
bp::error = ec
);
}
if (ec)
{
TC_LOG_ERROR(logger, R"(>> Failed to start process "{}": {})", executable, ec.message());
return EXIT_FAILURE;
}
std::future<void> stdOutReader = std::async(std::launch::async, [&]
{
std::string line;
while (std::getline(outStream, line, '\n'))
{
std::erase(line, '\r');
if (!line.empty())
TC_LOG_INFO(logger, "{}", line);
}
});
std::future<void> stdErrReader = std::async(std::launch::async, [&]
{
std::string line;
while (std::getline(errStream, line, '\n'))
{
std::erase(line, '\r');
if (!line.empty())
TC_LOG_ERROR(logger, "{}", line);
}
});
my_child->wait(ec);
int32 const result = !ec && !was_terminated ? my_child->exit_code() : EXIT_FAILURE;
my_child.reset();
stdOutReader.wait();
stdErrReader.wait();
TC_LOG_TRACE(logger, R"(>> Process "{}" finished with return value {}.)",
executable, result);
return result;
}
void SetFuture(std::future<int32> result_)
{
futureResult.emplace(std::move(result_));
}
/// Returns the future which contains the result of the process
/// as soon it is finished.
std::future<int32>& GetFutureResult() override
{
ASSERT(futureResult.has_value(), "The process wasn't started!");
return *futureResult;
}
/// Tries to terminate the process
void Terminate() override
{
if (my_child)
{
was_terminated = true;
std::error_code ec;
my_child->terminate(ec);
}
}
};
int32 StartProcess(std::string executable, std::vector<std::string> args,
std::string logger, std::string input_file, bool secure)
{
AsyncProcessResultImplementation handle(
std::move(executable), std::move(args), std::move(logger), std::move(input_file), secure);
return handle.StartProcess();
}
std::shared_ptr<AsyncProcessResult> StartAsyncProcess(std::string executable, std::vector<std::string> args,
std::string logger, std::string input_file, bool secure)
{
std::shared_ptr<AsyncProcessResultImplementation> handle = std::make_shared<AsyncProcessResultImplementation>(
std::move(executable), std::move(args), std::move(logger), std::move(input_file), secure);
handle->SetFuture(std::async(std::launch::async, [handle] { return handle->StartProcess(); }));
return handle;
}
std::string SearchExecutableInPath(std::string const& filename)
{
try
{
return bp::search_path(filename).string();
}
catch (...)
{
return "";
}
}
} // namespace Trinity
|
