Lorsque l'option de configuration session.upload_progress.enabled est active, PHP sera capable de traquer la progression d'un fichier en cours de téléversement (upload). Cette information n'est pas particulièrement utile pour la requête de téléversement en tant que tel, mais pendant le téléversement, une application peut envoyer une requête POST séparée (via XHR par exemple) pour vérifier le statut de ce téléversement.
La progression du téléversement sera disponible dans la variable super-globale $_SESSION lorsque le téléversement est en cours, et lors d'un envoi en méthode POST d'une variable du même nom que celui défini dans l'option de configuration INI session.upload_progress.name. Lorsque PHP détecte une requête POST de ce type, il remplira un tableau dans $_SESSION, où l'index est une valeur concaténée des options de configuration session.upload_progress.prefix et session.upload_progress.name. La clé est typiquement récupérée en lisant ces configurations INI, i.e.
<?php
$key = ini_get("session.upload_progress.prefix") . $_POST[ini_get("session.upload_progress.name")];
var_dump($_SESSION[$key]);
?>
Il est également possible d'annuler le téléversement courant
en définissant la clé $_SESSION[$key]["cancel_upload"] à la valeur
true. Lors du téléversement de plusieurs fichiers dans la même
requête, cette action n'annulera que le fichier actuellement en cours de téléchargement,
ainsi que ceux en attente de téléversement mais n'annulera pas les téléversement
terminés avec succès. Lorsqu'un téléversement est annulé en utilisant cette méthode,
la clé error du tableau $_FILES sera définie à
UPLOAD_ERR_EXTENSION.
Les options de configuration INI session.upload_progress.freq et session.upload_progress.min_freq contrôlent la fréquence de mise à jour des informations de progression de téléversement. Avec une configuration raisonnable de ces 2 options, la surcoût en terme de charge est quasi nul.
Exemple #1 Exemple
Exemple de structure du tableau contenant les informations de téléversement.
<form action="upload.php" method="POST" enctype="multipart/form-data">
<input type="hidden" name="<?php echo ini_get("session.upload_progress.name"); ?>" value="123" />
<input type="file" name="file1" />
<input type="file" name="file2" />
<input type="submit" />
</form>
Les données stockées en session ressembleront à :
<?php
$_SESSION["upload_progress_123"] = array(
"start_time" => 1234567890, // L'heure de la requête
"content_length" => 57343257, // Longueur du contenu POST
"bytes_processed" => 453489, // Quantité d'octets reçus et traités
"done" => false, // true lorsque le gestionnaire POST a terminé, avec succès ou non
"files" => array(
0 => array(
"field_name" => "file1", // Nom du champ <input/>
// Les 3 éléments suivants sont équivalents à ceux dans $_FILES
"name" => "foo.avi",
"tmp_name" => "/tmp/phpxxxxxx",
"error" => 0,
"done" => true, // True lorsque le gestionnaire POST a terminé de gérer ce fichier
"start_time" => 1234567890, // L'heure de début de requête
"bytes_processed" => 57343250, // Quantité d'octets reçus et traités pour ce fichier
),
// Un autre fichier, en cours de téléversement, dans la même requête
1 => array(
"field_name" => "file2",
"name" => "bar.avi",
"tmp_name" => NULL,
"error" => 0,
"done" => false,
"start_time" => 1234567899,
"bytes_processed" => 54554,
),
)
);La mise en mémoire tampon de la requête du serveur web doit être désactivée pour la bonne marche de cette fonctionnalité, sinon PHP ne verra le fichier qu'une fois qu'il sera totalement téléversé. Les serveurs tel que Nginx sont connus pour mettre en mémoire tampon des grosses requêtes.
Les informations de la progression du téléversement sont écrite en session avant qu'un script soit éxécuté. Par conséquence changer le nom de session grâce à ini_set() ou session_name() donnera une session sans les informations de progression du téléversement.
Note, this feature doesn't work, when your webserver is runnig PHP via FastCGI. There will be no progress informations in the session array.
Unfortunately PHP gets the data only after the upload is completed and can't show any progress.
I hope this informations helps.ATTENTION:
Put the upload progress session name input field BEFORE your file field in the form :
<form action="upload.php" method="POST" enctype="multipart/form-data">
<input type="hidden" name="<?php echo ini_get("session.upload_progress.name"); ?>" value="123" />
<input type="file" name="file1" />
<input type="file" name="file2" />
<input type="submit" />
</form>
If you make it after your file field, you'll waste a lot of time figuring why (just like me ...)
The following form will make you crazy and waste really a lot of time:
<form action="upload.php" method="POST" enctype="multipart/form-data">
<input type="file" name="file1" />
<input type="file" name="file2" />
<input type="hidden" name="<?php echo ini_get("session.upload_progress.name"); ?>" value="123" />
<input type="submit" />
</form>
DON'T do this!While the example in the documentation is accurate, the description is a bit off. To clarify:
PHP will populate an array in the $_SESSION, where the index is a concatenated value of the session.upload_progress.prefix and the VALUE of the POSTed session.upload_progress.name variable.If you're seeing
"PHP Warning: Unknown: The session id is too long or contains illegal characters, valid characters are a-z, A-Z, 0-9 and '-,' in Unknown on line 0",
then a misplaced input could be the cause. It's worth mentioning again that the hidden element MUST be before the file elements.Note that if you run that code and you print out the content of $_SESSSION[$key] you get an empty array due that session.upload_progress.cleanup is on by default and it cleans the progress information as soon as all POST data has been read.
Set it to Off or 0 to see the content of $_SESSION[$key].it should be noted that the hidden element come before the file element otherwise you wont get any updates.dont't forget, that the session has to be initialized before the form is generated, otherwise the mentioned example above won't work.There were two gotchas that got me with implementing this.
The first - if you use session_name() to change the name of sessions, this will not work. I discovered this by looking at phpinfo() and seeing that is saw a different session name.
At least in Apache, a better way to set the session is in your apache config use
php_value session.name "your custom name"
It goes within the Directory directive, might work in .htaccess - I don't know.
-=-
Secondly - in apache, don't use mod_mpm_prefork.so
That was the problem I had, that's the default in CentOS 7.
The problem is it causes Apache to wait with any additional requests until the upload is finished.
Commenting that module out and using mod_mpm_worker.so instead fixed that problem, and the progress meter worked.Warning:
Do not change session.save_path and session.name (in your application)!
The request for upload info must by POST with same value and name of your hidden input (session.upload_progress.name).
Info:
It works under IIS /FastCGI (at PHP 5.4 and PHP 8.2, other not tested).It seems like if you send a form with the field like :
<?php echo '<input type="hidden" name="'.ini_get('session.upload_progress.name') .'" value="123" />'; ?>
without any field type "file", the server respons will be an 500 error.session.upload_progress updates completely ignore custom session handlers set via session_set_save_handler()