File indexing completed on 2024-12-22 05:36:18

 <?php
 
 /**
  * @author   Ryan Faerman <ryan.faerman@gmail.com>
  * @author   Krzysztof Suszyński <k.suszynski@mediovski.pl>
  * @version  0.2
  * @package  php.manager.crontab
  *
  * Copyright (c) 2009 Ryan Faerman <ryan.faerman@gmail.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  *
  */
 
 //namespace Crontab\Manager;
 
 /**
  * Crontab manager implementation
  *
  * @author Krzysztof Suszyński <k.suszynski@mediovski.pl>
  * @author Ryan Faerman <ryan.faerman@gmail.com>
  */
 class Crontab_Manager_CrontabManager
 {
 
     /**
      * Location of the crontab executable
      *
      * @var string
      */
     public $crontab = '/usr/bin/crontab';
     public $cronContent = '';
 
     /**
      * Name of user to install crontab
      *
      * @var string
      */
     public $user = null;
     /**
      * @var boolean
      */
     public $prependRootPath = true;
     /**
      * Location to save the crontab file.
      *
      * @var string
      */
     private $_tmpfile;
     /**
      * @var CronEntry[]
      */
     private $jobs = array();
     /**
      * @var CronEntry[]
      */
     private $replace = array();
     /**
      * @var CronEntry[]
      */
     private $files = array();
     /**
      * @var array
      */
     private $fileHashes = array();
     /**
      * @var array
      */
     private $filesToRemove = array();
     /**
      * @var string[]
      */
     private $_comments = array();
     /**
      * @var string
      */
     private $_beginBlock = 'BEGIN:%s';
     /**
      * @var string
      */
     private $_endBlock = 'END:%s';
     /**
      * @var string
      */
     private $_before = "Autogenerated by CrontabManager.\n# Do not edit. Orginal file: %s";
     /**
      * @var string
      */
     private $_after = 'End of autogenerated code.';
 
     /**
      * Constructor
      *
      * @return void
      */
     public function __construct()
     {
         $this->_setTempFile();
     }
 
     /**
      * Sets tempfile name
      *
      * @return Crontab_Manager_CrontabManager
      */
     protected function _setTempFile()
     {
         if ($this->_tmpfile && is_file($this->_tmpfile)) {
             unlink($this->_tmpfile);
         }
         $tmpDir = sys_get_temp_dir();
         $this->_tmpfile = tempnam($tmpDir, 'cronman');
         chmod($this->_tmpfile, 0666);
 
         return $this;
     }
 
     /**
      * Destrutor
      */
     public function __destruct()
     {
         if ($this->_tmpfile && is_file($this->_tmpfile)) {
             unlink($this->_tmpfile);
         }
     }
 
     /**
      * Replace job with another one
      *
      * @param Crontab_Manager_CronEntry $from
      * @param Crontab_Manager_CronEntry $to
      *
      * @return Crontab_Manager_CrontabManager
      */
     public function replace(Crontab_Manager_CronEntry $from, Crontab_Manager_CronEntry $to)
     {
         $this->replace[] = array($from, $to);
         return $this;
     }
 
     /**
      * Reads cron file and adds jobs to list
      *
      * @param string $filename
      *
      * @returns Crontab_Manager_CrontabManager
      * @throws \InvalidArgumentException
      */
     public function enableOrUpdate($filename)
     {
         $path = realpath($filename);
         if (!$path || !is_readable($path)) {
             throw new \InvalidArgumentException(
                 sprintf(
                     '"%s" don\'t exists or isn\'t readable', $filename
                 )
             );
         }
         $hash = $this->_shortHash($path);
 
         if (isset($this->filesToRemove[$hash])) {
             unset($this->filesToRemove[$hash]);
         }
         $this->fileHashes[$path] = $hash;
         $jobs = $this->_parseFile($path, $hash);
         foreach ($jobs as $job) {
             $this->add($job, $path);
         }
 
         return $this;
     }
 
     /**
      * Calculates short hash of string
      *
      * @param string $input
      * @return string
      */
     private function _shortHash($input)
     {
         $hash = base_convert(
             $this->_signedInt(crc32($input)), 10, 36
         );
         return $hash;
     }
 
     /**
      * Gets signed int from unsigned 64bit int
      *
      * @param integer $in
      * @return integer
      */
     private static function _signedInt($in)
     {
         $int_max = 2147483647; // pow(2, 31) - 1
         if ($in > $int_max) {
             $out = $in - $int_max * 2 - 2;
         } else {
             $out = $in;
         }
         return $out;
     }
 
     /**
      * Parse input cron file to cron entires
      *
      * @param string $path
      * @param string $hash
      *
      * @return Crontab_Manager_CronEntry[]
      * @throws \InvalidArgumentException
      */
     private function _parseFile($path, $hash)
     {
         $jobs = array();
 
         $lines = file($path);
         foreach ($lines as $lineno => $line) {
             try {
                 $job = $this->newJob($line, $hash);
                 if ($this->prependRootPath) {
                     $job->setRootForCommands(dirname($path));
                 }
                 $job->addComments($this->_comments);
                 $this->_comments = array();
                 $jobs[] = $job;
             } catch (\Exception $exc) {
                 if (preg_match('/^\s*\#/', $line)) {
                     $this->_comments[] = trim($line);
                 } elseif (trim($line) == '') {
                     $this->_comments = array();
                     continue;
                 } else {
                     $msg = sprintf('Line #%d of file: "%s" is invalid!', $lineno, $path);
                     throw new \InvalidArgumentException($msg);
                 }
             }
         }
         return $jobs;
     }
 
     /**
      * Creates new job
      *
      * @param string $jobSpec
      * @param string $group
      *
      * @return CronEntry
      */
     public function newJob($jobSpec = null, $group = null)
     {
         return new Crontab_Manager_CronEntry($jobSpec, $this, $group);
     }
 
     /**
      * Adds job to managed list
      *
      * @param Crontab_Manager_CronEntry $job
      * @param string $file optional
      *
      * @return Crontab_Manager_CrontabManager
      */
     public function add(Crontab_Manager_CronEntry $job, $file = null)
     {
         if (!$file) {
             $this->jobs[] = $job;
         } else {
             if (!isset($this->files[$file])) {
                 $this->files[$file] = array();
                 $hash = $this->_shortHash($file);
                 $this->fileHashes[$file] = $hash;
             }
             $this->files[$file][] = $job;
         }
         return $this;
     }
 
     /**
      * Disable file from crontab
      *
      * @param string $filename
      *
      * @return Crontab_Manager_CrontabManager
      * @throws \InvalidArgumentException
      */
     public function disable($filename)
     {
         $path = realpath($filename);
         if (!$path || !is_readable($path)) {
             throw new \InvalidArgumentException(
                 sprintf(
                     '"%s" don\'t exists or isn\'t readable', $filename
                 )
             );
         }
         $hash = $this->_shortHash($path);
         if (isset($this->fileHashes[$path])) {
             unset($this->fileHashes[$path]);
             unset($this->files[$path]);
         }
         $this->filesToRemove[$hash] = $path;
 
         return $this;
     }
 
     /**
      * Save the jobs to disk, remove existing cron
      *
      * @param boolean $includeOldJobs optional
      *
      * @return boolean
      * @throws \UnexpectedValueException
      */
     public function save($includeOldJobs = true)
     {
         $this->cronContent = '';
         if ($includeOldJobs) {
             try {
                 $this->cronContent = $this->listJobs();
             } catch (\UnexpectedValueException $e) {
 
             }
         }
 
         $this->cronContent = $this->_prepareContents($this->cronContent);
 
         $this->_replaceCronContents();
     }
 
     /**
      * List current cron jobs
      *
      * @return string
      * @throws \UnexpectedValueException
      */
     public function listJobs()
     {
         $out = $this->_exec($this->_command() . ' -l', $retVal);
         if ($retVal != 0) {
             throw new \UnexpectedValueException('No cron file or no permissions to list', $retVal);
         }
         return $out;
     }
 
     /**
      * Runs command in terminal
      *
      * @param string $command
      * @param integer $returnVal
      *
      * @return string
      */
     private function _exec($command, & $returnVal)
     {
         ob_start();
         system($command, $returnVal);
         $output = ob_get_clean();
         return $output;
     }
 
     /**
      * calcuates crontab command
      *
      * @return string
      */
     protected function _command()
     {
         $cmd = '';
         if ($this->user) {
             $cmd .= sprintf('sudo -u %s ', $this->user);
         }
         $cmd .= $this->crontab;
         return $cmd;
     }
 
     /**
      * @param string $contents
      *
      * @return string
      */
     private function _prepareContents($contents)
     {
         if (empty($contents)) {
             $contents = array();
         } else {
             $contents = explode("\n", $contents);
         }
 
         foreach ($this->filesToRemove as $hash => $path) {
             $contents = $this->_removeBlock($contents, $hash);
         }
 
         foreach ($this->fileHashes as $file => $hash) {
             $contents = $this->_removeBlock($contents, $hash);
             $contents = $this->_addBlock($contents, $file, $hash);
         }
         if ($this->jobs) {
             $contents[] = '';
         }
         foreach ($this->jobs as $job) {
             $contents[] = $job;
         }
         $out = $this->_doReplace($contents);
         $out = preg_replace('/[\n]{3,}/m', "\n\n", $out);
         return trim($out) . "\n";
     }
 
     /**
      * @param array $contents
      * @param string $hash
      *
      * @return array
      */
     private function _removeBlock(array $contents, $hash)
     {
         $from = sprintf('# ' . $this->_beginBlock, $hash);
         $to = sprintf('# ' . $this->_endBlock, $hash);
         $cut = false;
         $toCut = array();
         foreach ($contents as $no => $line) {
             if (substr($line, 0, strlen($from)) == $from) {
                 $cut = true;
             }
             if ($cut) {
                 $toCut[] = $no;
             }
             if (substr($line, 0, strlen($to)) == $to) {
                 break;
             }
         }
         foreach ($toCut as $lineNo) {
             unset($contents[$lineNo]);
         }
         return $contents;
     }
 
     /**
      * @param array $contents
      * @param string $file
      * @param string $hash
      *
      * @return array
      */
     private function _addBlock(array $contents, $file, $hash)
     {
         $pre = sprintf('# ' . $this->_beginBlock, $hash);
         $pre .= sprintf(' ' . $this->_before, $file);
         $contents[] = $pre;
         $contents[] = '';
 
         foreach ($this->files as $jobs) {
             foreach ($jobs as $job) {
                 $contents[] = $job;
             }
         }
 
         $contents[] = '';
         $after = sprintf('# ' . $this->_endBlock, $hash);
         $after .= ' ' . $this->_after;
         $contents[] = $after;
 
         return $contents;
     }
 
     /**
      * @param array $contents
      *
      * @return string
      */
     private function _doReplace(array $contents)
     {
         $out = join("\n", $contents);
         foreach ($this->replace as $entry) {
             list($fromJob, $toTob) = $entry;
             $from = $fromJob->render(false);
             /* @var $fromJob Crontab_Manager_CronEntry */
             $out = str_replace($fromJob, $toTob, $out);
             /* @var $toTob Crontab_Manager_CronEntry */
             $out = str_replace($from, $toTob, $out);
         }
         return $out;
     }
 
     /**
      * Replaces cron contents
      *
      * @throws \UnexpectedValueException
      * @return Crontab_Manager_CrontabManager
      */
     protected function _replaceCronContents()
     {
         file_put_contents($this->_tmpfile, $this->cronContent, LOCK_EX);
         $out = $this->_exec($this->_command() . ' ' .
             $this->_tmpfile . ' 2>&1', $ret);
         $this->_setTempFile();
         if ($ret != 0) {
             throw new \UnexpectedValueException(
                 $out . "\n" . $this->cronContent, $ret
             );
         }
         return $this;
     }
 
     /**
      * Cleans an instance without saving to disk
      *
      * @return Crontab_Manager_CrontabManager
      */
     public function cleanManager()
     {
         $this->fileHashes = array();
         $this->jobs = array();
         $this->files = array();
         $this->replace = array();
         $this->filesToRemove = array();
 
         return $this;
     }
 
     /**
      * Delete one job from current jobs.
      * <p>
      * Exemple of use:
      * </p>
      * <pre>
      * $crontab = new Crontab_Manager_CrontabManager();
      * $crontab->deleteJob("ms8xjs");
      * $crontab->save(false);
      * </pre>
      *
      * @param string $job id or part of description of the job you wanna delete
      * @return int number of jobs deleted
      */
     function deleteJob($job = null)
     {
         $jobsDeleted = 0;
         if (!is_null($job)) {
             $data = array();
             $oldJobs = explode("\n", $this->listJobs()); // get the old jobs
             if (is_array($oldJobs)) {
                 foreach ($oldJobs as $oldJob) {
                     if ($oldJob != '') {
                         if (!preg_match('/' . $job . '/', $oldJob)) {
                             $newJob = new Crontab_Manager_CronEntry($oldJob, $this);
                             $newJob->lineComment = '';
                             $data[] = $newJob;
                         } else {
                             $jobsDeleted++;
                         }
                     }
                 }
             }
             $this->jobs = $data;
         }
         return $jobsDeleted;
     }
 
     /**
      * Verify if a job exists or not.
      * <p>
      * Exemple of uses:
      * </p>
      * <pre>
      * $crontab = new Crontab_Manager_CrontabManager();
      * $result = $crontab->jobExists("* * * * * /path/to/job");
      * </pre>
      *
      * @param string $job id or part of description of the job you wanna verify if exists or not
      * @return boolean [true|false] true if exists. false if not exists
      */
     function jobExists($job = null)
     {
         if (!is_null($job)) {
             $jobs = explode("\n", $this->listJobs()); // get the old jobs
             $needle = $job->__toString();
             if (is_array($jobs)) {
                 foreach ($jobs as $oneJob) {
                     if ($oneJob != '') {
                         if (false !== strpos($oneJob, $needle)) {
                             return true;
                         }
 //                        if (false !== preg_match('/' . $needle . '/', $oneJob)) {
 //                            return true;
 //                        } else {
 //                            $dummy = preg_last_error();
 //                        }
                     }
                 }
             }
         }
         return false;
     }
 
 }