MediaWiki REL1_31
initEditCount.php
Go to the documentation of this file.
1<?php
25require_once __DIR__ . '/Maintenance.php';
26
28 public function __construct() {
29 parent::__construct();
30 $this->addOption( 'quick', 'Force the update to be done in a single query' );
31 $this->addOption( 'background', 'Force replication-friendly mode; may be inefficient but
32 avoids locking tables or lagging replica DBs with large updates;
33 calculates counts on a replica DB if possible.
34
35Background mode will be automatically used if multiple servers are listed
36in the load balancer, usually indicating a replication environment.' );
37 $this->addDescription( 'Batch-recalculate user_editcount fields from the revision table' );
38 }
39
40 public function execute() {
42
43 $dbw = $this->getDB( DB_MASTER );
44
45 // Autodetect mode...
46 if ( $this->hasOption( 'background' ) ) {
47 $backgroundMode = true;
48 } elseif ( $this->hasOption( 'quick' ) ) {
49 $backgroundMode = false;
50 } else {
51 $backgroundMode = wfGetLB()->getServerCount() > 1;
52 }
53
54 $actorQuery = ActorMigration::newMigration()->getJoin( 'rev_user' );
55
56 $needSpecialQuery = ( $wgActorTableSchemaMigrationStage !== MIGRATION_OLD &&
58 if ( $needSpecialQuery ) {
59 foreach ( $actorQuery['joins'] as &$j ) {
60 $j[0] = 'JOIN'; // replace LEFT JOIN
61 }
62 unset( $j );
63 }
64
65 if ( $backgroundMode ) {
66 $this->output( "Using replication-friendly background mode...\n" );
67
68 $dbr = $this->getDB( DB_REPLICA );
69 $chunkSize = 100;
70 $lastUser = $dbr->selectField( 'user', 'MAX(user_id)', '', __METHOD__ );
71
72 $start = microtime( true );
73 $migrated = 0;
74 for ( $min = 0; $min <= $lastUser; $min += $chunkSize ) {
75 $max = $min + $chunkSize;
76
77 if ( $needSpecialQuery ) {
78 // Use separate subqueries to collect counts with the old
79 // and new schemas, to avoid having to do whole-table scans.
80 $result = $dbr->select(
81 [
82 'user',
83 'rev1' => '('
84 . $dbr->selectSQLText(
85 [ 'revision', 'revision_actor_temp' ],
86 [ 'rev_user', 'ct' => 'COUNT(*)' ],
87 [
88 "rev_user > $min AND rev_user <= $max",
89 'revactor_rev' => null,
90 ],
91 __METHOD__,
92 [ 'GROUP BY' => 'rev_user' ],
93 [ 'revision_actor_temp' => [ 'LEFT JOIN', 'revactor_rev = rev_id' ] ]
94 ) . ')',
95 'rev2' => '('
96 . $dbr->selectSQLText(
97 [ 'revision' ] + $actorQuery['tables'],
98 [ 'actor_user', 'ct' => 'COUNT(*)' ],
99 "actor_user > $min AND actor_user <= $max",
100 __METHOD__,
101 [ 'GROUP BY' => 'actor_user' ],
102 $actorQuery['joins']
103 ) . ')',
104 ],
105 [ 'user_id', 'user_editcount' => 'COALESCE(rev1.ct,0) + COALESCE(rev2.ct,0)' ],
106 "user_id > $min AND user_id <= $max",
107 __METHOD__,
108 [],
109 [
110 'rev1' => [ 'LEFT JOIN', 'user_id = rev_user' ],
111 'rev2' => [ 'LEFT JOIN', 'user_id = actor_user' ],
112 ]
113 );
114 } else {
115 $revUser = $actorQuery['fields']['rev_user'];
116 $result = $dbr->select(
117 [ 'user', 'rev' => [ 'revision' ] + $actorQuery['tables'] ],
118 [ 'user_id', 'user_editcount' => "COUNT($revUser)" ],
119 "user_id > $min AND user_id <= $max",
120 __METHOD__,
121 [ 'GROUP BY' => 'user_id' ],
122 [ 'rev' => [ 'LEFT JOIN', "user_id = $revUser" ] ] + $actorQuery['joins']
123 );
124 }
125
126 foreach ( $result as $row ) {
127 $dbw->update( 'user',
128 [ 'user_editcount' => $row->user_editcount ],
129 [ 'user_id' => $row->user_id ],
130 __METHOD__ );
131 ++$migrated;
132 }
133
134 $delta = microtime( true ) - $start;
135 $rate = ( $delta == 0.0 ) ? 0.0 : $migrated / $delta;
136 $this->output( sprintf( "%s %d (%0.1f%%) done in %0.1f secs (%0.3f accounts/sec).\n",
137 wfWikiID(),
138 $migrated,
139 min( $max, $lastUser ) / $lastUser * 100.0,
140 $delta,
141 $rate ) );
142
144 }
145 } else {
146 $this->output( "Using single-query mode...\n" );
147
148 $user = $dbw->tableName( 'user' );
149 if ( $needSpecialQuery ) {
150 $subquery1 = $dbw->selectSQLText(
151 [ 'revision', 'revision_actor_temp' ],
152 [ 'COUNT(*)' ],
153 [
154 'user_id = rev_user',
155 'revactor_rev' => null,
156 ],
157 __METHOD__,
158 [],
159 [ 'revision_actor_temp' => [ 'LEFT JOIN', 'revactor_rev = rev_id' ] ]
160 );
161 $subquery2 = $dbw->selectSQLText(
162 [ 'revision' ] + $actorQuery['tables'],
163 [ 'COUNT(*)' ],
164 'user_id = actor_user',
165 __METHOD__,
166 [],
167 $actorQuery['joins']
168 );
169 $dbw->query(
170 "UPDATE $user SET user_editcount=($subquery1) + ($subquery2)",
171 __METHOD__
172 );
173 } else {
174 $subquery = $dbw->selectSQLText(
175 [ 'revision' ] + $actorQuery['tables'],
176 [ 'COUNT(*)' ],
177 [ 'user_id = ' . $actorQuery['fields']['rev_user'] ],
178 __METHOD__,
179 [],
180 $actorQuery['joins']
181 );
182 $dbw->query( "UPDATE $user SET user_editcount=($subquery)", __METHOD__ );
183 }
184 }
185
186 $this->output( "Done!\n" );
187 }
188}
189
190$maintClass = InitEditCount::class;
191require_once RUN_MAINTENANCE_IF_MAIN;
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
wfGetLB( $wiki=false)
Get a load balancer object.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
__construct()
Default constructor.
execute()
Do the actual work.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
const MIGRATION_NEW
Definition Defines.php:305
const MIGRATION_OLD
Definition Defines.php:302
$maintClass
require_once RUN_MAINTENANCE_IF_MAIN
const DB_REPLICA
Definition defines.php:25
const DB_MASTER
Definition defines.php:29