1. sfSymfonyPluginManager.class.php
  2. /**
 * sfSymfonyPluginManager allows you to manage symfony plugins installation and uninstallation.
 *
 * @package    symfony
 * @subpackage plugin
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfSymfonyPluginManager.class.php 25218 2009-12-10 20:06:45Z Jonathan.Wage $
 */
  3. class sfSymfonyPluginManager extends sfPluginManager
  4. {
  5.   /**
  6.    * Initializes this sfPluginManager instance.
  7.    *
  8.    * Available options:
  9.    *
  10.    * * web_dir: The directory where to plugins assets (images, stylesheets, javascripts, ...)
  11.    *
  12.    * See sfPluginManager for other options.
  13.    *
  14.    * @param sfEventDispatcher $dispatcher   An event dispatcher instance
  15.    * @param sfPearEnvironment $environment  A sfPearEnvironment instance
  16.    */
  17.   public function initialize(sfEventDispatcher $dispatcher, sfPearEnvironment $environment)
  18.   {
  19.     parent::initialize($dispatcher, $environment);
  21.     if (!$environment->getOption('web_dir'))
  22.     {
  23.       throw new sfPluginException('You must provide a "web_dir" option.');
  24.     }
  25.   }
  27.   /**
  28.    * Configures this plugin manager.
  29.    */
  30.   public function configure()
  31.   {
  32.     // register symfony channel
  33.     $this->environment->registerChannel('pear.symfony-project.com', true);
  35.     // register symfony plugins channel
  36.     $this->environment->registerChannel('plugins.symfony-project.org', true);
  38.     // register symfony for dependencies
  39.     $this->registerSymfonyPackage();
  41.     // register callbacks to manage web content
  42.     $this->dispatcher->connect('plugin.post_install',  array($this, 'listenToPluginPostInstall'));
  43.     $this->dispatcher->connect('plugin.post_uninstall', array($this, 'listenToPluginPostUninstall'));
  44.   }
  46.   /**
  47.    * Installs web content for a plugin.
  48.    *
  49.    * @param string $plugin The plugin name
  50.    */
  51.   public function installWebContent($plugin, $sourceDirectory)
  52.   {
  53.     $webDir = $sourceDirectory.DIRECTORY_SEPARATOR.$plugin.DIRECTORY_SEPARATOR.'web';
  54.     if (is_dir($webDir))
  55.     {
  56.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array('Installing web data for plugin')));
  58.       $filesystem = new sfFilesystem();
  59.       $filesystem->relativeSymlink($webDir, $this->environment->getOption('web_dir').DIRECTORY_SEPARATOR.$plugin, true);
  60.     }
  61.   }
  63.   /**
  64.    * Unnstalls web content for a plugin.
  65.    *
  66.    * @param string $plugin The plugin name
  67.    */
  68.   public function uninstallWebContent($plugin)
  69.   {
  70.     $targetDir = $this->environment->getOption('web_dir').DIRECTORY_SEPARATOR.$plugin;
  71.     if (is_dir($targetDir))
  72.     {
  73.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array('Uninstalling web data for plugin')));
  75.       $filesystem = new sfFilesystem();
  77.       if (is_link($targetDir))
  78.       {
  79.         $filesystem->remove($targetDir);
  80.       }
  81.       else
  82.       {
  83.         $filesystem->remove(sfFinder::type('any')->in($targetDir));
  84.         $filesystem->remove($targetDir);
  85.       }
  86.     }
  87.   }
  89.   /**
  90.    * Enables a plugin in the ProjectConfiguration class.
  91.    *
  92.    * This is a static method that does not rely on the PEAR environment
  93.    * as we don't want this method to have PEAR as a dependency.
  94.    *
  95.    * @param string $plugin    The name of the plugin
  96.    * @param string $configDir The config directory
  97.    */
  98.   static public function enablePlugin($plugin, $configDir)
  99.   {
  100.     if (!$configDir)
  101.     {
  102.       throw new sfPluginException('You must provide a "config_dir" option.');
  103.     }
  105.     $manipulator = sfClassManipulator::fromFile($configDir.'/ProjectConfiguration.class.php');
  106.     $manipulator->wrapMethod('setup', '', sprintf('$this->enablePlugins(\'%s\');', $plugin));
  107.     $manipulator->save();
  108.   }
  110.   /**
  111.    * Disables a plugin in the ProjectConfiguration class.
  112.    *
  113.    * This is a static method that does not rely on the PEAR environment
  114.    * as we don't want this method to have PEAR as a dependency.
  115.    *
  116.    * @param string $plugin The name of the plugin
  117.    * @param string $configDir The config directory
  118.    */
  119.   static public function disablePlugin($plugin, $configDir)
  120.   {
  121.     if (!$configDir)
  122.     {
  123.       throw new sfPluginException('You must provide a "config_dir" option.');
  124.     }
  126.     $file = $configDir.'/ProjectConfiguration.class.php';
  127.     $source = file_get_contents($file);
  129.     $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(([^\)]+), *\'%s\'([^\)]*)\)\)#', $plugin), '$this->enablePlugins(array($1$2))', $source);
  130.     $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(\'%s\', *([^\)]*)\)\)#', $plugin), '$this->enablePlugins(array($1))', $source);
  131.     $source = preg_replace(sprintf('# *\$this\->enablePlugins\(\'%s\'\); *\n?#', $plugin), '', $source);
  132.     $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(\'%s\'\)\); *\n?#', $plugin), '', $source);
  133.     $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(\)\); *\n?#', $plugin), '', $source);
  135.     file_put_contents($file, $source);
  136.   }
  138.   /**
  139.    * Listens to the plugin.post_install event.
  140.    *
  141.    * @param sfEvent $event An sfEvent instance
  142.    */
  143.   public function listenToPluginPostInstall($event)
  144.   {
  145.     $this->installWebContent($event['plugin'], isset($event['plugin_dir']) ? $event['plugin_dir'] : $this->environment->getOption('plugin_dir'));
  147.     $this->enablePlugin($event['plugin'], $this->environment->getOption('config_dir'));
  148.   }
  150.   /**
  151.    * Listens to the plugin.post_uninstall event.
  152.    *
  153.    * @param sfEvent $event An sfEvent instance
  154.    */
  155.   public function listenToPluginPostUninstall($event)
  156.   {
  157.     $this->uninstallWebContent($event['plugin']);
  159.     $this->disablePlugin($event['plugin'], $this->environment->getOption('config_dir'));
  160.   }
  162.   /**
  163.    * Registers the symfony package for the current version.
  164.    */
  165.   protected function registerSymfonyPackage()
  166.   {
  167.     $symfony = new PEAR_PackageFile_v2_rw();
  168.     $symfony->setPackage('symfony');
  169.     $symfony->setChannel('pear.symfony-project.com');
  170.     $symfony->setConfig($this->environment->getConfig());
  171.     $symfony->setPackageType('php');
  172.     $symfony->setAPIVersion(preg_replace('/\d+(\-\w+)?$/', '0', SYMFONY_VERSION));
  173.     $symfony->setAPIStability(false === strpos(SYMFONY_VERSION, 'DEV') ? 'stable' : 'beta');
  174.     $symfony->setReleaseVersion(preg_replace('/\-\w+$/', '', SYMFONY_VERSION));
  175.     $symfony->setReleaseStability(false === strpos(SYMFONY_VERSION, 'DEV') ? 'stable' : 'beta');
  176.     $symfony->setDate(date('Y-m-d'));
  177.     $symfony->setDescription('symfony');
  178.     $symfony->setSummary('symfony');
  179.     $symfony->setLicense('MIT License');
  180.     $symfony->clearContents();
  181.     $symfony->resetFilelist();
  182.     $symfony->addMaintainer('lead', 'fabpot', 'Fabien Potencier', 'fabien.potencier@symfony-project.com');
  183.     $symfony->setNotes('-');
  184.     $symfony->setPearinstallerDep('1.4.3');
  185.     $symfony->setPhpDep('5.2.4');
  187.     $this->environment->getRegistry()->deletePackage('symfony', 'pear.symfony-project.com');
  188.     if (!$this->environment->getRegistry()->addPackage2($symfony))
  189.     {
  190.       throw new sfPluginException('Unable to register the symfony package');
  191.     }
  192.   }
  194.   /**
  195.    * Returns true if the plugin is comptatible with the dependency.
  196.    *
  197.    * @param  array   $dependency A dependency array
  198.    *
  199.    * @return Boolean true if the plugin is compatible, false otherwise
  200.    */
  201.   protected function isPluginCompatibleWithDependency($dependency)
  202.   {
  203.     if (isset($dependency['channel']) && 'symfony' == $dependency['name'] && 'pear.symfony-project.com' == $dependency['channel'])
  204.     {
  205.       return $this->checkDependency($dependency);
  206.     }
  208.     return true;
  209.   }
  210. }
Debug toolbar