X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=maintenance%2FreassignEdits.php;h=a91abf93d3347cde5fbdb9e94da5b0ea31a6fa24;hb=71c0d39d12f140eb49757c991e063daec34b000f;hp=721605c81be7272d2f03f296eebfd97523c86221;hpb=10ecfeb03b223b22db1966c2967f2a405aa59723;p=lhc%2Fweb%2Fwiklou.git diff --git a/maintenance/reassignEdits.php b/maintenance/reassignEdits.php index 721605c81b..7e15c09eb8 100644 --- a/maintenance/reassignEdits.php +++ b/maintenance/reassignEdits.php @@ -17,13 +17,20 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html * + * @file * @ingroup Maintenance * @author Rob Church * @licence GNU General Public Licence 2.0 or later */ -require_once( dirname( __FILE__ ) . '/Maintenance.php' ); +require_once __DIR__ . '/Maintenance.php'; +/** + * Maintenance script that reassigns edits from a user or IP address + * to another user. + * + * @ingroup Maintenance + */ class ReassignEdits extends Maintenance { public function __construct() { parent::__construct(); @@ -34,19 +41,19 @@ class ReassignEdits extends Maintenance { $this->addArg( 'from', 'Old user to take edits from' ); $this->addArg( 'to', 'New user to give edits to' ); } - + public function execute() { if ( $this->hasArg( 0 ) && $this->hasArg( 1 ) ) { # Set up the users involved $from = $this->initialiseUser( $this->getArg( 0 ) ); - $to = $this->initialiseUser( $this->getArg( 1 ) ); - + $to = $this->initialiseUser( $this->getArg( 1 ) ); + # If the target doesn't exist, and --force is not set, stop here if ( $to->getId() || $this->hasOption( 'force' ) ) { # Reassign the edits $report = $this->hasOption( 'report' ); - $count = $this->doReassignEdits( $from, $to, !$this->hasOption( 'norc' ), $report ); - # If reporting, and there were items, advise the user to run without --report + $this->doReassignEdits( $from, $to, !$this->hasOption( 'norc' ), $report ); + # If reporting, and there were items, advise the user to run without --report if ( $report ) { $this->output( "Run the script again without --report to update.\n" ); } @@ -62,13 +69,13 @@ class ReassignEdits extends Maintenance { * * @param $from User to take edits from * @param $to User to assign edits to - * @param $rc Update the recent changes table - * @param $report Don't change things; just echo numbers + * @param $rc bool Update the recent changes table + * @param $report bool Don't change things; just echo numbers * @return integer Number of entries changed, or that would be changed */ private function doReassignEdits( &$from, &$to, $rc = false, $report = false ) { $dbw = wfGetDB( DB_MASTER ); - $dbw->begin(); + $dbw->begin( __METHOD__ ); # Count things $this->output( "Checking current edits..." ); @@ -93,61 +100,64 @@ class ReassignEdits extends Maintenance { } else { $rec = 0; } - + $total = $cur + $del + $rec; $this->output( "\nTotal entries to change: {$total}\n" ); - + if ( !$report ) { if ( $total ) { # Reassign edits $this->output( "\nReassigning current edits..." ); - $res = $dbw->update( 'revision', $this->userSpecification( $to, 'rev_user', 'rev_user_text' ), $this->userConditions( $from, 'rev_user', 'rev_user_text' ), __METHOD__ ); + $dbw->update( 'revision', $this->userSpecification( $to, 'rev_user', 'rev_user_text' ), + $this->userConditions( $from, 'rev_user', 'rev_user_text' ), __METHOD__ ); $this->output( "done.\nReassigning deleted edits..." ); - $res = $dbw->update( 'archive', $this->userSpecification( $to, 'ar_user', 'ar_user_text' ), $this->userConditions( $from, 'ar_user', 'ar_user_text' ), __METHOD__ ); + $dbw->update( 'archive', $this->userSpecification( $to, 'ar_user', 'ar_user_text' ), + $this->userConditions( $from, 'ar_user', 'ar_user_text' ), __METHOD__ ); $this->output( "done.\n" ); # Update recent changes if required if ( $rc ) { $this->output( "Updating recent changes..." ); - $dbw->update( 'recentchanges', $this->userSpecification( $to, 'rc_user', 'rc_user_text' ), $this->userConditions( $from, 'rc_user', 'rc_user_text' ), __METHOD__ ); + $dbw->update( 'recentchanges', $this->userSpecification( $to, 'rc_user', 'rc_user_text' ), + $this->userConditions( $from, 'rc_user', 'rc_user_text' ), __METHOD__ ); $this->output( "done.\n" ); } } } - - $dbw->commit(); + + $dbw->commit( __METHOD__ ); return (int)$total; } - + /** * Return the most efficient set of user conditions * i.e. a user => id mapping, or a user_text => text mapping * * @param $user User for the condition - * @param $idfield Field name containing the identifier - * @param $utfield Field name containing the user text + * @param $idfield string Field name containing the identifier + * @param $utfield string Field name containing the user text * @return array */ private function userConditions( &$user, $idfield, $utfield ) { return $user->getId() ? array( $idfield => $user->getId() ) : array( $utfield => $user->getName() ); } - + /** * Return user specifications * i.e. user => id, user_text => text * * @param $user User for the spec - * @param $idfield Field name containing the identifier - * @param $utfield Field name containing the user text + * @param $idfield string Field name containing the identifier + * @param $utfield string Field name containing the user text * @return array */ private function userSpecification( &$user, $idfield, $utfield ) { return array( $idfield => $user->getId(), $utfield => $user->getName() ); } - + /** * Initialise the user object * - * @param $username Username or IP address + * @param $username string Username or IP address * @return User */ private function initialiseUser( $username ) { @@ -157,6 +167,9 @@ class ReassignEdits extends Maintenance { $user->setName( $username ); } else { $user = User::newFromName( $username ); + if ( !$user ) { + $this->error( "Invalid username", true ); + } } $user->load(); return $user; @@ -166,5 +179,4 @@ class ReassignEdits extends Maintenance { } $maintClass = "ReassignEdits"; -require_once( DO_MAINTENANCE ); - +require_once RUN_MAINTENANCE_IF_MAIN;