Extensions : nouveaux ciblages et gestion des caches périmés

Définir une nouvelle méthode de filtrage

C’est l’index plus de la condition passée à cachelab_cibler qui spécifie la fonction à utiliser pour filtrer.

Lorsque $conditions['plus'] vaut monfiltrage, le webmestre doit définir une fonction cachelab_ciblercache_monfiltrage($action, $conditions, $options, $cle, &$data, &$stats) qui renvoie true ou false selon que le cache vérifie ou non le filtrage désiré.

Les arguments en sont :

-  $action, $conditions, $options : les paramètres reçus par cachelab_cibler. Dans le tableau des $conditions spécifiées, peut figurer un index plus_arg dont la méthode de filtrage peut utiliser la valeur.

-  $cle : la clé du cache APC à tester

-  $data : la valeur du cache APC à tester, y compris les métadonnées. Cet argument est passé par référence par soucis d’efficacité et pour permettre de modifier le cache ou les métadonnées.

-  $stats : le tableau de stats en cours. Cet argument est passé par référence et peut être modifié par la nouvelle fonction de filtrage, pour incrémenter les statistiques, augmenter les listes de caches et éventuellement pour renvoyer des résultats complémentaires.

Ce filtrage dédié est appelée après les filtrages par session, chemin et cle_objet s’ils sont spécifiés.

Le filtrage par contexte, proposé d’origine dans CacheLab est un exemple d’extension. En effet, cette méthode de filtrage est implémentée au moyen d’une fonction cachelab_ciblercache_contexte. Cela peut vous aider à créer la vôtre... mais il n’est possible de spécifique qu’un seul filtrage ’plus’ dans un même appel à cachelab_cibler. De ce fait, il n’est pas possible de combiner contexte avec un autre filtrage plus pour faire un test plus complexe en une seule passe. Pour faire cela, votre nouveau filtrage « plus » devrait combiner le test du ’contexte’ et la contrainte spécifique ajoutée, et l’appeler directement, uniquement.

Définir une nouvelle sorte d’action sur les caches ciblés

Pour définir une nouvelle action nouvelleaction, il faudra définir une fonction cachelab_appliquer_nouvelleaction($action, $cle, $data=null, $options='', &$return=null) sur le modèle de la fonction cachelab_appliquer livrée dans le plugin.

Cette fonction sera appelée tour à tour par cachelab_cibler pour chacun des caches ciblés.
-  Elle devra appliquer l’action nouvelleaction sur le cache dont la clé est reçue en paramètre $cle et dont le contenu est $data s’il est déjà connu (dans le cas où le filtre ne porte pas seulement sur le chemin mais aussi sur le contexte).
-  Les options de ciblage sont $options.
-  Elle renverra true si elle a pu appliquer l’action et false sinon.
-  La fonction pourra éventuellement ajouter un résultat au tableau $return passé en référence. Ce tableau pourra être récupéré dans le champ ’return’ de la valeur de retour de cachelab_cibler.

Garbage collector et libération des caches

Avec APCu, les caches périmés restent toujours présent en mémoire et s’accumulent. Lorsque la mémoire disponible est épuisée, APCu vide l’entièreté de l’espace qui lui est alloué, d’un coup. À la suite d’un tel vidage, tous les calculs devront être fait de nouveau.

On a donc intérêt, à ne pas garder les caches périmés pour ne pas consommer plus de mémoire que nécessaire.

Pour éviter les flush ou limiter leur fréquence, il faut faire le ménage des caches périmés ou inutiles :

-  par défaut, la fonction cachelab_cibler, lorsqu’elle est appelée, efface les caches périmés (sauf si on lui passe l’option ['clean' =>false ]).

-  Cachelab permet de lancer une tâche de fond caches_autoclean qui détruit les caches périmés. Pour activer ce cron nettoyeur, Il suffit de définir la constante CACHELAB_CRON_AUTOCLEAN_DELAI_S : sa valeur indique la durée entre chaque nettoyage.

-  Vous pouvez aussi définir une fonction inc_cache_autoclean_dist (appelée suite à un charger_fonction('cache_autoclean', 'inc')) pour indiquer si un cache spécifique doit être détruit ou non. Cela permet de définir une politique de nettoyage spécifique à votre site, par exemple libérer certains caches même s’ils ne sont pas périmés. La fonction reçoit 2 arguments : le nom APCu du cache et le contenu APCu du cache.