www/ecrire/inc/modifier.php

   1 <?php
   2
   3 /***************************************************************************\
   4  *  SPIP, Systeme de publication pour l'internet                           *
   5  *                                                                         *
   6  *  Copyright (c) 2001-2019                                                *
   7  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
   8  *                                                                         *
   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 \***************************************************************************/
  12
  13 /**
  14  * Fonctions d'aides pour les fonctions d'objets de modification de contenus
  15  *
  16  * @package SPIP\Core\Objets\Modifications
  17  **/
  18
  19 if (!defined('_ECRIRE_INC_VERSION')) {
  20         return;
  21 }
  22
  23 /**
  24  * Collecte des champs postés
  25  *
  26  * Fonction générique pour la collecte des posts
  27  * dans action/editer_xxx
  28  *
  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
  36  * @param bool $tous
  37  *     true : Recupère tous les champs de white_list meme ceux n'ayant pas ete postés
  38  * @return array
  39  *     Tableau des champs et valeurs collectées
  40  */
  41 function collecter_requests($white_list, $black_list = array(), $set = null, $tous = false) {
  42         $c = $set;
  43         if (!$c) {
  44                 $c = array();
  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) {
  50                                 $c[$champ] = $val;
  51                         }
  52                 }
  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')) {
  56                         $c['lang'] = $l;
  57                 }
  58         }
  59         foreach ($black_list as $champ) {
  60                 unset($c[$champ]);
  61         }
  62
  63         return $c;
  64 }
  65
  66 /**
  67  * Modifie le contenu d'un objet
  68  *
  69  * Fonction generique pour l'API de modification de contenu, qui se
  70  * charge entre autres choses d'appeler les pipelines pre_edition
  71  * et post_edition
  72  *
  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
  76  *
  77  * @api
  78  * @param string $objet
  79  *     Type d'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
  94  * @return bool|string
  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
  98  */
  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');
 102
 103                 return _T('erreur_technique_enregistrement_impossible');
 104         }
 105
 106         include_spip('inc/filtres');
 107
 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);
 113
 114         // Appels incomplets (sans $c)
 115         if (!is_array($c)) {
 116                 spip_log('erreur appel objet_modifier_champs(' . $objet . '), manque $c');
 117
 118                 return _T('erreur_technique_enregistrement_impossible');
 119         }
 120
 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 ?
 126         unset($c['statut']);
 127         unset($c['id_parent']);
 128         unset($c['id_rubrique']);
 129         unset($c['id_secteur']);
 130
 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] === '') {
 135                                 $c[$champ] = $sinon;
 136                         }
 137                 }
 138         }
 139
 140
 141         // N'accepter que les champs qui existent
 142         // TODO: ici aussi on peut valider les contenus
 143         // en fonction du type
 144         $champs = array();
 145         foreach ($desc['field'] as $champ => $ignore) {
 146                 if (isset($c[$champ])) {
 147                         $champs[$champ] = $c[$champ];
 148                 }
 149         }
 150
 151         // Nettoyer les valeurs
 152         $champs = array_map('corriger_caracteres', $champs);
 153
 154         // Envoyer aux plugins
 155         $champs = pipeline('pre_edition',
 156                 array(
 157                         'args' => array(
 158                                 'table' => $spip_table_objet, // compatibilite
 159                                 'table_objet' => $table_objet,
 160                                 'spip_table_objet' => $spip_table_objet,
 161                                 'type' => $objet,
 162                                 'id_objet' => $id_objet,
 163                                 'data' => isset($options['data']) ? $options['data'] : null,
 164                                 'champs' => isset($options['champs']) ? $options['champs'] : array(), // [doc] c'est quoi ?
 165                                 'serveur' => $serveur,
 166                                 'action' => isset($options['action']) ? $options['action'] : 'modifier'
 167                         ),
 168                         'data' => $champs
 169                 )
 170         );
 171
 172         if (!$champs) {
 173                 return false;
 174         }
 175
 176
 177         // marquer le fait que l'objet est travaille par toto a telle date
 178         if ($GLOBALS['meta']['articles_modif'] != 'non') {
 179                 include_spip('inc/drapeau_edition');
 180                 signale_edition($id_objet, $GLOBALS['visiteur_session'], $objet);
 181         }
 182
 183         // Verifier si les mises a jour sont pertinentes, datees, en conflit etc
 184         include_spip('inc/editer');
 185         if (!isset($options['data']) or is_null($options['data'])){
 186                 $options['data'] = &$_POST;
 187         }
 188         $conflits = controler_md5($champs, $options['data'], $objet, $id_objet, $serveur);
 189         // cas hypothetique : normalement inc/editer verifie en amont le conflit edition
 190         // et gere l'interface
 191         // ici on ne renvoie donc qu'un messsage d'erreur, au cas ou on y arrive quand meme
 192         if ($conflits) {
 193                 return _T('titre_conflit_edition');
 194         }
 195
 196         if ($champs) {
 197                 // cas particulier de la langue : passer par instituer_langue_objet
 198                 if (isset($champs['lang'])) {
 199                         if ($changer_lang = $champs['lang']) {
 200                                 $id_rubrique = 0;
 201                                 if (isset($desc['field']['id_rubrique'])) {
 202                                         $parent = ($objet == 'rubrique') ? 'id_parent' : 'id_rubrique';
 203                                         $id_rubrique = sql_getfetsel($parent, $spip_table_objet, "$id_table_objet=" . intval($id_objet));
 204                                 }
 205                                 $instituer_langue_objet = charger_fonction('instituer_langue_objet', 'action');
 206                                 $champs['lang'] = $instituer_langue_objet($objet, $id_objet, $id_rubrique, $changer_lang, $serveur);
 207                         }
 208                         // on laisse 'lang' dans $champs,
 209                         // ca permet de passer dans le pipeline post_edition et de journaliser
 210                         // et ca ne gene pas qu'on refasse un sql_updateq dessus apres l'avoir
 211                         // deja pris en compte
 212                 }
 213
 214                 // la modif peut avoir lieu
 215
 216                 // faut-il ajouter date_modif ?
 217                 if (isset($options['date_modif']) and $options['date_modif']
 218                         and !isset($champs[$options['date_modif']])
 219                 ) {
 220                         $champs[$options['date_modif']] = date('Y-m-d H:i:s');
 221                 }
 222
 223                 // allez on commit la modif
 224                 sql_updateq($spip_table_objet, $champs, "$id_table_objet=" . intval($id_objet), $serveur);
 225
 226                 // on verifie si elle est bien passee
 227                 $moof = sql_fetsel(array_keys($champs), $spip_table_objet, "$id_table_objet=" . intval($id_objet), array(), array(),
 228                         '', array(), $serveur);
 229                 // si difference entre les champs, reperer les champs mal enregistres
 230                 if ($moof != $champs) {
 231                         $liste = array();
 232                         foreach ($moof as $k => $v) {
 233                                 if ($v !== $champs[$k]
 234                                         // ne pas alerter si le champ est numerique est que les valeurs sont equivalentes
 235                                         and (!is_numeric($v) or intval($v) != intval($champs[$k]))
 236                                 ) {
 237                                         $liste[] = $k;
 238                                         $conflits[$k]['post'] = $champs[$k];
 239                                         $conflits[$k]['save'] = $v;
 240
 241                                         // cas specifique MySQL+emoji : si l'un est la
 242                                         // conversion utf8_noplanes de l'autre alors c'est OK
 243                                         if (defined('_MYSQL_NOPLANES') && _MYSQL_NOPLANES) {
 244                                                 include_spip('inc/charsets');
 245                                                 if ($v == utf8_noplanes($champs[$k])) {
 246                                                         array_pop($liste);
 247                                                 }
 248                                         }
 249                                 }
 250                         }
 251                         // si un champ n'a pas ete correctement enregistre, loger et retourner une erreur
 252                         // c'est un cas exceptionnel
 253                         if (count($liste)) {
 254                                 spip_log("Erreur enregistrement en base $objet/$id_objet champs :" . var_export($conflits, true),
 255                                         'modifier.' . _LOG_CRITIQUE);
 256
 257                                 return _T('erreur_technique_enregistrement_champs',
 258                                         array('champs' => "<i>'" . implode("'</i>,<i>'", $liste) . "'</i>"));
 259                         }
 260                 }
 261
 262                 // Invalider les caches
 263                 if (isset($options['invalideur']) and $options['invalideur']) {
 264                         include_spip('inc/invalideur');
 265                         if (is_array($options['invalideur'])) {
 266                                 array_map('suivre_invalideur', $options['invalideur']);
 267                         } else {
 268                                 suivre_invalideur($options['invalideur']);
 269                         }
 270                 }
 271
 272                 // Notifications, gestion des revisions...
 273                 // en standard, appelle |nouvelle_revision ci-dessous
 274                 pipeline('post_edition',
 275                         array(
 276                                 'args' => array(
 277                                         'table' => $spip_table_objet,
 278                                         'table_objet' => $table_objet,
 279                                         'spip_table_objet' => $spip_table_objet,
 280                                         'type' => $objet,
 281                                         'id_objet' => $id_objet,
 282                                         'champs' => isset($options['champs']) ? $options['champs'] : array(), // [doc] kesako ?
 283                                         'serveur' => $serveur,
 284                                         'action' => isset($options['action']) ? $options['action'] : 'modifier'
 285                                 ),
 286                                 'data' => $champs
 287                         )
 288                 );
 289         }
 290
 291         // journaliser l'affaire
 292         // message a affiner :-)
 293         include_spip('inc/filtres_mini');
 294         $qui = isset($GLOBALS['visiteur_session']['nom']) and $GLOBALS['visiteur_session']['nom'] ? $GLOBALS['visiteur_session']['nom'] : $GLOBALS['ip'];
 295         journal(_L($qui . ' a &#233;dit&#233; l&#8217;' . $objet . ' ' . $id_objet . ' (' . join('+',
 296                         array_diff(array_keys($champs), array('date_modif'))) . ')'), array(
 297                 'faire' => 'modifier',
 298                 'quoi' => $objet,
 299                 'id' => $id_objet
 300         ));
 301
 302         return '';
 303 }
 304
 305 /**
 306  * Modifie un contenu
 307  *
 308  * Dépreciée :
 309  * Fonction générique pour l'API de modification de contenu
 310  *
 311  * @deprecated
 312  * @param string $type
 313  *     Type d'objet
 314  * @param int $id
 315  *     Identifiant de l'objet
 316  * @param array $options
 317  *     Toutes les options
 318  * @param array|null $c
 319  *     Couples champ/valeur à modifier
 320  * @param string $serveur
 321  *     Nom du connecteur à la base de données
 322  * @return bool
 323  *     true si quelque chose est modifié correctement
 324  *     false sinon (erreur ou aucun champ modifié)
 325  */
 326 function modifier_contenu($type, $id, $options, $c = null, $serveur = '') {
 327         $res = objet_modifier_champs($type, $id, $options, $c, $serveur);
 328
 329         return ($res === '' ? true : false);
 330 }
 331
 332 /**
 333  * Crée une modification d'un objet
 334  *
 335  * Wrapper pour remplacer tous les obsoletes revision_xxx
 336  *
 337  * @deprecated
 338  *     Utiliser objet_modifier();
 339  * @uses objet_modifier()
 340  *
 341  * @param string $objet
 342  *     Nom de l'objet
 343  * @param int $id_objet
 344  *     Identifiant de l'objet
 345  * @param array $c
 346  *     Couples des champs/valeurs modifiées
 347  * @return mixed|string
 348  */
 349 function revision_objet($objet, $id_objet, $c = null) {
 350         $objet = objet_type($objet); // securite
 351         include_spip('action/editer_objet');
 352
 353         return objet_modifier($objet, $id_objet, $c);
 354 }