www/ecrire/plugins/installer.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  * Installe ou retire un plugin
  17  *
  18  * Fonction surchargeable permettant d'installer ou retirer un plugin
  19  * en incluant les fichiers associes et en lancant les fonctions specifiques
  20  * 1. d'abord sur l'argument 'test',
  21  * 2. ensuite sur l'action demandee si le test repond False
  22  * 3. enfin sur l'argument 'test' a nouveau.
  23  * l'index install_test du tableau resultat est un tableau forme:
  24  *  - du resultat 3
  25  *  - des Echo de l'etape 2
  26  *
  27  * @param string $plug, nom du plugin
  28  * @param string $action, nom de l'action (install|uninstall)
  29  * @param string $dir_type, repertoire du plugin
  30  *
  31  * @return array|boolean True si deja installe, le tableau de get_infos sinon
  32  *
  33  */
  34 function plugins_installer_dist($plug, $action, $dir_type='_DIR_PLUGINS')
  35 {
  36         $get_infos = charger_fonction('get_infos','plugins');
  37         $infos = $get_infos($plug, false, constant($dir_type));
  38         if (!isset($infos['install']) OR !$infos['install']) return false;
  39         // passer en chemin absolu si possible, c'est plus efficace
  40         $dir = str_replace('_DIR_','_ROOT_',$dir_type);
  41         if (!defined($dir)) $dir = $dir_type;
  42         $dir = constant($dir);
  43         foreach($infos['install'] as $file) {
  44                 $file = $dir . $plug . "/" . trim($file);
  45                 if (file_exists($file)){
  46                         include_once($file);
  47                 }
  48         }
  49         $version = isset($infos['schema'])?$infos['schema']:'';
  50         $arg = $infos ;
  51         $f = $infos['prefix']."_install";
  52         if (!function_exists($f))
  53                 $f = isset($infos['schema']) ? 'spip_plugin_install' : '';
  54         else
  55                 $arg = $infos['prefix']; // stupide: info deja dans le nom
  56
  57         if (!$f) {
  58                 // installation sans operation particuliere
  59                 $infos['install_test'] = array(true, '');
  60                 return $infos;
  61         }
  62         $test = $f('test', $arg, $version);
  63         if ($action == 'uninstall') $test = !$test;
  64         // Si deja fait, on ne dit rien
  65         if ($test)  return true;
  66         // Si install et que l'on a la meta d'installation, c'est un upgrade
  67         if($action == 'install' && !is_null(lire_meta($infos['prefix'].'_base_version')))
  68                 $infos['upgrade'] = true;
  69
  70         // executer l'installation ou l'inverse
  71         // et renvoyer la trace (mais il faudrait passer en AJAX plutot)
  72         ob_start();
  73         $f($action, $arg, $version);
  74         $aff = ob_get_contents();
  75         ob_end_clean();
  76         // vider le cache des descriptions de tables a chaque (de)installation
  77         $trouver_table = charger_fonction('trouver_table', 'base');
  78         $trouver_table('');
  79         $infos['install_test'] = array($f('test', $arg, $version), $aff);
  80         return $infos;
  81 }
  82
  83 // Fonction par defaut pour install/desinstall
  84
  85 // http://doc.spip.org/@spip_plugin_install
  86 function spip_plugin_install($action, $infos, $version_cible){
  87         $prefix = $infos['prefix'];
  88         if (isset($infos['meta']) AND (($table = $infos['meta']) !== 'meta'))
  89                 $nom_meta = "base_version";
  90         else {
  91                 $nom_meta = $prefix."_base_version";
  92                 $table = 'meta';
  93         }
  94         switch ($action){
  95                 case 'test':
  96                         return  (isset($GLOBALS[$table])
  97                         AND isset($GLOBALS[$table][$nom_meta])
  98                         AND spip_version_compare($GLOBALS[$table][$nom_meta],$version_cible,'>='));
  99                         break;
 100                 case 'install':
 101                         if (function_exists($upgrade = $prefix."_upgrade"))
 102                                 $upgrade($nom_meta, $version_cible, $table);
 103                         break;
 104                 case 'uninstall':
 105                   if (function_exists($vider_tables = $prefix."_vider_tables"))
 106                                 $vider_tables($nom_meta, $table);
 107                         break;
 108         }
 109 }
 110
 111
 112 /**
 113  * Compare 2 numeros de version entre elles.
 114  *
 115  * Cette fonction est identique (arguments et retours) a la fonction PHP
 116  * version_compare() qu'elle appelle. Cependant, cette fonction reformate
 117  * les numeros de versions pour ameliorer certains usages dans SPIP ou bugs
 118  * dans PHP. On permet ainsi de comparer 3.0.4 à 3.0.* par exemple.
 119  *
 120  * @param string $v1
 121  *              Numero de version servant de base a la comparaison.
 122  *              Ce numero ne peut pas comporter d'etoile.
 123  * @param string $v2
 124  *              Numero de version a comparer.
 125  *              Il peut posseder des etoiles tel que 3.0.*
 126  * @param string $op
 127  *              Un operateur eventuel (<, >, <=, >=, =, == ...)
 128  * @return int|bool
 129  *              Sans operateur : int. -1 pour inferieur, 0 pour egal, 1 pour superieur
 130  *              Avec operateur : bool.
 131 **/
 132 function spip_version_compare($v1,$v2,$op=null){
 133         $v1 = strtolower(preg_replace(',([0-9])[\s-.]?(dev|alpha|a|beta|b|rc|pl|p),i','\\1.\\2',$v1));
 134         $v2 = strtolower(preg_replace(',([0-9])[\s-.]?(dev|alpha|a|beta|b|rc|pl|p),i','\\1.\\2',$v2));
 135         $v1 = str_replace('rc','RC',$v1); // certaines versions de PHP ne comprennent RC qu'en majuscule
 136         $v2 = str_replace('rc','RC',$v2); // certaines versions de PHP ne comprennent RC qu'en majuscule
 137
 138         $v1 = explode('.',$v1);
 139         $v2 = explode('.',$v2);
 140         // $v1 est toujours une version, donc sans etoile
 141         while (count($v1)<count($v2))
 142                 $v1[] = '0';
 143
 144         // $v2 peut etre une borne, donc accepte l'etoile
 145         $etoile = false;
 146         foreach ($v1 as $k => $v) {
 147                 if (!isset($v2[$k]))
 148                         $v2[] = ($etoile AND (is_numeric($v) OR $v=='pl' OR $v=='p')) ? $v : '0';
 149                 else if ($v2[$k] == '*') {
 150                         $etoile = true;
 151                         $v2[$k] = $v;
 152                 }
 153         }
 154         $v1 = implode('.',$v1);
 155         $v2 = implode('.',$v2);
 156
 157         return $op?version_compare($v1, $v2,$op):version_compare($v1, $v2);
 158 }
 159
 160 // Cette fonction retourne la meta "plugin" deserialisee
 161 // mais en fait une mise a jour qui aurait du intervenir au chgt de version
 162 // http://doc.spip.org/@liste_plugin_actifs
 163 function liste_plugin_actifs(){
 164         $liste = isset($GLOBALS['meta']['plugin'])?$GLOBALS['meta']['plugin']:'';
 165         if (!$liste) return array();
 166         if (!is_array($liste=unserialize($liste))) {
 167                 // compatibilite pre 1.9.2, mettre a jour la meta
 168                 spip_log("MAJ meta plugin vieille version : $liste","plugin");
 169                 $new = true;
 170                 list(, $liste) = liste_plugin_valides(explode(",",$liste));
 171         } else {
 172                 $new = false;
 173                 // compat au moment d'une migration depuis version anterieure
 174                 // si pas de dir_type, alors c'est _DIR_PLUGINS
 175                 foreach ($liste as $prefix=>$infos) {
 176                         if (!isset($infos['dir_type'])) {
 177                                 $liste[$prefix]['dir_type'] = "_DIR_PLUGINS";
 178                                 $new = true;
 179                         }
 180                 }
 181         }
 182         if ($new) ecrire_meta('plugin',serialize($liste));
 183         return $liste;
 184 }
 185
 186 ?>