1. sfPearRestPlugin.class.php
  2. /**
 * sfPearRestPlugin interacts with a symfony plugin channel.
 *
 * @package    symfony
 * @subpackage plugin
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfPearRestPlugin.class.php 21908 2009-09-11 12:06:21Z fabien $
 */
  3. class sfPearRestPlugin extends sfPearRest11
  4. {
  5.   protected
  6.     $config,
  7.     $rest10,
  8.     $restBase,
  9.     $channel;
  11.   /**
  12.    * Constructs a new sfRestPlugin instance.
  13.    *
  14.    * @param PEAR_Config $config   The PEAR Config object
  15.    * @param array       $options  An array of options
  16.    */
  17.   public function __construct(PEAR_Config $config, $options = array())
  18.   {
  19.     parent::__construct($config, $options);
  21.     $this->config = $config;
  22.     $this->rest10 = new sfPearRest10($config, $options);
  23.   }
  25.   /**
  26.    * Sets the channel for the REST object.
  27.    *
  28.    * @param string $channel The channel name
  29.    */
  30.   public function setChannel($channel)
  31.   {
  32.     $this->channel = $channel;
  33.     $this->restBase = $this->getRESTBase($channel);
  34.   }
  36.   /**
  37.    * Gets the REST base path.
  38.    *
  39.    * @param string $channelName The channel name
  40.    */
  41.   protected function getRESTBase($channelName)
  42.   {
  43.     $channel = $this->config->getRegistry()->getChannel($channelName);
  44.     if (PEAR::isError($channel))
  45.     {
  46.       throw new sfPluginException(sprintf('Unable to initialize channel "%s"', $channel->getMessage()));
  47.     }
  49.     $mirror = $this->config->get('preferred_mirror', null, $channelName);
  50.     if (!$channel->supportsREST($mirror))
  51.     {
  52.       throw new sfPluginRestException(sprintf('The channel "%s" does not support the REST protocol', $channelName));
  53.     }
  55.     return $channel->getBaseURL('REST1.1', $mirror);
  56.   }
  58.   /**
  59.    * Returns the license for a given plugin and version.
  60.    *
  61.    * @param string $plugin  The plugin name
  62.    * @param string $version The version
  63.    *
  64.    * @return string The license
  65.    */
  66.   public function getPluginLicense($plugin, $version)
  67.   {
  68.     $info = $this->packageInfo($this->restBase, $plugin);
  70.     if (PEAR::isError($info))
  71.     {
  72.       throw new sfPluginRestException(sprintf('Unable to get plugin licence information for plugin "%s": %s', $plugin, $info->getMessage())); 
  73.     }
  75.     if (null === $info)
  76.     {
  77.       // plugin does not exist
  78.       return null;
  79.     }
  81.     if (!isset($info['license']) || null === $info['license'])
  82.     {
  83.       throw new Exception('No license found for this plugin!');
  84.     }
  86.     return $info['releases'][$version]['license'];
  87.   }
  89.   /**
  90.    * Gets the all available versions for a given plugin.
  91.    *
  92.    * @param  string $plugin     The plugin name
  93.    * @param  string $stability  The stability name
  94.    *
  95.    * @return array  An array of versions
  96.    */
  97.   public function getPluginVersions($plugin, $stability = null)
  98.   {
  99.     $allreleases = $this->_rest->retrieveData($this->restBase.'r/'.strtolower($plugin).'/allreleases.xml');
  100.     if (PEAR::isError($allreleases))
  101.     {
  102.       throw new sfPluginRestException(sprintf('Unable to get information for plugin "%s": %s', $plugin, $allreleases->getMessage()));
  103.     }
  105.     if (!isset($allreleases['r']) || (isset($allreleases['r']) && !is_array($allreleases['r']) || !count($allreleases['r'])))
  106.     {
  107.       throw new sfPluginRestException(sprintf('No release available for plugin "%s"', $plugin));
  108.     }
  110.     if (!isset($allreleases['r'][0]))
  111.     {
  112.       $allreleases['r'] = array($allreleases['r']);
  113.     }
  115.     $versions = array();
  116.     $allowedStates = $this->getAllowedStates($stability);
  117.     foreach ($allreleases['r'] as $release)
  118.     {
  119.       if (!isset($allowedStates[$release['s']]))
  120.       {
  121.         continue;
  122.       }
  124.       $versions[] = $release['v'];
  125.     }
  127.     if (!count($versions))
  128.     {
  129.       throw new sfPluginException(sprintf('No release available for plugin "%s" in state "%s"', $plugin, $stability));
  130.     }
  132.     return $versions;
  133.   }
  135.   /**
  136.    * Returns plugin dependencies.
  137.    *
  138.    * @param string $plugin  The plugin name
  139.    * @param string $version The plugin version
  140.    *
  141.    * @return array  An array of depedencies
  142.    */
  143.   public function getPluginDependencies($plugin, $version)
  144.   {
  145.     $dependencies = $this->_rest->retrieveData($this->restBase.'r/'.strtolower($plugin).'/deps.'.$version.'.txt');
  146.     if (PEAR::isError($dependencies))
  147.     {
  148.       throw new sfPluginRestException(sprintf('Unable to get dependencies information for plugin "%s": %s', $plugin, $dependencies->getMessage()));
  149.     }
  151.     return unserialize($dependencies);
  152.   }
  154.   /**
  155.    * Gets the plugin download URL.
  156.    *
  157.    * @param  string $plugin     The plugin name
  158.    * @param  string $version    The plugin version
  159.    * @param  string $stability  The stability
  160.    *
  161.    * @return string The URL for the plugin
  162.    */
  163.   public function getPluginDownloadURL($plugin, $version, $stability)
  164.   {
  165.     $installed = $this->config->getRegistry()->packageInfo($plugin, 'version', $this->channel);
  166.     if ($installed >= $version)
  167.     {
  168.       throw new sfPluginException(sprintf('Plugin "%s" version "%s" is already installed (you tried to install version "%s")', $plugin, $installed, $version));
  169.     }
  171.     $info = $this->getDownloadURL($this->restBase, array('channel' => $this->channel, 'package' => $plugin, 'version' => $version), $stability, $installed);
  172.     if (PEAR::isError($info))
  173.     {
  174.       throw new sfPluginRestException(sprintf('Unable to get download information for plugin "%s | %s | %s": %s', $plugin, $version, $stability, $info->getMessage()));
  175.     }
  177.     if (!isset($info['url']))
  178.     {
  179.       throw new sfPluginRestException(sprintf('Plugin "%s" cannot be installed (No URL found)', $plugin));
  180.     }
  182.     return $info['url'].(extension_loaded('zlib') ? '.tgz' : '.tar');
  183.   }
  185.   /**
  186.    * Returns an array of set of possible states sorted from most to least stable.
  187.    *
  188.    * @param  string $stability Stability name
  189.    *
  190.    * @return array  An array of stability names
  191.    */
  192.   protected function getAllowedStates($stability = null)
  193.   {
  194.     $stability = null === $stability ? $this->config->get('preferred_state', null, $this->channel) : $stability;
  196.     return array_flip($this->betterStates($stability, true));
  197.   }
  199.   /**
  200.    * Proxies method to the PEAR REST10 object.
  201.    *
  202.    * @param string $method    The method name
  203.    * @param array  $arguments An array of arguments
  204.    */
  205.   public function __call($method, $arguments)
  206.   {
  207.     if (method_exists($this->rest10, $method))
  208.     {
  209.       return call_user_func_array(array($this->rest10, $method), $arguments);
  210.     }
  211.   }
  212. }
Debug toolbar