X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c655557fa685eb0201d5d45078a1f46370240592..dc8c61bef78e406080de2be91bc6e8d746edb647:/src/unix/utilsunx.cpp diff --git a/src/unix/utilsunx.cpp b/src/unix/utilsunx.cpp index d5b98d59af..ec550fcf24 100644 --- a/src/unix/utilsunx.cpp +++ b/src/unix/utilsunx.cpp @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: src/unix/utilsunx.cpp -// Purpose: generic Unix implementation of many wx functions +// Purpose: generic Unix implementation of many wx functions (for wxBase) // Author: Vadim Zeitlin // Id: $Id$ // Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin @@ -20,11 +20,18 @@ #include "wx/utils.h" +#define USE_PUTENV (!defined(HAVE_SETENV) && defined(HAVE_PUTENV)) + #ifndef WX_PRECOMP #include "wx/string.h" #include "wx/intl.h" #include "wx/log.h" #include "wx/app.h" + #include "wx/wxcrtvararg.h" + #if USE_PUTENV + #include "wx/module.h" + #include "wx/hashmap.h" + #endif #endif #include "wx/apptrait.h" @@ -32,28 +39,35 @@ #include "wx/process.h" #include "wx/thread.h" +#include "wx/cmdline.h" + #include "wx/wfstream.h" +#include "wx/private/selectdispatcher.h" +#include "wx/private/fdiodispatcher.h" #include "wx/unix/execute.h" #include "wx/unix/private.h" +#ifdef wxHAS_GENERIC_PROCESS_CALLBACK +#include "wx/private/fdiodispatcher.h" +#endif + #include +#include // waitpid() #ifdef HAVE_SYS_SELECT_H # include #endif -#define HAS_PIPE_INPUT_STREAM (wxUSE_STREAMS && wxUSE_FILE) +#define HAS_PIPE_STREAMS (wxUSE_STREAMS && wxUSE_FILE) -#if HAS_PIPE_INPUT_STREAM +#if HAS_PIPE_STREAMS // define this to let wxexec.cpp know that we know what we're doing #define _WX_USED_BY_WXEXECUTE_ #include "../common/execcmn.cpp" -#endif // HAS_PIPE_INPUT_STREAM - -#if wxUSE_BASE +#endif // HAS_PIPE_STREAMS #if defined(__MWERKS__) && defined(__MACH__) #ifndef WXWIN_OS_DESCRIPTION @@ -151,21 +165,17 @@ defined(__osf__) || defined(__EMX__)) extern "C" { - #ifdef __SUN__ + #ifdef __EMX__ + /* I copied this from the XFree86 diffs. AV. */ + #define INCL_DOSPROCESS + #include + inline void usleep(unsigned long delay) + { + DosSleep(delay ? (delay/1000l) : 1l); + } + #else // Unix int usleep(unsigned int usec); - #else // !Sun - #ifdef __EMX__ - /* I copied this from the XFree86 diffs. AV. */ - #define INCL_DOSPROCESS - #include - inline void usleep(unsigned long delay) - { - DosSleep(delay ? (delay/1000l) : 1l); - } - #else // !Sun && !EMX - void usleep(unsigned long usec); - #endif - #endif // Sun/EMX/Something else + #endif // __EMX__/Unix }; #define HAVE_USLEEP 1 @@ -192,7 +202,7 @@ void wxMicroSleep(unsigned long microseconds) tmReq.tv_nsec = (microseconds % 1000000) * 1000; // we're not interested in remaining time nor in return value - (void)nanosleep(&tmReq, (timespec *)NULL); + (void)nanosleep(&tmReq, NULL); #elif defined(HAVE_USLEEP) // uncomment this if you feel brave or if you are sure that your version // of Solaris has a safe usleep() function but please notice that usleep() @@ -245,7 +255,7 @@ int wxKill(long pid, wxSignal sig, wxKillError *rc, int flags) default: // this goes against Unix98 docs so log it - wxLogDebug(_T("unexpected kill(2) return value %d"), err); + wxLogDebug(wxT("unexpected kill(2) return value %d"), err); // something else... *rc = wxKILL_ERROR; @@ -255,105 +265,119 @@ int wxKill(long pid, wxSignal sig, wxKillError *rc, int flags) return err; } -#define WXEXECUTE_NARGS 127 +// Shutdown or reboot the PC +bool wxShutdown(int flags) +{ + flags &= ~wxSHUTDOWN_FORCE; -#if defined(__DARWIN__) -long wxMacExecute(wxChar **argv, - int flags, - wxProcess *process); -#endif + wxChar level; + switch ( flags ) + { + case wxSHUTDOWN_POWEROFF: + level = wxT('0'); + break; -long wxExecute( const wxString& command, int flags, wxProcess *process ) -{ - wxCHECK_MSG( !command.empty(), 0, wxT("can't exec empty command") ); - wxLogDebug(wxString(wxT("Launching: ")) + command); + case wxSHUTDOWN_REBOOT: + level = wxT('6'); + break; -#if wxUSE_THREADS - // fork() doesn't mix well with POSIX threads: on many systems the program - // deadlocks or crashes for some reason. Probably our code is buggy and - // doesn't do something which must be done to allow this to work, but I - // don't know what yet, so for now just warn the user (this is the least we - // can do) about it - wxASSERT_MSG( wxThread::IsMain(), - _T("wxExecute() can be called only from the main thread") ); -#endif // wxUSE_THREADS + case wxSHUTDOWN_LOGOFF: + // TODO: use dcop to log off? + return false; - int argc = 0; - wxChar *argv[WXEXECUTE_NARGS]; - wxString argument; - const wxChar *cptr = command.c_str(); - wxChar quotechar = wxT('\0'); // is arg quoted? - bool escaped = false; + default: + wxFAIL_MSG( wxT("unknown wxShutdown() flag") ); + return false; + } - // split the command line in arguments - do - { - argument = wxEmptyString; - quotechar = wxT('\0'); + return system(wxString::Format("init %c", level).mb_str()) == 0; +} - // eat leading whitespace: - while ( wxIsspace(*cptr) ) - cptr++; +// ---------------------------------------------------------------------------- +// wxStream classes to support IO redirection in wxExecute +// ---------------------------------------------------------------------------- - if ( *cptr == wxT('\'') || *cptr == wxT('"') ) - quotechar = *cptr++; +#if HAS_PIPE_STREAMS - do - { - if ( *cptr == wxT('\\') && ! escaped ) - { - escaped = true; - cptr++; - continue; - } +bool wxPipeInputStream::CanRead() const +{ + if ( m_lasterror == wxSTREAM_EOF ) + return false; - // all other characters: - argument += *cptr++; - escaped = false; + // check if there is any input available + struct timeval tv; + tv.tv_sec = 0; + tv.tv_usec = 0; - // have we reached the end of the argument? - if ( (*cptr == quotechar && ! escaped) - || (quotechar == wxT('\0') && wxIsspace(*cptr)) - || *cptr == wxT('\0') ) - { - wxASSERT_MSG( argc < WXEXECUTE_NARGS, - wxT("too many arguments in wxExecute") ); + const int fd = m_file->fd(); - argv[argc] = new wxChar[argument.length() + 1]; - wxStrcpy(argv[argc], argument.c_str()); - argc++; + fd_set readfds; - // if not at end of buffer, swallow last character: - if(*cptr) - cptr++; + wxFD_ZERO(&readfds); + wxFD_SET(fd, &readfds); - break; // done with this one, start over - } - } while(*cptr); - } while(*cptr); - argv[argc] = NULL; + switch ( select(fd + 1, &readfds, NULL, NULL, &tv) ) + { + case -1: + wxLogSysError(_("Impossible to get child process input")); + // fall through - long lRc; -#if defined(__DARWIN__) - // wxMacExecute only executes app bundles. - // It returns an error code if the target is not an app bundle, thus falling - // through to the regular wxExecute for non app bundles. - lRc = wxMacExecute(argv, flags, process); - if( lRc != ((flags & wxEXEC_SYNC) ? -1 : 0)) - return lRc; -#endif + case 0: + return false; - // do execute the command - lRc = wxExecute(argv, flags, process); + default: + wxFAIL_MSG(wxT("unexpected select() return value")); + // still fall through - // clean up - argc = 0; - while( argv[argc] ) - delete [] argv[argc++]; + case 1: + // input available -- or maybe not, as select() returns 1 when a + // read() will complete without delay, but it could still not read + // anything + return !Eof(); + } +} - return lRc; +size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t size) +{ + // We need to suppress error logging here, because on writing to a pipe + // which is full, wxFile::Write reports a system error. However, this is + // not an extraordinary situation, and it should not be reported to the + // user (but if really needed, the program can recognize it by checking + // whether LastRead() == 0.) Other errors will be reported below. + size_t ret; + { + wxLogNull logNo; + ret = m_file->Write(buffer, size); + } + + switch ( m_file->GetLastError() ) + { + // pipe is full +#ifdef EAGAIN + case EAGAIN: +#endif +#if defined(EWOULDBLOCK) && (EWOULDBLOCK != EAGAIN) + case EWOULDBLOCK: +#endif + // do not treat it as an error + m_file->ClearLastError(); + // fall through + + // no error + case 0: + break; + + // some real error + default: + wxLogSysError(_("Can't write to child process's stdin")); + m_lasterror = wxSTREAM_WRITE_ERROR; + } + + return ret; } +#endif // HAS_PIPE_STREAMS + // ---------------------------------------------------------------------------- // wxShell // ---------------------------------------------------------------------------- @@ -364,12 +388,12 @@ static wxString wxMakeShellCommand(const wxString& command) if ( !command ) { // just an interactive shell - cmd = _T("xterm"); + cmd = wxT("xterm"); } else { // execute command in a shell - cmd << _T("/bin/sh -c '") << command << _T('\''); + cmd << wxT("/bin/sh -c '") << command << wxT('\''); } return cmd; @@ -382,84 +406,105 @@ bool wxShell(const wxString& command) bool wxShell(const wxString& command, wxArrayString& output) { - wxCHECK_MSG( !command.empty(), false, _T("can't exec shell non interactively") ); + wxCHECK_MSG( !command.empty(), false, wxT("can't exec shell non interactively") ); return wxExecute(wxMakeShellCommand(command), output); } -// Shutdown or reboot the PC -bool wxShutdown(wxShutdownFlags wFlags) +namespace { - wxChar level; - switch ( wFlags ) + +// helper class for storing arguments as char** array suitable for passing to +// execvp(), whatever form they were passed to us +class ArgsArray +{ +public: + ArgsArray(const wxArrayString& args) { - case wxSHUTDOWN_POWEROFF: - level = _T('0'); - break; + Init(args.size()); - case wxSHUTDOWN_REBOOT: - level = _T('6'); - break; + for ( int i = 0; i < m_argc; i++ ) + { + m_argv[i] = wxStrdup(args[i]); + } + } - default: - wxFAIL_MSG( _T("unknown wxShutdown() flag") ); - return false; +#if wxUSE_UNICODE + ArgsArray(wchar_t **wargv) + { + int argc = 0; + while ( wargv[argc] ) + argc++; + + Init(argc); + + for ( int i = 0; i < m_argc; i++ ) + { + m_argv[i] = wxSafeConvertWX2MB(wargv[i]).release(); + } } +#endif // wxUSE_UNICODE - return system(wxString::Format(_T("init %c"), level).mb_str()) == 0; -} + ~ArgsArray() + { + for ( int i = 0; i < m_argc; i++ ) + { + free(m_argv[i]); + } -// ---------------------------------------------------------------------------- -// wxStream classes to support IO redirection in wxExecute -// ---------------------------------------------------------------------------- + delete [] m_argv; + } -#if HAS_PIPE_INPUT_STREAM + operator char**() const { return m_argv; } -bool wxPipeInputStream::CanRead() const -{ - if ( m_lasterror == wxSTREAM_EOF ) - return false; +private: + void Init(int argc) + { + m_argc = argc; + m_argv = new char *[m_argc + 1]; + m_argv[m_argc] = NULL; + } - // check if there is any input available - struct timeval tv; - tv.tv_sec = 0; - tv.tv_usec = 0; + int m_argc; + char **m_argv; - const int fd = m_file->fd(); + wxDECLARE_NO_COPY_CLASS(ArgsArray); +}; - fd_set readfds; +} // anonymous namespace - wxFD_ZERO(&readfds); - wxFD_SET(fd, &readfds); +// ---------------------------------------------------------------------------- +// wxExecute implementations +// ---------------------------------------------------------------------------- - switch ( select(fd + 1, &readfds, NULL, NULL, &tv) ) - { - case -1: - wxLogSysError(_("Impossible to get child process input")); - // fall through +#if defined(__DARWIN__) +bool wxMacLaunch(char **argv); +#endif - case 0: - return false; +long wxExecute(const wxString& command, int flags, wxProcess *process, + const wxExecuteEnv *env) +{ + ArgsArray argv(wxCmdLineParser::ConvertStringToArgs(command, + wxCMD_LINE_SPLIT_UNIX)); - default: - wxFAIL_MSG(_T("unexpected select() return value")); - // still fall through + return wxExecute(argv, flags, process, env); +} - case 1: - // input available -- or maybe not, as select() returns 1 when a - // read() will complete without delay, but it could still not read - // anything - return !Eof(); - } +#if wxUSE_UNICODE + +long wxExecute(wchar_t **wargv, int flags, wxProcess *process, + const wxExecuteEnv *env) +{ + ArgsArray argv(wargv); + + return wxExecute(argv, flags, process, env); } -#endif // HAS_PIPE_INPUT_STREAM +#endif // wxUSE_UNICODE -// ---------------------------------------------------------------------------- // wxExecute: the real worker function -// ---------------------------------------------------------------------------- - -long wxExecute(wxChar **argv, int flags, wxProcess *process) +long wxExecute(char **argv, int flags, wxProcess *process, + const wxExecuteEnv *env) { // for the sync execution, we return -1 to indicate failure, but for async // case we return 0 which is never a valid PID @@ -470,49 +515,38 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) wxCHECK_MSG( *argv, ERROR_RETURN_CODE, wxT("can't exec empty command") ); -#if wxUSE_UNICODE - int mb_argc = 0; - char *mb_argv[WXEXECUTE_NARGS]; +#if wxUSE_THREADS + // fork() doesn't mix well with POSIX threads: on many systems the program + // deadlocks or crashes for some reason. Probably our code is buggy and + // doesn't do something which must be done to allow this to work, but I + // don't know what yet, so for now just warn the user (this is the least we + // can do) about it + wxASSERT_MSG( wxThread::IsMain(), + wxT("wxExecute() can be called only from the main thread") ); +#endif // wxUSE_THREADS - while (argv[mb_argc]) +#if defined(__WXCOCOA__) || ( defined(__WXOSX_MAC__) && wxOSX_USE_COCOA_OR_CARBON ) + // wxMacLaunch() only executes app bundles and only does it asynchronously. + // It returns false if the target is not an app bundle, thus falling + // through to the regular code for non app bundles. + if ( !(flags & wxEXEC_SYNC) && wxMacLaunch(argv) ) { - wxWX2MBbuf mb_arg = wxConvertWX2MB(argv[mb_argc]); - mb_argv[mb_argc] = strdup(mb_arg); - mb_argc++; + // we don't have any PID to return so just make up something non null + return -1; } - mb_argv[mb_argc] = (char *) NULL; - - // this macro will free memory we used above - #define ARGS_CLEANUP \ - for ( mb_argc = 0; mb_argv[mb_argc]; mb_argc++ ) \ - free(mb_argv[mb_argc]) -#else // ANSI - // no need for cleanup - #define ARGS_CLEANUP - - wxChar **mb_argv = argv; -#endif // Unicode/ANSI - - // we want this function to work even if there is no wxApp so ensure that - // we have a valid traits pointer - wxConsoleAppTraits traitsConsole; - wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; - if ( !traits ) - traits = &traitsConsole; - - // this struct contains all information which we pass to and from - // wxAppTraits methods +#endif // __DARWIN__ + + + // this struct contains all information which we use for housekeeping wxExecuteData execData; execData.flags = flags; execData.process = process; // create pipes - if ( !traits->CreateEndProcessPipe(execData) ) + if ( !execData.pipeEndProcDetect.Create() ) { wxLogError( _("Failed to execute '%s'\n"), *argv ); - ARGS_CLEANUP; - return ERROR_RETURN_CODE; } @@ -527,8 +561,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) { wxLogError( _("Failed to execute '%s'\n"), *argv ); - ARGS_CLEANUP; - return ERROR_RETURN_CODE; } } @@ -548,36 +580,14 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) { wxLogSysError( _("Fork failed") ); - ARGS_CLEANUP; - return ERROR_RETURN_CODE; } else if ( pid == 0 ) // we're in child { - // These lines close the open file descriptors to to avoid any - // input/output which might block the process or irritate the user. If - // one wants proper IO for the subprocess, the right thing to do is to - // start an xterm executing it. - if ( !(flags & wxEXEC_SYNC) ) - { - // FD_SETSIZE is unsigned under BSD, signed under other platforms - // so we need a cast to avoid warnings on all platforms - for ( int fd = 0; fd < (int)FD_SETSIZE; fd++ ) - { - if ( fd == pipeIn[wxPipe::Read] - || fd == pipeOut[wxPipe::Write] - || fd == pipeErr[wxPipe::Write] - || traits->IsWriteFDOfEndProcessPipe(execData, fd) ) - { - // don't close this one, we still need it - continue; - } - - // leave stderr opened too, it won't do any harm - if ( fd != STDERR_FILENO ) - close(fd); - } - } + // NB: we used to close all the unused descriptors of the child here + // but this broke some programs which relied on e.g. FD 1 being + // always opened so don't do it any more, after all there doesn't + // seem to be any real problem with keeping them opened #if !defined(__VMS) && !defined(__EMX__) if ( flags & wxEXEC_MAKE_GROUP_LEADER ) @@ -588,10 +598,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) } #endif // !__VMS - // reading side can be safely closed but we should keep the write one - // opened - traits->DetachWriteFDOfEndProcessPipe(execData); - // redirect stdin, stdout and stderr if ( pipeIn.IsOk() ) { @@ -607,12 +613,78 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) pipeErr.Close(); } - execvp (*mb_argv, mb_argv); + // Close all (presumably accidentally) inherited file descriptors to + // avoid descriptor leaks. This means that we don't allow inheriting + // them purposefully but this seems like a lesser evil in wx code. + // Ideally we'd provide some flag to indicate that none (or some?) of + // the descriptors do not need to be closed but for now this is better + // than never closing them at all as wx code never used FD_CLOEXEC. + + // Note that while the reading side of the end process detection pipe + // can be safely closed, we should keep the write one opened, it will + // be only closed when the process terminates resulting in a read + // notification to the parent + const int fdEndProc = execData.pipeEndProcDetect.Detach(wxPipe::Write); + execData.pipeEndProcDetect.Close(); + + // TODO: Iterating up to FD_SETSIZE is both inefficient (because it may + // be quite big) and incorrect (because in principle we could + // have more opened descriptions than this number). Unfortunately + // there is no good portable solution for closing all descriptors + // above a certain threshold but non-portable solutions exist for + // most platforms, see [http://stackoverflow.com/questions/899038/ + // getting-the-highest-allocated-file-descriptor] + for ( int fd = 0; fd < (int)FD_SETSIZE; ++fd ) + { + if ( fd != STDIN_FILENO && + fd != STDOUT_FILENO && + fd != STDERR_FILENO && + fd != fdEndProc ) + { + close(fd); + } + } + + + // Process additional options if we have any + if ( env ) + { + // Change working directory if it is specified + if ( !env->cwd.empty() ) + wxSetWorkingDirectory(env->cwd); + + // Change environment if needed. + // + // NB: We can't use execve() currently because we allow using + // non full paths to wxExecute(), i.e. we want to search for + // the program in PATH. However it just might be simpler/better + // to do the search manually and use execve() envp parameter to + // set up the environment of the child process explicitly + // instead of doing what we do below. + if ( !env->env.empty() ) + { + wxEnvVariableHashMap oldenv; + wxGetEnvMap(&oldenv); + + // Remove unwanted variables + wxEnvVariableHashMap::const_iterator it; + for ( it = oldenv.begin(); it != oldenv.end(); ++it ) + { + if ( env->env.find(it->first) == env->env.end() ) + wxUnsetEnv(it->first); + } + + // And add the new ones (possibly replacing the old values) + for ( it = env->env.begin(); it != env->env.end(); ++it ) + wxSetEnv(it->first, it->second); + } + } + + execvp(*argv, argv); fprintf(stderr, "execvp("); - // CS changed ppc to ppc_ as ppc is not available under mac os CW Mach-O - for ( char **ppc_ = mb_argv; *ppc_; ppc_++ ) - fprintf(stderr, "%s%s", ppc_ == mb_argv ? "" : ", ", *ppc_); + for ( char **a = argv; *a; a++ ) + fprintf(stderr, "%s%s", a == argv ? "" : ", ", *a); fprintf(stderr, ") failed with error %d!\n", errno); // there is no return after successful exec() @@ -630,31 +702,45 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) } else // we're in parent { - ARGS_CLEANUP; - // save it for WaitForChild() use execData.pid = pid; + if (execData.process) + execData.process->SetPid(pid); // and also in the wxProcess // prepare for IO redirection -#if HAS_PIPE_INPUT_STREAM +#if HAS_PIPE_STREAMS // the input buffer bufOut is connected to stdout, this is why it is // called bufOut and not bufIn wxStreamTempInputBuffer bufOut, bufErr; -#endif // HAS_PIPE_INPUT_STREAM if ( process && process->IsRedirected() ) { -#if HAS_PIPE_INPUT_STREAM + // Avoid deadlocks which could result from trying to write to the + // child input pipe end while the child itself is writing to its + // output end and waiting for us to read from it. + if ( !pipeIn.MakeNonBlocking(wxPipe::Write) ) + { + // This message is not terrible useful for the user but what + // else can we do? Also, should we fail here or take the risk + // to continue and deadlock? Currently we choose the latter but + // it might not be the best idea. + wxLogSysError(_("Failed to set up non-blocking pipe, " + "the program might hang.")); +#if wxUSE_LOG + wxLog::FlushActive(); +#endif + } + wxOutputStream *inStream = - new wxFileOutputStream(pipeIn.Detach(wxPipe::Write)); + new wxPipeOutputStream(pipeIn.Detach(wxPipe::Write)); - wxPipeInputStream *outStream = - new wxPipeInputStream(pipeOut.Detach(wxPipe::Read)); + const int fdOut = pipeOut.Detach(wxPipe::Read); + wxPipeInputStream *outStream = new wxPipeInputStream(fdOut); - wxPipeInputStream *errStream = - new wxPipeInputStream(pipeErr.Detach(wxPipe::Read)); + const int fdErr = pipeErr.Detach(wxPipe::Read); + wxPipeInputStream *errStream = new wxPipeInputStream(fdErr); process->SetPipeStreams(outStream, inStream, errStream); @@ -663,8 +749,11 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) execData.bufOut = &bufOut; execData.bufErr = &bufErr; -#endif // HAS_PIPE_INPUT_STREAM + + execData.fdOut = fdOut; + execData.fdErr = fdErr; } +#endif // HAS_PIPE_STREAMS if ( pipeIn.IsOk() ) { @@ -673,6 +762,13 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) pipeErr.Close(); } + // we want this function to work even if there is no wxApp so ensure + // that we have a valid traits pointer + wxConsoleAppTraits traitsConsole; + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( !traits ) + traits = &traitsConsole; + return traits->WaitForChild(execData); } @@ -682,7 +778,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) } #undef ERROR_RETURN_CODE -#undef ARGS_CLEANUP // ---------------------------------------------------------------------------- // file and directory functions @@ -690,7 +785,7 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) const wxChar* wxGetHomeDir( wxString *home ) { - *home = wxGetUserHome( wxEmptyString ); + *home = wxGetUserHome(); wxString tmp; if ( home->empty() ) *home = wxT("/"); @@ -702,11 +797,7 @@ const wxChar* wxGetHomeDir( wxString *home ) return home->c_str(); } -#if wxUSE_UNICODE -const wxMB2WXbuf wxGetUserHome( const wxString &user ) -#else // just for binary compatibility -- there is no 'const' here -char *wxGetUserHome( const wxString &user ) -#endif +wxString wxGetUserHome( const wxString &user ) { struct passwd *who = (struct passwd *) NULL; @@ -716,20 +807,17 @@ char *wxGetUserHome( const wxString &user ) if ((ptr = wxGetenv(wxT("HOME"))) != NULL) { -#if wxUSE_UNICODE - wxWCharBuffer buffer( ptr ); - return buffer; -#else return ptr; -#endif } - if ((ptr = wxGetenv(wxT("USER"))) != NULL || (ptr = wxGetenv(wxT("LOGNAME"))) != NULL) + + if ((ptr = wxGetenv(wxT("USER"))) != NULL || + (ptr = wxGetenv(wxT("LOGNAME"))) != NULL) { - who = getpwnam(wxConvertWX2MB(ptr)); + who = getpwnam(wxSafeConvertWX2MB(ptr)); } - // We now make sure the the user exists! - if (who == NULL) + // make sure the user exists! + if ( !who ) { who = getpwuid(getuid()); } @@ -739,7 +827,7 @@ char *wxGetUserHome( const wxString &user ) who = getpwnam (user.mb_str()); } - return wxConvertMB2WX(who ? who->pw_dir : 0); + return wxSafeConvertMB2WX(who ? who->pw_dir : 0); } // ---------------------------------------------------------------------------- @@ -753,7 +841,7 @@ static wxString wxGetCommandOutput(const wxString &cmd) FILE *f = popen(cmd.ToAscii(), "r"); if ( !f ) { - wxLogSysError(_T("Executing \"%s\" failed"), cmd.c_str()); + wxLogSysError(wxT("Executing \"%s\" failed"), cmd.c_str()); return wxEmptyString; } @@ -769,7 +857,7 @@ static wxString wxGetCommandOutput(const wxString &cmd) pclose(f); - if ( !s.empty() && s.Last() == _T('\n') ) + if ( !s.empty() && s.Last() == wxT('\n') ) s.RemoveLast(); return s; @@ -790,11 +878,15 @@ static bool wxGetHostNameInternal(wxChar *buf, int sz) bool ok = uname(&uts) != -1; if ( ok ) { - wxStrncpy(buf, wxConvertMB2WX(uts.nodename), sz - 1); - buf[sz] = wxT('\0'); + wxStrlcpy(buf, wxSafeConvertMB2WX(uts.nodename), sz); } #elif defined(HAVE_GETHOSTNAME) - bool ok = gethostname(buf, sz) != -1; + char cbuf[sz]; + bool ok = gethostname(cbuf, sz) != -1; + if ( ok ) + { + wxStrlcpy(buf, wxSafeConvertMB2WX(cbuf), sz); + } #else // no uname, no gethostname wxFAIL_MSG(wxT("don't know host name for this machine")); @@ -836,7 +928,7 @@ bool wxGetFullHostName(wxChar *buf, int sz) { if ( !wxStrchr(buf, wxT('.')) ) { - struct hostent *host = gethostbyname(wxConvertWX2MB(buf)); + struct hostent *host = gethostbyname(wxSafeConvertWX2MB(buf)); if ( !host ) { wxLogSysError(_("Cannot get the official hostname")); @@ -846,7 +938,7 @@ bool wxGetFullHostName(wxChar *buf, int sz) else { // the canonical name - wxStrncpy(buf, wxConvertMB2WX(host->h_name), sz); + wxStrlcpy(buf, wxSafeConvertMB2WX(host->h_name), sz); } } //else: it's already a FQDN (BSD behaves this way) @@ -862,7 +954,7 @@ bool wxGetUserId(wxChar *buf, int sz) *buf = wxT('\0'); if ((who = getpwuid(getuid ())) != NULL) { - wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1); + wxStrlcpy (buf, wxSafeConvertMB2WX(who->pw_name), sz); return true; } @@ -871,41 +963,55 @@ bool wxGetUserId(wxChar *buf, int sz) bool wxGetUserName(wxChar *buf, int sz) { +#ifdef HAVE_PW_GECOS struct passwd *who; *buf = wxT('\0'); if ((who = getpwuid (getuid ())) != NULL) { - // pw_gecos field in struct passwd is not standard -#ifdef HAVE_PW_GECOS char *comma = strchr(who->pw_gecos, ','); if (comma) *comma = '\0'; // cut off non-name comment fields - wxStrncpy (buf, wxConvertMB2WX(who->pw_gecos), sz - 1); -#else // !HAVE_PW_GECOS - wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1); -#endif // HAVE_PW_GECOS/!HAVE_PW_GECOS + wxStrlcpy(buf, wxSafeConvertMB2WX(who->pw_gecos), sz); return true; } return false; +#else // !HAVE_PW_GECOS + return wxGetUserId(buf, sz); +#endif // HAVE_PW_GECOS/!HAVE_PW_GECOS } bool wxIsPlatform64Bit() { - wxString machine = wxGetCommandOutput(wxT("uname -m")); - - // NOTE: these tests are not 100% reliable! - return machine.Contains(wxT("AMD64")) || - machine.Contains(wxT("IA64")) || - machine.Contains(wxT("x64")) || - machine.Contains(wxT("X64")) || - machine.Contains(wxT("alpha")) || - machine.Contains(wxT("hppa64")) || - machine.Contains(wxT("ppc64")); + const wxString machine = wxGetCommandOutput(wxT("uname -m")); + + // the test for "64" is obviously not 100% reliable but seems to work fine + // in practice + return machine.Contains(wxT("64")) || + machine.Contains(wxT("alpha")); } -// these functions are in mac/utils.cpp for wxMac +#ifdef __LINUX__ +wxLinuxDistributionInfo wxGetLinuxDistributionInfo() +{ + const wxString id = wxGetCommandOutput(wxT("lsb_release --id")); + const wxString desc = wxGetCommandOutput(wxT("lsb_release --description")); + const wxString rel = wxGetCommandOutput(wxT("lsb_release --release")); + const wxString codename = wxGetCommandOutput(wxT("lsb_release --codename")); + + wxLinuxDistributionInfo ret; + + id.StartsWith("Distributor ID:\t", &ret.Id); + desc.StartsWith("Description:\t", &ret.Description); + rel.StartsWith("Release:\t", &ret.Release); + codename.StartsWith("Codename:\t", &ret.CodeName); + + return ret; +} +#endif + +// these functions are in src/osx/utilsexc_base.cpp for wxMac #ifndef __WXMAC__ wxOperatingSystemId wxGetOsVersion(int *verMaj, int *verMin) @@ -913,9 +1019,10 @@ wxOperatingSystemId wxGetOsVersion(int *verMaj, int *verMin) // get OS version int major, minor; wxString release = wxGetCommandOutput(wxT("uname -r")); - if ( !release.empty() && wxSscanf(release, "%d.%d", &major, &minor) != 2 ) + if ( release.empty() || + wxSscanf(release.c_str(), wxT("%d.%d"), &major, &minor) != 2 ) { - // unrecognized uname string format + // failed to get version string or unrecognized format major = minor = -1; } @@ -960,20 +1067,43 @@ wxMemorySize wxGetFreeMemory() char buf[1024]; if ( fgets(buf, WXSIZEOF(buf), fp) && fgets(buf, WXSIZEOF(buf), fp) ) { - long memTotal, memUsed; - sscanf(buf, "Mem: %ld %ld %ld", &memTotal, &memUsed, &memFree); + // /proc/meminfo changed its format in kernel 2.6 + if ( wxPlatformInfo().CheckOSVersion(2, 6) ) + { + unsigned long cached, buffers; + sscanf(buf, "MemFree: %ld", &memFree); + + fgets(buf, WXSIZEOF(buf), fp); + sscanf(buf, "Buffers: %lu", &buffers); + + fgets(buf, WXSIZEOF(buf), fp); + sscanf(buf, "Cached: %lu", &cached); + + // add to "MemFree" also the "Buffers" and "Cached" values as + // free(1) does as otherwise the value never makes sense: for + // kernel 2.6 it's always almost 0 + memFree += buffers + cached; + + // values here are always expressed in kB and we want bytes + memFree *= 1024; + } + else // Linux 2.4 (or < 2.6, anyhow) + { + long memTotal, memUsed; + sscanf(buf, "Mem: %ld %ld %ld", &memTotal, &memUsed, &memFree); + } } fclose(fp); return (wxMemorySize)memFree; } -#elif defined(__SUN__) && defined(_SC_AVPHYS_PAGES) - return (wxMemorySize)(sysconf(_SC_AVPHYS_PAGES)*sysconf(_SC_PAGESIZE)); #elif defined(__SGI__) struct rminfo realmem; if ( sysmp(MP_SAGET, MPSA_RMINFO, &realmem, sizeof realmem) == 0 ) return ((wxMemorySize)realmem.physmem * sysconf(_SC_PAGESIZE)); +#elif defined(_SC_AVPHYS_PAGES) + return ((wxMemorySize)sysconf(_SC_AVPHYS_PAGES))*sysconf(_SC_PAGESIZE); //#elif defined(__FREEBSD__) -- might use sysctl() to find it out, probably #endif @@ -1021,10 +1151,39 @@ bool wxGetDiskSpace(const wxString& path, wxDiskspaceSize_t *pTotal, wxDiskspace // env vars // ---------------------------------------------------------------------------- +#if USE_PUTENV + +WX_DECLARE_STRING_HASH_MAP(char *, wxEnvVars); + +static wxEnvVars gs_envVars; + +class wxSetEnvModule : public wxModule +{ +public: + virtual bool OnInit() { return true; } + virtual void OnExit() + { + for ( wxEnvVars::const_iterator i = gs_envVars.begin(); + i != gs_envVars.end(); + ++i ) + { + free(i->second); + } + + gs_envVars.clear(); + } + + DECLARE_DYNAMIC_CLASS(wxSetEnvModule) +}; + +IMPLEMENT_DYNAMIC_CLASS(wxSetEnvModule, wxModule) + +#endif // USE_PUTENV + bool wxGetEnv(const wxString& var, wxString *value) { // wxGetenv is defined as getenv() - wxChar *p = wxGetenv(var); + char *p = wxGetenv(var); if ( !p ) return false; @@ -1036,31 +1195,61 @@ bool wxGetEnv(const wxString& var, wxString *value) return true; } -bool wxSetEnv(const wxString& variable, const wxChar *value) +static bool wxDoSetEnv(const wxString& variable, const char *value) { #if defined(HAVE_SETENV) - return setenv(variable.mb_str(), - value ? (const char *)wxString(value).mb_str() - : NULL, - 1 /* overwrite */) == 0; + if ( !value ) + { +#ifdef HAVE_UNSETENV + // don't test unsetenv() return value: it's void on some systems (at + // least Darwin) + unsetenv(variable.mb_str()); + return true; +#else + value = ""; // we can't pass NULL to setenv() +#endif + } + + return setenv(variable.mb_str(), value, 1 /* overwrite */) == 0; #elif defined(HAVE_PUTENV) wxString s = variable; if ( value ) - s << _T('=') << value; + s << wxT('=') << value; // transform to ANSI const wxWX2MBbuf p = s.mb_str(); - // the string will be free()d by libc char *buf = (char *)malloc(strlen(p) + 1); strcpy(buf, p); + // store the string to free() it later + wxEnvVars::iterator i = gs_envVars.find(variable); + if ( i != gs_envVars.end() ) + { + free(i->second); + i->second = buf; + } + else // this variable hadn't been set before + { + gs_envVars[variable] = buf; + } + return putenv(buf) == 0; #else // no way to set an env var return false; #endif } +bool wxSetEnv(const wxString& variable, const wxString& value) +{ + return wxDoSetEnv(variable, value.mb_str()); +} + +bool wxUnsetEnv(const wxString& variable) +{ + return wxDoSetEnv(variable, NULL); +} + // ---------------------------------------------------------------------------- // signal handling // ---------------------------------------------------------------------------- @@ -1108,7 +1297,7 @@ bool wxHandleFatalExceptions(bool doit) ok &= sigaction(SIGSEGV, &act, &s_handlerSEGV) == 0; if ( !ok ) { - wxLogDebug(_T("Failed to install our signal handler.")); + wxLogDebug(wxT("Failed to install our signal handler.")); } s_savedHandlers = true; @@ -1122,7 +1311,7 @@ bool wxHandleFatalExceptions(bool doit) ok &= sigaction(SIGSEGV, &s_handlerSEGV, NULL) == 0; if ( !ok ) { - wxLogDebug(_T("Failed to uninstall our signal handler.")); + wxLogDebug(wxT("Failed to uninstall our signal handler.")); } s_savedHandlers = false; @@ -1134,166 +1323,271 @@ bool wxHandleFatalExceptions(bool doit) #endif // wxUSE_ON_FATAL_EXCEPTION -#endif // wxUSE_BASE - -#if wxUSE_GUI - // ---------------------------------------------------------------------------- // wxExecute support // ---------------------------------------------------------------------------- -// Darwin doesn't use the same process end detection mechanisms so we don't -// need wxExecute-related helpers for it -#if !(defined(__DARWIN__) && defined(__WXMAC__)) - -bool wxGUIAppTraits::CreateEndProcessPipe(wxExecuteData& execData) +int wxAppTraits::AddProcessCallback(wxEndProcessData *data, int fd) { - return execData.pipeEndProcDetect.Create(); -} + // define a custom handler processing only the closure of the descriptor + struct wxEndProcessFDIOHandler : public wxFDIOHandler + { + wxEndProcessFDIOHandler(wxEndProcessData *data, int fd) + : m_data(data), m_fd(fd) + { + } -bool wxGUIAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& execData, int fd) -{ - return fd == (execData.pipeEndProcDetect)[wxPipe::Write]; -} + virtual void OnReadWaiting() + { + wxFDIODispatcher::Get()->UnregisterFD(m_fd); + close(m_fd); -void wxGUIAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& execData) -{ - execData.pipeEndProcDetect.Detach(wxPipe::Write); - execData.pipeEndProcDetect.Close(); -} + wxHandleProcessTermination(m_data); -#else // !Darwin + delete this; + } -bool wxGUIAppTraits::CreateEndProcessPipe(wxExecuteData& WXUNUSED(execData)) -{ - return true; + virtual void OnWriteWaiting() { wxFAIL_MSG("unreachable"); } + virtual void OnExceptionWaiting() { wxFAIL_MSG("unreachable"); } + + wxEndProcessData * const m_data; + const int m_fd; + }; + + wxFDIODispatcher::Get()->RegisterFD + ( + fd, + new wxEndProcessFDIOHandler(data, fd), + wxFDIO_INPUT + ); + return fd; // unused, but return something unique for the tag } -bool -wxGUIAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData), - int WXUNUSED(fd)) +bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData) { +#if HAS_PIPE_STREAMS + bool hasIO = false; + + if ( execData.bufOut && execData.bufOut->Update() ) + hasIO = true; + + if ( execData.bufErr && execData.bufErr->Update() ) + hasIO = true; + + return hasIO; +#else // !HAS_PIPE_STREAMS + wxUnusedVar(execData); + return false; +#endif // HAS_PIPE_STREAMS/!HAS_PIPE_STREAMS } -void -wxGUIAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData)) +// helper classes/functions used by WaitForChild() +namespace { - // nothing to do here, we don't use the pipe -} - -#endif // !Darwin/Darwin -int wxGUIAppTraits::WaitForChild(wxExecuteData& execData) +// convenient base class for IO handlers which are registered for read +// notifications only and which also stores the FD we're reading from +// +// the derived classes still have to implement OnReadWaiting() +class wxReadFDIOHandler : public wxFDIOHandler { - wxEndProcessData *endProcData = new wxEndProcessData; +public: + wxReadFDIOHandler(wxFDIODispatcher& disp, int fd) : m_fd(fd) + { + if ( fd ) + disp.RegisterFD(fd, this, wxFDIO_INPUT); + } - const int flags = execData.flags; + virtual void OnWriteWaiting() { wxFAIL_MSG("unreachable"); } + virtual void OnExceptionWaiting() { wxFAIL_MSG("unreachable"); } - // wxAddProcessCallback is now (with DARWIN) allowed to call the - // callback function directly if the process terminates before - // the callback can be added to the run loop. Set up the endProcData. - if ( flags & wxEXEC_SYNC ) - { - // we may have process for capturing the program output, but it's - // not used in wxEndProcessData in the case of sync execution - endProcData->process = NULL; +protected: + const int m_fd; - // sync execution: indicate it by negating the pid - endProcData->pid = -execData.pid; - } - else + wxDECLARE_NO_COPY_CLASS(wxReadFDIOHandler); +}; + +// class for monitoring our end of the process detection pipe, simply sets a +// flag when input on the pipe (which must be due to EOF) is detected +class wxEndHandler : public wxReadFDIOHandler +{ +public: + wxEndHandler(wxFDIODispatcher& disp, int fd) + : wxReadFDIOHandler(disp, fd) { - // async execution, nothing special to do -- caller will be - // notified about the process termination if process != NULL, endProcData - // will be deleted in GTK_EndProcessDetector - endProcData->process = execData.process; - endProcData->pid = execData.pid; + m_terminated = false; } + bool Terminated() const { return m_terminated; } -#if defined(__DARWIN__) && (defined(__WXMAC__) || defined(__WXCOCOA__)) - endProcData->tag = wxAddProcessCallbackForPid(endProcData, execData.pid); -#else - endProcData->tag = wxAddProcessCallback - ( - endProcData, - execData.pipeEndProcDetect.Detach(wxPipe::Read) - ); + virtual void OnReadWaiting() { m_terminated = true; } - execData.pipeEndProcDetect.Close(); -#endif // defined(__DARWIN__) && (defined(__WXMAC__) || defined(__WXCOCOA__)) +private: + bool m_terminated; - if ( flags & wxEXEC_SYNC ) + wxDECLARE_NO_COPY_CLASS(wxEndHandler); +}; + +#if HAS_PIPE_STREAMS + +// class for monitoring our ends of child stdout/err, should be constructed +// with the FD and stream from wxExecuteData and will do nothing if they're +// invalid +// +// unlike wxEndHandler this class registers itself with the provided dispatcher +class wxRedirectedIOHandler : public wxReadFDIOHandler +{ +public: + wxRedirectedIOHandler(wxFDIODispatcher& disp, + int fd, + wxStreamTempInputBuffer *buf) + : wxReadFDIOHandler(disp, fd), + m_buf(buf) { - wxBusyCursor bc; - wxWindowDisabler *wd = flags & wxEXEC_NODISABLE ? NULL - : new wxWindowDisabler; + } - // endProcData->pid will be set to 0 from GTK_EndProcessDetector when the - // process terminates - while ( endProcData->pid != 0 ) - { - bool idle = true; + virtual void OnReadWaiting() + { + m_buf->Update(); + } -#if HAS_PIPE_INPUT_STREAM - if ( execData.bufOut ) - { - execData.bufOut->Update(); - idle = false; - } +private: + wxStreamTempInputBuffer * const m_buf; - if ( execData.bufErr ) - { - execData.bufErr->Update(); - idle = false; - } -#endif // HAS_PIPE_INPUT_STREAM + wxDECLARE_NO_COPY_CLASS(wxRedirectedIOHandler); +}; - // don't consume 100% of the CPU while we're sitting in this - // loop - if ( idle ) - wxMilliSleep(1); +#endif // HAS_PIPE_STREAMS - // give GTK+ a chance to call GTK_EndProcessDetector here and - // also repaint the GUI - wxYield(); - } +// helper function which calls waitpid() and analyzes the result +int DoWaitForChild(int pid, int flags = 0) +{ + wxASSERT_MSG( pid > 0, "invalid PID" ); - int exitcode = endProcData->exitcode; + int status, rc; - delete wd; - delete endProcData; + // loop while we're getting EINTR + for ( ;; ) + { + rc = waitpid(pid, &status, flags); + + if ( rc != -1 || errno != EINTR ) + break; + } + + if ( rc == 0 ) + { + // This can only happen if the child application closes our dummy pipe + // that is used to monitor its lifetime; in that case, our best bet is + // to pretend the process did terminate, because otherwise wxExecute() + // would hang indefinitely (OnReadWaiting() won't be called again, the + // descriptor is closed now). + wxLogDebug("Child process (PID %d) still alive but pipe closed so " + "generating a close notification", pid); + } + else if ( rc == -1 ) + { + wxLogLastError(wxString::Format("waitpid(%d)", pid)); + } + else // child did terminate + { + wxASSERT_MSG( rc == pid, "unexpected waitpid() return value" ); + + // notice that the caller expects the exit code to be signed, e.g. -1 + // instead of 255 so don't assign WEXITSTATUS() to an int + signed char exitcode; + if ( WIFEXITED(status) ) + exitcode = WEXITSTATUS(status); + else if ( WIFSIGNALED(status) ) + exitcode = -WTERMSIG(status); + else + { + wxLogError("Child process (PID %d) exited for unknown reason, " + "status = %d", pid, status); + exitcode = -1; + } return exitcode; } - else // async execution + + return -1; +} + +} // anonymous namespace + +int wxAppTraits::WaitForChild(wxExecuteData& execData) +{ + if ( !(execData.flags & wxEXEC_SYNC) ) { + // asynchronous execution: just launch the process and return, + // endProcData will be destroyed when it terminates (currently we leak + // it if the process doesn't terminate before we do and this should be + // fixed but it's not a real leak so it's not really very high + // priority) + wxEndProcessData *endProcData = new wxEndProcessData; + endProcData->process = execData.process; + endProcData->pid = execData.pid; + endProcData->tag = AddProcessCallback + ( + endProcData, + execData.GetEndProcReadFD() + ); + endProcData->async = true; + return execData.pid; } -} + //else: synchronous execution case + +#if HAS_PIPE_STREAMS && wxUSE_SOCKETS + wxProcess * const process = execData.process; + if ( process && process->IsRedirected() ) + { + // we can't simply block waiting for the child to terminate as we would + // dead lock if it writes more than the pipe buffer size (typically + // 4KB) bytes of output -- it would then block waiting for us to read + // the data while we'd block waiting for it to terminate + // + // so multiplex here waiting for any input from the child or closure of + // the pipe used to indicate its termination + wxSelectDispatcher disp; + + wxEndHandler endHandler(disp, execData.GetEndProcReadFD()); + + wxRedirectedIOHandler outHandler(disp, execData.fdOut, execData.bufOut), + errHandler(disp, execData.fdErr, execData.bufErr); + + while ( !endHandler.Terminated() ) + { + disp.Dispatch(); + } + } + //else: no IO redirection, just block waiting for the child to exit +#endif // HAS_PIPE_STREAMS -#endif // wxUSE_GUI -#if wxUSE_BASE + return DoWaitForChild(execData.pid); +} -void wxHandleProcessTermination(wxEndProcessData *proc_data) +void wxHandleProcessTermination(wxEndProcessData *data) { + data->exitcode = DoWaitForChild(data->pid, WNOHANG); + // notify user about termination if required - if ( proc_data->process ) + if ( data->process ) { - proc_data->process->OnTerminate(proc_data->pid, proc_data->exitcode); + data->process->OnTerminate(data->pid, data->exitcode); } - // clean up - if ( proc_data->pid > 0 ) + if ( data->async ) { - delete proc_data; + // in case of asynchronous execution we don't need this data any more + // after the child terminates + delete data; } - else + else // sync execution { - // let wxExecute() know that the process has terminated - proc_data->pid = 0; + // let wxExecute() know that the process has terminated + data->pid = 0; } } -#endif // wxUSE_BASE