Class.Crontab.php

Go to the documentation of this file.

<?php
/*
 * @author Anakeen
 * @package FDL
*/
/**
 * Crontab class
 *
 * This class allows you to manipulate a user crontab by registering
 * and unregistering cron files
 *
 * @author Anakeen
 * @version $Id: Class.Crontab.php,v 1.2 2009/01/16 15:51:35 jerome Exp $
 * @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 = tempnam(getTmpDir() , '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;
        }
        
        $newSectionElement = new \Dcp\CrontabSectionElement(DEFAULT_PUBDIR, $file);
        $newSectionElement->appendChild(new \Dcp\CrontabTextElement(sprintf("CONTEXT_ROOT=%s", DEFAULT_PUBDIR)));
        $newSectionElement->appendChild(new \Dcp\CrontabTextElement($crontab));
        
        $crontabData = $this->load();
        if ($crontabData === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading active crontab");
            return FALSE;
        }
        
        $parser = new \Dcp\CrontabParser();
        $crontabDocument = $parser->parse($crontabData);
        /* Remove existing sections for this context and file */
        $crontabDocument->childs = array_filter($crontabDocument->childs, function ($element) use ($file)
        {
            if (is_a($element, '\Dcp\CrontabSectionElement')) {
                /**
                 * @var $element \Dcp\CrontabSectionElement
                 */
                /* Keep sections that do not match this context/file */
                return !$element->match(DEFAULT_PUBDIR, $file);
            }
            /* Keep text elements */
            return true;
        });
        /* Add new section */
        $crontabDocument->appendChild($newSectionElement);
        
        $this->crontab = (string)$crontabDocument;
        
        printf("Saving crontab...\n");
        $ret = $this->save();
        if ($ret === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error saving crontab");
            return FALSE;
        }
        printf("Done.\n");
        
        return $this->crontab;
    }
    
    public function unregisterFile($file)
    {
        include_once ('WHAT/Lib.Prefix.php');
        
        $crontabData = $this->load();
        if ($crontabData === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading active crontab");
            return FALSE;
        }
        
        $parser = new \Dcp\CrontabParser();
        $crontabDocument = $parser->parse($crontabData);
        /* Remove existing sections for this context/file */
        $crontabDocument->childs = array_filter($crontabDocument->childs, function (\Dcp\CrontabElement & $element) use ($file)
        {
            if (is_a($element, '\Dcp\CrontabSectionElement')) {
                /**
                 * @var $element \Dcp\CrontabSectionElement
                 */
                /* Keep sections that do not match this context/file */
                return !$element->match(DEFAULT_PUBDIR, $file);
            }
            /* Keep other elements */
            return true;
        });
        
        $this->crontab = (string)$crontabDocument;
        
        printf("Saving crontab...\n");
        $ret = $this->save();
        if ($ret === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error saving crontab");
            return FALSE;
        }
        printf("Done.\n");
        
        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');
        
        $crontabData = $this->load();
        if ($crontabData === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading active crontab");
            return FALSE;
        }
        
        $parser = new \Dcp\CrontabParser();
        $crontabDocument = $parser->parse($crontabData);
        
        $crontabs = array();
        foreach ($crontabDocument->childs as & $element) {
            /**
             * @var $element \Dcp\CrontabSectionElement
             */
            if (is_a($element, '\Dcp\CrontabSectionElement') && $element->matchContextRoot(DEFAULT_PUBDIR)) {
                array_push($crontabs, array(
                    'file' => $element->file,
                    'content' => (string)$element
                ));
            }
        }
        unset($element);
        
        return $crontabs;
    }
    
    public function unregisterAll()
    {
        include_once ('WHAT/Lib.Prefix.php');
        
        $crontabData = $this->load();
        if ($crontabData === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error reading active crontab");
            return FALSE;
        }
        
        $parser = new \Dcp\CrontabParser();
        $crontabDocument = $parser->parse($crontabData);
        /* Remove existing sections for this context */
        $crontabDocument->childs = array_filter($crontabDocument->childs, function (\Dcp\CrontabElement & $element)
        {
            if (is_a($element, '\Dcp\CrontabSectionElement')) {
                /**
                 * @var $element \Dcp\CrontabSectionElement
                 */
                /* Keep sections that do not match the current context */
                return !$element->matchContextRoot(DEFAULT_PUBDIR);
            }
            /* Keep other elements */
            return true;
        });
        
        $this->crontab = (string)$crontabDocument;
        
        printf("Saving crontab...\n");
        $ret = $this->save();
        if ($ret === FALSE) {
            error_log(__CLASS__ . "::" . __FUNCTION__ . " Error saving crontab");
            return FALSE;
        }
        printf("Done.\n");
        
        return $this->crontab;
    }
}