spip_nursit/ecrire/balise/formulaire_.php

385 lines
12 KiB
PHP
Raw Permalink Normal View History

2023-06-01 15:30:12 +00:00
<?php
/***************************************************************************\
* SPIP, Systeme de publication pour l'internet *
* *
* Copyright (c) 2001-2019 *
* Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
* *
* Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
/**
* Fonctions génériques pour les balises formulaires
*
* @package SPIP\Core\Formulaires
**/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
include_spip('inc/filtres');
include_spip('inc/texte');
/**
* Protéger les saisies d'un champ de formulaire
*
* Proteger les ' et les " dans les champs que l'on va injecter,
* sans toucher aux valeurs sérialisées
*
* @see entites_html()
* @param string|array $texte
* Saisie à protéger
* @return string|array
* Saisie protégée
**/
function protege_champ($texte) {
if (is_array($texte)) {
$texte = array_map('protege_champ', $texte);
} else {
if (is_null($texte)) {
return $texte;
}
if (is_string($texte)
and $texte
and strpbrk($texte, "&\"'<>") !== false
) {
$texte = spip_htmlspecialchars($texte, ENT_QUOTES);
} elseif (is_bool($texte)) {
$texte = ($texte ? '1' : '');
}
}
return $texte;
}
/**
* Teste si un formulaire demandé possède un squelette pour l'afficher
*
* @see trouver_fond()
* @param string $form
* Nom du formulaire
* @return string|bool
* - string : chemin du squelette
* - false : pas de squelette trouvé
**/
function existe_formulaire($form) {
if (substr($form, 0, 11) == "FORMULAIRE_") {
$form = strtolower(substr($form, 11));
} else {
$form = strtolower($form);
}
if (!$form) {
return '';
} // on ne sait pas, le nom du formulaire n'est pas fourni ici
return trouver_fond($form, 'formulaires/') ? $form : false;
}
/**
* Tester si un formulaire est appele via un modele type <formulaire|...> et le cas echeant retourne les arguments passes au modele
* false sinon
* @return false|array
*/
function test_formulaire_inclus_par_modele() {
$trace = debug_backtrace(null, 20);
$trace_fonctions = array_column($trace, 'function');
$trace_fonctions = array_map('strtolower', $trace_fonctions);
// regarder si un flag a ete leve juste avant l'appel de balise_FORMULAIRE_dyn
if (function_exists('arguments_balise_dyn_depuis_modele')
and $form = arguments_balise_dyn_depuis_modele(null, 'read')) {
if (in_array('balise_formulaire__dyn', $trace_fonctions)) {
$k = array_search('balise_formulaire__dyn', $trace_fonctions);
if ($trace[$k]['args'][0] === $form) {
return $trace[$k]['args'];
}
}
}
// fallback qui ne repose pas sur le flag lie a l'analyse de contexte_compil,
// mais ne marche pas si executer_balise_dynamique est appelee via du php dans le squelette
if (in_array('eval', $trace_fonctions) and in_array('inclure_modele', $trace_fonctions)) {
$k = array_search('inclure_modele', $trace_fonctions);
// les arguments de recuperer_fond() passes par inclure_modele()
return $trace[$k-1]['args'][1]['args'];
}
return false;
}
/**
* Balises Formulaires par défaut.
*
* Compilé en un appel à une balise dynamique.
*
* @param Champ $p
* Description de la balise formulaire
* @return Champ
* Description complétée du code compilé appelant la balise dynamique
**/
function balise_FORMULAIRE__dist($p) {
// Cas d'un #FORMULAIRE_TOTO inexistant : renvoyer la chaine vide.
// mais si #FORMULAIRE_{toto} on ne peut pas savoir a la compilation, continuer
if (existe_formulaire($p->nom_champ) === false) {
$p->code = "''";
$p->interdire_scripts = false;
return $p;
}
// sinon renvoyer un code php dynamique
return calculer_balise_dynamique($p, $p->nom_champ, array());
}
/**
* Balise dynamiques par défaut des formulaires
*
* @param string $form
* Nom du formulaire
* @return string|array
* - array : squelette à appeler, durée du cache, contexte
* - string : texte à afficher directement
*/
function balise_FORMULAIRE__dyn($form) {
$form = existe_formulaire($form);
if (!$form) {
return '';
}
// deux moyen d'arriver ici :
// soit #FORMULAIRE_XX reroute avec 'FORMULAIRE_XX' ajoute en premier arg
// soit #FORMULAIRE_{xx}
// recuperer les arguments passes a la balise
// on enleve le premier qui est le nom de la balise
// deja recupere ci-dessus
$args = func_get_args();
array_shift($args);
$contexte = balise_FORMULAIRE__contexte($form, $args);
if (!is_array($contexte)) {
return $contexte;
}
return array("formulaires/$form", 3600, $contexte);
}
/**
* Calcule le contexte à envoyer dans le squelette d'un formulaire
*
* @param string $form
* Nom du formulaire
* @param array $args
* Arguments envoyés à l'appel du formulaire
* @return array
* Contexte d'environnement à envoyer au squelette
**/
function balise_FORMULAIRE__contexte($form, $args) {
// tester si ce formulaire vient d'etre poste (memes arguments)
// pour ne pas confondre 2 #FORMULAIRES_XX identiques sur une meme page
// si poste, on recupere les erreurs
$je_suis_poste = false;
if ($post_form = _request('formulaire_action')
and $post_form == $form
and $p = _request('formulaire_action_args')
and is_array($p = decoder_contexte_ajax($p, $post_form))
) {
// enlever le faux attribut de langue masque
array_shift($p);
if (formulaire__identifier($form, $args, $p)) {
$je_suis_poste = true;
}
}
$editable = true;
$erreurs = $post = array();
if ($je_suis_poste) {
$post = traiter_formulaires_dynamiques(true);
$e = "erreurs_$form";
$erreurs = isset($post[$e]) ? $post[$e] : array();
$editable = "editable_$form";
$editable = (!isset($post[$e]))
|| count($erreurs)
|| (isset($post[$editable]) && $post[$editable]);
}
$valeurs = formulaire__charger($form, $args, $je_suis_poste);
// si $valeurs n'est pas un tableau, le formulaire n'est pas applicable
// C'est plus fort qu'editable qui est gere par le squelette
// Idealement $valeur doit etre alors un message explicatif.
if (!is_array($valeurs)) {
return is_string($valeurs) ? $valeurs : '';
}
// charger peut passer une action si le formulaire ne tourne pas sur self()
// ou une action vide si elle ne sert pas
$action = (isset($valeurs['action'])) ? $valeurs['action'] : self('&amp;', true);
// bug IEx : si action finit par /
// IE croit que le <form ... action=../ > est autoferme
if (substr($action, -1) == '/') {
// on ajoute une ancre pour feinter IE, au pire ca tue l'ancre qui finit par un /
$action .= '#';
}
// recuperer la saisie en cours si erreurs
// seulement si c'est ce formulaire qui est poste
// ou si on le demande explicitement par le parametre _forcer_request = true
$dispo = ($je_suis_poste || (isset($valeurs['_forcer_request']) && $valeurs['_forcer_request']));
foreach (array_keys($valeurs) as $champ) {
if ($champ[0] !== '_' and !in_array($champ, array('message_ok', 'message_erreur', 'editable'))) {
if ($dispo and (($v = _request($champ)) !== null)) {
$valeurs[$champ] = $v;
}
// nettoyer l'url des champs qui vont etre saisis
if ($action) {
$action = parametre_url($action, $champ, '');
}
// proteger les ' et les " dans les champs que l'on va injecter
$valeurs[$champ] = protege_champ($valeurs[$champ]);
}
}
if ($action) {
// nettoyer l'url
$action = parametre_url($action, 'formulaire_action', '');
$action = parametre_url($action, 'formulaire_action_args', '');
$action = parametre_url($action, 'formulaire_action_sign', '');
}
/**
* sert (encore :() pour poster sur les actions de type editer_xxx() qui ne prenaient pas d'argument autrement que par _request('arg') et pour lesquelles il fallait donc passer un hash valide
*/
if (isset($valeurs['_action'])) {
$securiser_action = charger_fonction('securiser_action', 'inc');
$secu = $securiser_action(reset($valeurs['_action']), end($valeurs['_action']), '', -1);
$valeurs['_hidden'] = (isset($valeurs['_hidden']) ? $valeurs['_hidden'] : '') .
"<input type='hidden' name='arg' value='" . $secu['arg'] . "' />"
. "<input type='hidden' name='hash' value='" . $secu['hash'] . "' />";
}
// empiler la lang en tant que premier argument implicite du CVT
// pour permettre de la restaurer au moment du Verifier et du Traiter
array_unshift($args, $GLOBALS['spip_lang']);
$valeurs['formulaire_args'] = encoder_contexte_ajax($args, $form);
$valeurs['erreurs'] = $erreurs;
$valeurs['action'] = $action;
$valeurs['form'] = $form;
$valeurs['formulaire_sign'] = '';
if (!empty($GLOBALS['visiteur_session']['id_auteur'])) {
$securiser_action = charger_fonction('securiser_action', 'inc');
$secu = $securiser_action($valeurs['form'], $valeurs['formulaire_args'], '', -1);
$valeurs['formulaire_sign'] = $secu['hash'];
}
if (!isset($valeurs['id'])) {
$valeurs['id'] = 'new';
}
// editable peut venir de charger() ou de traiter() sinon
if (!isset($valeurs['editable'])) {
$valeurs['editable'] = $editable;
}
// dans tous les cas, renvoyer un espace ou vide (et pas un booleen)
$valeurs['editable'] = ($valeurs['editable'] ? ' ' : '');
if ($je_suis_poste) {
$valeurs['message_erreur'] = "";
if (isset($erreurs['message_erreur'])) {
$valeurs['message_erreur'] = $erreurs['message_erreur'];
}
$valeurs['message_ok'] = "";
if (isset($post["message_ok_$form"])) {
$valeurs['message_ok'] = $post["message_ok_$form"];
} elseif (isset($erreurs['message_ok'])) {
$valeurs['message_ok'] = $erreurs["message_ok"];
}
}
return $valeurs;
}
/**
* Charger les valeurs de saisie du formulaire
*
* @param string $form
* @param array $args
* @param bool $poste
* @return array
*/
function formulaire__charger($form, $args, $poste) {
if ($charger_valeurs = charger_fonction("charger", "formulaires/$form", true)) {
$valeurs = call_user_func_array($charger_valeurs, $args);
} else {
$valeurs = array();
}
$valeurs = pipeline(
'formulaire_charger',
array(
'args' => array('form' => $form, 'args' => $args, 'je_suis_poste' => $poste),
'data' => $valeurs
)
);
// prise en charge CVT multi etape
if (is_array($valeurs) and isset($valeurs['_etapes'])) {
include_spip('inc/cvt_multietapes');
$valeurs = cvtmulti_formulaire_charger_etapes(
array('form' => $form, 'args' => $args, 'je_suis_poste' => $poste),
$valeurs
);
}
// si $valeurs et false ou une chaine, pas de formulaire, donc pas de pipeline !
if (is_array($valeurs)) {
if (!isset($valeurs['_pipelines'])) {
$valeurs['_pipelines'] = array();
}
// l'ancien argument _pipeline devient maintenant _pipelines
// reinjectons le vieux _pipeline au debut de _pipelines
if (isset($valeurs['_pipeline'])) {
$pipe = is_array($valeurs['_pipeline']) ? reset($valeurs['_pipeline']) : $valeurs['_pipeline'];
$args = is_array($valeurs['_pipeline']) ? end($valeurs['_pipeline']) : array();
$pipelines = array($pipe => $args);
$valeurs['_pipelines'] = array_merge($pipelines, $valeurs['_pipelines']);
}
// et enfin, ajoutons systematiquement un pipeline sur le squelette du formulaire
// qui constitue le cas le plus courant d'utilisation du pipeline recuperer_fond
// (performance, cela evite de s'injecter dans recuperer_fond utilise pour *tous* les squelettes)
$valeurs['_pipelines']['formulaire_fond'] = array('form' => $form, 'args' => $args, 'je_suis_poste' => $poste);
}
return $valeurs;
}
/**
* Vérifier que le formulaire en cours est celui qui est poste
*
* On se base sur la fonction identifier (si elle existe) qui fournit
* une signature identifiant le formulaire a partir de ses arguments
* significatifs
*
* En l'absence de fonction identifier, on se base sur l'egalite des
* arguments, ce qui fonctionne dans les cas simples
*
* @param string $form
* @param array $args
* @param array $p
* @return bool
*/
function formulaire__identifier($form, $args, $p) {
if ($identifier_args = charger_fonction("identifier", "formulaires/$form", true)) {
return call_user_func_array($identifier_args, $args) === call_user_func_array($identifier_args, $p);
}
return $args === $p;
}