OW_Exec.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2004 Vintela, Inc. All rights reserved.
* Copyright (C) 2005 Novell, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc., Novell, Inc., nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc., Novell, Inc., OR THE 
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_EXEC_HPP_
#define OW_EXEC_HPP_
#include "OW_config.h"
#include "OW_Types.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_String.hpp"
#include "OW_ArrayFwd.hpp"
#include "OW_CommonFwd.hpp"
#include "OW_EnvVars.hpp"

namespace OW_NAMESPACE
{

OW_DECLARE_APIEXCEPTION(ExecTimeout, OW_COMMON_API);
OW_DECLARE_APIEXCEPTION(ExecBufferFull, OW_COMMON_API);
OW_DECLARE_APIEXCEPTION(ExecError, OW_COMMON_API);

class PopenStreamsImpl;
class OW_COMMON_API PopenStreams
{
public:
   PopenStreams();
   ~PopenStreams();
   PopenStreams(const PopenStreams& src);
   PopenStreams& operator=(const PopenStreams& src);
   UnnamedPipeRef in() const;
   
   void in(const UnnamedPipeRef& pipe);
   UnnamedPipeRef out() const;
   void out(const UnnamedPipeRef& pipe);
   UnnamedPipeRef err() const;
   void err(const UnnamedPipeRef& pipe);

   Array<UnnamedPipeRef> extraPipes() const;

   void setExtraPipes(const Array<UnnamedPipeRef>& pipes);

   ProcId pid() const;
   void pid(ProcId newPid);

   int getExitStatus(UInt32 wait_initial, UInt32 wait_close, UInt32 wait_term);

   int getExitStatus();

   void setProcessStatus(int ps);
private:
   IntrusiveReference<PopenStreamsImpl> m_impl;

   friend bool operator==(const PopenStreams& x, const PopenStreams& y);
};

namespace Exec
{
   OW_COMMON_API int safeSystem(const Array<String>& command,
      const char* const envp[] = 0);

   // TODO: Add a timeout to this and rewrite the impl to use safePopen()
   OW_COMMON_API int safeSystem(const Array<String>& command,
      const EnvVars& envVars);
   
   OW_COMMON_API PopenStreams safePopen(const Array<String>& command, const char* const envp[] = 0);

   OW_COMMON_API PopenStreams safePopen(const Array<String>& command, const EnvVars& envVars);

   // TODO: Create a version of safePopen that allows the caller to specify the number of extra pipes to be opened.

   OW_COMMON_API PopenStreams safePopen(const Array<String>& command,
         const String& initialInput) OW_DEPRECATED;

   const int INFINITE_TIMEOUT = -1;

   OW_COMMON_API void gatherOutput(String& output, PopenStreams& streams, int& processstatus, int timeoutsecs = INFINITE_TIMEOUT, int outputlimit = -1);
   
   enum EOutputSource
   {
      E_STDOUT,
      E_STDERR
   };

   class OutputCallback
   {
   public:
      virtual ~OutputCallback();
      void handleData(const char* data, size_t dataLen, EOutputSource outputSource, PopenStreams& theStream, size_t streamIndex, Array<char>& inputBuffer);
   private:
      virtual void doHandleData(const char* data, size_t dataLen, EOutputSource outputSource, PopenStreams& theStream, size_t streamIndex, Array<char>& inputBuffer) = 0;
   };

   class InputCallback
   {
   public:
      virtual ~InputCallback();
      void getData(Array<char>& inputBuffer, PopenStreams& theStream, size_t streamIndex);
   private:
      virtual void doGetData(Array<char>& inputBuffer, PopenStreams& theStream, size_t streamIndex) = 0;
   };

   enum EProcessRunning
   {
      E_PROCESS_RUNNING,
      E_PROCESS_EXITED
   };

   // class invariant: if m_running == E_PROCESS_RUNNING, then m_status == 0.
   class ProcessStatus
   {
   public:
      ProcessStatus()
      : m_running(E_PROCESS_RUNNING)
      , m_status(0)
      {
      }

      explicit ProcessStatus(int status)
      : m_running(E_PROCESS_EXITED)
      , m_status(status)
      {
      }

      bool hasExited() const
      {
         return m_running == E_PROCESS_EXITED;
      }

      const int& getStatus() const
      {
         return m_status;
      }
   private:
      EProcessRunning m_running;
      int m_status;
   };

   OW_COMMON_API void processInputOutput(OutputCallback& output, Array<PopenStreams>& streams, Array<ProcessStatus>& processStatuses,
      InputCallback& input, int timeoutSecs = INFINITE_TIMEOUT);
   
   OW_COMMON_API void executeProcessAndGatherOutput(
      const Array<String>& command,
      String& output, int& processstatus,
      int timeoutsecs = INFINITE_TIMEOUT, int outputlimit = -1, const String& input = String());

   OW_COMMON_API void executeProcessAndGatherOutput(
      const Array<String>& command,
      String& output, int& processstatus, const EnvVars& envVars,
      int timeoutsecs = INFINITE_TIMEOUT, int outputlimit = -1, const String& input = String());
   
   
} // end namespace Exec

} // end namespace OW_NAMESPACE

#endif

---