PhpConcept
 
 

PhpZip 1.7 - Alpha
Manuel Utilisateur

 
 

Fonctionnalités - Manuel Utilisateur - Téléchargements - Nouveautés - Historique

 
 
Introduction
 
 

 

PhpZip 1.7-alpha est constitué d'une application et de plusieurs librairies de compression : PhpZipLib 1.5, PclTar 1.1 et PclZip 1.2-alpha.

Pour une présentation générale voir la description des fonctionnalités.

Vous pouvez accéder directement au manuel de la librairie PhpZipLib., à celui de PclTar et à celui de PclZip.

Attention

La documentation de la version PhpZip 1.7-alpha n'est pas encore mise à jour.
En cas d'urgence, n'hésitez pas à me contacter : vincent@phpconcept.net

 
     
 
Manuel
 
 

 

Sommaire

Introduction

L'application PhpZip se présente dans un cadre en trois parties. La première offre le menu d'appel des fonctions décrites dans ce manuel, la seconde est propre à la fonction sélectionnée et la dernière est une zone de commentaires sur les actions attendues ou le résultat de celles-ci (figure 1).

 

Créer une archive

Pour créer une archive, sélectionner dans le menu le mot "Créer" (logique non ?).

Il vous est alors demandé le type d'archive à créer, le nom de celle-ci, et dans le cas des archives au format PhpZip, si vous souhaitez indiquer un fichier d'auto-start ou non.

Dans le cas des archives GNU TAR, le nom de l'archive doit avoir l'extension ".tar", sinon celle-ci est automatiquement ajoutée. Pour les archives GNU TAR compressées l'extension doit être ".tar.gz" ou ".tgz", sinon ".tgz" est ajouté. Pour les archives au format PhpZip, l'extension est libre.

La chaîne de caractères constituant le nom de l'archive doit être valide (pas de vérification dans les versions actuelles) et aucun fichier avec le même nom ne doit exister. Il est possible de spécifier un sous-dossier relatif au dossier où se trouve l'application PhpZip (figure 2).

Créer "archive.piz" correspond à créer "./archive.piz", créer "backup/archive.piz" revient à créer l'archive dans le sous-dossier "backup" du dossier courant.
- La création d'une archive dans un sous-dossier non créé n'est pas supporté (plantage du script).
- La création d'une archive dans un dossier parent "../archive.piz", n'est pas officiellement supporté bien que semblant fonctionner.

Une fois la commande exécutée, un status indique s'il y a eu erreur ou si tout s'est déroulé correctement.

Ouvrir une archive

Pour ouvrir une archive, sélectionner dans le menu le mot "Ouvrir" (toujours logique non ?).

Une fenêtre de navigation est alors proposée pour permettre la sélection de l'archive. Cette fenêtre s'ouvre sur la position courante du script (non configurable actuellement). On peut alors naviguer dans l'arborescence jusqu'à trouver l'archive recherchée.
Le navigateur ne propose (et ne visualise) que les dossiers accessibles en lecture. Les seuls fichiers sélectionnables sont (figure 3) :

  • les archives PhpZip identifiées par leur icône ,
  • les archives GNU TAR (extension ".tar") identifiées par leur icône ,
  • les archives GNU TAR compressées (extension ".tar.gz" et ".tgz") identifiées par leur icône .

Il vous suffit de cliquer sur l'archive pour l'ouvrir.

Si la commande se déroule de façon satisfaisante, la liste du contenu de l'archive est affichée.

Ajouter un fichier ou un dossier

Pour ajouter un fichier à une archive, sélectionner dans le menu le mot "Ajouter" (vous suivez toujours ?).

Pour ajouter un fichier ou un dossier, il faut qu'une archive soit ouverte (soit parce qu'elle vient d'être créée, soit parce que vous l'avez ouverte).

Un fenêtre de navigation vous permet de sélectionner les fichiers ou les dossiers que vous voulez ajouter à l'archive. Pour cela, cocher la case se trouvant à gauche de l'icône du fichier ou du dossier. Certains fichiers de format connu ont des icônes spécifiques. Lorsqu'un dossier est sélectionné, tous les fichiers et l'arborescence correspondante sont ajoutés. Indiquez alors le mode de compression souhaité (figure 4).
Cliquez sur le bouton "Ajouter à l'archive".

L'opération peut être répétée plusieurs fois pour sélectionner des fichiers se trouvant dans des dossiers différents. Les dossiers peuvent être ouvert en cliquant sur leur nom ou l'icône.

Dans le cas d'une archive au format PhpZip il est possible de modifier le mode de compression, ajout par ajout :

  • En mode automatique, PhpZip regarde l'extension du fichier. Si celle-ci correspond à l'une de celles se trouvant sur la liste suivante : ".gif,.jpg,.piz" (non configurable actuellement) le fichier n'est pas compressé, sinon il est compressé à moins qu'il fasse moins de 20 octets.
  • En mode normal, aucun fichier n'est compressé.
  • En mode compressé, tous les fichiers sont compressés sauf ceux faisant moins de 20 octets. En effet la taille minimum d'un fichier gzip est de 20 octets, il n'est donc pas optimum de compresser les fichiers plus petits.

Extraire une archive

Pour extraire les fichiers d'une archive, sélectionner dans le menu le mot "Extraire" (Là on est plus attentif ... inquiet même ... il va écrire sur mon disque !!).

Pour extraire les fichiers d'une archive, il faut que celle-ci soit ouverte.

Le contenu de l'archive est affiché dans la fenêtre principale. Pour effectuer une extraction partielle, sélectionnez les fichiers à extraire en cochant la case se trouvant à gauche du nom de fichier. Pour effectuer une extraction complète cocher la case "Extraire toute l'archive" (figure 5).

Vous pouvez alors, de façon optionnelle, indiquer un sous-dossier comme racine de départ de l'extraction. Par défaut celle-ci se fait dans le dossier courant. Le chemin doit nécessairement être un sous-dossier du dossier courant (donc ne pas utiliser les ".." ou le signe racine '/', commencez par "./" ou directement le nom du sous-dossier).

PhpZip extrait alors les fichiers sélectionnés, fichier après fichier, en respectant leur sous-dossier d'origine lors de la compression. Eventuellement le sous-dossier d'extraction est ajouté à ce chemin d'origine.

Lors de l'extraction, PhpZip vérifie l'existence du sous-dossier du fichier à extraire. Si celui-ci est absent il le crée. Si lors de l'extraction, un fichier existe déjà avec le même nom il est automatiquement remplacé par le fichier extrait.

 

Lister une archive

Pour lister les fichiers contenus dans une archive, sélectionner dans le menu le mot "Lister".

PhpZip indique la liste des fichiers archivés, ainsi que la taille de ceux-ci, le fait qu'ils soient compressés ou non, le taux de compression et le sous-dossier dans lequel ils seront extraits (figure 6).

 

Détruire une archive

Pour détruire une archive, sélectionner dans le menu le mot "Détruire".

Pour détruire une archive, il faut d'abord que celle-ci soit ouverte. Une confirmation est demandée avant la destruction (figure 7).

 

Configuration

Ce menu permet de configurer les propriétés de l'application PhpZip (figure 8).

Les propriétés configurables sont les suivantes :

  • Langage : La langue peut être sélectionnée parmi une liste (voir chapitre sur la langue),
  • Police de caractères et couleurs : Le nom de la police de caractère peut être indiquée, ainsi que les couleurs des textes, des titres et des arrières-plans,
  • Taille des textes : Les différentes tailles de caractères des titres et des textes peut être modifiée,
  • Configuration avancée : Permet d'indiquer le chemin vers les fichiers qui seront appelés comme entête et pied de page HTML avant et après le tableau PhpZip,
  • Configuration de la trace : Permet d'allumer la fonction de trace avant une action afin de rechercher un problème. Si la trace est "pas-à-pas" des affichages apparaissent n'importe où dans l'affichage normal. Si elle est "à la fin", les lignes de trace sont mémorisées dans un tableau et affichée uniquement à la fin. Une profondeur de trace peut être indiquée par "Niveau de trace".

 

Méthode de publication des archives au format PhpZip

Dans le cas des archives PhpZip auto-extractible, finissant donc par une extension PHP (.php3 ou .php), il faut prendre certaines précaussions :

Il faut télécharger (upload) une archive PhpZip en mode (FTP) binaire afin de ne pas avoir de surprises lors de l'extraction. Pour le cas des archives non compressées, cette restriction ne s'applique (à priori) pas.

ATTENTION : pour que quelqu'un puisse télécharger depuis votre site une archive auto-extractible, celle-ci ne peut pas avoir directement l'extension .php3 (ou .php) sinon l'extraction est lancée sur votre site (!).
Le plus simple est de nommer le fichier avec l'extension .piz.auto (par exemple), l'utilisateur devra alors le télécharger sur son site, le renommer en .piz.php(3) et le tour est joué.

Le plus performant est cependant d'utiliser un petit script 'download.php'. Vous mettez l'archive 'archive.piz.php3' sur votre site dans un dossier $dir :

<?
// ----- Renvoyer le fichier source
$dir = "download_dir";
$fp = fopen($dir.$file, "r");
header("Content-disposition: filename=".$file);
header("Content-type: application/octetstream");
header("Pragma: no-cache");
header("Expires: 0");
fpassthru($fp);
?>

Faites alors un lien vers 'download.php?file=archive.piz.php3' pour le téléchargement.

Langues supportées

PhpZip supporte dynamiquement les différentes langues. Pour cela il utilise des fichiers de langues se trouvant dans le dossier 'lang'.

Pour ajouter une nouvelle langue (par exemple 'spanish'), il faut :

  • Recopier le fichier 'lang-template.inc.php3' en 'lang-spanish.inc.php3'.
  • Traduire toutes les phrases anglaises (et non françaises) dans la langue souhaitée.

Le nouveau langage est alors dynamiquement pris en compte par PhpZip.

Si vous avez changé les extensions des fichiers en .php par exemple il vous faut aussi changer ceux des fichiers de langues.

Faites profiter aux autres votre travail ! Envoyez moi tout nouveau fichier de langue que vous auriez généré.
Merci !

 

Conventions

Afin de s'y retrouver, on prendra comme convention d'appeler les archives PhpZip avec les extensions suivantes :

.piz pour les archives PhpZip classiques,
.piz.php3 (ou .piz.php) pour les archives auto-extractibles une fois installées.

Ces considérations ne sont qu'informatives.

 
 
 
 

Fonctionnalités - Manuel Utilisateur - Téléchargements - Nouveautés - Historique

 

Member login - Stats
Copyright 2003 - PhpConcept

Powered by PcWeb