]> git.saurik.com Git - wxWidgets.git/blame - src/msw/utilsexc.cpp
fixing length param, see #10846
[wxWidgets.git] / src / msw / utilsexc.cpp
CommitLineData
32592631 1/////////////////////////////////////////////////////////////////////////////
9cd03a43 2// Name: src/msw/utilsexc.cpp
79066131 3// Purpose: wxExecute implementation for MSW
32592631
GL
4// Author: Julian Smart
5// Modified by:
6// Created: 04/01/98
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) 1998-2002 wxWidgets dev team
65571936 9// Licence: wxWindows licence
32592631
GL
10/////////////////////////////////////////////////////////////////////////////
11
b568d04f
VZ
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
19
32592631
GL
20// For compilers that support precompilation, includes "wx.h".
21#include "wx/wxprec.h"
22
23#ifdef __BORLANDC__
b568d04f 24 #pragma hdrstop
32592631
GL
25#endif
26
27#ifndef WX_PRECOMP
b568d04f
VZ
28 #include "wx/utils.h"
29 #include "wx/app.h"
30 #include "wx/intl.h"
068a7cfe 31 #include "wx/log.h"
530ecef0
WS
32 #if wxUSE_STREAMS
33 #include "wx/stream.h"
34 #endif
02761f6c 35 #include "wx/module.h"
2ae8a353 36#endif
32592631 37
eccd1992 38#include "wx/process.h"
204abcd4 39#include "wx/thread.h"
e2478fde 40#include "wx/apptrait.h"
dbbcfbb6 41#include "wx/evtloop.h"
5a8561fc 42#include "wx/vector.h"
e2478fde 43
eccd1992 44
32592631 45#include "wx/msw/private.h"
dbeac4bd 46
32592631
GL
47#include <ctype.h>
48
f172cb82 49#if !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
b568d04f 50 #include <direct.h>
17dff81c 51#ifndef __MWERKS__
b568d04f 52 #include <dos.h>
32592631 53#endif
17dff81c 54#endif
32592631 55
b39dbf34 56#if defined(__GNUWIN32__)
b568d04f
VZ
57 #include <sys/unistd.h>
58 #include <sys/stat.h>
57c208c5 59#endif
32592631 60
eccd1992
VZ
61#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
62 #ifndef __UNIX__
63 #include <io.h>
64 #endif
32592631 65
eccd1992
VZ
66 #ifndef __GNUWIN32__
67 #include <shellapi.h>
68 #endif
32592631
GL
69#endif
70
71#include <stdio.h>
72#include <stdlib.h>
73#include <string.h>
74#ifndef __WATCOMC__
3f4a0c5b
VZ
75 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
76 #include <errno.h>
77 #endif
32592631
GL
78#endif
79#include <stdarg.h>
80
731dd422
VZ
81#if wxUSE_IPC
82 #include "wx/dde.h" // for WX_DDE hack in wxExecute
83#endif // wxUSE_IPC
5bd3a2da 84
eccd1992 85// implemented in utils.cpp
487f2d58 86extern "C" WXDLLIMPEXP_BASE HWND
eccd1992
VZ
87wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
88
b568d04f
VZ
89// ----------------------------------------------------------------------------
90// constants
91// ----------------------------------------------------------------------------
92
cb6827a8
VZ
93// this message is sent when the process we're waiting for terminates
94#define wxWM_PROC_TERMINATED (WM_USER + 10000)
32592631 95
b568d04f
VZ
96// ----------------------------------------------------------------------------
97// this module globals
98// ----------------------------------------------------------------------------
99
100// we need to create a hidden window to receive the process termination
101// notifications and for this we need a (Win) class name for it which we will
102// register the first time it's needed
eccd1992 103static const wxChar *wxMSWEXEC_WNDCLASSNAME = wxT("_wxExecute_Internal_Class");
b568d04f
VZ
104static const wxChar *gs_classForHiddenWindow = NULL;
105
5a8561fc
VZ
106// event used to wake up threads waiting in wxExecuteThread
107static HANDLE gs_heventShutdown = NULL;
108
109// handles of all threads monitoring the execution of asynchronously running
110// processes
111static wxVector<HANDLE> gs_asyncThreads;
112
b568d04f
VZ
113// ----------------------------------------------------------------------------
114// private types
115// ----------------------------------------------------------------------------
116
cb6827a8
VZ
117// structure describing the process we're being waiting for
118struct wxExecuteData
119{
120public:
121 ~wxExecuteData()
122 {
123 if ( !::CloseHandle(hProcess) )
124 {
f6bcfd97 125 wxLogLastError(wxT("CloseHandle(hProcess)"));
cb6827a8
VZ
126 }
127 }
128
129 HWND hWnd; // window to send wxWM_PROC_TERMINATED to
130 HANDLE hProcess; // handle of the process
131 DWORD dwProcessId; // pid of the process
132 wxProcess *handler;
133 DWORD dwExitCode; // the exit code of the process
27d2dbbc 134 bool state; // set to false when the process finishes
32592631
GL
135};
136
eccd1992
VZ
137class wxExecuteModule : public wxModule
138{
139public:
140 virtual bool OnInit() { return true; }
141 virtual void OnExit()
142 {
5a8561fc
VZ
143 if ( gs_heventShutdown )
144 {
145 // stop any threads waiting for the termination of asynchronously
146 // running processes
147 if ( !::SetEvent(gs_heventShutdown) )
148 {
149 wxLogDebug(_T("Failed to set shutdown event in wxExecuteModule"));
150 }
151
152 ::CloseHandle(gs_heventShutdown);
153 gs_heventShutdown = NULL;
154
155 // now wait until they terminate
156 if ( !gs_asyncThreads.empty() )
157 {
158 const size_t numThreads = gs_asyncThreads.size();
159
160 if ( ::WaitForMultipleObjects
161 (
162 numThreads,
163 &gs_asyncThreads[0],
164 TRUE, // wait for all of them to become signalled
165 3000 // long but finite value
166 ) == WAIT_TIMEOUT )
167 {
168 wxLogDebug(_T("Failed to stop all wxExecute monitor threads"));
169 }
170
171 for ( size_t n = 0; n < numThreads; n++ )
172 {
173 ::CloseHandle(gs_asyncThreads[n]);
174 }
175
176 gs_asyncThreads.clear();
177 }
178 }
179
9978ac8e 180 if ( gs_classForHiddenWindow )
eccd1992
VZ
181 {
182 if ( !::UnregisterClass(wxMSWEXEC_WNDCLASSNAME, wxGetInstance()) )
183 {
184 wxLogLastError(_T("UnregisterClass(wxExecClass)"));
185 }
186
187 gs_classForHiddenWindow = NULL;
188 }
189 }
190
191private:
192 DECLARE_DYNAMIC_CLASS(wxExecuteModule)
193};
194
5a8561fc
VZ
195IMPLEMENT_DYNAMIC_CLASS(wxExecuteModule, wxModule)
196
eccd1992 197#if wxUSE_STREAMS && !defined(__WXWINCE__)
8b33ae2d 198
8b33ae2d
GL
199// ----------------------------------------------------------------------------
200// wxPipeStreams
201// ----------------------------------------------------------------------------
202
f6bcfd97
BP
203class wxPipeInputStream: public wxInputStream
204{
8b33ae2d
GL
205public:
206 wxPipeInputStream(HANDLE hInput);
79066131 207 virtual ~wxPipeInputStream();
8b33ae2d 208
27d2dbbc 209 // returns true if the pipe is still opened
79066131
VZ
210 bool IsOpened() const { return m_hInput != INVALID_HANDLE_VALUE; }
211
27d2dbbc 212 // returns true if there is any data to be read from the pipe
2b5f62a0 213 virtual bool CanRead() const;
f6bcfd97 214
8b33ae2d
GL
215protected:
216 size_t OnSysRead(void *buffer, size_t len);
217
218protected:
219 HANDLE m_hInput;
22f3361e 220
c0c133e1 221 wxDECLARE_NO_COPY_CLASS(wxPipeInputStream);
8b33ae2d
GL
222};
223
f6bcfd97
BP
224class wxPipeOutputStream: public wxOutputStream
225{
8b33ae2d
GL
226public:
227 wxPipeOutputStream(HANDLE hOutput);
8f0ff178
RN
228 virtual ~wxPipeOutputStream() { Close(); }
229 bool Close();
8b33ae2d
GL
230
231protected:
232 size_t OnSysWrite(const void *buffer, size_t len);
233
234protected:
235 HANDLE m_hOutput;
22f3361e 236
c0c133e1 237 wxDECLARE_NO_COPY_CLASS(wxPipeOutputStream);
8b33ae2d
GL
238};
239
79066131
VZ
240// define this to let wxexec.cpp know that we know what we're doing
241#define _WX_USED_BY_WXEXECUTE_
242#include "../common/execcmn.cpp"
243
244// ----------------------------------------------------------------------------
245// wxPipe represents a Win32 anonymous pipe
246// ----------------------------------------------------------------------------
247
248class wxPipe
249{
250public:
251 // the symbolic names for the pipe ends
252 enum Direction
253 {
254 Read,
255 Write
256 };
257
258 // default ctor doesn't do anything
259 wxPipe() { m_handles[Read] = m_handles[Write] = INVALID_HANDLE_VALUE; }
260
27d2dbbc 261 // create the pipe, return true if ok, false on error
79066131
VZ
262 bool Create()
263 {
264 // default secutiry attributes
265 SECURITY_ATTRIBUTES security;
266
267 security.nLength = sizeof(security);
268 security.lpSecurityDescriptor = NULL;
269 security.bInheritHandle = TRUE; // to pass it to the child
270
271 if ( !::CreatePipe(&m_handles[0], &m_handles[1], &security, 0) )
272 {
273 wxLogSysError(_("Failed to create an anonymous pipe"));
274
27d2dbbc 275 return false;
79066131
VZ
276 }
277
27d2dbbc 278 return true;
79066131
VZ
279 }
280
27d2dbbc 281 // return true if we were created successfully
79066131
VZ
282 bool IsOk() const { return m_handles[Read] != INVALID_HANDLE_VALUE; }
283
284 // return the descriptor for one of the pipe ends
82baa5e4 285 HANDLE operator[](Direction which) const { return m_handles[which]; }
79066131
VZ
286
287 // detach a descriptor, meaning that the pipe dtor won't close it, and
288 // return it
289 HANDLE Detach(Direction which)
290 {
79066131
VZ
291 HANDLE handle = m_handles[which];
292 m_handles[which] = INVALID_HANDLE_VALUE;
293
294 return handle;
295 }
296
297 // close the pipe descriptors
298 void Close()
299 {
300 for ( size_t n = 0; n < WXSIZEOF(m_handles); n++ )
301 {
302 if ( m_handles[n] != INVALID_HANDLE_VALUE )
303 {
304 ::CloseHandle(m_handles[n]);
305 m_handles[n] = INVALID_HANDLE_VALUE;
306 }
307 }
308 }
309
310 // dtor closes the pipe descriptors
311 ~wxPipe() { Close(); }
312
313private:
314 HANDLE m_handles[2];
315};
316
317#endif // wxUSE_STREAMS
318
319// ============================================================================
320// implementation
321// ============================================================================
322
79066131
VZ
323// ----------------------------------------------------------------------------
324// process termination detecting support
325// ----------------------------------------------------------------------------
326
327// thread function for the thread monitoring the process termination
328static DWORD __stdcall wxExecuteThread(void *arg)
329{
45d5a0c6 330 wxExecuteData * const data = (wxExecuteData *)arg;
79066131 331
5a8561fc
VZ
332 // create the shutdown event if we're the first thread starting to wait
333 if ( !gs_heventShutdown )
79066131 334 {
5a8561fc
VZ
335 // create a manual initially non-signalled event object
336 gs_heventShutdown = ::CreateEvent(NULL, TRUE, FALSE, NULL);
337 if ( !gs_heventShutdown )
338 {
339 wxLogDebug(_T("CreateEvent() in wxExecuteThread failed"));
340 }
79066131
VZ
341 }
342
5a8561fc
VZ
343 HANDLE handles[2] = { data->hProcess, gs_heventShutdown };
344 switch ( ::WaitForMultipleObjects(2, handles, FALSE, INFINITE) )
79066131 345 {
5a8561fc
VZ
346 case WAIT_OBJECT_0:
347 // process terminated, get its exit code
348 if ( !::GetExitCodeProcess(data->hProcess, &data->dwExitCode) )
349 {
350 wxLogLastError(wxT("GetExitCodeProcess"));
351 }
352
353 wxASSERT_MSG( data->dwExitCode != STILL_ACTIVE,
354 wxT("process should have terminated") );
79066131 355
5a8561fc
VZ
356 // send a message indicating process termination to the window
357 ::SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data);
358 break;
359
360 case WAIT_OBJECT_0 + 1:
361 // we're shutting down but the process is still running -- leave it
362 // run but clean up the associated data
363 if ( !data->state )
364 {
365 delete data;
366 }
367 //else: exiting while synchronously executing process is still
368 // running? this shouldn't happen...
369 break;
79066131 370
5a8561fc
VZ
371 default:
372 wxLogDebug(_T("Waiting for the process termination failed!"));
373 }
79066131
VZ
374
375 return 0;
376}
377
378// window procedure of a hidden window which is created just to receive
379// the notification message when a process exits
380LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message,
381 WPARAM wParam, LPARAM lParam)
382{
383 if ( message == wxWM_PROC_TERMINATED )
384 {
385 DestroyWindow(hWnd); // we don't need it any more
386
45d5a0c6 387 wxExecuteData * const data = (wxExecuteData *)lParam;
79066131
VZ
388 if ( data->handler )
389 {
390 data->handler->OnTerminate((int)data->dwProcessId,
391 (int)data->dwExitCode);
392 }
393
394 if ( data->state )
395 {
396 // we're executing synchronously, tell the waiting thread
397 // that the process finished
5a8561fc 398 data->state = false;
79066131
VZ
399 }
400 else
401 {
402 // asynchronous execution - we should do the clean up
403 delete data;
404 }
405
406 return 0;
407 }
408 else
409 {
45d5a0c6 410 return ::DefWindowProc(hWnd, message, wParam, lParam);
79066131
VZ
411 }
412}
413
414// ============================================================================
415// implementation of IO redirection support classes
416// ============================================================================
417
4676948b 418#if wxUSE_STREAMS && !defined(__WXWINCE__)
79066131
VZ
419
420// ----------------------------------------------------------------------------
421// wxPipeInputStreams
422// ----------------------------------------------------------------------------
8b33ae2d
GL
423
424wxPipeInputStream::wxPipeInputStream(HANDLE hInput)
425{
426 m_hInput = hInput;
cd6ce4a9 427}
8b33ae2d
GL
428
429wxPipeInputStream::~wxPipeInputStream()
430{
79066131
VZ
431 if ( m_hInput != INVALID_HANDLE_VALUE )
432 ::CloseHandle(m_hInput);
8b33ae2d
GL
433}
434
2b5f62a0 435bool wxPipeInputStream::CanRead() const
8b33ae2d 436{
386a2898
VZ
437 // we can read if there's something in the put back buffer
438 // even pipe is closed
439 if ( m_wbacksize > m_wbackcur )
440 return true;
441
442 wxPipeInputStream * const self = wxConstCast(this, wxPipeInputStream);
443
79066131 444 if ( !IsOpened() )
386a2898
VZ
445 {
446 // set back to mark Eof as it may have been unset by Ungetch()
447 self->m_lasterror = wxSTREAM_EOF;
27d2dbbc 448 return false;
386a2898 449 }
79066131 450
f6bcfd97
BP
451 DWORD nAvailable;
452
453 // function name is misleading, it works with anon pipes as well
454 DWORD rc = ::PeekNamedPipe
455 (
456 m_hInput, // handle
457 NULL, 0, // ptr to buffer and its size
458 NULL, // [out] bytes read
459 &nAvailable, // [out] bytes available
460 NULL // [out] bytes left
461 );
462
463 if ( !rc )
464 {
465 if ( ::GetLastError() != ERROR_BROKEN_PIPE )
466 {
467 // unexpected error
468 wxLogLastError(_T("PeekNamedPipe"));
469 }
8b33ae2d 470
3103e8a9 471 // don't try to continue reading from a pipe if an error occurred or if
f6bcfd97 472 // it had been closed
79066131
VZ
473 ::CloseHandle(m_hInput);
474
2b5f62a0
VZ
475 self->m_hInput = INVALID_HANDLE_VALUE;
476 self->m_lasterror = wxSTREAM_EOF;
477
478 nAvailable = 0;
f6bcfd97 479 }
79066131
VZ
480
481 return nAvailable != 0;
f6bcfd97
BP
482}
483
484size_t wxPipeInputStream::OnSysRead(void *buffer, size_t len)
485{
2b5f62a0 486 if ( !IsOpened() )
79066131
VZ
487 {
488 m_lasterror = wxSTREAM_EOF;
489
f6bcfd97 490 return 0;
79066131
VZ
491 }
492
f6bcfd97
BP
493 DWORD bytesRead;
494 if ( !::ReadFile(m_hInput, buffer, len, &bytesRead, NULL) )
495 {
2b5f62a0
VZ
496 m_lasterror = ::GetLastError() == ERROR_BROKEN_PIPE
497 ? wxSTREAM_EOF
498 : wxSTREAM_READ_ERROR;
8b33ae2d 499 }
f6bcfd97 500
3103e8a9 501 // bytesRead is set to 0, as desired, if an error occurred
8b33ae2d
GL
502 return bytesRead;
503}
504
79066131 505// ----------------------------------------------------------------------------
8b33ae2d 506// wxPipeOutputStream
79066131 507// ----------------------------------------------------------------------------
8b33ae2d
GL
508
509wxPipeOutputStream::wxPipeOutputStream(HANDLE hOutput)
510{
511 m_hOutput = hOutput;
3338a5bd
VZ
512
513 // unblock the pipe to prevent deadlocks when we're writing to the pipe
514 // from which the child process can't read because it is writing in its own
515 // end of it
516 DWORD mode = PIPE_READMODE_BYTE | PIPE_NOWAIT;
517 if ( !::SetNamedPipeHandleState
518 (
519 m_hOutput,
520 &mode,
521 NULL, // collection count (we don't set it)
522 NULL // timeout (we don't set it neither)
523 ) )
524 {
525 wxLogLastError(_T("SetNamedPipeHandleState(PIPE_NOWAIT)"));
526 }
cd6ce4a9 527}
8b33ae2d 528
8f0ff178 529bool wxPipeOutputStream::Close()
8b33ae2d 530{
8f0ff178 531 return ::CloseHandle(m_hOutput) != 0;
8b33ae2d
GL
532}
533
8f0ff178 534
8b33ae2d
GL
535size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t len)
536{
2b5f62a0 537 m_lasterror = wxSTREAM_NO_ERROR;
3338a5bd
VZ
538
539 DWORD totalWritten = 0;
540 while ( len > 0 )
f6bcfd97 541 {
3338a5bd
VZ
542 DWORD chunkWritten;
543 if ( !::WriteFile(m_hOutput, buffer, len, &chunkWritten, NULL) )
544 {
545 m_lasterror = ::GetLastError() == ERROR_BROKEN_PIPE
546 ? wxSTREAM_EOF
547 : wxSTREAM_WRITE_ERROR;
548 break;
549 }
550
551 if ( !chunkWritten )
552 break;
553
554 buffer = (char *)buffer + chunkWritten;
555 totalWritten += chunkWritten;
556 len -= chunkWritten;
8b33ae2d 557 }
f6bcfd97 558
3338a5bd 559 return totalWritten;
8b33ae2d
GL
560}
561
79066131
VZ
562#endif // wxUSE_STREAMS
563
b568d04f 564// ============================================================================
79066131 565// wxExecute functions family
b568d04f 566// ============================================================================
5260b1c5 567
ca289436
VZ
568#if wxUSE_IPC
569
570// connect to the given server via DDE and ask it to execute the command
42d0df00
VZ
571bool
572wxExecuteDDE(const wxString& ddeServer,
573 const wxString& ddeTopic,
574 const wxString& ddeCommand)
ca289436 575{
999836aa 576 bool ok wxDUMMY_INITIALIZE(false);
ca289436
VZ
577
578 wxDDEClient client;
42d0df00
VZ
579 wxConnectionBase *
580 conn = client.MakeConnection(wxEmptyString, ddeServer, ddeTopic);
ca289436
VZ
581 if ( !conn )
582 {
27d2dbbc 583 ok = false;
ca289436
VZ
584 }
585 else // connected to DDE server
586 {
4dd03db9
VZ
587 // the added complication here is that although most programs use
588 // XTYP_EXECUTE for their DDE API, some important ones -- like Word
589 // and other MS stuff - use XTYP_REQUEST!
ca289436 590 //
4dd03db9
VZ
591 // moreover, anotheri mportant program (IE) understands both but
592 // returns an error from Execute() so we must try Request() first
593 // to avoid doing it twice
ca289436 594 {
4dd03db9 595 // we're prepared for this one to fail, so don't show errors
ca289436 596 wxLogNull noErrors;
4dd03db9
VZ
597
598 ok = conn->Request(ddeCommand) != NULL;
ca289436
VZ
599 }
600
601 if ( !ok )
602 {
4dd03db9
VZ
603 // now try execute -- but show the errors
604 ok = conn->Execute(ddeCommand);
ca289436
VZ
605 }
606 }
607
608 return ok;
609}
610
611#endif // wxUSE_IPC
612
fbf456aa 613long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
32592631 614{
c3fad64b 615 wxCHECK_MSG( !cmd.empty(), 0, wxT("empty command in wxExecute") );
5bd3a2da 616
647b8e37
VZ
617#if wxUSE_THREADS
618 // for many reasons, the code below breaks down if it's called from another
619 // thread -- this could be fixed, but as Unix versions don't support this
620 // neither I don't want to waste time on this now
621 wxASSERT_MSG( wxThread::IsMain(),
622 _T("wxExecute() can be called only from the main thread") );
623#endif // wxUSE_THREADS
624
039f62f4 625 wxString command;
6ba63600 626
731dd422 627#if wxUSE_IPC
5bd3a2da
VZ
628 // DDE hack: this is really not pretty, but we need to allow this for
629 // transparent handling of DDE servers in wxMimeTypesManager. Usually it
630 // returns the command which should be run to view/open/... a file of the
631 // given type. Sometimes, however, this command just launches the server
632 // and an additional DDE request must be made to really open the file. To
633 // keep all this well hidden from the application, we allow a special form
6ba63600 634 // of command: WX_DDE#<command>#DDE_SERVER#DDE_TOPIC#DDE_COMMAND in which
5bd3a2da 635 // case we execute just <command> and process the rest below
039f62f4 636 wxString ddeServer, ddeTopic, ddeCommand;
5bd3a2da
VZ
637 static const size_t lenDdePrefix = 7; // strlen("WX_DDE:")
638 if ( cmd.Left(lenDdePrefix) == _T("WX_DDE#") )
639 {
ca289436
VZ
640 // speed up the concatenations below
641 ddeServer.reserve(256);
642 ddeTopic.reserve(256);
643 ddeCommand.reserve(256);
644
5bd3a2da
VZ
645 const wxChar *p = cmd.c_str() + 7;
646 while ( *p && *p != _T('#') )
647 {
648 command += *p++;
649 }
650
651 if ( *p )
652 {
653 // skip '#'
654 p++;
655 }
656 else
657 {
658 wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
659 }
660
661 while ( *p && *p != _T('#') )
662 {
663 ddeServer += *p++;
664 }
665
666 if ( *p )
667 {
668 // skip '#'
669 p++;
670 }
671 else
672 {
673 wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
674 }
675
676 while ( *p && *p != _T('#') )
677 {
678 ddeTopic += *p++;
679 }
680
681 if ( *p )
682 {
683 // skip '#'
684 p++;
685 }
686 else
687 {
688 wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
689 }
690
691 while ( *p )
692 {
693 ddeCommand += *p++;
694 }
6ba63600 695
ca289436
VZ
696 // if we want to just launch the program and not wait for its
697 // termination, try to execute DDE command right now, it can succeed if
698 // the process is already running - but as it fails if it's not
699 // running, suppress any errors it might generate
fbf456aa 700 if ( !(flags & wxEXEC_SYNC) )
6ba63600 701 {
ca289436
VZ
702 wxLogNull noErrors;
703 if ( wxExecuteDDE(ddeServer, ddeTopic, ddeCommand) )
704 {
705 // a dummy PID - this is a hack, of course, but it's well worth
706 // it as we don't open a new server each time we're called
707 // which would be quite bad
708 return -1;
709 }
6ba63600 710 }
5bd3a2da
VZ
711 }
712 else
731dd422 713#endif // wxUSE_IPC
5bd3a2da
VZ
714 {
715 // no DDE
716 command = cmd;
717 }
32592631 718
f6bcfd97
BP
719 // the IO redirection is only supported with wxUSE_STREAMS
720 BOOL redirect = FALSE;
79066131 721
4676948b 722#if wxUSE_STREAMS && !defined(__WXWINCE__)
79066131
VZ
723 wxPipe pipeIn, pipeOut, pipeErr;
724
725 // we'll save here the copy of pipeIn[Write]
33ac7e6f 726 HANDLE hpipeStdinWrite = INVALID_HANDLE_VALUE;
8b33ae2d 727
cd6ce4a9 728 // open the pipes to which child process IO will be redirected if needed
cd6ce4a9
VZ
729 if ( handler && handler->IsRedirected() )
730 {
79066131
VZ
731 // create pipes for redirecting stdin, stdout and stderr
732 if ( !pipeIn.Create() || !pipeOut.Create() || !pipeErr.Create() )
cd6ce4a9 733 {
79066131 734 wxLogSysError(_("Failed to redirect the child process IO"));
8b33ae2d 735
fbf456aa
VZ
736 // indicate failure: we need to return different error code
737 // depending on the sync flag
738 return flags & wxEXEC_SYNC ? -1 : 0;
8b33ae2d
GL
739 }
740
f6bcfd97 741 redirect = TRUE;
8b33ae2d 742 }
f6bcfd97 743#endif // wxUSE_STREAMS
5bd3a2da 744
cb6827a8
VZ
745 // create the process
746 STARTUPINFO si;
11c7d5b6 747 wxZeroMemory(si);
cb6827a8
VZ
748 si.cb = sizeof(si);
749
4676948b 750#if wxUSE_STREAMS && !defined(__WXWINCE__)
f6bcfd97 751 if ( redirect )
cb6827a8 752 {
fbf456aa 753 si.dwFlags = STARTF_USESTDHANDLES;
f6bcfd97 754
79066131
VZ
755 si.hStdInput = pipeIn[wxPipe::Read];
756 si.hStdOutput = pipeOut[wxPipe::Write];
757 si.hStdError = pipeErr[wxPipe::Write];
f6bcfd97 758
fbf456aa
VZ
759 // when the std IO is redirected, we don't show the (console) process
760 // window by default, but this can be overridden by the caller by
761 // specifying wxEXEC_NOHIDE flag
762 if ( !(flags & wxEXEC_NOHIDE) )
763 {
764 si.dwFlags |= STARTF_USESHOWWINDOW;
765 si.wShowWindow = SW_HIDE;
766 }
f6bcfd97
BP
767
768 // we must duplicate the handle to the write side of stdin pipe to make
79066131
VZ
769 // it non inheritable: indeed, we must close the writing end of pipeIn
770 // before launching the child process as otherwise this handle will be
f6bcfd97
BP
771 // inherited by the child which will never close it and so the pipe
772 // will never be closed and the child will be left stuck in ReadFile()
79066131 773 HANDLE pipeInWrite = pipeIn.Detach(wxPipe::Write);
f6bcfd97
BP
774 if ( !::DuplicateHandle
775 (
79066131
VZ
776 ::GetCurrentProcess(),
777 pipeInWrite,
778 ::GetCurrentProcess(),
f6bcfd97
BP
779 &hpipeStdinWrite,
780 0, // desired access: unused here
781 FALSE, // not inherited
782 DUPLICATE_SAME_ACCESS // same access as for src handle
783 ) )
cd6ce4a9 784 {
f6bcfd97 785 wxLogLastError(_T("DuplicateHandle"));
8b33ae2d 786 }
cd6ce4a9 787
79066131 788 ::CloseHandle(pipeInWrite);
f6bcfd97
BP
789 }
790#endif // wxUSE_STREAMS
cb6827a8 791
f6bcfd97 792 PROCESS_INFORMATION pi;
4676948b 793 DWORD dwFlags = CREATE_SUSPENDED;
78c743d8 794
4676948b
JS
795#ifndef __WXWINCE__
796 dwFlags |= CREATE_DEFAULT_ERROR_MODE ;
78c743d8 797#else
9cd03a43
WS
798 // we are assuming commands without spaces for now
799 wxString moduleName = command.BeforeFirst(wxT(' '));
800 wxString arguments = command.AfterFirst(wxT(' '));
4676948b 801#endif
f6bcfd97
BP
802
803 bool ok = ::CreateProcess
804 (
9cd03a43 805 // WinCE requires appname to be non null
78c743d8
JS
806 // Win32 allows for null
807#ifdef __WXWINCE__
808 (wxChar *)
c9f78968 809 moduleName.wx_str(),// application name
78c743d8 810 (wxChar *)
c9f78968 811 arguments.wx_str(), // arguments
78c743d8 812#else
9cd03a43 813 NULL, // application name (use only cmd line)
f6bcfd97 814 (wxChar *)
c9f78968 815 command.wx_str(), // full command line
78c743d8 816#endif
9cd03a43
WS
817 NULL, // security attributes: defaults for both
818 NULL, // the process and its main thread
819 redirect, // inherit handles if we use pipes
820 dwFlags, // process creation flags
821 NULL, // environment (use the same)
822 NULL, // current directory (use the same)
823 &si, // startup info (unused here)
824 &pi // process info
f6bcfd97
BP
825 ) != 0;
826
4676948b 827#if wxUSE_STREAMS && !defined(__WXWINCE__)
f6bcfd97
BP
828 // we can close the pipe ends used by child anyhow
829 if ( redirect )
830 {
79066131
VZ
831 ::CloseHandle(pipeIn.Detach(wxPipe::Read));
832 ::CloseHandle(pipeOut.Detach(wxPipe::Write));
833 ::CloseHandle(pipeErr.Detach(wxPipe::Write));
cb6827a8 834 }
f6bcfd97 835#endif // wxUSE_STREAMS
cb6827a8 836
f6bcfd97 837 if ( !ok )
5e1febfa 838 {
4676948b 839#if wxUSE_STREAMS && !defined(__WXWINCE__)
f6bcfd97
BP
840 // close the other handles too
841 if ( redirect )
5e1febfa 842 {
79066131
VZ
843 ::CloseHandle(pipeOut.Detach(wxPipe::Read));
844 ::CloseHandle(pipeErr.Detach(wxPipe::Read));
5e1febfa 845 }
f6bcfd97 846#endif // wxUSE_STREAMS
5e1febfa 847
f6bcfd97
BP
848 wxLogSysError(_("Execution of command '%s' failed"), command.c_str());
849
fbf456aa 850 return flags & wxEXEC_SYNC ? -1 : 0;
f6bcfd97 851 }
8b33ae2d 852
4676948b 853#if wxUSE_STREAMS && !defined(__WXWINCE__)
79066131
VZ
854 // the input buffer bufOut is connected to stdout, this is why it is
855 // called bufOut and not bufIn
856 wxStreamTempInputBuffer bufOut,
857 bufErr;
858
f6bcfd97
BP
859 if ( redirect )
860 {
8b33ae2d 861 // We can now initialize the wxStreams
79066131
VZ
862 wxPipeInputStream *
863 outStream = new wxPipeInputStream(pipeOut.Detach(wxPipe::Read));
864 wxPipeInputStream *
865 errStream = new wxPipeInputStream(pipeErr.Detach(wxPipe::Read));
866 wxPipeOutputStream *
867 inStream = new wxPipeOutputStream(hpipeStdinWrite);
868
869 handler->SetPipeStreams(outStream, inStream, errStream);
8b33ae2d 870
79066131
VZ
871 bufOut.Init(outStream);
872 bufErr.Init(errStream);
8b33ae2d 873 }
f6bcfd97 874#endif // wxUSE_STREAMS
8b33ae2d 875
cb6827a8
VZ
876 // create a hidden window to receive notification about process
877 // termination
eccd1992
VZ
878 HWND hwnd = wxCreateHiddenWindow
879 (
880 &gs_classForHiddenWindow,
881 wxMSWEXEC_WNDCLASSNAME,
882 (WNDPROC)wxExecuteWindowCbk
883 );
884
223d09f6 885 wxASSERT_MSG( hwnd, wxT("can't create a hidden window for wxExecute") );
e6045e08 886
cb6827a8
VZ
887 // Alloc data
888 wxExecuteData *data = new wxExecuteData;
889 data->hProcess = pi.hProcess;
890 data->dwProcessId = pi.dwProcessId;
891 data->hWnd = hwnd;
fbf456aa
VZ
892 data->state = (flags & wxEXEC_SYNC) != 0;
893 if ( flags & wxEXEC_SYNC )
e6045e08 894 {
5e1febfa
VZ
895 // handler may be !NULL for capturing program output, but we don't use
896 // it wxExecuteData struct in this case
e6045e08
VZ
897 data->handler = NULL;
898 }
899 else
900 {
901 // may be NULL or not
902 data->handler = handler;
ca5016d4
FM
903
904 if (handler)
905 handler->SetPid(pi.dwProcessId);
e6045e08 906 }
cb6827a8
VZ
907
908 DWORD tid;
909 HANDLE hThread = ::CreateThread(NULL,
910 0,
19193a2c 911 wxExecuteThread,
cb6827a8
VZ
912 (void *)data,
913 0,
914 &tid);
915
0d7ea902
VZ
916 // resume process we created now - whether the thread creation succeeded or
917 // not
918 if ( ::ResumeThread(pi.hThread) == (DWORD)-1 )
919 {
920 // ignore it - what can we do?
f6bcfd97 921 wxLogLastError(wxT("ResumeThread in wxExecute"));
0d7ea902
VZ
922 }
923
924 // close unneeded handle
925 if ( !::CloseHandle(pi.hThread) )
f6bcfd97 926 wxLogLastError(wxT("CloseHandle(hThread)"));
0d7ea902 927
cb6827a8
VZ
928 if ( !hThread )
929 {
f6bcfd97 930 wxLogLastError(wxT("CreateThread in wxExecute"));
cb6827a8
VZ
931
932 DestroyWindow(hwnd);
933 delete data;
934
935 // the process still started up successfully...
936 return pi.dwProcessId;
937 }
e6045e08 938
5a8561fc 939 gs_asyncThreads.push_back(hThread);
f6bcfd97 940
4676948b 941#if wxUSE_IPC && !defined(__WXWINCE__)
5bd3a2da
VZ
942 // second part of DDE hack: now establish the DDE conversation with the
943 // just launched process
ca289436 944 if ( !ddeServer.empty() )
5bd3a2da 945 {
ca289436
VZ
946 bool ok;
947
948 // give the process the time to init itself
949 //
950 // we use a very big timeout hoping that WaitForInputIdle() will return
951 // much sooner, but not INFINITE just in case the process hangs
952 // completely - like this we will regain control sooner or later
953 switch ( ::WaitForInputIdle(pi.hProcess, 10000 /* 10 seconds */) )
6ba63600 954 {
ca289436
VZ
955 default:
956 wxFAIL_MSG( _T("unexpected WaitForInputIdle() return code") );
957 // fall through
6ba63600 958
ca289436
VZ
959 case -1:
960 wxLogLastError(_T("WaitForInputIdle() in wxExecute"));
6ba63600 961
ca289436
VZ
962 case WAIT_TIMEOUT:
963 wxLogDebug(_T("Timeout too small in WaitForInputIdle"));
964
27d2dbbc 965 ok = false;
ca289436
VZ
966 break;
967
968 case 0:
969 // ok, process ready to accept DDE requests
970 ok = wxExecuteDDE(ddeServer, ddeTopic, ddeCommand);
6ba63600 971 }
1b47bebc
VZ
972
973 if ( !ok )
974 {
975 wxLogDebug(_T("Failed to send DDE request to the process \"%s\"."),
976 cmd.c_str());
977 }
5bd3a2da 978 }
731dd422 979#endif // wxUSE_IPC
5bd3a2da 980
fbf456aa 981 if ( !(flags & wxEXEC_SYNC) )
cb6827a8
VZ
982 {
983 // clean up will be done when the process terminates
e6045e08
VZ
984
985 // return the pid
cb6827a8
VZ
986 return pi.dwProcessId;
987 }
e6045e08 988
d60e2332
VZ
989 wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
990 wxCHECK_MSG( traits, -1, _T("no wxAppTraits in wxExecute()?") );
991
c3fad64b 992 void *cookie = NULL;
f38f6899
VZ
993 if ( !(flags & wxEXEC_NODISABLE) )
994 {
f38f6899
VZ
995 // disable all app windows while waiting for the child process to finish
996 cookie = traits->BeforeChildWaitLoop();
997 }
e2478fde
VZ
998
999 // wait until the child process terminates
1000 while ( data->state )
1001 {
4676948b 1002#if wxUSE_STREAMS && !defined(__WXWINCE__)
4d425dee 1003 if ( !bufOut.Update() && !bufErr.Update() )
79066131 1004#endif // wxUSE_STREAMS
4d425dee
VZ
1005 {
1006 // don't eat 100% of the CPU -- ugly but anything else requires
1007 // real async IO which we don't have for the moment
1008 ::Sleep(50);
1009 }
e6045e08 1010
dbbcfbb6
VZ
1011 // we must always process messages for our hidden window or we'd never
1012 // get wxWM_PROC_TERMINATED and so this loop would never terminate
1013 MSG msg;
1014 ::PeekMessage(&msg, data->hWnd, 0, 0, PM_REMOVE);
1015
1016 // we may also need to process messages for all the other application
1017 // windows
1018 if ( !(flags & wxEXEC_NOEVENTS) )
1019 {
1020 wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
1021 if ( loop )
1022 loop->Yield();
1023 }
cd6ce4a9 1024 }
068a7cfe 1025
d60e2332
VZ
1026 if ( !(flags & wxEXEC_NODISABLE) )
1027 {
1028 // reenable disabled windows back
f38f6899 1029 traits->AfterChildWaitLoop(cookie);
d60e2332 1030 }
0d7ea902 1031
e6045e08 1032 DWORD dwExitCode = data->dwExitCode;
cb6827a8
VZ
1033 delete data;
1034
e6045e08
VZ
1035 // return the exit code
1036 return dwExitCode;
32592631 1037}
c740f496 1038
05718a98
VZ
1039template <typename CharType>
1040long wxExecuteImpl(CharType **argv, int flags, wxProcess *handler)
c740f496 1041{
cb6827a8 1042 wxString command;
05718a98 1043 command.reserve(1024);
e6045e08 1044
3cdd564f 1045 wxString arg;
0493ba13 1046 for ( ;; )
cb6827a8 1047 {
3cdd564f
VZ
1048 arg = *argv++;
1049
a6eac99d
VZ
1050 bool quote;
1051 if ( arg.empty() )
1052 {
1053 // we need to quote empty arguments, otherwise they'd just
1054 // disappear
1055 quote = true;
1056 }
1057 else // non-empty
1058 {
1059 // escape any quotes present in the string to avoid interfering
1060 // with the command line parsing in the child process
1061 arg.Replace("\"", "\\\"", true /* replace all */);
3cdd564f 1062
a6eac99d
VZ
1063 // and quote any arguments containing the spaces to prevent them from
1064 // being broken down
1065 quote = arg.find_first_of(" \t") != wxString::npos;
1066 }
1067
1068 if ( quote )
3cdd564f 1069 command += '\"' + arg + '\"';
a6eac99d
VZ
1070 else
1071 command += arg;
3cdd564f 1072
0493ba13
VZ
1073 if ( !*argv )
1074 break;
cb6827a8 1075
05718a98 1076 command += ' ';
0493ba13 1077 }
cb6827a8 1078
fbf456aa 1079 return wxExecute(command, flags, handler);
c740f496 1080}
05718a98
VZ
1081
1082long wxExecute(char **argv, int flags, wxProcess *handler)
1083{
1084 return wxExecuteImpl(argv, flags, handler);
1085}
1086
d7ef641d
VZ
1087#if wxUSE_UNICODE
1088
05718a98
VZ
1089long wxExecute(wchar_t **argv, int flags, wxProcess *handler)
1090{
1091 return wxExecuteImpl(argv, flags, handler);
1092}
d7ef641d
VZ
1093
1094#endif // wxUSE_UNICODE