1. Introduction

Ce tutoriel présente la compression de fichiers avec la librairie bzip2 de Julian Seward. Les fichiers compressés avec cet algorithme portent l'extention bz2. La librairie bzip2/libbzip2 est téléchargeable ici : http://sources.redhat.com/bzip2/

2. Accès aux fichiers

Pour enregistrer ou lire un fichier compressé, il faut utiliser les fonctions bzopen() et bzclose() sur le même modèle que les fonctions standards fopen() et fclose(). Ces deux fonctions retournent un pointeur de fichier qui devra être passé en argument aux autres fonctions de traitement. Il existe deux modes d'ouverture de fichier : en lecture "r" en écriture "w".

2.1. Ouverture

Syntaxe d'ouverture de fichier :

 
Sélectionnez
  1. resource bzopen(string $filename, string $mode)  

Exemple d'ouverture de fichier en lecture :

 
Sélectionnez
  1. $bz = bzopen("archive.bz2", "r");  

La fonction bzopen() retourne un entier valant false en cas d'erreur.

2.2. Fermeture

Syntaxe de fermeture de fichier :

 
Sélectionnez
  1. int bzclose(resource $bz)  

Exemple de fermeture de fichier :

 
Sélectionnez
  1. bzclose($bz);  

La fonction bzclose() retourne un entier valant true si succès, ou false en cas d'erreur.

3. Accès aux données

Les accès au contenu des fichiers ouverts dépendent de leur mode d'ouverture. On peut lire avec bzread() un fichier ouvert en lecture, et écrire avec bzwrite() dans un fichier ouvert en écriture.

3.1. Lecture

Syntaxe de lecture :

 
Sélectionnez
  1. string bzread(resource $bz [, int $length ])  

Exemples de lecture :

 
Sélectionnez
  1. $str = bzread($bz); 
  2. $str = bzread($bz, 10);  

La fonction bzread() retourne une chaîne de caractères en décompressant à la volée le fichier spécifié. La lecture commence à la position courante et se termine après $length caractères décompressés lus, ou dès que survient une erreur, ou après 1024 caractères décompressés lus, ou en fin de fichier si celle-ci a été atteinte.

3.2. Ecriture

Syntaxe d'écriture :

 
Sélectionnez
  1. int bzwrite(resource $bz, string $str [, int $length ])  

Exemples d'écriture :

 
Sélectionnez
  1. bzwrite($bz, $str); 
  2. bzwrite($bz, $str, 10);  

La fonction bzwrite() compresse la chaîne $str à la volée et écrit le résultat dans le fichier spécifié. L'écriture débute à la position courante du fichier et s'arrête après $length caractères non compressés écrits ou dès que la fin de la chaîne $str a été atteinte.

3.3. Tampons d'écriture

Syntaxe de vidage des tampons :

 
Sélectionnez
  1. int bzflush(resource $bz)  

Exemple :

 
Sélectionnez
  1. bzflush($bz);  

La fonction bzflush() vide les tampons d'écriture sur le fichier ouvert en écriture. Comme pour la bibliothèque standard, les données ne sont pas écrites directement dans le fichier, mais par blocs. Quand un bloc en mémoire est plein, il est transféré sur le disque. Quand le fichier s'apprête à être fermé, les blocs qui restent (non pleins) sont eux aussi transférés sur disque.

3.4. Gestion des erreurs

Syntaxe d'obtention de la dernière erreur :

 
Sélectionnez
  1. array bzerror(resource $bz)  

Exemple :

 
Sélectionnez
  1. $error = bzerror($bz); 
  2. echo $error["errno"]; 
  3. echo $error["errstr"];  

La fonction bzerror() retourne un tableau associatif ayant pour clés : "errno" et "errstr" auxquelles sont associées respectivement les valeurs suivantes : le dernier code d'erreur généré par les fonctions Bz sur le fichier identifié par le pointeur $bz, et la description (en anglais) de cet code erreur.

D'autres fonctions sont disponibles : bzerrno() et bzerrstr() qui retournent respectivement le numéro et la description du dernier code d'erreur généré sur le fichier spécifié.

Syntaxes :

 
Sélectionnez
  1. int bzerrno(resource $bz) 
  2. string bzerrstr(resource $bz)  

Exemple :

 
Sélectionnez
  1. echo "Dernière erreur : ".bzerrno($bz)." : ".bzerrstr($bz);  

4. Compression à la volée

4.1. Compression

Syntaxe de compression :

 
Sélectionnez
  1. string bzcompress(string $str [, int $blocksize [, int $workfactor]])  

Exemples de compression :

 
Sélectionnez
  1. $str = bzcompress($str, 9, 100); 
  2. $str = bzcompress($str, 9); 
  3. $str = bzcompress($str);  

La fonction bzcompress compresse la chaîne $str et retourne le résultat. L'argument optionel $blocksize défini la qualité de la compression, ce doit être un nombre entier positif compris entre 1 et 9. Sa valeur par défaut est 4. Il représente la taille des blocs de données utilisés lors de la compression. L'argument $workfactor est un nombre entier compris entre 0 et 250, sa valeur par défaut est 30. Il permet d'orienter le comportement de l'algorithme de compression dans le cas où la chaîne à compresser comporte des motifs exagérément répétés.

4.2. Décompression

Syntaxe de décompression :

 
Sélectionnez
  1. string bzdecompress(string $str [, int $small])  

Exemples de décompression :

 
Sélectionnez
  1. $str = bzdecompress($str, true); 
  2. $str = bzdecompress($str);  

La fonction bzdecompress décompresse la chaîne $str et retourne le résultat. Si le paramètre optionel $small est passé à true, alors un autre algorithme moins gourmand en mémoire (mais moins rapide) sera utilisé.

5. Téléchargement de fichier compressé

Vous souhaitez permettre aux internautes de télécharger un fichier compressé. Pour cela vous disposez des deux méthodes suivantes :

5.1. Compression à la volée

En compressant à la volée le contenu d'un fichier quelconque.

 
Sélectionnez
  1. <?php 
  2.     // nom du fichier à compresser 
  3.     $filename = 'test.txt'; 
  4.     // entêtes HTTP 
  5.     header('Content-Type: application/x-bzip'); 
  6.     header('Content-Disposition: attachment; filename='.$filename); 
  7.     // extraction du contenu du fichier 
  8.     $fp = fopen ($filename, 'r'); 
  9.     $file = fread($fp, filesize($filename)); 
  10.     fclose ($fp); 
  11.     // compression et affichage 
  12.     echo bzcompress($file); 
  13. ?> 

5.2. Compression d'un fichier

En créant un nouveau fichier.

 
Sélectionnez
  1. <?php 
  2.     // nom du fichier à créer 
  3.     $filename = 'test.bz2'; 
  4.     // contenu à compresser 
  5.     $str = 'Chaîne à compresser.'; 
  6.     // entêtes HTTP 
  7.     header('Content-Type: application/x-bzip'); 
  8.     // force le téléchargement 
  9.     header('Content-Disposition: attachment; filename='.$filename); 
  10.     // création du fichier 
  11.     $bz = bzopen($filename, "w"); 
  12.     // écriture 
  13.     bzwrite($bz, $str); 
  14.     // fermeture 
  15.     bzclose($bz); 
  16.     // affichage du contenu compressé du fichier 
  17.     readfile($filename); 
  18. ?> 

Je remercie Le vieux pour la relecture et ses suggestions de corrections orthographiques.