1. sfLogRotateTask.class.php
  2. /**
 * Rotates an application log files.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfLogRotateTask.class.php 24331 2009-11-24 13:15:01Z Kris.Wallsmith $
 */
  3. class sfLogRotateTask extends sfBaseTask
  4. {
  5.   /** the default period to rotate logs in days */
  6.   const DEF_PERIOD = 7;
  8.   /** the default number of log historys to store, one history is created for every period */
  9.   const DEF_HISTORY = 10;
  11.   /**
  12.    * @see sfTask
  13.    */
  14.   protected function configure()
  15.   {
  16.     $this->addArguments(array(
  17.       new sfCommandArgument('application', sfCommandArgument::REQUIRED, 'The application name'),
  18.       new sfCommandArgument('env', sfCommandArgument::REQUIRED, 'The environment name'),
  19.     ));
  21.     $this->addOptions(array(
  22.       new sfCommandOption('history', null, sfCommandOption::PARAMETER_REQUIRED, 'The maximum number of old log files to keep', self::DEF_HISTORY),
  23.       new sfCommandOption('period', null, sfCommandOption::PARAMETER_REQUIRED, 'The period in days', self::DEF_PERIOD),
  24.     ));
  26.     $this->namespace = 'log';
  27.     $this->name = 'rotate';
  28.     $this->briefDescription = 'Rotates an application\'s log files';
  30.     $this->detailedDescription = <<<EOF
  31. The [log:rotate|INFO] task rotates application log files for a given
  32. environment:
  34.   [./symfony log:rotate frontend dev|INFO]
  36. You can specify a [period|COMMENT] or a [history|COMMENT] option:
  38.   [./symfony log:rotate frontend dev --history=10 --period=7|INFO]
  39. EOF;
  40.   }
  42.   /**
  43.    * @see sfTask
  44.    */
  45.   protected function execute($arguments = array(), $options = array())
  46.   {
  47.     $this->rotate($arguments['application'], $arguments['env'], $options['period'], $options['history'], true);
  48.   }
  50.   /**
  51.    * Rotates log file.
  52.    *
  53.    * @param  string $app       Application name
  54.    * @param  string $env       Enviroment name
  55.    * @param  string $period    Period 
  56.    * @param  string $history   History
  57.    * @param  bool   $override  Override
  58.    *
  59.    * @author Joe Simms
  60.    **/
  61.   public function rotate($app, $env, $period = null, $history = null, $override = false)
  62.   {
  63.     $logfile = $app.'_'.$env;
  64.     $logdir = sfConfig::get('sf_log_dir');
  66.     // set history and period values if not passed to default values
  67.     $period = isset($period) ? $period : self::DEF_PERIOD;
  68.     $history = isset($history) ? $history : self::DEF_HISTORY;
  70.     // get todays date
  71.     $today = date('Ymd');
  73.     // check history folder exists
  74.     if (!is_dir($logdir.'/history'))
  75.     {
  76.       $this->getFilesystem()->mkdirs($logdir.'/history');
  77.     }
  79.     // determine date of last rotation
  80.     $logs = sfFinder::type('file')->maxdepth(1)->name($logfile.'_*.log')->sort_by_name()->in($logdir.'/history');
  81.     $recentlog = is_array($logs) ? array_pop($logs) : null;
  83.     if ($recentlog)
  84.     {
  85.       // calculate date to rotate logs on
  86.       $lastRotatedOn = filemtime($recentlog);
  87.       $rotateOn = date('Ymd', strtotime('+ '.$period.' days', $lastRotatedOn));
  88.     }
  89.     else
  90.     {
  91.       // no rotation has occured yet
  92.       $rotateOn = null;
  93.     }
  95.     $srcLog = $logdir.'/'.$logfile.'.log';
  96.     $destLog = $logdir.'/history/'.$logfile.'_'.$today.'.log';
  98.     // if rotate log on date doesn't exist, or that date is today, then rotate the log
  99.     if (!$rotateOn || ($rotateOn == $today) || $override)
  100.     {
  101.       // create a lock file
  102.       $lockFile = sfConfig::get('sf_data_dir').'/'.$app.'_'.$env.'-cli.lck';
  103.       $this->getFilesystem()->touch($lockFile);
  105.       // change mode so the web user can remove it if we die
  106.       $this->getFilesystem()->chmod($lockFile, 0777);
  108.       // if log file exists rotate it
  109.       if (file_exists($srcLog))
  110.       {
  111.         // check if the log file has already been rotated today
  112.         if (file_exists($destLog))
  113.         {
  114.           // append log to existing rotated log
  115.           $handle = fopen($destLog, 'a');
  116.           $append = file_get_contents($srcLog);
  118.           $this->logSection('file+', $destLog);
  119.           fwrite($handle, $append);
  120.         }
  121.         else
  122.         {
  123.           // copy log
  124.           $this->getFilesystem()->copy($srcLog, $destLog);
  125.         }
  127.         // remove the log file
  128.         $this->getFilesystem()->remove($srcLog);
  130.         // get all log history files for this application and environment
  131.         $newLogs = sfFinder::type('file')->maxdepth(1)->name($logfile.'_*.log')->sort_by_name()->in($logdir.'/history');
  133.         // if the number of logs in history exceeds history then remove the oldest log
  134.         if (count($newLogs) > $history)
  135.         {
  136.           $this->getFilesystem()->remove($newLogs[0]);
  137.         }
  138.       }
  140.       // release lock
  141.       $this->getFilesystem()->remove($lockFile);
  142.     }
  143.   }
  144. }
Debug toolbar