/////////////////////////////////////////////////////////////////////////////
-// Name: utilsexec.cpp
+// Name: msw/utilsexec.cpp
// Purpose: Various utilities
// Author: Julian Smart
// Modified by:
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
#ifdef __GNUG__
-#pragma implementation
+ #pragma implementation
#endif
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
#ifndef WX_PRECOMP
-#include "wx/setup.h"
-#include "wx/utils.h"
-#include "wx/app.h"
-#include "wx/intl.h"
+ #include "wx/utils.h"
+ #include "wx/app.h"
+ #include "wx/intl.h"
#endif
#include "wx/log.h"
-#include "wx/process.h"
-#include "wx/msw/private.h"
+#ifdef __WIN32__
+ #include "wx/stream.h"
+ #include "wx/process.h"
+#endif
-#include <windows.h>
+#include "wx/msw/private.h"
#include <ctype.h>
-#if !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__SALFORDC__)
-#include <direct.h>
+#if !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__SALFORDC__) && !defined(__WXMICROWIN__)
+ #include <direct.h>
#ifndef __MWERKS__
-#include <dos.h>
+ #include <dos.h>
#endif
#endif
-#ifdef __GNUWIN32__
-#ifndef __TWIN32__
-#include <sys/unistd.h>
-#include <sys/stat.h>
-#endif
+#if defined(__GNUWIN32__) && !defined(__TWIN32__)
+ #include <sys/unistd.h>
+ #include <sys/stat.h>
#endif
-#if defined(__WIN32__) && !defined(__WXWINE__)
+#if defined(__WIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__)
#include <io.h>
#ifndef __GNUWIN32__
#endif
#include <stdarg.h>
+#if wxUSE_IPC
+ #include "wx/dde.h" // for WX_DDE hack in wxExecute
+#endif // wxUSE_IPC
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
// this message is sent when the process we're waiting for terminates
#define wxWM_PROC_TERMINATED (WM_USER + 10000)
+// ----------------------------------------------------------------------------
+// this module globals
+// ----------------------------------------------------------------------------
+
+// we need to create a hidden window to receive the process termination
+// notifications and for this we need a (Win) class name for it which we will
+// register the first time it's needed
+static const wxChar *gs_classForHiddenWindow = NULL;
+
+// ----------------------------------------------------------------------------
+// private types
+// ----------------------------------------------------------------------------
+
// structure describing the process we're being waiting for
struct wxExecuteData
{
#ifndef __WIN16__
if ( !::CloseHandle(hProcess) )
{
- wxLogLastError("CloseHandle(hProcess)");
+ wxLogLastError(wxT("CloseHandle(hProcess)"));
}
#endif
}
bool state; // set to FALSE when the process finishes
};
+#if defined(__WIN32__) && wxUSE_STREAMS
+
+// ----------------------------------------------------------------------------
+// wxPipeStreams
+// ----------------------------------------------------------------------------
+
+class wxPipeInputStream: public wxInputStream
+{
+public:
+ wxPipeInputStream(HANDLE hInput);
+ ~wxPipeInputStream();
+
+ virtual bool Eof() const;
+
+protected:
+ size_t OnSysRead(void *buffer, size_t len);
+
+protected:
+ HANDLE m_hInput;
+};
+
+class wxPipeOutputStream: public wxOutputStream
+{
+public:
+ wxPipeOutputStream(HANDLE hOutput);
+ ~wxPipeOutputStream();
+
+protected:
+ size_t OnSysWrite(const void *buffer, size_t len);
+
+protected:
+ HANDLE m_hOutput;
+};
+
+// ==================
+// wxPipeInputStream
+// ==================
+
+wxPipeInputStream::wxPipeInputStream(HANDLE hInput)
+{
+ m_hInput = hInput;
+}
+
+wxPipeInputStream::~wxPipeInputStream()
+{
+ ::CloseHandle(m_hInput);
+}
+
+bool wxPipeInputStream::Eof() const
+{
+ DWORD nAvailable;
+
+ // function name is misleading, it works with anon pipes as well
+ DWORD rc = ::PeekNamedPipe
+ (
+ m_hInput, // handle
+ NULL, 0, // ptr to buffer and its size
+ NULL, // [out] bytes read
+ &nAvailable, // [out] bytes available
+ NULL // [out] bytes left
+ );
+
+ if ( !rc )
+ {
+ if ( ::GetLastError() != ERROR_BROKEN_PIPE )
+ {
+ // unexpected error
+ wxLogLastError(_T("PeekNamedPipe"));
+ }
+
+ // don't try to continue reading from a pipe if an error occured or if
+ // it had been closed
+ return TRUE;
+ }
+ else
+ {
+ return nAvailable == 0;
+ }
+}
+
+size_t wxPipeInputStream::OnSysRead(void *buffer, size_t len)
+{
+ // reading from a pipe may block if there is no more data, always check for
+ // EOF first
+ m_lasterror = wxSTREAM_NOERROR;
+ if ( Eof() )
+ return 0;
+
+ DWORD bytesRead;
+ if ( !::ReadFile(m_hInput, buffer, len, &bytesRead, NULL) )
+ {
+ if ( ::GetLastError() == ERROR_BROKEN_PIPE )
+ m_lasterror = wxSTREAM_EOF;
+ else
+ m_lasterror = wxSTREAM_READ_ERROR;
+ }
+
+ return bytesRead;
+}
+
+// ==================
+// wxPipeOutputStream
+// ==================
+
+wxPipeOutputStream::wxPipeOutputStream(HANDLE hOutput)
+{
+ m_hOutput = hOutput;
+}
+
+wxPipeOutputStream::~wxPipeOutputStream()
+{
+ ::CloseHandle(m_hOutput);
+}
+
+size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t len)
+{
+ DWORD bytesRead;
+
+ m_lasterror = wxSTREAM_NOERROR;
+ if ( !::WriteFile(m_hOutput, buffer, len, &bytesRead, NULL) )
+ {
+ if ( ::GetLastError() == ERROR_BROKEN_PIPE )
+ m_lasterror = wxSTREAM_EOF;
+ else
+ m_lasterror = wxSTREAM_READ_ERROR;
+ }
+
+ return bytesRead;
+}
+
+#endif // __WIN32__
+
+// ============================================================================
+// implementation
+// ============================================================================
#ifdef __WIN32__
-static DWORD wxExecuteThread(wxExecuteData *data)
+
+static DWORD __stdcall wxExecuteThread(void *arg)
{
+ wxExecuteData *data = (wxExecuteData*)arg;
+
WaitForSingleObject(data->hProcess, INFINITE);
// get the exit code
if ( !GetExitCodeProcess(data->hProcess, &data->dwExitCode) )
{
- wxLogLastError("GetExitCodeProcess");
+ wxLogLastError(wxT("GetExitCodeProcess"));
}
wxASSERT_MSG( data->dwExitCode != STILL_ACTIVE,
- "process should have terminated" );
+ wxT("process should have terminated") );
// send a message indicating process termination to the window
SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data);
return 0;
}
-#endif
// window procedure of a hidden window which is created just to receive
// the notification message when a process exits
// asynchronous execution - we should do the clean up
delete data;
}
+
+ return 0;
}
+ else
+ {
+ return DefWindowProc(hWnd, message, wParam, lParam);
+ }
+}
+#endif // Win32
- return 0;
+#if wxUSE_IPC
+
+// connect to the given server via DDE and ask it to execute the command
+static bool wxExecuteDDE(const wxString& ddeServer,
+ const wxString& ddeTopic,
+ const wxString& ddeCommand)
+{
+ bool ok;
+
+ wxDDEClient client;
+ wxConnectionBase *conn = client.MakeConnection(_T(""),
+ ddeServer,
+ ddeTopic);
+ if ( !conn )
+ {
+ ok = FALSE;
+ }
+ else // connected to DDE server
+ {
+ // the added complication here is that although most
+ // programs use XTYP_EXECUTE for their DDE API, some
+ // important ones - like IE and other MS stuff - use
+ // XTYP_REQUEST!
+ //
+ // so we try it first and then the other one if it
+ // failed
+ {
+ wxLogNull noErrors;
+ ok = conn->Request(ddeCommand) != NULL;
+ }
+
+ if ( !ok )
+ {
+ // now try execute - but show the errors
+ ok = conn->Execute(ddeCommand);
+ }
+ }
+
+ return ok;
}
-extern char wxPanelClassName[];
+#endif // wxUSE_IPC
-long wxExecute(const wxString& command, bool sync, wxProcess *handler)
+long wxExecute(const wxString& cmd, bool sync, wxProcess *handler)
{
- wxCHECK_MSG( !!command, 0, "empty command in wxExecute" );
+ wxCHECK_MSG( !!cmd, 0, wxT("empty command in wxExecute") );
+
+ wxString command;
+
+#if wxUSE_IPC
+ // DDE hack: this is really not pretty, but we need to allow this for
+ // transparent handling of DDE servers in wxMimeTypesManager. Usually it
+ // returns the command which should be run to view/open/... a file of the
+ // given type. Sometimes, however, this command just launches the server
+ // and an additional DDE request must be made to really open the file. To
+ // keep all this well hidden from the application, we allow a special form
+ // of command: WX_DDE#<command>#DDE_SERVER#DDE_TOPIC#DDE_COMMAND in which
+ // case we execute just <command> and process the rest below
+ wxString ddeServer, ddeTopic, ddeCommand;
+ static const size_t lenDdePrefix = 7; // strlen("WX_DDE:")
+ if ( cmd.Left(lenDdePrefix) == _T("WX_DDE#") )
+ {
+ // speed up the concatenations below
+ ddeServer.reserve(256);
+ ddeTopic.reserve(256);
+ ddeCommand.reserve(256);
+
+ const wxChar *p = cmd.c_str() + 7;
+ while ( *p && *p != _T('#') )
+ {
+ command += *p++;
+ }
+
+ if ( *p )
+ {
+ // skip '#'
+ p++;
+ }
+ else
+ {
+ wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
+ }
+
+ while ( *p && *p != _T('#') )
+ {
+ ddeServer += *p++;
+ }
+
+ if ( *p )
+ {
+ // skip '#'
+ p++;
+ }
+ else
+ {
+ wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
+ }
+
+ while ( *p && *p != _T('#') )
+ {
+ ddeTopic += *p++;
+ }
+
+ if ( *p )
+ {
+ // skip '#'
+ p++;
+ }
+ else
+ {
+ wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
+ }
+
+ while ( *p )
+ {
+ ddeCommand += *p++;
+ }
+
+ // if we want to just launch the program and not wait for its
+ // termination, try to execute DDE command right now, it can succeed if
+ // the process is already running - but as it fails if it's not
+ // running, suppress any errors it might generate
+ if ( !sync )
+ {
+ wxLogNull noErrors;
+ if ( wxExecuteDDE(ddeServer, ddeTopic, ddeCommand) )
+ {
+ // a dummy PID - this is a hack, of course, but it's well worth
+ // it as we don't open a new server each time we're called
+ // which would be quite bad
+ return -1;
+ }
+ }
+ }
+ else
+#endif // wxUSE_IPC
+ {
+ // no DDE
+ command = cmd;
+ }
#if defined(__WIN32__) && !defined(__TWIN32__)
- // the old code is disabled because we really need a process handle
- // if we want to execute it asynchronously or even just get its
- // return code and for this we must use CreateProcess() and not
- // ShellExecute()
-#if 0
- // isolate command and arguments
- wxString commandName;
- bool insideQuotes = FALSE;
- const char *pc;
- for ( pc = command.c_str(); *pc != '\0'; pc++ )
+
+ // the IO redirection is only supported with wxUSE_STREAMS
+ BOOL redirect = FALSE;
+#if wxUSE_STREAMS
+ // the first elements are reading ends, the second are the writing ones
+ HANDLE hpipeStdin[2],
+ hpipeStdout[2],
+ hpipeStderr[2];
+ HANDLE hpipeStdinWrite = INVALID_HANDLE_VALUE;
+
+ // open the pipes to which child process IO will be redirected if needed
+ if ( handler && handler->IsRedirected() )
{
- switch ( *pc )
+ // default secutiry attributes
+ SECURITY_ATTRIBUTES security;
+
+ security.nLength = sizeof(security);
+ security.lpSecurityDescriptor = NULL;
+ security.bInheritHandle = TRUE;
+
+ // create stdin pipe
+ if ( !::CreatePipe(&hpipeStdin[0], &hpipeStdin[1], &security, 0) )
{
- case ' ':
- case '\t':
- if ( !insideQuotes )
- break;
- // fall through
+ wxLogSysError(_("Can't create the inter-process read pipe"));
- case '"':
- insideQuotes = !insideQuotes;
- // fall through
+ // indicate failure in both cases
+ return sync ? -1 : 0;
+ }
- default:
- commandName += *pc;
- continue; // skip the next break
+ // and a stdout one
+ if ( !::CreatePipe(&hpipeStdout[0], &hpipeStdout[1], &security, 0) )
+ {
+ ::CloseHandle(hpipeStdin[0]);
+ ::CloseHandle(hpipeStdin[1]);
+
+ wxLogSysError(_("Can't create the inter-process write pipe"));
+
+ return sync ? -1 : 0;
}
- // only reached for space not inside quotes
- break;
+ (void)::CreatePipe(&hpipeStderr[0], &hpipeStderr[1], &security, 0);
+
+ redirect = TRUE;
}
+#endif // wxUSE_STREAMS
- wxString commandArgs = pc;
-
- wxWindow *winTop = wxTheApp->GetTopWindow();
- HWND hwndTop = (HWND)(winTop ? winTop->GetHWND() : 0);
-
- HANDLE result;
-#ifdef __GNUWIN32__
- result = ShellExecute(hwndTop,
- (const wchar_t)"open",
- (const wchar_t)commandName,
- (const wchar_t)commandArgs,
- (const wchar_t)NULL,
- SW_SHOWNORMAL);
-#else // !GNUWIN32
- result = ShellExecute(hwndTop, "open", commandName,
- commandArgs, NULL, SW_SHOWNORMAL);
-#endif // GNUWIN32
-
- if ( ((long)result) <= 32 )
- wxLogSysError(_("Can't execute command '%s'"), command.c_str());
-
- return result;
-#else // 1
// create the process
STARTUPINFO si;
-#ifdef __GNUWIN32__
- memset(&si, 0, sizeof(si));
-#else
- ::ZeroMemory(&si, sizeof(si));
-#endif
-
+ wxZeroMemory(si);
si.cb = sizeof(si);
+#if wxUSE_STREAMS
+ if ( redirect )
+ {
+ // when the std IO is redirected, we don't show the (console) process
+ // window
+ si.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
+
+ si.hStdInput = hpipeStdin[0];
+ si.hStdOutput = hpipeStdout[1];
+ si.hStdError = hpipeStderr[1];
+
+ si.wShowWindow = SW_HIDE;
+
+ // we must duplicate the handle to the write side of stdin pipe to make
+ // it non inheritable: indeed, we must close hpipeStdin[1] before
+ // launching the child process as otherwise this handle will be
+ // inherited by the child which will never close it and so the pipe
+ // will never be closed and the child will be left stuck in ReadFile()
+ if ( !::DuplicateHandle
+ (
+ GetCurrentProcess(),
+ hpipeStdin[1],
+ GetCurrentProcess(),
+ &hpipeStdinWrite,
+ 0, // desired access: unused here
+ FALSE, // not inherited
+ DUPLICATE_SAME_ACCESS // same access as for src handle
+ ) )
+ {
+ wxLogLastError(_T("DuplicateHandle"));
+ }
+
+ ::CloseHandle(hpipeStdin[1]);
+ }
+#endif // wxUSE_STREAMS
+
PROCESS_INFORMATION pi;
+ DWORD dwFlags = CREATE_DEFAULT_ERROR_MODE | CREATE_SUSPENDED;
+
+ bool ok = ::CreateProcess
+ (
+ NULL, // application name (use only cmd line)
+ (wxChar *)
+ command.c_str(), // full command line
+ NULL, // security attributes: defaults for both
+ NULL, // the process and its main thread
+ redirect, // inherit handles if we use pipes
+ dwFlags, // process creation flags
+ NULL, // environment (use the same)
+ NULL, // current directory (use the same)
+ &si, // startup info (unused here)
+ &pi // process info
+ ) != 0;
+
+#if wxUSE_STREAMS
+ // we can close the pipe ends used by child anyhow
+ if ( redirect )
+ {
+ ::CloseHandle(hpipeStdin[0]);
+ ::CloseHandle(hpipeStdout[1]);
+ ::CloseHandle(hpipeStderr[1]);
+ }
+#endif // wxUSE_STREAMS
- if ( ::CreateProcess(
- NULL, // application name (use only cmd line)
- (char *)command.c_str(), // full command line
- NULL, // security attributes: defaults for both
- NULL, // the process and its main thread
- FALSE, // don't inherit handles
- CREATE_DEFAULT_ERROR_MODE, // flags
- NULL, // environment (use the same)
- NULL, // current directory (use the same)
- &si, // startup info (unused here)
- &pi // process info
- ) == 0 )
+ if ( !ok )
{
+#if wxUSE_STREAMS
+ // close the other handles too
+ if ( redirect )
+ {
+ ::CloseHandle(hpipeStdout[0]);
+ ::CloseHandle(hpipeStderr[0]);
+ }
+#endif // wxUSE_STREAMS
+
wxLogSysError(_("Execution of command '%s' failed"), command.c_str());
- return 0;
+ return sync ? -1 : 0;
}
- // close unneeded handle
- if ( !::CloseHandle(pi.hThread) )
- wxLogLastError("CloseHandle(hThread)");
+#if wxUSE_STREAMS
+ if ( redirect )
+ {
+ // We can now initialize the wxStreams
+ wxInputStream *inStream = new wxPipeInputStream(hpipeStdout[0]),
+ *errStream = new wxPipeInputStream(hpipeStderr[0]);
+ wxOutputStream *outStream = new wxPipeOutputStream(hpipeStdinWrite);
+
+ handler->SetPipeStreams(inStream, outStream, errStream);
+ }
+#endif // wxUSE_STREAMS
+
+ // register the class for the hidden window used for the notifications
+ if ( !gs_classForHiddenWindow )
+ {
+ gs_classForHiddenWindow = _T("wxHiddenWindow");
+
+ WNDCLASS wndclass;
+ wxZeroMemory(wndclass);
+ wndclass.lpfnWndProc = (WNDPROC)wxExecuteWindowCbk;
+ wndclass.hInstance = wxGetInstance();
+ wndclass.lpszClassName = gs_classForHiddenWindow;
+
+ if ( !::RegisterClass(&wndclass) )
+ {
+ wxLogLastError(wxT("RegisterClass(hidden window)"));
+ }
+ }
// create a hidden window to receive notification about process
// termination
- HWND hwnd = ::CreateWindow(wxPanelClassName, NULL, 0, 0, 0, 0, 0, NULL,
+ HWND hwnd = ::CreateWindow(gs_classForHiddenWindow, NULL,
+ WS_OVERLAPPEDWINDOW,
+ 0, 0, 0, 0, NULL,
(HMENU)NULL, wxGetInstance(), 0);
- wxASSERT_MSG( hwnd, "can't create a hidden window for wxExecute" );
-
- FARPROC ExecuteWindowInstance = MakeProcInstance((FARPROC)wxExecuteWindowCbk,
- wxGetInstance());
-
- ::SetWindowLong(hwnd, GWL_WNDPROC, (LONG) ExecuteWindowInstance);
+ wxASSERT_MSG( hwnd, wxT("can't create a hidden window for wxExecute") );
// Alloc data
wxExecuteData *data = new wxExecuteData;
data->state = sync;
if ( sync )
{
- wxASSERT_MSG( !handler, "wxProcess param ignored for sync execution" );
-
+ // handler may be !NULL for capturing program output, but we don't use
+ // it wxExecuteData struct in this case
data->handler = NULL;
}
else
DWORD tid;
HANDLE hThread = ::CreateThread(NULL,
0,
- (LPTHREAD_START_ROUTINE)wxExecuteThread,
+ wxExecuteThread,
(void *)data,
0,
&tid);
+ // resume process we created now - whether the thread creation succeeded or
+ // not
+ if ( ::ResumeThread(pi.hThread) == (DWORD)-1 )
+ {
+ // ignore it - what can we do?
+ wxLogLastError(wxT("ResumeThread in wxExecute"));
+ }
+
+ // close unneeded handle
+ if ( !::CloseHandle(pi.hThread) )
+ wxLogLastError(wxT("CloseHandle(hThread)"));
+
if ( !hThread )
{
- wxLogLastError("CreateThread in wxExecute");
+ wxLogLastError(wxT("CreateThread in wxExecute"));
DestroyWindow(hwnd);
delete data;
return pi.dwProcessId;
}
+ ::CloseHandle(hThread);
+
+#if wxUSE_IPC
+ // second part of DDE hack: now establish the DDE conversation with the
+ // just launched process
+ if ( !ddeServer.empty() )
+ {
+ bool ok;
+
+ // give the process the time to init itself
+ //
+ // we use a very big timeout hoping that WaitForInputIdle() will return
+ // much sooner, but not INFINITE just in case the process hangs
+ // completely - like this we will regain control sooner or later
+ switch ( ::WaitForInputIdle(pi.hProcess, 10000 /* 10 seconds */) )
+ {
+ default:
+ wxFAIL_MSG( _T("unexpected WaitForInputIdle() return code") );
+ // fall through
+
+ case -1:
+ wxLogLastError(_T("WaitForInputIdle() in wxExecute"));
+
+ case WAIT_TIMEOUT:
+ wxLogDebug(_T("Timeout too small in WaitForInputIdle"));
+
+ ok = FALSE;
+ break;
+
+ case 0:
+ // ok, process ready to accept DDE requests
+ ok = wxExecuteDDE(ddeServer, ddeTopic, ddeCommand);
+ }
+ }
+#endif // wxUSE_IPC
+
if ( !sync )
{
// clean up will be done when the process terminates
return pi.dwProcessId;
}
- // waiting until command executed
+ // waiting until command executed (disable everything while doing it)
+#if wxUSE_GUI
+ {
+ wxBusyCursor bc;
+
+ wxWindowDisabler wd;
+#endif // wxUSE_GUI
+
while ( data->state )
wxYield();
+#if wxUSE_GUI
+ }
+#endif // wxUSE_GUI
+
DWORD dwExitCode = data->dwExitCode;
delete data;
// return the exit code
return dwExitCode;
-#endif // 0/1
#else // Win16
long instanceID = WinExec((LPCSTR) WXSTRINGCAST command, SW_SHOW);
if (instanceID < 32) return(0);
return wxExecute(command, sync, handler);
}
-bool wxGetFullHostName(wxChar *buf, int maxSize)
-{
- DWORD nSize = maxSize;
- if ( !::GetComputerName(buf, &nSize) )
- {
- wxLogLastError("GetComputerName");
-
- return FALSE;
- }
-
- return TRUE;
-}