source: spip-zone/_plugins_/n-core/trunk/inc/ncore_type_noisette.php @ 109835

Last change on this file since 109835 was 109835, checked in by eric@…, 3 years ago

Une dernière modification du guide pour ce soir.

  • Property svn:eol-style set to native
File size: 14.2 KB
Line 
1<?php
2/**
3 * Ce fichier contient l'API N-Core de gestion des types de noisette, c'est-à-dire les squelettes et leur YAML.
4 *
5 * @package SPIP\NCORE\API\TYPE_NOISETTE
6 */
7if (!defined('_ECRIRE_INC_VERSION')) {
8        return;
9}
10
11
12/**
13 * Charge ou recharge les descriptions des types de noisette à partir des fichiers YAML.
14 * Les types de noisettes sont recherchés dans un répertoire relatif fourni en argument.
15 * La fonction optimise le chargement en effectuant uniquement les traitements nécessaires
16 * en fonction des modifications, ajouts et suppressions des types de noisettes identifiés en comparant
17 * les md5 des fichiers YAML.
18 *
19 * @api
20 * @uses ncore_type_noisette_lister()
21 * @uses ncore_type_noisette_completer()
22 * @uses ncore_type_noisette_stocker()
23 *
24 * @param string $plugin
25 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
26 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
27 * @param string $dossier
28 *        Chemin relatif (avec un `/` final) dans lequel chercher les fichiers YAML de description des noisettes.
29 *        Par défaut, les noisettes seront recherchées dans le dossier `noisettes/`.
30 * @param bool   $recharger
31 *        Si `true` force le rechargement de toutes les types de noisettes, sinon le chargement se base sur le
32 *        md5 des fichiers YAML. Par défaut vaut `false`.
33 * @param string $stockage
34 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
35 *        ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
36 *        fournissant le service de stockage souhaité.
37 *
38 * @return bool
39 *        `false` si une erreur s'est produite, `true` sinon.
40 */
41function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = false, $stockage = '') {
42
43        // Retour de la fonction
44        $retour = true;
45
46        // Initialiser le contexte de rechargement
47        // TODO : voir si on ajoute un var_mode=recalcul_noisettes ?
48
49        // On recherche les types de noisette directement par leur fichier YAML de configuration car il est
50        // obligatoire. La recherche s'effectue dans le path en utilisant le dossier relatif fourni.
51        if ($fichiers = find_all_in_path($dossier, '.+[.]yaml$')) {
52                // On charge l'API de stockge de N-Core.
53                // Ce sont ces fonctions qui aiguillent ou pas vers une éventuelle fonction spécifique de stockage.
54                include_spip("ncore/ncore");
55
56                // Initialisation des tableaux de types de noisette.
57                $types_noisette_a_ajouter = $types_noisette_a_changer = $types_noisette_a_effacer = array();
58
59                // Récupération des signatures md5 des noisettes déjà enregistrées.
60                // Si on force le rechargement il est inutile de gérer les signatures et les noisettes modifiées ou obsolètes.
61                $signatures = array();
62                if (!$recharger) {
63                        $signatures = ncore_type_noisette_lister($plugin, 'signature', $stockage);
64                        // On initialise la liste des types de noisette à supprimer avec l'ensemble des types de noisette déjà stockés.
65                        $types_noisette_a_effacer = $signatures ? array_keys($signatures) : array();
66                }
67
68                foreach ($fichiers as $_squelette => $_chemin) {
69                        $type_noisette = basename($_squelette, '.yaml');
70                        // Si on a forcé le rechargement ou si aucun md5 n'est encore stocké pour le type de noisette
71                        // on positionne la valeur du md5 stocké à chaine vide.
72                        // De cette façon, on force la lecture du fichier YAML du type de noisette.
73                        $md5_stocke = (isset($signatures[$type_noisette]) and !$recharger)
74                                ? $signatures[$type_noisette]
75                                : '';
76
77                        // Initialisation de la description par défaut du type de noisette
78                        // -- on y inclut le plugin appelant et la signature
79                        $description_defaut = array(
80                                'type_noisette' => $type_noisette,
81                                'nom'           => $type_noisette,
82                                'description'   => '',
83                                'icon'          => 'noisette-24.png',
84                                'necessite'     => array(),
85                                'contexte'      => array(),
86                                'ajax'          => 'defaut',
87                                'inclusion'     => 'statique',
88                                'parametres'    => array(),
89                                'plugin'        => $plugin,
90                                'signature'     => '',
91                        );
92
93                        // On vérifie que le md5 du fichier YAML est bien différent de celui stocké avant de charger
94                        // le contenu. Sinon, on passe au fichier suivant.
95                        $md5 = md5_file($_chemin);
96                        if ($md5 != $md5_stocke) {
97                                include_spip('inc/yaml');
98                                $description = yaml_charger_inclusions(yaml_decode_file($_chemin));
99
100                                // TODO : ne faudrait-il pas "valider" le fichier YAML ici ou alors lors du stockage ?
101                                // Traitements des champs pouvant être soit une chaine soit un tableau
102                                if (!empty($description['necessite']) and is_string($description['necessite'])) {
103                                        $description['necessite'] = array($description['necessite']);
104                                }
105                                if (!empty($description['contexte']) and is_string($description['contexte'])) {
106                                        $description['contexte'] = array($description['contexte']);
107                                }
108
109                                // On n'inclue ce type de noisette que si les plugins qu'il nécessite explicitement dans son
110                                // fichier de configuration sont bien tous activés.
111                                // Rappel: si un type de noisette est incluse dans un plugin non actif elle ne sera pas détectée
112                                //         lors du find_all_in_path() puisque le plugin n'est pas dans le path SPIP.
113                                //         Ce n'est pas ce cas qui est traité ici.
114                                $type_noisette_a_garder = true;
115                                if (!empty($description['necessite'])) {
116                                        foreach ($description['necessite'] as $_plugin_necessite) {
117                                                if (!defined('_DIR_PLUGIN_' . strtoupper($_plugin_necessite))) {
118                                                        $type_noisette_a_garder = false;
119                                                        break;
120                                                }
121                                        }
122                                }
123
124                                // Si la noisette est à garder on finalise sa description et on détermine si elle est nouvelle ou modifiée.
125                                // En mode rechargement forcé toute noisette est considérée comme nouvelle.
126                                // Sinon, la noisette doit être retirée de la base car un plugin qu'elle nécessite a été désactivée:
127                                // => il suffit pour cela de la laisser dans la liste des noisettes obsolètes.
128                                if ($type_noisette_a_garder) {
129                                        // Mise à jour du md5
130                                        $description['signature'] = $md5;
131                                        // Complétude de la description avec les valeurs par défaut
132                                        $description = array_merge($description_defaut, $description);
133                                        // Sérialisation des champs necessite, contexte et parametres qui sont des tableaux
134                                        $description['necessite'] = serialize($description['necessite']);
135                                        $description['contexte'] = serialize($description['contexte']);
136                                        $description['parametres'] = serialize($description['parametres']);
137                                        // Complément spécifique au plugin utilisateur si nécessaire
138                                        $description = ncore_type_noisette_completer($plugin, $description, $stockage);
139
140                                        if (!$md5_stocke or $recharger) {
141                                                // Le type de noisette est soit nouveau soit on est en mode rechargement forcé:
142                                                // => il faut le rajouter.
143                                                $types_noisette_a_ajouter[] = $description;
144                                        } else {
145                                                // La description stockée a été modifiée et le mode ne force pas le rechargement:
146                                                // => il faut mettre à jour le type de noisette.
147                                                $types_noisette_a_changer[] = $description;
148                                                // => et il faut donc le supprimer de la liste de types de noisette obsolètes
149                                                $types_noisette_a_effacer = array_diff($types_noisette_a_effacer, array($type_noisette));
150                                        }
151                                } else {
152                                        // Le type de noisette ne peut plus être utilisé car un des plugins qu'il nécessite n'est plus actif.
153                                        // => il faut le laisser dans la liste des obsolètes.
154                                        continue;
155                                }
156                        } else {
157                                // Le type de noisette n'a pas changé et n'a donc pas été réchargé:
158                                // => Il faut donc juste indiquer qu'il n'est pas obsolète.
159                                $types_noisette_a_effacer = array_diff($types_noisette_a_effacer, array($type_noisette));
160                        }
161                }
162
163                // Mise à jour du stockage des types de noisette si au moins un des 3 tableaux est non vide et que le chargement forcé
164                // n'est pas demandé:
165                // -- Suppression des types de noisettes obsolètes ou de tous les types de noisettes si on est en mode rechargement forcé.
166                //    Pour permettre une optimisation du traitement en mode rechargement forcé on passe toujours le mode.
167                // -- Update des types de noisette modifiés.
168                // -- Insertion des nouveaux types de noisette.
169                if ($recharger
170                        or (!$recharger and ($types_noisette_a_ajouter or $types_noisette_a_effacer or $types_noisette_a_changer))) {
171                        $types_noisette = array('a_ajouter' => $types_noisette_a_ajouter);
172                        if (!$recharger) {
173                                $types_noisette['a_effacer'] = $types_noisette_a_effacer;
174                                $types_noisette['a_changer'] = $types_noisette_a_changer;
175                        }
176                        $retour = ncore_type_noisette_stocker($plugin, $types_noisette, $recharger, $stockage);
177                }
178        }
179
180        return $retour;
181}
182
183
184/**
185 * Retourne, pour un type de noisette donné, la description complète ou seulement un champ précis.
186 * Les champs textuels peuvent subir une traitement typo si demandé.
187 *
188 * @api
189 * @uses ncore_type_noisette_decrire()
190 *
191 * @param string  $plugin
192 *        Le service permet de distinguer l'appelant qui peut-être un plugin comme le noiZetier ou
193 *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
194 *        La fonction utilisera la fonction de lecture de la description brute d'un type de noisette, spécifique
195 *        au service, ou à défaut, celle fournie par N-Core.
196 * @param string  $type_noisette
197 *        Identifiant du type de noisette.
198 * @param string  $information
199 *        Information spécifique à retourner ou vide pour retourner toute la description.
200 * @param boolean $traiter_typo
201 *        Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées
202 *        en utilisant la fonction _T_ou_typo. Par défaut l'indicateur vaut `false`.
203 *        Les champs sérialisés sont eux toujours désérialisés.
204 * @param string  $stockage
205 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
206 *        ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
207 *        fournissant le service de stockage souhaité.
208 *
209 * @return array|string
210 *        La description complète ou champ précis demandé pour un type de noisette donné. Les champs
211 *        de type tableau sont systématiquement désérialisés et si demandé, les champs textuels peuvent être
212 *        traités avec la fonction _T_ou_typo().
213 */
214function type_noisette_lire($plugin, $type_noisette, $information = '', $traiter_typo = false, $stockage = '') {
215
216        // On indexe le tableau des descriptions par le plugin appelant en cas d'appel sur le même hit
217        // par deux plugins différents.
218        static $donnees_typo = array('nom', 'description');
219        static $description_noisette = array();
220
221        // Stocker la description de la noisette si besoin
222        if (!isset($description_noisette[$plugin][$type_noisette])) {
223                // On charge l'API de N-Core.
224                // Ce sont ces fonctions qui aiguillent ou pas vers une fonction spécifique du service.
225                include_spip("ncore/ncore");
226
227                // Lecture de toute la configuration de la noisette: les données retournées sont brutes.
228                $description = ncore_type_noisette_decrire($plugin, $type_noisette, $stockage);
229
230                // Sauvegarde de la description de la page pour une consultation ultérieure dans le même hit.
231                if ($description) {
232                        // Traitements des champs tableaux sérialisés
233                        $description['contexte'] = unserialize($description['contexte']);
234                        $description['necessite'] = unserialize($description['necessite']);
235                        $description['parametres'] = unserialize($description['parametres']);
236                }
237
238                // Stockage de la description
239                $description_noisette[$plugin][$type_noisette] = $description;
240        }
241
242        if ($information) {
243                if (isset($description_noisette[$plugin][$type_noisette][$information])) {
244                        if (in_array($information, $donnees_typo) and $traiter_typo) {
245                                // Traitements de la donnée textuelle
246                                $retour = _T_ou_typo($description_noisette[$plugin][$type_noisette][$information]);
247                        } else {
248                                $retour = $description_noisette[$plugin][$type_noisette][$information];
249                        }
250                } else {
251                        $retour = '';
252                }
253        } else {
254                $retour = $description_noisette[$plugin][$type_noisette];
255                // Traitements des données textuels
256                if ($traiter_typo) {
257                        foreach ($donnees_typo as $_champ) {
258                                if (isset($retour[$_champ])) {
259                                        $retour[$_champ] = _T_ou_typo($retour[$_champ]);
260                                }
261                        }
262                }
263        }
264
265        return $retour;
266}
267
268/**
269 * Renvoie une liste de descriptions de types de noisette éventuellement filtrée sur certains champs.
270 *
271 * @api
272 * @uses ncore_type_noisette_lister()
273 *
274 * @param string $plugin
275 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
276 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
277 * @param array  $filtres
278 *        Tableau associatif `[champ] = valeur` de critères de filtres sur les descriptions de types de noisette.
279 *        Le seul opérateur possible est l'égalité.
280 * @param string $stockage
281 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
282 *        ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
283 *        fournissant le service de stockage souhaité.
284 *
285 * @return array
286 *        Tableau des descriptions des types de noisette trouvés indexé par le type de noisette.
287 */
288function type_noisette_repertorier($plugin, $filtres = array(), $stockage = '') {
289
290        // On indexe le tableau des des types de noisette par le plugin appelant en cas d'appel sur le même hit
291        // par deux plugins différents.
292        static $types_noisette = array();
293
294        if (!isset($types_noisette[$plugin])) {
295                // On charge l'API de N-Core.
296                // Ce sont ces fonctions qui aiguillent ou pas vers une fonction spécifique du service.
297                include_spip("ncore/ncore");
298
299                // On récupère la description complète de tous les types de noisettes détectés par le plugin appelant
300                $types_noisette[$plugin] = ncore_type_noisette_lister($plugin, '', $stockage);
301        }
302
303        // Application des filtres éventuellement demandés en argument de la fonction
304        $types_noisette_filtres = $types_noisette[$plugin];
305        if ($filtres) {
306                foreach ($types_noisette_filtres as $_type_noisette => $_description) {
307                        foreach ($filtres as $_critere => $_valeur) {
308                                if (isset($_description[$_critere]) and ($_description[$_critere] != $_valeur)) {
309                                        unset($types_noisette_filtres[$_type_noisette]);
310                                        break;
311                                }
312                        }
313                }
314        }
315
316        return $types_noisette_filtres;
317}
Note: See TracBrowser for help on using the repository browser.