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 344 345 346 347 348 349 350
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright : (C) 2014 Eran Ifrah
// file name : asyncprocess.cpp
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// 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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
class wxEvtHandler;
class IProcess;
//#include "asyncprocess.h"
#include "asyncprocess.h"
#include "StringUtils.h"
#include "clTempFile.hpp"
#include "cl_command_event.h"
#include "file_logger.h"
#include "fileutils.h"
#include "processreaderthread.h"
#include "ssh_account_info.h"
#include <wx/arrstr.h>
#include <wx/string.h>
#ifdef __WXMSW__
static bool shell_is_cmd = true;
#include "winprocess_impl.h"
#else
static bool shell_is_cmd = false;
#include "unixprocess_impl.h"
#endif
class __AsyncCallback : public wxEvtHandler
{
std::function<void(const wxString&)> m_cb;
wxString m_output;
public:
__AsyncCallback(std::function<void(const wxString&)> cb)
: m_cb(std::move(cb))
{
Bind(wxEVT_ASYNC_PROCESS_TERMINATED, &__AsyncCallback::OnProcessTerminated, this);
Bind(wxEVT_ASYNC_PROCESS_OUTPUT, &__AsyncCallback::OnProcessOutput, this);
}
~__AsyncCallback()
{
Unbind(wxEVT_ASYNC_PROCESS_TERMINATED, &__AsyncCallback::OnProcessTerminated, this);
Unbind(wxEVT_ASYNC_PROCESS_OUTPUT, &__AsyncCallback::OnProcessOutput, this);
}
void OnProcessOutput(clProcessEvent& event)
{
size_t new_len = m_output.length() + event.GetOutput().length();
if(new_len > m_output.length()) {
m_output.reserve(new_len);
m_output << event.GetOutput();
}
}
void OnProcessTerminated(clProcessEvent& event)
{
if(!event.GetOutput().empty()) {
m_output << event.GetOutput();
}
// all the user callback
m_cb(m_output);
delete event.GetProcess();
delete this; // we are no longer needed...
}
};
static void __WrapSpacesForShell(wxString& str, size_t flags)
{
str.Trim().Trim(false);
auto tmpArgs = StringUtils::BuildArgv(str);
if(tmpArgs.size() > 1) {
if(!shell_is_cmd || (flags & IProcessCreateSSH)) {
// escape any occurances of "
str.Replace("\"", "\\\"");
}
str.Append("\"").Prepend("\"");
}
}
static wxArrayString __WrapInShell(const wxArrayString& args, size_t flags)
{
wxArrayString tmparr = args;
for(wxString& arg : tmparr) {
__WrapSpacesForShell(arg, flags);
}
wxString cmd = wxJoin(tmparr, ' ', 0);
wxArrayString command;
bool is_ssh = flags & IProcessCreateSSH;
if(shell_is_cmd && !is_ssh) {
wxString shell = wxGetenv("COMSPEC");
if(shell.IsEmpty()) {
shell = "CMD.EXE";
}
command.Add(shell);
command.Add("/C");
command.Add("\"" + cmd + "\"");
} else {
command.Add("/bin/sh");
command.Add("-c");
command.Add("'" + cmd + "'");
}
return command;
}
static wxArrayString __AddSshCommand(const wxArrayString& args, const wxString& wd, const wxString& sshAccountName,
clTempFile& tmpfile, const clEnvList_t* env_list)
{
#ifndef __WXMSW__
wxUnusedVar(tmpfile);
#endif
// we accept both SSHAccountInfo* & wxString* with the account name
if(sshAccountName.empty()) {
clERROR() << "CreateAsyncProcess: no ssh account name provided" << endl;
return args;
}
wxArrayString a;
auto accountInfo = SSHAccountInfo::LoadAccount(sshAccountName);
if(accountInfo.GetAccountName().empty()) {
clERROR() << "CreateAsyncProcess: could not locate ssh account:" << sshAccountName << endl;
return args;
}
// determine the ssh client we have
wxString ssh_client = "ssh";
//----------------------------------------------------------
// prepare the main command ("args") as a one liner string
//----------------------------------------------------------
wxArrayString* p_args = const_cast<wxArrayString*>(&args);
wxArrayString tmpargs;
// add any environment variables provided by the caller
if(env_list) {
for(const std::pair<wxString, wxString>& env_var : *env_list) {
tmpargs.Add(env_var.first + "=" + env_var.second);
}
}
if(!wd.empty()) {
// add working directory
tmpargs.Add("cd");
tmpargs.Add(wd);
tmpargs.Add("&&");
}
// add the command arguments
tmpargs.insert(tmpargs.end(), args.begin(), args.end());
p_args = &tmpargs;
wxString oneLiner = wxJoin(*p_args, ' ', 0);
#ifdef __WXMSW__
oneLiner.Prepend("\"").Append("\"");
#else
oneLiner.Replace("\"", "\\\""); // escape any double quotes
#endif
//----------------------------------------------------------
// build the executing command
//----------------------------------------------------------
// the following are common to both ssh / putty clients
a.Add(ssh_client);
a.Add(accountInfo.GetUsername() + "@" + accountInfo.GetHost());
a.Add("-t"); // force tty
a.Add("-p"); // port
a.Add(wxString() << accountInfo.GetPort()); // the port number
//----------------------------------------------------------
// we support extra args in the environment variable
// CL_SSH_OPTIONS
//----------------------------------------------------------
wxString sshEnv;
if(::wxGetEnv("CL_SSH_OPTIONS", &sshEnv)) {
wxArrayString sshOptionsArr = StringUtils::BuildArgv(sshEnv);
a.insert(a.end(), sshOptionsArr.begin(), sshOptionsArr.end());
}
a.Add(oneLiner);
return a;
}
static void __FixArgs(wxArrayString& args)
{
for(wxString& arg : args) {
// escape LF/CR
arg.Replace("\n", "");
arg.Replace("\r", "");
#if defined(__WXOSX__) || defined(__WXGTK__)
arg.Trim().Trim(false);
if(arg.length() > 1) {
if(arg.StartsWith("'") && arg.EndsWith("'")) {
arg.Remove(0, 1);
arg.RemoveLast();
} else if(arg.StartsWith("\"") && arg.EndsWith("\"")) {
arg.Remove(0, 1);
arg.RemoveLast();
}
}
#endif
}
}
IProcess* CreateAsyncProcess(wxEvtHandler* parent, const std::vector<wxString>& args, size_t flags,
const wxString& workingDir, const clEnvList_t* env, const wxString& sshAccountName)
{
wxArrayString wxargs;
wxargs.reserve(args.size());
for(const wxString& s : args) {
wxargs.Add(s);
}
return CreateAsyncProcess(parent, wxargs, flags, workingDir, env, sshAccountName);
}
IProcess* CreateAsyncProcess(wxEvtHandler* parent, const wxArrayString& args, size_t flags, const wxString& workingDir,
const clEnvList_t* env, const wxString& sshAccountName)
{
clEnvironment e(env);
wxArrayString c = args;
// sanity:
// Check that we have SSH executable
wxFileName sshpath;
if((flags & IProcessCreateSSH) && !FileUtils::FindExe("ssh", sshpath)) {
return nullptr;
}
// clDEBUG1() << "1: CreateAsyncProcess called with:" << c << endl;
if(flags & IProcessWrapInShell) {
// wrap the command in OS specific terminal
c = __WrapInShell(c, flags);
}
clTempFile tmpfile; // needed for putty clients
tmpfile.Persist(); // do not delete this file on destruct
if(flags & IProcessCreateSSH) {
c = __AddSshCommand(c, workingDir, sshAccountName, tmpfile, env);
}
// needed on linux where fork does not require the extra quoting
__FixArgs(c);
// clDEBUG1() << "2: CreateAsyncProcess called with:" << c << endl;
#ifdef __WXMSW__
return WinProcessImpl::Execute(parent, c, flags, workingDir);
#else
return UnixProcessImpl::Execute(parent, c, flags, workingDir);
#endif
}
IProcess* CreateAsyncProcess(wxEvtHandler* parent, const wxString& cmd, size_t flags, const wxString& workingDir,
const clEnvList_t* env, const wxString& sshAccountName)
{
auto args = StringUtils::BuildArgv(cmd);
return CreateAsyncProcess(parent, args, flags, workingDir, env, sshAccountName);
}
void CreateAsyncProcessCB(const wxString& cmd, std::function<void(const wxString&)> cb, size_t flags,
const wxString& workingDir, const clEnvList_t* env)
{
clEnvironment e(env);
CreateAsyncProcess(new __AsyncCallback(move(cb)), cmd, flags, workingDir, env, wxEmptyString);
}
IProcess* CreateSyncProcess(const wxString& cmd, size_t flags, const wxString& workingDir, const clEnvList_t* env)
{
return CreateAsyncProcess(nullptr, StringUtils::BuildArgv(cmd), flags | IProcessCreateSync, workingDir, env,
wxEmptyString);
}
// Static methods:
bool IProcess::GetProcessExitCode(int pid, int& exitCode)
{
wxUnusedVar(pid);
wxUnusedVar(exitCode);
exitCode = 0;
return true;
}
void IProcess::SetProcessExitCode(int pid, int exitCode)
{
wxUnusedVar(pid);
wxUnusedVar(exitCode);
}
void IProcess::WaitForTerminate(wxString& output)
{
if(IsRedirect()) {
wxString buff;
wxString buffErr;
while(Read(buff, buffErr)) {
output << buff;
if(!buff.IsEmpty() && !buffErr.IsEmpty()) {
output << "\n";
}
output << buffErr;
}
} else {
// Just wait for the process to terminate in a busy loop
while(IsAlive()) {
wxThread::Sleep(10);
}
}
}
void IProcess::SuspendAsyncReads()
{
if(m_thr) {
clDEBUG1() << "Suspending process reader thread..." << endl;
m_thr->Suspend();
clDEBUG1() << "Suspending process reader thread...done" << endl;
}
}
void IProcess::ResumeAsyncReads()
{
if(m_thr) {
clDEBUG1() << "Resuming process reader thread..." << endl;
m_thr->Resume();
clDEBUG1() << "Resuming process reader thread..." << endl;
}
}
|