Carnet Wiki

CacheLab étend la balise #CACHE

Version 9 — il y a 4 mois JLuc

La balise #CACHE est étendue par CacheLab pour fournir de nouveaux services. Ces fonctionnalités peuvent être utilisées :
-  en complément aux autres fonctionnalités et API fournies par CacheLab
-  ou bien sans que les autres fonctionnalités de CacheLab soit utilisées
-  et même sans mémoization et sans cache APC activé (mais ça n’a pas été testé).

On peut donc activer CacheLab uniquement pour bénéficier des extensions de la balise #CACHE, sans que ça impacte le site par ailleurs. Les nouveaux paramètres s’ajoutent avec le fonctionnement fourni par le core et peuvent s’y combiner :

Cache de durée dynamique et contextuelle

Dans le core, la durée de cache spécifiée par #CACHE ne sert presque jamais ( sauf quand c’est , mais 0 ou quand elle n’et pas nulle , elle sert rarement le site est en lecture seule ) puisque l’ensemble de tous les caches tout est invalidé à chaque création ou modification de contenu par un internaute, avant donc l’expiration du cache.

Lorsque Cachelab a permis de supprimer toutes les invalidations globales du site et qu’il ne reste que les des invalidations voulues ciblées , alors il n’y a pas d’invalidations prématurées , et la durée indiquée pour le cache peut est réellement servir utilisée puisqu’il n’y a pas d’invalidations prématurées . La balise #CACHE se révèle alors parfois insuffisante pour coller aux besoins de certaines noisettes : lorsque la durée du cache doit varier selon les moments et le contexte.

Cela se présente par exemple lorsqu’on veut indiquer l’âge d’un article, depuis « déposé à l’instant » jusqu’à « il y a 2 ans » en passant par « Il y a 15 secondes », « il y a 2h », « hier », « la semaine dernière » ou « il y a 6 mois » etc. Lorsque l’article est tout frais, la noisette doit être très souvent mise à jour (toutes les minutes au début !), alors qu’après 3 mois, on peut se satisfaire d’une indication plus approximative : « il y a 5 mois » (la progression de la durée est visible dans le source. Bref, la durée du cache doit dépendre de l’âge et de la précision voulue. Or la balise #CACHE n’accepte que des valeurs numériques et ne permet pas de faire des calculs pour établir la durée du cache.

Pour permettre cela, CacheLab surcharge la balise #CACHE. Lorsqu’on veut spécifier une fonction de calcul de durée dynamique d’un cache pour un squelette :< code class=’spip’>#CACHEduree methode unenv</code >
 : - methode</var > aprés < var>duree</var > indique quelle méthode sera utilisée Le 1er argument est toujours indiqué pour calculer la durée assurer un fonctionnement correct du site en cas de désactivation du cache  : c’est la fonction < code class=’spip’>cachelab_duree_methode</code > qui sera appelée plugin cachelab . - le 2e argument ’duree-methode’ commence toujours par le préfixe ’duree-’ et la suite indique la méthode. C’est elle que le webmestre doit définir et coder qui est appelée pour calculer dynamiquement la durée en fonction d’une des variables d’environnement .
- unenv est le nom d’une des variables de l’environnement du cache. Souvent, ce sera un champ SQL de l’objet principal affiché par le squelette, avec un format DATE ou DATETIME. Par défaut, c’est date_creation. Cette valeur sera transmise en argument à la La fonction >. > doit être définie . _ Exemple : #CACHE{1200,duree-progapprox}">cachelab_duree_methode&lt;/code>. > doit être définie . _ Exemple : <code  class='spip'>#CACHE{1200,duree-progapprox} : le cache aura une durée progressive approximative calculée par la fonction cachelab_duree_progapprox.

_ Exemple : #CACHE{1200,duree-progapprox date_publication} : le cache aura une durée progressive approximative calculée par la fonction cachelab_duree_progapprox à partir de la date de publication. La valeur 1200 servira seulement si on désactive le plugin CACHELAB.

Si elle est définie par l’utilisateur, cette fonction recevra la valeur de date_creation issu de l’environnement de chaque cache. Souvent, c’est un champ de l’objet principal affiché par le squelette. Si nécessaire, on peut préciser un autre élément du contexte immédiatement aprés le nom de la méthode.
Exemple : #CACHE{1200,duree-progapprox date_naissance}

Une méthode de calcul de durée est livrée avec le plugin : progapprox. Elle renvoie une durée de cache de 10 secondes lorsque la date_creation date de moins d’une minute, qui augmente progressivement avec l’âge de l’objet affiché l’âce du cache , jusqu’à valoir 6 mois pour les objets de plus de 2 ans.

Si cette méthode ne convient pas, il appartient au webmestre de coder la fonction qui implémente la méthode dont il a besoin de ses besoins , ainsi que le filtre d’affichage de la date apparié .

Loger des éléments du cache

#CACHE{log ...} permet de loger des morceaux du cache, metadonnées et valeur .

#CACHE{3600, log} : loge tout le cache, méta et html (et spécifie une durée de 3600s pour le cache)
#CACHE{log lastmodified} : loge l’entrée ’lastmodified’ du cache
#CACHE{log contexte} : loge tout le tableau des variables environnement (#ENV)
#CACHE{log contexte/date_creation} : loge l’entrée ’date_creation’ de l’environnement

Le nom du fichier de cache utilisé pour ces logs est le nom du chemin du squelette, dans lequel les / ont été remplacés par des _, et préfixé par cachelab_

Vérifier le sessionnement

La bonne conception d’un squelette dans lequel l’internaute peut s’identifier suppose de parfaitement savoir si un squelette est sessionné ou non (pour éviter d’exploser les caches sessionnés). Le filtre assertsession permet de s’assurer que le squelette se comporte bien comme on l’a conçu, et que ce comportement perdure lors des évolutions futures de ce squelette ou d’autres parties du jeu de squelette.

Les arguments possibles sont : oui, oui_anonyme, oui_login, non, anonyme

-  #CACHE{3600, session assert non} s’assure que les emplois sont non-sessionnés
-  #CACHE{session oui} s’assure que les emplois sont sessionnés
-  #CACHE{session login} s’assure que les emplois sont sessionnés avec un internaute identifié
-  #CACHE{session anonyme} s’assure que les emplois sont non sessionnés ou sans internaute identifié

Dans le cas où une assertion n’est pas vérifié, une erreur est logée dans le fichier cachelab_assertsession

Filtrage post-calcul d’un cache

Il est possible pour le webmestre de définir d’autres filtrages du cache.

Pour traiter une instruction #CACHE{macommande arg1 arg2}, le webmestre doit définir une fonction cachelab_filtre_macommande. Cette fonction :


  • -  
    est appelée après le calcul du cache

  • -  
    reçoit 2 arguments :
    - le cache entier (toutes métadonnées et le code compilé). Si cet argument est reçu par référence, la fonction peut le modifier puis éventuellement mettre à jour la version mémoizée.
    - le reste de l’argument de #CACHE. Dans l’exemple ce sera arg1 arg2

Rq :
-  avec #FILTRE{unfiltre}, la fonction unfiltre reçoit le code html de tout le squelette, comme un filtre SPIP habituel.

Le webmestre peut définir lui même ses filtres à caches.
Par exemple #CACHE{1200,filtre-bidouille grave} appelle, aprés chaque calcul et enregistrement d’un cache, la fonction cachelab_filtre_bidouille avec 2 arguments : le $cache et l’argument $arg valant ’grave’.Éventuellement, le passage de $cache peut être fait par référence, ce qui permet que le filtre modifie son contenu.

Rq  :
-  
2 filtres de cache sont livrés d’origine avec le plugin : <var>session</var var>assertsession</var > et <var>log</var >, décrits plus haut . var > log</var > Leur code peut servir d’exemple pour en coder d’autres.
- La fonctionnalité #FILTRE de SPIP (usage : #FILTRE{unfiltre}) est différente puisqu’elle porte sur le contenu HTML, alors que les filtres de cache portent sur le cache entier, contenu HTML et métadonnées. Cependant, une fonctionnalité similaire à celle de #FILTRE pourrait être obtenue par un filtre sur le cache.

Voir aussi


-  Compléments CacheLab et todo
-  XRay, un explorateur des caches SPIP
-  CacheLab étend #CACHE et INCLURE
-  Plugin ’macrosession’ : usage optimisé et extension des données de session