Geekographie Maïeulesque

Gérer le statut des articles directement depuis le site public sous SPIP 3

Maïeul — 2012-08-12T19:43:32Z

J'avais publié il y a plus d'un an et demi un article sur la manière de gérer directement le statut des articles depuis le site public.

Voici son adaptation pour SPIP 3. Comme vous pourrez le voir, le code est beaucoup plus simple.

Il suffit en effet de mettre dans son squelette, dans la boucle (ARTICLES) :

[(#AUTORISER{publier,article,#ID_ARTICLE}|oui)
#FORMULAIRE_INSTITUER_OBJET{article,#ID_ARTICLE,#SELF|parametre_url{var_mode,preview}}
]

L. 1 et 3 : On vérifie que la personne connectée à bien le droit de publier l'article en question. Voir la documentation sur #AUTORISER.
L. 2 : appel du formulaire permettant de changer le statut d'un objet. Ici on précise que l'on veut pouvoir modifier le statut d'un article, dont l'identifiant est #ID_ARTICLE Le troisième argument SELF|parametre_url{var_mode,preview} sert à ne pas tomber sur une erreur 404 si on dépublie l'article : il indique qu'après l'exécution du formulaire on retourne sur la même page, en mode previsualisation [1].

[1] Attention, cela ne fonctionne pas si l'on passe le statut à « refusé » ou « à la poubelle ».

Les différents modes d'inclusion de SPIP

Maïeul — 2012-01-26T10:25:35Z

Suite à une remarque de Tetue après mon article sur les pratiques de développements avec SPIP et à une question d'un théologien sur twitter, je fais ici un point sur les deux modes d'inclusion de squelettes dans SPIP.

Rappel : principe de l'inclusion

Inclure un squelette A dans un squelette B, c'est dire à B de reprendre le contenu du squelette A à l'endroit de l'inclusion.

L'interêt d'une telle pratique est de mettre en commun des morceaux de codes utilisés par plusieurs squelettes. Le cas le plus classique étant l'affichage du menu, mais plus le temps passe, plus le devellopeur SPIP aguerri aura tendance à multiplier les inclusions, voyant qu'il utilise beaucoup de code en commun.

Le principe des squelettes Z pousse à l'extrême cette idée d'inclusion / mutualisation du code.

Mais attention : il ne faut pas croire qu'on imite ainsi un « copier-coller » de B dans A.

Ainsi si je met dans le squelette A :

XXXXXX

et dans le squelette B

YYY

Cela ne revient pas au même que mettre dans A :

XXXYYYXXX

Pourquoi ? Parce qu'il faut considérer que le contexte de chaque squelette est indépendant. Par contexte, j'entend l'ensemble des paramètres techniques qui lui sont passés, par exemple un numéro d'article. Ce contexte est récupérable via la balise #ENV et sert à l'interprétation des critères de boucles de premier niveaux. J'explique plus en détails cette notion de contexte dans un article sur contrib.

ou `#INCLURE` ?

Il existe deux modes principaux d'inclusion :

#INCLURE{fond=B}

Historiquement, le premier modèle est apparu d'abord. Quelle est la différence technique entre les deux ? Soit un squelette A appelant un squelette B.

Dans le cas d'une inclusion avec INCLURE le squelette B possède son propre cache. Lorsque le squelette A est appelé, il produit son cache à lui. Le résultat du cache de A est retourné au navigateur, et c'est à ce moment là que le cache du squelette B est inséré.
Dans le cas d'une inclusion avec #INCLURE, il n'existe pas de cache du squelette B. Le morceau de PHP / HTML lié à l'interprétation par SPIP du squelette B est mis directement dans le cache du squelette A.

Puisqu'il paraît qu'il faut mettre des schémas, voici un schéma qui tente d'expliquer cette différence [1].

ou #INCLURE ?

Inclusion statique ou inclusion dynamique ?

Conséquences techniques

Du point de vue de la taille des caches :
1. produit plus de fichiers de cache, mais moins gros.
2. #INCLURE produit des fichiers de cache plus gros, mais en moindre quantité.
Du point de vue de la durée des caches :
1. permet d'avoir un squelette fils n'ayant pas la même durée de cache que le squelette père.
2. #INCLURE ne permet pas cela, puisque le squelette fils n'a pas vraiment de cache propre.
Du point de vue des techniques SPIP applicables :
1. On peut pas filtrer le résultat d'une inclusion par [2].
2. Par contre avec #INCLURE on peut appliquer un filtre [(#INCLURE{fond=B}|filtre)].
3. Dans tout les cas on peut utiliser AJAX.
Du point de vue de la performance j'avoue ne pas trop savoir. Avoir un cache propre () permet d'avoir une vrai mutualisation des caches, dont un gain en terme de requête SQL, en revanche on a une perte de temps au moment où le cache de B est « reinjecté » dans le fichier A renvoyé à l'internaute. C'est donc au développeur de juger au cas par cas, mais il me semble que dans 90 % des cas, il vaut mieux utiliser .

Et `#MODELE`

On peut aussi utiliser #MODELE. Pour ce faire, il faut que le fichier inclu se situe dans le dossier modeles.

Techniquement, faire

#MODELE{B}

revient, à peu de chose près, à la même chose que faire #INCLURE{fond=modeles/B}. Une différence toutefois : dans le cas de #MODELE l'identifiant de l'objet courant est automatiquement passé en paramètre.

Exemple, j'ai un squelette modeles/B.html :

 #ID_ARTICLE #TITRE

Dans mon squelette A, je cherche à appeler ce squelette pour tout les articles d'une rubrique.

Je peux faire soit :

 #MODELE{B}

soit :

 #INCLURE{fond=modeles/B,id_article}

Personnellement je n'aime pas trop #MODELE, je trouve qu'il induit une confusion. Le seul cas où l'emploi de modèle est justifiable, c'est lorsque l'on souhaite permettre à un auteur d'inclure un tel morceau dans son article, en utilisant :

Par exemple le plugin Gravatar propose un modèle gravatar, que l'on peut appeler :

soit dans un squelette #MODELE{gravatar}{id_auteur}.
soit dans un article .

On consultera la documentation sur les modèles pour plus de détails.

Pour aider à y voir plus clair dans les différents squelettes inclus, on utilisera la fonction var_mode=inclure.

[1] Toute suggestion d'amélioration est la bienvenue.

[2] Une solution pour contourner ce problème est de mettre #FILTRE{nom du filtre} dans le squelette inclus.

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.

Notifications sur un forum plat

Maïeul — 2010-12-17T10:17:40Z

Sur ce site j'utilise le plugin Notifications, pour que les personnes reçoivent les réponses à leurs réactions.

J'ai coché dans la configuration « Fil de discussion : les participants au même fil de discussion reçoivent les notifications des forums (publics). ». Mais les personnes ne recevaient pas les notifications. Voilà comment j'ai résolu le problème.

Le problème, c'est que mes forums sont en mode {plat} [1]. Donc il n'y a pas vraiment de fil de discussion, mais seulement des messages individuels sans liens, du coup notification ne peut fonctionner.

La solution est de s'arranger pour avoir un fil de discussion unique.

Pour cela, j'appel de la manière suivante le formulaire de réaction :


#FORMULAIRE_FORUM

#FORMULAIRE_FORUM

Ainsi, le message est systématiquement posté en réaction au dernier message, et s'il n'y a pas de message, il est posté directement en réaction à l'article, et un fil de discussion est ouvert.

[1] En fait j'utilise le plugin de Romy : Comments, qui met ce mode {plat}

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.