Changeset 113830 in spip-zone

Timestamp:

Feb 9, 2019, 7:41:18 PM (11 days ago)

Author:

eric@…

Message:

Ajout de paramètres de configuration des caches et utilisation dans les API.
Ajout de l'API cache_repertorier().

Location:

_plugins_/cache/trunk

Files:

• cache/cache.php (modified) (6 diffs)
• inc/cache.php (modified) (3 diffs)

_plugins_/cache/trunk/cache/cache.php

@@ -39 +39 @@
         // Initialisation du tableau de configuration avec les valeurs par défaut du plugin Cache.
         $configuration_defaut = array(
-                'racine'        => _DIR_CACHE,
-                'nom'           => array('nom'),
-                'extension'     => '.txt',
-                'securisation'  => false,
-                'serialisation' => true,
-                'separateur'    => '_'
+                'racine'          => _DIR_CACHE,
+                'sous_dossier'    => false,
+                'nom_obligatoire' => array('nom'),
+                'nom_facultatif'  => array(),
+                'extension'       => '.txt',
+                'securisation'    => false,
+                'serialisation'   => true,
+                'separateur'      => '_'
         );
 
@@ -76 +78 @@
                 $configuration['racine'] = rtrim($configuration['racine'], '/') . '/';
         }
+
         // -- Sous-dossier spécifique au plugin
         $sous_dossier = ($configuration['racine'] == _DIR_VAR) ? "cache-${plugin}" : "$plugin";
@@ -81 +84 @@
         include_spip('inc/flock');
         $configuration['dossier_base'] = sous_repertoire($configuration['racine'], $sous_dossier);
-        
+
+        // -- Construction du tableau des composants du nom : dans l'ordre on a toujours les composants obligatoires
+        //    suivis des composants faclutatifs.
+        $configuration['nom'] = array_merge($configuration['nom_obligatoire'], $configuration['nom_facultatif']);
+
         // Enregistrement de la configuration du plugin utilisateur dans la meta prévue.
         // Si une configuration existe déjà on l'écrase.
@@ -123 +130 @@
                 // de base des caches du plugin.
                 $dir_cache = $configuration['dossier_base'];
-                if (!empty($cache['sous_dossier'])) {
-                        // Si le cache nécessite un sous-dossier, appelé service dans l'identifiant du cache.
-                        $dir_cache .= rtrim($cache['sous_dossier'], '/') . '/';
+                if ($configuration['sous_dossier']) {
+                        if (!empty($cache['sous_dossier'])) {
+                                // Si le cache nécessite un sous-dossier, appelé service dans l'identifiant du cache.
+                                $dir_cache .= rtrim($cache['sous_dossier'], '/') . '/';
+                        } else {
+                                // C'est une erreur, le sous-dossier n'a pas été fourni alors qu'il est requis.
+                                $dir_cache = '';
+                        }
                 }
 
@@ -132 +144 @@
                 // fournie par le plugin (liste ordonnée de composant).
                 $nom_cache = '';
-                foreach ($configuration['nom'] as $_composant) {
-                        if (isset($cache[$_composant])) {
-                                $nom_cache .= ($nom_cache ? $configuration['separateur'] : '') . $cache[$_composant];
+                if ($dir_cache) {
+                        foreach ($configuration['nom'] as $_composant) {
+                                if (isset($cache[$_composant])) {
+                                        $nom_cache .= ($nom_cache ? $configuration['separateur'] : '') . $cache[$_composant];
+                                }
                         }
                 }
@@ -204 +218 @@
 
 
+/**
+ * Complète la description canonique d'un cache.
+ *
+ * Le plugin Cache Factory ne complète pas la description canonique.
+ *
+ * @uses cache_chercher_service()
+ *
+ * @param string $plugin
+ *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
+ *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
+ * @param array  $cache
+  *       Tableau identifiant le cache pour lequel on veut construire le nom.
+ * @param array  $configuration
+ *        Configuration complète des caches du plugin utlisateur lue à partir de la meta de stockage.
+ *
+ * @return array
+ *         Description du cache complétée par un ensemble de données propres au plugin.
+ */
+function cache_cache_completer($plugin, $cache, $configuration) {
+
+        // Le plugin utilisateur peut fournir un service propre pour construire le chemin complet du fichier cache.
+        // Néanmoins, étant donné la généricité du mécanisme offert par le plugin Cache cela devrait être rare.
+        if ($completer = cache_chercher_service($plugin, 'cache_completer')) {
+                // On passe le plugin appelant à la fonction car cela permet ainsi de mutualiser les services de stockage.
+                $cache = $completer($plugin, $cache, $configuration);
+        }
+
+        return $cache;
+}
+
+
 // -----------------------------------------------------------------------
 // ----------------- UTILITAIRE PROPRE AU PLUGIN CACHE -------------------

_plugins_/cache/trunk/inc/cache.php

@@ -50 +50 @@
         if (is_array($cache)) {
                 // Création du répertoire du cache à créer, si besoin.
-                if (!empty($cache['sous_dossier'])) {
-                        // Si le conteneur nécessite un sous-dossier, appelé service dans l'identifiant du conteneur.
-                        sous_repertoire($configuration[$plugin]['dossier_base'], rtrim($cache['sous_dossier'], '/'));
-                }
-
-                // Détermination du chemin du cache :
+                $erreur_sous_dossier = false;
+                if ($configuration[$plugin]['sous_dossier']) {
+                        if (!empty($cache['sous_dossier'])) {
+                                // Si le cache nécessite un sous-dossier on crée le répertoire au besoin.
+                                sous_repertoire($configuration[$plugin]['dossier_base'], rtrim($cache['sous_dossier'], '/'));
+                        } else {
+                                // C'est une erreur, le sous-dossier n'a pas été fourni alors qu'il est requis. On arrête l'écriture.
+                                $erreur_sous_dossier = true;
+                        }
+                }
+
+                // Détermination du chemin du cache si pas d'erreur sur le sous-dossier :
                 // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
                 //   de la configuration du nom pour le plugin.
-                $fichier_cache = cache_cache_composer($plugin, $cache, $configuration[$plugin]);
+                if (!$erreur_sous_dossier) {
+                        $fichier_cache = cache_cache_composer($plugin, $cache, $configuration[$plugin]);
+                }
         } elseif (is_string($cache)) {
                 // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
@@ -316 +324 @@
 
 /**
- * Supprime le ou les caches spécifiés d'un plugin donné.
- * A AMELIORER
+ * Retourne la description complète des caches d'un plugin filtrés sur une liste de critères.
+ *
+ * @api
+ *
+ * @uses cache_configuration_lire()
+ * @uses cache_cache_configurer()
+ * @uses cache_cache_composer()
+ * @uses cache_cache_decomposer()
+ * @uses cache_cache_completer()
+ *
+ * @param string       $plugin
+ *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
+ *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
+ * @param array $filtres
+ *        Tableau associatif `[champ] = valeur` ou `[champ] = !valeur` de critères de filtres sur les composants
+ *        de caches. Les opérateurs égalité et inégalité sont possibles.
+ *
+ * @return array
+ *        Tableau des descriptions des fichiers cache créés par le plugin indexé par le chemin complet de
+ *        chaque fichier cache.
+ */
+function cache_repertorier($plugin, $filtres = array()) {
+
+        // Initialisation de la liste des caches
+        $caches = array();
+
+        // Lecture de la configuration des caches du plugin.
+        // Si celle-ci n'existe pas encore elle est créée (cas d'un premier appel, peu probable pour une lecture).
+        static $configuration = array();
+        include_spip('cache/cache');
+        if (empty($configuration[$plugin]) and (!$configuration[$plugin] = cache_configuration_lire($plugin))) {
+                $configuration[$plugin] = cache_cache_configurer($plugin);
+        }
+
+        // Rechercher les caches du plugin sans appliquer de filtre si ce n'est sur le sous-dossier éventuellement.
+        // Les autres filtres seront appliqués sur les fichiers récupérés.
+        $pattern_fichier = $configuration[$plugin]['dossier_base'];
+        if ($configuration[$plugin]['sous_dossier']) {
+                if (array_key_exists('sous_dossier', $filtres)) {
+                        $pattern_fichier .= rtrim($filtres['sous_dossier'], '/') . '/';
+                } else {
+                        $pattern_fichier .= '*/';
+                }
+        }
+
+        // On complète le pattern avec une recherche d'un nom quelconque mais avec l'extension configurée.
+        $pattern_fichier .= '*' . $configuration[$plugin]['extension'];
+
+        // On recherche les fichiers correspondant au pattern.
+        $fichiers_cache = glob($pattern_fichier);
+
+        if ($fichiers_cache) {
+                foreach ($fichiers_cache as $_fichier_cache) {
+                        // On décompose le chemin de chaque cache afin de renvoyer l'identifiant canonique du cache.
+                        $cache = cache_cache_decomposer($plugin, $_fichier_cache, $configuration[$plugin]);
+
+                        // Maintenant que les composants sont déterminés on applique les filtres pour savoir si on
+                        // complète et stocke le cache.
+                        $cache_conforme = true;
+                        foreach ($filtres as $_critere => $_valeur) {
+                                $operateur_egalite = true;
+                                $valeur = $_valeur;
+                                if (substr($_valeur, 0, 1) == '!') {
+                                        $operateur_egalite = false;
+                                        $valeur = ltrim($_valeur, '!');
+                                }
+                                if (isset($cache[$_critere])
+                                and (($operateur_egalite and ($cache[$_critere] != $valeur))
+                                        or (!$operateur_egalite and ($cache[$_critere] == $valeur)))) {
+                                        $cache_conforme = false;
+                                        break;
+                                }
+                        }
+
+                        if ($cache_conforme) {
+                                // On permet au plugin de completer la description canonique
+                                $cache = cache_cache_completer($plugin, $cache, $configuration[$plugin]);
+
+                                // On stocke la description du fichier cache dans le tableau de sortie.
+                                $caches[$_fichier_cache] = $cache;
+                        }
+                }
+        }
+
+        return $caches;
+}
+
+
+/**
+ * Supprime, pour un plugin donné, les caches désignés par leur chemin complet.
  *
  * @api
@@ -325 +421 @@
  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
  * @param array  $caches
- *        Liste des fichiers caches (chemin complet) à supprimer.
+ *        Liste des fichiers caches désignés par leur chemin complet.
  *
  * @return bool
+ *         True si la suppression s'est bien passée, false sinon.
  */
 function cache_vider($plugin, $caches) {