Files
postfixadmin/model/Exec.php
Kent Riboe 2c0a06f932 Add Exec class to help refactor/reduce duplication of proc_open calls, update phpunit (see note) (#1009)
* code refactoring (adds Exec class to centralise proc_open like calls). 
* bump phpunit to ^11.0, as this is the last release that supports php8.2. Note, there is not (yet?) a phpunit release for php8.2 that fixes PKSA-z3gr-8qht-p93v or PKSA-5jz8-6tcw-pbk4, so ignore them for now in composer.json
2026-04-18 10:05:35 +01:00

62 lines
1.8 KiB
PHP

<?php
class Exec
{
public readonly string $stdout;
public readonly string $stderr;
public readonly int $retval;
/**
* Run an external command via proc_open.
*
* Used for post-creation, post-deletion, post-password-change scripts etc.
* Handles process creation, optional stdin data, stdout capture, and error logging.
*
* $command can be either:
* - string: full shell command (callers should escapeshellarg() arguments and append 2>&1)
* - array: [script, arg1, arg2, ...] — PHP handles escaping, no shell involved (preferred)
*
* @param string|array $command shell command string or array of [script, arg1, arg2, ...]
* @param string|null $stdin_data optional data to write to the process stdin
* /
*/
public function __construct(string|array $command, ?string $stdin_data = null)
{
$spec = [
0 => ["pipe", "r"], // stdin
1 => ["pipe", "w"], // stdout
2 => ["pipe", "w"], // stderr
];
$proc = proc_open($command, $spec, $pipes);
$cmd_display = is_array($command) ? implode(' ', $command) : $command;
if (!$proc) {
error_log("postfixadmin: can't proc_open: $cmd_display");
throw new \RuntimeException("can't proc_open: $cmd_display");
}
if ($stdin_data !== null) {
fwrite($pipes[0], $stdin_data);
}
fclose($pipes[0]);
$this->stdout = stream_get_contents($pipes[1]);
$this->stderr = stream_get_contents($pipes[2]);
fclose($pipes[1]);
fclose($pipes[2]);
$this->retval = proc_close($proc);
}
/**
* @see __construct
*/
public static function run(string|array $command, ?string $stdin_data = null): self
{
return new self($command, $stdin_data);
}
}