summaryrefslogtreecommitdiff
path: root/includes/jobqueue/jobs/RecentChangesUpdateJob.php
blob: d6fa26b81fcb52c2b1569c758ede8e5bd68d6c33 (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
214
215
216
217
218
219
220
221
222
223
224
225
<?php
/**
 * 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
 * @ingroup JobQueue
 */

/**
 * Job for pruning recent changes
 *
 * @ingroup JobQueue
 * @since 1.25
 */
class RecentChangesUpdateJob extends Job {
	function __construct( Title $title, array $params ) {
		parent::__construct( 'recentChangesUpdate', $title, $params );

		if ( !isset( $params['type'] ) ) {
			throw new Exception( "Missing 'type' parameter." );
		}

		$this->removeDuplicates = true;
	}

	/**
	 * @return RecentChangesUpdateJob
	 */
	final public static function newPurgeJob() {
		return new self(
			SpecialPage::getTitleFor( 'Recentchanges' ), array( 'type' => 'purge' )
		);
	}

	/**
	 * @return RecentChangesUpdateJob
	 * @since 1.26
	 */
	final public static function newCacheUpdateJob() {
		return new self(
			SpecialPage::getTitleFor( 'Recentchanges' ), array( 'type' => 'cacheUpdate' )
		);
	}

	public function run() {
		if ( $this->params['type'] === 'purge' ) {
			$this->purgeExpiredRows();
		} elseif ( $this->params['type'] === 'cacheUpdate' ) {
			$this->updateActiveUsers();
		} else {
			throw new InvalidArgumentException(
				"Invalid 'type' parameter '{$this->params['type']}'." );
		}

		return true;
	}

	protected function purgeExpiredRows() {
		global $wgRCMaxAge;

		$lockKey = wfWikiID() . ':recentchanges-prune';

		$dbw = wfGetDB( DB_MASTER );
		if ( !$dbw->lockIsFree( $lockKey, __METHOD__ )
			|| !$dbw->lock( $lockKey, __METHOD__, 1 )
		) {
			return; // already in progress
		}

		$batchSize = 100; // avoid slave lag
		$cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
		do {
			$rcIds = $dbw->selectFieldValues( 'recentchanges',
				'rc_id',
				array( 'rc_timestamp < ' . $dbw->addQuotes( $cutoff ) ),
				__METHOD__,
				array( 'LIMIT' => $batchSize )
			);
			if ( $rcIds ) {
				$dbw->delete( 'recentchanges', array( 'rc_id' => $rcIds ), __METHOD__ );
			}
			// Commit in chunks to avoid slave lag
			$dbw->commit( __METHOD__, 'flush' );

			if ( count( $rcIds ) === $batchSize ) {
				// There might be more, so try waiting for slaves
				if ( !wfWaitForSlaves( null, false, false, /* $timeout = */ 3 ) ) {
					// Another job will continue anyway
					break;
				}
			}
		} while ( $rcIds );

		$dbw->unlock( $lockKey, __METHOD__ );
	}

	protected function updateActiveUsers() {
		global $wgActiveUserDays;

		// Users that made edits at least this many days ago are "active"
		$days = $wgActiveUserDays;
		// Pull in the full window of active users in this update
		$window = $wgActiveUserDays * 86400;

		$dbw = wfGetDB( DB_MASTER );
		// JobRunner uses DBO_TRX, but doesn't call begin/commit itself;
		// onTransactionIdle() will run immediately since there is no trx.
		$dbw->onTransactionIdle( function() use ( $dbw, $days, $window ) {
			// Avoid disconnect/ping() cycle that makes locks fall off
			$dbw->setSessionOptions( array( 'connTimeout' => 900 ) );

			$lockKey = wfWikiID() . '-activeusers';
			if ( !$dbw->lock( $lockKey, __METHOD__, 1 ) ) {
				return false; // exclusive update (avoids duplicate entries)
			}

			$nowUnix = time();
			// Get the last-updated timestamp for the cache
			$cTime = $dbw->selectField( 'querycache_info',
				'qci_timestamp',
				array( 'qci_type' => 'activeusers' )
			);
			$cTimeUnix = $cTime ? wfTimestamp( TS_UNIX, $cTime ) : 1;

			// Pick the date range to fetch from. This is normally from the last
			// update to till the present time, but has a limited window for sanity.
			// If the window is limited, multiple runs are need to fully populate it.
			$sTimestamp = max( $cTimeUnix, $nowUnix - $days * 86400 );
			$eTimestamp = min( $sTimestamp + $window, $nowUnix );

			// Get all the users active since the last update
			$res = $dbw->select(
				array( 'recentchanges' ),
				array( 'rc_user_text', 'lastedittime' => 'MAX(rc_timestamp)' ),
				array(
					'rc_user > 0', // actual accounts
					'rc_type != ' . $dbw->addQuotes( RC_EXTERNAL ), // no wikidata
					'rc_log_type IS NULL OR rc_log_type != ' . $dbw->addQuotes( 'newusers' ),
					'rc_timestamp >= ' . $dbw->addQuotes( $dbw->timestamp( $sTimestamp ) ),
					'rc_timestamp <= ' . $dbw->addQuotes( $dbw->timestamp( $eTimestamp ) )
				),
				__METHOD__,
				array(
					'GROUP BY' => array( 'rc_user_text' ),
					'ORDER BY' => 'NULL' // avoid filesort
				)
			);
			$names = array();
			foreach ( $res as $row ) {
				$names[$row->rc_user_text] = $row->lastedittime;
			}

			// Rotate out users that have not edited in too long (according to old data set)
			$dbw->delete( 'querycachetwo',
				array(
					'qcc_type' => 'activeusers',
					'qcc_value < ' . $dbw->addQuotes( $nowUnix - $days * 86400 ) // TS_UNIX
				),
				__METHOD__
			);

			// Find which of the recently active users are already accounted for
			if ( count( $names ) ) {
				$res = $dbw->select( 'querycachetwo',
					array( 'user_name' => 'qcc_title' ),
					array(
						'qcc_type' => 'activeusers',
						'qcc_namespace' => NS_USER,
						'qcc_title' => array_keys( $names ) ),
					__METHOD__
				);
				foreach ( $res as $row ) {
					unset( $names[$row->user_name] );
				}
			}

			// Insert the users that need to be added to the list
			if ( count( $names ) ) {
				$newRows = array();
				foreach ( $names as $name => $lastEditTime ) {
					$newRows[] = array(
						'qcc_type' => 'activeusers',
						'qcc_namespace' => NS_USER,
						'qcc_title' => $name,
						'qcc_value' => wfTimestamp( TS_UNIX, $lastEditTime ),
						'qcc_namespacetwo' => 0, // unused
						'qcc_titletwo' => '' // unused
					);
				}
				foreach ( array_chunk( $newRows, 500 ) as $rowBatch ) {
					$dbw->insert( 'querycachetwo', $rowBatch, __METHOD__ );
					wfWaitForSlaves();
				}
			}

			// If a transaction was already started, it might have an old
			// snapshot, so kludge the timestamp range back as needed.
			$asOfTimestamp = min( $eTimestamp, (int)$dbw->trxTimestamp() );

			// Touch the data freshness timestamp
			$dbw->replace( 'querycache_info',
				array( 'qci_type' ),
				array( 'qci_type' => 'activeusers',
					'qci_timestamp' => $dbw->timestamp( $asOfTimestamp ) ), // not always $now
				__METHOD__
			);

			$dbw->unlock( $lockKey, __METHOD__ );
		} );
	}
}