class.commandrunner.php

Go to the documentation of this file.

<?php
/*
 * Copyright (c) 2021-2024 Bearsampp
 * License:  GNU General Public License version 3 or later; see LICENSE.txt
 * Author: Bear
 * Website: https://bearsampp.com
 * Github: https://github.com/Bearsampp
 */

class CommandRunner
{
    private static function writeLog(string $log): void
    {
        global $bearsamppRoot;
        Log::debug($log, $bearsamppRoot->getBatchLogFilePath());
    }

    public static function exec(string $executable, array $args = [], string &$stderr = ''): string|false
    {
        $cmd = escapeshellarg($executable);
        foreach ($args as $arg) {
            $cmd .= ' ' . escapeshellarg((string) $arg);
        }
 
        self::writeLog('CommandRunner::exec: ' . $cmd);
 
        $descriptorspec = [
            0 => ['pipe', 'r'],
            1 => ['pipe', 'w'],
            2 => ['pipe', 'w'],
        ];
 
        $process = @proc_open($cmd, $descriptorspec, $pipes, null, null, ['bypass_shell' => true]);
 
        if (!is_resource($process)) {
            self::writeLog('CommandRunner::exec: failed to start process: ' . $cmd);
            return false;
        }
 
        fclose($pipes[0]);
        $output = stream_get_contents($pipes[1]);
        $stderr = stream_get_contents($pipes[2]);
        fclose($pipes[1]);
        fclose($pipes[2]);
        proc_close($process);
 
        if (!empty($stderr)) {
            self::writeLog('CommandRunner::exec stderr: ' . $stderr);
        }
 
        return $output;
    }

    public static function execCombined(string $executable, array $args = []): string|false
    {
        $stderr = '';
        $output = self::exec($executable, $args, $stderr);
 
        if ($output === false) {
            return false;
        }
 
        if (!empty($stderr)) {
            $output .= "\n" . $stderr;
        }
 
        return $output;
    }

    public static function stream(string $executable, array $args, callable $lineCallback): int|false
    {
        $cmd = escapeshellarg($executable);
        foreach ($args as $arg) {
            $cmd .= ' ' . escapeshellarg((string) $arg);
        }
 
        self::writeLog('CommandRunner::stream: ' . $cmd);
 
        $process = popen($cmd, 'rb');
        if (!$process) {
            self::writeLog('CommandRunner::stream: failed to start process: ' . $cmd);
            return false;
        }
 
        $buffer = '';
        while (!feof($process)) {
            $buffer .= fread($process, 8192);
            while (($pos = strpos($buffer, "\r")) !== false) {
                $line   = trim(substr($buffer, 0, $pos));
                $buffer = substr($buffer, $pos + 1);
                $lineCallback($line);
            }
        }
 
        // Flush any remaining data not terminated by \r
        if (!empty($buffer)) {
            $lineCallback(trim($buffer));
        }
 
        return pclose($process);
    }

    public static function background(string $command): void
    {
        self::writeLog('CommandRunner::background: ' . $command);
        pclose(popen('start /B ' . $command, 'r'));
    }

    public static function shellExec(string $command): ?string
    {
        self::writeLog('CommandRunner::shellExec: ' . $command);
        return shell_exec($command);
    }
}