Completed
Pull Request — master (#35)
by
unknown
03:38
created
src/Queue/Config.php 1 patch
Indentation   +56 added lines, -56 removed lines patch added patch discarded remove patch
@@ -6,66 +6,66 @@
 block discarded – undo
6 6
 class Config
7 7
 {
8 8
 
9
-    /**
10
-     *
11
-     * @return int
12
-     */
13
-    public static function defaultWorkerTimeout()
14
-    {
15
-        return Configure::read('Queue.defaultWorkerTimeout', 600); // 10min
16
-    }
9
+	/**
10
+	 *
11
+	 * @return int
12
+	 */
13
+	public static function defaultWorkerTimeout()
14
+	{
15
+		return Configure::read('Queue.defaultWorkerTimeout', 600); // 10min
16
+	}
17 17
 
18
-    /**
19
-     *
20
-     * @return int
21
-     */
22
-    public static function workerMaxRuntime()
23
-    {
24
-        return Configure::read('Queue.workerMaxRuntime', 120);
25
-    }
18
+	/**
19
+	 *
20
+	 * @return int
21
+	 */
22
+	public static function workerMaxRuntime()
23
+	{
24
+		return Configure::read('Queue.workerMaxRuntime', 120);
25
+	}
26 26
 
27
-    /**
28
-     *
29
-     * @return int
30
-     */
31
-    public static function cleanupTimeout()
32
-    {
33
-        return Configure::read('Queue.cleanupTimeout', 2592000); // 30 days
34
-    }
27
+	/**
28
+	 *
29
+	 * @return int
30
+	 */
31
+	public static function cleanupTimeout()
32
+	{
33
+		return Configure::read('Queue.cleanupTimeout', 2592000); // 30 days
34
+	}
35 35
 
36
-    /**
37
-     *
38
-     * @return int
39
-     */
40
-    public static function sleepTime()
41
-    {
42
-        return Configure::read('Queue.sleepTime', 10);
43
-    }
36
+	/**
37
+	 *
38
+	 * @return int
39
+	 */
40
+	public static function sleepTime()
41
+	{
42
+		return Configure::read('Queue.sleepTime', 10);
43
+	}
44 44
 
45
-    /**
46
-     *
47
-     * @return int
48
-     */
49
-    public static function gcprob()
50
-    {
51
-        return Configure::read('Queue.gcprob', 10);
52
-    }
45
+	/**
46
+	 *
47
+	 * @return int
48
+	 */
49
+	public static function gcprob()
50
+	{
51
+		return Configure::read('Queue.gcprob', 10);
52
+	}
53 53
 
54
-    /**
55
-     *
56
-     * @return int
57
-     */
58
-    public static function defaultWorkerRetries()
59
-    {
60
-        return Configure::read('Queue.defaultWorkerRetries', 1);
61
-    }
54
+	/**
55
+	 *
56
+	 * @return int
57
+	 */
58
+	public static function defaultWorkerRetries()
59
+	{
60
+		return Configure::read('Queue.defaultWorkerRetries', 1);
61
+	}
62 62
 
63
-    /**
64
-     *
65
-     * @return int
66
-     */
67
-    public static function maxWorkers()
68
-    {
69
-        return Configure::read('Queue.maxWorkers', 1);
70
-    }
63
+	/**
64
+	 *
65
+	 * @return int
66
+	 */
67
+	public static function maxWorkers()
68
+	{
69
+		return Configure::read('Queue.maxWorkers', 1);
70
+	}
71 71
 }
Please login to merge, or discard this patch.
src/Shell/Task/AddInterface.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -10,12 +10,12 @@
 block discarded – undo
10 10
 interface AddInterface
11 11
 {
12 12
 
13
-    /**
14
-     * Allows adding a task to the queue.
15
-     *
16
-     * Will create one example task in the queue, which later will be executed using run().
17
-     *
18
-     * @return void
19
-     */
20
-    public function add(): void;
13
+	/**
14
+	 * Allows adding a task to the queue.
15
+	 *
16
+	 * Will create one example task in the queue, which later will be executed using run().
17
+	 *
18
+	 * @return void
19
+	 */
20
+	public function add(): void;
21 21
 }
Please login to merge, or discard this patch.
src/Model/Entity/QueuedTask.php 1 patch
Indentation   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -20,21 +20,21 @@
 block discarded – undo
20 20
 class QueuedTask extends Entity
21 21
 {
22 22
 
23
-    /**
24
-     *
25
-     * {@inheritdoc}
26
-     *
27
-     * @var array
28
-     */
29
-    protected $_accessible = [
30
-        'task' => true,
31
-        'data' => true,
32
-        'not_before' => true,
33
-        'fetched' => true,
34
-        'completed' => true,
35
-        'failed_count' => true,
36
-        'failure_message' => true,
37
-        'worker_key' => true,
38
-        'created' => true
39
-    ];
23
+	/**
24
+	 *
25
+	 * {@inheritdoc}
26
+	 *
27
+	 * @var array
28
+	 */
29
+	protected $_accessible = [
30
+		'task' => true,
31
+		'data' => true,
32
+		'not_before' => true,
33
+		'fetched' => true,
34
+		'completed' => true,
35
+		'failed_count' => true,
36
+		'failure_message' => true,
37
+		'worker_key' => true,
38
+		'created' => true
39
+	];
40 40
 }
Please login to merge, or discard this patch.
tests/config/app_queue.php 1 patch
Indentation   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -1,18 +1,18 @@
 block discarded – undo
1 1
 <?php
2 2
 
3 3
 return [
4
-    'Queue' => [
5
-        // time (in seconds) after which a job is requeued if the worker doesn't report back
6
-        'defaultWorkerTimeout' => 1800,
4
+	'Queue' => [
5
+		// time (in seconds) after which a job is requeued if the worker doesn't report back
6
+		'defaultWorkerTimeout' => 1800,
7 7
 
8
-        // seconds of running time after which the worker will terminate (0 = unlimited)
9
-        'workerMaxRuntime' => 120,
8
+		// seconds of running time after which the worker will terminate (0 = unlimited)
9
+		'workerMaxRuntime' => 120,
10 10
 
11
-        // minimum time (in seconds) which a task remains in the database before being cleaned up.
12
-        'cleanupTimeout' => 2592000, // 30 days
11
+		// minimum time (in seconds) which a task remains in the database before being cleaned up.
12
+		'cleanupTimeout' => 2592000, // 30 days
13 13
 
14
-        /* Optional */
14
+		/* Optional */
15 15
 
16
-        'isSearchEnabled' => true,
17
-    ],
16
+		'isSearchEnabled' => true,
17
+	],
18 18
 ];
Please login to merge, or discard this patch.
src/Queue/TaskFinder.php 1 patch
Indentation   +68 added lines, -68 removed lines patch added patch discarded remove patch
@@ -8,80 +8,80 @@
 block discarded – undo
8 8
 class TaskFinder
9 9
 {
10 10
 
11
-    /**
12
-     *
13
-     * @var array|null
14
-     */
15
-    protected $tasks;
11
+	/**
12
+	 *
13
+	 * @var array|null
14
+	 */
15
+	protected $tasks;
16 16
 
17
-    /**
18
-     * Returns all possible Queue tasks.
19
-     *
20
-     * Makes sure that app tasks are prioritized over plugin ones.
21
-     *
22
-     * @return array
23
-     */
24
-    public function allAppAndPluginTasks()
25
-    {
26
-        if ($this->tasks !== null) {
27
-            return $this->tasks;
28
-        }
17
+	/**
18
+	 * Returns all possible Queue tasks.
19
+	 *
20
+	 * Makes sure that app tasks are prioritized over plugin ones.
21
+	 *
22
+	 * @return array
23
+	 */
24
+	public function allAppAndPluginTasks()
25
+	{
26
+		if ($this->tasks !== null) {
27
+			return $this->tasks;
28
+		}
29 29
 
30
-        $paths = App::path('Shell/Task');
31
-        $this->tasks = [];
30
+		$paths = App::path('Shell/Task');
31
+		$this->tasks = [];
32 32
 
33
-        foreach ($paths as $path) {
34
-            $Folder = new Folder($path);
35
-            $this->tasks = $this->getAppPaths($Folder);
36
-        }
37
-        $plugins = Plugin::loaded();
38
-        foreach ($plugins as $plugin) {
39
-            $pluginPaths = App::path('Shell/Task', $plugin);
40
-            foreach ($pluginPaths as $pluginPath) {
41
-                $Folder = new Folder($pluginPath);
42
-                $pluginTasks = $this->getPluginPaths($Folder, $plugin);
43
-                $this->tasks = array_merge($this->tasks, $pluginTasks);
44
-            }
45
-        }
33
+		foreach ($paths as $path) {
34
+			$Folder = new Folder($path);
35
+			$this->tasks = $this->getAppPaths($Folder);
36
+		}
37
+		$plugins = Plugin::loaded();
38
+		foreach ($plugins as $plugin) {
39
+			$pluginPaths = App::path('Shell/Task', $plugin);
40
+			foreach ($pluginPaths as $pluginPath) {
41
+				$Folder = new Folder($pluginPath);
42
+				$pluginTasks = $this->getPluginPaths($Folder, $plugin);
43
+				$this->tasks = array_merge($this->tasks, $pluginTasks);
44
+			}
45
+		}
46 46
 
47
-        return $this->tasks;
48
-    }
47
+		return $this->tasks;
48
+	}
49 49
 
50
-    /**
51
-     *
52
-     * @param \Cake\Filesystem\Folder $Folder The directory
53
-     *
54
-     * @return array
55
-     */
56
-    protected function getAppPaths(Folder $Folder)
57
-    {
58
-        $res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
59
-        foreach ($res as &$r) {
60
-            $r = basename($r, 'Task.php');
61
-        }
50
+	/**
51
+	 *
52
+	 * @param \Cake\Filesystem\Folder $Folder The directory
53
+	 *
54
+	 * @return array
55
+	 */
56
+	protected function getAppPaths(Folder $Folder)
57
+	{
58
+		$res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
59
+		foreach ($res as &$r) {
60
+			$r = basename($r, 'Task.php');
61
+		}
62 62
 
63
-        return $res;
64
-    }
63
+		return $res;
64
+	}
65 65
 
66
-    /**
67
-     *
68
-     * @param \Cake\Filesystem\Folder $Folder The directory
69
-     * @param string $plugin The plugin name
70
-     *
71
-     * @return array
72
-     */
73
-    protected function getPluginPaths(Folder $Folder, $plugin)
74
-    {
75
-        $res = $Folder->find('Queue.+Task\.php');
76
-        foreach ($res as $key => $r) {
77
-            $name = basename($r, 'Task.php');
78
-            if (in_array($name, $this->tasks)) {
79
-                unset($res[$key]);
80
-                continue;
81
-            }
82
-            $res[$key] = $plugin . '.' . $name;
83
-        }
66
+	/**
67
+	 *
68
+	 * @param \Cake\Filesystem\Folder $Folder The directory
69
+	 * @param string $plugin The plugin name
70
+	 *
71
+	 * @return array
72
+	 */
73
+	protected function getPluginPaths(Folder $Folder, $plugin)
74
+	{
75
+		$res = $Folder->find('Queue.+Task\.php');
76
+		foreach ($res as $key => $r) {
77
+			$name = basename($r, 'Task.php');
78
+			if (in_array($name, $this->tasks)) {
79
+				unset($res[$key]);
80
+				continue;
81
+			}
82
+			$res[$key] = $plugin . '.' . $name;
83
+		}
84 84
 
85
-        return $res;
86
-    }
85
+		return $res;
86
+	}
87 87
 }
Please login to merge, or discard this patch.
src/Shell/Task/QueueTask.php 1 patch
Indentation   +45 added lines, -45 removed lines patch added patch discarded remove patch
@@ -18,57 +18,57 @@
 block discarded – undo
18 18
 abstract class QueueTask extends Shell implements QueueTaskInterface
19 19
 {
20 20
 
21
-    /**
22
-     *
23
-     * @var string
24
-     */
25
-    public $queueModelClass = 'Queue.QueuedTasks';
21
+	/**
22
+	 *
23
+	 * @var string
24
+	 */
25
+	public $queueModelClass = 'Queue.QueuedTasks';
26 26
 
27
-    /**
28
-     *
29
-     * @var \Queue\Model\Table\QueuedTasksTable
30
-     */
31
-    public $QueuedTasks;
27
+	/**
28
+	 *
29
+	 * @var \Queue\Model\Table\QueuedTasksTable
30
+	 */
31
+	public $QueuedTasks;
32 32
 
33
-    /**
34
-     * Timeout for run, after which the Task is reassigned to a new worker.
35
-     *
36
-     * @var int
37
-     */
38
-    public $timeout = 120;
33
+	/**
34
+	 * Timeout for run, after which the Task is reassigned to a new worker.
35
+	 *
36
+	 * @var int
37
+	 */
38
+	public $timeout = 120;
39 39
 
40
-    /**
41
-     * Number of times a failed instance of this task should be restarted before giving up.
42
-     *
43
-     * @var int
44
-     */
45
-    public $retries = 1;
40
+	/**
41
+	 * Number of times a failed instance of this task should be restarted before giving up.
42
+	 *
43
+	 * @var int
44
+	 */
45
+	public $retries = 1;
46 46
 
47
-    /**
48
-     *
49
-     * @param \Cake\Console\ConsoleIo|null $io IO
50
-     */
51
-    public function __construct(ConsoleIo $io = null)
52
-    {
53
-        parent::__construct($io);
47
+	/**
48
+	 *
49
+	 * @param \Cake\Console\ConsoleIo|null $io IO
50
+	 */
51
+	public function __construct(ConsoleIo $io = null)
52
+	{
53
+		parent::__construct($io);
54 54
 
55
-        $this->loadModel($this->queueModelClass);
56
-    }
55
+		$this->loadModel($this->queueModelClass);
56
+	}
57 57
 
58
-    /**
59
-     *
60
-     * @return string
61
-     * @throws \InvalidArgumentException
62
-     */
63
-    protected function queueTaskName()
64
-    {
65
-        $class = get_class($this);
58
+	/**
59
+	 *
60
+	 * @return string
61
+	 * @throws \InvalidArgumentException
62
+	 */
63
+	protected function queueTaskName()
64
+	{
65
+		$class = get_class($this);
66 66
 
67
-        preg_match('#\\\\Queue(.+)Task$#', $class, $matches);
68
-        if (!$matches) {
69
-            throw new InvalidArgumentException('Invalid class name: ' . $class);
70
-        }
67
+		preg_match('#\\\\Queue(.+)Task$#', $class, $matches);
68
+		if (!$matches) {
69
+			throw new InvalidArgumentException('Invalid class name: ' . $class);
70
+		}
71 71
 
72
-        return $matches[1];
73
-    }
72
+		return $matches[1];
73
+	}
74 74
 }
Please login to merge, or discard this patch.
src/Shell/Task/QueueExampleTask.php 1 patch
Indentation   +72 added lines, -72 removed lines patch added patch discarded remove patch
@@ -7,82 +7,82 @@
 block discarded – undo
7 7
 class QueueExampleTask extends QueueTask implements AddInterface
8 8
 {
9 9
 
10
-    /**
11
-     * Timeout for run, after which the task is reassigned to a new worker.
12
-     *
13
-     * @var int
14
-     */
15
-    public $timeout = 10;
10
+	/**
11
+	 * Timeout for run, after which the task is reassigned to a new worker.
12
+	 *
13
+	 * @var int
14
+	 */
15
+	public $timeout = 10;
16 16
 
17
-    /**
18
-     * Timeout for cleanup, after which completed jobs are deleted (in seconds).
19
-     *
20
-     * @var int
21
-     */
22
-    public $cleanupTimeout = 600;
17
+	/**
18
+	 * Timeout for cleanup, after which completed jobs are deleted (in seconds).
19
+	 *
20
+	 * @var int
21
+	 */
22
+	public $cleanupTimeout = 600;
23 23
 
24
-    /**
25
-     * Number of times a failed instance of this task should be restarted before giving up.
26
-     *
27
-     * @var int
28
-     */
29
-    public $retries = 0;
24
+	/**
25
+	 * Number of times a failed instance of this task should be restarted before giving up.
26
+	 *
27
+	 * @var int
28
+	 */
29
+	public $retries = 0;
30 30
 
31
-    /**
32
-     * Stores any failure messages triggered during run().
33
-     *
34
-     * @var string
35
-     */
36
-    public $failureMessage = '';
31
+	/**
32
+	 * Stores any failure messages triggered during run().
33
+	 *
34
+	 * @var string
35
+	 */
36
+	public $failureMessage = '';
37 37
 
38
-    /**
39
-     * Example add functionality.
40
-     * Will create one example job in the queue, which later will be executed using run();
41
-     *
42
-     * To invoke from CLI execute:
43
-     * - bin/cake queue add Example
44
-     *
45
-     * @return void
46
-     */
47
-    public function add(): void
48
-    {
49
-        $this->out(__d('queue', 'CakePHP Queue Example task.'));
50
-        $this->hr();
51
-        $this->out(__d('queue', 'This is a very simple example of a queueTask.'));
52
-        $this->out(__d('queue', 'Now adding an example Task Job into the Queue.'));
53
-        $this->out(__d('queue', 'This task will only produce some console output on the worker that it runs on.'));
54
-        $this->out(' ');
55
-        $this->out(__d('queue', 'To run a Worker use:'));
56
-        $this->out(__d('queue', '	cake queue runworker'));
57
-        $this->out(' ');
58
-        $this->out(__d('queue', 'You can find the sourcecode of this task in: '));
59
-        $this->out(__FILE__);
60
-        $this->out(' ');
38
+	/**
39
+	 * Example add functionality.
40
+	 * Will create one example job in the queue, which later will be executed using run();
41
+	 *
42
+	 * To invoke from CLI execute:
43
+	 * - bin/cake queue add Example
44
+	 *
45
+	 * @return void
46
+	 */
47
+	public function add(): void
48
+	{
49
+		$this->out(__d('queue', 'CakePHP Queue Example task.'));
50
+		$this->hr();
51
+		$this->out(__d('queue', 'This is a very simple example of a queueTask.'));
52
+		$this->out(__d('queue', 'Now adding an example Task Job into the Queue.'));
53
+		$this->out(__d('queue', 'This task will only produce some console output on the worker that it runs on.'));
54
+		$this->out(' ');
55
+		$this->out(__d('queue', 'To run a Worker use:'));
56
+		$this->out(__d('queue', '	cake queue runworker'));
57
+		$this->out(' ');
58
+		$this->out(__d('queue', 'You can find the sourcecode of this task in: '));
59
+		$this->out(__FILE__);
60
+		$this->out(' ');
61 61
 
62
-        // Adding a task of type 'example' with no additionally passed data
63
-        if ($this->QueuedTasks->createJob('Example')) {
64
-            $this->out(__d('queue', 'OK, job created, now run the worker'));
65
-        } else {
66
-            $this->err(__d('queue', 'Could not create Job'));
67
-        }
68
-    }
62
+		// Adding a task of type 'example' with no additionally passed data
63
+		if ($this->QueuedTasks->createJob('Example')) {
64
+			$this->out(__d('queue', 'OK, job created, now run the worker'));
65
+		} else {
66
+			$this->err(__d('queue', 'Could not create Job'));
67
+		}
68
+	}
69 69
 
70
-    /**
71
-     * Example run function.
72
-     * This function is executed, when a worker is executing a task.
73
-     * The return parameter will determine, if the task will be marked completed, or be requeued.
74
-     *
75
-     * @param array $data The array passed to QueuedTasksTable::createJob()
76
-     * @param int $taskId The id of the QueuedTask entity
77
-     * @return void
78
-     */
79
-    public function run(array $data, $taskId): void
80
-    {
81
-        $this->hr();
82
-        $this->out(__d('queue', 'CakePHP Queue Example task.'));
83
-        $this->hr();
84
-        $this->out(__d('queue', ' ->Success, the Example Task was run.<-'));
85
-        $this->out(' ');
86
-        $this->out(' ');
87
-    }
70
+	/**
71
+	 * Example run function.
72
+	 * This function is executed, when a worker is executing a task.
73
+	 * The return parameter will determine, if the task will be marked completed, or be requeued.
74
+	 *
75
+	 * @param array $data The array passed to QueuedTasksTable::createJob()
76
+	 * @param int $taskId The id of the QueuedTask entity
77
+	 * @return void
78
+	 */
79
+	public function run(array $data, $taskId): void
80
+	{
81
+		$this->hr();
82
+		$this->out(__d('queue', 'CakePHP Queue Example task.'));
83
+		$this->hr();
84
+		$this->out(__d('queue', ' ->Success, the Example Task was run.<-'));
85
+		$this->out(' ');
86
+		$this->out(' ');
87
+	}
88 88
 }
Please login to merge, or discard this patch.
src/Shell/Task/QueueTaskInterface.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -13,12 +13,12 @@
 block discarded – undo
13 13
 interface QueueTaskInterface
14 14
 {
15 15
 
16
-    /**
17
-     * Main execution of the task.
18
-     *
19
-     * @param array $data The array passed to QueuedTasksTable::createJob()
20
-     * @param int $taskId The id of the QueuedTask entity
21
-     * @return void
22
-     */
23
-    public function run(array $data, $taskId): void;
16
+	/**
17
+	 * Main execution of the task.
18
+	 *
19
+	 * @param array $data The array passed to QueuedTasksTable::createJob()
20
+	 * @param int $taskId The id of the QueuedTask entity
21
+	 * @return void
22
+	 */
23
+	public function run(array $data, $taskId): void;
24 24
 }
Please login to merge, or discard this patch.
src/Model/Table/QueuedTasksTable.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -189,7 +189,7 @@  discard block
 block discarded – undo
189 189
     {
190 190
         $driverName = $this->_getDriverName();
191 191
         $options = [
192
-            'fields' => function (Query $query) use ($driverName) {
192
+            'fields' => function(Query $query) use ($driverName) {
193 193
                 $alltime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(created)');
194 194
                 $runtime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
195 195
                 $fetchdelay = $query->func()->avg('UNIX_TIMESTAMP(fetched) - IF(not_before is NULL, UNIX_TIMESTAMP(created), UNIX_TIMESTAMP(not_before))');
@@ -236,7 +236,7 @@  discard block
 block discarded – undo
236 236
     public function getFullStats($taskName = null)
237 237
     {
238 238
         $driverName = $this->_getDriverName();
239
-        $fields = function (Query $query) use ($driverName) {
239
+        $fields = function(Query $query) use ($driverName) {
240 240
             $runtime = $query->newExpr('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
241 241
             switch ($driverName) {
242 242
                 case static::DRIVER_SQLSERVER:
@@ -370,7 +370,7 @@  discard block
 block discarded – undo
370 370
         }
371 371
 
372 372
         /** @var \Queue\Model\Entity\QueuedTask|null $task */
373
-        $task = $this->getConnection()->transactional(function () use ($query, $options, $now) {
373
+        $task = $this->getConnection()->transactional(function() use ($query, $options, $now) {
374 374
             $task = $query->find('all', $options)
375 375
                 ->enableAutoFields(true)
376 376
                 ->epilog('FOR UPDATE')
Please login to merge, or discard this patch.
Indentation   +593 added lines, -593 removed lines patch added patch discarded remove patch
@@ -28,597 +28,597 @@
 block discarded – undo
28 28
 class QueuedTasksTable extends Table
29 29
 {
30 30
 
31
-    const DRIVER_MYSQL = 'Mysql';
32
-
33
-    const DRIVER_POSTGRES = 'Postgres';
34
-
35
-    const DRIVER_SQLSERVER = 'Sqlserver';
36
-
37
-    const STATS_LIMIT = 100000;
38
-
39
-    /**
40
-     *
41
-     * @var string|null
42
-     */
43
-    protected $_key;
44
-
45
-    /**
46
-     * Initialize method
47
-     *
48
-     * @param array $config The configuration for the Table.
49
-     * @return void
50
-     */
51
-    public function initialize(array $config)
52
-    {
53
-        parent::initialize($config);
54
-
55
-        $this->setTable('queued_tasks');
56
-        $this->setDisplayField('id');
57
-        $this->setPrimaryKey('id');
58
-
59
-        $this->addBehavior('Timestamp');
60
-    }
61
-
62
-    /**
63
-     * set connection name
64
-     *
65
-     * @return string
66
-     */
67
-    public static function defaultConnectionName()
68
-    {
69
-        $connection = Configure::read('Queue.connection');
70
-        if (!empty($connection)) {
71
-            return $connection;
72
-        }
73
-
74
-        return parent::defaultConnectionName();
75
-    }
76
-
77
-    /**
78
-     *
79
-     * @param \Cake\Event\Event $event Model event
80
-     * @param \ArrayObject $data The data
81
-     * @param \ArrayObject $options The options
82
-     * @return void
83
-     */
84
-    public function beforeMarshal(Event $event, ArrayObject $data, ArrayObject $options)
85
-    {
86
-        if (isset($data['data']) && $data['data'] === '') {
87
-            $data['data'] = null;
88
-        }
89
-    }
90
-
91
-    /**
92
-     * Adds a new job to the queue.
93
-     *
94
-     * @param string $taskName Task name
95
-     * @param array|null $data Array of data
96
-     * @param string $notBefore A datetime which indicates when the job may be executed
97
-     * @return \Queue\Model\Entity\QueuedTask Saved job entity
98
-     */
99
-    public function createJob($taskName, array $data = null, string $notBefore = null)
100
-    {
101
-        $task = [
102
-            'task' => $taskName,
103
-            'data' => serialize($data),
104
-            'not_before' => $this->getDateTime()
105
-        ];
106
-
107
-        if (!empty($notBefore)) {
108
-            $task['not_before'] = $this->getDateTime(strtotime($notBefore));
109
-        }
110
-
111
-        $queuedTask = $this->newEntity($task);
112
-
113
-        return $this->saveOrFail($queuedTask);
114
-    }
115
-
116
-    /**
117
-     *
118
-     * @param string|null $taskName
119
-     *
120
-     * @return bool
121
-     *
122
-     * @throws \InvalidArgumentException
123
-     */
124
-    public function isQueued($taskName = null)
125
-    {
126
-        $conditions = [
127
-            'completed IS' => null
128
-        ];
129
-        if ($taskName) {
130
-            $conditions['task'] = $taskName;
131
-        }
132
-
133
-        return (bool)$this->find()
134
-            ->where($conditions)
135
-            ->select([
136
-                'id'
137
-            ])
138
-            ->first();
139
-    }
140
-
141
-    /**
142
-     * Returns the number of items in the queue.
143
-     * Either returns the number of ALL pending jobs, or the number of pending jobs of the passed type.
144
-     *
145
-     * @param string|null $taskName Task type to Count
146
-     * @return int
147
-     */
148
-    public function getLength($taskName = null)
149
-    {
150
-        $findConf = [
151
-            'conditions' => [
152
-                'completed IS' => null
153
-            ]
154
-        ];
155
-        if ($taskName !== null) {
156
-            $findConf['conditions']['task'] = $taskName;
157
-        }
158
-
159
-        return $this->find('all', $findConf)->count();
160
-    }
161
-
162
-    /**
163
-     * Return a list of all task types in the Queue.
164
-     *
165
-     * @return \Cake\ORM\Query
166
-     */
167
-    public function getTypes()
168
-    {
169
-        $findCond = [
170
-            'fields' => [
171
-                'task'
172
-            ],
173
-            'group' => [
174
-                'task'
175
-            ],
176
-            'keyField' => 'task',
177
-            'valueField' => 'task'
178
-        ];
179
-
180
-        return $this->find('list', $findCond);
181
-    }
182
-
183
-    /**
184
-     * Return some statistics about finished jobs still in the Database.
185
-     * TO-DO: rewrite as virtual field
186
-     *
187
-     * @return \Cake\ORM\Query
188
-     */
189
-    public function getStats()
190
-    {
191
-        $driverName = $this->_getDriverName();
192
-        $options = [
193
-            'fields' => function (Query $query) use ($driverName) {
194
-                $alltime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(created)');
195
-                $runtime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
196
-                $fetchdelay = $query->func()->avg('UNIX_TIMESTAMP(fetched) - IF(not_before is NULL, UNIX_TIMESTAMP(created), UNIX_TIMESTAMP(not_before))');
197
-                switch ($driverName) {
198
-                    case static::DRIVER_SQLSERVER:
199
-                        $alltime = $query->func()->avg("DATEDIFF(s, '1970-01-01 00:00:00', completed) - DATEDIFF(s, '1970-01-01 00:00:00', created)");
200
-                        $runtime = $query->func()->avg("DATEDIFF(s, '1970-01-01 00:00:00', completed) - DATEDIFF(s, '1970-01-01 00:00:00', fetched)");
201
-                        $fetchdelay = $query->func()->avg("DATEDIFF(s, '1970-01-01 00:00:00', fetched) - (CASE WHEN not_before IS NULL THEN DATEDIFF(s, '1970-01-01 00:00:00', created) ELSE DATEDIFF(s, '1970-01-01 00:00:00', not_before) END)");
202
-                        break;
203
-                }
204
-                /**
205
-                 *
206
-                 * @var \Cake\ORM\Query
207
-                 */
208
-                return [
209
-                    'task',
210
-                    'num' => $query->func()->count('*'),
211
-                    'alltime' => $alltime,
212
-                    'runtime' => $runtime,
213
-                    'fetchdelay' => $fetchdelay
214
-                ];
215
-            },
216
-            'conditions' => [
217
-                'completed IS NOT' => null
218
-            ],
219
-            'group' => [
220
-                'task'
221
-            ]
222
-        ];
223
-
224
-        return $this->find('all', $options);
225
-    }
226
-
227
-    /**
228
-     * Returns [
229
-     * 'Task' => [
230
-     * 'YYYY-MM-DD' => INT,
231
-     * ...
232
-     * ]
233
-     * ]
234
-     *
235
-     * @param string|null $taskName The task name
236
-     * @return array
237
-     */
238
-    public function getFullStats($taskName = null)
239
-    {
240
-        $driverName = $this->_getDriverName();
241
-        $fields = function (Query $query) use ($driverName) {
242
-            $runtime = $query->newExpr('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
243
-            switch ($driverName) {
244
-                case static::DRIVER_SQLSERVER:
245
-                    $runtime = $query->newExpr("DATEDIFF(s, '1970-01-01 00:00:00', completed) - DATEDIFF(s, '1970-01-01 00:00:00', fetched)");
246
-                    break;
247
-            }
248
-
249
-            return [
250
-                'task',
251
-                'created',
252
-                'duration' => $runtime
253
-            ];
254
-        };
255
-
256
-        $conditions = [
257
-            'completed IS NOT' => null
258
-        ];
259
-        if ($taskName) {
260
-            $conditions['task'] = $taskName;
261
-        }
262
-
263
-        $tasks = $this->find()
264
-            ->select($fields)
265
-            ->where($conditions)
266
-            ->enableHydration(false)
267
-            ->orderDesc('id')
268
-            ->limit(static::STATS_LIMIT)
269
-            ->all()
270
-            ->toArray();
271
-
272
-        $result = [];
273
-
274
-        $days = [];
275
-
276
-        foreach ($tasks as $task) {
277
-            /** @var \DateTime $created */
278
-            $created = $task['created'];
279
-            $day = $created->format('Y-m-d');
280
-            if (!isset($days[$day])) {
281
-                $days[$day] = $day;
282
-            }
283
-
284
-            $result[$task['task']][$day][] = $task['duration'];
285
-        }
286
-
287
-        foreach ($result as $type => $tasks) {
288
-            foreach ($tasks as $day => $durations) {
289
-                $average = array_sum($durations) / count($durations);
290
-                $result[$type][$day] = (int)$average;
291
-            }
292
-
293
-            foreach ($days as $day) {
294
-                if (isset($result[$type][$day])) {
295
-                    continue;
296
-                }
297
-
298
-                $result[$type][$day] = 0;
299
-            }
300
-
301
-            ksort($result[$type]);
302
-        }
303
-
304
-        return $result;
305
-    }
306
-
307
-    /**
308
-     * Look for a new job that can be processed with the current abilities and
309
-     * from the specified group (or any if null).
310
-     *
311
-     * @param array $capabilities Available QueueWorkerTasks.
312
-     * @param array $types Request a job from these types (or exclude certain types), or any otherwise.
313
-     * @return \Queue\Model\Entity\QueuedTask|null
314
-     */
315
-    public function requestJob(array $capabilities, array $types = [])
316
-    {
317
-        $now = $this->getDateTime();
318
-        $nowStr = $now->toDateTimeString();
319
-        $driverName = $this->_getDriverName();
320
-
321
-        $query = $this->find();
322
-        $age = $query->newExpr()->add('IFNULL(TIMESTAMPDIFF(SECOND, "' . $nowStr . '", not_before), 0)');
323
-        switch ($driverName) {
324
-            case static::DRIVER_SQLSERVER:
325
-                $age = $query->newExpr()->add('ISNULL(DATEDIFF(SECOND, GETDATE(), not_before), 0)');
326
-                break;
327
-            case static::DRIVER_POSTGRES:
328
-                $age = $query->newExpr()->add('COALESCE((EXTRACT(EPOCH FROM now()) - EXTRACT(EPOCH FROM not_before)), 0)');
329
-                break;
330
-        }
331
-        $options = [
332
-            'conditions' => [
333
-                'completed IS' => null,
334
-                'OR' => []
335
-            ],
336
-            'fields' => [
337
-                'age' => $age
338
-            ],
339
-            'order' => [
340
-                'age' => 'ASC',
341
-                'id' => 'ASC'
342
-            ]
343
-        ];
344
-
345
-        if ($types) {
346
-            $options['conditions'] = $this->addFilter($options['conditions'], 'task', $types);
347
-        }
348
-
349
-        // Generate the task specific conditions.
350
-        foreach ($capabilities as $task) {
351
-            list ($plugin, $name) = pluginSplit($task['name']);
352
-            $timeoutAt = $now->copy();
353
-            $tmp = [
354
-                'task' => $name,
355
-                'AND' => [
356
-                    [
357
-                        'OR' => [
358
-                            'not_before <' => $nowStr,
359
-                            'not_before IS' => null
360
-                        ]
361
-                    ],
362
-                    [
363
-                        'OR' => [
364
-                            'fetched <' => $timeoutAt->subSeconds($task['timeout']),
365
-                            'fetched IS' => null
366
-                        ]
367
-                    ]
368
-                ],
369
-                'failed_count <' => ($task['retries'] + 1)
370
-            ];
371
-            $options['conditions']['OR'][] = $tmp;
372
-        }
373
-
374
-        /** @var \Queue\Model\Entity\QueuedTask|null $task */
375
-        $task = $this->getConnection()->transactional(function () use ($query, $options, $now) {
376
-            $task = $query->find('all', $options)
377
-                ->enableAutoFields(true)
378
-                ->epilog('FOR UPDATE')
379
-                ->first();
380
-
381
-            if (!$task) {
382
-                return null;
383
-            }
384
-
385
-            $key = $this->key();
386
-            $task = $this->patchEntity($task, [
387
-                'worker_key' => $key,
388
-                'fetched' => $now
389
-            ]);
390
-
391
-            return $this->saveOrFail($task);
392
-        });
393
-
394
-        if (!$task) {
395
-            return null;
396
-        }
397
-
398
-        return $task;
399
-    }
400
-
401
-    /**
402
-     * Mark a task as Completed, removing it from the queue.
403
-     *
404
-     * @param \Queue\Model\Entity\QueuedTask $task Task
405
-     * @return bool Success
406
-     */
407
-    public function markJobDone(QueuedTask $task)
408
-    {
409
-        $fields = [
410
-            'completed' => $this->getDateTime()
411
-        ];
412
-        $task = $this->patchEntity($task, $fields);
413
-
414
-        return (bool)$this->save($task);
415
-    }
416
-
417
-    /**
418
-     * Mark a job as Failed, incrementing the failed-counter and Requeueing it.
419
-     *
420
-     * @param \Queue\Model\Entity\QueuedTask $task Task
421
-     * @param string|null $failureMessage Optional message to append to the failure_message field.
422
-     * @return bool Success
423
-     */
424
-    public function markJobFailed(QueuedTask $task, $failureMessage = null)
425
-    {
426
-        $fields = [
427
-            'failed_count' => $task->failed_count + 1,
428
-            'failure_message' => $failureMessage
429
-        ];
430
-        $task = $this->patchEntity($task, $fields);
431
-
432
-        return (bool)$this->save($task);
433
-    }
434
-
435
-    /**
436
-     * Reset current jobs
437
-     *
438
-     * @param int|null $id ID
439
-     *
440
-     * @return int Success
441
-     */
442
-    public function reset($id = null)
443
-    {
444
-        $fields = [
445
-            'completed' => null,
446
-            'fetched' => null,
447
-            'failed_count' => 0,
448
-            'worker_key' => null,
449
-            'failure_message' => null
450
-        ];
451
-        $conditions = [
452
-            'completed IS' => null
453
-        ];
454
-        if ($id) {
455
-            $conditions['id'] = $id;
456
-        }
457
-
458
-        return $this->updateAll($fields, $conditions);
459
-    }
460
-
461
-    /**
462
-     *
463
-     * @param string $taskName Task name
464
-     *
465
-     * @return int
466
-     */
467
-    public function rerun($taskName)
468
-    {
469
-        $fields = [
470
-            'completed' => null,
471
-            'fetched' => null,
472
-            'failed_count' => 0,
473
-            'worker_key' => null,
474
-            'failure_message' => null
475
-        ];
476
-        $conditions = [
477
-            'completed IS NOT' => null,
478
-            'task' => $taskName
479
-        ];
480
-
481
-        return $this->updateAll($fields, $conditions);
482
-    }
483
-
484
-    /**
485
-     * Cleanup/Delete Completed Tasks.
486
-     *
487
-     * @return void
488
-     */
489
-    public function cleanOldJobs()
490
-    {
491
-        if (!Configure::read('Queue.cleanuptimeout')) {
492
-            return;
493
-        }
494
-
495
-        $this->deleteAll([
496
-            'completed <' => time() - (int)Configure::read('Queue.cleanuptimeout')
497
-        ]);
498
-    }
499
-
500
-    /**
501
-     *
502
-     * @param \Queue\Model\Entity\QueuedTask $queuedTask Queued task
503
-     * @param array $taskConfiguration Task configuration
504
-     * @return string
505
-     */
506
-    public function getFailedStatus($queuedTask, array $taskConfiguration)
507
-    {
508
-        $failureMessageRequeued = 'requeued';
509
-
510
-        $queuedTaskName = 'Queue' . $queuedTask->task;
511
-        if (empty($taskConfiguration[$queuedTaskName])) {
512
-            return $failureMessageRequeued;
513
-        }
514
-        $retries = $taskConfiguration[$queuedTaskName]['retries'];
515
-        if ($queuedTask->failed_count <= $retries) {
516
-            return $failureMessageRequeued;
517
-        }
518
-
519
-        return 'aborted';
520
-    }
521
-
522
-    /**
523
-     * Generates a unique Identifier for the current worker thread.
524
-     *
525
-     * Useful to identify the currently running processes for this thread.
526
-     *
527
-     * @return string Identifier
528
-     */
529
-    public function key()
530
-    {
531
-        if ($this->_key !== null) {
532
-            return $this->_key;
533
-        }
534
-        $this->_key = sha1(microtime());
535
-        if (!$this->_key) {
536
-            throw new RuntimeException('Invalid key generated');
537
-        }
538
-
539
-        return $this->_key;
540
-    }
541
-
542
-    /**
543
-     * Resets worker Identifier
544
-     *
545
-     * @return void
546
-     */
547
-    public function clearKey()
548
-    {
549
-        $this->_key = null;
550
-    }
551
-
552
-    /**
553
-     * truncate()
554
-     *
555
-     * @return void
556
-     */
557
-    public function truncate()
558
-    {
559
-        $sql = $this->getSchema()->truncateSql($this->_connection);
560
-        foreach ($sql as $snippet) {
561
-            $this->_connection->execute($snippet);
562
-        }
563
-    }
564
-
565
-    /**
566
-     * get the name of the driver
567
-     *
568
-     * @return string
569
-     */
570
-    protected function _getDriverName()
571
-    {
572
-        $className = explode('\\', $this->getConnection()->config()['driver']);
573
-        $name = end($className);
574
-
575
-        return $name;
576
-    }
577
-
578
-    /**
579
-     *
580
-     * @param array $conditions Conditions
581
-     * @param string $key Key
582
-     * @param array $values Values
583
-     * @return array
584
-     */
585
-    protected function addFilter(array $conditions, $key, array $values)
586
-    {
587
-        $include = [];
588
-        $exclude = [];
589
-        foreach ($values as $value) {
590
-            if (substr($value, 0, 1) === '-') {
591
-                $exclude[] = substr($value, 1);
592
-            } else {
593
-                $include[] = $value;
594
-            }
595
-        }
596
-
597
-        if ($include) {
598
-            $conditions[$key . ' IN'] = $include;
599
-        }
600
-        if ($exclude) {
601
-            $conditions[$key . ' NOT IN'] = $exclude;
602
-        }
603
-
604
-        return $conditions;
605
-    }
606
-
607
-    /**
608
-     * Returns a DateTime object from different input.
609
-     *
610
-     * Without argument this will be "now".
611
-     *
612
-     * @param int|string|\Cake\I18n\FrozenTime|\Cake\I18n\Time|null $notBefore Not before time
613
-     *
614
-     * @return \Cake\I18n\FrozenTime|\Cake\I18n\Time
615
-     */
616
-    protected function getDateTime($notBefore = null)
617
-    {
618
-        if (is_object($notBefore)) {
619
-            return $notBefore;
620
-        }
621
-
622
-        return new FrozenTime($notBefore);
623
-    }
31
+	const DRIVER_MYSQL = 'Mysql';
32
+
33
+	const DRIVER_POSTGRES = 'Postgres';
34
+
35
+	const DRIVER_SQLSERVER = 'Sqlserver';
36
+
37
+	const STATS_LIMIT = 100000;
38
+
39
+	/**
40
+	 *
41
+	 * @var string|null
42
+	 */
43
+	protected $_key;
44
+
45
+	/**
46
+	 * Initialize method
47
+	 *
48
+	 * @param array $config The configuration for the Table.
49
+	 * @return void
50
+	 */
51
+	public function initialize(array $config)
52
+	{
53
+		parent::initialize($config);
54
+
55
+		$this->setTable('queued_tasks');
56
+		$this->setDisplayField('id');
57
+		$this->setPrimaryKey('id');
58
+
59
+		$this->addBehavior('Timestamp');
60
+	}
61
+
62
+	/**
63
+	 * set connection name
64
+	 *
65
+	 * @return string
66
+	 */
67
+	public static function defaultConnectionName()
68
+	{
69
+		$connection = Configure::read('Queue.connection');
70
+		if (!empty($connection)) {
71
+			return $connection;
72
+		}
73
+
74
+		return parent::defaultConnectionName();
75
+	}
76
+
77
+	/**
78
+	 *
79
+	 * @param \Cake\Event\Event $event Model event
80
+	 * @param \ArrayObject $data The data
81
+	 * @param \ArrayObject $options The options
82
+	 * @return void
83
+	 */
84
+	public function beforeMarshal(Event $event, ArrayObject $data, ArrayObject $options)
85
+	{
86
+		if (isset($data['data']) && $data['data'] === '') {
87
+			$data['data'] = null;
88
+		}
89
+	}
90
+
91
+	/**
92
+	 * Adds a new job to the queue.
93
+	 *
94
+	 * @param string $taskName Task name
95
+	 * @param array|null $data Array of data
96
+	 * @param string $notBefore A datetime which indicates when the job may be executed
97
+	 * @return \Queue\Model\Entity\QueuedTask Saved job entity
98
+	 */
99
+	public function createJob($taskName, array $data = null, string $notBefore = null)
100
+	{
101
+		$task = [
102
+			'task' => $taskName,
103
+			'data' => serialize($data),
104
+			'not_before' => $this->getDateTime()
105
+		];
106
+
107
+		if (!empty($notBefore)) {
108
+			$task['not_before'] = $this->getDateTime(strtotime($notBefore));
109
+		}
110
+
111
+		$queuedTask = $this->newEntity($task);
112
+
113
+		return $this->saveOrFail($queuedTask);
114
+	}
115
+
116
+	/**
117
+	 *
118
+	 * @param string|null $taskName
119
+	 *
120
+	 * @return bool
121
+	 *
122
+	 * @throws \InvalidArgumentException
123
+	 */
124
+	public function isQueued($taskName = null)
125
+	{
126
+		$conditions = [
127
+			'completed IS' => null
128
+		];
129
+		if ($taskName) {
130
+			$conditions['task'] = $taskName;
131
+		}
132
+
133
+		return (bool)$this->find()
134
+			->where($conditions)
135
+			->select([
136
+				'id'
137
+			])
138
+			->first();
139
+	}
140
+
141
+	/**
142
+	 * Returns the number of items in the queue.
143
+	 * Either returns the number of ALL pending jobs, or the number of pending jobs of the passed type.
144
+	 *
145
+	 * @param string|null $taskName Task type to Count
146
+	 * @return int
147
+	 */
148
+	public function getLength($taskName = null)
149
+	{
150
+		$findConf = [
151
+			'conditions' => [
152
+				'completed IS' => null
153
+			]
154
+		];
155
+		if ($taskName !== null) {
156
+			$findConf['conditions']['task'] = $taskName;
157
+		}
158
+
159
+		return $this->find('all', $findConf)->count();
160
+	}
161
+
162
+	/**
163
+	 * Return a list of all task types in the Queue.
164
+	 *
165
+	 * @return \Cake\ORM\Query
166
+	 */
167
+	public function getTypes()
168
+	{
169
+		$findCond = [
170
+			'fields' => [
171
+				'task'
172
+			],
173
+			'group' => [
174
+				'task'
175
+			],
176
+			'keyField' => 'task',
177
+			'valueField' => 'task'
178
+		];
179
+
180
+		return $this->find('list', $findCond);
181
+	}
182
+
183
+	/**
184
+	 * Return some statistics about finished jobs still in the Database.
185
+	 * TO-DO: rewrite as virtual field
186
+	 *
187
+	 * @return \Cake\ORM\Query
188
+	 */
189
+	public function getStats()
190
+	{
191
+		$driverName = $this->_getDriverName();
192
+		$options = [
193
+			'fields' => function (Query $query) use ($driverName) {
194
+				$alltime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(created)');
195
+				$runtime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
196
+				$fetchdelay = $query->func()->avg('UNIX_TIMESTAMP(fetched) - IF(not_before is NULL, UNIX_TIMESTAMP(created), UNIX_TIMESTAMP(not_before))');
197
+				switch ($driverName) {
198
+					case static::DRIVER_SQLSERVER:
199
+						$alltime = $query->func()->avg("DATEDIFF(s, '1970-01-01 00:00:00', completed) - DATEDIFF(s, '1970-01-01 00:00:00', created)");
200
+						$runtime = $query->func()->avg("DATEDIFF(s, '1970-01-01 00:00:00', completed) - DATEDIFF(s, '1970-01-01 00:00:00', fetched)");
201
+						$fetchdelay = $query->func()->avg("DATEDIFF(s, '1970-01-01 00:00:00', fetched) - (CASE WHEN not_before IS NULL THEN DATEDIFF(s, '1970-01-01 00:00:00', created) ELSE DATEDIFF(s, '1970-01-01 00:00:00', not_before) END)");
202
+						break;
203
+				}
204
+				/**
205
+				 *
206
+				 * @var \Cake\ORM\Query
207
+				 */
208
+				return [
209
+					'task',
210
+					'num' => $query->func()->count('*'),
211
+					'alltime' => $alltime,
212
+					'runtime' => $runtime,
213
+					'fetchdelay' => $fetchdelay
214
+				];
215
+			},
216
+			'conditions' => [
217
+				'completed IS NOT' => null
218
+			],
219
+			'group' => [
220
+				'task'
221
+			]
222
+		];
223
+
224
+		return $this->find('all', $options);
225
+	}
226
+
227
+	/**
228
+	 * Returns [
229
+	 * 'Task' => [
230
+	 * 'YYYY-MM-DD' => INT,
231
+	 * ...
232
+	 * ]
233
+	 * ]
234
+	 *
235
+	 * @param string|null $taskName The task name
236
+	 * @return array
237
+	 */
238
+	public function getFullStats($taskName = null)
239
+	{
240
+		$driverName = $this->_getDriverName();
241
+		$fields = function (Query $query) use ($driverName) {
242
+			$runtime = $query->newExpr('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
243
+			switch ($driverName) {
244
+				case static::DRIVER_SQLSERVER:
245
+					$runtime = $query->newExpr("DATEDIFF(s, '1970-01-01 00:00:00', completed) - DATEDIFF(s, '1970-01-01 00:00:00', fetched)");
246
+					break;
247
+			}
248
+
249
+			return [
250
+				'task',
251
+				'created',
252
+				'duration' => $runtime
253
+			];
254
+		};
255
+
256
+		$conditions = [
257
+			'completed IS NOT' => null
258
+		];
259
+		if ($taskName) {
260
+			$conditions['task'] = $taskName;
261
+		}
262
+
263
+		$tasks = $this->find()
264
+			->select($fields)
265
+			->where($conditions)
266
+			->enableHydration(false)
267
+			->orderDesc('id')
268
+			->limit(static::STATS_LIMIT)
269
+			->all()
270
+			->toArray();
271
+
272
+		$result = [];
273
+
274
+		$days = [];
275
+
276
+		foreach ($tasks as $task) {
277
+			/** @var \DateTime $created */
278
+			$created = $task['created'];
279
+			$day = $created->format('Y-m-d');
280
+			if (!isset($days[$day])) {
281
+				$days[$day] = $day;
282
+			}
283
+
284
+			$result[$task['task']][$day][] = $task['duration'];
285
+		}
286
+
287
+		foreach ($result as $type => $tasks) {
288
+			foreach ($tasks as $day => $durations) {
289
+				$average = array_sum($durations) / count($durations);
290
+				$result[$type][$day] = (int)$average;
291
+			}
292
+
293
+			foreach ($days as $day) {
294
+				if (isset($result[$type][$day])) {
295
+					continue;
296
+				}
297
+
298
+				$result[$type][$day] = 0;
299
+			}
300
+
301
+			ksort($result[$type]);
302
+		}
303
+
304
+		return $result;
305
+	}
306
+
307
+	/**
308
+	 * Look for a new job that can be processed with the current abilities and
309
+	 * from the specified group (or any if null).
310
+	 *
311
+	 * @param array $capabilities Available QueueWorkerTasks.
312
+	 * @param array $types Request a job from these types (or exclude certain types), or any otherwise.
313
+	 * @return \Queue\Model\Entity\QueuedTask|null
314
+	 */
315
+	public function requestJob(array $capabilities, array $types = [])
316
+	{
317
+		$now = $this->getDateTime();
318
+		$nowStr = $now->toDateTimeString();
319
+		$driverName = $this->_getDriverName();
320
+
321
+		$query = $this->find();
322
+		$age = $query->newExpr()->add('IFNULL(TIMESTAMPDIFF(SECOND, "' . $nowStr . '", not_before), 0)');
323
+		switch ($driverName) {
324
+			case static::DRIVER_SQLSERVER:
325
+				$age = $query->newExpr()->add('ISNULL(DATEDIFF(SECOND, GETDATE(), not_before), 0)');
326
+				break;
327
+			case static::DRIVER_POSTGRES:
328
+				$age = $query->newExpr()->add('COALESCE((EXTRACT(EPOCH FROM now()) - EXTRACT(EPOCH FROM not_before)), 0)');
329
+				break;
330
+		}
331
+		$options = [
332
+			'conditions' => [
333
+				'completed IS' => null,
334
+				'OR' => []
335
+			],
336
+			'fields' => [
337
+				'age' => $age
338
+			],
339
+			'order' => [
340
+				'age' => 'ASC',
341
+				'id' => 'ASC'
342
+			]
343
+		];
344
+
345
+		if ($types) {
346
+			$options['conditions'] = $this->addFilter($options['conditions'], 'task', $types);
347
+		}
348
+
349
+		// Generate the task specific conditions.
350
+		foreach ($capabilities as $task) {
351
+			list ($plugin, $name) = pluginSplit($task['name']);
352
+			$timeoutAt = $now->copy();
353
+			$tmp = [
354
+				'task' => $name,
355
+				'AND' => [
356
+					[
357
+						'OR' => [
358
+							'not_before <' => $nowStr,
359
+							'not_before IS' => null
360
+						]
361
+					],
362
+					[
363
+						'OR' => [
364
+							'fetched <' => $timeoutAt->subSeconds($task['timeout']),
365
+							'fetched IS' => null
366
+						]
367
+					]
368
+				],
369
+				'failed_count <' => ($task['retries'] + 1)
370
+			];
371
+			$options['conditions']['OR'][] = $tmp;
372
+		}
373
+
374
+		/** @var \Queue\Model\Entity\QueuedTask|null $task */
375
+		$task = $this->getConnection()->transactional(function () use ($query, $options, $now) {
376
+			$task = $query->find('all', $options)
377
+				->enableAutoFields(true)
378
+				->epilog('FOR UPDATE')
379
+				->first();
380
+
381
+			if (!$task) {
382
+				return null;
383
+			}
384
+
385
+			$key = $this->key();
386
+			$task = $this->patchEntity($task, [
387
+				'worker_key' => $key,
388
+				'fetched' => $now
389
+			]);
390
+
391
+			return $this->saveOrFail($task);
392
+		});
393
+
394
+		if (!$task) {
395
+			return null;
396
+		}
397
+
398
+		return $task;
399
+	}
400
+
401
+	/**
402
+	 * Mark a task as Completed, removing it from the queue.
403
+	 *
404
+	 * @param \Queue\Model\Entity\QueuedTask $task Task
405
+	 * @return bool Success
406
+	 */
407
+	public function markJobDone(QueuedTask $task)
408
+	{
409
+		$fields = [
410
+			'completed' => $this->getDateTime()
411
+		];
412
+		$task = $this->patchEntity($task, $fields);
413
+
414
+		return (bool)$this->save($task);
415
+	}
416
+
417
+	/**
418
+	 * Mark a job as Failed, incrementing the failed-counter and Requeueing it.
419
+	 *
420
+	 * @param \Queue\Model\Entity\QueuedTask $task Task
421
+	 * @param string|null $failureMessage Optional message to append to the failure_message field.
422
+	 * @return bool Success
423
+	 */
424
+	public function markJobFailed(QueuedTask $task, $failureMessage = null)
425
+	{
426
+		$fields = [
427
+			'failed_count' => $task->failed_count + 1,
428
+			'failure_message' => $failureMessage
429
+		];
430
+		$task = $this->patchEntity($task, $fields);
431
+
432
+		return (bool)$this->save($task);
433
+	}
434
+
435
+	/**
436
+	 * Reset current jobs
437
+	 *
438
+	 * @param int|null $id ID
439
+	 *
440
+	 * @return int Success
441
+	 */
442
+	public function reset($id = null)
443
+	{
444
+		$fields = [
445
+			'completed' => null,
446
+			'fetched' => null,
447
+			'failed_count' => 0,
448
+			'worker_key' => null,
449
+			'failure_message' => null
450
+		];
451
+		$conditions = [
452
+			'completed IS' => null
453
+		];
454
+		if ($id) {
455
+			$conditions['id'] = $id;
456
+		}
457
+
458
+		return $this->updateAll($fields, $conditions);
459
+	}
460
+
461
+	/**
462
+	 *
463
+	 * @param string $taskName Task name
464
+	 *
465
+	 * @return int
466
+	 */
467
+	public function rerun($taskName)
468
+	{
469
+		$fields = [
470
+			'completed' => null,
471
+			'fetched' => null,
472
+			'failed_count' => 0,
473
+			'worker_key' => null,
474
+			'failure_message' => null
475
+		];
476
+		$conditions = [
477
+			'completed IS NOT' => null,
478
+			'task' => $taskName
479
+		];
480
+
481
+		return $this->updateAll($fields, $conditions);
482
+	}
483
+
484
+	/**
485
+	 * Cleanup/Delete Completed Tasks.
486
+	 *
487
+	 * @return void
488
+	 */
489
+	public function cleanOldJobs()
490
+	{
491
+		if (!Configure::read('Queue.cleanuptimeout')) {
492
+			return;
493
+		}
494
+
495
+		$this->deleteAll([
496
+			'completed <' => time() - (int)Configure::read('Queue.cleanuptimeout')
497
+		]);
498
+	}
499
+
500
+	/**
501
+	 *
502
+	 * @param \Queue\Model\Entity\QueuedTask $queuedTask Queued task
503
+	 * @param array $taskConfiguration Task configuration
504
+	 * @return string
505
+	 */
506
+	public function getFailedStatus($queuedTask, array $taskConfiguration)
507
+	{
508
+		$failureMessageRequeued = 'requeued';
509
+
510
+		$queuedTaskName = 'Queue' . $queuedTask->task;
511
+		if (empty($taskConfiguration[$queuedTaskName])) {
512
+			return $failureMessageRequeued;
513
+		}
514
+		$retries = $taskConfiguration[$queuedTaskName]['retries'];
515
+		if ($queuedTask->failed_count <= $retries) {
516
+			return $failureMessageRequeued;
517
+		}
518
+
519
+		return 'aborted';
520
+	}
521
+
522
+	/**
523
+	 * Generates a unique Identifier for the current worker thread.
524
+	 *
525
+	 * Useful to identify the currently running processes for this thread.
526
+	 *
527
+	 * @return string Identifier
528
+	 */
529
+	public function key()
530
+	{
531
+		if ($this->_key !== null) {
532
+			return $this->_key;
533
+		}
534
+		$this->_key = sha1(microtime());
535
+		if (!$this->_key) {
536
+			throw new RuntimeException('Invalid key generated');
537
+		}
538
+
539
+		return $this->_key;
540
+	}
541
+
542
+	/**
543
+	 * Resets worker Identifier
544
+	 *
545
+	 * @return void
546
+	 */
547
+	public function clearKey()
548
+	{
549
+		$this->_key = null;
550
+	}
551
+
552
+	/**
553
+	 * truncate()
554
+	 *
555
+	 * @return void
556
+	 */
557
+	public function truncate()
558
+	{
559
+		$sql = $this->getSchema()->truncateSql($this->_connection);
560
+		foreach ($sql as $snippet) {
561
+			$this->_connection->execute($snippet);
562
+		}
563
+	}
564
+
565
+	/**
566
+	 * get the name of the driver
567
+	 *
568
+	 * @return string
569
+	 */
570
+	protected function _getDriverName()
571
+	{
572
+		$className = explode('\\', $this->getConnection()->config()['driver']);
573
+		$name = end($className);
574
+
575
+		return $name;
576
+	}
577
+
578
+	/**
579
+	 *
580
+	 * @param array $conditions Conditions
581
+	 * @param string $key Key
582
+	 * @param array $values Values
583
+	 * @return array
584
+	 */
585
+	protected function addFilter(array $conditions, $key, array $values)
586
+	{
587
+		$include = [];
588
+		$exclude = [];
589
+		foreach ($values as $value) {
590
+			if (substr($value, 0, 1) === '-') {
591
+				$exclude[] = substr($value, 1);
592
+			} else {
593
+				$include[] = $value;
594
+			}
595
+		}
596
+
597
+		if ($include) {
598
+			$conditions[$key . ' IN'] = $include;
599
+		}
600
+		if ($exclude) {
601
+			$conditions[$key . ' NOT IN'] = $exclude;
602
+		}
603
+
604
+		return $conditions;
605
+	}
606
+
607
+	/**
608
+	 * Returns a DateTime object from different input.
609
+	 *
610
+	 * Without argument this will be "now".
611
+	 *
612
+	 * @param int|string|\Cake\I18n\FrozenTime|\Cake\I18n\Time|null $notBefore Not before time
613
+	 *
614
+	 * @return \Cake\I18n\FrozenTime|\Cake\I18n\Time
615
+	 */
616
+	protected function getDateTime($notBefore = null)
617
+	{
618
+		if (is_object($notBefore)) {
619
+			return $notBefore;
620
+		}
621
+
622
+		return new FrozenTime($notBefore);
623
+	}
624 624
 }
Please login to merge, or discard this patch.