Compression de fichiers Gz en PHP avec Zlib

Les modes d'ouverture des fichiers sont les mêmes qu'avec la fonction standard fopen().

Ce mode peut être complété par le niveau de compression (en écriture seulement) entier compris entre 0 et 9, exemple : w5. Un autre suffixe peut être ajouté pour indiquer une heuristique pour filtrer les données : f, exemple : w5f. Le suffixe h permet de n'activer que la compression de Huffman, exemple : w5h.

Syntaxe d'ouverture de fichier :

resource gzopen(string $filename, string $mode, int $use_include_path)

Exemple d'ouverture de fichier en lecture :

$gz = gzopen("archive.gz", "r");

Si le paramètre optionnel $use_include_path est passé à 1, alors la fonction gzopen() recherchera le fichier dans le répertoire défini par la directive de configuration include_path du php.ini. La fonction gzopen() retourne un entier valant false en cas d'erreur.

Syntaxe de fermeture de fichier :

int gzclose(resource $gz)

Exemple de fermeture de fichier :

gzclose($gz);

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

III-A-1. Par bloc▲

string gzread(resource $gz, int $length)

$str = gzread($gz, 1024);

III-A-2. Par ligne▲

string gzgets(resource $gz, int $length)

III-A-3. Par ligne, sans balise▲

string gzgetss(resource $gz, int $length [, string $allowable_tags ])

III-A-4. Par caractère▲

string gzgetc(resource $gz)

III-A-5. Tout le fichier dans un tableau▲

array gzfile(string $filename [, int $use_include_path ])

$file = gzfile('archive.gz');
foreach($file as $elem) {
  $text .= trim($elem);
}

III-A-6. Tout le fichier à l'écran▲

int readgzfile(string $filename [, int $use_include_path ])

readgzfile('archive.gz');

Syntaxe d'écriture :

int gzwrite(resource $gz, string $str [, int $length ])

Exemples d'écriture :

gzwrite($gz, $str);
gzwrite($gz, $str, 1024);

La fonction gzwrite() 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.

gzputs() est un alias de gzwrite().

III-C-1. Position du pointeur▲

int gztell(resource $gz)

III-C-2. Déplacement du pointeur▲

int gzseek(resource $gz, int $offset)

III-C-3. Retour au début▲

int gzrewind(resource $gz)

III-C-4. Fin de fichier▲

int gzeof(resource $gz)

Syntaxe de compression :

string gzcompress(string $str [, int $level ])

Exemples de compression :

$str = gzcompress($str, 9);
$str = gzcompress($str);

La fonction gzcompress() compresse la chaîne $str et retourne le résultat. L'argument optionnel $level définit la qualité de la compression, ce doit être un nombre entier positif compris entre 0 (pas de compression) et 9 (compression maximale).

Syntaxe de décompression :

string gzuncompress(string $str [, int $length])

Exemples de décompression :

$str = gzuncompress($str, 100);
$str = gzuncompress($str);

La fonction gzuncompress() décompresse la chaîne $str compressée par gzcompress() et retourne le résultat. Cette fonction retourne false si la chaîne décompressée est plus de 256 fois supérieure à la chaîne compressée $str, ou de taille supérieure à $length caractères.

Syntaxe :

string gzencode(string $data [, int $level [, int $encoding_mode ] ])

Exemple :

$data = implode('', file('test.txt'));
$gzdata = gzencode($data, 9);
$fp = fopen('test.txt.gz', 'w');
fwrite($fp, $gzdata);
fclose($fp);

Retourne une chaîne résultant de la compression de $data ou false si échec. Le paramètre optionnel $level spécifie le niveau de compression (entre 0 et 9). Le paramètre optionnel $encoding_mode permet de spécifier la constante FORCE_GZIP (par défaut) ou bien FORCE_DEFLATE, cette dernière produit une chaîne compressée réduite sans la somme de contrôle finale CRC32.

Contrairement à gzcompress(), cette fonction produit tous les entêtes nécessaires à la création d'un fichier avec les fonctions standards.

Le script ci-dessous procède comme suit :

• lecture du fichier source avec les fonctions standards fopen() et fread() ;
• compression du contenu de ce fichier avec gzencode() ;
• création d'un nouveau fichier avec les fonctions standards, dont le contenu est le résultat de la compression du premier fichier ;
• affichage à l'écran du grain de la compression en valeur absolue et en valeur relative.

<?php
/******************************************
* COMPRESSION D'UN FICHIER DU SERVEUR
* 
*  - lecture des données originales
*  - compression avec gzencode()
*  - écriture des données compressées
*  - affichage du gain de la compression
* 
*        29 mai 2003, Hugo ETIEVANT
*  http://cyberzoide.developpez.com/php4/
*******************************************/

// nom et chemin du fichier à compresser
$filename = './gz.pdf';

// ouverture du fichier à compresser
if($fp = fopen($filename, "rb")) {

  // lecture du contenu
  $size1 = filesize($filename);
  $data = fread($fp, $size1);
  // fermeture
  fclose($fp);
  
  // compression des données
  $gzdata = gzencode($data, 9);
  
  // ouverture et création du fichier compressé
  if($fp = fopen($filename.'.gz', 'wb')) {

    // écriture des données compressées
    fwrite($fp, $gzdata);
    // fermeture
    fclose($fp);
    
    // calcul gain de la compression
    $size2 = filesize($filename.'.gz');
    $diff = $size1-$size2;
    $pc = round($diff/$size1*100, 2);
    echo "Gain de la compression : $diff octets soit $pc %.";

  } else {
    echo "Impossible d'ouvrir $filename.gz en écriture.";
  } 

} else {
  echo "Impossible d'ouvrir $filename en lecture.";
}

?>

Affiche ceci :

Gain de la compression : 17909 octets soit 32.63 %.

Le script ci-dessous procède comme suit :

• ouverture d'un fichier compressé avec gzopen() en mode lecture binaire (« rb ») ;
• lecture et décompression à la volée du contenu par bloc de 1024 avec gzread() tant que la fin de fichier n'est pas vérifiée (gzeof()) ;
• affichage du texte à l'écran.

<?php
/******************************************
* LECTURE D'UN FICHIER COMPRESSE
* 
*        29 mai 2003, Hugo ETIEVANT
*  http://cyberzoide.developpez.com/php4/
*******************************************/

// nom et chemin du fichier compressé
$filename = './gz.txt.gz';

// ouverture du fichier compresser à lire
if($gz = gzopen($filename, "rb")) {

  // tant qu'on n'a pas atteint la fin du fichier
  while(!gzeof($gz)) {
    // lecture et décompression à la volée
    $text.= gzread($gz, 1024);
  }
  
  // affichage du texte
  echo $text;
  
} else {
  echo "Impossible d'ouvrir $filename en lecture.";
}

?>

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