add option to forward environment to pipestream
[libi2ncommon] / src / pipestream.hxx
index 211ee5d..8668df3 100644 (file)
@@ -29,92 +29,148 @@ on this file might be covered by the GNU General Public License.
 
 #include <stdio.h>
 
+#include <cstring>
 #include <string>
 #include <streambuf>
 #include <istream>
 #include <ostream>
-#include <cstdio>
+#include <vector>
 
-#include "exception.hxx"
+#include <stringfunc.hxx>
 
-// ATTENTION: A lot of mysterious STL bugs occured
-//            with a "real" buffer (buffer larger than 1 byte and up to 100 bytes)
-//            -> Keep it slow and working!
+struct ExecResult
+{
+    /** if the program exited normally and returned a return code */
+    bool normal_exit;
+
+    /** the real return code of the program, only set when normal_exit true */
+    char return_code;
+
+    /** if the program was terminated by a signal */
+    bool terminated_by_signal;
+
+    /** number of the signal that terminated the program, only valid when terminated_by_signal true */
+    int signal;
+
+    /** errormessage if we have one */
+    std::string error_message;
+
+    inline std::string format (void) const
+    {
+        return std::string ("(")
+            + "(normal_exit " + (this->normal_exit ? "T" : "F") + ") "
+              "(return_code '" + I2n::to_string ((int)this->return_code) + "') "
+              "(signal " + (this->terminated_by_signal
+                            ? strsignal (this->signal)
+                            : "<nil>") + "))"
+            ;
+    };
+};
+typedef struct ExecResult ExecResult;
+
+std::string capture_exec(const std::string& command, ExecResult &rescode);
+std::string capture_exec(const char *const *command, ExecResult &rescode,
+                         const bool out=true, const bool err=false,
+                         const bool path=false, const bool env=false);
+std::string capture_exec(const std::vector<std::string>& command, ExecResult &rescode,
+                         const bool out=true, const bool err=false,
+                         const bool path=false, const bool env=false);
+
+inline std::string capture_exec (const std::string &command)
+{
+    ExecResult r;
+    return capture_exec(command,r);
+}
+
+inline std::string capture_exec(const char *const *command)
+{
+    ExecResult r;
+    return capture_exec(command,r);
+}
 
+inline std::string capture_exec(const std::vector<std::string>& command)
+{
+    ExecResult r;
+    return capture_exec(command,r);
+}
+
+/** @brief runs command and provides buffered input for it through pipe
+ *
+ * opens pipe to command using popen; exit status available after destruction
+ * (use WEXITSTATUS to get the "regular" return code (lowest byte))
+ *
+ * ATTENTION: A lot of mysterious STL bugs occured
+ *            with a "real" buffer (buffer larger than 1 byte and up to 100 bytes)
+ *            -> Keep it slow and working!
+ */
 class inpipebuf : public std::streambuf
 {
 protected:
     char buffer;
+
     FILE *pipe;
+    pid_t pid;
 
     // "callback" variables for destructor to store exit status
     bool *status_set;
     int *exit_status;
 
 public:
-    inpipebuf(const std::string& command)
-    {
-        status_set = NULL;
-        exit_status = NULL;
-
-        pipe = popen (command.c_str(), "r");
-        if (pipe == NULL)
-            throw EXCEPTION (pipestream_error, "can't open program or permission denied");
-
-        // force underflow
-        setg (&buffer, &buffer, &buffer);
-    }
-
-    ~inpipebuf()
-    {
-        if (pipe != NULL) {
-            int pclose_exit = pclose (pipe);
+    inpipebuf(const std::string& command,
+              const bool out, const bool err, const bool path, const bool env);
+    inpipebuf(const char *const *command,
+              const bool out, const bool err, const bool path, const bool env);
+    inpipebuf(const std::vector<std::string> &command,
+              const bool out, const bool err, const bool path, const bool env);
 
-            if (exit_status && pclose_exit != -1) {
-                *status_set = true;
-                *exit_status = pclose_exit;
-            }
+    ~inpipebuf();
 
-            pipe = NULL;
-        }
-    }
-
-    void store_exit_status(bool *_status_set, int *_exit_status)
-    { status_set = _status_set; exit_status = _exit_status; }
+    void store_exit_status(bool *_status_set, int *_exit_status);
 
 protected:
-    virtual int_type underflow()
-    {
-        if (gptr() < egptr())
-            return traits_type::to_int_type(*gptr());
-
-        buffer = fgetc (pipe);
-        if (feof (pipe))
-        {
-            // ERROR or EOF
-            return EOF;
-        }
-
-        setg (&buffer, &buffer, &buffer+sizeof(char));
+    virtual int_type underflow();
 
-        return traits_type::to_int_type(*gptr());
-    }
+private:
+    std::pair <pid_t, FILE *>
+    init_without_shell (const char *const *argv,
+                        const bool out, const bool err,
+                        const bool path, const bool env) const;
 };
 
+/** @brief stream around inpipebuf -- see comment there */
 class inpipestream : public std::istream
 {
 protected:
     inpipebuf buf;
 
 public:
-    inpipestream(const std::string& command)
-            : std::istream(&buf), buf(command)
+    inpipestream(const std::string& command,
+                 const bool out=true, const bool err=false,
+                 const bool path=false, const bool env=false)
+            : std::istream(&buf), buf(command, out, err, path, env)
+    {}
+
+    inpipestream(const char *const command[],
+                 const bool out=true, const bool err=false,
+                 const bool path=false, const bool env=false)
+            : std::istream(&buf), buf(command, out, err, path, env)
+    {}
+
+    inpipestream(const std::vector<std::string> &command,
+                 const bool out=true, const bool err=false,
+                 const bool path=false, const bool env=false)
+            : std::istream(&buf), buf(command, out, err, path, env)
     {}
 
     void store_exit_status(bool *_status_set, int *_exit_status)
     { buf.store_exit_status(_status_set, _exit_status); }
 };
 
+/** @brief runs command and provides buffered ouptput from it through pipe
+ *
+ * opens pipe to command using popen; exit status available after destruction
+ * (use WEXITSTATUS to get the "regular" return code (lowest byte))
+ */
 class outpipebuf : public std::streambuf
 {
 protected:
@@ -125,50 +181,21 @@ protected:
     int *exit_status;
 
 public:
-    outpipebuf(const std::string& command)
-    {
-        status_set = NULL;
-        exit_status = NULL;
+    outpipebuf(const std::string& command);
 
-        pipe = popen (command.c_str(), "w");
-        if (pipe == NULL)
-            throw EXCEPTION (pipestream_error, "can't open program or permission denied");
-    }
+    ~outpipebuf();
 
-    ~outpipebuf()
-    {
-        if (pipe != NULL) {
-            int pclose_exit = pclose (pipe);
-
-            if (exit_status && pclose_exit != -1) {
-                *status_set = true;
-                *exit_status = pclose_exit;
-            }
-
-            pipe = NULL;
-        }
-    }
-
-    void store_exit_status(bool *_status_set, int *_exit_status)
-    { status_set = _status_set; exit_status = _exit_status; }
+    /** note: exit status only available after destruction */
+    void store_exit_status(bool *_status_set, int *_exit_status);
 
 protected:
-    virtual int_type overflow(int_type c)
-    {
-        if (c != EOF)
-        {
-            if (fputc(c,pipe)==EOF)
-                return EOF;
-        }
-        return c;
-    }
-
-    virtual std::streamsize xsputn(const char* s, std::streamsize num)
-    {
-        return fwrite(s,num,1,pipe);
-    }
+    virtual int_type overflow(int_type c);
+
+    virtual std::streamsize xsputn(const char* s, std::streamsize num);
 };
 
+
+/** @brief stream around outpipebuf -- see comment there */
 class outpipestream : public std::ostream
 {
 protected: