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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
#include "conptyprocess.h"
#include <QFile>
#include <QFileInfo>
#include <QThread>
#include <sstream>
#include <QTimer>
#include <QMutexLocker>
#include <QCoreApplication>
#include <QWinEventNotifier>
#include <qt_windows.h>
#define READ_INTERVAL_MSEC 500
HRESULT ConPtyProcess::createPseudoConsoleAndPipes(HPCON* phPC, HANDLE* phPipeIn, HANDLE* phPipeOut, qint16 cols, qint16 rows)
{
HRESULT hr{ E_UNEXPECTED };
HANDLE hPipePTYIn{ INVALID_HANDLE_VALUE };
HANDLE hPipePTYOut{ INVALID_HANDLE_VALUE };
// Create the pipes to which the ConPTY will connect
if (CreatePipe(&hPipePTYIn, phPipeOut, NULL, 0) &&
CreatePipe(phPipeIn, &hPipePTYOut, NULL, 0))
{
// Create the Pseudo Console of the required size, attached to the PTY-end of the pipes
hr = m_winContext.createPseudoConsole({cols, rows}, hPipePTYIn, hPipePTYOut, 0, phPC);
// Note: We can close the handles to the PTY-end of the pipes here
// because the handles are dup'ed into the ConHost and will be released
// when the ConPTY is destroyed.
if (INVALID_HANDLE_VALUE != hPipePTYOut) CloseHandle(hPipePTYOut);
if (INVALID_HANDLE_VALUE != hPipePTYIn) CloseHandle(hPipePTYIn);
}
return hr;
}
// Initializes the specified startup info struct with the required properties and
// updates its thread attribute list with the specified ConPTY handle
HRESULT ConPtyProcess::initializeStartupInfoAttachedToPseudoConsole(STARTUPINFOEX* pStartupInfo, HPCON hPC)
{
HRESULT hr{ E_UNEXPECTED };
if (pStartupInfo)
{
SIZE_T attrListSize{};
pStartupInfo->StartupInfo.hStdInput = m_hPipeIn;
pStartupInfo->StartupInfo.hStdError = m_hPipeOut;
pStartupInfo->StartupInfo.hStdOutput = m_hPipeOut;
pStartupInfo->StartupInfo.dwFlags |= STARTF_USESTDHANDLES;
pStartupInfo->StartupInfo.cb = sizeof(STARTUPINFOEX);
// Get the size of the thread attribute list.
InitializeProcThreadAttributeList(NULL, 1, 0, &attrListSize);
// Allocate a thread attribute list of the correct size
pStartupInfo->lpAttributeList = reinterpret_cast<LPPROC_THREAD_ATTRIBUTE_LIST>(
HeapAlloc(GetProcessHeap(), 0, attrListSize));
// Initialize thread attribute list
if (pStartupInfo->lpAttributeList
&& InitializeProcThreadAttributeList(pStartupInfo->lpAttributeList, 1, 0, &attrListSize))
{
// Set Pseudo Console attribute
hr = UpdateProcThreadAttribute(
pStartupInfo->lpAttributeList,
0,
PROC_THREAD_ATTRIBUTE_PSEUDOCONSOLE,
hPC,
sizeof(HPCON),
NULL,
NULL)
? S_OK
: HRESULT_FROM_WIN32(GetLastError());
}
else
{
hr = HRESULT_FROM_WIN32(GetLastError());
}
}
return hr;
}
Q_DECLARE_METATYPE(HANDLE)
ConPtyProcess::ConPtyProcess()
: IPtyProcess()
, m_ptyHandler { INVALID_HANDLE_VALUE }
, m_hPipeIn { INVALID_HANDLE_VALUE }
, m_hPipeOut { INVALID_HANDLE_VALUE }
, m_readThread(nullptr)
{
qRegisterMetaType<HANDLE>("HANDLE");
}
ConPtyProcess::~ConPtyProcess()
{
kill();
}
bool ConPtyProcess::startProcess(const QString &executable,
const QStringList &arguments,
const QString &workingDir,
QStringList environment,
qint16 cols,
qint16 rows)
{
if (!isAvailable()) {
m_lastError = m_winContext.lastError();
return false;
}
//already running
if (m_ptyHandler != INVALID_HANDLE_VALUE)
return false;
QFileInfo fi(executable);
if (fi.isRelative() || !QFile::exists(executable)) {
//todo add auto-find executable in PATH env var
m_lastError = QString("ConPty Error: shell file path '%1' must be absolute").arg(executable);
return false;
}
m_shellPath = executable;
m_shellPath.replace('/', '\\');
m_size = QPair<qint16, qint16>(cols, rows);
//env
const QString env = environment.join(QChar(QChar::Null)) + QChar(QChar::Null);
LPVOID envPtr = env.isEmpty() ? nullptr : (LPVOID) env.utf16();
LPCWSTR workingDirPtr = workingDir.isEmpty() ? nullptr : (LPCWSTR) workingDir.utf16();
QStringList exeAndArgs = arguments;
exeAndArgs.prepend(m_shellPath);
std::wstring cmdArg{(LPCWSTR) (exeAndArgs.join(QLatin1String(" ")).utf16())};
HRESULT hr{E_UNEXPECTED};
// Create the Pseudo Console and pipes to it
hr = createPseudoConsoleAndPipes(&m_ptyHandler, &m_hPipeIn, &m_hPipeOut, cols, rows);
if (S_OK != hr) {
m_lastError = QString("ConPty Error: CreatePseudoConsoleAndPipes fail");
return false;
}
// Initialize the necessary startup info struct
if (S_OK != initializeStartupInfoAttachedToPseudoConsole(&m_shellStartupInfo, m_ptyHandler)) {
m_lastError = QString("ConPty Error: InitializeStartupInfoAttachedToPseudoConsole fail");
return false;
}
hr = CreateProcessW(nullptr, // No module name - use Command Line
cmdArg.data(), // Command Line
nullptr, // Process handle not inheritable
nullptr, // Thread handle not inheritable
FALSE, // Inherit handles
EXTENDED_STARTUPINFO_PRESENT | CREATE_UNICODE_ENVIRONMENT, // Creation flags
envPtr, // Environment block
workingDirPtr, // Use parent's starting directory
&m_shellStartupInfo.StartupInfo, // Pointer to STARTUPINFO
&m_shellProcessInformation) // Pointer to PROCESS_INFORMATION
? S_OK
: GetLastError();
if (S_OK != hr) {
m_lastError = QString("ConPty Error: Cannot create process -> %1").arg(hr);
return false;
}
m_pid = m_shellProcessInformation.dwProcessId;
// Notify when the shell process has been terminated
m_shellCloseWaitNotifier = new QWinEventNotifier(m_shellProcessInformation.hProcess, notifier());
QObject::connect(m_shellCloseWaitNotifier,
&QWinEventNotifier::activated,
notifier(),
[this](HANDLE hEvent) {
DWORD exitCode = 0;
GetExitCodeProcess(hEvent, &exitCode);
m_exitCode = exitCode;
// Do not respawn if the object is about to be destructed
if (!m_aboutToDestruct)
emit notifier()->aboutToClose();
m_shellCloseWaitNotifier->setEnabled(false);
}, Qt::QueuedConnection);
//this code runned in separate thread
m_readThread = QThread::create([this]() {
//buffers
const DWORD BUFF_SIZE{1024};
char szBuffer[BUFF_SIZE]{};
forever {
DWORD dwBytesRead{};
// Read from the pipe
BOOL result = ReadFile(m_hPipeIn, szBuffer, BUFF_SIZE, &dwBytesRead, NULL);
const bool needMoreData = !result && GetLastError() == ERROR_MORE_DATA;
if (result || needMoreData) {
QMutexLocker locker(&m_bufferMutex);
m_buffer.m_readBuffer.append(szBuffer, dwBytesRead);
m_buffer.emitReadyRead();
}
const bool brokenPipe = !result && GetLastError() == ERROR_BROKEN_PIPE;
if (QThread::currentThread()->isInterruptionRequested() || brokenPipe)
break;
}
CancelIoEx(m_hPipeIn, nullptr);
});
//start read thread
m_readThread->start();
return true;
}
bool ConPtyProcess::resize(qint16 cols, qint16 rows)
{
if (m_ptyHandler == nullptr)
{
return false;
}
bool res = SUCCEEDED(m_winContext.resizePseudoConsole(m_ptyHandler, {cols, rows}));
if (res)
{
m_size = QPair<qint16, qint16>(cols, rows);
}
return res;
return true;
}
bool ConPtyProcess::kill()
{
bool exitCode = false;
if (m_ptyHandler != INVALID_HANDLE_VALUE) {
m_aboutToDestruct = true;
// Close ConPTY - this will terminate client process if running
m_winContext.closePseudoConsole(m_ptyHandler);
// Clean-up the pipes
if (INVALID_HANDLE_VALUE != m_hPipeOut)
CloseHandle(m_hPipeOut);
if (INVALID_HANDLE_VALUE != m_hPipeIn)
CloseHandle(m_hPipeIn);
if (m_readThread) {
m_readThread->requestInterruption();
if (!m_readThread->wait(1000))
m_readThread->terminate();
m_readThread->deleteLater();
m_readThread = nullptr;
}
delete m_shellCloseWaitNotifier;
m_shellCloseWaitNotifier = nullptr;
m_pid = 0;
m_ptyHandler = INVALID_HANDLE_VALUE;
m_hPipeIn = INVALID_HANDLE_VALUE;
m_hPipeOut = INVALID_HANDLE_VALUE;
CloseHandle(m_shellProcessInformation.hThread);
CloseHandle(m_shellProcessInformation.hProcess);
// Cleanup attribute list
if (m_shellStartupInfo.lpAttributeList) {
DeleteProcThreadAttributeList(m_shellStartupInfo.lpAttributeList);
HeapFree(GetProcessHeap(), 0, m_shellStartupInfo.lpAttributeList);
}
exitCode = true;
}
return exitCode;
}
IPtyProcess::PtyType ConPtyProcess::type()
{
return PtyType::ConPty;
}
QString ConPtyProcess::dumpDebugInfo()
{
#ifdef PTYQT_DEBUG
return QString("PID: %1, Type: %2, Cols: %3, Rows: %4")
.arg(m_pid).arg(type())
.arg(m_size.first).arg(m_size.second);
#else
return QString("Nothing...");
#endif
}
QIODevice *ConPtyProcess::notifier()
{
return &m_buffer;
}
QByteArray ConPtyProcess::readAll()
{
QByteArray result;
{
QMutexLocker locker(&m_bufferMutex);
result.swap(m_buffer.m_readBuffer);
}
return result;
}
qint64 ConPtyProcess::write(const QByteArray &byteArray)
{
DWORD dwBytesWritten{};
WriteFile(m_hPipeOut, byteArray.data(), byteArray.size(), &dwBytesWritten, NULL);
return dwBytesWritten;
}
bool ConPtyProcess::isAvailable()
{
#ifdef TOO_OLD_WINSDK
return false; //very importnant! ConPty can be built, but it doesn't work if built with old sdk and Win10 < 1903
#endif
qint32 buildNumber = QSysInfo::kernelVersion().split(".").last().toInt();
if (buildNumber < CONPTY_MINIMAL_WINDOWS_VERSION)
return false;
return m_winContext.init();
}
void ConPtyProcess::moveToThread(QThread *targetThread)
{
//nothing for now...
}
|