MediaWiki  REL1_33
reassignEdits.php
Go to the documentation of this file.
1 <?php
27 
28 require_once __DIR__ . '/Maintenance.php';
29 
36 class ReassignEdits extends Maintenance {
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 & SCHEMA_COMPAT_WRITE_OLD ) {
140  $dbw->update(
141  'revision',
142  [
143  'rev_user' => $to->getId(),
144  'rev_user_text' => $to->getName(),
145  ],
146  $from->isLoggedIn()
147  ? [ 'rev_user' => $from->getId() ] : [ 'rev_user_text' => $from->getName() ],
148  __METHOD__
149  );
150  }
152  $dbw->update(
153  'revision_actor_temp',
154  [ 'revactor_actor' => $to->getActorId( $dbw ) ],
155  [ 'revactor_actor' => $from->getActorId() ],
156  __METHOD__
157  );
158  }
159  $this->output( "done.\nReassigning deleted edits..." );
160  $dbw->update( 'archive',
161  $this->userSpecification( $dbw, $to, 'ar_user', 'ar_user_text', 'ar_actor' ),
162  [ $arQueryInfo['conds'] ], __METHOD__ );
163  $this->output( "done.\n" );
164  # Update recent changes if required
165  if ( $rc ) {
166  $this->output( "Updating recent changes..." );
167  $dbw->update( 'recentchanges',
168  $this->userSpecification( $dbw, $to, 'rc_user', 'rc_user_text', 'rc_actor' ),
169  [ $rcQueryInfo['conds'] ], __METHOD__ );
170  $this->output( "done.\n" );
171  }
172  }
173  }
174 
175  $this->commitTransaction( $dbw, __METHOD__ );
176 
177  return (int)$total;
178  }
179 
191  private function userSpecification( IDatabase $dbw, &$user, $idfield, $utfield, $acfield ) {
193 
194  $ret = [];
196  $ret += [
197  $idfield => $user->getId(),
198  $utfield => $user->getName(),
199  ];
200  }
202  $ret += [ $acfield => $user->getActorId( $dbw ) ];
203  }
204  return $ret;
205  }
206 
213  private function initialiseUser( $username ) {
214  if ( User::isIP( $username ) ) {
215  $user = new User();
216  $user->setId( 0 );
217  $user->setName( $username );
218  } else {
220  if ( !$user ) {
221  $this->fatalError( "Invalid username" );
222  }
223  }
224  $user->load();
225 
226  return $user;
227  }
228 }
229 
231 require_once RUN_MAINTENANCE_IF_MAIN;
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1510
ReassignEdits
Maintenance script that reassigns edits from a user or IP address to another user.
Definition: reassignEdits.php:36
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:485
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:329
$ret
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:2003
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:585
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition: Maintenance.php:338
ReassignEdits\doReassignEdits
doReassignEdits(&$from, &$to, $rc=false, $report=false)
Reassign edits from one user to another.
Definition: reassignEdits.php:78
$res
$res
Definition: database.txt:21
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
User
User
Definition: All_system_messages.txt:425
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:111
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
ReassignEdits\initialiseUser
initialiseUser( $username)
Initialise the user object.
Definition: reassignEdits.php:213
ReassignEdits\__construct
__construct()
Default constructor.
Definition: reassignEdits.php:37
Maintenance\beginTransaction
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
Definition: Maintenance.php:1399
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:248
User\isIP
static isIP( $name)
Does the string match an anonymous IP address?
Definition: User.php:967
ReassignEdits\userSpecification
userSpecification(IDatabase $dbw, &$user, $idfield, $utfield, $acfield)
Return user specifications for an UPDATE i.e.
Definition: reassignEdits.php:191
DB_MASTER
const DB_MASTER
Definition: defines.php:26
$maintClass
$maintClass
Definition: reassignEdits.php:230
SCHEMA_COMPAT_WRITE_OLD
const SCHEMA_COMPAT_WRITE_OLD
Definition: Defines.php:293
SCHEMA_COMPAT_WRITE_NEW
const SCHEMA_COMPAT_WRITE_NEW
Definition: Defines.php:295
Maintenance\commitTransaction
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
Definition: Maintenance.php:1414
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:300
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1373
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:782
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:462
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:434
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option exists.
Definition: Maintenance.php:269
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:352
ReassignEdits\execute
execute()
Do the actual work.
Definition: reassignEdits.php:47
$wgActorTableSchemaMigrationStage
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
Definition: DefaultSettings.php:8982