(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
proc_open — Выполняет команду и открывает указатель на файл для ввода или вывода
$command,$descriptor_spec,&$pipes,$cwd = null,$env_vars = null,$options = nullФункция proc_open() аналогична функции popen(), но предоставляет значительно больше контроля над выполнением программы.
commandКомандная для выполнения, указанная как строка (string). Специальные символы должны быть должным образом экранированы, и должны применяться правильные кавычки.
Замечание: В Windows, если для
bypass_shellне установлено значениеtrueвoptions,commandпередаётся в cmd.exe (точнее,%ComSpec%) с флагом/cв виде строки без кавычек (т.е. точно так, как было задано в proc_open()). Это может привести к тому, что cmd.exe удалит заключающие изcommand(подробности смотрите в документации cmd.exe), приводя к неожиданному и потенциально даже опасному поведению, потому что сообщения об ошибках cmd.exe могут содержать (частично) переданный параметрcommand(смотрите пример ниже).
Начиная с PHP 7.4.0 параметр command разрешается передавать
как массив (array) параметров команды.
Тогда функция откроет процесс напрямую (не проходя через оболочку)
и PHP позаботится об экранировании любого необходимого аргумента.
Замечание:
В ОС Windows экранирование аргумента массива (array) элементов предполагает, что синтаксический анализ выполненной команды совместим с синтаксическим анализом аргументов командной строки, выполняемых средой выполнения VC.
descriptor_specМассив, ключи которого представляют собой номер дескриптора, а значение описывает, как PHP должен передать этот дескриптор дочернему процессу. 0 — stdin, 1 — stdout и 2 — stderr.
Каждый элемент может быть:
pipe (второй элемент либо
r для передачи процессу стороны канала для
чтения, либо w для передачи стороны записи)
и file (второй элемент - имя файла).
Обратите внимание, что всё, кроме w, обрабатывается как r.
STDIN).
Номера дескрипторов не ограничены только 0, 1 и 2 - вы можете назначить любой действительный номер дескриптора и он будет передан дочернему процессу. Это позволяет скрипту взаимодействовать с другими скриптами, работающими, как параллельные процессы. В частности, таким образом можно передавать данные, требующие защиты, в программы вроде PGP, GPG и openssl более безопасно. Также это может оказаться полезным для чтения статусной информации, предоставляемой этими программами на вспомогательных файловых дескрипторах.
pipesБудет задан массивом указателей на файлы, соответствующие созданным каналам передачи данных PHP.
cwd
Рабочая директория команды. Это должен быть
абсолютный путь к директории или
null, если требуется использовать директорию по умолчанию (рабочая
директория текущего процесса PHP).
env_vars
Массив переменных окружения для запускаемой команды или null, если
требуется использовать то же самое окружение, что и у текущего PHP-процесса.
optionsПозволяет задать дополнительные настройки. На данный момент поддерживаются следующие настройки:
suppress_errors (только для Windows): при установке
в true не будут показываться ошибки, возникающие в ходе работы
функции
bypass_shell (только для Windows): при установке в
true процесс будет запущен в обход оболочки
cmd.exe
blocking_pipes (только для Windows): принудительно
блокировать поток при значении true
create_process_group (только для Windows): разрешить
дочернему процессу обрабатывать CTRL события, если установлено значение true
create_new_console (только для Windows): новый процесс использует новую консоль, а не наследует консоль своего родителя
Функция возвращает ресурс, который представляет процесс. Этот ресурс требуется освобождать
функцией proc_close() по завершении работы с ним.
Функция возвращает false, если возникла ошибка.
| Версия | Описание |
|---|---|
| 7.4.4 |
Добавлена опция create_new_console в
параметр options.
|
| 7.4.0 |
proc_open() теперь также принимает массив (array)
в command.
|
| 7.4.0 |
Добавлена опция create_process_group в
параметр options.
|
Пример #1 Пример использования proc_open()
<?php
$descriptorspec = array(
0 => array("pipe", "r"), // stdin - канал, из которого дочерний процесс будет читать
1 => array("pipe", "w"), // stdout - канал, в который дочерний процесс будет записывать
2 => array("file", "/tmp/error-output.txt", "a") // stderr - файл для записи
);
$cwd = '/tmp';
$env = array('some_option' => 'aeiou');
$process = proc_open('php', $descriptorspec, $pipes, $cwd, $env);
if (is_resource($process)) {
// $pipes теперь выглядит так:
// 0 => записывающий обработчик, подключённый к дочернему stdin
// 1 => читающий обработчик, подключённый к дочернему stdout
// Вывод сообщений об ошибках будет добавляться в /tmp/error-output.txt
fwrite($pipes[0], '<?php print_r($_ENV); ?>');
fclose($pipes[0]);
echo stream_get_contents($pipes[1]);
fclose($pipes[1]);
// Важно закрывать все каналы перед вызовом
// proc_close во избежание мёртвой блокировки
$return_value = proc_close($process);
echo "команда вернула $return_value\n";
}
?>Вывод приведённого примера будет похож на:
Array
(
[some_option] => aeiou
[PWD] => /tmp
[SHLVL] => 1
[_] => /usr/local/bin/php
)
команда вернула 0
Пример #2 proc_open() причуда в Windows
Хотя можно ожидать, что следующая программа будет искать в файле
filename.txt текст search
и выводить результаты, она ведёт себя несколько иначе.
<?php
$descriptorspec = [STDIN, STDOUT, STDOUT];
$cmd = '"findstr" "search" "filename.txt"';
$proc = proc_open($cmd, $descriptorspec, $pipes);
proc_close($proc);
?>Результат выполнения приведённого примера:
'findstr" "search" "filename.txt' не распознается как внутренняя или внешняя команда, работающая программа или пакетный файл.
Чтобы обойти это поведение, обычно достаточно передать command в дополнительных кавычках:
$cmd = '""findstr" "search" "filename.txt""';Замечание:
Совместимость с Windows: Дескрипторы дальше 2 (stderr) наследуются дочерними процессам, однако с тех пор как Windows не ассоциирует номера файловых дескрипторов с низкоуровневыми обработчиками, дочерние процессы не имеют (пока) к ним доступа. Это не относится к stdin, stdout и stderr.
Замечание:
Если нужен однонаправленный канал процесса, используйте функцию popen(), так как она значительно проще в использовании.