Process.hpp

/*
 * Process.hpp
 *
 * Copyright (C) 2020 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
 * with RStudio, then this program is licensed to you under the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
 
#ifndef LAUNCHER_PLUGINS_PROCESS_HPP
#define LAUNCHER_PLUGINS_PROCESS_HPP
 
#include <Noncopyable.hpp>
 
#include <functional>
#include <string>
#include <vector>
 
#include <api/Job.hpp>
#include <system/FilePath.hpp>
#include <system/DateTime.hpp>
#include <system/User.hpp>
 
namespace rstudio {
namespace launcher_plugins {
 
class Error;
 
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
namespace process {
 
typedef std::function<void(const Error&)> OnErrorCallback;
typedef std::function<void(int)> OnExitCallback;
typedef std::function<void(const std::string&)> OnOutputCallback;
 
struct ProcessInfo
{
   ProcessInfo();
 
   static Error getProcessInfo(pid_t in_pid, ProcessInfo& out_info);
 
   std::vector<std::string> Arguments;
 
   std::string Executable;
 
   User Owner;
 
   pid_t PGrp;
 
   pid_t Pid;
 
   pid_t PPid;
 
   std::string State;
};
 
struct ProcessResult
{
   ProcessResult() : ExitCode(0) {};
 
   int ExitCode;
 
   std::string StdError;
 
   std::string StdOut;
};
 
struct AsyncProcessCallbacks
{
   OnErrorCallback OnError;
 
   OnExitCallback OnExit;
 
   OnOutputCallback OnStandardError;
 
   OnOutputCallback OnStandardOutput;
};
 
struct ProcessOptions
{
   ProcessOptions() :
      CloseStdIn(true),
      IsShellCommand(false),
      UseSandbox(true)
   {};
 
   std::vector<std::string> Arguments;
 
   bool CloseStdIn;
 
   api::EnvironmentList Environment;
 
   std::string Executable;
 
   bool IsShellCommand;
 
   api::MountList Mounts;
 
   std::string PamProfile;
 
   std::string Password;
 
   User RunAsUser;
 
   std::string StandardInput;
 
   FilePath StandardOutputFile;
 
   FilePath StandardErrorFile;
 
   bool UseSandbox;
 
   FilePath WorkingDirectory;
};
 
class AbstractChildProcess : public Noncopyable
{
public:
   virtual ~AbstractChildProcess() = default;
 
   pid_t getPid() const;
 
   virtual Error terminate();
 
   virtual Error writeToStdin(const std::string& in_string, bool in_eof) = 0;
 
protected:
   explicit AbstractChildProcess(const ProcessOptions& in_options);
 
   Error run();
 
   // The private implementation of AbstractChildProcess.
   PRIVATE_IMPL(m_baseImpl);
};
 
class SyncChildProcess final : public AbstractChildProcess
{
public:
   explicit SyncChildProcess(const ProcessOptions& in_options);
 
   Error run(ProcessResult& out_result);
 
   Error writeToStdin(const std::string& in_string, bool in_eof) override;
};
 
class ProcessSupervisor final : public Noncopyable
{
public:
 
   static bool hasRunningChildren();
 
   static Error runAsyncProcess(
      const ProcessOptions& in_options,
      const AsyncProcessCallbacks& in_callbacks,
      std::shared_ptr<AbstractChildProcess>* out_childProcess = nullptr);
 
   static void terminateAll();
 
   static bool waitForExit(const TimeDuration& in_maxWaitTime = TimeDuration::Infinity());
 
private:
   static ProcessSupervisor& getInstance();
 
   ProcessSupervisor();
 
   // The private implementation of ProcessSupervisor.
   PRIVATE_IMPL_SHARED(m_impl);
};
 
Error getChildProcesses(pid_t in_parentPid, std::vector<ProcessInfo>& out_processes);
 
Error signalProcess(pid_t in_pid, int in_signal, bool in_processGroupOnly = true);
 
std::string shellEscape(const std::string& in_toEscape);
 
std::string shellEscape(const FilePath& in_filePath);
 
} // namespace process
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
#endif