summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/JobQueue.php
blob: 2e580459ffee6e5a4494a13f60f5fc3ffa06ad86 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<?php

namespace SMW\MediaWiki;

use JobQueueGroup;

/**
 * MediaWiki's JobQueue contains mostly final methods making it difficult to use
 * an instance during tests hence this class provides a reduced interface with
 * mockable methods.
 *
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author mwjames
 */
class JobQueue {

	/**
	 * @var JobQueueGroup
	 */
	private $jobQueueGroup;

	/**
	 * @var boolean
	 */
	private $disableCache = false;

	/**
	 * @since 3.0
	 *
	 * @param JobQueueGroup $jobQueueGroup
	 */
	public function __construct( JobQueueGroup $jobQueueGroup ) {
		$this->jobQueueGroup = $jobQueueGroup;
	}

	/**
	 * @since 3.0
	 *
	 * @param boolean $disableCache
	 */
	public function disableCache( $disableCache = true ) {
		$this->disableCache = (bool)$disableCache;
	}

	/**
	 * @since 3.0
	 *
	 * @param string $type
	 *
	 * @return boolean
	 */
	public function isDelayedJobsEnabled( $type ) {
		return $this->jobQueueGroup->get( $this->mapLegacyType( $type ) )->delayedJobsEnabled();
	}

	/**
	 * @since 3.0
	 *
	 * @param array $list
	 *
	 * @return []
	 */
	public function runFromQueue( array $list ) {

		$log = [];

		foreach ( $list as $type => $amount ) {

			if ( $amount == 0 || $amount === false ) {
				continue;
			}

			$jobs = array_fill( 0, $amount, $type );
			$log[$type] = [];

			foreach ( $jobs as $job ) {
				$j = $this->pop( $job );

				if ( $j === false ) {
					break;
				}

				$log[$type][] = $j->getTitle()->getPrefixedDBKey();

				$j->run();
				$this->ack( $j );
			}
		}

		return $log;
	}

	/**
	 * @since 3.0
	 *
	 * @param string $type
	 *
	 * @return Job|boolean
	 */
	public function pop( $type ) {
		return $this->jobQueueGroup->get( $this->mapLegacyType( $type ) )->pop();
	}

	/**
	 * Acknowledge that a job was completed
	 *
	 * @since 3.0
	 *
	 * @param Job $job
	 */
	public function ack( \Job $job ) {
		$this->jobQueueGroup->get( $job->getType() )->ack( $job );
	}

	/**
	 * @since 3.0
	 *
	 * @param string $type
	 */
	public function delete( $type ) {

		$jobQueue = $this->jobQueueGroup->get( $this->mapLegacyType( $type ) );
		$jobQueue->delete();

		if ( $this->disableCache ) {
			$jobQueue->flushCaches();
			$this->disableCache = false;
		}
	}

	/**
	 * @since 3.0
	 *
	 * @param Job|Job[] $jobs
	 */
	public function push( $jobs ) {
		$this->jobQueueGroup->push( $jobs );
	}

	/**
	 * @since 3.0
	 *
	 * @param Job|Job[] $jobs
	 */
	public function lazyPush( $jobs ) {

		if ( !method_exists( $this->jobQueueGroup, 'lazyPush' ) ) {
			return $this->push( $jobs );
		}

		$this->jobQueueGroup->lazyPush( $jobs );
	}

	/**
	 * @since 3.0
	 *
	 * @return array
	 */
	public function getQueueSizes() {
		return $this->jobQueueGroup->getQueueSizes();
	}

	/**
	 * @since 3.0
	 *
	 * @param string $type
	 *
	 * @return integer
	 */
	public function getQueueSize( $type ) {

		$jobQueue = $this->jobQueueGroup->get( $this->mapLegacyType( $type ) );

		if ( $this->disableCache ) {
			$jobQueue->flushCaches();
			$this->disableCache = false;
		}

		return $jobQueue->getSize();
	}

	/**
	 * @since 3.0
	 *
	 * @param string $type
	 *
	 * @return boolean
	 */
	public function hasPendingJob( $type ) {
		return $this->getQueueSize( $type ) > 0;
	}

	/**
	 * @note FIXME Remove with 3.1
	 * @since 3.0
	 *
	 * @param string $type
	 *
	 * @return string
	 */
	public static function mapLegacyType( $type ) {

		// Legacy names
		if ( strpos( $type, 'SMW\\' ) !== false ) {
			$type = 'smw.' . lcfirst( str_replace( [ 'SMW\\', 'Job' ], '', $type ) );
		}

		return $type;
	}

}