1. sfPluginInstallTask.class.php
  2. /**
 * Installs a plugin.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfPluginInstallTask.class.php 23922 2009-11-14 14:58:38Z fabien $
 */
  3. class sfPluginInstallTask extends sfPluginBaseTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('name', sfCommandArgument::REQUIRED, 'The plugin name'),
  12.     ));
  14.     $this->addOptions(array(
  15.       new sfCommandOption('stability', 's', sfCommandOption::PARAMETER_REQUIRED, 'The preferred stability (stable, beta, alpha)', null),
  16.       new sfCommandOption('release', 'r', sfCommandOption::PARAMETER_REQUIRED, 'The preferred version', null),
  17.       new sfCommandOption('channel', 'c', sfCommandOption::PARAMETER_REQUIRED, 'The PEAR channel name', null),
  18.       new sfCommandOption('install_deps', 'd', sfCommandOption::PARAMETER_NONE, 'Whether to force installation of required dependencies', null),
  19.       new sfCommandOption('force-license', null, sfCommandOption::PARAMETER_NONE, 'Whether to force installation even if the license is not MIT like'),
  20.     ));
  22.     $this->namespace = 'plugin';
  23.     $this->name = 'install';
  25.     $this->briefDescription = 'Installs a plugin';
  27.     $this->detailedDescription = <<<EOF
  28. The [plugin:install|INFO] task installs a plugin:
  30.   [./symfony plugin:install sfGuardPlugin|INFO]
  32. By default, it installs the latest [stable|COMMENT] release.
  34. If you want to install a plugin that is not stable yet,
  35. use the [stability|COMMENT] option:
  37.   [./symfony plugin:install --stability=beta sfGuardPlugin|INFO]
  38.   [./symfony plugin:install -s beta sfGuardPlugin|INFO]
  40. You can also force the installation of a specific version:
  42.   [./symfony plugin:install --release=1.0.0 sfGuardPlugin|INFO]
  43.   [./symfony plugin:install -r 1.0.0 sfGuardPlugin|INFO]
  45. To force installation of all required dependencies, use the [install_deps|INFO] flag:
  47.   [./symfony plugin:install --install-deps sfGuardPlugin|INFO]
  48.   [./symfony plugin:install -d sfGuardPlugin|INFO]
  50. By default, the PEAR channel used is [symfony-plugins|INFO]
  51. (plugins.symfony-project.org).
  53. You can specify another channel with the [channel|COMMENT] option:
  55.   [./symfony plugin:install --channel=mypearchannel sfGuardPlugin|INFO]
  56.   [./symfony plugin:install -c mypearchannel sfGuardPlugin|INFO]
  58. You can also install PEAR packages hosted on a website:
  60.   [./symfony plugin:install http://somewhere.example.com/sfGuardPlugin-1.0.0.tgz|INFO]
  62. Or local PEAR packages:
  64.   [./symfony plugin:install /home/fabien/plugins/sfGuardPlugin-1.0.0.tgz|INFO]
  66. If the plugin contains some web content (images, stylesheets or javascripts),
  67. the task creates a [%name%|COMMENT] symbolic link for those assets under [web/|COMMENT].
  68. On Windows, the task copy all the files to the [web/%name%|COMMENT] directory.
  69. EOF;
  70.   }
  72.   /**
  73.    * @see sfTask
  74.    */
  75.   protected function execute($arguments = array(), $options = array())
  76.   {
  77.     $this->logSection('plugin', sprintf('installing plugin "%s"', $arguments['name']));
  79.     $options['version'] = $options['release'];
  80.     unset($options['release']);
  82.     // license compatible?
  83.     if (!$options['force-license'])
  84.     {
  85.       try
  86.       {
  87.         $license = $this->getPluginManager()->getPluginLicense($arguments['name'], $options);
  88.       }
  89.       catch (Exception $e)
  90.       {
  91.         throw new sfCommandException(sprintf('%s (use --force-license to force installation)', $e->getMessage()));
  92.       }
  94.       if (false !== $license)
  95.       {
  96.         $temp = trim(str_replace('license', '', strtolower($license)));
  97.         if (null !== $license && !in_array($temp, array('mit', 'bsd', 'lgpl', 'php', 'apache')))
  98.         {
  99.           throw new sfCommandException(sprintf('The license of this plugin "%s" is not MIT like (use --force-license to force installation).', $license));
  100.         }
  101.       }
  102.     }
  104.     $this->getPluginManager()->installPlugin($arguments['name'], $options);
  105.   }
  106. }
Debug toolbar