Remove some out of date comments.

[wxWidgets.git] / src / unix / utilsunx.cpp

diff --git a/src/unix/utilsunx.cpp b/src/unix/utilsunx.cpp
index f5380ab137addde78c396723d8cb7b0dba48bc9d..ec550fcf244c9a990bec2e530683fd7418e9533a 100644 (file)
--- a/src/unix/utilsunx.cpp
+++ b/src/unix/utilsunx.cpp
@@ -59,15 +59,15 @@
 #   include <sys/select.h>
 #endif
 
 #   include <sys/select.h>
 #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"
 
 
 // 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
 
 #if defined(__MWERKS__) && defined(__MACH__)
     #ifndef WXWIN_OS_DESCRIPTION


@@ -297,7 +297,7 @@ bool wxShutdown(int flags)
 // wxStream classes to support IO redirection in wxExecute
 // ----------------------------------------------------------------------------
 
 // wxStream classes to support IO redirection in wxExecute
 // ----------------------------------------------------------------------------
 

-#if HAS_PIPE_INPUT_STREAM
+#if HAS_PIPE_STREAMS

 
 bool wxPipeInputStream::CanRead() const
 {
 
 bool wxPipeInputStream::CanRead() const
 {


@@ -337,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
 
 // ----------------------------------------------------------------------------
 // wxShell


@@ -559,12 +598,6 @@ long wxExecute(char **argv, int flags, wxProcess *process,
         }
 #endif // !__VMS
 
         }
 #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() )
         {
         // redirect stdin, stdout and stderr
         if ( pipeIn.IsOk() )
         {


@@ -580,6 +613,39 @@ long wxExecute(char **argv, int flags, wxProcess *process,
             pipeErr.Close();
         }
 
             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 )
         {
         // Process additional options if we have any
         if ( env )
         {


@@ -643,7 +709,7 @@ long wxExecute(char **argv, int flags, wxProcess *process,
 
         // prepare for IO redirection
 
 
         // 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,
         // the input buffer bufOut is connected to stdout, this is why it is
         // called bufOut and not bufIn
         wxStreamTempInputBuffer bufOut,


@@ -662,10 +728,13 @@ long wxExecute(char **argv, int flags, wxProcess *process,
                 // it might not be the best idea.
                 wxLogSysError(_("Failed to set up non-blocking pipe, "
                                 "the program might hang."));
                 // 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 =
             }
 
             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);
 
             const int fdOut = pipeOut.Detach(wxPipe::Read);
             wxPipeInputStream *outStream = new wxPipeInputStream(fdOut);


@@ -684,7 +753,7 @@ long wxExecute(char **argv, int flags, wxProcess *process,
             execData.fdOut = fdOut;
             execData.fdErr = fdErr;
         }
             execData.fdOut = fdOut;
             execData.fdErr = fdErr;
         }

-#endif // HAS_PIPE_INPUT_STREAM
+#endif // HAS_PIPE_STREAMS

 
         if ( pipeIn.IsOk() )
         {
 
         if ( pipeIn.IsOk() )
         {


@@ -1296,7 +1365,7 @@ int wxAppTraits::AddProcessCallback(wxEndProcessData *data, int fd)
 
 bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData)
 {
 
 bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData)
 {

-#if HAS_PIPE_INPUT_STREAM
+#if HAS_PIPE_STREAMS

     bool hasIO = false;
 
     if ( execData.bufOut && execData.bufOut->Update() )
     bool hasIO = false;
 
     if ( execData.bufOut && execData.bufOut->Update() )


@@ -1306,11 +1375,11 @@ bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData)
         hasIO = true;
 
     return hasIO;
         hasIO = true;
 
     return hasIO;

-#else // !HAS_PIPE_INPUT_STREAM
+#else // !HAS_PIPE_STREAMS

     wxUnusedVar(execData);
 
     return false;
     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()
 }
 
 // helper classes/functions used by WaitForChild()


@@ -1360,7 +1429,7 @@ private:
     wxDECLARE_NO_COPY_CLASS(wxEndHandler);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxEndHandler);
 };
 

-#if HAS_PIPE_INPUT_STREAM
+#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
 
 // 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


@@ -1389,7 +1458,7 @@ private:
     wxDECLARE_NO_COPY_CLASS(wxRedirectedIOHandler);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxRedirectedIOHandler);
 };
 

-#endif // HAS_PIPE_INPUT_STREAM
+#endif // HAS_PIPE_STREAMS

 
 // helper function which calls waitpid() and analyzes the result
 int DoWaitForChild(int pid, int flags = 0)
 
 // helper function which calls waitpid() and analyzes the result
 int DoWaitForChild(int pid, int flags = 0)


@@ -1470,7 +1539,7 @@ int wxAppTraits::WaitForChild(wxExecuteData& execData)
     }
     //else: synchronous execution case
 
     }
     //else: synchronous execution case
 

-#if HAS_PIPE_INPUT_STREAM && wxUSE_SOCKETS
+#if HAS_PIPE_STREAMS && wxUSE_SOCKETS

     wxProcess * const process = execData.process;
     if ( process && process->IsRedirected() )
     {
     wxProcess * const process = execData.process;
     if ( process && process->IsRedirected() )
     {


@@ -1494,7 +1563,7 @@ int wxAppTraits::WaitForChild(wxExecuteData& execData)
         }
     }
     //else: no IO redirection, just block waiting for the child to exit
         }
     }
     //else: no IO redirection, just block waiting for the child to exit

-#endif // HAS_PIPE_INPUT_STREAM
+#endif // HAS_PIPE_STREAMS

 
     return DoWaitForChild(execData.pid);
 }
 
     return DoWaitForChild(execData.pid);
 }