SPIP et PHP le couple infernal

Transcription

1 SPIP et PHP le couple infernal signé : les apprentis sorciers PERFORMANCES, PERFORMANCE QUAND TU NOUS TIENT... par la barbichette... Au départ il y avait un site qui marchait bien. Mais on voulait du mieux; du mieux fonctionnel (tout ce qu'on ne pouvait pas faire avec SPIP, ou qu'on ne savait pas faire), du mieux plus rapide : quand on regarde les requêtes SQL dans le PHP généré par Spip (fichiers SKEL dans le répertoire CACHE), et qu'on est inquiet par la taille de sa base de données, on se dit qu'on peut faire mieux. Le fameux "mieux", "ennemi du bien"? CACHE AS CACHE CAN La fleur au fusil, on remplace toutes les boucles spip par des requêtes mysql et du code php ; on se familiarise assez vite avec la structure de la base ; ça marche. Enfin, avec un utilisateur, ça marche, même bien. Et on peut faire toute la cuisine qu'on veut; même des nouilles... Mais le site devient lent ; une course contre la montre s'engage : on remplace plus de boucle spip par du code php/mysql. Il est pas beau mon php? Le site s'effondre. Kesskisspass? Ayons la curiosité, osons nous plonger dans ce mystérieux répertoire cache. Prenons par exemple le fichier sommaire 1.d'origine avec des boucles spip ; Exemple :la colonne de droite du site (le fil d'actualité) : on ne veut lister que les 35 dernières contributions non refusées : <BOUCLE_article(ARTICLES){id_rubrique=3}{statut!="refuse"}{par id_article}{0,35}{inverse}> on voit dans CACHE un fichier SKEL_sommaire.php3 dans lequel les boucles spip sont traduites en php et requêtes mysql, par exemple : SELECT articles.id_article,articles.id_rubrique,articles.id_secteur,articles.surtitr e,articles.titre,articles.soustitre,articles.date,articles.date_redac,article s.visites,articles.popularite,articles.statut,articles.accepter_forum FROM spip_articles AS articles WHERE articles.id_secteur='3' AND articles.statut!='refuse' AND articles.date<now() AND (articles.statut='publie' OR articles.statut='prop') ORDER BY id_article

2 DESC LIMIT 0,35 qui sélectionne TOUS LES CHAMPS des articles (même si on n'a besoin que du titre) qui sont des contributions (rubrique = id_secteur = 3), qui ne sont pas refusées (statut différent de refusé)... mais plus loin Spip a ajouté de lui-même "statut=publié ou statut=proposé" (en fait, on élimine non seulement les "refusés" mais aussi les articles "en préparation" ou "à la poubelle"), dont la date n'est pas dans le futur (articles préparés à l'avance), on les trie par ordre décroissant, et on ne garde que les 35 derniers. Cela fait beaucoup de travail sur articles, alors que l'on pourrait commencer par ne prendre que les 35 derniers en s'appuyant sur id_article, qui est la clé d'indexation, en disant WHERE id_article>20965 (= ) on voit dans un des sous-répertoires de CACHE (CACHE/0 à CACHE/f) un fichier au nom du style "sommaire.34xdf56" : ce fichier contient du HTML et tout ce qui était php et mysql dans le fichier SKEL est maintenant remplacé par du texte, le contenu de la base de donnée qui a été ramené grace aux requêtes MySql et aux traitements php. Ainsi, la prochaine fois que quelqu'un consulte la même page dans le même contexte, il n'y aura qu'à envoyer ce fichier dans son navigateur; pas la peine d'ouvrir et de consulter à nouveau la base et de calculer toutes ces mises en forme. Réponse instantanée garantie (enfin presque) 2.lorsqu'on a remplacé les boucles spip par du php/mysql Exemple, une requête plus intelligente que celle ci-dessus pourrait être: SELECT id_article,titre FROM spip_articles WHERE id_article>20965 AND id_rubrique='3' AND date<now() AND (statut='publie' OR statut='prop') ORDER BY id_article DESC on voit dans CACHE un fichier quasiment tel quel, votre php/mysql original a juste été mis à l'intérieur d'une fonction "_executer". Que voit-on dans un des sous-répertoires de CACHE? Là encore une fichier au nom du style "sommaire.34xdf56", mais que contient-il : votre code php/mysql qui reste prêt à s'exécuter. A s'exécuter à chaque fois que la page est demandée... L'intérêt du CACHE devient nul : même si votre requête sql est 10 fois plus efficace, elle va s'exécuter 10 fois ou plus, alors que la requête de spip ne sera exécutée qu'une fois. Les inconnues il semble que le fichier SKEL ne soit recalculé que lorsque vous changez le fichier HTML ; rien ne se passe si vous ne changez que le fichier php3 qui l'appelle. Rien de tentant à changer quoi que ce soit dans ce fichier php3 me direz-vous, mais nous on l'a fait, en cherchant à s'en sortir avec quelques beaux "include" supplémentaires... il semble que les fichier cachés sous CACHE/0.. CACHE/f ne soient créés que lorsque le fichier php a été appelé avec un contexte (par exemple avec? id_rubrique=3). Donc si vous vous acharnez à changer sommaire.html et

3 que vous ne fassiez vos test qu'en appelant sommaire.php3 vous risquez de ne rien voir se créer dans les sous-répertoire CACHE. Par contre si vous ajoutez un contexte comme?id_rubrique=3 vous verrez se créer quelque part un fichier au nom barbare genre "sommaire-3.318ad9" et tous les fichiers qu'il appelle avec des "INCLURE" également. PLUS DE CONTEXTE Quand le php s'exécute à partir d'un fichier caché, le contexte habituel de spip n'est pas disponible : c'est à vous de gérer tout l'environnement. Notamment, on a remarqué pour vous : les belles fonctions que vous avez mises dans mes_fonctions.php3 sont inconnues au bataillon. La base peut ne pas être ouverte (c'est bien le principe avec ces fichiers cachés de ne justement pas avoir besoin d'ouvrir la base), donc vos belles requêtes mysql vont sortir en erreur. Bien sûr, comme vous êtes un bon programmeur, vous aurez testé l'erreur et envoyé un beau message d'erreur explicatif. Mais ça n'aide pas... COMMENTAIRES Quand on se lance dans des modifs comme ça, on aime bien sauvegarder ses arrières. Voici deux mauvaises façons de le faire 1 garder les boucles SPIP et les mettre entre commentaires html <!-- comme ça --> 2 - garder les boucles SPIP et les mettre entre commentaires php /* */ ou après // en effet dans ces cas là, spip continue à essayer d'interpreter ces instructions comme des boucles SPIP valides, ça marche et ça met le résultat dans les commentaires... redoutable! Donc, préférer remplacer <BOUCLE par <!--BOUCLE, ou supprimer les carrément et garder plutôt le fichier à part. JOUER SUR LE DELAI? Mettre le delai à zero ou à une valeur très faible semble être la seule solution pour que votre nouveau code php/mysql marche. Il marche en effet mais le SKEL est recalculé à chaque fois la page calculée est envoyée au navigateur et une copie est gardée en cache dans un des sous-répertoire CACHE/0... mais ce fichier ne sert à rien

4 puisqu'au prochain appel de la page un nouveau devra être créé... donc question performance on est doublement pénalisé : les accès à la base de donnée se font à chaque fois, et à chaque fois on fait des calculs inutiles de squelette et de pages cachées. SEULE VOIE DE SORTIE, MES_FONCTIONS C'est le seul endroit où l'on peut mettre du php/mysql qui pourra être calculé dans le SKEL (avec le bon contexte), et dont le résultat pourra être caché normalement selon les règles de spip. On peut même imaginer créer une boucle bidon pour forcer spip à l'exécuter : <BOUCLE_BIDON(RUBRIQUES){0,1}> [(#ID_RUBRIQUE FilActu)] </BOUCLE_RUBRIQUE> et dans mes_fonctions.php3 on aura une fonction function FilActu(idrubrique_bidon){... dans laquelle on n'est pas obligé de se servir de l'id_rubrique envoyée, et qui retournera le contenu que vous voulez calculer avec votre php et vos requêtes sql: return $retour; } Tout ce qui doit être renvoyé comme contenu et html doit être dans cette variable $retour : il faut donc commencer par un $retour=""; et remplacer tous les echo "..." par des $retour.= "..." ou bien, si vous avez intercallé du HTML, remplacer?> <DIV class="boite"><ul>... <? par $retour.="<div class='boite'><ul>..." (noter les éventuels problèmes de guillements) Si vous faites des requêtes mysql intelligentes dans votre code, n'oubliez pas de libérer la mémoire occupée par le résultat de la requête où $result est la variable retour de spip_query ref :

5 CONSEQUENCES ARCHITECTURALES Votre fichier mes_fonctions.php3 va devenir très gros, raison de plus pour bien le structurer et documenter. Par contre vous pouvez maintenant faire l'économie des nombreux fichiers que vous appeliez auparavant par des INCLURE, et les remplacer par des appels de fonction. Autre conséquence positive : vous pouvez modifier, améliorer vos fonctions et uploader un nouveau fichier mes_fonctions.php3 et cela n'oblige pas spip à recalculer les squelettes et les fichiers en cache (avantages/inconvénients...) EXCLURE <INCLURE()>? Attention cependant aux limites de cet exercice : en termes de performances, là-encore, il est peut-être préférable de garder vos fichiers à inclure car ils peuvent être "rafraîchis" en cache à des fréquences différentes. Par exemple, notre site a une colonne de gauche assez statique, sauf la partie agenda qui n'a pas vraiment besoin d'être recalculée plus fréquemment qu'une fois par heure; une colonne centrale avec des editos, environ un à deux par jour, donc à recalculer toutes les 4 heures suffit ; une colonne de droite avec un fil d'actualité, à rafraîchir toutes les 10 minutes (50 contributions en 8 heures). Gérer ces différents éléments uniquement avec des fonctions dans mes_fonctions.php3 amènerait à TOUT recalculer toutes les 10 minutes. Il vaut mieux laisser ces différents éléments dans des fichiers séparés et un "delai" approprié à chacun. Ce qu'on trouvera dans le cache sera une page type sommaire.34xdf56 où les fichiers indiqués dans le code SPIP, comme par exemple : <INCLURE(indy_coldroite.php3){id_mot}> seront traduits en php, par exemple : <?php $contexte_inclus = ''; $contexte_inclus[id_mot] = '15'; include ('indy_coldroite.php3');?> La logique de gestion de cache de Spip ira alors chercher la dernière version de indy_coldroite en cache, par exemple un fichier : indy_coldroite-15.45gj78 L'affichage du sommaire se fera donc avec les dernières versions en cache des différents éléments (agenda, navigation, editos, fil d'actu), sans qu'il soit besoin de les recalculer toutes.

6 TRUCS ET ASTUCES pour remédier à quelques limites de la programmation en SPIP Spip est super pour éviter la programmation, et il faut autant que possible rester dans ce cadre là si vous avez un site qui n'a pas un trafic important. LES MOTS-CLEFS Une de notre premières difficultés à été la gestion des pages thématiques, pour laquelle nous utilisons les mot-clefs, très pratiques dans Spip. Nous voulons utiliser les mots-clefs comme des filtres ; notre page d'accueil présente tout, quelque soient les mots-clefs attribués aux contributions. Idéalement, la page d'accueil thématique aurait le même code spip, mais n'afficherait que les contributions (agenda, editos, fil d'actu) relatives au motclef passé en paramètre. Ainsi n'afficherait que ce qui concerne l'afrique. Par exemple, il suffirait d'ajouter {id_mot} à la boucle du fil d'actualité, qui deviendrait <BOUCLE_article(ARTICLES){id_rubrique=3}{id_mot} {statut!="refuse"}{par id_article}{0,35}{inverse}> malheureusement cette boucle ne marche plus si la page d'accueil générale est appelée sans mot-clef, juste On s'en tire avec une boucle conditionnelle sur les mots clefs, mais il faut répéter le code : <B100> <BOUCLE100(MOTS){id_mot}> <BOUCLE_article_avec_mots(ARTICLES){id_rubrique=3}{id_mot} {statut!="refuse"}{par id_article}{0,35}{inverse}>...insérer le code d'affichage ici... </BOUCLE_article_avec_mots> </BOUCLE100> </B100> <BOUCLE_article_sans_mot(ARTICLES){id_rubrique=3} {statut!="refuse"}{par id_article}{0,35}{inverse}>...insérer le code d'affichage ici... </BOUCLE_article_sans_mot> <//B100> En fait on ne s'en tire pas beaucoup mieux si on met le code d'affichage de la boucle dans une fonction du fichier mes_fonctions.php3 ; il faut même jouer

7 d'une astuce pour pouvoir faire l'appel de fonction, qui ne peut s'appeler qu'à une balise Spip (ici, selon le cas, #ID_MOT si on en a un, #TOTAL_BOUCLE si on n'en a pas (et sa valeur sera donc zéro!... à tester dans la fonction indy_coldroite...) : <B102> <BOUCLE102(MOTS){id_mot}> [(#ID_MOT indy_coldroite)] </BOUCLE102> </B102> [(#TOTAL_BOUCLE indy_coldroite)] <//B102 LA SELECTION D'ARTICLES On a vu plus haut l'intérêt de limiter la boucle articles avec, par exemple, id_article> Mais comment faire si on veut passer cette valeur en paramètre? A l'expérience, on voit que certains critères de sélection de spip acceptent le passage des paramètres en url, d'autres pas. Par exemple, la boucle <BOUCLE_articles(ARTICLES){id_rubrique=3}{statut!="refuse"}{par id_article}{0,maxarticles}{inverse}> va fonctionner comme prévu si l'url contient un parametre maxarticles, par exemple : Par contre, si on veut faire une sélection sur numéro d'article, ça ne marche plus <BOUCLE_articles(ARTICLES){id_article>dernier_article} {id_rubrique=3}{statut!="refuse"}{par id_article}{inverse}> avec ne sort plus rien car cela a été traduit dans la requête mysql par :... WHERE id_article>'dernier_article'... La requête est d'ailleurs fort longue car elle teste les articles pour voir si le numéro est bien égal à la chaîne de caractères "dernier_article"! Il y a bien une astuce mais elle vous entraîne vers la programmation... attention DANGER! <BOUCLE_articles(ARTICLES){id_article>'$GLOBALS[dernier_article]'} {id_rubrique=3}{statut!="refuse"}{par id_article}{inverse}> marchera...

8 $GLOBALS peut résoudre d'autres problèmes, surtout si vous êtes, comme nous, en SPIP 1.4. Dans cette version on ne peut passer qu'un seul paramètre à une fonction dans mes_fonctions.php3. Pour reprendre le code ci-dessus, [(#ID_MOT indy_coldroite)] correspond à une fonction: function indy_coldroite ($id_mot) {...} Dans les dernières versions, il est possible de passer plusieurs paramètres. Ainsi, une syntaxe Spip comme : [(#ID_MOT indy_coldroite{id_rubrique}{dernier_article})] correspondra à une fonction : function indy_coldroite ($id_mot, $id_rubrique, $dernier_article) {...} Comment faire si on n'a pas la dernière version? Et bien on peut ici aussi utiliser $GLOBALS La fonction ci-dessus, celle avec un seul paramètre, contiendra un code comme : function indy_coldroite ($id_mot) { $id_rubrique=$globals[id_rubrique]; $dernier_article=$globals[dernier_article];...} en espérant que tout ceci, comme à nous, ne vous servira... jamais... ;-)