www/ecrire/base/upgrade.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 if (!defined('_ECRIRE_INC_VERSION')) return;
  14
  15 /**
  16  * Programme de mise a jour des tables SQL lors d'un chgt de version.
  17  * L'entree dans cette fonction est reservee au maj de SPIP coeur
  18  *
  19  * Marche aussi pour les plugins en appelant directement la fonction maj_plugin
  20  * Pour que ceux-ci profitent aussi de la reprise sur interruption,
  21  * ils doivent simplement indiquer leur numero de version installee dans une meta
  22  * et fournir le tableau maj a la fonction maj_plugin.
  23  * La reprise sur timeout se fait alors par la page admin_plugin et jamais par ici
  24  *
  25  * http://doc.spip.org/@base_upgrade_dist
  26  *
  27  * @param string $titre
  28  * @param string $reprise
  29  * @return
  30  */
  31 function base_upgrade_dist($titre='', $reprise='')
  32 {
  33         if (!$titre) return; // anti-testeur automatique
  34         if ($GLOBALS['spip_version_base']!=$GLOBALS['meta']['version_installee']) {
  35                 if (!is_numeric(_request('reinstall'))) {
  36                         include_spip('base/create');
  37                         spip_log("recree les tables eventuellement disparues","maj."._LOG_INFO_IMPORTANTE);
  38                         creer_base();
  39                 }
  40
  41                 // quand on rentre par ici, c'est toujours une mise a jour de SPIP
  42                 // lancement de l'upgrade SPIP
  43                 $res = maj_base();
  44
  45                 if ($res) {
  46                         // on arrete tout ici !
  47                         exit;
  48                 }
  49         }
  50         spip_log("Fin de mise a jour SQL. Debut m-a-j acces et config","maj."._LOG_INFO_IMPORTANTE);
  51
  52         // supprimer quelques fichiers temporaires qui peuvent se retrouver invalides
  53         @spip_unlink(_CACHE_RUBRIQUES);
  54         @spip_unlink(_CACHE_PIPELINES);
  55         @spip_unlink(_CACHE_PLUGINS_PATH);
  56         @spip_unlink(_CACHE_PLUGINS_OPT);
  57         @spip_unlink(_CACHE_PLUGINS_FCT);
  58         @spip_unlink(_CACHE_CHEMIN);
  59         @spip_unlink(_DIR_TMP."plugin_xml_cache.gz");
  60
  61         include_spip('inc/auth');
  62         auth_synchroniser_distant();
  63         $config = charger_fonction('config', 'inc');
  64         $config();
  65 }
  66
  67 /**
  68  * MAJ de base de SPIP
  69  *
  70  * http://doc.spip.org/@maj_base
  71  *
  72  * @param int $version_cible
  73  * @param string $redirect
  74  * @return array|bool
  75  */
  76 function maj_base($version_cible = 0, $redirect = '') {
  77         global $spip_version_base;
  78
  79         $version_installee = @$GLOBALS['meta']['version_installee'];
  80         //
  81         // Si version nulle ou inexistante, c'est une nouvelle installation
  82         //   => ne pas passer par le processus de mise a jour.
  83         // De meme en cas de version superieure: ca devait etre un test,
  84         // il y a eu le message d'avertissement il doit savoir ce qu'il fait
  85         //
  86         // version_installee = 1.702; quand on a besoin de forcer une MAJ
  87
  88         spip_log("Version anterieure: $version_installee. Courante: $spip_version_base","maj."._LOG_INFO_IMPORTANTE);
  89         if (!$version_installee OR ($spip_version_base < $version_installee)) {
  90                 sql_replace('spip_meta',
  91                       array('nom' => 'version_installee',
  92                             'valeur' => $spip_version_base,
  93                             'impt' => 'non'));
  94                 return false;
  95         }
  96         if (!upgrade_test()) return true;
  97
  98         $cible = ($version_cible ? $version_cible : $spip_version_base);
  99
 100         if ($version_installee <= 1.926) {
 101                 $n = floor($version_installee * 10);
 102                 while ($n < 19) {
 103                         $nom  = sprintf("v%03d",$n);
 104                         $f = charger_fonction($nom, 'maj', true);
 105                         if ($f) {
 106                                 spip_log( "$f repercute les modifications de la version " . ($n/10),"maj."._LOG_INFO_IMPORTANTE);
 107                                 $f($version_installee, $spip_version_base);
 108                         } else spip_log( "pas de fonction pour la maj $n $nom","maj."._LOG_INFO_IMPORTANTE);
 109                         $n++;
 110                 }
 111                 include_spip('maj/v019_pre193');
 112                 v019_pre193($version_installee, $version_cible);
 113         }
 114         if ($version_installee < 2000) {
 115                 if ($version_installee < 2)
 116                         $version_installee = $version_installee*1000;
 117                 include_spip('maj/v019');
 118         }
 119         if ($cible < 2)
 120                 $cible = $cible*1000;
 121
 122         include_spip('maj/svn10000');
 123         ksort($GLOBALS['maj']);
 124         $res = maj_while($version_installee, $cible, $GLOBALS['maj'], 'version_installee','meta', $redirect, true);
 125         if ($res) {
 126                 if (!is_array($res))
 127                         spip_log("Pb d'acces SQL a la mise a jour","maj."._LOG_INFO_ERREUR);
 128                 else {
 129                         echo _T('avis_operation_echec') . ' ' . join(' ', $res);
 130                         echo install_fin_html();
 131                 }
 132         }
 133         return $res;
 134 }
 135
 136 /**
 137  * Mise à jour d'un plugin de SPIP
 138  *
 139  * Fonction appelée par la fonction de maj d'un plugin.
 140  * On lui fournit un tableau de fonctions élementaires
 141  * dont l'indice est la version
 142  *
 143  * @param string $nom_meta_base_version
 144  *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
 145  * @param string $version_cible
 146  *     Version du schéma de données dans le plugin (déclaré dans paquet.xml)
 147  * @param array $maj
 148  *     Tableau d'actions à faire à l'installation (clé 'create') et pour chaque
 149  *     version intermédiaire entre la version actuelle du schéma du plugin dans SPIP
 150  *     et la version du schéma déclaré dans le plugin (ex. clé '1.1.0').
 151  *
 152  *     Chaque valeur est un tableau contenant une liste de fonctions à exécuter,
 153  *     cette liste étant elle-même un tableau avec premier paramètre le nom de la fonction
 154  *     et les suivant les paramètres à lui passer
 155  *     @example
 156  *        array(
 157  *            'create' => array(
 158  *                array('maj_tables', array('spip_rubriques', 'spip_articles')),
 159  *                array('creer_base)),
 160  *            '1.1.0' => array(
 161  *                array('sql_alter', 'TABLE spip_articles ADD INDEX truc (truc)'))
 162  *        )
 163  * @param string $table_meta
 164  *     Nom de la table meta (sans le prefixe spip_) dans laquelle trouver la meta $nom_meta_base_version
 165  * @return void
 166  */
 167 function maj_plugin($nom_meta_base_version, $version_cible, $maj, $table_meta='meta'){
 168
 169         if ($table_meta!=='meta')
 170                 lire_metas($table_meta);
 171         if ( (!isset($GLOBALS[$table_meta][$nom_meta_base_version]) )
 172                         || (!spip_version_compare($current_version = $GLOBALS[$table_meta][$nom_meta_base_version],$version_cible,'='))){
 173
 174                 // $maj['create'] contient les directives propres a la premiere creation de base
 175                 // c'est une operation derogatoire qui fait aboutir directement dans la version_cible
 176                 if (isset($maj['create'])){
 177                         if (!isset($GLOBALS[$table_meta][$nom_meta_base_version])){
 178                                 // installation : on ne fait que l'operation create
 179                                 $maj = array("init"=>$maj['create']);
 180                                 // et on lui ajoute un appel a inc/config
 181                                 // pour creer les metas par defaut
 182                                 $config = charger_fonction('config','inc');
 183                                 $maj[$version_cible] = array(array($config));
 184                         }
 185                         // dans tous les cas enlever cet index du tableau
 186                         unset($maj['create']);
 187                 }
 188                 // si init, deja dans le bon ordre
 189                 if (!isset($maj['init'])){
 190                         include_spip('inc/plugin'); // pour spip_version_compare
 191                         uksort($maj,'spip_version_compare');
 192                 }
 193
 194                 // la redirection se fait par defaut sur la page d'administration des plugins
 195                 // sauf lorsque nous sommes sur l'installation de SPIP
 196                 // ou define _REDIRECT_MAJ_PLUGIN
 197                 $redirect = (defined('_REDIRECT_MAJ_PLUGIN')?_REDIRECT_MAJ_PLUGIN:generer_url_ecrire('admin_plugin'));
 198                 if (defined('_ECRIRE_INSTALL')) {
 199                         $redirect = parametre_url(generer_url_ecrire('install'),'etape', _request('etape'));
 200                 }
 201
 202                 $res = maj_while($current_version, $version_cible, $maj, $nom_meta_base_version, $table_meta, $redirect);
 203                 if ($res) {
 204                         if (!is_array($res))
 205                                 spip_log("Pb d'acces SQL a la mise a jour","maj."._LOG_INFO_ERREUR);
 206                         else {
 207                                 echo "<p>"._T('avis_operation_echec') . ' ' . join(' ', $res)."</p>";
 208                         }
 209                 }
 210         }
 211 }
 212
 213 /**
 214  * Relancer le hit de maj avant timeout
 215  * si pas de redirect fourni, on redirige vers exec=upgrade pour finir
 216  * ce qui doit etre une maj SPIP
 217  *
 218  * @param string $meta
 219  * @param string $table
 220  * @param string $redirect
 221  * @return void
 222  */
 223 function relance_maj($meta,$table,$redirect=''){
 224         include_spip('inc/headers');
 225         if (!$redirect){
 226                 // recuperer la valeur installee en cours
 227                 // on la tronque numeriquement, elle ne sert pas reellement
 228                 // sauf pour verifier que ce n'est pas oui ou non
 229                 // sinon is_numeric va echouer sur un numero de version 1.2.3
 230                 $installee = intval($GLOBALS[$table][$meta]);
 231                 $redirect = generer_url_ecrire('upgrade',"reinstall=$installee&meta=$meta&table=$table",true);
 232         }
 233         echo redirige_formulaire($redirect);
 234         exit();
 235 }
 236
 237 /**
 238  * Initialiser la page pour l'affichage des progres de l'upgrade
 239  * uniquement si la page n'a pas deja ete initilalisee
 240  *
 241  * @param string $installee
 242  * @param string $meta
 243  * @param string $table
 244  * @return
 245  */
 246 function maj_debut_page($installee,$meta,$table){
 247         static $done = false;
 248         if ($done) return;
 249         include_spip('inc/minipres');
 250         @ini_set("zlib.output_compression","0"); // pour permettre l'affichage au fur et a mesure
 251         $timeout = _UPGRADE_TIME_OUT*2;
 252         $titre = _T('titre_page_upgrade');
 253         $balise_img = charger_filtre('balise_img');
 254         $titre .= $balise_img(chemin_image('searching.gif'));
 255         echo ( install_debut_html($titre));
 256         // script de rechargement auto sur timeout
 257         $redirect = generer_url_ecrire('upgrade',"reinstall=$installee&meta=$meta&table=$table",true);
 258         echo http_script("window.setTimeout('location.href=\"".$redirect."\";',".($timeout*1000).")");
 259         echo "<div style='text-align: left'>\n";
 260         ob_flush();flush();
 261         $done = true;
 262 }
 263
 264 define('_UPGRADE_TIME_OUT', 20);
 265
 266 /**
 267  * A partir des > 1.926 (i.e SPIP > 1.9.2), cette fonction gere les MAJ.
 268  * Se relancer soi-meme pour eviter l'interruption pendant une operation SQL
 269  * (qu'on espere pas trop longue chacune)
 270  * evidemment en ecrivant dans la meta a quel numero on en est.
 271  *
 272  * Cette fonction peut servir aux plugins qui doivent donner comme arguments:
 273  * 1. le numero de version courant (numero de version 1.2.3 ou entier)
 274  * 2. le numero de version a atteindre (numero de version 1.2.3 ou entier)
 275  * 3. le tableau des instructions de mise a jour a executer
 276  * Pour profiter du mecanisme de reprise sur interruption il faut de plus
 277  * 4. le nom de la meta permettant de retrouver tout ca
 278  * 5. la table des meta ou elle se trouve ($table_prefix . '_meta' par defaut)
 279  * (cf debut de fichier)
 280  * en cas d'echec, cette fonction retourne un tableau (etape,sous-etape)
 281  * sinon elle retourne un tableau vide
 282  *
 283  * les fonctions sql_xx appelees lors des maj sont supposees atomiques et ne sont pas relancees
 284  * en cas de timeout
 285  * mais les fonctions specifiques sont relancees jusqu'a ce qu'elles finissent
 286  * elles doivent donc s'assurer de progresser a chaque reprise
 287  *
 288  * http://doc.spip.org/@maj_while
 289  *
 290  * @param  $installee
 291  * @param  $cible
 292  * @param  $maj
 293  * @param string $meta
 294  * @param string $table
 295  * @param string $redirect
 296  * @param bool $debut_page
 297  * @return array
 298  */
 299 function maj_while($installee, $cible, $maj, $meta='', $table='meta', $redirect='', $debut_page = false)
 300 {
 301         # inclusions pour que les procedures d'upgrade disposent des fonctions de base
 302         include_spip('base/create');
 303         include_spip('base/abstract_sql');
 304         $trouver_table = charger_fonction('trouver_table','base');
 305         include_spip('inc/plugin'); // pour spip_version_compare
 306         $n = 0;
 307         $time = time();
 308         // definir le timeout qui peut etre utilise dans les fonctions
 309         // de maj qui durent trop longtemps
 310         define('_TIME_OUT',$time+_UPGRADE_TIME_OUT);
 311
 312         reset($maj);
 313         while (list($v,)=each($maj)) {
 314                 // si une maj pour cette version
 315                 if ($v=='init' OR
 316                         (spip_version_compare($v,$installee,'>')
 317                         AND spip_version_compare($v,$cible,'<='))) {
 318                         if ($debut_page)
 319                                 maj_debut_page($v,$meta,$table);
 320                         echo "MAJ $v";
 321                         $etape = serie_alter($v, $maj[$v], $meta, $table, $redirect);
 322                         $trouver_table(''); // vider le cache des descriptions de table
 323                         # echec sur une etape en cours ?
 324                         # on sort
 325                         if ($etape) return array($v, $etape);
 326                         $n = time() - $time;
 327                         spip_log( "$table $meta: $v en $n secondes",'maj.'._LOG_INFO_IMPORTANTE);
 328                         if ($meta) ecrire_meta($meta, $installee=$v,'oui', $table);
 329                         echo "<br />";
 330                 }
 331                 if (time() >= _TIME_OUT) {
 332                         relance_maj($meta,$table,$redirect);
 333                 }
 334         }
 335         $trouver_table(''); // vider le cache des descriptions de table
 336         // indispensable pour les chgt de versions qui n'ecrivent pas en base
 337         // tant pis pour la redondance eventuelle avec ci-dessus
 338         if ($meta) ecrire_meta($meta, $cible,'oui',$table);
 339         spip_log( "MAJ terminee. $meta: $installee",'maj.'._LOG_INFO_IMPORTANTE);
 340         return array();
 341 }
 342
 343 /**
 344  * Appliquer une serie de chgt qui risquent de partir en timeout
 345  * (Alter cree une copie temporaire d'une table, c'est lourd)
 346  *
 347  * http://doc.spip.org/@serie_alter
 348  *
 349  * @param string $serie
 350  *   numero de version upgrade
 351  * @param array $q
 352  *   tableau des operations pour cette version
 353  * @param string $meta
 354  *   nom de la meta qui contient le numero de version
 355  * @param string $table
 356  *   nom de la table meta
 357  * @param string $redirect
 358  *   url de redirection en cas d'interruption
 359  * @return int
 360  */
 361 function serie_alter($serie, $q = array(), $meta='', $table='meta', $redirect='') {
 362         $meta2 = $meta . '_maj_' . $serie;
 363         $etape = intval(@$GLOBALS[$table][$meta2]);
 364         foreach ($q as $i => $r) {
 365                 if ($i >= $etape) {
 366                         $msg = "maj $table $meta2 etape $i";
 367                         if (is_array($r)
 368                           AND function_exists($f = array_shift($r))) {
 369                                 spip_log( "$msg: $f " . join(',',$r),'maj.'._LOG_INFO_IMPORTANTE);
 370                                 // pour les fonctions atomiques sql_xx
 371                                 // on enregistre le meta avant de lancer la fonction,
 372                                 // de maniere a eviter de boucler sur timeout
 373                                 // mais pour les fonctions complexes,
 374                                 // il faut les rejouer jusqu'a achevement.
 375                                 // C'est a elle d'assurer qu'elles progressent a chaque rappel
 376                                 if (strncmp($f,"sql_",4)==0)
 377                                         ecrire_meta($meta2, $i+1, 'non', $table);
 378                                 echo " <span title='$i'>.</span>";
 379                                 call_user_func_array($f, $r);
 380                                 // si temps imparti depasse, on relance sans ecrire en meta
 381                                 // car on est peut etre sorti sur timeout si c'est une fonction longue
 382                                 if (time() >= _TIME_OUT) {
 383                                         relance_maj($meta,$table,$redirect);
 384                                 }
 385                                 ecrire_meta($meta2, $i+1, 'non', $table);
 386                                 spip_log( "$meta2: ok", 'maj.'._LOG_INFO_IMPORTANTE);
 387                         }
 388                         else {
 389                                 if (!is_array($r))
 390                                         spip_log("maj $i format incorrect","maj."._LOG_ERREUR);
 391                                 else
 392                                         spip_log("maj $i fonction $f non definie","maj."._LOG_ERREUR);
 393                                 // en cas d'erreur serieuse, on s'arrete
 394                                 // mais on permet de passer par dessus en rechargeant la page.
 395                                 return $i+1;
 396                         }
 397                 }
 398         }
 399         effacer_meta($meta2, $table);
 400         return 0;
 401 }
 402
 403
 404
 405 // La fonction a appeler dans le tableau global $maj
 406 // quand on rajoute des types MIME. cf par exemple la 1.953
 407
 408 // http://doc.spip.org/@upgrade_types_documents
 409 function upgrade_types_documents() {
 410         if (include_spip('base/medias')
 411         AND function_exists('creer_base_types_doc'))
 412                 creer_base_types_doc();
 413 }
 414
 415 // http://doc.spip.org/@upgrade_test
 416 function upgrade_test() {
 417         sql_drop_table("spip_test", true);
 418         sql_create("spip_test", array('a' => 'int'));
 419         sql_alter("TABLE spip_test ADD b INT");
 420         sql_insertq('spip_test', array('b' => 1), array('field'=>array('b' => 'int')));
 421         $result = sql_select('b', "spip_test");
 422         // ne pas garder le resultat de la requete sinon sqlite3
 423         // ne peut pas supprimer la table spip_test lors du sql_alter qui suit
 424         // car cette table serait alors 'verouillee'
 425         $result = $result?true:false;
 426         sql_alter("TABLE spip_test DROP b");
 427         return $result;
 428 }
 429
 430 // pour versions <= 1.926
 431 // http://doc.spip.org/@maj_version
 432 function maj_version ($version, $test = true) {
 433         if ($test) {
 434                 if ($version>=1.922)
 435                         ecrire_meta('version_installee', $version, 'oui');
 436                 else {
 437                         // on le fait manuellement, car ecrire_meta utilise le champs impt qui est absent sur les vieilles versions
 438                         $GLOBALS['meta']['version_installee'] = $version;
 439                         sql_updateq('spip_meta',  array('valeur' => $version), "nom=" . sql_quote('version_installee') );
 440                 }
 441                 spip_log( "mise a jour de la base en $version","maj."._LOG_INFO_IMPORTANTE);
 442         } else {
 443                 echo _T('alerte_maj_impossible', array('version' => $version));
 444                 exit;
 445         }
 446 }
 447
 448 // pour versions <= 1.926
 449 // http://doc.spip.org/@upgrade_vers
 450 function upgrade_vers($version, $version_installee, $version_cible = 0){
 451         return ($version_installee<$version
 452                 AND (($version_cible>=$version) OR ($version_cible==0))
 453         );
 454 }
 455 ?>