source: spip-zone/_plugins_/noizetier/trunk/formulaires/editer_page.php @ 110333

Last change on this file since 110333 was 110333, checked in by eric@…, 5 months ago

Renommage dans l'API des blocs.
Mise au point de l'API des objets.
Correction des fonctions réversibles de composition/décomposition des conteneurs pour le cas des objets.

File size: 14.3 KB
Line 
1<?php
2
3if (!defined('_ECRIRE_INC_VERSION')) {
4        return;
5}
6
7// TODO : à quoi ça sert vraiment?
8if (!function_exists('autoriser')) {
9        include_spip('inc/autoriser');
10}     // si on utilise le formulaire dans le public
11
12/**
13 * Formulaire d'édition d'une page de composition de noisettes.
14 * Déclarer les champs postés et y intégrer les valeurs par défaut
15 *
16 * @param string $edition
17 *              Type d'édition à savoir :
18 *              - `modifier`: édition de la configuration de base d'une composition virtuelle
19 *              - `créer`: création d'une composition virtuelle à partir d'une page source
20 *              - `dupliquer`: copie d'une composition pour créer une nouvelle composition virtuelle
21 * @param string $page
22 *              L'identifiant de la page ou de la composition :
23 *              - `modifier`: la composition virtuelle en cours d'édition
24 *              - `créer`: la page source
25 *              - `dupliquer`: la composition source
26 * @param string $redirect
27 *              URL de redirection. La valeur dépend du type d'édition.
28 *
29 * @return array
30 *              Tableau des champs postés pour l'affichage du formulaire.
31 */
32function formulaires_editer_page_charger_dist($edition, $page, $redirect = '') {
33
34        // Initialisation des données communes à charger dans le formulaire
35        $valeurs = array(
36                'editable' => true,
37                'edition' => $edition,
38                'type_page' => '',
39                'composition' => '',
40                'nom' => '',
41                'description' => '',
42                'icon' => '',
43                '_blocs' => array(),
44                '_blocs_defaut' => array(),
45        );
46
47        include_spip('inc/noizetier_page');
48        $description_page = noizetier_page_lire($page, false);
49        if ($description_page) {
50                if ($edition == 'modifier') {
51                        // La page désignée par $page est déjà une composition virtuelle dont on souhaite modifier une
52                        // partie de la configuration (hors noisettes).
53                        // La variable $description_page contient donc la configuration complète de cette page.
54                        $valeurs['type_page'] = $description_page['type'];
55                        $valeurs['composition'] = $description_page['composition'];
56                        $valeurs['est_virtuelle'] = $description_page['est_virtuelle'];
57
58                        if ($valeurs['est_virtuelle'] == 'oui') {
59                                $valeurs['nom'] = $description_page['nom'];
60                                $valeurs['description'] = $description_page['description'];
61                                $valeurs['icon'] = $description_page['icon'];
62                        }
63
64                } elseif ($edition == 'dupliquer') {
65                        // La page désignée est la composition source que l'on souhaite dupliquer pour créer une nouvelle
66                        // composition virtuelle. La nouvelle composition virtuelle aura donc le même type de page et
67                        // un identifiant de composition différent initialisé à 'copie_composition'.
68                        // On initialise aussi le nom de la nouvelle composition à 'copie de nom_page_source'.
69                        $valeurs['type_page'] = $description_page['type'];
70                        $valeurs['composition'] = "copie_{$description_page['composition']}";
71                        $valeurs['nom'] = _T('noizetier:copie_de', array('source' => $description_page['nom']));
72
73                } elseif ($edition == 'creer') {
74                        // On crée une nouvelle composition à partir d'une page source.
75                        // La variable $description_page contient donc la configuration complète de la page source.
76                        $valeurs['type_page'] = $description_page['type'];
77                        $valeurs['nom'] = _T('info_sans_titre');
78
79                } else {
80                        $valeurs['editable'] = false;
81                }
82        } else {
83                $valeurs['editable'] = false;
84        }
85
86        if ($valeurs['editable']) {
87                // Ajout de la liste des blocs configurables afin de choisir de possibles exclusions.
88                // En outre, on initialise les blocs exclus par défaut qui coincident
89                // -- pour une modification, à la liste des blocs exclus de la composition en cours de modification
90                // -- pour une duplication ou une création de composition, à la liste des blocs exclus de la source.
91                // Ainsi cette liste est toujours l'inverse de l'index [blocs] de l'argument $description_page.
92                include_spip('inc/noizetier_bloc');
93                $blocs = noizetier_bloc_lister_defaut();
94                foreach ($blocs as $_bloc) {
95                        $valeurs['_blocs'][$_bloc] = noizetier_bloc_lire($_bloc, 'nom');
96                        if (!in_array($_bloc, $description_page['blocs'])) {
97                                $valeurs['_blocs_defaut'][] = $_bloc;
98                        }
99                }
100
101                // Ajout des héritages possibles en fonction du type de page. L'identifiant de la page permet quant à
102                // lui d'initialiser les héritages avec :
103                // - soit ceux de la page en cours de modification
104                // - soit ceux de la composition source pour une duplication
105                $valeurs['_heritiers'] = array();
106                if ($valeurs['est_virtuelle'] == 'oui') {
107                        $page = $description_page['composition']
108                                ? "{$description_page['type']}-{$description_page['composition']}"
109                                : '';
110                        $valeurs = array_merge($valeurs, construire_heritages($valeurs['type_page'], $page));
111                }
112        }
113
114        return $valeurs;
115}
116
117/**
118 * @param string $edition
119 *              Type d'édition à savoir :
120 *              - `modifier`: édition de la configuration de base d'une composition virtuelle
121 *              - `créer`: création d'une composition virtuelle à partir d'une page source
122 *              - `dupliquer`: copie d'une composition pour créer une nouvelle composition virtuelle
123 * @param string $page
124 *              L'identifiant de la page ou de la composition :
125 *              - `modifier`: la composition virtuelle en cours d'édition
126 *              - `créer`: la page source
127 *              - `dupliquer`: la composition source
128 * @param string $redirect
129 *              URL de redirection. La valeur dépend du type d'édition.
130 *
131 * @return array
132 */
133function formulaires_editer_page_verifier_dist($edition, $page, $redirect = '') {
134        $erreurs = array();
135
136        // On vérifie que les champs obligatoires ont été bien saisis
137        if (_request('est_virtuelle') == 'oui') {
138                foreach (array('type_page', 'composition', 'nom') as $champ) {
139                        if (!_request($champ)) {
140                                $erreurs[$champ] = _T('noizetier:formulaire_obligatoire');
141                        }
142                }
143        }
144
145        // On vérifie dans le cas d'une nouvelle composition que :
146        // - l'identifiant saisi n'est pas déjà utilisé par une autre composition
147        // - la syntaxe de l'identifiant qui ne doit contenir ni espace, ni tiret.
148        if ($edition != 'modifier') {
149                $type_page = _request('type_page');
150                $composition = _request('composition');
151
152                $where = array('composition!=' . sql_quote(''));
153                $pages = sql_allfetsel('page', 'spip_noizetier_pages', $where);
154                if ($pages) {
155                        $pages = array_map('reset', $pages);
156                        if (isset($pages[$type_page.'-'.$composition])) {
157                                $erreurs['composition'] = _T('noizetier:formulaire_identifiant_deja_pris');
158                        }
159                        if (!preg_match('#^[a-z0-9_]+$#', $composition)) {
160                                $erreurs['composition'] = _T('noizetier:formulaire_erreur_format_identifiant');
161                        }
162                }
163        }
164
165        return $erreurs;
166}
167
168/**
169 *
170 *
171 * @param string $edition
172 *              Type d'édition à savoir :
173 *              - `modifier`: édition de la configuration de base d'une composition virtuelle
174 *              - `créer`: création d'une composition virtuelle à partir d'une page source
175 *              - `dupliquer`: copie d'une composition pour créer une nouvelle composition virtuelle
176 * @param string $page
177 *              L'identifiant de la page ou de la composition :
178 *              - `modifier`: la composition virtuelle en cours d'édition
179 *              - `créer`: la page source
180 *              - `dupliquer`: la composition source
181 * @param string $redirect
182 *              URL de redirection. La valeur dépend du type d'édition.
183 *
184 * @return array
185 */
186function formulaires_editer_page_traiter_dist($edition, $page, $redirect = '') {
187
188        $retour = array();
189        $description = array();
190
191        // Identifiant de la page ou de la composition.
192        $type_page = _request('type_page');
193        $composition = _request('composition');
194        $identifiant = $composition ? "${type_page}-${composition}" : $type_page;
195
196        // Déterminer si la page est explicite ou est une composition virtuelle.
197        // En effet, pour les pages explicites seuls les blocs exclus peuvent être modifiés.
198        $est_virtuelle = _request('est_virtuelle');
199
200        // Récupération des champs descriptifs et de l'icone.
201        if ($est_virtuelle == 'oui') {
202                $description['nom'] = _request('nom');
203                $description['description'] = _request('description');
204                $description['icon'] = _request('icon');
205
206                // Traitement des branches éventuelles pour la composition virtuelle résultante
207                $branche = array();
208                $heritages = construire_heritages($type_page);
209                foreach ($heritages['_heritiers'] as $_objet => $_composition) {
210                        if ($composition_heritee = _request("heritage-${_objet}")) {
211                                $branche[$_objet] = $composition_heritee;
212                        }
213                }
214                $description['branche'] = $branche;
215        }
216
217        // Traitement des blocs configurables
218        $blocs_exclus = _request('blocs_exclus');
219        $description['blocs_exclus'] = $blocs_exclus;
220        // TODO : si on exclut des blocs il faut supprimer leurs éventuelles noisettes.
221        // TODO : une autre solution serait d'interdire l'exclusion d'un bloc contenant une noisette
222
223        if ($edition != 'modifier') {
224                // Initialisation de la description pour une composition virtuelle.
225                $description_defaut = array(
226                        'page'           => $identifiant,
227                        'type'           => $type_page,
228                        'composition'    => $composition,
229                        'nom'            => $identifiant,
230                        'description'    => '',
231                        'icon'           => 'page-24.png',
232                        'blocs_exclus'   => array(),
233                        'necessite'      => array(),
234                        'branche'        => array(),
235                        'est_virtuelle'  => 'oui',
236                        'est_page_objet' => 'non',
237                        'signature'      => '',
238                );
239
240                // Identifie si la page est celle d'un objet SPIP
241                include_spip('base/objets');
242                $tables_objets = array_keys(lister_tables_objets_sql());
243                $description['est_page_objet'] = in_array(table_objet_sql($type_page), $tables_objets) ? 'oui' : 'non';
244
245                // Complétude de la description avec les valeurs par défaut
246                $description = array_merge($description_defaut, $description);
247        }
248
249        // On termine en sérialisant les tableaux des blocs exclus, necessite et branche.
250        $description['blocs_exclus'] = serialize($description['blocs_exclus']);
251        if ($est_virtuelle == 'oui') {
252                $description['branche'] = serialize($description['branche']);
253                if (isset($description['necessite'])) {
254                        $description['necessite'] = serialize($description['necessite']);
255                }
256        }
257
258        // Mise ou insertion de la composition virtuelle
259        if ($edition == 'modifier') {
260                // -- Update de la composition modifiée
261                $where = array('page=' . sql_quote($identifiant));
262                $retour_sql = sql_updateq('spip_noizetier_pages', $description, $where);
263        } else {
264                // -- Insertion de la nouvelle composition
265                $retour_sql = sql_insertq('spip_noizetier_pages', $description);
266
267                // Pour une création ou un duplication, il faut traiter le peuplement automatique des noisettes
268                // de la page source si requis.
269                // -- on préremplit avec les noisettes de la page source, systématiquement en cas de duplication
270                //    ou si demandé, en cas de création.
271                if ($retour_sql) {
272                        if (($type_page != 'page')
273                        and (($edition == 'dupliquer') or (($edition == 'creer') and _request('peupler')))) {
274                                // Récupération des noisettes de la page source
275                                $select = array('plugin', 'rang_noisette', 'type', 'composition', 'bloc', 'type_noisette', 'parametres');
276                                $from = 'spip_noisettes';
277                                $where = array(
278                                        'plugin=' . sql_quote('noizetier'),
279                                        'type=' . sql_quote($type_page),
280                                        'composition=' . sql_quote(noizetier_page_extraire_composition($page))
281                                );
282                                $noisettes_source = sql_allfetsel($select, $from, $where);
283                                // Injection des noisettes de la source dans la composition virtuelle en cours de création qui diffère
284                                // uniquement par l'identifiant de composition.
285                                if ($noisettes_source) {
286                                        foreach ($noisettes_source as $_index => $_noisette) {
287                                                $noisettes_source[$_index]['composition'] = $composition;
288                                        }
289                                        sql_insertq_multi($from, $noisettes_source);
290                                }
291                        }
292
293                        // On invalide le cache en cas de création ou  de duplication
294                        include_spip('inc/invalideur');
295                        suivre_invalideur("id='page/$identifiant'");
296                }
297        }
298
299        if ($retour_sql === false) {
300                $retour['message_nok'] = _T('noizetier:formulaire_composition_erreur');
301        } else {
302                $retour['message_ok'] = _T('noizetier:formulaire_composition_mise_a_jour');
303                if (in_array($edition, array('creer', 'dupliquer'))) {
304                        $retour['redirect'] = $redirect;
305                } elseif ($redirect) {
306                        if (strncmp($redirect, 'javascript:', 11) == 0) {
307                                $retour['message_ok'] .= '<script type="text/javascript">/*<![CDATA[*/'.substr($redirect, 11).'/*]]>*/</script>';
308                                $retour['editable'] = true;
309                        } else {
310                                $retour['redirect'] = $redirect;
311                        }
312                }
313        }
314
315        return $retour;
316}
317
318
319/**
320 * Détermine les compositions héritables par le type de page et les héritages définis
321 * pour chaque type d'objet concerné par la composition désignée par $page.
322 *
323 * @param string $type
324 *              Type d'objet pouvant posséder des enfants.
325 * @param string $page
326 *              Identifiant de la composition dont les héritages doivent être renvoyés.
327 *
328 * @return array
329 */
330function construire_heritages($type, $page = '') {
331
332        // Initialisation du tableau
333        $heritages = array('_heritiers' => array());
334
335        // Récupération des compositions explicites et virtuelles
336        $select = array('page', 'type', 'composition', 'nom', 'branche');
337        $where = array('composition!=' . sql_quote(''));
338        $compositions = sql_allfetsel($select, 'spip_noizetier_pages', $where);
339        if ($compositions) {
340                // On réindexe le tableau entier par l'identifiant de la page
341                $compositions = array_column($compositions, null, 'page');
342
343                // Récupération des types d'objet (objets héritiers) possédant un type d'objet parent.
344                // Par exemple, article qui à a un parent rubrique.
345                include_spip('compositions_fonctions');
346                $objets_heritiers = array_keys(compositions_recuperer_heritage(), $type);
347                if ($objets_heritiers) {
348                        foreach ($compositions as $_page => $_configuration) {
349                                // Pour chaque composition répertoriée par le noiZetier, on détecte si celle-ci est affectable à
350                                // un des types d'objet ayant un parent et on liste les compositions par objet héritier.
351                                if (in_array($_configuration['type'], $objets_heritiers)) {
352                                        if (empty($heritages['_heritiers'][$_configuration['type']]['-'])) {
353                                                // Ne pas oublier d'insérer une fois la page par défaut de l'objet
354                                                $heritages['_heritiers'][$_configuration['type']]['-'] =
355                                                        ucfirst(_T('compositions:composition_defaut')) . ' (' . $_configuration['type'] . ')';
356                                        }
357                                        $heritages['_heritiers'][$_configuration['type']][$_configuration['composition']] =
358                                                $_configuration['nom'] . ' (' . $_configuration['type'] . '-' . $_configuration['composition'] . ')';
359                                        // On initialise, pour la page concernée si besoin, la composition affectée.
360                                        if (($_page == $page) and ($branches = unserialize($_configuration['branche'])) and !empty($branches)) {
361                                                foreach ($branches as $_objet => $_composition) {
362                                                        $heritages["heritage-${_objet}"] = $_composition;
363                                                }
364                                        }
365                                }
366                        }
367                }
368        }
369
370        return $heritages;
371}
Note: See TracBrowser for help on using the repository browser.