MediaWiki REL1_31
reassignEdits.php
Go to the documentation of this file.
1<?php
27
28require_once __DIR__ . '/Maintenance.php';
29
37 public function __construct() {
38 parent::__construct();
39 $this->addDescription( 'Reassign edits from one user to another' );
40 $this->addOption( "force", "Reassign even if the target user doesn't exist" );
41 $this->addOption( "norc", "Don't update the recent changes table" );
42 $this->addOption( "report", "Print out details of what would be changed, but don't update it" );
43 $this->addArg( 'from', 'Old user to take edits from' );
44 $this->addArg( 'to', 'New user to give edits to' );
45 }
46
47 public function execute() {
48 if ( $this->hasArg( 0 ) && $this->hasArg( 1 ) ) {
49 # Set up the users involved
50 $from = $this->initialiseUser( $this->getArg( 0 ) );
51 $to = $this->initialiseUser( $this->getArg( 1 ) );
52
53 # If the target doesn't exist, and --force is not set, stop here
54 if ( $to->getId() || $this->hasOption( 'force' ) ) {
55 # Reassign the edits
56 $report = $this->hasOption( 'report' );
57 $this->doReassignEdits( $from, $to, !$this->hasOption( 'norc' ), $report );
58 # If reporting, and there were items, advise the user to run without --report
59 if ( $report ) {
60 $this->output( "Run the script again without --report to update.\n" );
61 }
62 } else {
63 $ton = $to->getName();
64 $this->error( "User '{$ton}' not found." );
65 }
66 }
67 }
68
78 private function doReassignEdits( &$from, &$to, $rc = false, $report = false ) {
80
81 $dbw = $this->getDB( DB_MASTER );
82 $this->beginTransaction( $dbw, __METHOD__ );
83
84 # Count things
85 $this->output( "Checking current edits..." );
86 $revQueryInfo = ActorMigration::newMigration()->getWhere( $dbw, 'rev_user', $from );
87 $res = $dbw->select(
88 [ 'revision' ] + $revQueryInfo['tables'],
89 'COUNT(*) AS count',
90 $revQueryInfo['conds'],
91 __METHOD__,
92 [],
93 $revQueryInfo['joins']
94 );
95 $row = $dbw->fetchObject( $res );
96 $cur = $row->count;
97 $this->output( "found {$cur}.\n" );
98
99 $this->output( "Checking deleted edits..." );
100 $arQueryInfo = ActorMigration::newMigration()->getWhere( $dbw, 'ar_user', $from, false );
101 $res = $dbw->select(
102 [ 'archive' ] + $arQueryInfo['tables'],
103 'COUNT(*) AS count',
104 $arQueryInfo['conds'],
105 __METHOD__,
106 [],
107 $arQueryInfo['joins']
108 );
109 $row = $dbw->fetchObject( $res );
110 $del = $row->count;
111 $this->output( "found {$del}.\n" );
112
113 # Don't count recent changes if we're not supposed to
114 if ( $rc ) {
115 $this->output( "Checking recent changes..." );
116 $rcQueryInfo = ActorMigration::newMigration()->getWhere( $dbw, 'rc_user', $from, false );
117 $res = $dbw->select(
118 [ 'recentchanges' ] + $rcQueryInfo['tables'],
119 'COUNT(*) AS count',
120 $rcQueryInfo['conds'],
121 __METHOD__,
122 [],
123 $rcQueryInfo['joins']
124 );
125 $row = $dbw->fetchObject( $res );
126 $rec = $row->count;
127 $this->output( "found {$rec}.\n" );
128 } else {
129 $rec = 0;
130 }
131
132 $total = $cur + $del + $rec;
133 $this->output( "\nTotal entries to change: {$total}\n" );
134
135 if ( !$report ) {
136 if ( $total ) {
137 # Reassign edits
138 $this->output( "\nReassigning current edits..." );
139 if ( $wgActorTableSchemaMigrationStage < MIGRATION_NEW ) {
140 $dbw->update(
141 'revision',
142 [
143 'rev_user' => $to->getId(),
144 'rev_user_text' =>
145 $wgActorTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH ? $to->getName() : ''
146 ],
147 $from->isLoggedIn()
148 ? [ 'rev_user' => $from->getId() ] : [ 'rev_user_text' => $from->getName() ],
149 __METHOD__
150 );
151 }
153 $dbw->update(
154 'revision_actor_temp',
155 [ 'revactor_actor' => $to->getActorId( $dbw ) ],
156 [ 'revactor_actor' => $from->getActorId() ],
157 __METHOD__
158 );
159 }
160 $this->output( "done.\nReassigning deleted edits..." );
161 $dbw->update( 'archive',
162 $this->userSpecification( $dbw, $to, 'ar_user', 'ar_user_text', 'ar_actor' ),
163 [ $arQueryInfo['conds'] ], __METHOD__ );
164 $this->output( "done.\n" );
165 # Update recent changes if required
166 if ( $rc ) {
167 $this->output( "Updating recent changes..." );
168 $dbw->update( 'recentchanges',
169 $this->userSpecification( $dbw, $to, 'rc_user', 'rc_user_text', 'rc_actor' ),
170 [ $rcQueryInfo['conds'] ], __METHOD__ );
171 $this->output( "done.\n" );
172 }
173 }
174 }
175
176 $this->commitTransaction( $dbw, __METHOD__ );
177
178 return (int)$total;
179 }
180
192 private function userSpecification( IDatabase $dbw, &$user, $idfield, $utfield, $acfield ) {
194
195 $ret = [];
197 $ret += [
198 $idfield => $user->getId(),
199 $utfield => $wgActorTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH ? $user->getName() : '',
200 ];
201 }
203 $ret += [ $acfield => $user->getActorId( $dbw ) ];
204 }
205 return $ret;
206 }
207
214 private function initialiseUser( $username ) {
215 if ( User::isIP( $username ) ) {
216 $user = new User();
217 $user->setId( 0 );
218 $user->setName( $username );
219 } else {
220 $user = User::newFromName( $username );
221 if ( !$user ) {
222 $this->fatalError( "Invalid username" );
223 }
224 }
225 $user->load();
226
227 return $user;
228 }
229}
230
231$maintClass = ReassignEdits::class;
232require_once RUN_MAINTENANCE_IF_MAIN;
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
getName()
Get the script's name.
addArg( $arg, $description, $required=true)
Add some args that are needed.
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
hasArg( $argId=0)
Does a given argument exist?
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.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Maintenance script that reassigns edits from a user or IP address to another user.
userSpecification(IDatabase $dbw, &$user, $idfield, $utfield, $acfield)
Return user specifications i.e.
execute()
Do the actual work.
__construct()
Default constructor.
initialiseUser( $username)
Initialise the user object.
doReassignEdits(&$from, &$to, $rc=false, $report=false)
Reassign edits from one user to another.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:53
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:591
static isIP( $name)
Does the string match an anonymous IP address?
Definition User.php:943
$res
Definition database.txt:21
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
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2612
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2005
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:785
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
const MIGRATION_NEW
Definition Defines.php:305
const MIGRATION_WRITE_BOTH
Definition Defines.php:303
const MIGRATION_OLD
Definition Defines.php:302
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:38
require_once RUN_MAINTENANCE_IF_MAIN
const DB_MASTER
Definition defines.php:29
$maintClass