www/ecrire/inc/modifier.php

   1 <?php
   2
   3 /***************************************************************************\
   4  *  SPIP, Systeme de publication pour l'internet                           *
   5  *                                                                         *
   6  *  Copyright (c) 2001-2014                                                *
   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\Objets\Modifications
  17 **/
  18
  19 if (!defined('_ECRIRE_INC_VERSION')) return;
  20
  21 /**
  22  * Collecte des champs postés
  23  *
  24  * Fonction générique pour la collecte des posts
  25  * dans action/editer_xxx
  26  *
  27  * @param array $white_list
  28  *     Les champs à récupérer
  29  * @param array $black_list
  30  *     Les champs à ignorer
  31  * @param array|null $set
  32  *     array : Tableau des champs postés
  33  *     null  : Les champs sont obtenus par des _request() sur les noms de la white liste
  34  * @param bool $tous
  35  *     true : Recupère tous les champs de white_list meme ceux n'ayant pas ete postés
  36  * @return array
  37  *     Tableau des champs et valeurs collectées
  38  */
  39 function collecter_requests($white_list, $black_list, $set=null, $tous=false){
  40         $c = $set;
  41         if (!$c){
  42                 $c = array();
  43                 foreach($white_list as $champ) {
  44                         // on ne collecte que les champs reellement envoyes par defaut.
  45                         // le cas d'un envoi de valeur NULL peut du coup poser probleme.
  46                         $val = _request($champ);
  47                         if ($tous OR $val !== NULL) {
  48                                 $c[$champ] = $val;
  49                         }
  50                 }
  51                 // on ajoute toujours la lang en saisie possible
  52                 // meme si pas prevu au depart pour l'objet concerne
  53                 if ($l = _request('changer_lang')){
  54                         $c['lang'] = $l;
  55                 }
  56         }
  57         foreach($black_list as $champ) {
  58                 unset($c[$champ]);
  59         }
  60
  61         return $c;
  62 }
  63
  64 /**
  65  * Modifie le contenu d'un objet
  66  *
  67  * Fonction generique pour l'API de modification de contenu, qui se
  68  * charge entre autres choses d'appeler les pipelines pre_edition
  69  * et post_edition
  70  *
  71  * Attention, pour éviter des hacks on interdit des champs
  72  * (statut, id_secteur, id_rubrique, id_parent),
  73  * mais la securite doit étre assurée en amont
  74  *
  75  * @api
  76  * @param string $objet
  77  *     Type d'objet
  78  * @param int $id_objet
  79  *     Identifiant de l'objet
  80  * @param array $options
  81  *     Toutes les options
  82  * @param array|null $c
  83  *     Couples champ/valeur à modifier
  84  * @param string $serveur
  85  *     Nom du connecteur à la base de données
  86  * @return bool|string
  87  *     - false  : Aucune modification, aucun champ n'est à modifier
  88  *     - chaîne vide : Vide si tout s'est bien passé
  89  *     - chaîne : Texte d'un message d'erreur
  90  */
  91 function objet_modifier_champs($objet, $id_objet, $options, $c=null, $serveur='') {
  92         if (!$id_objet = intval($id_objet)) {
  93                 spip_log('Erreur $id_objet non defini', 'warn');
  94                 return _T('erreur_technique_enregistrement_impossible');
  95         }
  96
  97         include_spip('inc/filtres');
  98
  99         $table_objet = table_objet($objet,$serveur);
 100         $spip_table_objet = table_objet_sql($objet,$serveur);
 101         $id_table_objet = id_table_objet($objet,$serveur);
 102         $trouver_table = charger_fonction('trouver_table', 'base');
 103         $desc = $trouver_table($spip_table_objet, $serveur);
 104
 105         // Appels incomplets (sans $c)
 106         if (!is_array($c)) {
 107                 spip_log('erreur appel objet_modifier_champs('.$objet.'), manque $c');
 108                 return _T('erreur_technique_enregistrement_impossible');
 109         }
 110
 111         // Securite : certaines variables ne sont jamais acceptees ici
 112         // car elles ne relevent pas de autoriser(xxx, modifier) ;
 113         // il faut passer par instituer_XX()
 114         // TODO: faut-il passer ces variables interdites
 115         // dans un fichier de description separe ?
 116         unset($c['statut']);
 117         unset($c['id_parent']);
 118         unset($c['id_rubrique']);
 119         unset($c['id_secteur']);
 120
 121         // Gerer les champs non vides
 122         if (isset($options['nonvide']) AND is_array($options['nonvide'])) {
 123                 foreach ($options['nonvide'] as $champ => $sinon) {
 124                         if ($c[$champ] === '') {
 125                                 $c[$champ] = $sinon;
 126                         }
 127                 }
 128         }
 129
 130
 131         // N'accepter que les champs qui existent
 132         // TODO: ici aussi on peut valider les contenus
 133         // en fonction du type
 134         $champs = array();
 135         foreach($desc['field'] as $champ => $ignore)
 136                 if (isset($c[$champ]))
 137                         $champs[$champ] = $c[$champ];
 138
 139         // Nettoyer les valeurs
 140         $champs = array_map('corriger_caracteres', $champs);
 141
 142         // Envoyer aux plugins
 143         $champs = pipeline('pre_edition',
 144                 array(
 145                         'args' => array(
 146                                 'table' => $spip_table_objet, // compatibilite
 147                                 'table_objet' => $table_objet,
 148                                 'spip_table_objet' => $spip_table_objet,
 149                                 'type' =>$objet,
 150                                 'id_objet' => $id_objet,
 151                                 'champs' => isset($options['champs']) ? $options['champs'] : array(), // [doc] c'est quoi ?
 152                                 'serveur' => $serveur,
 153                                 'action' => 'modifier'
 154                         ),
 155                         'data' => $champs
 156                 )
 157         );
 158
 159         if (!$champs) return false;
 160
 161
 162         // marquer le fait que l'objet est travaille par toto a telle date
 163         if ($GLOBALS['meta']['articles_modif'] != 'non') {
 164                 include_spip('inc/drapeau_edition');
 165                 signale_edition ($id_objet, $GLOBALS['visiteur_session'], $objet);
 166         }
 167
 168         // Verifier si les mises a jour sont pertinentes, datees, en conflit etc
 169         include_spip('inc/editer');
 170         $conflits = controler_md5($champs, $_POST, $objet, $id_objet, $serveur);
 171         // cas hypothetique : normalement inc/editer verifie en amont le conflit edition
 172         // et gere l'interface
 173         // ici on ne renvoie donc qu'un messsage d'erreur, au cas ou on y arrive quand meme
 174         if ($conflits)
 175                 return _T('titre_conflit_edition');
 176
 177         if ($champs) {
 178                 // cas particulier de la langue : passer par instituer_langue_objet
 179                 if (isset($champs['lang'])){
 180                         if ($changer_lang=$champs['lang']){
 181                                 $id_rubrique = 0;
 182                                 if ($desc['field']['id_rubrique']){
 183                                         $parent = ($objet=='rubrique')?'id_parent':'id_rubrique';
 184                                         $id_rubrique = sql_getfetsel($parent, $spip_table_objet, "$id_table_objet=".intval($id_objet));
 185                                 }
 186                                 $instituer_langue_objet = charger_fonction('instituer_langue_objet','action');
 187                                 $champs['lang'] = $instituer_langue_objet($objet,$id_objet, $id_rubrique, $changer_lang);
 188                         }
 189                         // on laisse 'lang' dans $champs,
 190                         // ca permet de passer dans le pipeline post_edition et de journaliser
 191                         // et ca ne gene pas qu'on refasse un sql_updateq dessus apres l'avoir
 192                         // deja pris en compte
 193                 }
 194
 195                 // la modif peut avoir lieu
 196
 197                 // faut-il ajouter date_modif ?
 198                 if (isset($options['date_modif']) AND $options['date_modif']
 199                 AND !isset($champs[$options['date_modif']]))
 200                         $champs[$options['date_modif']] = date('Y-m-d H:i:s');
 201
 202                 // allez on commit la modif
 203                 sql_updateq($spip_table_objet, $champs, "$id_table_objet=".intval($id_objet), $serveur);
 204
 205                 // on verifie si elle est bien passee
 206                 $moof = sql_fetsel(array_keys($champs), $spip_table_objet, "$id_table_objet=".intval($id_objet), array(), array(), '', array(), $serveur);
 207                 // si difference entre les champs, reperer les champs mal enregistres
 208                 if ($moof != $champs) {
 209                         $liste = array();
 210                         foreach($moof as $k=>$v)
 211                                 if ($v !== $champs[$k]
 212                                         // ne pas alerter si le champ est numerique est que les valeurs sont equivalentes
 213                                         AND (!is_numeric($v) OR intval($v)!=intval($champs[$k]))
 214                                         ) {
 215                                         $liste[] = $k;
 216                                         $conflits[$k]['post'] = $champs[$k];
 217                                         $conflits[$k]['save'] = $v;
 218                                 }
 219                         // si un champ n'a pas ete correctement enregistre, loger et retourner une erreur
 220                         // c'est un cas exceptionnel
 221                         if (count($liste)){
 222                                 spip_log("Erreur enregistrement en base $objet/$id_objet champs :".var_export($conflits,true),'modifier.'._LOG_CRITIQUE);
 223                                 return _T('erreur_technique_enregistrement_champs',array('champs'=>"<i>'".implode("'</i>,<i>'",$liste)."'</i>"));
 224                         }
 225                 }
 226
 227                 // Invalider les caches
 228                 if (isset($options['invalideur']) and $options['invalideur']) {
 229                         include_spip('inc/invalideur');
 230                         if (is_array($options['invalideur']))
 231                                 array_map('suivre_invalideur',$options['invalideur']);
 232                         else
 233                                 suivre_invalideur($options['invalideur']);
 234                 }
 235
 236                 // Notifications, gestion des revisions...
 237                 // en standard, appelle |nouvelle_revision ci-dessous
 238                 pipeline('post_edition',
 239                         array(
 240                                 'args' => array(
 241                                         'table' => $spip_table_objet,
 242                                         'table_objet' => $table_objet,
 243                                         'spip_table_objet' => $spip_table_objet,
 244                                         'type' =>$objet,
 245                                         'id_objet' => $id_objet,
 246                                         'champs' => isset($options['champs']) ? $options['champs'] : array(), // [doc] kesako ?
 247                                         'serveur' => $serveur,
 248                                         'action' => 'modifier'
 249                                 ),
 250                                 'data' => $champs
 251                         )
 252                 );
 253         }
 254
 255         // journaliser l'affaire
 256         // message a affiner :-)
 257         include_spip('inc/filtres_mini');
 258         $qui = ((isset($GLOBALS['visiteur_session']['nom']) AND $GLOBALS['visiteur_session']['nom'])?$GLOBALS['visiteur_session']['nom']:$GLOBALS['ip']);
 259         journal(_L($qui.' a &#233;dit&#233; l&#8217;'.$objet.' '.$id_objet.' ('.join('+',array_diff(array_keys($champs), array('date_modif'))).')'), array(
 260                 'faire' => 'modifier',
 261                 'quoi' => $objet,
 262                 'id' => $id_objet
 263         ));
 264
 265         return '';
 266 }
 267
 268 /**
 269  * Modifie un contenu
 270  *
 271  * Dépreciée :
 272  * Fonction générique pour l'API de modification de contenu
 273  *
 274  * @deprecated
 275  * @param string $type
 276  *     Type d'objet
 277  * @param int $id
 278  *     Identifiant de l'objet
 279  * @param array $options
 280  *     Toutes les options
 281  * @param array|null $c
 282  *     Couples champ/valeur à modifier
 283  * @param string $serveur
 284  *     Nom du connecteur à la base de données
 285  * @return bool
 286  *     true si quelque chose est modifié correctement
 287  *     false sinon (erreur ou aucun champ modifié)
 288  */
 289 function modifier_contenu($type, $id, $options, $c=null, $serveur='') {
 290         $res = objet_modifier_champs($type, $id, $options, $c, $serveur);
 291         return ($res===''?true:false);
 292 }
 293
 294 /**
 295  * Crée une modification d'un objet
 296  *
 297  * Wrapper pour remplacer tous les obsoletes revision_xxx
 298  *
 299  * @deprecated
 300  *     Utiliser objet_modifier();
 301  * @see objet_modifier();
 302  *
 303  * @param string $objet
 304  *     Nom de l'objet
 305  * @param int $id_objet
 306  *     Identifiant de l'objet
 307  * @param array $c
 308  *     Couples des champs/valeurs modifiées
 309  * @return mixed|string
 310  */
 311 function revision_objet($objet,$id_objet,$c=null){
 312         $objet = objet_type($objet); // securite
 313         include_spip('action/editer_objet');
 314         return objet_modifier($objet,$id_objet,$c);
 315 }
 316
 317
 318 ?>