\n"; if (ob_get_level()) { ob_flush(); } flush(); $done = true; } if (!defined('_UPGRADE_TIME_OUT')) { /** * Durée en secondes pour relancer les scripts de mises à jour, x secondes * avant que la durée d'exécution du script provoque un timeout * * @var int **/ define('_UPGRADE_TIME_OUT', 20); } /** * Gestion des mises à jour de SPIP et des plugins * * À partir des versions > 1.926 (i.e SPIP > 1.9.2), cette fonction gere les MAJ. * * Se relancer soi-même pour éviter l'interruption pendant une operation SQL * (qu'on espère pas trop longue chacune) évidemment en ecrivant dans la meta * à quel numero on en est. * * Cette fonction peut servir aux plugins qui doivent donner comme arguments : * * 1. le numero de version courant (numéro de version 1.2.3 ou entier) * 2. le numero de version à atteindre (numéro de version 1.2.3 ou entier) * 3. le tableau des instructions de mise à jour à exécuter * Pour profiter du mécanisme de reprise sur interruption il faut de plus * 4. le nom de la meta permettant de retrouver tout ca * 5. la table des meta ou elle se trouve (`$table_prefix . '_meta'` par défaut) * (cf début de fichier) * * les fonctions `sql_xx` appelées lors des mises à jour sont supposées * atomiques et ne sont pas relancées en cas de timeout, mais les fonctions * spécifiques sont relancées jusqu'à ce qu'elles finissent. * Elles doivent donc s'assurer de progresser à chaque reprise. * * @uses maj_debut_page() * @uses serie_alter() * @uses relance_maj() * * @param string $installee * @param string $cible * @param array $maj * @param string $meta * @param string $table * @param string $redirect * @param bool $debut_page * @return array * - tableau (étape, sous-étape) en cas d'échec, * - tableau vide sinon. */ function maj_while($installee, $cible, $maj, $meta = '', $table = 'meta', $redirect = '', $debut_page = false) { # inclusions pour que les procedures d'upgrade disposent des fonctions de base include_spip('base/create'); include_spip('base/abstract_sql'); $trouver_table = charger_fonction('trouver_table', 'base'); include_spip('inc/plugin'); // pour spip_version_compare $n = 0; $time = time(); if (!defined('_TIME_OUT')) { /** * Définir le timeout qui peut-être utilisé dans les fonctions * de mises à jour qui durent trop longtemps * * À utiliser tel que : `if (time() >= _TIME_OUT)` * * @var int */ define('_TIME_OUT', $time + _UPGRADE_TIME_OUT); } foreach ($maj as $v => $operations) { // si une maj pour cette version if ($v == 'init' or (spip_version_compare($v, $installee, '>') and spip_version_compare($v, $cible, '<=')) ) { if ($debut_page) { maj_debut_page($v, $meta, $table); } echo "MAJ $v"; $etape = serie_alter($v, $operations, $meta, $table, $redirect); $trouver_table(''); // vider le cache des descriptions de table # echec sur une etape en cours ? # on sort if ($etape) { return array($v, $etape); } $n = time() - $time; spip_log("$table $meta: $v en $n secondes", 'maj.' . _LOG_INFO_IMPORTANTE); if ($meta) { ecrire_meta($meta, $installee = $v, 'oui', $table); } echo '
'; } if (time() >= _TIME_OUT) { relance_maj($meta, $table, $redirect); } } $trouver_table(''); // vider le cache des descriptions de table // indispensable pour les chgt de versions qui n'ecrivent pas en base // tant pis pour la redondance eventuelle avec ci-dessus if ($meta) { ecrire_meta($meta, $cible, 'oui', $table); } spip_log("MAJ terminee. $meta: $installee", 'maj.' . _LOG_INFO_IMPORTANTE); return array(); } /** * Appliquer une serie de changements qui risquent de partir en timeout * * Alter crée une copie temporaire d'une table, c'est lourd. * * @uses relance_maj() * * @param string $serie * numero de version upgrade * @param array $q * tableau des operations pour cette version * @param string $meta * nom de la meta qui contient le numero de version * @param string $table * nom de la table meta * @param string $redirect * url de redirection en cas d'interruption * @return int */ function serie_alter($serie, $q = array(), $meta = '', $table = 'meta', $redirect = '') { $meta2 = $meta . '_maj_' . $serie; $etape = intval(@$GLOBALS[$table][$meta2]); foreach ($q as $i => $r) { if ($i >= $etape) { $msg = "maj $table $meta2 etape $i"; if (is_array($r) and function_exists($f = array_shift($r)) ) { // note: $r (arguments de la fonction $f) peut avoir des données tabulaires spip_log("$msg: $f " . @join(',', $r), 'maj.' . _LOG_INFO_IMPORTANTE); // pour les fonctions atomiques sql_xx // on enregistre le meta avant de lancer la fonction, // de maniere a eviter de boucler sur timeout // mais pour les fonctions complexes, // il faut les rejouer jusqu'a achevement. // C'est a elle d'assurer qu'elles progressent a chaque rappel if (strncmp($f, 'sql_', 4) == 0) { ecrire_meta($meta2, $i + 1, 'non', $table); } echo " ."; call_user_func_array($f, $r); // si temps imparti depasse, on relance sans ecrire en meta // car on est peut etre sorti sur timeout si c'est une fonction longue if (time() >= _TIME_OUT) { relance_maj($meta, $table, $redirect); } ecrire_meta($meta2, $i + 1, 'non', $table); spip_log("$meta2: ok", 'maj.' . _LOG_INFO_IMPORTANTE); } else { if (!is_array($r)) { spip_log("maj $i format incorrect", 'maj.' . _LOG_ERREUR); } else { spip_log("maj $i fonction $f non definie", 'maj.' . _LOG_ERREUR); } // en cas d'erreur serieuse, on s'arrete // mais on permet de passer par dessus en rechargeant la page. return $i + 1; } } } effacer_meta($meta2, $table); return 0; } /** * Mise à jour des types MIME de documents * * Fonction utilisé par les vieilles mises à jour de SPIP, à appeler dans * le tableau `$maj` quand on rajoute des types MIME. Remplacé actuellement * par le plugin Medias. * * @deprecated Utiliser directement `creer_base_types_doc()` du plugin Medias * @example * ``` * $GLOBALS['maj'][1953] = array(array('upgrade_types_documents')); * * ``` * @uses creer_base_types_doc() * **/ function upgrade_types_documents() { if (include_spip('base/medias') and function_exists('creer_base_types_doc') ) { creer_base_types_doc(); } } /** * Vérifie qu'il est possible d'ajouter une colonne à une table SQL * * @return bool True si possible. **/ function upgrade_test() { sql_drop_table('spip_test', true); sql_create('spip_test', array('a' => 'int')); sql_alter('TABLE spip_test ADD b INT'); sql_insertq('spip_test', array('b' => 1), array('field' => array('b' => 'int'))); $result = sql_select('b', 'spip_test'); // ne pas garder le resultat de la requete sinon sqlite3 // ne peut pas supprimer la table spip_test lors du sql_alter qui suit // car cette table serait alors 'verouillee' $result = $result ? true : false; sql_alter('TABLE spip_test DROP b'); return $result; } /** * Mise à jour des versions de SPIP < 1.926 * * @deprecated Utiliser `maj_plugin()` ou la globale `maj` pour le core. * @see maj_plugin() * @see maj_base() * * @param float $version * @param bool $test * @return void **/ function maj_version($version, $test = true) { if ($test) { if ($version >= 1.922) { ecrire_meta('version_installee', $version, 'oui'); } else { // on le fait manuellement, car ecrire_meta utilise le champs impt qui est absent sur les vieilles versions $GLOBALS['meta']['version_installee'] = $version; sql_updateq('spip_meta', array('valeur' => $version), 'nom=' . sql_quote('version_installee')); } spip_log("mise a jour de la base en $version", 'maj.' . _LOG_INFO_IMPORTANTE); } else { echo _T('alerte_maj_impossible', array('version' => $version)); exit; } } /** * Teste de mise à jour des versions de SPIP < 1.926 * * @deprecated Utiliser `maj_plugin()` ou la globale `maj` pour le core. * @see maj_plugin() * @see maj_base() * * @param float $version * @param float $version_installee * @param int $version_cible * @return bool true si la mise à jour doit se réaliser **/ function upgrade_vers($version, $version_installee, $version_cible = 0) { return ($version_installee < $version and (($version_cible >= $version) or ($version_cible == 0)) ); }