1. sfGenerateAppTask.class.php
  2. /**
 * Generates a new application.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfGenerateAppTask.class.php 24039 2009-11-16 17:52:14Z Kris.Wallsmith $
 */
  3. class sfGenerateAppTask extends sfGeneratorBaseTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('app', sfCommandArgument::REQUIRED, 'The application name'),
  12.     ));
  14.     $this->addOptions(array(
  15.       new sfCommandOption('escaping-strategy', null, sfCommandOption::PARAMETER_REQUIRED, 'Output escaping strategy', true),
  16.       new sfCommandOption('csrf-secret', null, sfCommandOption::PARAMETER_REQUIRED, 'Secret to use for CSRF protection', true),
  17.     ));
  19.     $this->namespace = 'generate';
  20.     $this->name = 'app';
  22.     $this->briefDescription = 'Generates a new application';
  24.     $this->detailedDescription = <<<EOF
  25. The [generate:app|INFO] task creates the basic directory structure
  26. for a new application in the current project:
  28.   [./symfony generate:app frontend|INFO]
  30. This task also creates two front controller scripts in the
  31. [web/|COMMENT] directory:
  33.   [web/%application%.php|INFO]     for the production environment
  34.   [web/%application%_dev.php|INFO] for the development environment
  36. For the first application, the production environment script is named
  37. [index.php|COMMENT].
  39. If an application with the same name already exists,
  40. it throws a [sfCommandException|COMMENT].
  42. By default, the output escaping is enabled (to prevent XSS), and a random
  43. secret is also generated to prevent CSRF.
  45. You can disable output escaping by using the [escaping-strategy|COMMENT]
  46. option:
  48.   [./symfony generate:app frontend --escaping-strategy=false|INFO]
  50. You can enable session token in forms (to prevent CSRF) by defining
  51. a secret with the [csrf-secret|COMMENT] option:
  53.   [./symfony generate:app frontend --csrf-secret=UniqueSecret|INFO]
  55. You can customize the default skeleton used by the task by creating a
  56. [%sf_data_dir%/skeleton/app|COMMENT] directory.
  57. EOF;
  58.   }
  60.   /**
  61.    * @see sfTask
  62.    */
  63.   protected function execute($arguments = array(), $options = array())
  64.   {
  65.     $app = $arguments['app'];
  67.     // Validate the application name
  68.     if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $app))
  69.     {
  70.       throw new sfCommandException(sprintf('The application name "%s" is invalid.', $app));
  71.     }
  73.     $appDir = sfConfig::get('sf_apps_dir').'/'.$app;
  75.     if (is_dir($appDir))
  76.     {
  77.       throw new sfCommandException(sprintf('The application "%s" already exists.', $appDir));
  78.     }
  80.     if (is_readable(sfConfig::get('sf_data_dir').'/skeleton/app'))
  81.     {
  82.       $skeletonDir = sfConfig::get('sf_data_dir').'/skeleton/app';
  83.     }
  84.     else
  85.     {
  86.       $skeletonDir = dirname(__FILE__).'/skeleton/app';
  87.     }
  89.     // Create basic application structure
  90.     $finder = sfFinder::type('any')->discard('.sf');
  91.     $this->getFilesystem()->mirror($skeletonDir.'/app', $appDir, $finder);
  93.     // Create $app.php or index.php if it is our first app
  94.     $indexName = 'index';
  95.     $firstApp = !file_exists(sfConfig::get('sf_web_dir').'/index.php');
  96.     if (!$firstApp)
  97.     {
  98.       $indexName = $app;
  99.     }
  101.     if (true === $options['csrf-secret'])
  102.     {
  103.       $options['csrf-secret'] = sha1(rand(111111111, 99999999).getmypid());
  104.     }
  106.     // Set no_script_name value in settings.yml for production environment
  107.     $finder = sfFinder::type('file')->name('settings.yml');
  108.     $this->getFilesystem()->replaceTokens($finder->in($appDir.'/config'), '##', '##', array(
  109.       'NO_SCRIPT_NAME'    => $firstApp ? 'true' : 'false',
  110.       'CSRF_SECRET'       => sfYamlInline::dump(sfYamlInline::parseScalar($options['csrf-secret'])),
  111.       'ESCAPING_STRATEGY' => sfYamlInline::dump((boolean) sfYamlInline::parseScalar($options['escaping-strategy'])),
  112.       'USE_DATABASE'      => sfConfig::has('sf_orm') ? 'true' : 'false',
  113.     ));
  115.     $this->getFilesystem()->copy($skeletonDir.'/web/index.php', sfConfig::get('sf_web_dir').'/'.$indexName.'.php');
  116.     $this->getFilesystem()->copy($skeletonDir.'/web/index.php', sfConfig::get('sf_web_dir').'/'.$app.'_dev.php');
  118.     $this->getFilesystem()->replaceTokens(sfConfig::get('sf_web_dir').'/'.$indexName.'.php', '##', '##', array(
  119.       'APP_NAME'    => $app,
  120.       'ENVIRONMENT' => 'prod',
  121.       'IS_DEBUG'    => 'false',
  122.       'IP_CHECK'    => '',
  123.     ));
  125.     $this->getFilesystem()->replaceTokens(sfConfig::get('sf_web_dir').'/'.$app.'_dev.php', '##', '##', array(
  126.       'APP_NAME'    => $app,
  127.       'ENVIRONMENT' => 'dev',
  128.       'IS_DEBUG'    => 'true',
  129.       'IP_CHECK'    => '// this check prevents access to debug front controllers that are deployed by accident to production servers.'.PHP_EOL.
  130.                        '// feel free to remove this, extend it or make something more sophisticated.'.PHP_EOL.
  131.                        'if (!in_array(@$_SERVER[\'REMOTE_ADDR\'], array(\'127.0.0.1\', \'::1\')))'.PHP_EOL.
  132.                        '{'.PHP_EOL.
  133.                        '  die(\'You are not allowed to access this file. Check \'.basename(__FILE__).\' for more information.\');'.PHP_EOL.
  134.                        '}'.PHP_EOL,
  135.     ));
  137.     $this->getFilesystem()->rename($appDir.'/config/ApplicationConfiguration.class.php', $appDir.'/config/'.$app.'Configuration.class.php');
  139.     $this->getFilesystem()->replaceTokens($appDir.'/config/'.$app.'Configuration.class.php', '##', '##', array('APP_NAME' => $app));
  141.     $fixPerms = new sfProjectPermissionsTask($this->dispatcher, $this->formatter);
  142.     $fixPerms->setCommandApplication($this->commandApplication);
  143.     $fixPerms->setConfiguration($this->configuration);
  144.     $fixPerms->run();
  146.     // Create test dir
  147.     $this->getFilesystem()->mkdirs(sfConfig::get('sf_test_dir').'/functional/'.$app);
  148.   }
  149. }
Debug toolbar