1. sfGenerateProjectTask.class.php
  2. /**
 * Generates a new project.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfGenerateProjectTask.class.php 27211 2010-01-26 20:23:26Z FabianLange $
 */
  3. class sfGenerateProjectTask extends sfGeneratorBaseTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function doRun(sfCommandManager $commandManager, $options)
  9.   {
  10.     $this->process($commandManager, $options);
  12.     return $this->execute($commandManager->getArgumentValues(), $commandManager->getOptionValues());
  13.   }
  15.   /**
  16.    * @see sfTask
  17.    */
  18.   protected function configure()
  19.   {
  20.     $this->addArguments(array(
  21.       new sfCommandArgument('name', sfCommandArgument::REQUIRED, 'The project name'),
  22.       new sfCommandArgument('author', sfCommandArgument::OPTIONAL, 'The project author', 'Your name here'),
  23.     ));
  25.     $this->addOptions(array(
  26.       new sfCommandOption('orm', null, sfCommandOption::PARAMETER_REQUIRED, 'The ORM to use by default', 'Doctrine'),
  27.       new sfCommandOption('installer', null, sfCommandOption::PARAMETER_REQUIRED, 'An installer script to execute', null),
  28.     ));
  30.     $this->namespace = 'generate';
  31.     $this->name = 'project';
  33.     $this->briefDescription = 'Generates a new project';
  35.     $this->detailedDescription = <<<EOF
  36. The [generate:project|INFO] task creates the basic directory structure
  37. for a new project in the current directory:
  39.   [./symfony generate:project blog|INFO]
  41. If the current directory already contains a symfony project,
  42. it throws a [sfCommandException|COMMENT].
  44. By default, the task configures Doctrine as the ORM. If you want to use
  45. Propel, use the [--orm|COMMENT] option:
  47.   [./symfony generate:project blog --orm=Propel|INFO]
  49. If you don't want to use an ORM, pass [none|COMMENT] to [--orm|COMMENT] option:
  51.   [./symfony generate:project blog --orm=none|INFO]
  53. You can also pass the [--installer|COMMENT] option to further customize the
  54. project:
  56.   [./symfony generate:project blog --installer=./installer.php|INFO]
  58. You can optionally include a second [author|COMMENT] argument to specify what name to
  59. use as author when symfony generates new classes:
  61.   [./symfony generate:project blog "Jack Doe"|INFO]
  62. EOF;
  63.   }
  65.   /**
  66.    * @see sfTask
  67.    */
  68.   protected function execute($arguments = array(), $options = array())
  69.   {
  70.     if (file_exists('symfony'))
  71.     {
  72.       throw new sfCommandException(sprintf('A symfony project already exists in this directory (%s).', getcwd()));
  73.     }
  75.     if (!in_array(strtolower($options['orm']), array('propel', 'doctrine', 'none')))
  76.     {
  77.       throw new InvalidArgumentException(sprintf('Invalid ORM name "%s".', $options['orm']));
  78.     }
  80.     if ($options['installer'] && $this->commandApplication && !file_exists($options['installer']))
  81.     {
  82.       throw new InvalidArgumentException(sprintf('The installer "%s" does not exist.', $options['installer']));
  83.     }
  85.     // clean orm option
  86.     $options['orm'] = ucfirst(strtolower($options['orm']));
  88.     $this->arguments = $arguments;
  89.     $this->options = $options;
  91.     // create basic project structure
  92.     $this->installDir(dirname(__FILE__).'/skeleton/project');
  94.     // update ProjectConfiguration class (use a relative path when the symfony core is nested within the project)
  95.     $symfonyCoreAutoload = 0 === strpos(sfConfig::get('sf_symfony_lib_dir'), sfConfig::get('sf_root_dir')) ?
  96.       sprintf('dirname(__FILE__).\'/..%s/autoload/sfCoreAutoload.class.php\'', str_replace(sfConfig::get('sf_root_dir'), '', sfConfig::get('sf_symfony_lib_dir'))) :
  97.       var_export(sfConfig::get('sf_symfony_lib_dir').'/autoload/sfCoreAutoload.class.php', true);
  99.     $this->replaceTokens(array(sfConfig::get('sf_config_dir')), array('SYMFONY_CORE_AUTOLOAD' => $symfonyCoreAutoload));
  101.     $this->tokens = array(
  102.       'ORM'          => $this->options['orm'],
  103.       'PROJECT_NAME' => $this->arguments['name'],
  104.       'AUTHOR_NAME'  => $this->arguments['author'],
  105.       'PROJECT_DIR'  => sfConfig::get('sf_root_dir'),
  106.     );
  108.     $this->replaceTokens();
  110.     // execute the choosen ORM installer script
  111.     if (in_array($options['orm'], array('Doctrine', 'Propel')))
  112.     {
  113.       include dirname(__FILE__).'/../../plugins/sf'.$options['orm'].'Plugin/config/installer.php';
  114.     }
  116.     // execute a custom installer
  117.     if ($options['installer'] && $this->commandApplication)
  118.     {
  119.       if ($this->canRunInstaller($options['installer']))
  120.       {
  121.         $this->reloadTasks();
  122.         include $options['installer'];
  123.       }
  124.     }
  126.     // fix permission for common directories
  127.     $fixPerms = new sfProjectPermissionsTask($this->dispatcher, $this->formatter);
  128.     $fixPerms->setCommandApplication($this->commandApplication);
  129.     $fixPerms->setConfiguration($this->configuration);
  130.     $fixPerms->run();
  132.     $this->replaceTokens();
  133.   }
  135.   protected function canRunInstaller($installer)
  136.   {
  137.     if (preg_match('#^(https?|ftps?)://#', $installer))
  138.     {
  139.       if (ini_get('allow_url_fopen') === false)
  140.       {
  141.         $this->logSection('generate', sprintf('Cannot run remote installer "%s" because "allow_url_fopen" is off', $installer));
  142.       }
  143.       if (ini_get('allow_url_include') === false)
  144.       {
  145.         $this->logSection('generate', sprintf('Cannot run remote installer "%s" because "allow_url_include" is off', $installer));
  146.       }
  147.       return ini_get('allow_url_fopen') && ini_get('allow_url_include');
  148.     }
  149.     return true;
  150.   }
  151. }
Debug toolbar