PHP 6 : les fichiers

6-1 Introduction

PHP, en tant que langage serveur, peut accéder aux ressources du serveur et plus particulièrement au système de fichier du serveur. Cet accès ne se limite pas à la lecture de données contenues dans des fichiers, mais permet aussi la manipulation de fichiers et de répertoires (création, suppression, renommage...).

La manipulation, au sens strict du terme, de fichiers ne peut se faire que sur le serveur, les fichiers du client étant, par définition inaccessibles aux scripts PHP. Il existe tout de même deux exceptions à cette règle : «l’upload» de fichiers et le «download» de fichiers. Pour ces deux dernières «manipulations» on peut quand même remarquer que «l’initiative» est laissée au client, plus exactement à l’utilisateur, et non au serveur.

6-2 Manipulation de répertoires

Les répertoires sont comme des ressources qu’il faut ouvrir et dans lesquelles on se «déplace», comme dans une liste.
Les différentes fonctions "répertoire" en php :

• opendir : "ouvrir" un répertoire et permet alors de le manipuler comme une liste de fichiers.
  Son prototype : int opendir(string rep);
  Sa syntaxe : opendir('/chemin/vers/fichiers')


• chdir :changer de répertoire courant.
  Son prototype : int chdir(sting rep);
  Sa syntaxe :


• closedir : fermer le répertoire repéré par id.
  Son prototype : void closedir(int id);
  Sa syntaxe :
  NB : cette fonction ne retourne rien (type void).


• readdir : lire successivement toutes les entrées d'un répertoire
  Son prototype : string readdir(int id);
  Sa syntaxe :
  NB : la lecture d’une entrée dans un répertoire, c’est à dire du nom d’un fichier, provoque une «avancée» dans la liste des noms des fichiers, la prochaine lecture renverra le prochain fichier et ainsi de suite ! Lorsque l’on se trouve à la fin, cette fonction renvoie la chaîne vide.


• rewinddir : se repostionner au début du répertoire
  Son prototype : void rewinddir(int id);
  Sa syntaxe :


• scandir : liste les fichiers et dossiers dans un dossier
  Son prototype : void rewinddir(int id);
  Sa syntaxe :

6-3 Les fichiers

L'objectif de ce paragraphe est d'étudier comment manipuler le contenu des fichiers et aussi comment gérer la maintenance des fichiers : suppression, modification des droits (uniquement sous UNIX évidemment)...
Les différentes fonctions "fichier" en php : 2 catégories

• celles qui permettent de lire et d’écrire dans des fichiers;
• celles qui permettent de manipuler les fichiers ainsi que leurs propriétés.

6-3-1 Fonctions de lecture et d'écriture

Il est possible de sauvegarder des informations dans un fichier sur le serveur à l’aide d’un script PHP. L’accès aux fichiers peut se faire, soit par l’intermédiaire de lecture de caractères, soit par l’intermédiaire de lecture d’octets "bruts". Seule la méthode "caractères" est présentée ici.
ATTENTION :
1. une valeur numérique sauvegardée dans un fichier texte sera automatiquement convertie en la chaîne de caractères correspondante.
2. en PHP, la notion de fichier est «large» : un fichier est aussi bien un fichier du disque du serveur, qu’un URL !

• fopen : ouvrir un fichier Son prototype : int identificateur fopen(string nom_fichier,string mod);
  Sa syntaxe :
  Cette fonction renvoie un entier qui est l’identificateur du fichier auquel on souhaite accéder. Toutes les manipulations que l’on effectuera par la suite utiliseront cet identificateur de fichier. Les deux paramètres de cette fonction sont :
  • une chaîne de caractères contenant le nom du fichier à ouvrir;
  • une chaîne de caractères contenant les modes d’accès :
  • r ouverture en lecture et positionnement au début du fichier;
  • r+ ouverture en lecture, écriture et positionnement au début du fichier;
  • w ouverture en écriture et positionnement au début du fichier;
  • w+ ouverture en lecture, écriture et positionnement au début du fichier. Dans ce cas, si le fichier existe sa taille est réduite à 0, sinon le fichier est créé;
  • a ouverture en écriture et positionnement à la fin du fichier. Si le fichier n’existe pas, il est créé;
  • a+ ouverture en lecture, écriture et positionnement à la fin du fichier. Si le fichier n’existe pas, il est créé;
  
  La commande suivante permet d’ouvrir le fichier toto.txt du répertoire courant en lecture, et de récupérer l’identificateur de fichier dans la variable $fic .
  $fic = fopen("./toto.txt","r");


Même si en PHP un fichier est automatiquement fermé à la fin du script qui l'a ouvert, un fichier une fois utilisé doit être refermé.

• fclose : fermer un fichier ouvert
  Cette fonction retourne un booléen (type bool), permettant de tester la validité de l’opération réalisée.
  Son prototype : bool fclose(int id);
  L’instruction suivante permet de fermer le fichier précédemment ouvert :
  fclose($fic);

Il y a plusieurs façons de lire des caractères dans un fichier : on peut lire, en une opération de lecture, un nombre fixé de caractères, une ligne d’un fichier, la totalité du fichier. Comme dans le cas des répertoires, les fichiers sont considérés comme des listes de données. Cela implique que toute lecture provoque un déplacement de «la position courante» dans le fichier. Lors de l’ouverture, la «position courante» du fichier dépend du mode d’ouverture. Un fichier ouvert en mode lecture verra sa position courante placée au début. Cette position courante est «implicite» : c’est le système qui en gère le déplacement. Evidemment, il existe des fonctions permettant, par exemple, de se déplacer dans le fichier, notamment au début de celui-ci.

• fgetc : lire un caractère dans le fichier et avance la position courante associée du fichier.
  Son prototype : string fgetc(int id);
  Sa syntaxe :
• fgets : lire une chaîne de caractères de taille donnée dans le fichier, ou la ligne courante jusqu’à une nouvelle ligne, ou la ligne courante jusqu’à la fin du fichier.
  NB : cette fonction "avance" la «position courante» du fichier.
  Son prototype : string fgets(int id, int nbr);
  Sa syntaxe :
• file ou array file : lire la totalité d'un fichier et palcer le résultat dans un tableau
  NB : Cette fonction ne nécessite pas l'ouverture du fichier à lire.
  Son prototype : array file(string nom_fichier);
  Sa syntaxe :

NB : La lecture totale d’une ligne se fait en réalisant une lecture de 4096 caractères.
Pour manipuler des fichiers, il peut être nécessaire de savoir si l’on se trouve à la fin du fichier.

• feof : tester si l'on se trouve à la fin d’un fichier.
  Son prototype est : int feof(int id);
  Sa syntaxe :

Exemple avec l'affichage de la totalité des caractères contenus dans un fichier par les différentes fonctions présentées ci-dessus

• fputs : Ecrire dans un fichier
  Son prototype : int fputs(int id , string ch);
  Sa syntaxe :
  NB : L’entier retourné sert à indiquer si l’opération a été bien réalisée. Il n’est pas obligatoire de le récupérer et d’en tester la valeur, évidemment, si l’on ne teste pas cette valeur, il ne sera pas possible de savoir si l’opération a été correctement réalisée ou non !

Les opérations d’écriture et de lecture présentées précédemment modifiaient la position courante du fichier : en effet, suite à une lecture ou à une écriture, la position courante du fichier se trouve décalée. Il est donc nécessaire, dans certains cas, de modifier la position courante sans modifier le contenu du fichier, ou sans lire des données qui ne sont pas utiles au bon déroulement de l’application.

• ftell :connaître la position courante
  Son prototype : int ftell(int id);
  
• fseek :déplacer la position courante du fichier, sans avoir à effectuer de lecture.
  Son prototype : int fseek(int id , int pos);
  Sa syntaxe :

La valeur de retour indique si le déplacement a été bien effectué ou non. En utilisant cette fonction, on se déplace à la position précisée par position dans le fichier.
Attention on remarque que le premier caractère d’un fichier est à la position 0.
Attention les retours à la ligne sont considérés comme des caractères !
Un exemple de deplacement de la position courante

6-3-2 Manipulations de fichiers

Il existe d'autres fonctions "fichiers", qui elles, permettent de manipuler les fichiers : effacement, copie, test des droits...
Attention au système d'exploitation du serveur : tout n'est pas possible sous Windows95 ou Windows98!
De plus comme dans le cas de la création d’un fichier, il faut faire attention aux droits ainsi qu’au propriétaire ou au groupe du fichier : vous ne pouvez pas forcément changer les droits, renommer ou effacer tous les fichiers !

• chmod :change les droits d’un fichier.
  Les droits des fichiers sont donnés sous forme numérique. Cette fonction retourne 0 (false) si l’opération n’a pu être effectuée. Dans le cas contraire cette fonction renvoie 1 (true).
  Son prototype : int chmod(string nom_fichier, int mode);
  Sa syntaxe :
• copy :copie le fichier source en dest.
  Cette fonction retourne 0 (false) si l’opération n’a pu être effectuée. Dans le cas contraire cette fonction renvoie 1 (true). Son prototype : int copy(string source, string dest);
  Sa syntaxe :
• file_exists :teste l’existence d’une fichier.
  Cette fonction retourne 0 (false) si le fichier n’existe pas.Dans le cas contraire cette fonction renvoie 1 (true).
  Son prototype : int file_exists(string nom_fichier);
  Sa syntaxe :
• filesize :permet de récupérer la taille d’un fichier.
  Son prototype : int filesize(string nom_fichier);
  Sa syntaxe :
• mkdir :crée un répertoire.
  Cette fonction retourne 0 (false) si l’opération n’a pu être effectuée. Dans le cas contraire cette fonction renvoie 1 (true).
  Son prototype : int mkdir(string nom_rep, int mode);
  Sa syntaxe :
• rename :renomme un fichier.
  Cette fonction retourne 0 (false) si l’opération n’a pu être effectuée. Dans le cas contraire cette fonction renvoie 1 (true).
  Son prototype : int rename(string nom_source, string nom_dest);
  Sa syntaxe :
• rmdir :efface un répertoire.
  Cette fonction retourne 0 (false) si l’opération n’a pu être effectuée. Dans le cas contraire cette fonction renvoie 1 (true).
  Son prototype : int rmdir(string nom_rep);
  Sa syntaxe :
• touch :crée un fichier vide.
  Cette fonction retourne 0 (false) si l’opération n’a pu être effectuée. Dans le cas contraire cette fonction renvoie 1 (true).
  Son prototype : int touch(string nom_fichier);
  Sa syntaxe :
• unlink :détruit un fichier.
  La fonction unlink détruit un fichier. Cette fonction retourne 0 (false) si l’opération n’a pu être effectuée. Dans le cas contraire cette fonction renvoie 1 (true).
  Son prototype : int unlink(string nom_fic);
  Sa syntaxe :

Evidemment, il existe d'autres fonctions. Elles sont décrites sur Manuel PHP

6-4 upload de fichiers

En PHP, on peut écrire un script pour que l'internaute puisse faire un "upload" de fichier, c'est à dire le télécharger.
Attention, donner une trop grande possibilité d’upload de fichiers sur un site risque de provoquer la saturation rapide de ce dernier !
On utilise ici le protocole HTTP et non pas FTP.

6-4-1 Choix du fichier côté client

L'internaute sélectionne le fichier à télécharger à l’aide d’un formulaire. Deux types de formulaires sont possibles :

• un champ texte : l'internaute devra alors saisir le nom complet et précis du fichier avec le chemin d'accès. Un bon nombre ne ne savent pas écrire le chemin complet. Cette solution est donc à proscrire.
• un champ input dont le type est file.En voici un exemple .

Ce type de formulaire utilise un encodage "multipart/form-date", à voir dans la doc html

6-4-2 Gestion du côté serveur

Une fois le bouton submit pressé, le fichier est envoyé au serveur. Sur le serveur, Les différentes informations relatives au fichier sont contenues dans un tableau associatif nommé $_FILES . Si le nom de la variable issue du formulaire contenant le fichier est $fichier les entrées du tableau associatif sont : • $_FILES["fichier"]["name"] pour nom du fichier original sur la machine source; • $_FILES["fichier"]["type"] pour le type MIME du fichier; • $_FILES["fichier"]["size"] pour la taille en octets du fichier envoyé; • $_FILES["fichier"]["tmp_name"] pour le nom temporaire du fichier sur le serveur. • $_FILES["fichier"]["error"] qui retourne, si nécessaire le code d’erreur associé à l’opération Les codes d’erreurs associés à l’upload de fichier sont : • 0 - UPLOAD_ERR_OK aucune erreur • 1 - UPLOAD_ERR_INI_SIZE taille supérieure à celle précisée dans le fichier php.ini • 2 - UPLOAD_ERR_FORM_SIZE taille supérieure à MAX_FILE_SIZE précisée dans le formulaire html • 3 - UPLOAD_ERR_PARTIAL fichier partiellement téléchargé • 4 - UPLOAD_ERR_NO_FILE aucun fichier téléchargé • 6 - UPLOAD_ERR_NO_TMP_DIR dossier temporaire manquant • 7 - UPLOAD_ERR_CANT_WRITE échec d’écriture sur le disque On remarque que le fichier lorsqu’il «arrive» sur le serveur est «contenu» dans un fichier temporaire, il faudra copier ce fichier pour qu’il soit effectivement enregistré ! Une fois le fichier chargé sur le serveur, il est placé dans le répertoire temporaire défini par PHP. Attention le fichier temporaire est détruit dès la fin du script, il faut donc le copier en lui donnant, soit un nom particulier, soit son nom d’origine, mais dans ce cas attention aux collisions de noms ! Pour effectuer la copie du fichier temporaire, nous avons à notre disposition des fonctions spécifiques de PHP : bool move_uploaded_file ( string filename, string destination ) Afin de vérifier la validité du tranfert, une fonction est mise à notre disposition : bool is_uploaded_file ( string filename )