2 /***************************************************************************\
3 * SPIP, Systeme de publication pour l'internet *
5 * Copyright (c) 2001-2019 *
6 * Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
8 * Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
9 * Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
10 \***************************************************************************/
13 * Fonctions génériques pour les balises formulaires
15 * @package SPIP\Core\Formulaires
17 if (!defined('_ECRIRE_INC_VERSION')) {
21 include_spip('inc/filtres');
22 include_spip('inc/texte');
25 * Protéger les saisies d'un champ de formulaire
27 * Proteger les ' et les " dans les champs que l'on va injecter,
28 * sans toucher aux valeurs sérialisées
31 * @param string|array $texte
33 * @return string|array
36 function protege_champ($texte) {
37 if (is_array($texte)) {
38 $texte = array_map('protege_champ', $texte);
40 // ne pas corrompre une valeur serialize
41 if ((preg_match(",^[abis]:\d+[:;],", $texte) and @unserialize
($texte) != false) or is_null($texte)) {
46 and strpbrk($texte, "&\"'<>") !== false
48 $texte = spip_htmlspecialchars($texte, ENT_QUOTES
);
49 } elseif (is_bool($texte)) {
50 $texte = ($texte ?
'1' : '');
58 * Teste si un formulaire demandé possède un squelette pour l'afficher
64 * - string : chemin du squelette
65 * - false : pas de squelette trouvé
67 function existe_formulaire($form) {
68 if (substr($form, 0, 11) == "FORMULAIRE_") {
69 $form = strtolower(substr($form, 11));
71 $form = strtolower($form);
76 } // on ne sait pas, le nom du formulaire n'est pas fourni ici
78 return trouver_fond($form, 'formulaires/') ?
$form : false;
82 * Tester si un formulaire est appele via un modele type <formulaire|...> et le cas echeant retourne les arguments passes au modele
86 function test_formulaire_inclus_par_modele() {
87 $trace = debug_backtrace(null, 20);
88 $trace_fonctions = array_column($trace, 'function');
89 $trace_fonctions = array_map('strtolower', $trace_fonctions);
91 // regarder si un flag a ete leve juste avant l'appel de balise_FORMULAIRE_dyn
92 if (function_exists('arguments_balise_dyn_depuis_modele')
93 and $form = arguments_balise_dyn_depuis_modele(null, 'read')) {
94 if (in_array('balise_formulaire__dyn', $trace_fonctions)) {
95 $k = array_search('balise_formulaire__dyn', $trace_fonctions);
96 if ($trace[$k]['args'][0] === $form) {
97 return $trace[$k]['args'];
102 // fallback qui ne repose pas sur le flag lie a l'analyse de contexte_compil,
103 // mais ne marche pas si executer_balise_dynamique est appelee via du php dans le squelette
104 if (in_array('eval', $trace_fonctions) and in_array('inclure_modele', $trace_fonctions)) {
105 $k = array_search('inclure_modele', $trace_fonctions);
106 // les arguments de recuperer_fond() passes par inclure_modele()
107 return $trace[$k-1]['args'][1]['args'];
113 * Balises Formulaires par défaut.
115 * Compilé en un appel à une balise dynamique.
118 * Description de la balise formulaire
120 * Description complétée du code compilé appelant la balise dynamique
122 function balise_FORMULAIRE__dist($p) {
124 // Cas d'un #FORMULAIRE_TOTO inexistant : renvoyer la chaine vide.
125 // mais si #FORMULAIRE_{toto} on ne peut pas savoir a la compilation, continuer
126 if (existe_formulaire($p->nom_champ
) === false) {
128 $p->interdire_scripts
= false;
133 // sinon renvoyer un code php dynamique
134 return calculer_balise_dynamique($p, $p->nom_champ
, array());
138 * Balise dynamiques par défaut des formulaires
140 * @param string $form
142 * @return string|array
143 * - array : squelette à appeler, durée du cache, contexte
144 * - string : texte à afficher directement
146 function balise_FORMULAIRE__dyn($form) {
147 $form = existe_formulaire($form);
152 // deux moyen d'arriver ici :
153 // soit #FORMULAIRE_XX reroute avec 'FORMULAIRE_XX' ajoute en premier arg
154 // soit #FORMULAIRE_{xx}
156 // recuperer les arguments passes a la balise
157 // on enleve le premier qui est le nom de la balise
158 // deja recupere ci-dessus
160 $args = func_get_args();
162 $contexte = balise_FORMULAIRE__contexte($form, $args);
163 if (!is_array($contexte)) {
167 return array("formulaires/$form", 3600, $contexte);
171 * Calcule le contexte à envoyer dans le squelette d'un formulaire
173 * @param string $form
176 * Arguments envoyés à l'appel du formulaire
178 * Contexte d'environnement à envoyer au squelette
180 function balise_FORMULAIRE__contexte($form, $args) {
181 // tester si ce formulaire vient d'etre poste (memes arguments)
182 // pour ne pas confondre 2 #FORMULAIRES_XX identiques sur une meme page
183 // si poste, on recupere les erreurs
185 $je_suis_poste = false;
186 if ($post_form = _request('formulaire_action')
187 and $post_form == $form
188 and $p = _request('formulaire_action_args')
189 and is_array($p = decoder_contexte_ajax($p, $post_form))
191 // enlever le faux attribut de langue masque
193 if (formulaire__identifier($form, $args, $p)) {
194 $je_suis_poste = true;
199 $erreurs = $post = array();
200 if ($je_suis_poste) {
201 $post = traiter_formulaires_dynamiques(true);
202 $e = "erreurs_$form";
203 $erreurs = isset($post[$e]) ?
$post[$e] : array();
204 $editable = "editable_$form";
205 $editable = (!isset($post[$e]))
207 ||
(isset($post[$editable]) && $post[$editable]);
210 $valeurs = formulaire__charger($form, $args, $je_suis_poste);
212 // si $valeurs n'est pas un tableau, le formulaire n'est pas applicable
213 // C'est plus fort qu'editable qui est gere par le squelette
214 // Idealement $valeur doit etre alors un message explicatif.
215 if (!is_array($valeurs)) {
216 return is_string($valeurs) ?
$valeurs : '';
219 // charger peut passer une action si le formulaire ne tourne pas sur self()
220 // ou une action vide si elle ne sert pas
221 $action = (isset($valeurs['action'])) ?
$valeurs['action'] : self('&', true);
222 // bug IEx : si action finit par /
223 // IE croit que le <form ... action=../ > est autoferme
224 if (substr($action, -1) == '/') {
225 // on ajoute une ancre pour feinter IE, au pire ca tue l'ancre qui finit par un /
229 // recuperer la saisie en cours si erreurs
230 // seulement si c'est ce formulaire qui est poste
231 // ou si on le demande explicitement par le parametre _forcer_request = true
232 $dispo = ($je_suis_poste ||
(isset($valeurs['_forcer_request']) && $valeurs['_forcer_request']));
233 foreach (array_keys($valeurs) as $champ) {
234 if ($champ[0] !== '_' and !in_array($champ, array('message_ok', 'message_erreur', 'editable'))) {
235 if ($dispo and (($v = _request($champ)) !== null)) {
236 $valeurs[$champ] = $v;
238 // nettoyer l'url des champs qui vont etre saisis
240 $action = parametre_url($action, $champ, '');
242 // proteger les ' et les " dans les champs que l'on va injecter
243 $valeurs[$champ] = protege_champ($valeurs[$champ]);
249 $action = parametre_url($action, 'formulaire_action', '');
250 $action = parametre_url($action, 'formulaire_action_args', '');
253 if (isset($valeurs['_action'])) {
254 $securiser_action = charger_fonction('securiser_action', 'inc');
255 $secu = $securiser_action(reset($valeurs['_action']), end($valeurs['_action']), '', -1);
256 $valeurs['_hidden'] = (isset($valeurs['_hidden']) ?
$valeurs['_hidden'] : '') .
257 "<input type='hidden' name='arg' value='" . $secu['arg'] . "' />"
258 . "<input type='hidden' name='hash' value='" . $secu['hash'] . "' />";
261 // empiler la lang en tant que premier argument implicite du CVT
262 // pour permettre de la restaurer au moment du Verifier et du Traiter
263 array_unshift($args, $GLOBALS['spip_lang']);
265 $valeurs['formulaire_args'] = encoder_contexte_ajax($args, $form);
266 $valeurs['erreurs'] = $erreurs;
267 $valeurs['action'] = $action;
268 $valeurs['form'] = $form;
270 if (!isset($valeurs['id'])) {
271 $valeurs['id'] = 'new';
273 // editable peut venir de charger() ou de traiter() sinon
274 if (!isset($valeurs['editable'])) {
275 $valeurs['editable'] = $editable;
277 // dans tous les cas, renvoyer un espace ou vide (et pas un booleen)
278 $valeurs['editable'] = ($valeurs['editable'] ?
' ' : '');
280 if ($je_suis_poste) {
281 $valeurs['message_erreur'] = "";
282 if (isset($erreurs['message_erreur'])) {
283 $valeurs['message_erreur'] = $erreurs['message_erreur'];
286 $valeurs['message_ok'] = "";
287 if (isset($post["message_ok_$form"])) {
288 $valeurs['message_ok'] = $post["message_ok_$form"];
289 } elseif (isset($erreurs['message_ok'])) {
290 $valeurs['message_ok'] = $erreurs["message_ok"];
298 * Charger les valeurs de saisie du formulaire
300 * @param string $form
305 function formulaire__charger($form, $args, $poste) {
306 if ($charger_valeurs = charger_fonction("charger", "formulaires/$form", true)) {
307 $valeurs = call_user_func_array($charger_valeurs, $args);
313 'formulaire_charger',
315 'args' => array('form' => $form, 'args' => $args, 'je_suis_poste' => $poste),
320 // prise en charge CVT multi etape
321 if (is_array($valeurs) and isset($valeurs['_etapes'])) {
322 include_spip('inc/cvt_multietapes');
323 $valeurs = cvtmulti_formulaire_charger_etapes(
324 array('form' => $form, 'args' => $args, 'je_suis_poste' => $poste),
329 // si $valeurs et false ou une chaine, pas de formulaire, donc pas de pipeline !
330 if (is_array($valeurs)) {
331 if (!isset($valeurs['_pipelines'])) {
332 $valeurs['_pipelines'] = array();
334 // l'ancien argument _pipeline devient maintenant _pipelines
335 // reinjectons le vieux _pipeline au debut de _pipelines
336 if (isset($valeurs['_pipeline'])) {
337 $pipe = is_array($valeurs['_pipeline']) ?
reset($valeurs['_pipeline']) : $valeurs['_pipeline'];
338 $args = is_array($valeurs['_pipeline']) ?
end($valeurs['_pipeline']) : array();
340 $pipelines = array($pipe => $args);
341 $valeurs['_pipelines'] = array_merge($pipelines, $valeurs['_pipelines']);
344 // et enfin, ajoutons systematiquement un pipeline sur le squelette du formulaire
345 // qui constitue le cas le plus courant d'utilisation du pipeline recuperer_fond
346 // (performance, cela evite de s'injecter dans recuperer_fond utilise pour *tous* les squelettes)
347 $valeurs['_pipelines']['formulaire_fond'] = array('form' => $form, 'args' => $args, 'je_suis_poste' => $poste);
354 * Vérifier que le formulaire en cours est celui qui est poste
356 * On se base sur la fonction identifier (si elle existe) qui fournit
357 * une signature identifiant le formulaire a partir de ses arguments
360 * En l'absence de fonction identifier, on se base sur l'egalite des
361 * arguments, ce qui fonctionne dans les cas simples
363 * @param string $form
368 function formulaire__identifier($form, $args, $p) {
369 if ($identifier_args = charger_fonction("identifier", "formulaires/$form", true)) {
370 return call_user_func_array($identifier_args, $args) === call_user_func_array($identifier_args, $p);