Geekographie Maïeulesque

Sept bonnes pratiques de développement avec SPIP

Maïeul — 2012-01-05T00:39:57Z

Je travaille en ce moment sur un squelette qui n'est pas de moi. Il semble que la personne qui l'a créé n'était pas au courant des bonnes pratiques de développement sous SPIP. Il est vrai que ces bonnes pratiques ne sont pas nécessairement accessibles aux premiers abords de la documentation webmaster de SPIP.

Voici sept règles que je juge indispensables

1. Ne pas mettre de PHP dans les squelettes

Le but de SPIP était de permettre de ne pas avoir à connaître le PHP pour concevoir un site. Tout un système spécifique a été prévu, pour faire des requêtes SQL, mais aussi des tests. C'est parfois perturbant pour les utilisateurs venant du monde PHP.

Mais pour autant, c'est une très bonne pratique de ne quasiment-jamais mettre de PHP dans un squelette. En réalité, c'est une mauvaise pratique d'en mettre.

2. Ne rien mettre dans le dossier IMG

Le dossier IMG ne doit contenir que les images et documents ajoutés par l'utilisateur depuis l'interface privé. En aucun cas il ne doit contenir des images propres aux squelettes, qui doivent se trouver dans le même dossier que les squelettes.

Choisir de mettre les images dans IMG (comme je l'ai vu dans ce squelette), c'est compliquer les réutilisations des squelettes, et mélanger les couches utilisateurs et webmestres de SPIP.

3. Utiliser `#CHEMIN`

La balise #CHEMIN est une balise indispensable de SPIP. Elle permet d'indiquer l'adresse d'un fichier sans se préoccuper du nom du dossier parent. En effet, SPIP va cherche le fichier passé en argument dans l'ordre suivant [1] :

squelettes
plugin B dépendant du plugin A
plugin A
squelettes-dist
prive
ecrire

Exemple : j'ai une image dans le dossier squelettes, je ne fais pas :

mais bien

mieux, je met mon image toto.png dans le dossier img du dossier squelettes.

Je peux alors faire :

L'avantage d'un tel système est évident : permettre d'avoir un dossier squelettes qui ne s'appelle pas squelettes, par exemple lorsqu'on utilise ma sixième recommandation : les squelettes sous forme de plugins. Mais aussi permettre à SPIP de gérer correctement les URLS arborescentes (le cas échéant).

4. Utiliser `|balise_img`

Il est recommandé lorsqu'on insère une balise de lui mettre des attributs height et with pour améliorer les performances du navigateur lors de l'affichage de la page.

On peut bien sûr indiquer cela manuellement :

Mais supposons que je réduise la taille de toto.png : je dois dans ce cas modifier les attributs height et width à chaque fois que je l'utilise.

Pour éviter cela, SPIP prévoit le filtre |balise_img qui, lorsqu'il est appliqué au chemin d'un fichier image, crée automatiquement la balise , avec la hauteur et la largeur du fichier. Ainsi, pas besoin de corriger si on réduit la taille du fichier.

Le filtre s'utilise de manière très simple :

[(#CHEMIN{toto.png}|balise_img)]

On peut même mettre en argument le contenu de l'attribut alt

[(#CHEMIN{toto.png}|balise_img{0+0})]

Voir en deuxième argument la valeur de l'attribut class :

[(#CHEMIN{toto.png}|balise_img{0+0,blague_pour_enfants})]

Ce code au final me produit :

5. Utiliser les chaînes de langues

Bien que cela puisse paraître inutile et fastidieux pour un site monolingue, utiliser les chaînes de langue est quand même utile pour trois raisons :

on ne sait jamais : si le site devient multilingue, c'est toujours cela de fait.
il est plus facile d'uniformiser les textes.
il est plus facile de corriger en cas de faute ou de changement d'avis.

6. Utiliser

C'est un principe de base de l'informatique : dès qu'une séquence d'instructions est utilisée plusieurs fois, il faut non pas la dupliquer, mais la mettre dans un morceau qu'on appelle plusieurs fois.

En SPIP ce morceau, c'est un fichier inclus.

Typiquement supposons que j'affiche sur toutes les pages de mon site les sites amis.

Au lieux de copier-coller le code suivant dans les squelettes :

   #NOM

Je le met dans un fichier sites-amis.html, situé dans un dossier inclure du dossier contenant les squelettes.

Et je met le code suivant là où je souhaite afficher les sites amis :

Cela me permet si je dois modifier les critères de cette liste de ne les modifier qu'à un endroit [2].

La logique est donc : diviser son site en briques réutilisables. Chaque brique correspondant à fichier et à un morceau logique de page. Ensuite assembler ces briques dans des fichiers plus globaux [3].

Le modèle de squelettes Z pousse à l'extrême cette logique des inclusions. Je conseille de le suivre : on gagne largement en maintenance ce qu'on perd en temps d'apprentissage initial.

Une règle importante dans les inclusions : les balises html qui s'ouvrent dans un fichier doivent se fermer dans le même fichier. Il est très mauvais d'ouvrir une balise dans un fichier puis de la fermer dans un autre : on y est perd en lisibilité du code, et donc en maintenance [4].

7. Mettre ses squelettes sous formes de plugins

Cela peut paraître un luxe ou coquetterie, mais cela facilite énormément le déploiement d'un même squelette sur plusieurs sites ou le déménagement depuis la version locale vers la version en ligne :

en indiquant les dépendances aux plugins.
en incluant le fichier mes_options.php dans le même dossier.
en permettant même le cas échéant d'ajouter automatiquement un contenu pré-défini.

Un précédent article détaille comment fabriquer ces squelettes-plugins.

Amis SPIPeurs, j'attends vos remarques et ajouts !

[1] Liste tirée du site Programmer avec SPIP.

[2] En outre, cela diminue les requêtes SQL et donc la charge du serveur SQL, mais la contrepartie est de multiplier les fichiers de caches ainsi que les inclusions PHP.

[3] Pour comprendre comment passer des paramètres lors de ces inclusions, pour par exemple connaître l'article courant, je renvoie à mon article sur la balise #ENV. Cet article devrais être mis à jour pour parler des dernières nouveautés. Mais l'essentiel est là.

[4] J'ai crû à un moment qu'une structure html était incorrecte du fait qu'un fichier avait plus de

ouvrantes que fermantes. En réalité, le dernier

manquant se trouvait ailleurs.

Archivage avec redirection

Maïeul — 2011-06-24T13:15:24Z

Sur ce site, certains articles sont considérés comme « obsolètes » parce que j'ai trouvé une meilleure méthode pour obtenir le même résultat.

Je souhaitais que google n'indexe plus ces articles, mais soit redirigé vers leurs remplaçants respectifs. En même temps, je souhaitais qu'une personne qui s'amuse à fouiller dans les archives de ce site puisse le cas échéant retrouver l'article.

Voici la manière dont j'ai procédé. Je remercie xdjuj pour m'avoir fourni l'idée de départ.

Principe

Pour arriver à mes fins, j'utilise le plugin A2A qui me permet d'indiquer quel est l'article remplaçant d'un article obsolète.

En interne, les liens vers les articles archivés portent la variable GET archive=oui. Par exemple Un index des sources primaires (1).

Si une personne arrive sur une page archivée sans passer la variable archive=oui alors elle est redirigée vers la nouvelle version, par une redirection HTTP 301 (redirection permanente).

En revanche si la variable est passée, il reste sur cette page, mais celle-ci possède une meta-donnée qui indique de ne pas l'indexer.

Ceci permet donc d'accéder aux archives du site via la navigation interne de ce site, tout en réorientant les liens externes, dont ceux des moteurs de recherches.

La méthode : la modification des liens

Il existe deux types de liens internes pointant éventuellement vers des archives : ceux générés avec #URL_ARTICLE dans un squelette et ceux générés avec des raccourcis de la forme [texte->xx] ou [texte->artxx] ou [texte->articlexx], dans le texte d'un article.

Comment faire pour ajouter des arguments à ces liens seulement si l'article de destination est un article « obsolète » ?

Dans les squelettes

Pour les liens dans les squelettes, c'est relativement simple :

[(#URL_ARTICLE|parametre_url{archive,oui})] me rajoute ma variable. Sauf que cela le fait sur tous les articles.

Il va donc falloir conditionner. Pour ce faire je crée un squelette inclure/obsolete.html. Celui-ci renvoie 1 si un article est lié à l'article passé en argument, donc si cet article est « obsolète ». Il ne renvoie rien dans le cas contraire.

Voici le code de ce squelette

Je remplace dans mes squelettes toutes les références à #URL_ARTICLE par :

[(#INCLURE{fond=inclure/obsolete}{id_article}|?{#URL_ARTICLE|parametre_url{archive,oui},#URL_ARTICLE})]

Ce qui en gros veut dire : on utilise le squelette inclure/obsolete en lui donnant l'id_article courant comme valeur. Si ce squelette retourne quelque chose, alors on renvoie #URL_ARTICLE|parametre_url{archive,oui}, sinon on renvoie simplement #URL_ARTICLE.

À noter qu'ici je filtre un squelette appelé via #INCLURE, ce que je ne peux faire avec .

Pour les raccourcis typographiques

Il faut qu'avant que SPIP interprète les raccourcis typographique, je modifie, si cela est pertinent, les formes [texte->artxx] par [texte->artxx?archive=oui]. SPIP s'occupera ensuite de la question des urls propres.

Pour faire cela, j'utilise la pipeline pre_liens, que je déclare dans mon fichier plugin.xml

 pre_liens geek_maieul.php

Sur la pipeline pre_liens, je renvoie à l'article de Marcimat.

Je la déclare dans mon fichier geek_maieul.php.

function geek_maieul_pre_liens($texte){ $match = array(); if (!preg_match("#->(?:art)?(?:article)?([0-9]+)\]#",$texte,$match)){ //trouer les liens vers les articles, sans rien derrière return $texte; } $obsolete = sql_getfetsel('id_article_lie','spip_articles_lies','id_article='.$match[1]); // y a-t-il un article lié ? if ($obsolete){ $texte = str_replace($match[1].']',$match[1].'?archive=oui]',$texte); // on } return $texte; }

Commentaires :

ligne 1 : nom de la fonction / pipeline.
ligne 2 à 5 : je teste si mon lien interne est bien un lien de type article. Si jamais ce n'est pas le cas, je ne modifie rien et renvoie le lien comme il était avant. Sinon je stocke le numéro de l'article dans le tableau $match, dans l'entrée 1. Pour ce faire, j'utilise une expression régulière.
ligne 7 : je regarde si mon article a un article lié. J'utilise pour cela la fonction de SPIP sql_getfetsel()
ligne 8 et 9 : si mon article a un article lié, je modifie le lien, en ajoutant ?archive=oui.
ligne 11 : je renvoie le tout.

Redirection

Dans mon fichier article.html, je teste si mon article a un article lié, et si c'est le cas, j'appelle filtre sur l'URL de l'article lié :


[(#URL_ARTICLE{#ID_ARTICLE_LIE}|redirect301)]

Le filtre |redirect301 est écrit par moi. C'est une fonction php relativement simple

function redirect301($url){ if (_request('archive')!='oui'){ header("Status: 301 Moved Permanently", false, 301); header("Location:$url"); exit(); }
}

Avant de faire une redirection, je vérifie que je n'ai pas la valeur archive=oui passée dans l'url [1]

Si c'est le cas, je procède à la redirection.

Méta donnée pour indiquer de ne pas indexer

Dans l'entête de mon squelette d'article, je met

[(#INCLURE{fond=inclure/obsolete}{id_article}|oui)].

Ce qui a pour conséquent de placer la balise si mon article est obsolète, afin que les moteurs de recherches ne l'indexent plus.

Il est évident que si je fais pointer l'article A vers l'article B et l'article B vers l'article A je risque d'avoir des problèmes de renvois mutuels. Mais comme je suis le seul rédacteur sur ce site, le risque est minimum.

[1] J'utilise la fonction SPIP _request().

Pourquoi ne pas mettre de PHP dans un squelette, sauf exception

Maïeul — 2010-12-10T00:16:19Z

Je tombe régulièrement sur des squelettes, faits par des gens venant du monde PHP, qui sont pleins de PHP.

Voici quelques bonnes raisons de ne pas faire cela. Et puis aussi des pistes sur comment s'en passer.

Raison 1 : On ne profite pas du cache de SPIP

SPIP dispose d'un système de cache, qui évite de refaire trop souvent des calculs, et donc accélère les pages. Les parties PHP d'un squelette SPIP ne sont pas soumis à ce système, du coup on perd un des avantages de SPIP.

Raison 2 : C'est illisible

Bien souvent, pas toujours, ces « squelettes » sont illisibles, car le code PHP n'est pas bien structuré. Ce n'est pas toujours le cas, mais très souvent. Je pense que les personnes qui utilisent cela « bidouillent » car ils n'arrivent pas à faire ce qu'ils veulent en SPIP. Bien sûr, on pourrait imaginer un squelette SPIPHP lisible, mais je n'en ai jamais vu.

Raison 3 : Ce n'est pas optimisé

Il m'est arrivé de voir des requêtes SQL directement dans un squelette SPIP ! Alors même que SPIP est un méta-langage de requêtes SQL, qui les optimise automatiquement. J'ai vu par exemple des appels via mysql_query() à des champs qui ne seront jamais utilisés dans la page. SPIP lui n'appel que les champs réellement utiles (ceux qu'on insère dans la page avec #CHAMP).

Raison 4 : On ne profite pas de la souplesse des boucles de SPIP

Les boucles de SPIP possèdent des ressources insoupçonnées : récursivité des requêtes, requêtes imbriquées. Certe il est possible de faire cela en SQL / PHP, mais pourquoi ré-inventé la roue, d'autant plus que SPIP, la lecture sera plus claire.

Raison 5 : On ne profite pas de SPIP

Et oui, SPIP c'est prévu pour pouvoir faire directement les requêtes SQL dans la « trame », dans le « moule » de l'affichage souhaité. Si on en profite pas, alors pourquoi prendre SPIP et pas un autre CMS ?

Une exception : pour gérer certains élèments de session

Toute règle à ses exceptions. C'est le cas de la présente règle. On lira un article qui explique pourquoi, pour gérer les sessions, mettre du PHP dans certains squelettes peut-être une solution.

Comment faire

Ceci n'est pas exhaustif, mais je tenterai de donner quelques indications pour les gens venant du monde PHP pour se « convertir » en SPIP.

Une requête SQL = Une Boucle SPIP. Pour ceux qui ont besoin d'une explication formaliste, grammaticale de ce qu'est une boucle SPIP : http://programmer.spip.org/-Les-boucles-
Pour modifier le résultat d'une balise SPIP = d'un champ SQL : un filtre = une fonction à définir dans mes_fonctions.php. Définition formelle d'une balise : http://programmer.spip.org/-Les-balises-, définition formelle d'un filtre : http://programmer.spip.org/-Les-filtres-de-balises-
Une variable de compteur :
- Si c'est pour compter les résultats d'une requête SQL : #COMPTEUR_BOUCLE. Ex : itération #COMPTEUR_BOUCLE
- Si la variable est plus compliquée : #SET{variable,valeur}, #GET{variable} et les filtres mathématiques : |plus, |mult etc. http://www.spip.net/fr_article901.html
- Une variable tout court : voir ci dessus.
Des tests conditionnels :
- filtres de comparaison et filtres de test : http://programmer.spip.org/Filtres-de-comparaison http://programmer.spip.org/Les-filtres-de-tests.
- Et pour conditionner en fonction du résultat de la requête SQL : la syntaxe complète des boucles : http://programmer.spip.org/Syntaxe-complete-des-boucles
- Des tableaux : la balise #ARRAY : http://www.spip.net/fr_article4009.html

Voilà, avec ça vous avez les bases pour ne plus mettre de PHP dans vos squelettes (bien sûr, il faut lire les liens ! Ceci n'est pas un tutoriel).

Si d'autres SPIPeurs voient des bonnes raisons, ne pas hésiter à les signaler.