proc_open

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

proc_open — Exécute une commande et ouvre les pointeurs de fichiers pour les entrées / sorties

Description

proc_open(
    array|string $command,
    array $descriptor_spec,
    array &$pipes,
    ?string $cwd = null,
    ?array $env_vars = null,
    ?array $options = null
): resource|false

proc_open() est similaire à popen() mais fournit un plus grand degré de contrôle sur l'exécution du programme.

Liste de paramètres

command

La commande à exécuter en tant que chaîne de caractères. Les caractères spéciaux doivent être échappés correctement, et une application correcte des guillemets doit être appliquée.

Note: Sur Windows, sauf si bypass_shell est définie à true dans options, command est passé à cmd.exe (en fait, %ComSpec%) avec le drapeau /c comme une chaîne de caractères sans guillemets (c.à.d. exactement comment elle a été fournie à proc_open()). Ceci peut causer cmd.exe à supprimer les guillemets entourant command (pour plus de détails voir la documentation de cmd.exe), ce qui peut engendrer un comportement inattendu, et potentiellement dangereux, car les messages d'erreurs de cmd.exe peuvent contenir (une partie de) la command passée (voir exemple ci-dessous).

À partir de PHP 7.4.0, command peut être passé comme un tableau de paramètres de commandes. Dans ce cas le processus sera ouvert directement (sans passer à travers un shell) et PHP se chargera d'échapper les arguments nécessaires.

Note:

Sur Windows, l'échappement des arguments des éléments du tableau assume que le traitement de la ligne de commande de la commande exécutée est compatible avec le traitement d'arguments de ligne de commande fait par le runtime VC.

descriptor_spec

Un tableau indexé, dont les clés représentent le numéro de descripteur et la valeur la méthode avec laquelle PHP va passer ce descripteur au processus fils. 0 est stdin, 1 est stdout, et 2 est stderr.

Chaque élément peut être :

  • Un tableau décrivant le pipe à passer au processus. Le premier élément est le type du descripteur et le second est une option pour le type donné. Les types valides sont pipe (le second élément est soit r pour passer la fin de lecture du pipe au processus, ou w pour passer la fin d'écriture) et file (le second élément est le nom de fichier). À noter que tout autre élément différent de w est traité comme r.
  • Une ressource de flux représentant un descripteur de fichier (e.g. un fichier ouvert, un socket, ou bien STDIN).

Les numéros de pointeurs de fichiers ne sont pas limités à 0, 1 et 2 - il est possible de spécifier n'importe quel numéro de descripteur valide, et il sera passé au processus fils. Cela permettra au script d'interopérer avec d'autres scripts, et d'être exécuté comme "co-processus". En particulier, c'est très pratique pour passer des mots de passe à des programmes comme PGP, GPG et openssl, avec une méthode très protégée. C'est aussi pratique pour lire des informations de statut fournies par ces programmes, sur des descripteurs auxiliaires.

pipes

Doit être défini en un tableau indexé de pointeurs de fichiers qui correspondent à la fin de n'importe quel descripteur PHP qui sont créés.

cwd

Le dossier initial de travail de la commande. Cela doit être un chemin absolu vers le dossier ou null pour utiliser la valeur par défaut (le dossier de travail du processus courant PHP)

env_vars

Un tableau contenant les variables d'environnement pour la commande qui doit être exécutée, ou null pour utiliser le même environnement que le processus PHP courant

options

Permet de spécifier des options supplémentaires. Les options actuellement supportées sont :

  • suppress_errors (windows uniquement): suppression des erreurs générées par cette fonction lorsque défini à true
  • bypass_shell (windows uniquement): bypass du shell cmd.exe lorsque défini à true
  • blocking_pipes (windows uniquement): force les tubes bloquants lorsque défini à true
  • create_process_group (windows uniquement) : permet au processus enfant de gérer les évènements CTRL lorsqu'il est à true
  • create_new_console (windows uniquement) : le nouveau processus a une nouvelle console, au lieu d'hériter la console de son parent.

Valeurs de retour

Retourne une ressource représentant le processus, qui pourra être utilisé par la fonction proc_close() lorsqu'on n'en aura plus besoin. En cas d'échec, false sera retourné.

Erreurs / Exceptions

À partir de PHP 8.3.0, une exception ValueError est levée si command est un tableau sans au moins un élément non vide.

Historique

Version Description
8.3.0 Une exception ValueError sera levée si command est un tableau sans au moins un élément non vide.
7.4.4 Ajout de l'option create_new_console au paramètre options.
7.4.0 proc_open() accepte désormais un tableau pour command.
7.4.0 Ajout de l'option create_process_group au paramètre options.

Exemples

Exemple #1 Exemple avec proc_open()

<?php
$descriptorspec = array(
0 => array("pipe", "r"), // stdin est un pipe où le processus va lire
1 => array("pipe", "w"), // stdout est un pipe où le processus va écrire
2 => array("file", "/tmp/error-output.txt", "a") // stderr est un fichier
);

$cwd = '/tmp';
$env = array('quelques_options' => 'aeiou');

$process = proc_open('php', $descriptorspec, $pipes, $cwd, $env);

if (is_resource($process)) {
// $pipes ressemble à :
// 0 => fichier accessible en écriture, connecté à l'entrée standard du processus fils
// 1 => fichier accessible en lecture, connecté à la sortie standard du processus fils
// Toute erreur sera ajoutée au fichier /tmp/error-output.txt

fwrite($pipes[0], '<?php print_r($_ENV); ?>');
fclose($pipes[0]);

echo stream_get_contents($pipes[1]);
fclose($pipes[1]);

// Il est important que vous fermiez les pipes avant d'appeler
// proc_close afin d'éviter un verrouillage.
$return_value = proc_close($process);

echo "La commande a retourné $return_value\n";
}
?>

Résultat de l'exemple ci-dessus est similaire à :

Array
(
    [some_option] => aeiou
    [PWD] => /tmp
    [SHLVL] => 1
    [_] => /usr/local/bin/php
)
La commande a retourné 0

Exemple #2 Bizarrerie de proc_open() sur Windows

Bien que l'on puisse s'attendre à ce que le programme suivant recherche le fichier filename.txt pour le texte search et d'afficher les résultats, il se comporte plutôt différemment.

<?php
$descriptorspec = [STDIN, STDOUT, STDOUT];
$cmd = '"findstr" "search" "filename.txt"';
$proc = proc_open($cmd, $descriptorspec, $pipes);
proc_close($proc);
?>

L'exemple ci-dessus va afficher :

'findstr" "search" "filename.txt' is not recognized as an internal or external command,
operable program or batch file.

Pour contourner ce comportement, il est généralement suffisant d'entourer command de guillemets additionnels :

$cmd = '""findstr" "search" "filename.txt""';

Notes

Note:

Compatibilité Windows : les descripteurs au-delà de 2 (stderr) sont accessibles au processus fils, sous la forme de pointeurs hérités, mais comme l'architecture Windows n'associe pas de nombre aux descripteurs de bas niveau, le processus fils n'a, actuellement, aucun moyen d'y accéder. D'un autre côté, stdin, stdout et stderr fonctionnent comme d'habitude.

Note:

S'il n'est besoin que d'un processus unidirectionnel, popen() sera plus pratique, car plus simple à utiliser.

Voir aussi