Class.Crontab.php

Go to the documentation of this file.

<?php
/*
 * @author Anakeen
 * @license http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ Anakeen - licence CC
 * @package FDL
*/
/**
 * Crontab class
 *
 * This class allows you to manipulate a user crontab by registering
 * and unregistering cron files
 *
 * @author Anakeen 2009
 * @version $Id: Class.Crontab.php,v 1.2 2009/01/16 15:51:35 jerome Exp $
 * @license http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ Anakeen - licence CC
 * @package FDL
 * @subpackage
 */
/**
 */

class Crontab
{
    var $user = NULL;
    var $crontab = '';
    
    public function __construct($user = NULL)
    {
        $this->user = $user;
        return $this;
    }
    
    public function setUser($user)
    {
        $this->user = $user;
        return $this->user;
    }
    
    public function unsetUser()
    {
        $this->user = NULL;
        return $this->user;
    }
    
    private function load()
    {
        $cmd = 'crontab -l';
        if ($this->user != NULL) {
            $cmd.= ' -u ' . escapeshellarg($this->user);
        }
        $cmd.= ' 2> /dev/null';
        
        $ph = popen($cmd, 'r');
        if ($ph === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error popen");
            return FALSE;
        }
        
        $crontab = stream_get_contents($ph);
        if ($crontab === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error stream_get_contents");
            return FALSE;
        }
        
        $this->crontab = $crontab;
        
        return $crontab;
    }
    
    private function save()
    {
        include_once ('WHAT/Lib.System.php');
        
        $tmp = LibSystem::tempnam(null, 'crontab');
        if ($tmp === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error creating temporary file");
            return FALSE;
        }
        
        $ret = file_put_contents($tmp, $this->crontab);
        if ($ret === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error writing content to file '" . $tmp . "'");
            return FALSE;
        }
        
        $cmd = 'crontab';
        if ($this->user != NULL) {
            $cmd.= ' -u ' . escapeshellarg($this->user);
        }
        $cmd.= ' ' . escapeshellarg($tmp);
        $cmd.= ' > /dev/null 2>&1';
        
        system($cmd, $ret);
        if ($ret != 0) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error saving crontab '" . $tmp . "'");
            return FALSE;
        }
        
        return $this->crontab;
    }
    
    public function registerFile($file)
    {
        include_once ('WHAT/Lib.Prefix.php');
        
        $crontab = file_get_contents($file);
        if ($crontab === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading content from file '" . $file . "'");
            return FALSE;
        }
        
        $crontab = "# BEGIN:FREEDOM_CRONTAB:" . DEFAULT_PUBDIR . ":" . $file . "\n" . "CONTEXT_ROOT=" . DEFAULT_PUBDIR . "\n" . $crontab . "\n" . "# END:FREEDOM_CRONTAB:" . DEFAULT_PUBDIR . ":" . $file . "\n";
        
        $activeCrontab = $this->load();
        if ($activeCrontab === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading active crontab");
            return FALSE;
        }
        
        if (preg_match('/^#\s+BEGIN:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':' . preg_quote($file, '/') . '.*?#\s+END:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':' . preg_quote($file, '/') . '$/ms', $activeCrontab) === 1) {
            print "Removing existing crontab\n";
            $tmpCrontab = preg_replace('/^#\s+BEGIN:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':' . preg_quote($file, '/') . '.*?#\s+END:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':' . preg_quote($file, '/') . '$/ms', '', $activeCrontab);
            if ($tmpCrontab === NULL) {
                error_log(__CLASS__ . "::" . __FUNCTION__ . " Error removing existing registered crontab");
                return FALSE;
            }
            $activeCrontab = $tmpCrontab;
        }
        
        $activeCrontab.= $crontab;
        $this->crontab = $activeCrontab;
        
        $ret = $this->save();
        if ($ret === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error saving crontab");
            return FALSE;
        }
        
        return $this->crontab;
    }
    
    public function unregisterFile($file)
    {
        include_once ('WHAT/Lib.Prefix.php');
        
        $activeCrontab = $this->load();
        if ($activeCrontab === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading active crontab");
            return FALSE;
        }
        
        $tmpCrontab = preg_replace('/^#\s+BEGIN:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':' . preg_quote($file, '/') . '.*?#\s+END:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':' . preg_quote($file, '/') . '$/ms', '', $activeCrontab);
        if ($tmpCrontab === NULL) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error unregistering crontab '" . DEFAULT_PUBDIR . ":" . $file . "' from active crontab");
            return FALSE;
        }
        
        $this->crontab = $tmpCrontab;
        
        $ret = $this->save();
        if ($ret === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error saving crontab");
            return FALSE;
        }
        
        return $this->crontab;
    }
    
    public function listAll()
    {
        $crontabs = $this->getActiveCrontab();
        if ($crontabs === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error retrieving active crontabs");
            return FALSE;
        }
        
        print "\n";
        print "Active crontabs\n";
        print "---------------\n";
        print "\n";
        foreach ($crontabs as $crontab) {
            print "Crontab: " . $crontab['file'] . "\n";
            print "--8<--\n" . $crontab['content'] . "\n-->8--\n\n";
        }
        
        return TRUE;
    }
    
    public function getActiveCrontab()
    {
        include_once ('WHAT/Lib.Prefix.php');
        
        $activeCrontab = $this->load();
        if ($activeCrontab === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading active crontab");
            return FALSE;
        }
        
        $ret = preg_match_all('/^#\s+BEGIN:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':(.*?)\n(.*?)\n#\s+END:FREEDOM_CRONTAB:' . preg_quote(DEFAULT_PUBDIR, '/') . ':\1/ms', $activeCrontab, $matches, PREG_SET_ORDER);
        if ($ret === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error in preg_match_all");
            return FALSE;
        }
        
        $crontabs = array();
        foreach ($matches as $match) {
            array_push($crontabs, array(
                'file' => $match[1],
                'content' => $match[2]
            ));
        }
        
        return $crontabs;
    }
}
?>