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
|
<?php
/**
* Job queue aggregator code.
*
* 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
*
* @ingroup JobQueue
* @since 1.21
*/
abstract class JobQueueAggregator {
/** @var JobQueueAggregator */
protected static $instance = null;
/**
* @param array $params
*/
protected function __construct( array $params ) {}
/**
* @return JobQueueAggregator
*/
final public static function singleton() {
global $wgJobQueueAggregator;
if ( !isset( self::$instance ) ) {
$class = $wgJobQueueAggregator['class'];
$obj = new $class( $wgJobQueueAggregator );
if ( !( $obj instanceof JobQueueAggregator ) ) {
throw new MWException( "Class '$class' is not a JobQueueAggregator class." );
}
self::$instance = $obj;
}
return self::$instance;
}
/**
* Destroy the singleton instance
*
* @return void
*/
final public static function destroySingleton() {
self::$instance = null;
}
/**
* Mark a queue as being empty
*
* @param string $wiki
* @param string $type
* @return bool Success
*/
final public function notifyQueueEmpty( $wiki, $type ) {
wfProfileIn( __METHOD__ );
$ok = $this->doNotifyQueueEmpty( $wiki, $type );
wfProfileOut( __METHOD__ );
return $ok;
}
/**
* @see JobQueueAggregator::notifyQueueEmpty()
*/
abstract protected function doNotifyQueueEmpty( $wiki, $type );
/**
* Mark a queue as being non-empty
*
* @param string $wiki
* @param string $type
* @return bool Success
*/
final public function notifyQueueNonEmpty( $wiki, $type ) {
wfProfileIn( __METHOD__ );
$ok = $this->doNotifyQueueNonEmpty( $wiki, $type );
wfProfileOut( __METHOD__ );
return $ok;
}
/**
* @see JobQueueAggregator::notifyQueueNonEmpty()
*/
abstract protected function doNotifyQueueNonEmpty( $wiki, $type );
/**
* Get the list of all of the queues with jobs
*
* @return Array (job type => (list of wiki IDs))
*/
final public function getAllReadyWikiQueues() {
wfProfileIn( __METHOD__ );
$res = $this->doGetAllReadyWikiQueues();
wfProfileOut( __METHOD__ );
return $res;
}
/**
* @see JobQueueAggregator::getAllReadyWikiQueues()
*/
abstract protected function doGetAllReadyWikiQueues();
/**
* Purge all of the aggregator information
*
* @return bool Success
*/
final public function purge() {
wfProfileIn( __METHOD__ );
$res = $this->doPurge();
wfProfileOut( __METHOD__ );
return $res;
}
/**
* @see JobQueueAggregator::purge()
*/
abstract protected function doPurge();
/**
* Get all databases that have a pending job.
* This poll all the queues and is this expensive.
*
* @return Array (job type => (list of wiki IDs))
*/
protected function findPendingWikiQueues() {
global $wgLocalDatabases;
$pendingDBs = array(); // (job type => (db list))
foreach ( $wgLocalDatabases as $db ) {
foreach ( JobQueueGroup::singleton( $db )->getQueuesWithJobs() as $type ) {
$pendingDBs[$type][] = $db;
}
}
return $pendingDBs;
}
}
|
