www/ecrire/base/create.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  * Création ou mise à jour des tables
  15  *
  16  * @package SPIP\Core\Installation
  17  **/
  18 if (!defined('_ECRIRE_INC_VERSION')) {
  19         return;
  20 }
  21
  22 include_spip('inc/acces');
  23 include_spip('base/objets');
  24 include_spip('base/typedoc');
  25 include_spip('base/abstract_sql');
  26
  27 /**
  28  * Determiner le flag autoinc pour une table
  29  * en fonction de si c'est une table principale
  30  *
  31  * @param string $table
  32  * @param array $desc
  33  * @return bool
  34  */
  35 function base_determine_autoinc($table, $desc = array()) {
  36         if ($t = lister_tables_principales() and isset($t[$table])) {
  37                 $autoinc = true;
  38         } elseif ($t = lister_tables_auxiliaires() and isset($t[$table])) {
  39                 $autoinc = false;
  40         } else {
  41                 // essayer de faire au mieux !
  42                 $autoinc = (isset($desc['key']['PRIMARY KEY'])
  43                         and strpos($desc['key']['PRIMARY KEY'], ',') === false
  44                         and strpos($desc['field'][$desc['key']['PRIMARY KEY']], 'default') === false);
  45         }
  46
  47         return $autoinc;
  48 }
  49
  50 /**
  51  * Créer une table,
  52  * ou ajouter les champs manquants si elle existe déjà
  53  *
  54  * @param string $table
  55  * @param array $desc
  56  * @param bool|string $autoinc
  57  *   'auto' pour detecter automatiquement si le champ doit etre autoinc ou non
  58  *   en fonction de la table
  59  * @param bool $upgrade
  60  * @param string $serveur
  61  * @return void
  62  */
  63 function creer_ou_upgrader_table($table, $desc, $autoinc, $upgrade = false, $serveur = '') {
  64         #spip_log("creer_ou_upgrader_table table=$table autoinc=$autoinc upgrade=$upgrade","dbinstall"._LOG_INFO_IMPORTANTE);
  65         $sql_desc = $upgrade ? sql_showtable($table, true, $serveur) : false;
  66         #if (!$sql_desc) $sql_desc = false;
  67         #spip_log("table=$table sql_desc:$sql_desc","dbinstall"._LOG_INFO_IMPORTANTE);
  68         if (!$sql_desc) {
  69                 if ($autoinc === 'auto') {
  70                         $autoinc = base_determine_autoinc($table, $desc);
  71                 }
  72                 #spip_log("sql_create $table autoinc=$autoinc","dbinstall"._LOG_INFO_IMPORTANTE);
  73                 sql_create($table, $desc['field'], $desc['key'], $autoinc, false, $serveur);
  74                 // verifier la bonne installation de la table (php-fpm es-tu la ?)
  75                 $sql_desc = sql_showtable($table, true, $serveur);
  76                 #if (!$sql_desc) $sql_desc = false;
  77                 #spip_log("Resultat table=$table sql_desc:$sql_desc","dbinstall"._LOG_INFO_IMPORTANTE);
  78                 if (!$sql_desc) {
  79                         // on retente avec un sleep ?
  80                         sleep(1);
  81                         sql_create($table, $desc['field'], $desc['key'], $autoinc, false, $serveur);
  82                         $sql_desc = sql_showtable($table, true, $serveur);
  83                         #if (!$sql_desc) $sql_desc = false;
  84                         #spip_log("Resultat table=$table sql_desc:$sql_desc","dbinstall"._LOG_INFO_IMPORTANTE);
  85                         if (!$sql_desc) {
  86                                 spip_log("Echec creation table $table", "maj" . _LOG_CRITIQUE);
  87                         }
  88                 }
  89         } else {
  90                 #spip_log("sql_alter $table ... (on s'en fiche)","dbinstall"._LOG_INFO_IMPORTANTE);
  91                 // ajouter les champs manquants
  92                 // on ne supprime jamais les champs, car c'est dangereux
  93                 // c'est toujours a faire manuellement
  94                 $last = '';
  95                 foreach ($desc['field'] as $field => $type) {
  96                         if (!isset($sql_desc['field'][$field])) {
  97                                 sql_alter("TABLE $table ADD $field $type" . ($last ? " AFTER $last" : ""), $serveur);
  98                         }
  99                         $last = $field;
 100                 }
 101                 foreach ($desc['key'] as $key => $type) {
 102                         // Ne pas oublier les cas des cles non nommees dans la declaration et qui sont retournees
 103                         // par le showtable sous la forme d'un index de tableau "KEY $type" et non "KEY"
 104                         if (!isset($sql_desc['key'][$key]) and !isset($sql_desc['key']["$key $type"])) {
 105                                 sql_alter("TABLE $table ADD $key ($type)", $serveur);
 106                         }
 107                         $last = $field;
 108                 }
 109
 110         }
 111 }
 112
 113 /**
 114  * Creer ou mettre à jour un ensemble de tables
 115  * en fonction du flag `$up`
 116  *
 117  * @uses creer_ou_upgrader_table()
 118  *
 119  * @param array $tables_inc
 120  *   tables avec autoincrement sur la cle primaire
 121  * @param  $tables_noinc
 122  *   tables sans autoincrement sur la cle primaire
 123  * @param bool|array $up
 124  *   upgrader (true) ou creer (false)
 125  *   si un tableau de table est fournie, seules l'intersection de ces tables
 126  *   et des $tables_inc / $tables_noinc seront traitees
 127  * @param string $serveur
 128  *   serveur sql
 129  * @return void
 130  */
 131 function alterer_base($tables_inc, $tables_noinc, $up = false, $serveur = '') {
 132         if ($up === false) {
 133                 $old = false;
 134                 $up = array();
 135         } else {
 136                 $old = true;
 137                 if (!is_array($up)) {
 138                         $up = array($up);
 139                 }
 140         }
 141         foreach ($tables_inc as $k => $v) {
 142                 if (!$old or in_array($k, $up)) {
 143                         creer_ou_upgrader_table($k, $v, true, $old, $serveur);
 144                 }
 145         }
 146
 147         foreach ($tables_noinc as $k => $v) {
 148                 if (!$old or in_array($k, $up)) {
 149                         creer_ou_upgrader_table($k, $v, false, $old, $serveur);
 150                 }
 151         }
 152 }
 153
 154 /**
 155  * Créer une base de données
 156  * à partir des tables principales et auxiliaires
 157  *
 158  * Lorsque de nouvelles tables ont été déclarées, cette fonction crée les tables manquantes.
 159  * mais ne crée pas des champs manquant d'une table déjà présente.
 160  * Pour cela, c’est `maj_tables()` qu’il faut appeler.
 161  *
 162  * @api
 163  * @see  maj_tables()
 164  * @uses alterer_base()
 165  *
 166  * @param string $serveur
 167  * @return void
 168  */
 169 function creer_base($serveur = '') {
 170
 171         // Note: les mises a jour reexecutent ce code pour s'assurer
 172         // de la conformite de la base
 173         // pas de panique sur  "already exists" et "duplicate entry" donc.
 174
 175         alterer_base(
 176                 lister_tables_principales(),
 177                 lister_tables_auxiliaires(),
 178                 false,
 179                 $serveur
 180         );
 181 }
 182
 183 /**
 184  * Mettre à jour une liste de tables
 185  *
 186  * Fonction facilitatrice utilisée pour les maj de base
 187  * dans les plugins.
 188  *
 189  * Elle permet de créer les champs manquants d'une table déjà présente.
 190  *
 191  * @api
 192  * @see  creer_base()
 193  * @uses alterer_base()
 194  *
 195  * @param array $upgrade_tables
 196  * @param string $serveur
 197  * @return void
 198  */
 199 function maj_tables($upgrade_tables = array(), $serveur = '') {
 200         alterer_base(
 201                 lister_tables_principales(),
 202                 lister_tables_auxiliaires(),
 203                 $upgrade_tables,
 204                 $serveur
 205         );
 206 }