CleanupJob::getJobType() - Code Metrics - Inspection of "SilverStripe 4 compatibility" - silverstripe-australia/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#109)

by Robbie

created 2016-12-22 01:02 UTC

CleanupJob::getJobType() A

↳ Parent: CleanupJob

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php

namespace SilverStripe\QueuedJobs\Jobs;

use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;
use SilverStripe\QueuedJobs\Services\QueuedJob;

/**
 * An queued job to clean out the QueuedJobDescriptor Table
 * which often gets too full
 *
 * @author Andrew Aitken-Fincham <[email protected]>
 */
class CleanupJob extends AbstractQueuedJob implements QueuedJob
{

    /**
     * How we will determine "stale"
     * Possible values: age, number
     * @config
     * @var string
     */
    private static $cleanup_method = "age";


    /**
     * Value associated with cleanupMethod
     * age => days, number => integer
     * @config
     * @var integer
     */
    private static $cleanup_value = 30;


    /**
     * Which JobStatus values are OK to be deleted
     * @config
     * @var array
     */
    private static $cleanup_statuses = array(

        "Complete",
        "Broken",
        // "Initialising",
        // "Running",
        // "New",
        // "Paused",
        // "Cancelled",
        // "Waiting",
    );

    /**
     * Check whether is enabled or not for BC
     * @config
     * @var boolean
     */
    private static $is_enabled = false;


    /**
     * Required because we aren't extending object
     * @return Config_ForClass
     */
    public function config()
    {
        return Config::inst()->forClass(get_called_class());
    }

    /**
     * Defines the title of the job
     * @return string
     */
    public function getTitle()
    {
        return _t(
            'CleanupJob.Title',
            "Clean up old jobs from the database"
        );
    }

    /**
     * Set immediacy of job
     * @return int
     */
    public function getJobType()
    {
        $this->totalSteps = '1';
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        return QueuedJob::IMMEDIATE;
    }

    /**
     * Clear out stale jobs based on the cleanup values
     */
    public function process()
    {
        $statusList = implode('\', \'', $this->config()->cleanup_statuses);
        switch ($this->config()->cleanup_method) {
            // If Age, we need to get jobs that are at least n days old
            case "age":
                $cutOff = date(
                    "Y-m-d H:i:s",
                    strtotime(DBDatetime::now() .
                        " - " .
                        $this->config()->cleanup_value .
                        " days")
                );
                $stale = DB::query(
                    'SELECT "ID"
					FROM "QueuedJobDescriptor"
					WHERE "JobStatus"
					IN (\'' . $statusList . '\')
					AND "LastEdited" < \'' . $cutOff .'\''
                );
                $staleJobs = $stale->column("ID");
                break;
            // If Number, we need to save n records, then delete from the rest
            case "number":
                $fresh = DB::query(
                    'SELECT "ID"
					FROM "QueuedJobDescriptor"
					ORDER BY "LastEdited"
					ASC LIMIT ' . $this->config()->cleanup_value
                );
                $freshJobIDs = implode('\', \'', $fresh->column("ID"));

                $stale = DB::query(
                    'SELECT "ID"
					FROM "QueuedJobDescriptor"
					WHERE "ID"
					NOT IN (\'' . $freshJobIDs . '\')
					AND "JobStatus"
					IN (\'' . $statusList . '\')'
                );
                $staleJobs = $stale->column("ID");
                break;
            default:
                $this->addMessage("Incorrect configuration values set. Cleanup ignored");
                $this->isComplete = true;
                return;
        }
        if (empty($staleJobs)) {
            $this->addMessage("No jobs to clean up.");
            $this->isComplete = true;
            return;
        }
        $numJobs = count($staleJobs);
        $staleJobs = implode('\', \'', $staleJobs);
        DB::query('DELETE FROM "QueuedJobDescriptor"
			WHERE "ID"
			IN (\'' . $staleJobs . '\')');
        $this->addMessage($numJobs . " jobs cleaned up.");
        // let's make sure there is a cleanupJob in the queue
        if (Config::inst()->get('SilverStripe\\QueuedJobs\\Jobs\\CleanupJob', 'is_enabled')) {
            $this->addMessage("Queueing the next Cleanup Job.");
            $cleanup = new CleanupJob();
            singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')
                ->queueJob($cleanup, date('Y-m-d H:i:s', time() + 86400));
        }
        $this->isComplete = true;
        return;
    }
}


1			<?php
2
3			namespace SilverStripe\QueuedJobs\Jobs;
4
5			use SilverStripe\Core\Config\Config;
6			use SilverStripe\ORM\DB;
7			use SilverStripe\ORM\FieldType\DBDatetime;
8			use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;
9			use SilverStripe\QueuedJobs\Services\QueuedJob;
10
11			/**
12			* An queued job to clean out the QueuedJobDescriptor Table
13			* which often gets too full
14			*
15			* @author Andrew Aitken-Fincham <[email protected]>
16			*/
17			class CleanupJob extends AbstractQueuedJob implements QueuedJob
18			{
19
20			/**
21			* How we will determine "stale"
22			* Possible values: age, number
23			* @config
24			* @var string
25			*/
26			private static $cleanup_method = "age";
			0 ignored issues – show Unused Code introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `$cleanup_method` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
27
28			/**
29			* Value associated with cleanupMethod
30			* age => days, number => integer
31			* @config
32			* @var integer
33			*/
34			private static $cleanup_value = 30;
			0 ignored issues – show Unused Code introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `$cleanup_value` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
35
36			/**
37			* Which JobStatus values are OK to be deleted
38			* @config
39			* @var array
40			*/
41			private static $cleanup_statuses = array(
			0 ignored issues – show Unused Code introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `$cleanup_statuses` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
42			"Complete",
43			"Broken",
44			// "Initialising",
45			// "Running",
46			// "New",
47			// "Paused",
48			// "Cancelled",
49			// "Waiting",
50			);
51
52			/**
53			* Check whether is enabled or not for BC
54			* @config
55			* @var boolean
56			*/
57			private static $is_enabled = false;
			0 ignored issues – show Unused Code introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `$is_enabled` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
58
59			/**
60			* Required because we aren't extending object
61			* @return Config_ForClass
62			*/
63			public function config()
64			{
65			return Config::inst()->forClass(get_called_class());
66			}
67
68			/**
69			* Defines the title of the job
70			* @return string
71			*/
72			public function getTitle()
73			{
74			return _t(
75			'CleanupJob.Title',
76			"Clean up old jobs from the database"
77			);
78			}
79
80			/**
81			* Set immediacy of job
82			* @return int
83			*/
84			public function getJobType()
85			{
86			$this->totalSteps = '1';
			0 ignored issues – show Documentation Bug introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `$totalSteps` was declared of type `integer`, but `'1'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
87			return QueuedJob::IMMEDIATE;
88			}
89
90			/**
91			* Clear out stale jobs based on the cleanup values
92			*/
93			public function process()
94			{
95			$statusList = implode('\', \'', $this->config()->cleanup_statuses);
96			switch ($this->config()->cleanup_method) {
97			// If Age, we need to get jobs that are at least n days old
98			case "age":
99			$cutOff = date(
100			"Y-m-d H:i:s",
101			strtotime(DBDatetime::now() .
102			" - " .
103			$this->config()->cleanup_value .
104			" days")
105			);
106			$stale = DB::query(
107			'SELECT "ID"
108			FROM "QueuedJobDescriptor"
109			WHERE "JobStatus"
110			IN (\'' . $statusList . '\')
111			AND "LastEdited" < \'' . $cutOff .'\''
112			);
113			$staleJobs = $stale->column("ID");
114			break;
115			// If Number, we need to save n records, then delete from the rest
116			case "number":
117			$fresh = DB::query(
118			'SELECT "ID"
119			FROM "QueuedJobDescriptor"
120			ORDER BY "LastEdited"
121			ASC LIMIT ' . $this->config()->cleanup_value
122			);
123			$freshJobIDs = implode('\', \'', $fresh->column("ID"));
124
125			$stale = DB::query(
126			'SELECT "ID"
127			FROM "QueuedJobDescriptor"
128			WHERE "ID"
129			NOT IN (\'' . $freshJobIDs . '\')
130			AND "JobStatus"
131			IN (\'' . $statusList . '\')'
132			);
133			$staleJobs = $stale->column("ID");
134			break;
135			default:
136			$this->addMessage("Incorrect configuration values set. Cleanup ignored");
137			$this->isComplete = true;
138			return;
139			}
140			if (empty($staleJobs)) {
141			$this->addMessage("No jobs to clean up.");
142			$this->isComplete = true;
143			return;
144			}
145			$numJobs = count($staleJobs);
146			$staleJobs = implode('\', \'', $staleJobs);
147			DB::query('DELETE FROM "QueuedJobDescriptor"
148			WHERE "ID"
149			IN (\'' . $staleJobs . '\')');
150			$this->addMessage($numJobs . " jobs cleaned up.");
151			// let's make sure there is a cleanupJob in the queue
152			if (Config::inst()->get('SilverStripe\\QueuedJobs\\Jobs\\CleanupJob', 'is_enabled')) {
153			$this->addMessage("Queueing the next Cleanup Job.");
154			$cleanup = new CleanupJob();
155			singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')
156			->queueJob($cleanup, date('Y-m-d H:i:s', time() + 86400));
157			}
158			$this->isComplete = true;
159			return;
160			}
161			}
162

silverstripe-australia / silverstripe-queuedjobs

Pull Request — master (#109)

CleanupJob::getJobType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like