www/plugins-dist/revisions/inc/revisions_pipeline.php

   1 <?php
   2
   3 /***************************************************************************\
   4  *  SPIP, Systeme de publication pour l'internet                           *
   5  *                                                                         *
   6  *  Copyright (c) 2001-2016                                                *
   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  * Pipelines utilisés du plugin révisions
  15  *
  16  * @package SPIP\Revisions\Pipelines
  17  **/
  18 if (!defined('_ECRIRE_INC_VERSION')) {
  19         return;
  20 }
  21
  22
  23 /**
  24  * Ajoute dans le bloc d'info d'un objet un bouton permettant d'aller voir
  25  * l'historique de ses révisions
  26  *
  27  * @param array $flux Données du pipeline
  28  * @return array $flux  Données du pipeline
  29  */
  30 function revisions_boite_infos($flux) {
  31         $type = $flux['args']['type'];
  32         if ($id = intval($flux['args']['id'])
  33                 and $tables = unserialize($GLOBALS['meta']['objets_versions'])
  34                 and in_array(table_objet_sql($type), $tables)
  35                 and autoriser('voirrevisions', $type, $id)
  36                 // regarder le numero de revision le plus eleve, et afficher le bouton
  37                 // si c'est interessant (id_version>1)
  38                 and sql_countsel('spip_versions', 'id_objet=' . intval($id) . ' AND objet = ' . sql_quote($type)) > 1
  39         ) {
  40                 include_spip('inc/presentation');
  41                 $flux['data'] .= icone_horizontale(_T('revisions:info_historique_lien'),
  42                         generer_url_ecrire('revision', "id_objet=$id&objet=$type"), "revision-24.png");
  43         }
  44
  45         return $flux;
  46 }
  47
  48 /**
  49  * Afficher les dernières révisions sur l'accueil et le suivi
  50  *
  51  * Liste les révisions en bas de la page d'accueil de ecrire/
  52  * et sur la page de suivi de l'activité du site
  53  *
  54  * @param array $flux Données du pipeline
  55  * @return array $flux  Données du pipeline
  56  */
  57 function revisions_affiche_milieu($flux) {
  58         // la bonne page et des objets révisables cochées !
  59         if (in_array($flux['args']['exec'], array('accueil', 'suivi_edito'))
  60                 and unserialize($GLOBALS['meta']['objets_versions'])
  61         ) {
  62                 $contexte = array();
  63                 if ($GLOBALS['visiteur_session']['statut'] !== '0minirezo') {
  64                         $contexte['id_auteur'] = $GLOBALS['visiteur_session']['id_auteur'];
  65                 }
  66                 $flux['data'] .= recuperer_fond('prive/objets/liste/versions', $contexte, array('ajax' => true));
  67         }
  68
  69         return $flux;
  70 }
  71
  72 /**
  73  * Définir les metas de configuration liées aux révisions
  74  *
  75  * Utilisé par inc/config
  76  *
  77  * @param array $metas Liste des métas et leurs valeurs par défaut
  78  * @return array        Liste des métas et leurs valeurs par défaut
  79  */
  80 function revisions_configurer_liste_metas($metas) {
  81         // Dorénavant dans les metas on utilisera un array serialisé de types d'objets
  82         // qui correspondront aux objets versionnés
  83         $metas['objets_versions'] = '';
  84
  85         return $metas;
  86 }
  87
  88
  89 /**
  90  * Charge les données d'une révision donnée dans le formulaire d'édition d'un objet
  91  *
  92  * @param array $flux Données du pipeline
  93  * @return array $flux  Données du pipeline
  94  */
  95 function revisions_formulaire_charger($flux) {
  96         if (strncmp($flux['args']['form'], 'editer_', 7) == 0
  97                 and $id_version = _request('id_version')
  98                 and $objet = substr($flux['args']['form'], 7)
  99                 and $id_table_objet = id_table_objet($objet)
 100                 and isset($flux['data'][$id_table_objet])
 101                 and $id = intval($flux['data'][$id_table_objet])
 102                 and !$flux['args']['je_suis_poste']
 103         ) {
 104                 // ajouter un message convival pour indiquer qu'on a restaure la version
 105                 $flux['data']['message_ok'] = _T('revisions:icone_restaurer_version', array('version' => $id_version));
 106                 $flux['data']['message_ok'] .= "<br />" . _T('revisions:message_valider_recuperer_version');
 107                 // recuperer la version
 108                 include_spip('inc/revisions');
 109                 #$champs = recuperer_version_complete($id, $objet, $id_version);
 110                 $champs = recuperer_version($id, $objet, $id_version);
 111                 foreach ($champs as $champ => $valeur) {
 112                         if (!strncmp($champ, 'jointure_', 9) == 0) {
 113                                 if ($champ == 'id_rubrique') {
 114                                         $flux['data']['id_parent'] = $valeur;
 115                                 } else {
 116                                         $flux['data'][$champ] = $valeur;
 117                                 }
 118                         }
 119                 }
 120         }
 121
 122         return $flux;
 123 }
 124
 125
 126 /**
 127  * Sur une insertion en base, lever un flag pour ne pas creer une premiere révision vide
 128  * dans pre_edition mais attendre la post_edition pour cela
 129  *
 130  * @param array $x Données du pipeline
 131  * @return array $x  Données du pipeline
 132  */
 133 function revisions_post_insertion($x) {
 134         $table = $x['args']['table'];
 135         include_spip('inc/revisions');
 136         if ($champs = liste_champs_versionnes($table)) {
 137                 $GLOBALS['premiere_revision']["$table:" . $x['args']['id_objet']] = true;
 138         }
 139
 140         return $x;
 141 }
 142
 143 /**
 144  * Avant toute modification en base
 145  * vérifier qu'une version initiale existe bien pour cet objet
 146  * et la creer sinon avec l'etat actuel de l'objet
 147  *
 148  * @param array $x Données du pipeline
 149  * @return array $x  Données du pipeline
 150  */
 151 function revisions_pre_edition($x) {
 152         // ne rien faire quand on passe ici en controle md5
 153         if (!isset($x['args']['action'])
 154                 or $x['args']['action'] !== 'controler'
 155         ) {
 156                 $table = $x['args']['table'];
 157                 include_spip('inc/revisions');
 158                 // si flag leve passer son chemin, post_edition le fera (mais baisser le flag en le gardant en memoire tout de meme)
 159                 if (isset($GLOBALS['premiere_revision']["$table:" . $x['args']['id_objet']])) {
 160                         $GLOBALS['premiere_revision']["$table:" . $x['args']['id_objet']] = 0;
 161                 } // sinon creer une premiere revision qui date et dont on ne connait pas l'auteur
 162                 elseif ($versionnes = liste_champs_versionnes($table)) {
 163                         $objet = isset($x['args']['type']) ? $x['args']['type'] : objet_type($table);
 164                         verifier_premiere_revision($table, $objet, $x['args']['id_objet'], $versionnes, -1);
 165                 }
 166         }
 167
 168         return $x;
 169 }
 170
 171 /**
 172  * Avant modification en base d'un lien,
 173  * enregistrer une première révision de l'objet si nécessaire
 174  *
 175  * @param array $x Données du pipeline
 176  * @return array $x  Données du pipeline
 177  */
 178 function revisions_pre_edition_lien($x) {
 179         if (intval($x['args']['id_objet_source']) > 0
 180                 and intval($x['args']['id_objet']) > 0
 181         ) {
 182                 $table = table_objet_sql($x['args']['objet']);
 183                 $id_objet = intval($x['args']['id_objet']);
 184                 include_spip('inc/revisions');
 185                 if (isset($GLOBALS['premiere_revision']["$table:" . $id_objet])) {
 186                         $GLOBALS['premiere_revision']["$table:" . $id_objet] = 0;
 187                 } // ex : si le champ jointure_mots est versionnable sur les articles
 188                 elseif ($versionnes = liste_champs_versionnes($table)
 189                         and in_array($j = 'jointure_' . table_objet($x['args']['objet_source']), $versionnes)
 190                 ) {
 191                         verifier_premiere_revision($table, $x['args']['objet'], $id_objet, $versionnes, -1);
 192                 }
 193
 194                 $table = table_objet_sql($x['args']['objet_source']);
 195                 $id_objet = $x['args']['id_objet_source'];
 196                 if (isset($GLOBALS['premiere_revision']["$table:" . $id_objet])) {
 197                         $GLOBALS['premiere_revision']["$table:" . $id_objet] = 0;
 198                 } // ex : si le champ jointure_articles est versionnable sur les mots
 199                 elseif ($versionnes = liste_champs_versionnes($table)
 200                         and in_array($j = 'jointure_' . table_objet($x['args']['objet']), $versionnes)
 201                 ) {
 202                         verifier_premiere_revision($table, $x['args']['objet_source'], $id_objet, $versionnes, -1);
 203                 }
 204         }
 205
 206         return $x;
 207 }
 208
 209 /**
 210  * Après modification en base, versionner l'objet
 211  *
 212  * @param array $x Données du pipeline
 213  * @return array $x  Données du pipeline
 214  */
 215 function revisions_post_edition($x) {
 216         include_spip('inc/revisions');
 217         if (isset($x['args']['table']) and $versionnes = liste_champs_versionnes($x['args']['table'])) {
 218                 // Regarder si au moins une des modifs est versionnable
 219                 $champs = array();
 220                 $table = $x['args']['table'];
 221                 $objet = isset($x['args']['type']) ? $x['args']['type'] : objet_type($table);
 222                 include_spip('inc/session');
 223
 224                 if (isset($GLOBALS['premiere_revision']["$table:" . $x['args']['id_objet']])) {
 225                         unset($GLOBALS['premiere_revision']["$table:" . $x['args']['id_objet']]);
 226                         // verifier la premiere version : sur une version initiale on attend ici pour la creer
 227                         // plutot que de creer une version vide+un diff
 228                         verifier_premiere_revision($table, $objet, $x['args']['id_objet'], $versionnes, session_get('id_auteur'));
 229                 } else {
 230                         // on versionne les differences
 231                         foreach ($versionnes as $key) {
 232                                 if (isset($x['data'][$key])) {
 233                                         $champs[$key] = $x['data'][$key];
 234                                 }
 235                         }
 236
 237                         if (count($champs)) {
 238                                 ajouter_version($x['args']['id_objet'], $objet, $champs, '', session_get('id_auteur'));
 239                         }
 240                 }
 241         }
 242
 243         return $x;
 244 }
 245
 246
 247 /**
 248  * Après modification en base d'un lien, versionner l'objet si nécessaire
 249  *
 250  * @param array $x Données du pipeline
 251  * @return array $x  Données du pipeline
 252  */
 253 function revisions_post_edition_lien($x) {
 254         /*pipeline('post_edition_lien',
 255                 array(
 256                         'args' => array(
 257                                 'table_lien' => $table_lien,
 258                                 'objet_source' => $objet_source,
 259                                 'id_objet_source' => $l[$primary],
 260                                 'objet' => $l['objet'],
 261                                 'id_objet' => $id_o,
 262                                 'action'=>'delete',
 263                         ),
 264                         'data' => $couples
 265                 )
 266         */
 267         if (intval($x['args']['id_objet_source']) > 0
 268                 and intval($x['args']['id_objet']) > 0
 269         ) {
 270
 271                 $table = table_objet_sql($x['args']['objet']);
 272                 $id_objet = $x['args']['id_objet'];
 273                 include_spip('inc/revisions');
 274                 if (isset($GLOBALS['premiere_revision']["$table:" . $id_objet])) {
 275                         $GLOBALS['premiere_revision']["$table:" . $id_objet] = 0;
 276                 } // ex : si le champ jointure_mots est versionnable sur les articles
 277                 elseif ($versionnes = liste_champs_versionnes($table)
 278                         and in_array($j = 'jointure_' . table_objet($x['args']['objet_source']), $versionnes)
 279                 ) {
 280                         $champs = array(
 281                                 $j => recuperer_valeur_champ_jointure($x['args']['objet'], $id_objet, $x['args']['objet_source'])
 282                         );
 283                         ajouter_version($id_objet, $x['args']['objet'], $champs, '', $GLOBALS['visiteur_session']['id_auteur']);
 284                 }
 285
 286                 $table = table_objet_sql($x['args']['objet_source']);
 287                 $id_objet = $x['args']['id_objet_source'];
 288                 if (isset($GLOBALS['premiere_revision']["$table:" . $id_objet])) {
 289                         $GLOBALS['premiere_revision']["$table:" . $id_objet] = 0;
 290                 } // ex : si le champ jointure_articles est versionnable sur les mots
 291                 elseif ($versionnes = liste_champs_versionnes($table)
 292                         and in_array($j = 'jointure_' . table_objet($x['args']['objet']), $versionnes)
 293                 ) {
 294                         $champs = array(
 295                                 $j => recuperer_valeur_champ_jointure($x['args']['objet_source'], $id_objet, $x['args']['objet'])
 296                         );
 297                         ajouter_version($id_objet, $x['args']['objet_source'], $champs, '', $GLOBALS['visiteur_session']['id_auteur']);
 298                 }
 299         }
 300
 301         return $x;
 302 }
 303
 304 /**
 305  * Ajoute la tâche d'optimisation des tables dans la liste des tâches périodiques
 306  *
 307  * @pipeline taches_generales_cron
 308  *
 309  * @param array $taches_generales
 310  *     Tableau des tâches et leur périodicité en seconde
 311  * @return array
 312  *     Tableau des tâches et leur périodicité en seconde
 313  */
 314 function revisions_taches_generales_cron($taches_generales) {
 315         $taches_generales['optimiser_revisions'] = 86400;
 316
 317         return $taches_generales;
 318 }