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: 

<?php

/**
 * Copyright 2017 MICRORISC s.r.o.
 * Copyright 2017 IQRF Tech s.r.o.
 *
 * 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.
 */

declare(strict_types=1);

namespace App\Model;

use Nette;
use Nette\Utils\Strings;
use Tracy\Debugger;

/**
 * Tool for executing commands.
 */
class CommandManager {

    use Nette\SmartObject;

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

    /**
     * @var array An indexed array where the key represents the descriptor number and the value represents how PHP will pass that descriptor to the child process. 0 is stdin, 1 is stdout, while 2 is stderr.
     */
    private $descriptorspec = [
        0 => ['pipe', 'r'], // stdin is a pipe that the child will read from
        1 => ['pipe', 'w'], // stdout is a pipe that the child will write to
        2 => ['pipe', 'w'] // stderr is a pipe that the child will write to
    ];

    /**
     * Constructor
     * @param bool $sudo Sudo required
     */
    public function __construct(bool $sudo) {
        $this->sudo = $sudo;
    }

    /**
     * Execute shell command and return output
     * @param string $cmd Command to execute
     * @param bool $needSudo
     * @return string Output
     */
    public function send(string $cmd, bool $needSudo = false) {
        $command = $this->sudo && $needSudo ? 'sudo ' : '';
        $command .= $cmd;
        $output['command'] = $command;
        $process = proc_open($command, $this->descriptorspec, $pipes);
        if (is_resource($process)) {
            fclose($pipes[0]);
            $output['stdout'] = stream_get_contents($pipes[1]);
            fclose($pipes[1]);
            $output['stderr'] = stream_get_contents($pipes[2]);
            fclose($pipes[2]);
            // It is important that you close any pipes before calling
            // proc_close in order to avoid a deadlock
            $output['returnValue'] = proc_close($process);
        }
        Debugger::barDump($output, 'Command manager');
        return Strings::trim($output['stdout']);
    }

    /**
     * Check the existence of a command
     * @param string $cmd Command
     * @return bool
     */
    public function commandExist(string $cmd) {
        return !empty($this->send('which ' . $cmd));
    }

}