Plein PHAR !

Plein PHAR ! Packagez vos applications avec PHAR

http://medias.mageekbox.net/conferences/openWorldForum2011

frederic.hardy@mageekbox.net | http://blog.mageekbox.net | @mageekguy
vendredi 23 septembre 2011

Préambule

http://medias.mageekbox.net/conferences/openWorldForum2011

⇢ suhosin.executor.include.whitelist="phar"
⇢ php openWorldForum.src.phar -e

Plein PHAR ! | Open World Forum | Paris | 23 novembre 2011

À propos

⇢ Développeur PHP depuis 12 ans
⇢ Agiliste
⇢ Architecte logiciel
⇢ Contributeur à divers projet open-source
⇢ atoum
⇢ PHP, VIM, FreeBSD


Plan

⇢ Feux de position
⇢ Feux de croisement
⇢ Feux de route


Feux de position

⇢ Présentation
⇢ Historique
⇢ Installation


Présentation


Définition

⇢ PHAR = PHP Archive
⇢ PHAR ≃ JAR


Objectifs

⇢ Un ﬁchier unique
⇢ pour la distribution
⇢ pour l'exécution


Fonctionnalités

⇢ Signature
⇢ Métadonnées
⇢ Compression
⇢ Exécutable ou non


Historique


Origine

⇢ 2007 : Extension PECL
⇢ Steph Fox (php|architect)
⇢ Greg Beaver (PEAR/PECL)
⇢ Marcus Börger (PHP 5)


Aujourd'hui
⇢ 2009
⇢ Extension intégrée à PHP 5.3
⇢ 2011
⇢ Silex
⇢ Photon
⇢ atoum
⇢ Behat
⇢ …


Installation


Configuration minimum

⇢ PHP ≥ 5.2
⇢ Standard PHP Library
⇢ Compression
⇢ extensions zlib|bzip2
⇢ Signature sécurisée
⇢ extension openssl


Compilation et configuration

⇢ Lors du ./configure
⇢ Ne pas utiliser --disable-phar
⇢ Ne pas utiliser --zend-enable-multibyte
⇢ Directives de conﬁguration
⇢ phar.readonly
⇢ phar.require_hash
⇢ phar.cache_list


Feux de croisement
⇢ Mode d'emploi
⇢ Structure
⇢ Compatibilité
⇢ Création
⇢ Utilisation
⇢ L'utilitaire phar


Mode d'emploi


Archive exécutable

⇢ lisible par PHP directement
⇢ en CLI
⇢ via HTTP
⇢ au sein d'un script


Archive non exécutable

⇢ Lisible uniquement au sein d'un script


Structure


Composition
⇢ Fichier de démarrage
⇢ Manifeste
⇢ Chemin d'accès
⇢ Permissions
⇢ Fichiers
⇢ Signature et métadonnées
⇢ Format interne PHAR | TAR | ZIP


Fichier de démarrage
⇢ Interprété lorsque l'archive est
⇢ exécutée par PHP
⇢ incluse dans un script
⇢ N'est pas interprété via phar://
⇢ Permet d'initialiser l'archive
⇢ auto-chargement de classes
⇢ conﬁguration
⇢ …


Format PHAR

⇢ Format « naturel »
⇢ Uniquement exécutable
⇢ .phar


Format TAR

⇢ Chemin des ﬁchiers ≤ 255 caractères
⇢ (.phar)?.tar


Format ZIP

⇢ Moins efﬁcace que PHAR ou TAR
⇢ (.phar)?.zip


Compatibilité


PHP

⇢ PHAR, TAR, ZIP
⇢ Dépend du ﬁchier de démarrage
⇢ Des extensions disponibles


Reste du monde
⇢ Archives au format
⇢ PHAR
⇢ illisible
⇢ ZIP
⇢ lisibles et modiﬁables
⇢ TAR
⇢ lisibles et modiﬁables


Création


Classes
⇢ phar : archives exécutables
⇢ pharData : archives non exécutable
⇢ hérite de phar
⇢ pharFileInfo : ﬁchier d'une archive
⇢ Exceptions
⇢ pharException
⇢ runtimeException
⇢ invalidArgumentException
⇢ unexpectedValueException


__DIR__ et __FILE__
⇢ Dans le fichier de démarrage
⇢ __DIR__ = répertoire de l'archive
⇢ __FILE__ = archive
⇢ En dehors
⇢ __DIR__ = répertoire du fichier
⇢ __FILE__ = fichier


Sécurité
⇢ Archive exécutable
⇢ .phar(.tar|.zip)?
⇢ Création impossible par défaut
⇢ phar.readonly=1
⇢ Solution ?
⇢ -d phar.readonly=0 en CLI
⇢ phar.readonly=0 + ini_set()


Exemple


Fichier de démarrage par défaut
⇢ TAR|ZIP
⇢ Ne fait rien
⇢ PHAR
⇢ CLI|HTTP
⇢ Support de PHAR non obligatoire
⇢ index.php obligatoire par défaut


Modifier le comportement par défaut

⇢ Utiliser un ﬁchier différent
⇢ de index.php ?
⇢ pour la CLI ?
⇢ via HTTP ?
⇢ phar::setDefaultStub()


Fichier de démarrage « home made »

⇢ Doit
⇢ contenir du code valide
⇢ se terminer par __HALT_COMPILER
()
⇢ ?> non obligatoire
⇢ ;S*?>


Méthodes dédiées

⇢ phar::mapPhar()|phar::webPhar()
⇢ performance|aliasing
⇢ phar::mungServer()
⇢ rend invisible l'archive
⇢ phar::interceptFileFunc()
⇢ chemins de ﬁchiers relatifs re-routés


Ajouter des fichiers
⇢ interface arrayAccess
⇢ Phar::addFile()
⇢ Phar::addFromString()
⇢ Phar::addEmptyDir()
⇢ Phar::buildFromDirectory()
⇢ Phar::buildFromIterator()
⇢ SplFileInfo


Manipuler des fichiers

⇢ Modiﬁcation
⇢ Mêmes outils que pour la création
⇢ Suppression
⇢ interface arrayAccess
⇢ phar::delete()


Signature

⇢ Intégrité
⇢ MD5
⇢ SHA-1 (défault), SHA-256, SHA-512
⇢ Intégrité + sécurité
⇢ OpenSSL


Utilisation


Utilisation dans un script


Extraire des fichiers
⇢ Phar::extractTo()
⇢ tous les fichiers
⇢ un fichier spécifique
⇢ mais pas les répertoires


L'utilitaire phar

⇢ Livré en standard depuis PHP 5.3
⇢ script PHP
⇢ permet de manipuler une archive
⇢ phar help


Exemple d'utilisation


Feux de route
⇢ Métadonnées
⇢ Compression
⇢ Point de montage
⇢ Performances
⇢ Cas pratique


Métadonnées


Définition

⇢ Informations complémentaires
⇢ version, date, éditeur, documentation…
⇢ globales à l'archive
⇢ par ﬁchier
⇢ Stockées indépendamment des donnés
⇢ chaîne, entier, ﬂottant, tableau, objet


Exemple sur une archive


Exemple sur un fichier


Compression


Possibilités
⇢ PHAR | TAR
⇢ globale
⇢ PHAR | ZIP
⇢ par ﬁchier
⇢ Algorithmes
⇢ gzip
⇢ bzip2


Règles de nommage

PHAR TAR ZIP

phar::NONE .phar (.phar)?.tar (.phar)?.zip

phar::GZ .phar.gz (.phar)?.tar.gz (.phar)?.zip

phar::BZ2 .phar.bz2 (.phar)?.tar.bz2 (.phar)?.zip


Compression globale


Compression locale


Décompression

⇢ Transparente lors de l'utilisation
⇢ Peut être demandée explicitement
⇢ phar::decompress()
⇢ phar::decompressFiles()
⇢ pharFileInfo::decompress()


Points de montage


Utilité

⇢ Pouvoir accéder à des fichiers externes
⇢ journaux d'événements
⇢ fichier de configuration
⇢ …
⇢ Externe ou interne


Montage externe


Montage interne


Performances


Impact
⇢ Sans compression
⇢ Perte légère de performance
⇢ Avec compression
⇢ 10 à 15% de perte
⇢ phar.cache_list
⇢ APC
⇢ gain signiﬁcatif !


Cas réel


atoum

⇢ Framework de tests unitaires
⇢ simple, moderne et intuitif
⇢ http://github.com/mageekguy/atoum
⇢ http://downloads.atoum.org/nightly


Exemple en CLI


Exemple en PHP


Références

⇢ http://php.net/phar
⇢ http://blog.pascal-martin.fr/post/php-5.3-phar-php-archive
⇢ http://blog.mageekbox.net


Questions ?


Cette conférence est maintenant terminée, vous pouvez reprendre une activité normale !

frederic.hardy@mageekbox.net | http://blog.mageekbox.net | @mageekguy

Plein PHAR !

Recomendados

Recomendados

Más contenido relacionado

Más de Frederic Hardy

Más de Frederic Hardy (9)

Plein PHAR !