Current File : /var/www/crm/include/SugarQueue/SugarCronJobs.php
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
/*********************************************************************************
* SugarCRM Community Edition is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* SugarCRM" logo. If the display of the logo is not reasonably feasible for
* technical reasons, the Appropriate Legal Notices must display the words
* "Powered by SugarCRM".
********************************************************************************/
require_once 'include/SugarQueue/SugarJobQueue.php';
require_once 'modules/Schedulers/Scheduler.php';
/**
* CRON driver for job queue
* @api
*/
class SugarCronJobs
{
/**
* Max number of jobs per cron run
* @var int
*/
public $max_jobs = 10;
/**
* Max time per cron run
* @var int
*/
public $max_runtime = 60;
/**
* Min time between cron runs
* @var int
*/
public $min_interval = 30;
/**
* Lock file to ensure the jobs aren't run too fast
* @var string
*/
public $lockfile;
/**
* Currently running job
* @var SchedulersJob
*/
public $job;
/**
* Is current queue run OK?
* @var bool
*/
public $runOk = true;
/**
* Should the driver print reports to stdout?
* @var bool
*/
public $verbose = false;
/**
* This allows to disable schedulers cycle, e.g. for testing
* @var bool
*/
public $disable_schedulers = false;
public function __construct()
{
$this->queue = new SugarJobQueue();
$this->lockfile = sugar_cached("modules/Schedulers/lastrun");
if(!empty($GLOBALS['sugar_config']['cron']['max_jobs'])) {
$this->max_jobs = $GLOBALS['sugar_config']['cron']['max_cron_jobs'];
}
if(!empty($GLOBALS['sugar_config']['cron']['max_cron_runtime'])) {
$this->max_jobs = $GLOBALS['sugar_config']['cron']['max_cron_runtime'];
}
if(isset($GLOBALS['sugar_config']['cron']['min_cron_interval'])) {
$this->min_interval = $GLOBALS['sugar_config']['cron']['min_cron_interval'];
}
}
/**
* Remember last time it was run
*/
protected function markLastRun()
{
if(!file_put_contents($this->lockfile, time())) {
$GLOBALS['log']->fatal('Scheduler cannot write PID file. Please check permissions on '.$this->lockfile);
}
}
/**
* Check if we aren't running jobs too frequently
* @return bool OK to run?
*/
public function throttle()
{
if($this->min_interval == 0) {
return true;
}
create_cache_directory($this->lockfile);
if(!file_exists($this->lockfile)) {
$this->markLastRun();
return true;
} else {
$ts = file_get_contents($this->lockfile);
$this->markLastRun();
$now = time();
if($now - $ts < $this->min_interval) {
// run too frequently
return false;
}
}
return true;
}
/**
* What to do if one of the jobs failed
* @param SchedulersJob $job
*/
protected function jobFailed($job = null)
{
$this->runOk = false;
if(!empty($job)) {
$GLOBALS['log']->fatal("Job {$job->id} ({$job->name}) failed in CRON run");
if($this->verbose) {
printf(translate('ERR_JOB_FAILED_VERBOSE', 'SchedulersJobs'), $job->id, $job->name);
}
}
}
/**
* Shutdown handler to be called if something breaks in the middle of the job
*/
public function unexpectedExit()
{
if(!empty($this->job)) {
$this->jobFailed($this->job);
$this->job->failJob(translate('ERR_FAILED', 'SchedulersJobs'));
$this->job = null;
}
}
/**
* Return ID for this client
* @return string
*/
public function getMyId()
{
return 'CRON'.$GLOBALS['sugar_config']['unique_key'].':'.getmypid();
}
/**
* Execute given job
* @param SchedulersJob $job
*/
public function executeJob($job)
{
if(!$this->job->runJob()) {
// if some job fails, change run status
$this->jobFailed($this->job);
}
}
/**
* Run CRON cycle:
* - cleanup
* - schedule new jobs
* - execute pending jobs
*/
public function runCycle()
{
// throttle
if(!$this->throttle()) {
$GLOBALS['log']->fatal("Job runs too frequently, throttled to protect the system.");
return;
}
// clean old stale jobs
if(!$this->queue->cleanup()) {
$this->jobFailed();
}
// run schedulers
if(!$this->disable_schedulers) {
$this->queue->runSchedulers();
}
// run jobs
$cutoff = time()+$this->max_runtime;
register_shutdown_function(array($this, "unexpectedExit"));
$myid = $this->getMyId();
for($count=0;$count<$this->max_jobs;$count++) {
$this->job = $this->queue->nextJob($myid);
if(empty($this->job)) {
return;
}
$this->executeJob($this->job);
if(time() >= $cutoff) {
break;
}
}
$this->job = null;
}
/**
* Check if the queue run was fine
*/
public function runOk()
{
return $this->runOk;
}
}
Mini Shell