Mage_Cron_Model_Observer Class Reference

List of all members.

Public Member Functions
	dispatch ($observer)
	getPendingSchedules ()
	generate ()
	cleanup ()
Public Attributes
const	CACHE_KEY_LAST_SCHEDULE_GENERATE_AT = 'cron_last_schedule_generate_at'
const	CACHE_KEY_LAST_HISTORY_CLEANUP_AT = 'cron_last_history_cleanup_at'
const	XML_PATH_SCHEDULE_GENERATE_EVERY = 'system/cron/schedule_generate_freq'
const	XML_PATH_SCHEDULE_AHEAD_FOR = 'system/cron/schedule_ahead_for'
const	XML_PATH_SCHEDULE_LIFETIME = 'system/cron/schedule_lifetime'
const	XML_PATH_HISTORY_CLEANUP_EVERY = 'system/cron/history_cleanup_every'
const	XML_PATH_HISTORY_SUCCESS = 'system/cron/history_success_lifetime'
const	XML_PATH_HISTORY_FAILURE = 'system/cron/history_failure_lifetime'
const	REGEX_RUN_MODEL = '#^([a-z0-9_]+/[a-z0-9_]+)::([a-z0-9_]+)$#i'
Protected Member Functions
	_generateJobs ($jobs, $exists)
Protected Attributes
	$_pendingSchedules

---

Detailed Description

Definition at line 34 of file Observer.php.

---

Member Function Documentation

_generateJobs	(	$	jobs,
		$	exists
	)			[protected]

Generate jobs for config information

Parameters:

	$jobs
	array	$exists

Returns:

Mage_Cron_Model_Observer

Definition at line 181 of file Observer.php.

    {
        $scheduleAheadFor = Mage::getStoreConfig(self::XML_PATH_SCHEDULE_AHEAD_FOR)*60;
        $schedule = Mage::getModel('cron/schedule');

        foreach ($jobs as $jobCode => $jobConfig) {
            $cronExpr = null;
            if ($jobConfig->schedule->config_path) {
                $cronExpr = Mage::getStoreConfig((string)$jobConfig->schedule->config_path);
            }
            if (empty($cronExpr) && $jobConfig->schedule->cron_expr) {
                $cronExpr = (string)$jobConfig->schedule->cron_expr;
            }
            if (!$cronExpr) {
                continue;
            }

            $now = time();
            $timeAhead = $now + $scheduleAheadFor;
            $schedule->setJobCode($jobCode)
                ->setCronExpr($cronExpr)
                ->setStatus(Mage_Cron_Model_Schedule::STATUS_PENDING);

            for ($time = $now; $time < $timeAhead; $time += 60) {
                $ts = strftime('%Y-%m-%d %H:%M:00', $time);
                if (!empty($exists[$jobCode.'/'.$ts])) {
                    // already scheduled
                    continue;
                }
                if (!$schedule->trySchedule($time)) {
                    // time does not match cron expression
                    continue;
                }
                $schedule->unsScheduleId()->save();
            }
        }
        return $this;
    }

cleanup

(

)

Definition at line 220 of file Observer.php.

    {
        // check if history cleanup is needed
        $lastCleanup = Mage::app()->loadCache(self::CACHE_KEY_LAST_HISTORY_CLEANUP_AT);
        if ($lastCleanup > time() - Mage::getStoreConfig(self::XML_PATH_HISTORY_CLEANUP_EVERY)*60) {
            return $this;
        }

        $history = Mage::getModel('cron/schedule')->getCollection()
            ->addFieldToFilter('status', array('in'=>array(
                Mage_Cron_Model_Schedule::STATUS_SUCCESS,
                Mage_Cron_Model_Schedule::STATUS_MISSED,
                Mage_Cron_Model_Schedule::STATUS_ERROR,
            )))->load();

        $historyLifetimes = array(
            Mage_Cron_Model_Schedule::STATUS_SUCCESS => Mage::getStoreConfig(self::XML_PATH_HISTORY_SUCCESS)*60,
            Mage_Cron_Model_Schedule::STATUS_MISSED => Mage::getStoreConfig(self::XML_PATH_HISTORY_FAILURE)*60,
            Mage_Cron_Model_Schedule::STATUS_ERROR => Mage::getStoreConfig(self::XML_PATH_HISTORY_FAILURE)*60,
        );

        $now = time();
        foreach ($history->getIterator() as $record) {
            if (strtotime($record->getExecutedAt()) < $now-$historyLifetimes[$record->getStatus()]) {
                $record->delete();
            }
        }

        // save time history cleanup was ran with no expiration
        Mage::app()->saveCache(time(), self::CACHE_KEY_LAST_HISTORY_CLEANUP_AT, array('crontab'), null);

        return $this;
    }

dispatch

(

$

observer

)

Process cron queue Geterate tasks schedule Cleanup tasks schedule

Parameters:

Varien_Event_Observer

$observer

Definition at line 57 of file Observer.php.

    {
        $schedules = $this->getPendingSchedules();
        $scheduleLifetime = Mage::getStoreConfig(self::XML_PATH_SCHEDULE_LIFETIME) * 60;
        $now = time();
        $jobsRoot = Mage::getConfig()->getNode('crontab/jobs');

        foreach ($schedules->getIterator() as $schedule) {
            $jobConfig = $jobsRoot->{$schedule->getJobCode()};
            if (!$jobConfig || !$jobConfig->run) {
                continue;
            }

            $runConfig = $jobConfig->run;
            $time = strtotime($schedule->getScheduledAt());
            if ($time > $now) {
                continue;
            }
            try {
                $errorStatus = Mage_Cron_Model_Schedule::STATUS_ERROR;
                $errorMessage = Mage::helper('cron')->__('Unknown error');

                if ($time < $now - $scheduleLifetime) {
                    $errorStatus = Mage_Cron_Model_Schedule::STATUS_MISSED;
                    Mage::throwException(Mage::helper('cron')->__('Too late for the schedule'));
                }

                $schedule->setExecutedAt(strftime('%Y-%m-%d %H:%M:%S', time()));

                if ($runConfig->model) {
                    if (!preg_match(self::REGEX_RUN_MODEL, (string)$runConfig->model, $run)) {
                        Mage::throwException(Mage::helper('cron')->__('Invalid model/method definition, expecting "model/class::method".'));
                    }
                    if (!($model = Mage::getModel($run[1])) || !method_exists($model, $run[2])) {
                        Mage::throwException(Mage::helper('cron')->__('Invalid callback: %s::%s does not exist', $run[1], $run[2]));
                    }
                    $callback = array($model, $run[2]);
                    $arguments = array($schedule);
                }
                if (empty($callback)) {
                    Mage::throwException(Mage::helper('cron')->__('No callbacks found'));
                }

                $schedule->setStatus(Mage_Cron_Model_Schedule::STATUS_RUNNING)
                    ->save();

                call_user_func_array($callback, $arguments);

                $schedule->setStatus(Mage_Cron_Model_Schedule::STATUS_SUCCESS)
                    ->setFinishedAt(strftime('%Y-%m-%d %H:%M:%S', time()));

            } catch (Exception $e) {
                $schedule->setStatus($errorStatus)
                    ->setMessages($e->getMessage());
            }
            $schedule->save();
        }

        $this->generate();
        $this->cleanup();
    }

generate

(

)

Generate cron schedule

Returns:

Mage_Cron_Model_Observer

check if schedule generation is needed

generate global crontab jobs

generate configurable crontab jobs

save time schedules generation was ran with no expiration

Definition at line 134 of file Observer.php.

    {
        /**
         * check if schedule generation is needed
         */
        $lastRun = Mage::app()->loadCache(self::CACHE_KEY_LAST_SCHEDULE_GENERATE_AT);
        if ($lastRun > time() - Mage::getStoreConfig(self::XML_PATH_SCHEDULE_GENERATE_EVERY)*60) {
            return $this;
        }

        $schedules = $this->getPendingSchedules();
        $exists = array();
        foreach ($schedules->getIterator() as $schedule) {
            $exists[$schedule->getJobCode().'/'.$schedule->getScheduledAt()] = 1;
        }

        /**
         * generate global crontab jobs
         */
        $config = Mage::getConfig()->getNode('crontab/jobs');
        if ($config instanceof Mage_Core_Model_Config_Element) {
            $this->_generateJobs($config->children(), $exists);
        }

        /**
         * generate configurable crontab jobs
         */
        $config = Mage::getConfig()->getNode('default/crontab/jobs');
        if ($config instanceof Mage_Core_Model_Config_Element) {
            $this->_generateJobs($config->children(), $exists);
        }

        /**
         * save time schedules generation was ran with no expiration
         */
        Mage::app()->saveCache(time(), self::CACHE_KEY_LAST_SCHEDULE_GENERATE_AT, array('crontab'), null);

        return $this;
    }

getPendingSchedules

(

)

Definition at line 119 of file Observer.php.

    {
        if (!$this->_pendingSchedules) {
            $this->_pendingSchedules = Mage::getModel('cron/schedule')->getCollection()
                ->addFieldToFilter('status', Mage_Cron_Model_Schedule::STATUS_PENDING)
                ->load();
        }
        return $this->_pendingSchedules;
    }

---

Member Data Documentation

$_pendingSchedules [protected]

Definition at line 48 of file Observer.php.

const CACHE_KEY_LAST_HISTORY_CLEANUP_AT = 'cron_last_history_cleanup_at'

Definition at line 37 of file Observer.php.

const CACHE_KEY_LAST_SCHEDULE_GENERATE_AT = 'cron_last_schedule_generate_at'

Definition at line 36 of file Observer.php.

const REGEX_RUN_MODEL = '#^([a-z0-9_]+/[a-z0-9_]+)::([a-z0-9_]+)$#i'

Definition at line 46 of file Observer.php.

const XML_PATH_HISTORY_CLEANUP_EVERY = 'system/cron/history_cleanup_every'

Definition at line 42 of file Observer.php.

const XML_PATH_HISTORY_FAILURE = 'system/cron/history_failure_lifetime'

Definition at line 44 of file Observer.php.

const XML_PATH_HISTORY_SUCCESS = 'system/cron/history_success_lifetime'

Definition at line 43 of file Observer.php.

const XML_PATH_SCHEDULE_AHEAD_FOR = 'system/cron/schedule_ahead_for'

Definition at line 40 of file Observer.php.

const XML_PATH_SCHEDULE_GENERATE_EVERY = 'system/cron/schedule_generate_freq'

Definition at line 39 of file Observer.php.

const XML_PATH_SCHEDULE_LIFETIME = 'system/cron/schedule_lifetime'

Definition at line 41 of file Observer.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Cron/Model/Observer.php