1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/utilsexec.cpp
3 // Purpose: wxExecute implementation for MSW
4 // Author: Julian Smart
8 // Copyright: (c) 1998-2002 wxWindows dev team
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
40 #include "wx/stream.h"
41 #include "wx/process.h"
44 #include "wx/msw/private.h"
48 #if !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__SALFORDC__) && !defined(__WXMICROWIN__)
55 #if defined(__GNUWIN32__) && !defined(__TWIN32__)
56 #include <sys/unistd.h>
60 #if defined(__WIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__)
72 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
79 #include "wx/dde.h" // for WX_DDE hack in wxExecute
82 // ----------------------------------------------------------------------------
84 // ----------------------------------------------------------------------------
86 // this message is sent when the process we're waiting for terminates
87 #define wxWM_PROC_TERMINATED (WM_USER + 10000)
89 // ----------------------------------------------------------------------------
90 // this module globals
91 // ----------------------------------------------------------------------------
93 // we need to create a hidden window to receive the process termination
94 // notifications and for this we need a (Win) class name for it which we will
95 // register the first time it's needed
96 static const wxChar
*gs_classForHiddenWindow
= NULL
;
98 // ----------------------------------------------------------------------------
100 // ----------------------------------------------------------------------------
102 // structure describing the process we're being waiting for
109 if ( !::CloseHandle(hProcess
) )
111 wxLogLastError(wxT("CloseHandle(hProcess)"));
116 HWND hWnd
; // window to send wxWM_PROC_TERMINATED to
117 HANDLE hProcess
; // handle of the process
118 DWORD dwProcessId
; // pid of the process
120 DWORD dwExitCode
; // the exit code of the process
121 bool state
; // set to FALSE when the process finishes
124 #if defined(__WIN32__) && wxUSE_STREAMS
126 // ----------------------------------------------------------------------------
128 // ----------------------------------------------------------------------------
130 class wxPipeInputStream
: public wxInputStream
133 wxPipeInputStream(HANDLE hInput
);
134 virtual ~wxPipeInputStream();
136 // returns TRUE if the pipe is still opened
137 bool IsOpened() const { return m_hInput
!= INVALID_HANDLE_VALUE
; }
139 // returns TRUE if there is any data to be read from the pipe
140 bool IsAvailable() const;
143 size_t OnSysRead(void *buffer
, size_t len
);
149 class wxPipeOutputStream
: public wxOutputStream
152 wxPipeOutputStream(HANDLE hOutput
);
153 virtual ~wxPipeOutputStream();
156 size_t OnSysWrite(const void *buffer
, size_t len
);
162 // define this to let wxexec.cpp know that we know what we're doing
163 #define _WX_USED_BY_WXEXECUTE_
164 #include "../common/execcmn.cpp"
166 // ----------------------------------------------------------------------------
167 // wxPipe represents a Win32 anonymous pipe
168 // ----------------------------------------------------------------------------
173 // the symbolic names for the pipe ends
180 // default ctor doesn't do anything
181 wxPipe() { m_handles
[Read
] = m_handles
[Write
] = INVALID_HANDLE_VALUE
; }
183 // create the pipe, return TRUE if ok, FALSE on error
186 // default secutiry attributes
187 SECURITY_ATTRIBUTES security
;
189 security
.nLength
= sizeof(security
);
190 security
.lpSecurityDescriptor
= NULL
;
191 security
.bInheritHandle
= TRUE
; // to pass it to the child
193 if ( !::CreatePipe(&m_handles
[0], &m_handles
[1], &security
, 0) )
195 wxLogSysError(_("Failed to create an anonymous pipe"));
203 // return TRUE if we were created successfully
204 bool IsOk() const { return m_handles
[Read
] != INVALID_HANDLE_VALUE
; }
206 // return the descriptor for one of the pipe ends
207 HANDLE
operator[](Direction which
) const
209 wxASSERT_MSG( which
>= 0 && (size_t)which
< WXSIZEOF(m_handles
),
210 _T("invalid pipe index") );
212 return m_handles
[which
];
215 // detach a descriptor, meaning that the pipe dtor won't close it, and
217 HANDLE
Detach(Direction which
)
219 wxASSERT_MSG( which
>= 0 && (size_t)which
< WXSIZEOF(m_handles
),
220 _T("invalid pipe index") );
222 HANDLE handle
= m_handles
[which
];
223 m_handles
[which
] = INVALID_HANDLE_VALUE
;
228 // close the pipe descriptors
231 for ( size_t n
= 0; n
< WXSIZEOF(m_handles
); n
++ )
233 if ( m_handles
[n
] != INVALID_HANDLE_VALUE
)
235 ::CloseHandle(m_handles
[n
]);
236 m_handles
[n
] = INVALID_HANDLE_VALUE
;
241 // dtor closes the pipe descriptors
242 ~wxPipe() { Close(); }
248 #endif // wxUSE_STREAMS
250 // ============================================================================
252 // ============================================================================
256 // ----------------------------------------------------------------------------
257 // process termination detecting support
258 // ----------------------------------------------------------------------------
260 // thread function for the thread monitoring the process termination
261 static DWORD __stdcall
wxExecuteThread(void *arg
)
263 wxExecuteData
*data
= (wxExecuteData
*)arg
;
265 if ( ::WaitForSingleObject(data
->hProcess
, INFINITE
) != WAIT_OBJECT_0
)
267 wxLogDebug(_T("Waiting for the process termination failed!"));
271 if ( !::GetExitCodeProcess(data
->hProcess
, &data
->dwExitCode
) )
273 wxLogLastError(wxT("GetExitCodeProcess"));
276 wxASSERT_MSG( data
->dwExitCode
!= STILL_ACTIVE
,
277 wxT("process should have terminated") );
279 // send a message indicating process termination to the window
280 ::SendMessage(data
->hWnd
, wxWM_PROC_TERMINATED
, 0, (LPARAM
)data
);
285 // window procedure of a hidden window which is created just to receive
286 // the notification message when a process exits
287 LRESULT APIENTRY _EXPORT
wxExecuteWindowCbk(HWND hWnd
, UINT message
,
288 WPARAM wParam
, LPARAM lParam
)
290 if ( message
== wxWM_PROC_TERMINATED
)
292 DestroyWindow(hWnd
); // we don't need it any more
294 wxExecuteData
*data
= (wxExecuteData
*)lParam
;
297 data
->handler
->OnTerminate((int)data
->dwProcessId
,
298 (int)data
->dwExitCode
);
303 // we're executing synchronously, tell the waiting thread
304 // that the process finished
309 // asynchronous execution - we should do the clean up
317 return DefWindowProc(hWnd
, message
, wParam
, lParam
);
321 // ============================================================================
322 // implementation of IO redirection support classes
323 // ============================================================================
327 // ----------------------------------------------------------------------------
328 // wxPipeInputStreams
329 // ----------------------------------------------------------------------------
331 wxPipeInputStream::wxPipeInputStream(HANDLE hInput
)
336 wxPipeInputStream::~wxPipeInputStream()
338 if ( m_hInput
!= INVALID_HANDLE_VALUE
)
339 ::CloseHandle(m_hInput
);
342 bool wxPipeInputStream::IsAvailable() const
353 // function name is misleading, it works with anon pipes as well
354 DWORD rc
= ::PeekNamedPipe
357 NULL
, 0, // ptr to buffer and its size
358 NULL
, // [out] bytes read
359 &nAvailable
, // [out] bytes available
360 NULL
// [out] bytes left
365 if ( ::GetLastError() != ERROR_BROKEN_PIPE
)
368 wxLogLastError(_T("PeekNamedPipe"));
371 // don't try to continue reading from a pipe if an error occured or if
372 // it had been closed
373 ::CloseHandle(m_hInput
);
375 wxConstCast(this, wxPipeInputStream
)->m_hInput
= INVALID_HANDLE_VALUE
;
380 return nAvailable
!= 0;
384 size_t wxPipeInputStream::OnSysRead(void *buffer
, size_t len
)
386 // reading from a pipe may block if there is no more data, always check for
388 if ( !IsAvailable() )
390 m_lasterror
= wxSTREAM_EOF
;
395 m_lasterror
= wxSTREAM_NOERROR
;
398 if ( !::ReadFile(m_hInput
, buffer
, len
, &bytesRead
, NULL
) )
400 if ( ::GetLastError() == ERROR_BROKEN_PIPE
)
401 m_lasterror
= wxSTREAM_EOF
;
403 m_lasterror
= wxSTREAM_READ_ERROR
;
409 // ----------------------------------------------------------------------------
410 // wxPipeOutputStream
411 // ----------------------------------------------------------------------------
413 wxPipeOutputStream::wxPipeOutputStream(HANDLE hOutput
)
418 wxPipeOutputStream::~wxPipeOutputStream()
420 ::CloseHandle(m_hOutput
);
423 size_t wxPipeOutputStream::OnSysWrite(const void *buffer
, size_t len
)
427 m_lasterror
= wxSTREAM_NOERROR
;
428 if ( !::WriteFile(m_hOutput
, buffer
, len
, &bytesRead
, NULL
) )
430 if ( ::GetLastError() == ERROR_BROKEN_PIPE
)
431 m_lasterror
= wxSTREAM_EOF
;
433 m_lasterror
= wxSTREAM_READ_ERROR
;
439 #endif // wxUSE_STREAMS
443 // ============================================================================
444 // wxExecute functions family
445 // ============================================================================
449 // connect to the given server via DDE and ask it to execute the command
450 static bool wxExecuteDDE(const wxString
& ddeServer
,
451 const wxString
& ddeTopic
,
452 const wxString
& ddeCommand
)
457 wxConnectionBase
*conn
= client
.MakeConnection(_T(""),
464 else // connected to DDE server
466 // the added complication here is that although most
467 // programs use XTYP_EXECUTE for their DDE API, some
468 // important ones - like IE and other MS stuff - use
471 // so we try it first and then the other one if it
475 ok
= conn
->Request(ddeCommand
) != NULL
;
480 // now try execute - but show the errors
481 ok
= conn
->Execute(ddeCommand
);
490 long wxExecute(const wxString
& cmd
, int flags
, wxProcess
*handler
)
492 wxCHECK_MSG( !!cmd
, 0, wxT("empty command in wxExecute") );
497 // DDE hack: this is really not pretty, but we need to allow this for
498 // transparent handling of DDE servers in wxMimeTypesManager. Usually it
499 // returns the command which should be run to view/open/... a file of the
500 // given type. Sometimes, however, this command just launches the server
501 // and an additional DDE request must be made to really open the file. To
502 // keep all this well hidden from the application, we allow a special form
503 // of command: WX_DDE#<command>#DDE_SERVER#DDE_TOPIC#DDE_COMMAND in which
504 // case we execute just <command> and process the rest below
505 wxString ddeServer
, ddeTopic
, ddeCommand
;
506 static const size_t lenDdePrefix
= 7; // strlen("WX_DDE:")
507 if ( cmd
.Left(lenDdePrefix
) == _T("WX_DDE#") )
509 // speed up the concatenations below
510 ddeServer
.reserve(256);
511 ddeTopic
.reserve(256);
512 ddeCommand
.reserve(256);
514 const wxChar
*p
= cmd
.c_str() + 7;
515 while ( *p
&& *p
!= _T('#') )
527 wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
530 while ( *p
&& *p
!= _T('#') )
542 wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
545 while ( *p
&& *p
!= _T('#') )
557 wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
565 // if we want to just launch the program and not wait for its
566 // termination, try to execute DDE command right now, it can succeed if
567 // the process is already running - but as it fails if it's not
568 // running, suppress any errors it might generate
569 if ( !(flags
& wxEXEC_SYNC
) )
572 if ( wxExecuteDDE(ddeServer
, ddeTopic
, ddeCommand
) )
574 // a dummy PID - this is a hack, of course, but it's well worth
575 // it as we don't open a new server each time we're called
576 // which would be quite bad
588 #if defined(__WIN32__) && !defined(__TWIN32__)
590 // the IO redirection is only supported with wxUSE_STREAMS
591 BOOL redirect
= FALSE
;
594 wxPipe pipeIn
, pipeOut
, pipeErr
;
596 // we'll save here the copy of pipeIn[Write]
597 HANDLE hpipeStdinWrite
= INVALID_HANDLE_VALUE
;
599 // open the pipes to which child process IO will be redirected if needed
600 if ( handler
&& handler
->IsRedirected() )
602 // create pipes for redirecting stdin, stdout and stderr
603 if ( !pipeIn
.Create() || !pipeOut
.Create() || !pipeErr
.Create() )
605 wxLogSysError(_("Failed to redirect the child process IO"));
607 // indicate failure: we need to return different error code
608 // depending on the sync flag
609 return flags
& wxEXEC_SYNC
? -1 : 0;
614 #endif // wxUSE_STREAMS
616 // create the process
624 si
.dwFlags
= STARTF_USESTDHANDLES
;
626 si
.hStdInput
= pipeIn
[wxPipe::Read
];
627 si
.hStdOutput
= pipeOut
[wxPipe::Write
];
628 si
.hStdError
= pipeErr
[wxPipe::Write
];
630 // when the std IO is redirected, we don't show the (console) process
631 // window by default, but this can be overridden by the caller by
632 // specifying wxEXEC_NOHIDE flag
633 if ( !(flags
& wxEXEC_NOHIDE
) )
635 si
.dwFlags
|= STARTF_USESHOWWINDOW
;
636 si
.wShowWindow
= SW_HIDE
;
639 // we must duplicate the handle to the write side of stdin pipe to make
640 // it non inheritable: indeed, we must close the writing end of pipeIn
641 // before launching the child process as otherwise this handle will be
642 // inherited by the child which will never close it and so the pipe
643 // will never be closed and the child will be left stuck in ReadFile()
644 HANDLE pipeInWrite
= pipeIn
.Detach(wxPipe::Write
);
645 if ( !::DuplicateHandle
647 ::GetCurrentProcess(),
649 ::GetCurrentProcess(),
651 0, // desired access: unused here
652 FALSE
, // not inherited
653 DUPLICATE_SAME_ACCESS
// same access as for src handle
656 wxLogLastError(_T("DuplicateHandle"));
659 ::CloseHandle(pipeInWrite
);
661 #endif // wxUSE_STREAMS
663 PROCESS_INFORMATION pi
;
664 DWORD dwFlags
= CREATE_DEFAULT_ERROR_MODE
| CREATE_SUSPENDED
;
666 bool ok
= ::CreateProcess
668 NULL
, // application name (use only cmd line)
670 command
.c_str(), // full command line
671 NULL
, // security attributes: defaults for both
672 NULL
, // the process and its main thread
673 redirect
, // inherit handles if we use pipes
674 dwFlags
, // process creation flags
675 NULL
, // environment (use the same)
676 NULL
, // current directory (use the same)
677 &si
, // startup info (unused here)
682 // we can close the pipe ends used by child anyhow
685 ::CloseHandle(pipeIn
.Detach(wxPipe::Read
));
686 ::CloseHandle(pipeOut
.Detach(wxPipe::Write
));
687 ::CloseHandle(pipeErr
.Detach(wxPipe::Write
));
689 #endif // wxUSE_STREAMS
694 // close the other handles too
697 ::CloseHandle(pipeOut
.Detach(wxPipe::Read
));
698 ::CloseHandle(pipeErr
.Detach(wxPipe::Read
));
700 #endif // wxUSE_STREAMS
702 wxLogSysError(_("Execution of command '%s' failed"), command
.c_str());
704 return flags
& wxEXEC_SYNC
? -1 : 0;
708 // the input buffer bufOut is connected to stdout, this is why it is
709 // called bufOut and not bufIn
710 wxStreamTempInputBuffer bufOut
,
715 // We can now initialize the wxStreams
717 outStream
= new wxPipeInputStream(pipeOut
.Detach(wxPipe::Read
));
719 errStream
= new wxPipeInputStream(pipeErr
.Detach(wxPipe::Read
));
721 inStream
= new wxPipeOutputStream(hpipeStdinWrite
);
723 handler
->SetPipeStreams(outStream
, inStream
, errStream
);
725 bufOut
.Init(outStream
);
726 bufErr
.Init(errStream
);
728 #endif // wxUSE_STREAMS
730 // register the class for the hidden window used for the notifications
731 if ( !gs_classForHiddenWindow
)
733 gs_classForHiddenWindow
= _T("wxHiddenWindow");
736 wxZeroMemory(wndclass
);
737 wndclass
.lpfnWndProc
= (WNDPROC
)wxExecuteWindowCbk
;
738 wndclass
.hInstance
= wxGetInstance();
739 wndclass
.lpszClassName
= gs_classForHiddenWindow
;
741 if ( !::RegisterClass(&wndclass
) )
743 wxLogLastError(wxT("RegisterClass(hidden window)"));
747 // create a hidden window to receive notification about process
749 HWND hwnd
= ::CreateWindow(gs_classForHiddenWindow
, NULL
,
752 (HMENU
)NULL
, wxGetInstance(), 0);
753 wxASSERT_MSG( hwnd
, wxT("can't create a hidden window for wxExecute") );
756 wxExecuteData
*data
= new wxExecuteData
;
757 data
->hProcess
= pi
.hProcess
;
758 data
->dwProcessId
= pi
.dwProcessId
;
760 data
->state
= (flags
& wxEXEC_SYNC
) != 0;
761 if ( flags
& wxEXEC_SYNC
)
763 // handler may be !NULL for capturing program output, but we don't use
764 // it wxExecuteData struct in this case
765 data
->handler
= NULL
;
769 // may be NULL or not
770 data
->handler
= handler
;
774 HANDLE hThread
= ::CreateThread(NULL
,
781 // resume process we created now - whether the thread creation succeeded or
783 if ( ::ResumeThread(pi
.hThread
) == (DWORD
)-1 )
785 // ignore it - what can we do?
786 wxLogLastError(wxT("ResumeThread in wxExecute"));
789 // close unneeded handle
790 if ( !::CloseHandle(pi
.hThread
) )
791 wxLogLastError(wxT("CloseHandle(hThread)"));
795 wxLogLastError(wxT("CreateThread in wxExecute"));
800 // the process still started up successfully...
801 return pi
.dwProcessId
;
804 ::CloseHandle(hThread
);
807 // second part of DDE hack: now establish the DDE conversation with the
808 // just launched process
809 if ( !ddeServer
.empty() )
813 // give the process the time to init itself
815 // we use a very big timeout hoping that WaitForInputIdle() will return
816 // much sooner, but not INFINITE just in case the process hangs
817 // completely - like this we will regain control sooner or later
818 switch ( ::WaitForInputIdle(pi
.hProcess
, 10000 /* 10 seconds */) )
821 wxFAIL_MSG( _T("unexpected WaitForInputIdle() return code") );
825 wxLogLastError(_T("WaitForInputIdle() in wxExecute"));
828 wxLogDebug(_T("Timeout too small in WaitForInputIdle"));
834 // ok, process ready to accept DDE requests
835 ok
= wxExecuteDDE(ddeServer
, ddeTopic
, ddeCommand
);
840 if ( !(flags
& wxEXEC_SYNC
) )
842 // clean up will be done when the process terminates
845 return pi
.dwProcessId
;
848 // waiting until command executed (disable everything while doing it)
856 // wait until the child process terminates
857 while ( data
->state
)
862 #endif // wxUSE_STREAMS
864 // don't eat 100% of the CPU -- ugly but anything else requires
865 // real async IO which we don't have for the moment
876 DWORD dwExitCode
= data
->dwExitCode
;
879 // return the exit code
882 long instanceID
= WinExec((LPCSTR
) WXSTRINGCAST command
, SW_SHOW
);
884 return flags
& wxEXEC_SYNC
? -1 : 0;
886 if ( flags
& wxEXEC_SYNC
)
892 running
= GetModuleUsage((HINSTANCE
)instanceID
);
900 long wxExecute(wxChar
**argv
, int flags
, wxProcess
*handler
)
913 return wxExecute(command
, flags
, handler
);