3 /***************************************************************************\
4 * SPIP, Systeme de publication pour l'internet *
6 * Copyright (c) 2001-2017 *
7 * Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
9 * Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
10 * Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
11 \***************************************************************************/
14 * Fonctions d'aides pour les fonctions d'objets de modification de contenus
16 * @package SPIP\Core\Objets\Modifications
19 if (!defined('_ECRIRE_INC_VERSION')) {
24 * Collecte des champs postés
26 * Fonction générique pour la collecte des posts
27 * dans action/editer_xxx
29 * @param array $white_list
30 * Les champs à récupérer
31 * @param array $black_list
32 * Les champs à ignorer
33 * @param array|null $set
34 * array : Tableau des champs postés
35 * null : Les champs sont obtenus par des _request() sur les noms de la white liste
37 * true : Recupère tous les champs de white_list meme ceux n'ayant pas ete postés
39 * Tableau des champs et valeurs collectées
41 function collecter_requests($white_list, $black_list = array(), $set = null, $tous = false) {
45 foreach ($white_list as $champ) {
46 // on ne collecte que les champs reellement envoyes par defaut.
47 // le cas d'un envoi de valeur NULL peut du coup poser probleme.
48 $val = _request($champ);
49 if ($tous or $val !== null) {
53 // on ajoute toujours la lang en saisie possible
54 // meme si pas prevu au depart pour l'objet concerne
55 if ($l = _request('changer_lang')) {
59 foreach ($black_list as $champ) {
67 * Modifie le contenu d'un objet
69 * Fonction generique pour l'API de modification de contenu, qui se
70 * charge entre autres choses d'appeler les pipelines pre_edition
73 * Attention, pour éviter des hacks on interdit des champs
74 * (statut, id_secteur, id_rubrique, id_parent),
75 * mais la securite doit étre assurée en amont
78 * @param string $objet
80 * @param int $id_objet
81 * Identifiant de l'objet
82 * @param array $options
83 * array data : tableau des donnees sources utilisees pour la detection de conflit ($_POST sinon fourni ou si nul)
84 * array nonvide : valeur par defaut des champs que l'on ne veut pas vide
85 * string date_modif : champ a mettre a date('Y-m-d H:i:s') s'il y a modif
86 * string invalideur : id de l'invalideur eventuel
87 * array champs : non documente (utilise seulement par inc/rechercher ?)
88 * string action : action realisee, passee aux pipelines pre/post edition (par defaut 'modifier')
89 * bool indexation : deprecie
90 * @param array|null $c
91 * Couples champ/valeur à modifier
92 * @param string $serveur
93 * Nom du connecteur à la base de données
95 * - false : Aucune modification, aucun champ n'est à modifier
96 * - chaîne vide : Vide si tout s'est bien passé
97 * - chaîne : Texte d'un message d'erreur
99 function objet_modifier_champs($objet, $id_objet, $options, $c = null, $serveur = '') {
100 if (!$id_objet = intval($id_objet)) {
101 spip_log('Erreur $id_objet non defini', 'warn');
103 return _T('erreur_technique_enregistrement_impossible');
106 include_spip('inc/filtres');
108 $table_objet = table_objet($objet, $serveur);
109 $spip_table_objet = table_objet_sql($objet, $serveur);
110 $id_table_objet = id_table_objet($objet, $serveur);
111 $trouver_table = charger_fonction('trouver_table', 'base');
112 $desc = $trouver_table($spip_table_objet, $serveur);
114 // Appels incomplets (sans $c)
116 spip_log('erreur appel objet_modifier_champs(' . $objet . '), manque $c');
118 return _T('erreur_technique_enregistrement_impossible');
121 // Securite : certaines variables ne sont jamais acceptees ici
122 // car elles ne relevent pas de autoriser(xxx, modifier) ;
123 // il faut passer par instituer_XX()
124 // TODO: faut-il passer ces variables interdites
125 // dans un fichier de description separe ?
127 unset($c['id_parent']);
128 unset($c['id_rubrique']);
129 unset($c['id_secteur']);
131 // Gerer les champs non vides
132 if (isset($options['nonvide']) and is_array($options['nonvide'])) {
133 foreach ($options['nonvide'] as $champ => $sinon) {
134 if (isset($c[$champ]) and $c[$champ] === '') {
141 // N'accepter que les champs qui existent
142 // TODO: ici aussi on peut valider les contenus
143 // en fonction du type
145 foreach ($desc['field'] as $champ => $ignore) {
146 if (isset($c[$champ])) {
147 $champs[$champ] = $c[$champ];
151 // Nettoyer les valeurs
152 $champs = array_map('corriger_caracteres', $champs);
154 // Envoyer aux plugins
155 $champs = pipeline('pre_edition',
158 'table' => $spip_table_objet, // compatibilite
159 'table_objet' => $table_objet,
160 'spip_table_objet' => $spip_table_objet,
162 'id_objet' => $id_objet,
163 'champs' => isset($options['champs']) ?
$options['champs'] : array(), // [doc] c'est quoi ?
164 'serveur' => $serveur,
165 'action' => isset($options['action']) ?
$options['action'] : 'modifier'
176 // marquer le fait que l'objet est travaille par toto a telle date
177 if ($GLOBALS['meta']['articles_modif'] != 'non') {
178 include_spip('inc/drapeau_edition');
179 signale_edition($id_objet, $GLOBALS['visiteur_session'], $objet);
182 // Verifier si les mises a jour sont pertinentes, datees, en conflit etc
183 include_spip('inc/editer');
184 if (!isset($options['data']) or is_null($options['data'])){
185 $options['data'] = &$_POST;
187 $conflits = controler_md5($champs, $options['data'], $objet, $id_objet, $serveur);
188 // cas hypothetique : normalement inc/editer verifie en amont le conflit edition
189 // et gere l'interface
190 // ici on ne renvoie donc qu'un messsage d'erreur, au cas ou on y arrive quand meme
192 return _T('titre_conflit_edition');
196 // cas particulier de la langue : passer par instituer_langue_objet
197 if (isset($champs['lang'])) {
198 if ($changer_lang = $champs['lang']) {
200 if (isset($desc['field']['id_rubrique'])) {
201 $parent = ($objet == 'rubrique') ?
'id_parent' : 'id_rubrique';
202 $id_rubrique = sql_getfetsel($parent, $spip_table_objet, "$id_table_objet=" . intval($id_objet));
204 $instituer_langue_objet = charger_fonction('instituer_langue_objet', 'action');
205 $champs['lang'] = $instituer_langue_objet($objet, $id_objet, $id_rubrique, $changer_lang, $serveur);
207 // on laisse 'lang' dans $champs,
208 // ca permet de passer dans le pipeline post_edition et de journaliser
209 // et ca ne gene pas qu'on refasse un sql_updateq dessus apres l'avoir
210 // deja pris en compte
213 // la modif peut avoir lieu
215 // faut-il ajouter date_modif ?
216 if (isset($options['date_modif']) and $options['date_modif']
217 and !isset($champs[$options['date_modif']])
219 $champs[$options['date_modif']] = date('Y-m-d H:i:s');
222 // allez on commit la modif
223 sql_updateq($spip_table_objet, $champs, "$id_table_objet=" . intval($id_objet), $serveur);
225 // on verifie si elle est bien passee
226 $moof = sql_fetsel(array_keys($champs), $spip_table_objet, "$id_table_objet=" . intval($id_objet), array(), array(),
227 '', array(), $serveur);
228 // si difference entre les champs, reperer les champs mal enregistres
229 if ($moof != $champs) {
231 foreach ($moof as $k => $v) {
232 if ($v !== $champs[$k]
233 // ne pas alerter si le champ est numerique est que les valeurs sont equivalentes
234 and (!is_numeric($v) or intval($v) != intval($champs[$k]))
237 $conflits[$k]['post'] = $champs[$k];
238 $conflits[$k]['save'] = $v;
240 // cas specifique MySQL+emoji : si l'un est la
241 // conversion utf8_noplanes de l'autre alors c'est OK
242 if (defined('_MYSQL_NOPLANES') && _MYSQL_NOPLANES
) {
243 include_spip('inc/charsets');
244 if ($v == utf8_noplanes($champs[$k])) {
250 // si un champ n'a pas ete correctement enregistre, loger et retourner une erreur
251 // c'est un cas exceptionnel
253 spip_log("Erreur enregistrement en base $objet/$id_objet champs :" . var_export($conflits, true),
254 'modifier.' . _LOG_CRITIQUE
);
256 return _T('erreur_technique_enregistrement_champs',
257 array('champs' => "<i>'" . implode("'</i>,<i>'", $liste) . "'</i>"));
261 // Invalider les caches
262 if (isset($options['invalideur']) and $options['invalideur']) {
263 include_spip('inc/invalideur');
264 if (is_array($options['invalideur'])) {
265 array_map('suivre_invalideur', $options['invalideur']);
267 suivre_invalideur($options['invalideur']);
271 // Notifications, gestion des revisions...
272 // en standard, appelle |nouvelle_revision ci-dessous
273 pipeline('post_edition',
276 'table' => $spip_table_objet,
277 'table_objet' => $table_objet,
278 'spip_table_objet' => $spip_table_objet,
280 'id_objet' => $id_objet,
281 'champs' => isset($options['champs']) ?
$options['champs'] : array(), // [doc] kesako ?
282 'serveur' => $serveur,
283 'action' => isset($options['action']) ?
$options['action'] : 'modifier'
290 // journaliser l'affaire
291 // message a affiner :-)
292 include_spip('inc/filtres_mini');
293 $qui = isset($GLOBALS['visiteur_session']['nom']) and $GLOBALS['visiteur_session']['nom'] ?
$GLOBALS['visiteur_session']['nom'] : $GLOBALS['ip'];
294 journal(_L($qui . ' a édité l’' . $objet . ' ' . $id_objet . ' (' . join('+',
295 array_diff(array_keys($champs), array('date_modif'))) . ')'), array(
296 'faire' => 'modifier',
308 * Fonction générique pour l'API de modification de contenu
311 * @param string $type
314 * Identifiant de l'objet
315 * @param array $options
317 * @param array|null $c
318 * Couples champ/valeur à modifier
319 * @param string $serveur
320 * Nom du connecteur à la base de données
322 * true si quelque chose est modifié correctement
323 * false sinon (erreur ou aucun champ modifié)
325 function modifier_contenu($type, $id, $options, $c = null, $serveur = '') {
326 $res = objet_modifier_champs($type, $id, $options, $c, $serveur);
328 return ($res === '' ?
true : false);
332 * Crée une modification d'un objet
334 * Wrapper pour remplacer tous les obsoletes revision_xxx
337 * Utiliser objet_modifier();
338 * @uses objet_modifier()
340 * @param string $objet
342 * @param int $id_objet
343 * Identifiant de l'objet
345 * Couples des champs/valeurs modifiées
346 * @return mixed|string
348 function revision_objet($objet, $id_objet, $c = null) {
349 $objet = objet_type($objet); // securite
350 include_spip('action/editer_objet');
352 return objet_modifier($objet, $id_objet, $c);