www/ecrire/balise/formulaire_.php

   1 <?php
   2 /***************************************************************************\
   3  *  SPIP, Systeme de publication pour l'internet                           *
   4  *                                                                         *
   5  *  Copyright (c) 2001-2012                                                *
   6  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
   7  *                                                                         *
   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 \***************************************************************************/
  11
  12 /**
  13  * Fonctions génériques pour les balises formulaires
  14  *
  15  * @package SPIP\Formulaires
  16 **/
  17 if (!defined('_ECRIRE_INC_VERSION')) return;
  18
  19 include_spip('inc/filtres');
  20
  21 /**
  22  * Protéger les saisies d'un champ de formulaire
  23  *
  24  * Proteger les ' et les " dans les champs que l'on va injecter,
  25  * sans toucher aux valeurs sérialisées
  26  *
  27  * @see entites_html()
  28  * @param string|array $texte
  29  *     Saisie à protéger
  30  * @return string|array
  31  *     Saisie protégée
  32 **/
  33 function protege_champ($texte){
  34         if (is_array($texte))
  35                 $texte = array_map('protege_champ',$texte);
  36         else {
  37                 // ne pas corrompre une valeur serialize
  38                 if ((preg_match(",^[abis]:\d+[:;],", $texte) AND unserialize($texte)!=false) OR is_null($texte))
  39                         return $texte;
  40                 $texte = entites_html($texte);
  41         }
  42         return $texte;
  43 }
  44
  45 /**
  46  * Teste si un formulaire demandé possède un squelette pour l'afficher
  47  *
  48  * @see trouver_fond()
  49  * @param string
  50  *     Nom du formulaire
  51  * @return string|bool
  52  *     - string : chemin du squelette
  53  *     - false : pas de squelette trouvé
  54 **/
  55 function existe_formulaire($form)
  56 {
  57         if (substr($form,0,11)=="FORMULAIRE_")
  58                 $form = strtolower(substr($form,11));
  59         else
  60                 $form = strtolower($form);
  61
  62         if (!$form) return ''; // on ne sait pas, le nom du formulaire n'est pas fourni ici
  63
  64         return trouver_fond($form, 'formulaires/') ? $form : false;
  65 }
  66
  67
  68 /**
  69  * Balises Formulaires par défaut.
  70  *
  71  * Compilé en un appel à une balise dynamique.
  72  *
  73  * @param Champ $p
  74  *     Description de la balise formulaire
  75  * @return Champ
  76  *     Description complétée du code compilé appelant la balise dynamique
  77 **/
  78 function balise_FORMULAIRE__dist($p) {
  79
  80         // Cas d'un #FORMULAIRE_TOTO inexistant : renvoyer la chaine vide.
  81         // mais si #FORMULAIRE_{toto} on ne peut pas savoir a la compilation, continuer
  82         if (existe_formulaire($p->nom_champ)===FALSE) {
  83                     $p->code = "''";
  84                     $p->interdire_scripts = false;
  85                     return $p;
  86         }
  87
  88         // sinon renvoyer un code php dynamique
  89         return calculer_balise_dynamique($p, $p->nom_champ, array());
  90 }
  91
  92 /**
  93  * Balise dynamiques par défaut des formulaires
  94  *
  95  * @param string $form
  96  *     Nom du formulaire
  97  * @return string|array
  98  *     - array : squelette à appeler, durée du cache, contexte
  99  *     - string : texte à afficher directement
 100  */
 101 function balise_FORMULAIRE__dyn($form)
 102 {
 103         $form = existe_formulaire($form);
 104         if (!$form) return '';
 105
 106         // deux moyen d'arriver ici :
 107         // soit #FORMULAIRE_XX reroute avec 'FORMULAIRE_XX' ajoute en premier arg
 108         // soit #FORMULAIRE_{xx}
 109
 110         // recuperer les arguments passes a la balise
 111         // on enleve le premier qui est le nom de la balise
 112         // deja recupere ci-dessus
 113
 114         $args = func_get_args();
 115         array_shift($args);
 116         $contexte = balise_FORMULAIRE__contexte($form, $args);
 117         if (!is_array($contexte)) return $contexte;
 118         return array("formulaires/$form", 3600, $contexte);
 119 }
 120
 121 /**
 122  * Calcule le contexte à envoyer dans le squelette d'un formulaire
 123  *
 124  * @param string $form
 125  *     Nom du formulaire
 126  * @param array $args
 127  *     Arguments envoyés à l'appel du formulaire
 128  * @return array
 129  *     Contexte d'environnement à envoyer au squelette
 130 **/
 131 function balise_FORMULAIRE__contexte($form, $args)
 132 {
 133         // tester si ce formulaire vient d'etre poste (memes arguments)
 134         // pour ne pas confondre 2 #FORMULAIRES_XX identiques sur une meme page
 135         // si poste, on recupere les erreurs
 136
 137         $je_suis_poste = false;
 138         if ($post_form = _request('formulaire_action')
 139          AND $post_form==$form
 140          AND $p = _request('formulaire_action_args')
 141          AND is_array($p = decoder_contexte_ajax($p, $post_form))) {
 142                 // enlever le faux attribut de langue masque
 143                 array_shift($p);
 144                 if (formulaire__identifier($form, $args, $p))
 145                         $je_suis_poste = true;
 146         }
 147
 148         $editable = true;
 149         $erreurs = $post = array();
 150         if ($je_suis_poste) {
 151                 $post = traiter_formulaires_dynamiques(true);
 152                 $e = "erreurs_$form";
 153                 $erreurs = isset($post[$e]) ? $post[$e] : array();
 154                 $editable = "editable_$form";
 155                 $editable = (!isset($post[$e]))
 156                           || count($erreurs)
 157                           || (isset($post[$editable]) && $post[$editable]);
 158         }
 159
 160         $valeurs = formulaire__charger($form, $args, $je_suis_poste);
 161
 162         // si $valeurs n'est pas un tableau, le formulaire n'est pas applicable
 163         // C'est plus fort qu'editable qui est gere par le squelette
 164         // Idealement $valeur doit etre alors un message explicatif.
 165         if (!is_array($valeurs)) return is_string($valeurs) ? $valeurs : '';
 166
 167         // charger peut passer une action si le formulaire ne tourne pas sur self()
 168         // ou une action vide si elle ne sert pas
 169         $action = (isset($valeurs['action'])) ? $valeurs['action'] : self('&amp;', true);
 170         // bug IEx : si action finit par /
 171         // IE croit que le <form ... action=../ > est autoferme
 172         if (substr($action,-1)=='/') {
 173                 // on ajoute une ancre pour feinter IE, au pire ca tue l'ancre qui finit par un /
 174                 $action .= '#';
 175         }
 176
 177         // recuperer la saisie en cours si erreurs
 178         // seulement si c'est ce formulaire qui est poste
 179         // ou si on le demande explicitement par le parametre _forcer_request = true
 180         $dispo = ($je_suis_poste || (isset($valeurs['_forcer_request']) && $valeurs['_forcer_request']));
 181         foreach(array_keys($valeurs) as $champ){
 182                 if ($champ[0]!=='_' AND !in_array($champ, array('message_ok','message_erreur','editable'))) {
 183                         if ($dispo AND (($v = _request($champ))!==NULL))
 184                                 $valeurs[$champ] = $v;
 185                         // nettoyer l'url des champs qui vont etre saisis
 186                         if ($action)
 187                                 $action = parametre_url($action,$champ,'');
 188                         // proteger les ' et les " dans les champs que l'on va injecter
 189                         $valeurs[$champ] = protege_champ($valeurs[$champ]);
 190                 }
 191         }
 192
 193         if ($action) {
 194                 // nettoyer l'url
 195                 $action = parametre_url($action,'formulaire_action','');
 196                 $action = parametre_url($action,'formulaire_action_args','');
 197         }
 198
 199         if (isset($valeurs['_action'])){
 200                 $securiser_action = charger_fonction('securiser_action','inc');
 201                 $secu = $securiser_action(reset($valeurs['_action']),end($valeurs['_action']),'',-1);
 202                 $valeurs['_hidden'] = (isset($valeurs['_hidden'])?$valeurs['_hidden']:'') .
 203                 "<input type='hidden' name='arg' value='".$secu['arg']."' />"
 204                 . "<input type='hidden' name='hash' value='".$secu['hash']."' />";
 205         }
 206
 207         // empiler la lang en tant que premier argument implicite du CVT
 208         // pour permettre de la restaurer au moment du Verifier et du Traiter
 209         array_unshift($args, $GLOBALS['spip_lang']);
 210
 211         $valeurs['formulaire_args'] = encoder_contexte_ajax($args, $form);
 212         $valeurs['erreurs'] = $erreurs;
 213         $valeurs['action'] = $action;
 214         $valeurs['form'] = $form;
 215
 216         if (!isset($valeurs['id'])) $valeurs['id'] = 'new';
 217         // editable peut venir de charger() ou de traiter() sinon
 218         if (!isset($valeurs['editable'])) $valeurs['editable'] = $editable;
 219         // dans tous les cas, renvoyer un espace ou vide (et pas un booleen)
 220         $valeurs['editable'] = ($valeurs['editable']?' ':'');
 221
 222         if ($je_suis_poste) {
 223                 $valeurs['message_erreur'] = "";
 224                 if (isset($erreurs['message_erreur']))
 225                         $valeurs['message_erreur'] = $erreurs['message_erreur'];
 226
 227                 $valeurs['message_ok'] = "";
 228                 if (isset($post["message_ok_$form"]))
 229                         $valeurs['message_ok'] = $post["message_ok_$form"];
 230                 elseif (isset($erreurs['message_ok']))
 231                         $valeurs['message_ok'] = $erreurs["message_ok"];
 232         }
 233
 234         return $valeurs;
 235 }
 236
 237 /**
 238  * Charger les valeurs de saisie du formulaire
 239  *
 240  * @param string $form
 241  * @param array $args
 242  * @param bool $poste
 243  * @return array
 244  */
 245 function formulaire__charger($form, $args, $poste)
 246 {
 247         if ($charger_valeurs = charger_fonction("charger","formulaires/$form",true))
 248                 $valeurs = call_user_func_array($charger_valeurs,$args);
 249         else $valeurs = array();
 250
 251         $valeurs = pipeline(
 252                 'formulaire_charger',
 253                 array(
 254                         'args'=>array('form'=>$form,'args'=>$args,'je_suis_poste'=>$poste),
 255                         'data'=>$valeurs)
 256         );
 257
 258         // si $valeurs et false ou une chaine, pas de formulaire, donc pas de pipeline !
 259         if (is_array($valeurs)){
 260                 if (!isset($valeurs['_pipelines'])) $valeurs['_pipelines']=array();
 261                 // l'ancien argument _pipeline devient maintenant _pipelines
 262                 // reinjectons le vieux _pipeline au debut de _pipelines
 263                 if (isset($valeurs['_pipeline'])) {
 264                         $pipe = is_array($valeurs['_pipeline'])?reset($valeurs['_pipeline']):$valeurs['_pipeline'];
 265                         $args = is_array($valeurs['_pipeline'])?end($valeurs['_pipeline']):array();
 266
 267                         $pipelines = array($pipe=>$args);
 268                         $valeurs['_pipelines'] = array_merge($pipelines,$valeurs['_pipelines']);
 269                 }
 270
 271                 // et enfin, ajoutons systematiquement un pipeline sur le squelette du formulaire
 272                 // qui constitue le cas le plus courant d'utilisation du pipeline recuperer_fond
 273                 // (performance, cela evite de s'injecter dans recuperer_fond utilise pour *tous* les squelettes)
 274                 $valeurs['_pipelines']['formulaire_fond'] = array('form'=>$form,'args'=>$args,'je_suis_poste'=>$poste);
 275         }
 276
 277         return $valeurs;
 278 }
 279
 280 /**
 281  * Vérifier que le formulaire en cours est celui qui est poste
 282  *
 283  * On se base sur la fonction identifier (si elle existe) qui fournit
 284  * une signature identifiant le formulaire a partir de ses arguments
 285  * significatifs
 286  *
 287  * En l'absence de fonction identifier, on se base sur l'egalite des
 288  * arguments, ce qui fonctionne dans les cas simples
 289  *
 290  * @param string $form
 291  * @param array $args
 292  * @param array $p
 293  * @return bool
 294  */
 295 function formulaire__identifier($form, $args, $p) {
 296         if ($identifier_args = charger_fonction("identifier","formulaires/$form",true)) {
 297                 return call_user_func_array($identifier_args,$args)===call_user_func_array($identifier_args,$p);
 298         }
 299         return $args===$p;
 300 }
 301 ?>