The ASW - c

Une version optimisée pour PHP de JSMin

cgo2 — Wed, 28 Mar 2007 18:23:00 +0200

Les Javascripts permettent de faire tout pleins de choses sur un site web, c'est cool. Mais à force d'empiler les librairies, les frameworks et autres fonctions, on peut vite se retrouver avec deux kilo-tonnes de script, ce qui n'est ni très agréable à charger et ni très léger pour la bande passante.

Heureusement, plusieurs librairies (plus ou mois efficaces) existent et permettent de compresser les scripts. JSMin est l'une d'entre elle.

A l'origine, JSMin est un petit programme écrit en C par Douglas Crokford. Il prend un fichier Javascript et supprime tout ce qui n'est strictement nécessaire, c'est-à-dire :

les commentaires (/* */ et //),
les lignes vides et retour à la ligne,
les espaces (sauf dans les chaines de caractères et les expressions régulières).

Contrairement à d'autres packer, JSMin ne brouille pas le code, c'est-à-dire que le fichier compressé reste lisible, débuggable et modifiable (même si une petite ré-indentation est nécessaire), ce qui est quand même un avantage très appréciable.

Il existe une version PHP de JSMin, mais, comme son auteur l'indique, il s'agit d'une « conversion simple et brutale du C vers le PHP », entendez par là qu'elle n'est pas du tout optimisée et donc super lente. Evidemment, la version C est théoriquement utilisable en PHP via la fonction shell_exec, mais c'est totalement impensable sur un hébergement mutualisé.

Récemment, j'ai dû mettre en place un système de compression et de concaténation des javascripts « à la volée » ; c'est-à-dire que les javascripts sont compressés la première fois qu'un utilisateur les demande, puis mis en cache (vaguement inspiré de ce post). Dès qu'un fichier est mis à jour, le cache est regénéré. Ainsi, je conserve les versions commentées et indentées pour développer, et je n'ai pas à me soucier de les compresser avant de les mettre en ligne. C'est magique.

Mais, la version originale de JSMin en PHP met parfois plus de 3 secondes à compresser certains fichiers, ce qui est bien trop long. Donc je n'ai pas pû m'empêcher de faire un tour dans le code pour l'optimiser. J'ai remplacé toutes les boucles de lecture caractère par caractère (typique du C) par des fonctions natives PHP comme strpos et strlen.

J'ai également viré toute la partie qui concernait les fichiers (dans la version originale, il est possible de passer un nom de fichier à JSMin pour qu'il le lise directement), parceque en PHP c'est beaucoup plus rapide de lire d'abord le fichier (par une fonction comme file_get_contents) et de travailler sur la chaine de caractère représentant le contenu.

Le gain en vitesse dépend fortement de la taille et du contenu du fichier ; dans mon cas c'est entre 10% et 50% plus rapide.

Utilisation

Le constructeur prend 2 paramètres : le code à compresser (string) et, si besoin, un tableau de commentaires à ajouter en début de fichier (array ou rien). Ensuite il suffit d'appeller la fonction minify().

Exemple :

$code = file_get_contents('foo.js');
$compressor = new MyJsMin($code, array('Hello', 'World'));
echo $compressor->minify();

Le fichier foo.js contient :

function foo(bar)
{
bar += 1;
alert('hello world !');
}

Le résultat sera :

// hello
// world

function foo(bar)
{bar+=1;alert('hello world !');}

Sources

Sources de MyJsMin.
Pour JSMin en PHP, voir le blog de l'auteur.
La page de la version originale de JSMin en C (avec des liens vers d'autres langages)

Test en ligne

Vous pouvez tester les performances du script grace à cette page (en anglais, parceque c'est la classe internationnale).

Mon premier programme C/PHP

cgo2 — Mon, 02 May 2005 11:16:00 +0000

Comment embarquer PHP dans un programme C de la manière la plus basique possible.

Hello world

En guise d'"Hello World", nous allons essayer d'executer la commande phpinfo().

Avant tout, il faut initialiser le module php embed. Tout ceci n'étant absolument pas documenté, je ne saurais dire à quoi correspondent les paramètres.

static char *argv[2] = {"monboprog", NULL};

if ( php_embed_init(1, argv PTSRMLS_CC) == FAILURE ) {
	puts ("Impossible d'initialiser PHP");
	return -1;
}

Maintenant on peut executer une commande. On utilise zend_eval_string qui prend comme premier paramètre la commande à executer. Je ne sais pas à quoi correspond le deuxième (je laisse NULL). Quant au dernier, apparement on peut mettre n'importe quoi... Allez comprendre !

Zend (le parseur php) fournis des macros imitant le try-catch du C++, permettant de recuperer les erreurs de php. Il n'y a donc qu'à les utiliser. Et voila ce que ça donne :

zend_first_try {                                                                                                                   
	if ( zend_eval_string("phpinfo();", NULL, "php embed roulez") == SUCCESS )
		puts("Commande executée avec succès");
	else    
		puts("Impossible d'executer la commande");
} zend_catch {
	printf ("Exception %d", EG(exit_status));
} zend_end_try();

Enfin, on arrette php avec la commande suivante :

php_embed_shutdown(TSRMLS_C);

Il ne manque plus qu'à inclure php_embed.h, et on peut essayer de le compiler. Le programme complet d'exemple est disponible par ici

Compilation

Ca c'est la partie la plus galère, surtout quand rien n'est documenté. Je tiens d'ailleurs à remercier kermit, une star du Makefile, sans qui je ne serais sans doute jamais arrivé à compiler cette saloperie de programme.

En fait, php_embed.h demande pleins d'autres fichiers d'entetes, situés un peu partout dans les sources de PHP. Il faut donc rajouter un paquet de paramètres d'inclusion à gcc. Dans un makefile, ça donne :

# chemin des sources de php
PHPPATH=/home/cgo2/documents/prog/php/php-5.0.2
PHPFLAGS=-I$(PHPPATH) -I$(PHPPATH)/Zend -I$(PHPPATH)/TSRM -I$(PHPPATH)/sapi/embed

Pour le linkage, il faut utiliser la lib que l'on a compilé :

LDFLAGS=-L$(PHPPATH)/libs
LIBS=-lphp5

Le makefile pour ce programme d'exemple n'est pas encore parfait, puisque trop de paramètres sont hardcodés, mais bon...

Execution

Premier test :

$ ./monboprog
./monboprog: error while loading shared libraries: libphp5.so: cannot open shared object file: No such file or directory

Pas grave, il suffit d'ajouter le chemin de la libs dans la variable d'environnement qui va bien :

$ export LD_LIBRARY_PATH=~/documents/prog/php/php-5.0.2/libs/

Et voila :)

Conclusion

Il reste encore beaucoup à faire pour pouvoir embarquer facilement php : faciliter la compilation et le linkage (tout le monde n'a pas les sources de php sous la main), et également l'execution. Quant au code, dans un premier temps un découpage en fonctions permettant d'eviter de manipuler Zend directement s'impose. Il faut ensuite voir comment inclure des fichiers php, exporter des fonctions C pour les utiliser dans les scripts, etc... Mais au moins avec cet exemple vous pourrez dire : "moi aussi j'ai réussi à embarquer php" !

Quelques liens

LE programme sans lequel on aurait rien reussi : le module php-irssi qui permet de script irssi avec php. Malheureusement il n'y a aucun site officiel, et le projet semble mort. On peut encore recuprer les sources sur le CVS de php
Un PDF interressant par l'auteur de php-irssi