class UnixPipes in Zircon Profile 8.0

UnixPipes implementation uses unix pipes as handles.

@author Romain Neutron <[e-mail]>

@internal

Hierarchy

• class \Symfony\Component\Process\Pipes\AbstractPipes implements PipesInterface
  • class \Symfony\Component\Process\Pipes\UnixPipes

1 file declares its use of UnixPipes

Process.php in vendor/symfony/process/Process.php

File

vendor/symfony/process/Pipes/UnixPipes.php, line 23

Namespace

Symfony\Component\Process\Pipes

class UnixPipes extends AbstractPipes {

  /** @var bool */
  private $ttyMode;

  /** @var bool */
  private $ptyMode;

  /** @var bool */
  private $disableOutput;
  public function __construct($ttyMode, $ptyMode, $input, $disableOutput) {
    $this->ttyMode = (bool) $ttyMode;
    $this->ptyMode = (bool) $ptyMode;
    $this->disableOutput = (bool) $disableOutput;
    if (is_resource($input)) {
      $this->input = $input;
    }
    else {
      $this->inputBuffer = (string) $input;
    }
  }
  public function __destruct() {
    $this
      ->close();
  }

  /**
   * {@inheritdoc}
   */
  public function getDescriptors() {
    if ($this->disableOutput) {
      $nullstream = fopen('/dev/null', 'c');
      return array(
        array(
          'pipe',
          'r',
        ),
        $nullstream,
        $nullstream,
      );
    }
    if ($this->ttyMode) {
      return array(
        array(
          'file',
          '/dev/tty',
          'r',
        ),
        array(
          'file',
          '/dev/tty',
          'w',
        ),
        array(
          'file',
          '/dev/tty',
          'w',
        ),
      );
    }
    if ($this->ptyMode && Process::isPtySupported()) {
      return array(
        array(
          'pty',
        ),
        array(
          'pty',
        ),
        array(
          'pty',
        ),
      );
    }
    return array(
      array(
        'pipe',
        'r',
      ),
      array(
        'pipe',
        'w',
      ),
      // stdout
      array(
        'pipe',
        'w',
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getFiles() {
    return array();
  }

  /**
   * {@inheritdoc}
   */
  public function readAndWrite($blocking, $close = false) {

    // only stdin is left open, job has been done !
    // we can now close it
    if (1 === count($this->pipes) && array(
      0,
    ) === array_keys($this->pipes)) {
      fclose($this->pipes[0]);
      unset($this->pipes[0]);
    }
    if (empty($this->pipes)) {
      return array();
    }
    $this
      ->unblock();
    $read = array();
    if (null !== $this->input) {

      // if input is a resource, let's add it to stream_select argument to
      // fill a buffer
      $r = array_merge($this->pipes, array(
        'input' => $this->input,
      ));
    }
    else {
      $r = $this->pipes;
    }

    // discard read on stdin
    unset($r[0]);
    $w = isset($this->pipes[0]) ? array(
      $this->pipes[0],
    ) : null;
    $e = null;

    // let's have a look if something changed in streams
    if (false === ($n = @stream_select($r, $w, $e, 0, $blocking ? Process::TIMEOUT_PRECISION * 1000000.0 : 0))) {

      // if a system call has been interrupted, forget about it, let's try again
      // otherwise, an error occurred, let's reset pipes
      if (!$this
        ->hasSystemCallBeenInterrupted()) {
        $this->pipes = array();
      }
      return $read;
    }

    // nothing has changed
    if (0 === $n) {
      return $read;
    }
    foreach ($r as $pipe) {

      // prior PHP 5.4 the array passed to stream_select is modified and
      // lose key association, we have to find back the key
      $type = false !== ($found = array_search($pipe, $this->pipes)) ? $found : 'input';
      $data = '';
      while ('' !== ($dataread = (string) fread($pipe, self::CHUNK_SIZE))) {
        $data .= $dataread;
      }
      if ('' !== $data) {
        if ($type === 'input') {
          $this->inputBuffer .= $data;
        }
        else {
          $read[$type] = $data;
        }
      }
      if (false === $data || true === $close && feof($pipe) && '' === $data) {
        if ($type === 'input') {

          // no more data to read on input resource
          // use an empty buffer in the next reads
          $this->input = null;
        }
        else {
          fclose($this->pipes[$type]);
          unset($this->pipes[$type]);
        }
      }
    }
    if (null !== $w && 0 < count($w)) {
      while (strlen($this->inputBuffer)) {
        $written = fwrite($w[0], $this->inputBuffer, 2 << 18);

        // write 512k
        if ($written > 0) {
          $this->inputBuffer = (string) substr($this->inputBuffer, $written);
        }
        else {
          break;
        }
      }
    }

    // no input to read on resource, buffer is empty and stdin still open
    if ('' === $this->inputBuffer && null === $this->input && isset($this->pipes[0])) {
      fclose($this->pipes[0]);
      unset($this->pipes[0]);
    }
    return $read;
  }

  /**
   * {@inheritdoc}
   */
  public function areOpen() {
    return (bool) $this->pipes;
  }

  /**
   * Creates a new UnixPipes instance.
   *
   * @param Process         $process
   * @param string|resource $input
   *
   * @return UnixPipes
   */
  public static function create(Process $process, $input) {
    return new static($process
      ->isTty(), $process
      ->isPty(), $input, $process
      ->isOutputDisabled());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractPipes::$blocked	private	property	@var bool
AbstractPipes::$input	protected	property	@var resource|null
AbstractPipes::$inputBuffer	protected	property	@var string
AbstractPipes::$pipes	public	property	@var array
AbstractPipes::close	public	function	Closes file handles and pipes. Overrides PipesInterface::close	1
AbstractPipes::hasSystemCallBeenInterrupted	protected	function	Returns true if a system call has been interrupted.
AbstractPipes::unblock	protected	function	Unblocks streams.
PipesInterface::CHUNK_SIZE		constant
UnixPipes::$disableOutput	private	property	@var bool
UnixPipes::$ptyMode	private	property	@var bool
UnixPipes::$ttyMode	private	property	@var bool
UnixPipes::areOpen	public	function	Returns if the current state has open file handles or pipes. Overrides PipesInterface::areOpen
UnixPipes::create	public static	function	Creates a new UnixPipes instance.
UnixPipes::getDescriptors	public	function	Returns an array of descriptors for the use of proc_open. Overrides PipesInterface::getDescriptors
UnixPipes::getFiles	public	function	Returns an array of filenames indexed by their related stream in case these pipes use temporary files. Overrides PipesInterface::getFiles
UnixPipes::readAndWrite	public	function	Reads data in file handles and pipes. Overrides PipesInterface::readAndWrite
UnixPipes::__construct	public	function
UnixPipes::__destruct	public	function