1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
//
// Copyright (C) 2018 Kubos Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

use crate::error::ProtocolError;
use libc::pid_t;
use nix::sys::signal;
use nix::unistd::Pid;
use std::io;
use std::io::{BufRead, BufReader, BufWriter, Write};
use std::os::unix::prelude::*;
use std::process::{Child, ChildStderr, ChildStdin, ChildStdout, Command, Stdio};
use std::time::Duration;
use timeout_readwrite::{TimeoutReader, TimeoutWriter};

// Helper function for reading a line from a BufReader
fn do_read<R: BufRead>(mut reader: R) -> Result<Option<String>, ProtocolError> {
    let mut data = String::new();
    match reader.read_line(&mut data) {
        Ok(0) => Ok(None),
        Ok(_) => Ok(Some(data)),
        Err(err) => match err.kind() {
            io::ErrorKind::TimedOut => Err(ProtocolError::ReadTimeout),
            _ => Err(ProtocolError::ProcesssError {
                action: "reading".to_owned(),
                err,
            }),
        },
    }
}

/// Structure to handle lifetime and communications with child process
pub struct ProcessHandler {
    /// Handle to actual child process
    process: Child,
    /// Buffered timeout reader pointed to stdout pipe
    pub stdout_reader: Option<BufReader<TimeoutReader<ChildStdout>>>,
    /// Buffered timeout reader pointed to stderr pipe
    pub stderr_reader: Option<BufReader<TimeoutReader<ChildStderr>>>,
    /// Buffered timeout writer pointed to stdin pipe
    stdin_writer: Option<BufWriter<TimeoutWriter<ChildStdin>>>,
}

impl ProcessHandler {
    /// Spawn a process and setup handler structure
    ///
    /// # Arguments
    ///
    /// * command - Path to binary to execute
    /// * args - Optional arguments for binary
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let proc = ProcessHandler::spawn(&"/bin/bash".to_owned(), None);
    /// ```
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let proc = ProcessHandler::spawn(&"ls".to_owned(), Some(vec!["-l".to_owned()]));
    /// ```
    pub fn spawn(
        command: &str,
        args: Option<Vec<String>>,
    ) -> Result<ProcessHandler, ProtocolError> {
        let mut process = match Command::new(command.to_owned())
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
            .args(args.unwrap_or_else(|| vec![]))
            .spawn()
        {
            Ok(process) => process,
            Err(err) => {
                return Err(ProtocolError::SpawnError {
                    cmd: command.to_owned(),
                    err,
                });
            }
        };

        let stdout_reader = match process.stdout.take() {
            Some(stdout) => Some(BufReader::new(TimeoutReader::new(
                stdout,
                Duration::from_millis(5),
            ))),
            None => None,
        };

        let stderr_reader = match process.stderr.take() {
            Some(stderr) => Some(BufReader::new(TimeoutReader::new(
                stderr,
                Duration::from_millis(5),
            ))),
            None => None,
        };

        let stdin_writer = match process.stdin.take() {
            Some(stdin) => Some(BufWriter::new(TimeoutWriter::new(
                stdin,
                Duration::from_millis(5),
            ))),
            None => None,
        };

        Ok(ProcessHandler {
            process,
            stdout_reader,
            stderr_reader,
            stdin_writer,
        })
    }

    /// Attempt to read from stdout
    ///
    /// A return value of `None` indicates the stream is
    /// no longer available and likewise the process
    /// is likely no longer alive.
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let mut proc = ProcessHandler::spawn(&"ls".to_owned(), None).unwrap();
    /// match proc.read_stdout() {
    ///     Ok(Some(output)) => println!("Stdout: {}", output),
    ///     Ok(None) => println!("Stdout time out"),
    ///     Err(e) => eprintln!("Stdout err {}", e),
    /// }
    /// ```
    pub fn read_stdout(&mut self) -> Result<Option<String>, ProtocolError> {
        match self.stdout_reader {
            Some(ref mut stdout_reader) => Ok(do_read(stdout_reader)?),
            None => Ok(None),
        }
    }

    /// Attempt to read from stderr
    ///
    /// A return value of `None` indicates the stream is
    /// no longer available and likewise the process
    /// is likely no longer alive.
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let mut proc = ProcessHandler::spawn(&"ls".to_owned(), None).unwrap();
    /// match proc.read_stderr() {
    ///     Ok(Some(output)) => println!("Stderr: {}", output),
    ///     Ok(None) => println!("Stderr time out"),
    ///     Err(e) => eprintln!("Stderr err {}", e),
    /// }
    /// ```
    pub fn read_stderr(&mut self) -> Result<Option<String>, ProtocolError> {
        match self.stderr_reader {
            Some(ref mut stderr_reader) => Ok(do_read(stderr_reader)?),
            None => Ok(None),
        }
    }

    /// Attempt to write to stdin
    ///
    /// # Arguments
    ///
    /// * data - Slice of bytes to write
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let cmd = "ls\n".as_bytes();
    /// let mut proc = ProcessHandler::spawn(&"/bin/bash".to_owned(), None).unwrap();
    /// match proc.write_stdin(&cmd) {
    ///     Ok(()) => println!("Stdin write success"),
    ///     Err(e) => eprintln!("Stdin err {}", e),
    /// }
    /// ```
    pub fn write_stdin(&mut self, data: &[u8]) -> Result<(), ProtocolError> {
        match self.stdin_writer {
            Some(ref mut stdin_writer) => {
                stdin_writer
                    .write_all(data)
                    .map_err(|err| ProtocolError::ProcesssError {
                        action: "write to stdin".to_owned(),
                        err,
                    })?;
                stdin_writer
                    .flush()
                    .map_err(|err| ProtocolError::ProcesssError {
                        action: "flush stdin".to_owned(),
                        err,
                    })?;
                Ok(())
            }
            None => Ok(()),
        }
    }

    /// Close process' stdin pipe
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let mut proc = ProcessHandler::spawn(&"/bin/bash".to_owned(), None).unwrap();
    /// match proc.close_stdin() {
    ///     Ok(()) => println!("Stdin closed"),
    ///     Err(e) => eprintln!("Stdin close err {}", e),
    /// }
    /// ```
    pub fn close_stdin(&mut self) -> Result<(), ProtocolError> {
        self.stdin_writer = None;
        Ok(())
    }

    /// Retrieve ID of process
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let proc = ProcessHandler::spawn(&"/bin/bash".to_owned(), None).unwrap();
    /// let pid = proc.id();
    /// ```
    pub fn id(&self) -> u32 {
        self.process.id()
    }

    /// Check to see if a process has exited and if the exit
    /// status is available
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let mut proc = ProcessHandler::spawn(&"/bin/bash".to_owned(), None).unwrap();
    /// match proc.status() {
    ///     Ok(Some((code, signal))) => println!("Process has exited: {}, {}", code, signal),
    ///     Ok(None) => println!("Process has not exited"),
    ///     Err(e) => eprintln!("Error getting process status {}", e)
    /// }
    /// ```
    pub fn status(&mut self) -> Result<Option<(u32, u32)>, ProtocolError> {
        match self.process.try_wait() {
            Ok(Some(status)) => Ok(Some((
                status.code().unwrap_or(0) as u32,
                status.signal().unwrap_or(0) as u32,
            ))),
            Ok(None) => Ok(None),
            Err(err) => Err(ProtocolError::ProcesssError {
                action: "get exit status".to_owned(),
                err,
            }),
        }
    }

    /// Send killing signal to process
    ///
    /// # Arguments
    ///
    /// * signal - Optional signal to send to process
    ///
    /// # Examples
    ///
    /// ```
    /// use shell_protocol::*;
    ///
    /// let mut proc = ProcessHandler::spawn(&"/bin/bash".to_owned(), None).unwrap();
    /// match proc.kill(None) {
    ///     Ok(()) => println!("Process killed"),
    ///     Err(e) => eprintln!("Error killing process: {}", e),
    /// }
    /// ```
    pub fn kill(&mut self, signal: Option<u32>) -> Result<(), ProtocolError> {
        let pid = Pid::from_raw(self.process.id() as pid_t);
        let sig = signal::Signal::from_c_int(signal.unwrap_or(9) as i32)
            .unwrap_or(signal::Signal::SIGKILL);
        signal::kill(pid, sig).map_err(|err| ProtocolError::KillError { err })
    }
}