1. sfProjectDeployTask.class.php
  2. /**
 * Deploys a project to another server.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfProjectDeployTask.class.php 23922 2009-11-14 14:58:38Z fabien $
 */
  3. class sfProjectDeployTask extends sfBaseTask
  4. {
  5.   protected
  6.     $outputBuffer = '',
  7.     $errorBuffer = '';
  9.   /**
  10.    * @see sfTask
  11.    */
  12.   protected function configure()
  13.   {
  14.     $this->addArguments(array(
  15.       new sfCommandArgument('server', sfCommandArgument::REQUIRED, 'The server name'),
  16.     ));
  18.     $this->addOptions(array(
  19.       new sfCommandOption('go', null, sfCommandOption::PARAMETER_NONE, 'Do the deployment'),
  20.       new sfCommandOption('rsync-dir', null, sfCommandOption::PARAMETER_REQUIRED, 'The directory where to look for rsync*.txt files', 'config'),
  21.       new sfCommandOption('rsync-options', null, sfCommandOption::PARAMETER_OPTIONAL, 'To options to pass to the rsync executable', '-azC --force --delete --progress'),
  22.     ));
  24.     $this->namespace = 'project';
  25.     $this->name = 'deploy';
  26.     $this->briefDescription = 'Deploys a project to another server';
  28.     $this->detailedDescription = <<<EOF
  29. The [project:deploy|INFO] task deploys a project on a server:
  31.   [./symfony project:deploy production|INFO]
  33. The server must be configured in [config/properties.ini|COMMENT]:
  35.   [[production]
  36.     host=www.example.com
  37.     port=22
  38.     user=fabien
  39.     dir=/var/www/sfblog/
  40.     type=rsync|INFO]
  42. To automate the deployment, the task uses rsync over SSH.
  43. You must configure SSH access with a key or configure the password
  44. in [config/properties.ini|COMMENT].
  46. By default, the task is in dry-mode. To do a real deployment, you
  47. must pass the [--go|COMMENT] option:
  49.   [./symfony project:deploy --go production|INFO]
  51. Files and directories configured in [config/rsync_exclude.txt|COMMENT] are
  52. not deployed:
  54.   [.svn
  55.   /web/uploads/*
  56.   /cache/*
  57.   /log/*|INFO]
  59. You can also create a [rsync.txt|COMMENT] and [rsync_include.txt|COMMENT] files.
  61. If you need to customize the [rsync*.txt|COMMENT] files based on the server,
  62. you can pass a [rsync-dir|COMMENT] option:
  64.   [./symfony project:deploy --go --rsync-dir=config/production production|INFO]
  66. Last, you can specify the options passed to the rsync executable, using the
  67. [rsync-options|INFO] option (defaults are [-azC --force --delete --progress|INFO]):
  69.   [./symfony project:deploy --go --rsync-options=-avz|INFO]
  70. EOF;
  71.   }
  73.   /**
  74.    * @see sfTask
  75.    */
  76.   protected function execute($arguments = array(), $options = array())
  77.   {
  78.     $env = $arguments['server'];
  80.     $ini = sfConfig::get('sf_config_dir').'/properties.ini';
  81.     if (!file_exists($ini))
  82.     {
  83.       throw new sfCommandException('You must create a config/properties.ini file');
  84.     }
  86.     $properties = parse_ini_file($ini, true);
  88.     if (!isset($properties[$env]))
  89.     {
  90.       throw new sfCommandException(sprintf('You must define the configuration for server "%s" in config/properties.ini', $env));
  91.     }
  93.     $properties = $properties[$env];
  95.     if (!isset($properties['host']))
  96.     {
  97.       throw new sfCommandException('You must define a "host" entry.');
  98.     }
  100.     if (!isset($properties['dir']))
  101.     {
  102.       throw new sfCommandException('You must define a "dir" entry.');
  103.     }
  105.     $host = $properties['host'];
  106.     $dir  = $properties['dir'];
  107.     $user = isset($properties['user']) ? $properties['user'].'@' : '';
  109.     if (substr($dir, -1) != '/')
  110.     {
  111.       $dir .= '/';
  112.     }
  114.     $ssh = 'ssh';
  116.     if (isset($properties['port']))
  117.     {
  118.       $port = $properties['port'];
  119.       $ssh = '"ssh -p'.$port.'"';
  120.     }
  122.     if (isset($properties['parameters']))
  123.     {
  124.       $parameters = $properties['parameters'];
  125.     }
  126.     else
  127.     {
  128.       $parameters = $options['rsync-options'];
  129.       if (file_exists($options['rsync-dir'].'/rsync_exclude.txt'))
  130.       {
  131.         $parameters .= sprintf(' --exclude-from=%s/rsync_exclude.txt', $options['rsync-dir']);
  132.       }
  134.       if (file_exists($options['rsync-dir'].'/rsync_include.txt'))
  135.       {
  136.         $parameters .= sprintf(' --include-from=%s/rsync_include.txt', $options['rsync-dir']);
  137.       }
  139.       if (file_exists($options['rsync-dir'].'/rsync.txt'))
  140.       {
  141.         $parameters .= sprintf(' --files-from=%s/rsync.txt', $options['rsync-dir']);
  142.       }
  143.     }
  145.     $dryRun = $options['go'] ? '' : '--dry-run';
  146.     $command = "rsync $dryRun $parameters -e $ssh ./ $user$host:$dir";
  148.     $this->getFilesystem()->execute($command, $options['trace'] ? array($this, 'logOutput') : null, array($this, 'logErrors'));
  150.     $this->clearBuffers();
  151.   }
  153.   public function logOutput($output)
  154.   {
  155.     if (false !== $pos = strpos($output, "\n"))
  156.     {
  157.       $this->outputBuffer .= substr($output, 0, $pos);
  158.       $this->log($this->outputBuffer);
  159.       $this->outputBuffer = substr($output, $pos + 1);
  160.     }
  161.     else
  162.     {
  163.       $this->outputBuffer .= $output;
  164.     }
  165.   }
  167.   public function logErrors($output)
  168.   {
  169.     if (false !== $pos = strpos($output, "\n"))
  170.     {
  171.       $this->errorBuffer .= substr($output, 0, $pos);
  172.       $this->log($this->formatter->format($this->errorBuffer, 'ERROR'));
  173.       $this->errorBuffer = substr($output, $pos + 1);
  174.     }
  175.     else
  176.     {
  177.       $this->errorBuffer .= $output;
  178.     }
  179.   }
  181.   protected function clearBuffers()
  182.   {
  183.     if ($this->outputBuffer)
  184.     {
  185.       $this->log($this->outputBuffer);
  186.       $this->outputBuffer = '';
  187.     }
  189.     if ($this->errorBuffer)
  190.     {
  191.       $this->log($this->formatter->format($this->errorBuffer, 'ERROR'));
  192.       $this->errorBuffer = '';
  193.     }
  194.   }
  195. }
Debug toolbar