Changeset 125403 in spip-zone

Timestamp:

Aug 16, 2020, 6:47:21 PM (8 months ago)

Author:

Eric Lupinacci

Message:

Mise au point du formulaire de vidage des caches : un seul formulaire par plugin.
Correction de la balise #CACHE_LISTE pour prendre en compte le type de cache

Location:

_plugins_/cache/trunk

Files:

• . (modified) (2 props)
• ezcache/ezcache.php (modified) (1 diff)
• ezcache_fonctions.php (modified) (3 diffs)
• formulaires/cache_vider.html (modified) (2 diffs)
• formulaires/cache_vider.php (modified) (6 diffs)
• formulaires/inc-ezcache_cache_vider.html (modified) (2 diffs)
• lang/cache_fr.php (modified) (2 diffs)
• prive/squelettes/contenu/cache_vider.html (modified) (1 diff)

_plugins_/cache/trunk/ezcache/ezcache.php

@@ -414 +414 @@
 }
 
-/**
- * Effectue le chargement du formulaire de vidage des caches pour un plugin utilisateur donné.
- *
- * Le plugin Cache Factory propose une version simplifié du formulaire où tous les fichiers caches
- * sont listées par ordre alphabétique sans possibilité de regroupement.
- *
- * @uses service_cache_chercher()
- * @uses cache_repertorier()
- *
- * @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  $options       Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
- *                              au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
- *                              Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
- * @param array  $configuration Configuration complète des caches du plugin utilisateur 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 ezcache_cache_formulaire_charger($plugin, $options, $configuration) {
-
-        // Stocker le préfixe et le nom du plugin de façon systématique.
-        $valeurs = array('_prefixe' => $plugin);
-        $informer = chercher_filtre('info_plugin');
-        $valeurs['_nom_plugin'] = $informer($plugin, 'nom', true);
-
-        // Stocker le type de cache pour l'afficher dans le titre du formulaire.
-        $valeurs['_type_cache'] = $configuration['type_cache'];
-
-        // On répertorie les caches pour vérifier qu'ils existent. Si non, on n'appelle aucune fonction spécifique.
-        $valeurs['_caches'] = array();
-        $caches = cache_repertorier($plugin, $configuration['type_cache'], array());
-
-        // Le plugin utilisateur peut fournir un service propre pour construire le tableau des valeurs du formulaire.
-        if ($caches) {
-                if ($charger = service_cache_chercher($plugin, 'cache_formulaire_charger')) {
-                        $valeurs_plugin = $charger($plugin, $options, $configuration);
-                        if ($valeurs_plugin) {
-                                $valeurs = array_merge($valeurs, $valeurs_plugin);
-                        }
-                } else {
-                        // On présente simplement les fichiers caches en ordre alphabétique en visualisant uniquement
-                        // le sous-dossuer éventuel et le nom du fichier sans décomposition.
-                        // On construit un pseudo groupe unique sans titre dont l'id est le préfixe du plugin, ce qui permet de gérer
-                        // automatiquement les regroupements spécifiques de caches si besoin (par exemple, par services météo pour
-                        // Rainette).
-                        $valeurs['_caches'][$plugin] = array(
-                                'titre' => '',
-                                'liste' => $caches
-                        );
-                }
-        }
-
-        return $valeurs;
-}
-
 // -----------------------------------------------------------------------
 // ----------------- UTILITAIRE PROPRE AU PLUGIN CACHE -------------------

_plugins_/cache/trunk/ezcache_fonctions.php

@@ -9 +9 @@
 /**
  * Compile la balise `#CACHE_LISTE` qui fournit la liste des caches pour un plugin utilisateur donné
- * et conformes aux filtres éventuellement fournis.
+ * et conformes aux filtres éventuellement fournis. Pour se focaliser sur un type de cache donné du plugin
+ * il faut le fournir en filtre avec pour critère `type_cache`.
  * La signature de la balise est : `#CACHE_LISTE{plugin[, filtres]}`.
  *
@@ -17 +18 @@
  *     ```
  *     #CACHE_LISTE{ezcheck}, renvoie tous les caches du plugin ezcheck
- *     #CACHE_LISTE{ezcheck, #ARRAY{objet, repo}}, renvoie les caches du plugin ezcheck dont l'objet est 'repo'
+ *     #CACHE_LISTE{ezcheck, #ARRAY{type_cache, dashboard}}, renvoie tous les caches du type 'dashboard' du plugin ezcheck
+ *     #CACHE_LISTE{ezcheck, #ARRAY{type_cache, dashboard, objet, repo}}, renvoie les caches de type dashboard du plugin ezcheck dont l'objet est 'repo'
  *     ```
  *
@@ -56 +58 @@
  */
 function calculer_liste_cache($plugin, $filtres = array()) {
+
+        // Initialisation de la sortie
+        $caches = array();
+
+        // Déterminer si on veut les caches d'un type de cache ou de tous les types de caches du plugin
         include_spip('inc/ezcheck_cache');
+        if (isset($filtres['type_cache'])) {
+                // Recherche d'un filtre sur le type de cache
+                $types_cache = array($filtres['type_cache']);
+                unset($filtres['type_cache']);
+        } else {
+                $configurations = configuration_cache_lire($plugin);
+                $types_cache = array_keys($configurations);
+        }
 
-        return cache_repertorier($plugin, $filtres);
+        foreach ($types_cache as $_type_cache) {
+                $caches = array_merge($caches, cache_repertorier($plugin, $_type_cache, $filtres));
+        }
+
+        return $caches;
 }

_plugins_/cache/trunk/formulaires/cache_vider.html

@@ -1 @@
-<div class="formulaire_spip formulaire_vider_cache formulaire_vider_cache_#ENV{_prefixe}_#ENV{_type_cache}" id="#ENV{_prefixe}_#ENV{_type_cache}">
-
+<div class="formulaire_spip formulaire_vider_cache formulaire_vider_cache_#ENV{_prefixe}" id="#ENV{_prefixe}">
         <h3 class="titrem">
-                <:cache:cache_vider_titre_form{plugin=#ENV{_nom_plugin}}:>&nbsp;(<:cache:cache_vider_type_cache_form{type=#ENV{_type_cache}}:>)
+                <:cache:cache_vider_titre_form{plugin=#ENV{_nom_plugin}}:>
         </h3>
 
@@ -11 +10 @@
         <div>
                 #ACTION_FORMULAIRE{#ENV{action}}
+                <input type="hidden" name="types_cache" value="#ENV{_types_cache}" />
 
-                [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_[(#ENV{_type_cache})_]cache_vider.html]}|oui)
-                        <INCLURE{fond=formulaires/inc-#ENV{_prefixe}_#ENV{_type_cache}_cache_vider, env} />
+                [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_cache_vider.html]}|oui)
+                        <INCLURE{fond=formulaires/inc-#ENV{_prefixe}_cache_vider, env} />
                 ]
-                [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_[(#ENV{_type_cache})_]cache_vider.html]}|non)
+                [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_cache_vider.html]}|non)
                         <INCLURE{fond=formulaires/inc-ezcache_cache_vider, env} />
                 ]

_plugins_/cache/trunk/formulaires/cache_vider.php

@@ -13 +13 @@
  * le vidage de tout ou partie des fichiers.
  *
- * @uses configuration_cache_lire()
- * @uses ezcache_cache_formulaire_charger()
+ * @uses formulaire_cache_charger()
  *
  * @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 string $type_cache Type de cache identifiant la configuration dans la liste des configurations de cache du plugin
  * @param array  $options    Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
  *                           au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
@@ -27 +25 @@
  *               - `_caches`    : (affichage) liste des descriptions des caches du plugin rangés par groupes
  */
-function formulaires_cache_vider_charger($plugin, $type_cache, $options = array()) {
+function formulaires_cache_vider_charger($plugin, $options = array()) {
 
-        // Lecture de la configuration des caches du plugin.
+        // Stocker le préfixe et le nom du plugin de façon systématique.
+        $valeurs = array('_prefixe' => $plugin);
+        $informer = chercher_filtre('info_plugin');
+        $valeurs['_nom_plugin'] = $informer($plugin, 'nom', true);
+
+        // Récupérer les configurations de tous les types de cache du plugin et stocker la liste des types de cache
+        // afin de les fournir en hidden au formulaire.
         include_spip('inc/ezcache_cache');
-        $configuration = configuration_cache_lire($plugin, $type_cache);
+        $configurations = configuration_cache_lire($plugin);
+        $valeurs['_types_cache'] = implode(':', array_keys($configurations));
 
-        // On appelle le service de chargement des variables qui est soit celui par défaut de Cache Factory
-        // soit celui spécifique au plugin si il existe.
-        include_spip('ezcache/ezcache');
-        $valeurs = ezcache_cache_formulaire_charger($plugin, $options, $configuration);
+        // On boucle sur chaque type de cache pour répertorier les caches existant
+        $valeurs['_caches'] = array();
+        foreach ($configurations as $_type_cache => $_configuration) {
+                // On répertorie les caches pour vérifier qu'ils existent. Si non, on n'appelle aucune fonction spécifique.
+                $caches = cache_repertorier($plugin, $_type_cache, array());
+
+                // Le plugin utilisateur peut fournir un service propre pour construire le tableau des valeurs du formulaire
+                // pour le type de cache concerné. Les valeurs doivent suivre la structure standard pour l'affichage.
+                if ($caches) {
+                        if ($charger = service_cache_chercher($plugin, "${_type_cache}_cache_formulaire_charger")) {
+                                // Le plugin utilisateur doit présenter le tableau des caches sous la forme :
+                                // -- ['_caches'][$_type_cache][$groupe] = array('titre', 'liste)
+                                $valeurs_plugin = $charger($plugin, $options, $_configuration);
+                                if ($valeurs_plugin) {
+                                        $valeurs = array_merge($valeurs, $valeurs_plugin);
+                                }
+                        } else {
+                                // On présente simplement les fichiers caches en ordre alphabétique en visualisant uniquement
+                                // le sous-dossuer éventuel et le nom du fichier sans décomposition.
+                                // On construit un pseudo groupe unique sans titre dont l'id est le préfixe du plugin, ce qui permet de gérer
+                                // automatiquement les regroupements spécifiques de caches si besoin (par exemple, par services météo pour
+                                // Rainette).
+                                $valeurs['_caches'][$_type_cache][$plugin] = array(
+                                        'titre' => '',
+                                        'liste' => $caches
+                                );
+                        }
+                }
+        }
 
         return $valeurs;
@@ -46 +76 @@
  * @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 string $type_cache Type de cache identifiant la configuration dans la liste des configurations de cache du plugin
  * @param array  $options    Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
  *                           au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
@@ -53 +82 @@
  * @return array Tableau des erreurs qui se limite à la non sélection d'au moins un cache.
  */
-function formulaires_cache_vider_verifier($plugin, $type_cache, $options = array()) {
+function formulaires_cache_vider_verifier($plugin, $options = array()) {
         $erreurs = array();
 
-        $obligatoires = array('caches');
-        foreach ($obligatoires as $_obligatoire) {
-                if (!_request($_obligatoire)) {
-                        $erreurs[$_obligatoire] = _T('info_obligatoire');
+        $types_cache = explode(':', _request('types_cache'));
+        if ($types_cache !== false) {
+                $caches = array();
+                foreach ($types_cache as $_type_cache) {
+                        $caches_type = _request("caches_${_type_cache}");
+                        if ($caches_type) {
+                                $caches = array_merge($caches, $caches_type);
+                        }
+                }
+
+                if (!$caches) {
+                        $erreurs['message_erreur'] = _T('cache:cache_vider_erreur_nocache');
                 }
         }
@@ -73 +110 @@
  * @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 string $type_cache Type de cache identifiant la configuration dans la liste des configurations de cache du plugin
  * @param array  $options    Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
  *                           au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
@@ -81 +117 @@
  *               editable est toujours à vrai.
  */
-function formulaires_cache_vider_traiter($plugin, $type_cache, $options = array()) {
+function formulaires_cache_vider_traiter($plugin, $options = array()) {
         $retour = array();
 
         // On récupère les caches à supprimer
-        $caches = _request('caches');
+        $types_cache = explode(':', _request('types_cache'));
+        if ($types_cache === false) {
+                $types_cache = array();
+        }
 
-        // On appelle l'API des caches
+        // On boucle sur tous les types pour acquérir la liste des caches à supprimer
         include_spip('inc/ezcache_cache');
-        cache_vider($plugin, $type_cache, $caches);
+        foreach ($types_cache as $_type_cache) {
+                // On lit la liste des caches du type concerné
+                $caches = _request("caches_${_type_cache}");
+
+                // On supprimer les caches sélectionnés du type concerné
+                if ($caches) {
+                        cache_vider($plugin, $_type_cache, $caches);
+                }
+        }
 
         $retour['message_ok'] = _T('cache:cache_vider_succes');

_plugins_/cache/trunk/formulaires/inc-ezcache_cache_vider.html

@@ -1 @@
-<div class="editer-groupe">
-<BOUCLE_groupes(DATA) {source table, #ENV{_caches}}>
-        <div class="editer editer_caches">
-                [<label>(#VAL{cache:cache_vider_label_choix}|_T|unique{#ENV{_prefixe}})</label>]
-                [<h4>(#VALEUR{titre})</h4>]
-                <BOUCLE_caches(DATA) {source table, #VALEUR{liste}}{par cle}>
-                        <div class="choix">
-                                [(#SET{id, [(#ENV{_prefixe}|concat{_}|uniqid)]})]
-                                <input
-                                        type="checkbox"
-                                        name="caches[]"
-                                        class="checkbox checkbox_caches #_groupes:CLE"
-                                        id="#GET{id}"
-                                        value="#CLE" />
-                                <label for="#GET{id}"[ title="(#VALEUR{nom_cache})"]>
-                                [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_[(#ENV{_type_cache})_]cache_label.html]}|oui)
-                                        <INCLURE{fond=formulaires/inc-#ENV{_prefixe}_#ENV{_type_cache}_cache_label, cache=#VALEUR} />
-                                ]
-                                [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_[(#ENV{_type_cache})_]cache_label.html]}|non)
-                                        [[(#VALEUR{sous_dossier})&nbsp;|&nbsp;](#VALEUR{nom_cache})]
-                                ]
-                                </label>
-                        </div>
-                </BOUCLE_caches>
+<BOUCLE_types_cache(DATA) {source table, #ENV{_caches}}>
+#SET{type_cache, #CLE}
+<fieldset>
+        <legend>
+                <:cache:cache_vider_fieldset_form{type=#GET{type_cache}}:>
+        </legend>
+        <div class="editer-groupe">
+        <BOUCLE_groupes(DATA) {source table, #VALEUR}>
+                <div class="editer editer_caches">
+                        [<label>(#VAL{cache:cache_vider_label_choix}|_T|unique{#ENV{_prefixe}})</label>]
+                        [<h4>(#VALEUR{titre})</h4>]
+                        <BOUCLE_caches(DATA) {source table, #VALEUR{liste}}{par cle}>
+                                <div class="choix">
+                                        [(#SET{id, [(#ENV{_prefixe}|concat{#GET{type_cache}}|uniqid)]})]
+                                        <input
+                                                type="checkbox"
+                                                name="caches_#GET{type_cache}[]"
+                                                class="checkbox checkbox_caches[ (#GET{type_cache}) ]#_groupes:CLE"
+                                                id="#GET{id}"
+                                                value="#CLE" />
+                                        <label for="#GET{id}"[ title="(#VALEUR{nom_cache})"]>
+                                        [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_[(#GET{type_cache})_]cache_label.html]}|oui)
+                                                <INCLURE{fond=formulaires/inc-#ENV{_prefixe}_#GET{type_cache}_cache_label, cache=#VALEUR} />
+                                        ]
+                                        [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_[(#GET{type_cache})_]cache_label.html]}|non)
+                                                [[(#VALEUR{sous_dossier})&nbsp;|&nbsp;](#VALEUR{nom_cache})]
+                                        ]
+                                        </label>
+                                </div>
+                        </BOUCLE_caches>
+                </div>
+                <div class="action-cocher">
+                        <a href="#" id="tout-#GET{type_cache}-#CLE"><:cache:cache_vider_cocher_tout:></a><span class="sep"> | </span>
+                        <a href="#" id="rien-#GET{type_cache}-#CLE"><:cache:cache_vider_cocher_rien:></a>
+                </div>
+        </BOUCLE_groupes>
+                <div class="editer pleine_largeur">
+                        #BOITE_OUVRIR{'','notice'}
+                                <p><:cache:cache_vider_notice_aucun:></p>
+                        #BOITE_FERMER
+                </div>
+        <//B_groupes>
         </div>
-        <div class="action-cocher">
-                <a href="#" id="tout_#CLE"><:cache:cache_vider_cocher_tout:></a><span class="sep"> | </span>
-                <a href="#" id="rien_#CLE"><:cache:cache_vider_cocher_rien:></a>
-        </div>
-</BOUCLE_groupes>
-        <div class="editer pleine_largeur">
-                #BOITE_OUVRIR{'','notice'}
-                        <p><:cache:cache_vider_notice_aucun:></p>
-                #BOITE_FERMER
-        </div>
-<//B_groupes>
-</div>
+</fieldset>
+</BOUCLE_types_cache>
+
 [(#REM) <!-- Gestion des liens tout cocher et tout décocher --> ]
 <script type="text/javascript">
@@ -41 +50 @@
         (function($){
                 jQuery(".action-cocher a").click(function(){
-                        var id = $(this).attr('id').split('_');
+                        var id = $(this).attr('id').split('-');
                         var action = id[0];
-                        var groupe = id[1];
-                        jQuery("input.checkbox.checkbox_caches." + groupe).prop("checked", action === 'tout');
+                        var type_cache = id[1];
+                        var groupe = id[2];
+                        jQuery("input.checkbox.checkbox_caches." + type_cache + "." + groupe).prop("checked", action === 'tout');
                         return false;
                 });

_plugins_/cache/trunk/lang/cache_fr.php

@@ -7 +7 @@
         // C
         'cache_vider_titre_form'      => 'Caches du plugin @plugin@',
-        'cache_vider_type_cache_form' => 'type de cache «@type@»',
+        'cache_vider_fieldset_form'   => 'Type de cache « @type@ »',
         'cache_vider_titre_page'      => 'Cache Factory',
         'cache_vider_menu'            => 'Vider les caches des plugins',
@@ -13 +13 @@
         'cache_vider_notice_aucun'    => 'Aucun cache n\'a encore été créé par le plugin.',
         'cache_vider_succes'          => 'Les caches sélectionnés ont bien été supprimés.',
+        'cache_vider_erreur_nocache'  => 'Il est obligatoire de sélectionner au moins un cache.',
         'cache_vider_cocher_rien'     => 'Tout décocher',
         'cache_vider_cocher_tout'     => 'Tout cocher',

_plugins_/cache/trunk/prive/squelettes/contenu/cache_vider.html

@@ -2 +2 @@
 <h1 class="grostitre"><:cache:cache_vider_titre_page:>&nbsp;-&nbsp;<:cache:cache_vider_menu:></h1>
 
-[(#REM) <!-- On boucle sur la meta "cache": par plugin puis par type de cache dans chaque plugin -->]
+[(#REM) <!-- On boucle sur la meta "cache" pour chaque plugin -->]
 <BOUCLE_plugins_cache(DATA){source table, #CONFIG{cache}}{par cle}>
-        <BOUCLE_types_cache(DATA){source table, #VALEUR}{par cle}>
-        [<div class="ajax">
-                (#FORMULAIRE_CACHE_VIDER*{#_plugins_cache:CLE, #CLE})
-        </div>]
-        </BOUCLE_types_cache>
+[<div class="ajax">
+        (#FORMULAIRE_CACHE_VIDER*{#CLE})
+</div>]
 </BOUCLE_plugins_cache>