JobErrorHandler::handleException() - Code Metrics - Inspection of "Always enqueue a new CleanupJob when complete" - silverstripe-australia/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — 2.10 (#130)

by Fred
created 2017-05-22 21:20 UTC
JobErrorHandler::handleException() A

↳ Parent: JobErrorHandler
Complexity

Conditions	1
Paths	1
Size

Total Lines	11
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	8
nc	1
nop	1
<?php

/**
 * A service that can be used for starting, stopping and listing queued jobs.
 *
 * When a job is first added, it is initialised, its job type determined, then persisted to the database
 *
 * When the queues are scanned, a job is reloaded and processed. Ignoring the persistence and reloading, it looks
 * something like
 *
 * job->getJobType();
 * job->getJobData();
 * data->write();
 * job->setup();
 * while !job->isComplete
 *	job->process();
 *	job->getJobData();
 *  data->write();
 *
 *
 * @author Marcus Nyeholt <[email protected]>
 * @license BSD http://silverstripe.org/bsd-license/
 */
class QueuedJobService {
namespace YourVendor;

class YourClass { }
	/**
	 * @var int
	 */
	private static $stall_threshold = 3;


	/**
	 * How much ram will we allow before pausing and releasing the memory?
	 *
	 * For instance, set to 134217728 (128MB) to pause this process if used memory exceeds
	 * this value. This needs to be set to a value lower than the php_ini max_memory as
	 * the system will otherwise crash before shutdown can be handled gracefully.
	 *
	 * @var int
	 * @config
	 */
	private static $memory_limit = 134217728;


	/**
	 * Optional time limit (in seconds) to run the service before restarting to release resources.
	 *
	 * Defaults to no limit.
	 *
	 * @var int
	 * @config
	 */
	private static $time_limit = 0;


	/**
	 * Timestamp (in seconds) when the queue was started
	 *
	 * @var int
	 */
	protected $startedAt = 0;

	/**
	 * Should "immediate" jobs be managed using the shutdown function?
	 *
	 * It is recommended you set up an inotify watch and use that for
	 * triggering immediate jobs. See the wiki for more information
	 *
	 * @var boolean
	 */
	private static $use_shutdown_function = true;


	/**
	 * The location for immediate jobs to be stored in
	 *
	 * @var string
	 */
	private static $cache_dir = 'queuedjobs';


	/**
	 * @var DefaultQueueHandler
	 */
	public $queueHandler;

	/**
	 *
	 * @var TaskRunnerEngine
	 */
	public $queueRunner;

	/**
	 * Config controlled list of default/required jobs
	 * @var Array
	 */
	public $defaultJobs;

	/**
	 * Register our shutdown handler
	 */
	public function __construct() {
		// bind a shutdown function to process all 'immediate' queued jobs if needed, but only in CLI mode
		if (Config::inst()->get(__CLASS__, 'use_shutdown_function') && Director::is_cli()) {
			if (class_exists('PHPUnit_Framework_TestCase') && SapphireTest::is_running_test()) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
				// do NOTHING
			} else {
				register_shutdown_function(array($this, 'onShutdown'));
			}

		}
		if (Config::inst()->get('Email', 'queued_job_admin_email') == '') {
			Config::inst()->update('Email', 'queued_job_admin_email', Config::inst()->get('Email', 'admin_email'));
		}
	}

	/**
	 * Adds a job to the queue to be started
	 *
	 * Relevant data about the job will be persisted using a QueuedJobDescriptor
	 *
	 * @param QueuedJob $job
	 *			The job to start.
	 * @param $startAfter
	 *			The date (in Y-m-d H:i:s format) to start execution after
	 * @param int $userId
	 *			The ID of a user to execute the job as. Defaults to the current user
	 * @return int
	 */
	public function queueJob(QueuedJob $job, $startAfter = null, $userId = null, $queueName = null) {

		$signature = $job->getSignature();

		// see if we already have this job in a queue
		$filter = array(
			'Signature' => $signature,
			'JobStatus' => array(
				QueuedJob::STATUS_NEW,
				QueuedJob::STATUS_INIT
			)
		);

		$existing = DataList::create('QueuedJobDescriptor')->filter($filter)->first();

		if ($existing && $existing->ID) {
			return $existing->ID;
		}

		$jobDescriptor = new QueuedJobDescriptor();
		$jobDescriptor->JobTitle = $job->getTitle();
		$jobDescriptor->JobType = $queueName ? $queueName : $job->getJobType();
		$jobDescriptor->Signature = $signature;
		$jobDescriptor->Implementation = get_class($job);
		$jobDescriptor->StartAfter = $startAfter;

		$jobDescriptor->RunAsID = $userId ? $userId : Member::currentUserID();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		// copy data
		$this->copyJobToDescriptor($job, $jobDescriptor);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$jobDescriptor->write();

		$this->startJob($jobDescriptor, $startAfter);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		return $jobDescriptor->ID;
	}

	/**
	 * Start a job (or however the queue handler determines it should be started)
	 *
	 * @param JobDescriptor $jobDescriptor
	 * @param date $startAfter
	 */
	public function startJob($jobDescriptor, $startAfter = null) {
		if ($startAfter && strtotime($startAfter) > time()) {
			$this->queueHandler->scheduleJob($jobDescriptor, $startAfter);
		} else {
			// immediately start it on the queue, however that works
			$this->queueHandler->startJobOnQueue($jobDescriptor);
		}
	}

	/**
	 * Copies data from a job into a descriptor for persisting
	 *
	 * @param QueuedJob $job
	 * @param JobDescriptor $jobDescriptor
	 */
	protected function copyJobToDescriptor($job, $jobDescriptor) {
		$data = $job->getJobData();

		$jobDescriptor->TotalSteps = $data->totalSteps;
		$jobDescriptor->StepsProcessed = $data->currentStep;
		if ($data->isComplete) {
			$jobDescriptor->JobStatus = QueuedJob::STATUS_COMPLETE;
			$jobDescriptor->JobFinished = date('Y-m-d H:i:s');
		}

		$jobDescriptor->SavedJobData = serialize($data->jobData);
		$jobDescriptor->SavedJobMessages = serialize($data->messages);
	}

	/**
	 * @param QueuedJobDescriptor $jobDescriptor
	 * @param QueuedJob $job
	 */
	protected function copyDescriptorToJob($jobDescriptor, $job) {
		$jobData = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$messages = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		// switching to php's serialize methods... not sure why this wasn't done from the start!
		$jobData = @unserialize($jobDescriptor->SavedJobData);
		$messages = @unserialize($jobDescriptor->SavedJobMessages);

		if (!$jobData) {
			// SS's convert:: function doesn't do this detection for us!!
			if (function_exists('json_decode')) {
				$jobData = json_decode($jobDescriptor->SavedJobData);
				$messages = json_decode($jobDescriptor->SavedJobMessages);
			} else {
				$jobData = Convert::json2obj($jobDescriptor->SavedJobData);
				$messages = Convert::json2obj($jobDescriptor->SavedJobMessages);
			}
		}

		$job->setJobData(
			$jobDescriptor->TotalSteps,
			$jobDescriptor->StepsProcessed,
			$jobDescriptor->JobStatus == QueuedJob::STATUS_COMPLETE,
			$jobData,
			$messages
		);
	}

	/**
	 * Check the current job queues and see if any of the jobs currently in there should be started. If so,
	 * return the next job that should be executed
	 *
	 * @param string $type Job type
	 * @return QueuedJobDescriptor
	 */
	public function getNextPendingJob($type = null) {
		// Filter jobs by type
		$type = $type ?: QueuedJob::QUEUED;
		$list = QueuedJobDescriptor::get()
			->filter('JobType', $type)
			->sort('ID', 'ASC');

		// see if there's any blocked jobs that need to be resumed
		$waitingJob = $list
			->filter('JobStatus', QueuedJob::STATUS_WAIT)
			->first();
		if ($waitingJob) {
			return $waitingJob;
		}

		// If there's an existing job either running or pending, the lets just return false to indicate
		// that we're still executing
		$runningJob = $list
			->filter('JobStatus', array(QueuedJob::STATUS_INIT, QueuedJob::STATUS_RUN))
			->first();
		if ($runningJob) {
			return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
		}

		// Otherwise, lets find any 'new' jobs that are waiting to execute
		$newJob = $list
			->filter('JobStatus', QueuedJob::STATUS_NEW)
			->where(sprintf(
				'"StartAfter" < \'%s\' OR "StartAfter" IS NULL',
				SS_DateTime::now()->getValue()
			))
			->first();

		return $newJob;
	}

	/**
	 * Runs an explicit check on all currently running jobs to make sure their "processed" count is incrementing
	 * between each run. If it's not, then we need to flag it as paused due to an error.
	 *
	 * This typically happens when a PHP fatal error is thrown, which can't be picked up by the error
	 * handler or exception checker; in this case, we detect these stalled jobs later and fix (try) to
	 * fix them
     *
     * @param int $queue The queue to check against
	 */
	public function checkJobHealth($queue = null) {
        $queue = $queue ?: QueuedJob::QUEUED;
		// Select all jobs currently marked as running
		$runningJobs = QueuedJobDescriptor::get()
			->filter(array(
				'JobStatus' => array(
					QueuedJob::STATUS_RUN,
					QueuedJob::STATUS_INIT,
				),
                'JobType' => $queue,
			));

		// If no steps have been processed since the last run, consider it a broken job
		// Only check jobs that have been viewed before. LastProcessedCount defaults to -1 on new jobs.
		$stalledJobs = $runningJobs
			->filter('LastProcessedCount:GreaterThanOrEqual', 0)
			->where('"StepsProcessed" = "LastProcessedCount"');
		foreach ($stalledJobs as $stalledJob) {
			$this->restartStalledJob($stalledJob);
		}

		// now, find those that need to be marked before the next check
		// foreach job, mark it as having been incremented
		foreach ($runningJobs as $job) {
			$job->LastProcessedCount = $job->StepsProcessed;
			$job->write();
		}

		// finally, find the list of broken jobs and send an email if there's some found
		$brokenJobs = QueuedJobDescriptor::get()->filter('JobStatus', QueuedJob::STATUS_BROKEN);
		if ($brokenJobs && $brokenJobs->count()) {

			SS_Log::log(array(
				'errno' => 0,
				'errstr' => 'Broken jobs were found in the job queue',
				'errfile' => __FILE__,
				'errline' => __LINE__,
				'errcontext' => array()
			), SS_Log::ERR);
		}
	}

	/**
	 * Checks through all the scheduled jobs that are expected to exist
	 */
	public function checkdefaultJobs($queue = null) {
		$queue = $queue ?: QueuedJob::QUEUED;
		if (count($this->defaultJobs)) {

			$activeJobs = QueuedJobDescriptor::get()->filter(array(
					'JobStatus' => array(
					QueuedJob::STATUS_NEW,
					QueuedJob::STATUS_INIT,
					QueuedJob::STATUS_RUN,
					QueuedJob::STATUS_WAIT,
					QueuedJob::STATUS_PAUSED
				),
				'JobType' => $queue
			));

			foreach ($this->defaultJobs as $title => $jobConfig) {
				if (!isset($jobConfig['filter']) || !isset($jobConfig['type'])) {
					SS_Log::log("Default Job config: $title incorrectly set up. Please check the readme for examples", SS_Log::ERR);
					continue;
				}

				$job = $activeJobs->filter(array_merge(
					array('Implementation' => $jobConfig['type']), $jobConfig['filter']
				));

				if (!$job->count()) {
					Email::create()
						->setTo(isset($jobConfig['email']) ? $jobConfig['email'] : Email::config()->admin_email)
						->setSubject('Default Job "' . $title . '" missing')
						->populateTemplate(array('Title' => $title, 'Site' => Director::absoluteBaseURL()))
						->populateTemplate($jobConfig)
						->setTemplate('QueuedJobsDefaultJob')
						->send();

					if (isset($jobConfig['recreate']) && $jobConfig['recreate']) {
						if (!isset($jobConfig['construct']) || !isset($jobConfig['startDateFormat']) || !isset($jobConfig['startTimeString'])) {
							SS_Log::log("Default Job config: $title incorrectly set up. Please check the readme for examples", SS_Log::ERR);
							continue;
						}
						singleton('QueuedJobService')->queueJob(
							Injector::inst()->createWithArgs($jobConfig['type'], $jobConfig['construct']),
							date($jobConfig['startDateFormat'], strtotime($jobConfig['startTimeString']))
						);
					}
				}
			}
		}
	}

	/**
	 * Attempt to restart a stalled job
	 *
	 * @param QueuedJobDescriptor $stalledJob
	 * @return bool True if the job was successfully restarted
	 */
	protected function restartStalledJob($stalledJob) {
		if ($stalledJob->ResumeCounts < Config::inst()->get(__CLASS__, 'stall_threshold')) {
			$stalledJob->restart();
			$message = sprintf(
				_t(
					'QueuedJobs.STALLED_JOB_MSG',
					'A job named %s appears to have stalled. It will be stopped and restarted, please login to make sure it has continued'
				),
				$stalledJob->JobTitle
			);
		} else {
			$stalledJob->pause();
			$message = sprintf(
				_t(
					'QueuedJobs.STALLED_JOB_MSG',
					'A job named %s appears to have stalled. It has been paused, please login to check it'
				),
				$stalledJob->JobTitle
			);
		}

		singleton('QJUtils')->log($message);
		$from = Config::inst()->get('Email', 'admin_email');
		$to = Config::inst()->get('Email', 'queued_job_admin_email');
		$subject = _t('QueuedJobs.STALLED_JOB', 'Stalled job');
		$mail = new Email($from, $to, $subject, $message);
		$mail->send();
	}

	/**
	 * Prepares the given jobDescriptor for execution. Returns the job that
	 * will actually be run in a state ready for executing.
	 *
	 * Note that this is called each time a job is picked up to be executed from the cron
	 * job - meaning that jobs that are paused and restarted will have 'setup()' called on them again,
	 * so your job MUST detect that and act accordingly.
	 *
	 * @param QueuedJobDescriptor $jobDescriptor
	 *			The Job descriptor of a job to prepare for execution
	 *
	 * @return QueuedJob|boolean
	 */
	protected function initialiseJob(QueuedJobDescriptor $jobDescriptor) {
		// create the job class
		$impl = $jobDescriptor->Implementation;
		$job = Object::create($impl);
		/* @var $job QueuedJob */
		if (!$job) {
			throw new Exception("Implementation $impl no longer exists");
		}

		$jobDescriptor->JobStatus = QueuedJob::STATUS_INIT;
		$jobDescriptor->write();

		// make sure the data is there
		$this->copyDescriptorToJob($jobDescriptor, $job);

		// see if it needs 'setup' or 'restart' called
		if ($jobDescriptor->StepsProcessed <= 0) {
			$job->setup();
		} else {
			$job->prepareForRestart();
		}

		// make sure the descriptor is up to date with anything changed
		$this->copyJobToDescriptor($job, $jobDescriptor);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$jobDescriptor->write();

		return $job;
	}

	/**
	 * Given a {@link QueuedJobDescriptor} mark the job as initialised. Works sort of like a mutex.
	 * Currently a database lock isn't entirely achievable, due to database adapters not supporting locks.
	 * This may still have a race condition, but this should minimise the possibility.
	 * Side effect is the job status will be changed to "Initialised".
	 *
	 * Assumption is the job has a status of "Queued" or "Wait".
	 *
	 * @param QueuedJobDescriptor $jobDescriptor
	 * @return boolean
	 */
	protected function grabMutex(QueuedJobDescriptor $jobDescriptor) {
		// write the status and determine if any rows were affected, for protection against a
		// potential race condition where two or more processes init the same job at once.
		// This deliberately does not use write() as that would always update LastEdited
		// and thus the row would always be affected.
		try {
			DB::query(sprintf(
				'UPDATE "QueuedJobDescriptor" SET "JobStatus" = \'%s\' WHERE "ID" = %s',
				QueuedJob::STATUS_INIT,
				$jobDescriptor->ID
			));
		} catch(Exception $e) {
			return false;
		}

		if(DB::getConn()->affectedRows() === 0 && $jobDescriptor->JobStatus !== QueuedJob::STATUS_INIT) {

			return false;
		}

		return true;
	}

	/**
	 * Start the actual execution of a job.
	 * The assumption is the jobID refers to a {@link QueuedJobDescriptor} that is status set as "Queued".
	 *
	 * This method will continue executing until the job says it's completed
	 *
	 * @param int $jobId
	 *			The ID of the job to start executing
	 * @return boolean
	 */
	public function runJob($jobId) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		// first retrieve the descriptor
		$jobDescriptor = DataObject::get_by_id('QueuedJobDescriptor', (int) $jobId);
		if (!$jobDescriptor) {
			throw new Exception("$jobId is invalid");
		}

		// now lets see whether we have a current user to run as. Typically, if the job is executing via the CLI,
		// we want it to actually execute as the RunAs user - however, if running via the web (which is rare...), we
		// want to ensure that the current user has admin privileges before switching. Otherwise, we just run it
		// as the currently logged in user and hope for the best

		// We need to use $_SESSION directly because SS ties the session to a controller that no longer exists at
		// this point of execution in some circumstances
		$originalUserID = isset($_SESSION['loggedInAs']) ? $_SESSION['loggedInAs'] : 0;
		$originalUser = $originalUserID ? DataObject::get_by_id('Member', $originalUserID) : null;
		$runAsUser = null;

		if (Director::is_cli() || !$originalUser || Permission::checkMember($originalUser, 'ADMIN')) {
			$runAsUser = $jobDescriptor->RunAs();
			if ($runAsUser && $runAsUser->exists()) {
				// the job runner outputs content way early in the piece, meaning there'll be cookie errors
				// if we try and do a normal login, and we only want it temporarily...
				if (Controller::has_curr()) {
					Session::set('loggedInAs', $runAsUser->ID);
				} else {
					$_SESSION['loggedInAs'] = $runAsUser->ID;
				}

				// this is an explicit coupling brought about by SS not having
				// a nice way of mocking a user, as it requires session
				// nastiness
				if (class_exists('SecurityContext')) {
					singleton('SecurityContext')->setMember($runAsUser);
				}
			}
		}

		// set up a custom error handler for this processing
		$errorHandler = new JobErrorHandler();

		$job = null;

		$broken = false;

		// Push a config context onto the stack for the duration of this job run.
		Config::nest();

		if($this->grabMutex($jobDescriptor)) {

			try {
				$job = $this->initialiseJob($jobDescriptor);


				// get the job ready to begin.
				if (!$jobDescriptor->JobStarted) {
					$jobDescriptor->JobStarted = date('Y-m-d H:i:s');
				} else {
					$jobDescriptor->JobRestarted = date('Y-m-d H:i:s');
				}


		                // Only write to job as "Running" if 'isComplete' was NOT set to true
       			        // during setup() or prepareForRestart()

		                if (!$job->jobFinished()) {
		                    $jobDescriptor->JobStatus = QueuedJob::STATUS_RUN;
		                    $jobDescriptor->write();
		                }

				$lastStepProcessed = 0;
				// have we stalled at all?
				$stallCount = 0;

				if ($job->SubsiteID && class_exists('Subsite')) {
					Subsite::changeSubsite($job->SubsiteID);

					// lets set the base URL as far as Director is concerned so that our URLs are correct
					$subsite = DataObject::get_by_id('Subsite', $job->SubsiteID);
					if ($subsite && $subsite->exists()) {
						$domain = $subsite->domain();
						$base = rtrim(Director::protocol() . $domain, '/') . '/';

						Config::inst()->update('Director', 'alternate_base_url', $base);
					}
				}

				// while not finished
				while (!$job->jobFinished() && !$broken) {
					// see that we haven't been set to 'paused' or otherwise by another process
					$jobDescriptor = DataObject::get_by_id('QueuedJobDescriptor', (int) $jobId);
					if (!$jobDescriptor || !$jobDescriptor->exists()) {
						$broken = true;
						SS_Log::log(array(
							'errno' => 0,
							'errstr' => 'Job descriptor ' . $jobId . ' could not be found',
							'errfile' => __FILE__,
							'errline' => __LINE__,
							'errcontext' => array()
						), SS_Log::ERR);
						break;
					}
					if ($jobDescriptor->JobStatus != QueuedJob::STATUS_RUN) {
						// we've been paused by something, so we'll just exit
						$job->addMessage(sprintf(_t('QueuedJobs.JOB_PAUSED', "Job paused at %s"), date('Y-m-d H:i:s')));
						$broken = true;
					}

					if (!$broken) {
						try {
							$job->process();
						} catch (Exception $e) {
							// okay, we'll just catch this exception for now
							$job->addMessage(sprintf(_t('QueuedJobs.JOB_EXCEPT', 'Job caused exception %s in %s at line %s'), $e->getMessage(), $e->getFile(), $e->getLine()), 'ERROR');

							$errorHandler->handleException($e);
							$jobDescriptor->JobStatus =  QueuedJob::STATUS_BROKEN;
						}

						// now check the job state
						$data = $job->getJobData();
						if ($data->currentStep == $lastStepProcessed) {
							$stallCount++;
						}

						if ($stallCount > Config::inst()->get(__CLASS__, 'stall_threshold')) {
							$broken = true;
							$job->addMessage(sprintf(_t('QueuedJobs.JOB_STALLED', "Job stalled after %s attempts - please check"), $stallCount), 'ERROR');

							$jobDescriptor->JobStatus =  QueuedJob::STATUS_BROKEN;
						}

						// now we'll be good and check our memory usage. If it is too high, we'll set the job to
						// a 'Waiting' state, and let the next processing run pick up the job.
						if ($this->isMemoryTooHigh()) {
							$job->addMessage(sprintf(
								_t('QueuedJobs.MEMORY_RELEASE', 'Job releasing memory and waiting (%s used)'),
								$this->humanReadable($this->getMemoryUsage())
							));

                            if ($jobDescriptor->JobStatus != QueuedJob::STATUS_BROKEN) {
                                $jobDescriptor->JobStatus = QueuedJob::STATUS_WAIT;
                            }

							$broken = true;
						}

						// Also check if we are running too long
						if($this->hasPassedTimeLimit()) {
							$job->addMessage(_t(
								'QueuedJobs.TIME_LIMIT',
								'Queue has passed time limit and will restart before continuing'
							));
							if ($jobDescriptor->JobStatus != QueuedJob::STATUS_BROKEN) {
                                $jobDescriptor->JobStatus = QueuedJob::STATUS_WAIT;
                            }
							$broken = true;
						}
					}

					if ($jobDescriptor) {
						$this->copyJobToDescriptor($job, $jobDescriptor);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
						$jobDescriptor->write();
					} else {

						SS_Log::log(array(
							'errno' => 0,
							'errstr' => 'Job descriptor has been set to null',
							'errfile' => __FILE__,
							'errline' => __LINE__,
							'errcontext' => array()
						), SS_Log::WARN);
						$broken = true;
					}
				}

				// a last final save. The job is complete by now
				if ($jobDescriptor) {
					$jobDescriptor->write();
				}

				if (!$broken) {
					$job->afterComplete();
					$jobDescriptor->cleanupJob();
				}
			} catch (Exception $e) {
				// okay, we'll just catch this exception for now
				$errorHandler->handleException($e);
				$jobDescriptor->JobStatus =  QueuedJob::STATUS_BROKEN;
				$jobDescriptor->write();
				$broken = true;
			}
		}

		$errorHandler->clear();

		Config::unnest();

		// okay let's reset our user if we've got an original
		if ($runAsUser && $originalUser) {
			Session::clear("loggedInAs");
			if ($originalUser) {
				Session::set("loggedInAs", $originalUser->ID);
			}
		}

		return !$broken;
	}

	/**
	 * Start timer
	 */
	protected function markStarted() {
		if($this->startedAt) {
			$this->startedAt = SS_Datetime::now()->Format('U');
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		}
	}

	/**
	 * Is execution time too long?
	 *
	 * @return bool True if the script has passed the configured time_limit
	 */
	protected function hasPassedTimeLimit() {
		// Ensure a limit exists
		$limit = Config::inst()->get(__CLASS__, 'time_limit');
		if(!$limit) {
			return false;
		}

		// Ensure started date is set
		$this->markStarted();

		// Check duration
		$now = SS_Datetime::now()->Format('U');
		return $now > $this->startedAt + $limit;
	}

	/**
	 * Is memory usage too high?
	 *
	 * @return bool
	 */
	protected function isMemoryTooHigh() {
		$used = $this->getMemoryUsage();
		$limit = $this->getMemoryLimit();
		return $limit && ($used > $limit);
	}

	/**
	 * Get peak memory usage of this application
	 *
	 * @return float
	 */
	protected function getMemoryUsage() {
		// Note we use real_usage = false http://stackoverflow.com/questions/15745385/memory-get-peak-usage-with-real-usage
		// Also we use the safer peak memory usage
		return (float)memory_get_peak_usage(false);
	}

	/**
	 * Determines the memory limit (in bytes) for this application
	 * Limits to the smaller of memory_limit configured via php.ini or silverstripe config
	 *
	 * @return float Memory limit in bytes
	 */
	protected function getMemoryLimit() {
		// Limit to smaller of explicit limit or php memory limit
		$limit = $this->parseMemory(Config::inst()->get(__CLASS__, 'memory_limit'));
		if($limit) {
			return $limit;
		}

		// Fallback to php memory limit
		$phpLimit = $this->getPHPMemoryLimit();
		if($phpLimit) {
			return $phpLimit;
		}
	}

	/**
	 * Calculate the current memory limit of the server
	 *
	 * @return float
	 */
	protected function getPHPMemoryLimit() {
		return $this->parseMemory(trim(ini_get("memory_limit")));
	}

	/**
	 * Convert memory limit string to bytes.
	 * Based on implementation in install.php5
	 *
	 * @param string $memString
	 * @return float
	 */
	protected function parseMemory($memString) {
		switch(strtolower(substr($memString, -1))) {
			case "b":
				return round(substr($memString, 0, -1));
			case "k":
				return round(substr($memString, 0, -1) * 1024);
			case "m":
				return round(substr($memString, 0, -1) * 1024 * 1024);
			case "g":
				return round(substr($memString, 0, -1) * 1024 * 1024 * 1024);
			default:
				return round($memString);
		}
	}

	protected function humanReadable($size) {
		$filesizename = array(" Bytes", " KB", " MB", " GB", " TB", " PB", " EB", " ZB", " YB");
		return $size ? round($size/pow(1024, ($i = floor(log($size, 1024)))), 2) . $filesizename[$i] : '0 Bytes';
	}


	/**
	 * Gets a list of all the current jobs (or jobs that have recently finished)
	 *
	 * @param string $type
	 *			if we're after a particular job list
	 * @param int $includeUpUntil
	 *			The number of seconds to include jobs that have just finished, allowing a job list to be built that
	 *			includes recently finished jobs
	 */
	public function getJobList($type = null, $includeUpUntil = 0) {
		return DataObject::get('QueuedJobDescriptor', $this->getJobListFilter($type, $includeUpUntil));
	}

	/**
	 * Return the SQL filter used to get the job list - this is used by the UI for displaying the job list...
	 *
	 * @param string $type
	 *			if we're after a particular job list
	 * @param int $includeUpUntil
	 *			The number of seconds to include jobs that have just finished, allowing a job list to be built that
	 *			includes recently finished jobs
	 * @return string
	 */
	public function getJobListFilter($type = null, $includeUpUntil = 0) {
		$filter = array('JobStatus <>' => QueuedJob::STATUS_COMPLETE);
		if ($includeUpUntil) {
			$filter['JobFinished > '] = date('Y-m-d H:i:s', time() - $includeUpUntil);
		}

		$filter = singleton('QJUtils')->dbQuote($filter, ' OR ');

		if ($type) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$filter = singleton('QJUtils')->dbQuote(array('JobType =' => (string) $type)) . ' AND ('.$filter.')';
		}

		return $filter;
	}

	/**
	 * Process the job queue with the current queue runner
	 *
	 * @param string $queue
	 */
	public function runQueue($queue) {
		$this->checkJobHealth($queue);
		$this->checkdefaultJobs($queue);
		$this->queueRunner->runQueue($queue);
	}

	/**
	 * Process all jobs from a given queue
	 *
	 * @param string $name The job queue to completely process
	 */
	public function processJobQueue($name) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		// Start timer to measure lifetime
		$this->markStarted();

		// Begin main loop
		do {
			if (class_exists('Subsite')) {
				// clear subsite back to default to prevent any subsite changes from leaking to
				// subsequent actions
				Subsite::changeSubsite(0);
			}
			if (Controller::has_curr()) {
				Session::clear('loggedInAs');
			} else {
				unset($_SESSION['loggedInAs']);
			}

			if (class_exists('SecurityContext')) {
				singleton('SecurityContext')->setMember(null);
			}

			$job = $this->getNextPendingJob($name);
			if ($job) {
				$success = $this->runJob($job->ID);
				if (!$success) {
					// make sure job is null so it doesn't continue the current
					// processing loop. Next queue executor can pick up where
					// things left off
					$job = null;
				}
			}
		} while($job);
	}

	/**
	 * When PHP shuts down, we want to process all of the immediate queue items
	 *
	 * We use the 'getNextPendingJob' method, instead of just iterating the queue, to ensure
	 * we ignore paused or stalled jobs.
	 */
	public function onShutdown() {
		$this->processJobQueue(QueuedJob::IMMEDIATE);
	}
}

/**
 * Class used to handle errors for a single job
 */
class JobErrorHandler {
namespace YourVendor;

class YourClass { }
	public function __construct() {
		set_error_handler(array($this, 'handleError'));
	}

	public function clear() {
		restore_error_handler();
	}

	/**
	 * For logging and catching exceptions thrown during AbstractQueuedJob::process()
	 * and similar.
	 */ 
	public function handleException($exception) {
		$errno = E_USER_ERROR;
		$type = get_class($exception);
		$message = "Uncaught " . $type . ": " . $exception->getMessage();
		$file = $exception->getFile();
		$line = $exception->getLine();
		$context = $exception->getTrace();

		// NOTE: This will call SS_Log::log()
		Debug::fatalHandler($errno, $message, $file, $line, $context);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * Works like the core Silverstripe error handler without exiting
	 * on fatal messages.
	 */ 
	public function handleError($errno, $errstr, $errfile, $errline) {
		if (error_reporting()) {
			// Don't throw E_DEPRECATED in PHP 5.3+
			/*if (defined('E_DEPRECATED')) {

				if ($errno == E_DEPRECATED || $errno == E_USER_DEPRECATED) {
					return;
				}
			}*/

			switch ($errno) {
				case E_NOTICE:
				case E_USER_NOTICE:
				case E_DEPRECATED:
				case E_USER_DEPRECATED:
				case E_STRICT:
					Debug::noticeHandler($errno, $errstr, $errfile, $errline, debug_backtrace());
				break;

				case E_WARNING:
				case E_CORE_WARNING:
				case E_USER_WARNING:
				case E_RECOVERABLE_ERROR:
					Debug::warningHandler($errno, $errstr, $errfile, $errline, debug_backtrace());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				break;

				default:
					throw new ErrorException($errstr, $errno, $errno, $errfile, $errline);
					// Old exception throw
					//throw new Exception($errstr . " in $errfile at line $errline", $errno);

				break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
			}
		}
	}
}

silverstripe-australia / silverstripe-queuedjobs

Pull Request — 2.10 (#130)

JobErrorHandler::handleException() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
