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
214
215
216
217
218
219
220
221
222
223
224
225
226
|
<?php
/**
* Job queue aggregator code that uses PhpRedis.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Aaron Schulz
*/
/**
* Class to handle tracking information about all queues using PhpRedis
*
* @ingroup JobQueue
* @ingroup Redis
* @since 1.21
*/
class JobQueueAggregatorRedis extends JobQueueAggregator {
/** @var RedisConnectionPool */
protected $redisPool;
/** @var array List of Redis server addresses */
protected $servers;
/**
* @param array $params Possible keys:
* - redisConfig : An array of parameters to RedisConnectionPool::__construct().
* - redisServers : Array of server entries, the first being the primary and the
* others being fallback servers. Each entry is either a hostname/port
* combination or the absolute path of a UNIX socket.
* If a hostname is specified but no port, the standard port number
* 6379 will be used. Required.
*/
public function __construct( array $params ) {
parent::__construct( $params );
$this->servers = isset( $params['redisServers'] )
? $params['redisServers']
: array( $params['redisServer'] ); // b/c
$params['redisConfig']['serializer'] = 'none';
$this->redisPool = RedisConnectionPool::singleton( $params['redisConfig'] );
}
protected function doNotifyQueueEmpty( $wiki, $type ) {
$conn = $this->getConnection();
if ( !$conn ) {
return false;
}
try {
$conn->hDel( $this->getReadyQueueKey(), $this->encQueueName( $type, $wiki ) );
return true;
} catch ( RedisException $e ) {
$this->handleException( $conn, $e );
return false;
}
}
protected function doNotifyQueueNonEmpty( $wiki, $type ) {
$conn = $this->getConnection();
if ( !$conn ) {
return false;
}
try {
$conn->multi( Redis::PIPELINE );
$conn->hSetNx( $this->getQueueTypesKey(), $type, 'enabled' );
$conn->sAdd( $this->getWikiSetKey(), $wiki );
$conn->hSet( $this->getReadyQueueKey(), $this->encQueueName( $type, $wiki ), time() );
$conn->exec();
return true;
} catch ( RedisException $e ) {
$this->handleException( $conn, $e );
return false;
}
}
protected function doGetAllReadyWikiQueues() {
$conn = $this->getConnection();
if ( !$conn ) {
return array();
}
try {
$map = $conn->hGetAll( $this->getReadyQueueKey() );
if ( is_array( $map ) && isset( $map['_epoch'] ) ) {
unset( $map['_epoch'] ); // ignore
$pendingDBs = array(); // (type => list of wikis)
foreach ( $map as $key => $time ) {
list( $type, $wiki ) = $this->dencQueueName( $key );
$pendingDBs[$type][] = $wiki;
}
} else {
// Avoid duplicated effort
$rand = wfRandomString( 32 );
$conn->multi( Redis::MULTI );
$conn->setex( "{$rand}:lock", 3600, 1 );
$conn->renamenx( "{$rand}:lock", $this->getReadyQueueKey() . ":lock" );
if ( $conn->exec() !== array( true, true ) ) { // lock
$conn->delete( "{$rand}:lock" );
return array(); // already in progress
}
$pendingDBs = $this->findPendingWikiQueues(); // (type => list of wikis)
$conn->multi( Redis::PIPELINE );
$now = time();
$map = array( '_epoch' => time() ); // dummy key for empty Redis collections
foreach ( $pendingDBs as $type => $wikis ) {
$conn->hSetNx( $this->getQueueTypesKey(), $type, 'enabled' );
foreach ( $wikis as $wiki ) {
$map[$this->encQueueName( $type, $wiki )] = $now;
}
}
$conn->hMSet( $this->getReadyQueueKey(), $map );
$conn->exec();
$conn->delete( $this->getReadyQueueKey() . ":lock" ); // unlock
}
return $pendingDBs;
} catch ( RedisException $e ) {
$this->handleException( $conn, $e );
return array();
}
}
protected function doPurge() {
$conn = $this->getConnection();
if ( !$conn ) {
return false;
}
try {
$conn->delete( $this->getReadyQueueKey() );
// leave key at getQueueTypesKey() alone
} catch ( RedisException $e ) {
$this->handleException( $conn, $e );
return false;
}
return true;
}
/**
* Get a connection to the server that handles all sub-queues for this queue
*
* @return RedisConnRef|bool Returns false on failure
* @throws MWException
*/
protected function getConnection() {
$conn = false;
foreach ( $this->servers as $server ) {
$conn = $this->redisPool->getConnection( $server );
if ( $conn ) {
break;
}
}
return $conn;
}
/**
* @param RedisConnRef $conn
* @param RedisException $e
* @return void
*/
protected function handleException( RedisConnRef $conn, $e ) {
$this->redisPool->handleError( $conn, $e );
}
/**
* @return string
*/
private function getReadyQueueKey() {
return "jobqueue:aggregator:h-ready-queues:v2"; // global
}
/**
* @return string
*/
private function getQueueTypesKey() {
return "jobqueue:aggregator:h-queue-types:v2"; // global
}
/**
* @return string
*/
private function getWikiSetKey() {
return "jobqueue:aggregator:s-wikis:v2"; // global
}
/**
* @param string $type
* @param string $wiki
* @return string
*/
private function encQueueName( $type, $wiki ) {
return rawurlencode( $type ) . '/' . rawurlencode( $wiki );
}
/**
* @param string $name
* @return string
*/
private function dencQueueName( $name ) {
list( $type, $wiki ) = explode( '/', $name, 2 );
return array( rawurldecode( $type ), rawurldecode( $wiki ) );
}
}
|
