1. sfCacheClearTask.class.php
  2. /**
 * Clears the symfony cache.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCacheClearTask.class.php 23922 2009-11-14 14:58:38Z fabien $
 */
  3. class sfCacheClearTask extends sfBaseTask
  4. {
  5.   protected
  6.     $config = null;
  8.   /**
  9.    * @see sfTask
  10.    */
  11.   protected function configure()
  12.   {
  13.     $this->addOptions(array(
  14.       new sfCommandOption('app', null, sfCommandOption::PARAMETER_OPTIONAL, 'The application name', null),
  15.       new sfCommandOption('env', null, sfCommandOption::PARAMETER_OPTIONAL, 'The environment', null),
  16.       new sfCommandOption('type', null, sfCommandOption::PARAMETER_OPTIONAL, 'The type', 'all'),
  17.     ));
  19.     $this->aliases = array('cc');
  20.     $this->namespace = 'cache';
  21.     $this->name = 'clear';
  22.     $this->briefDescription = 'Clears the cache';
  24.     $this->detailedDescription = <<<EOF
  25. The [cache:clear|INFO] task clears the symfony cache.
  27. By default, it removes the cache for all available types, all applications,
  28. and all environments.
  30. You can restrict by type, application, or environment:
  32. For example, to clear the [frontend|COMMENT] application cache:
  34.   [./symfony cache:clear --app=frontend|INFO]
  36. To clear the cache for the [prod|COMMENT] environment for the [frontend|COMMENT] application:
  38.   [./symfony cache:clear --app=frontend --env=prod|INFO]
  40. To clear the cache for all [prod|COMMENT] environments:
  42.   [./symfony cache:clear --env=prod|INFO]
  44. To clear the [config|COMMENT] cache for all [prod|COMMENT] environments:
  46.   [./symfony cache:clear --type=config --env=prod|INFO]
  48. The built-in types are: [config|COMMENT], [i18n|COMMENT], [routing|COMMENT], [module|COMMENT]
  49. and [template|COMMENT].
  51. EOF;
  52.   }
  54.   /**
  55.    * @see sfTask
  56.    */
  57.   protected function execute($arguments = array(), $options = array())
  58.   {
  59.     if (!sfConfig::get('sf_cache_dir') || !is_dir(sfConfig::get('sf_cache_dir')))
  60.     {
  61.       throw new sfException(sprintf('Cache directory "%s" does not exist.', sfConfig::get('sf_cache_dir')));
  62.     }
  64.     // finder to find directories (1 level) in a directory
  65.     $dirFinder = sfFinder::type('dir')->discard('.sf')->maxdepth(0)->relative();
  67.     // iterate through applications
  68.     $apps = null === $options['app'] ? $dirFinder->in(sfConfig::get('sf_apps_dir')) : array($options['app']);
  69.     foreach ($apps as $app)
  70.     {
  71.       $this->checkAppExists($app);
  73.       if (!is_dir(sfConfig::get('sf_cache_dir').'/'.$app))
  74.       {
  75.         continue;
  76.       }
  78.       // iterate through environments
  79.       $envs = null === $options['env'] ? $dirFinder->in(sfConfig::get('sf_cache_dir').'/'.$app) : array($options['env']);
  80.       foreach ($envs as $env)
  81.       {
  82.         if (!is_dir(sfConfig::get('sf_cache_dir').'/'.$app.'/'.$env))
  83.         {
  84.           continue;
  85.         }
  87.         $this->logSection('cache', sprintf('Clearing cache type "%s" for "%s" app and "%s" env', $options['type'], $app, $env));
  89.         $appConfiguration = ProjectConfiguration::getApplicationConfiguration($app, $env, true);
  91.         $this->lock($app, $env);
  93.         $event = $appConfiguration->getEventDispatcher()->notifyUntil(new sfEvent($this, 'task.cache.clear', array('app' => $appConfiguration, 'env' => $env, 'type' => $options['type'])));
  94.         if (!$event->isProcessed())
  95.         {
  96.           // default cleaning process
  97.           $method = $this->getClearCacheMethod($options['type']);
  98.           if (!method_exists($this, $method))
  99.           {
  100.             throw new InvalidArgumentException(sprintf('Do not know how to remove cache for type "%s".', $options['type']));
  101.           }
  102.           $this->$method($appConfiguration);
  103.         }
  105.         $this->unlock($app, $env);
  106.       }
  107.     }
  109.     // clear global cache
  110.     if (null === $options['app'] && 'all' == $options['type'])
  111.     {
  112.       $this->getFilesystem()->remove(sfFinder::type('file')->discard('.sf')->in(sfConfig::get('sf_cache_dir')));
  113.     }
  114.   }
  116.   protected function getClearCacheMethod($type)
  117.   {
  118.     return sprintf('clear%sCache', ucfirst($type));
  119.   }
  121.   protected function clearAllCache(sfApplicationConfiguration $appConfiguration)
  122.   {
  123.     $this->clearI18NCache($appConfiguration);
  124.     $this->clearRoutingCache($appConfiguration);
  125.     $this->clearTemplateCache($appConfiguration);
  126.     $this->clearModuleCache($appConfiguration);
  127.     $this->clearConfigCache($appConfiguration);
  128.   }
  130.   protected function clearConfigCache(sfApplicationConfiguration $appConfiguration)
  131.   {
  132.     $subDir = sfConfig::get('sf_cache_dir').'/'.$appConfiguration->getApplication().'/'.$appConfiguration->getEnvironment().'/config';
  134.     if (is_dir($subDir))
  135.     {
  136.       // remove cache files
  137.       $this->getFilesystem()->remove(sfFinder::type('file')->discard('.sf')->in($subDir));
  138.     }
  139.   }
  141.   protected function clearI18NCache(sfApplicationConfiguration $appConfiguration)
  142.   {
  143.     $config = $this->getFactoriesConfiguration($appConfiguration);
  145.     if (isset($config['i18n']['param']['cache']))
  146.     {
  147.       $this->cleanCacheFromFactoryConfig($config['i18n']['param']['cache']);
  148.     }
  149.   }
  151.   protected function clearRoutingCache(sfApplicationConfiguration $appConfiguration)
  152.   {
  153.     $config = $this->getFactoriesConfiguration($appConfiguration);
  155.     if (isset($config['routing']['param']['cache']))
  156.     {
  157.       $this->cleanCacheFromFactoryConfig($config['routing']['param']['cache']);
  158.     }
  159.   }
  161.   protected function clearTemplateCache(sfApplicationConfiguration $appConfiguration)
  162.   {
  163.     $config = $this->getFactoriesConfiguration($appConfiguration);
  165.     if (isset($config['view_cache']))
  166.     {
  167.       $this->cleanCacheFromFactoryConfig($config['view_cache']);
  168.     }
  169.   }
  171.   protected function clearModuleCache(sfApplicationConfiguration $appConfiguration)
  172.   {
  173.     $subDir = sfConfig::get('sf_cache_dir').'/'.$appConfiguration->getApplication().'/'.$appConfiguration->getEnvironment().'/modules';
  175.     if (is_dir($subDir))
  176.     {
  177.       // remove cache files
  178.       $this->getFilesystem()->remove(sfFinder::type('file')->discard('.sf')->in($subDir));
  179.     }
  180.   }
  182.   public function getFactoriesConfiguration(sfApplicationConfiguration $appConfiguration)
  183.   {
  184.     $app = $appConfiguration->getApplication();
  185.     $env = $appConfiguration->getEnvironment();
  187.     if (!isset($this->config[$app]))
  188.     {
  189.       $this->config[$app] = array();
  190.     }
  192.     if (!isset($this->config[$app][$env]))
  193.     {
  194.       $this->config[$app][$env] = sfFactoryConfigHandler::getConfiguration($appConfiguration->getConfigPaths('config/factories.yml'));
  195.     }
  197.     return $this->config[$app][$env] ;
  198.   }
  200.   public function cleanCacheFromFactoryConfig($class, $parameters = array())
  201.   {
  202.     if ($class)
  203.     {
  204.       // the standard array with ['class'] and ['param'] can be passed as well
  205.       if (is_array($class))
  206.       {
  207.         if (!isset($class['class']))
  208.         {
  209.           return;
  210.         }
  211.         if (isset($class['param']))
  212.         {
  213.           $parameters = $class['param'];
  214.         }
  215.         $class = $class['class'];
  216.       }
  217.       $cache = new $class($parameters);
  218.       $cache->clean();
  219.     }
  220.   }
  222.   protected function lock($app, $env)
  223.   {
  224.     // create a lock file
  225.     $this->getFilesystem()->touch($this->getLockFile($app, $env));
  227.     // change mode so the web user can remove it if we die
  228.     $this->getFilesystem()->chmod($this->getLockFile($app, $env), 0777);
  229.   }
  231.   protected function unlock($app, $env)
  232.   {
  233.     // release lock
  234.     $this->getFilesystem()->remove($this->getLockFile($app, $env));
  235.   }
  237.   protected function getLockFile($app, $env)
  238.   {
  239.     return sfConfig::get('sf_data_dir').'/'.$app.'_'.$env.'-cli.lck';
  240.   }
  241. }
Debug toolbar