X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d7ef641d4e6d0e2157beb920bdd7d72fc6aecfd7..8a07956565ddccd1720abf4e510945593128d774:/src/unix/utilsunx.cpp diff --git a/src/unix/utilsunx.cpp b/src/unix/utilsunx.cpp index 5b9a1f627d..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 @@ -39,6 +39,8 @@ #include "wx/process.h" #include "wx/thread.h" +#include "wx/cmdline.h" + #include "wx/wfstream.h" #include "wx/private/selectdispatcher.h" @@ -57,15 +59,15 @@ # 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 +#endif // HAS_PIPE_STREAMS #if defined(__MWERKS__) && defined(__MACH__) #ifndef WXWIN_OS_DESCRIPTION @@ -200,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() @@ -253,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; @@ -264,32 +266,38 @@ int wxKill(long pid, wxSignal sig, wxKillError *rc, int flags) } // Shutdown or reboot the PC -bool wxShutdown(wxShutdownFlags wFlags) +bool wxShutdown(int flags) { + flags &= ~wxSHUTDOWN_FORCE; + wxChar level; - switch ( wFlags ) + switch ( flags ) { case wxSHUTDOWN_POWEROFF: - level = _T('0'); + level = wxT('0'); break; case wxSHUTDOWN_REBOOT: - level = _T('6'); + level = wxT('6'); break; + case wxSHUTDOWN_LOGOFF: + // TODO: use dcop to log off? + return false; + default: - wxFAIL_MSG( _T("unknown wxShutdown() flag") ); + wxFAIL_MSG( wxT("unknown wxShutdown() flag") ); return false; } - return system(wxString::Format(_T("init %c"), level).mb_str()) == 0; + return system(wxString::Format("init %c", level).mb_str()) == 0; } // ---------------------------------------------------------------------------- // wxStream classes to support IO redirection in wxExecute // ---------------------------------------------------------------------------- -#if HAS_PIPE_INPUT_STREAM +#if HAS_PIPE_STREAMS bool wxPipeInputStream::CanRead() const { @@ -318,7 +326,7 @@ bool wxPipeInputStream::CanRead() const return false; default: - wxFAIL_MSG(_T("unexpected select() return value")); + wxFAIL_MSG(wxT("unexpected select() return value")); // still fall through case 1: @@ -329,7 +337,46 @@ bool wxPipeInputStream::CanRead() const } } -#endif // HAS_PIPE_INPUT_STREAM +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 @@ -341,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; @@ -359,7 +406,7 @@ 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); } @@ -386,7 +433,7 @@ public: ArgsArray(wchar_t **wargv) { int argc = 0; - while ( *wargv++ ) + while ( wargv[argc] ) argc++; Init(argc); @@ -421,7 +468,7 @@ private: int m_argc; char **m_argv; - DECLARE_NO_COPY_CLASS(ArgsArray); + wxDECLARE_NO_COPY_CLASS(ArgsArray); }; } // anonymous namespace @@ -434,78 +481,30 @@ private: bool wxMacLaunch(char **argv); #endif -long wxExecute(const wxString& command, int flags, wxProcess *process) +long wxExecute(const wxString& command, int flags, wxProcess *process, + const wxExecuteEnv *env) { - wxArrayString args; - - const char *cptr = command.c_str(); - - // split the command line in arguments - // - // TODO: combine this with wxCmdLineParser::ConvertStringToArgs(), it - // doesn't do exactly the same thing right now but it's pretty close - // and we shouldn't maintain 2 copies of this code - do - { - wxString argument; - char quotechar = '\0'; // is arg quoted? - bool escaped = false; - - // eat leading whitespace: - while ( wxIsspace(*cptr) ) - cptr++; - - if ( *cptr == '\'' || *cptr == '"' ) - quotechar = *cptr++; - - do - { - if ( *cptr == '\\' && !escaped ) - { - escaped = true; - cptr++; - continue; - } - - // all other characters: - argument += *cptr++; - escaped = false; - - // have we reached the end of the argument? - if ( (*cptr == quotechar && !escaped) - || (quotechar == '\0' && wxIsspace(*cptr)) - || *cptr == '\0' ) - { - args.push_back(argument); - - // if not at end of buffer, swallow last character: - if ( *cptr ) - cptr++; - - break; // done with this one, start over - } - } while ( *cptr ); - } while ( *cptr ); - - ArgsArray argv(args); + ArgsArray argv(wxCmdLineParser::ConvertStringToArgs(command, + wxCMD_LINE_SPLIT_UNIX)); - // do execute the command - return wxExecute(argv, flags, process); + return wxExecute(argv, flags, process, env); } #if wxUSE_UNICODE -long wxExecute(wchar_t **wargv, int flags, wxProcess *process) +long wxExecute(wchar_t **wargv, int flags, wxProcess *process, + const wxExecuteEnv *env) { ArgsArray argv(wargv); - return wxExecute(argv, flags, process); + return wxExecute(argv, flags, process, env); } #endif // wxUSE_UNICODE // wxExecute: the real worker function -long wxExecute(char **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 @@ -523,10 +522,10 @@ long wxExecute(char **argv, int flags, wxProcess *process) // 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") ); + wxT("wxExecute() can be called only from the main thread") ); #endif // wxUSE_THREADS -#if defined(__DARWIN__) +#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. @@ -585,30 +584,10 @@ long wxExecute(char **argv, int flags, wxProcess *process) } 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] - || fd == (execData.pipeEndProcDetect)[wxPipe::Write] ) - { - // 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 ) @@ -619,12 +598,6 @@ long wxExecute(char **argv, int flags, wxProcess *process) } #endif // !__VMS - // reading side can be safely closed but we should keep the write one - // opened, it will be only closed when the process terminates resulting - // in a read notification to the parent - execData.pipeEndProcDetect.Detach(wxPipe::Write); - execData.pipeEndProcDetect.Close(); - // redirect stdin, stdout and stderr if ( pipeIn.IsOk() ) { @@ -640,6 +613,73 @@ long wxExecute(char **argv, int flags, wxProcess *process) pipeErr.Close(); } + // 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("); @@ -664,10 +704,12 @@ long wxExecute(char **argv, int flags, wxProcess *process) { // 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, @@ -675,8 +717,24 @@ long wxExecute(char **argv, int flags, wxProcess *process) if ( process && process->IsRedirected() ) { + // 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)); const int fdOut = pipeOut.Detach(wxPipe::Read); wxPipeInputStream *outStream = new wxPipeInputStream(fdOut); @@ -695,7 +753,7 @@ long wxExecute(char **argv, int flags, wxProcess *process) execData.fdOut = fdOut; execData.fdErr = fdErr; } -#endif // HAS_PIPE_INPUT_STREAM +#endif // HAS_PIPE_STREAMS if ( pipeIn.IsOk() ) { @@ -783,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; } @@ -799,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; @@ -820,16 +878,14 @@ static bool wxGetHostNameInternal(wxChar *buf, int sz) bool ok = uname(&uts) != -1; if ( ok ) { - wxStrncpy(buf, wxSafeConvertMB2WX(uts.nodename), sz - 1); - buf[sz] = wxT('\0'); + wxStrlcpy(buf, wxSafeConvertMB2WX(uts.nodename), sz); } #elif defined(HAVE_GETHOSTNAME) char cbuf[sz]; bool ok = gethostname(cbuf, sz) != -1; if ( ok ) { - wxStrncpy(buf, wxSafeConvertMB2WX(cbuf), sz - 1); - buf[sz] = wxT('\0'); + wxStrlcpy(buf, wxSafeConvertMB2WX(cbuf), sz); } #else // no uname, no gethostname wxFAIL_MSG(wxT("don't know host name for this machine")); @@ -882,7 +938,7 @@ bool wxGetFullHostName(wxChar *buf, int sz) else { // the canonical name - wxStrncpy(buf, wxSafeConvertMB2WX(host->h_name), sz); + wxStrlcpy(buf, wxSafeConvertMB2WX(host->h_name), sz); } } //else: it's already a FQDN (BSD behaves this way) @@ -898,7 +954,7 @@ bool wxGetUserId(wxChar *buf, int sz) *buf = wxT('\0'); if ((who = getpwuid(getuid ())) != NULL) { - wxStrncpy (buf, wxSafeConvertMB2WX(who->pw_name), sz - 1); + wxStrlcpy (buf, wxSafeConvertMB2WX(who->pw_name), sz); return true; } @@ -916,7 +972,7 @@ bool wxGetUserName(wxChar *buf, int sz) char *comma = strchr(who->pw_gecos, ','); if (comma) *comma = '\0'; // cut off non-name comment fields - wxStrncpy (buf, wxSafeConvertMB2WX(who->pw_gecos), sz - 1); + wxStrlcpy(buf, wxSafeConvertMB2WX(who->pw_gecos), sz); return true; } @@ -936,7 +992,26 @@ bool wxIsPlatform64Bit() 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) @@ -1139,7 +1214,7 @@ static bool wxDoSetEnv(const wxString& variable, const char *value) #elif defined(HAVE_PUTENV) wxString s = variable; if ( value ) - s << _T('=') << value; + s << wxT('=') << value; // transform to ANSI const wxWX2MBbuf p = s.mb_str(); @@ -1222,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; @@ -1236,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; @@ -1290,7 +1365,7 @@ int wxAppTraits::AddProcessCallback(wxEndProcessData *data, int fd) bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData) { -#if HAS_PIPE_INPUT_STREAM +#if HAS_PIPE_STREAMS bool hasIO = false; if ( execData.bufOut && execData.bufOut->Update() ) @@ -1300,9 +1375,11 @@ bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData) hasIO = true; return hasIO; -#else // !HAS_PIPE_INPUT_STREAM +#else // !HAS_PIPE_STREAMS + wxUnusedVar(execData); + return false; -#endif // HAS_PIPE_INPUT_STREAM/!HAS_PIPE_INPUT_STREAM +#endif // HAS_PIPE_STREAMS/!HAS_PIPE_STREAMS } // helper classes/functions used by WaitForChild() @@ -1328,7 +1405,7 @@ public: protected: const int m_fd; - DECLARE_NO_COPY_CLASS(wxReadFDIOHandler) + wxDECLARE_NO_COPY_CLASS(wxReadFDIOHandler); }; // class for monitoring our end of the process detection pipe, simply sets a @@ -1349,10 +1426,10 @@ public: private: bool m_terminated; - DECLARE_NO_COPY_CLASS(wxEndHandler) + wxDECLARE_NO_COPY_CLASS(wxEndHandler); }; -#if wxUSE_STREAMS +#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 @@ -1378,10 +1455,10 @@ public: private: wxStreamTempInputBuffer * const m_buf; - DECLARE_NO_COPY_CLASS(wxRedirectedIOHandler) + wxDECLARE_NO_COPY_CLASS(wxRedirectedIOHandler); }; -#endif // wxUSE_STREAMS +#endif // HAS_PIPE_STREAMS // helper function which calls waitpid() and analyzes the result int DoWaitForChild(int pid, int flags = 0) @@ -1417,15 +1494,21 @@ int DoWaitForChild(int pid, int flags = 0) { 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) ) - return WEXITSTATUS(status); + exitcode = WEXITSTATUS(status); else if ( WIFSIGNALED(status) ) - return -WTERMSIG(status); + exitcode = -WTERMSIG(status); else { wxLogError("Child process (PID %d) exited for unknown reason, " "status = %d", pid, status); + exitcode = -1; } + + return exitcode; } return -1; @@ -1456,7 +1539,7 @@ int wxAppTraits::WaitForChild(wxExecuteData& execData) } //else: synchronous execution case -#if wxUSE_STREAMS +#if HAS_PIPE_STREAMS && wxUSE_SOCKETS wxProcess * const process = execData.process; if ( process && process->IsRedirected() ) { @@ -1480,7 +1563,7 @@ int wxAppTraits::WaitForChild(wxExecuteData& execData) } } //else: no IO redirection, just block waiting for the child to exit -#endif // wxUSE_STREAMS +#endif // HAS_PIPE_STREAMS return DoWaitForChild(execData.pid); }