battis / autocrontabjob

src/AutoCrontabJob.php

<?php

/** AutoCrontabJob and related classes */

namespace Battis;

/**
 * An object-oriented approach to scheduling regular cron jobs automatically
 *
 * @author Seth Battis <seth@battis.net>
 **/
abstract class AutoCrontabJob
{
    /** @var \TiBeN\CrontabManager\CrontabRepository Crontab management */
    private $cron = null;

    /** @var \Log A Pear Log handle */
    protected $log = null;

    /**
     * Construct a new AutoCrontabJob
     *
     * @param string $identifier Hopefully unique!
     * @param string $script Path to data collection script (probably `__FILE__`)
     * @param string|TiBeN\CrontabManager\CrontabJob Cron schedule or a complete

The type Battis\Cron was not found. Maybe you did not declare it correctly or list all dependencies?

     *        `TiBeN\CrontabManager\CrontabJob`
     * @param string (Optional) path to log file (defaults to same directory and

The type Battis\Optional was not found. Maybe you did not declare it correctly or list all dependencies?

     *        name as the script file) e.g. a script at `/var/www/foo/bar.php` would
     *        have a log at `/var/www/foo/bar.log`
     *
     * @throws AutoCrontabJob_Exception CONSTRUCTOR_ERROR If parameters are not validated
     **/
    public function __construct($identifier, $script, $schedule, $log = null)
    {
        /* Make sure the scheduled script file exists... */
        if (file_exists($script)) {
            /* try to make the identifier truly unique to this instance */
            $_identifier  = $identifier . '.' . md5($identifier . __FILE__ . __CLASS__);

            /* ensure that we're working with a valid Cron job */
            $newJob = null;
            if (is_string($schedule)) {
                $newJob = \TiBeN\CrontabManager\CrontabJob::createFromCrontabLine($schedule . " php $script");
            } elseif ($schedule instanceof \TiBeN\CrontabManager\CrontabJob) {
                $newJob = $schedule;
            } else {
                throw new AutoCrontabJobException(
                    'Expected a string or TiBeN\CrontabManager\CrontabJob, received ' . print_r($schedule, true),
                    AutoCrontabJobException::CONSTRUCTOR_ERROR
                );
            }
            $newJob->comments = implode(' ', [
                $newJob->comments,
                "Created by $script:" . get_class($this) . ' ' . date('Y-m-d h:ia') . " (Job ID $_identifier)"
            ]);


            /* update cron if this job already exists */
            $this->cron = new \TiBeN\CrontabManager\CrontabRepository(new \TiBeN\CrontabManager\CrontabAdapter());
            $jobs = $this->cron->getJobs();
            $jobExists = false;
            // TODO Rewrite whenever this is fixed: https://github.com/TiBeN/CrontabManager/issues/3
            foreach ($jobs as $job) {
                if (preg_match("/$_identifier/", $job->formatCrontabLine())) {
                    $jobExists = true;
                    $job->minutes = $newJob->minutes;
                    $job->hours = $newJob->hours;
                    $job->dayOfMonth = $newJob->dayOfMonth;
                    $job->months = $newJob->months;
                    $job->dayOfWeek = $newJob->dayOfWeek;
                    break;
                }
            }

            /* ... or add this as a new job if it doesn't exist */
            if (!$jobExists) {
                $this->cron->addJob($newJob);
            }

            /* set up log file */
            if (empty($log)) {
                $log = dirname($script) . '/' . basename($script, '.php') . '.log';
            }
            $this->log = \Log::singleton('file', $log);

            /* update cron to enable scheduled jobs */
            $this->cron->persist();
        } else {
            throw new AutoCrontabJobException(
                "PHP script '$script' does not exist",
                AutoCrontabJobException::CONSTRUCTOR_ERROR
            );
        }
    }

    /**
     * Scheduled job
     *
     * Override this method to do something scheduled by Cron.
     *
     * @return void
     **/
    abstract public function scheduledJob();
}