* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
+ * @file
* @ingroup Maintenance
* @author Rob Church <robchur@gmail.com>
* @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();
- $this->mDescription = "Reassign edits from one user to another";
+ $this->addDescription( 'Reassign edits from one user to another' );
$this->addOption( "force", "Reassign even if the target user doesn't exist" );
$this->addOption( "norc", "Don't update the recent changes table" );
$this->addOption( "report", "Print out details of what would be changed, but don't update it" );
$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) ) {
+ if ( $this->hasArg( 0 ) && $this->hasArg( 1 ) ) {
# Set up the users involved
- $from = $this->initialiseUser( $this->getArg(0) );
- $to = $this->initialiseUser( $this->getArg(1) );
-
+ $from = $this->initialiseUser( $this->getArg( 0 ) );
+ $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') ) {
+ 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
- if( $report )
+ $report = $this->hasOption( '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" );
+ }
} else {
$ton = $to->getName();
$this->error( "User '{$ton}' not found." );
/**
* Reassign edits from one user to another
*
- * @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
- * @return integer Number of entries changed, or that would be changed
+ * @param User $from User to take edits from
+ * @param User $to User to assign edits to
+ * @param bool $rc Update the recent changes table
+ * @param bool $report Don't change things; just echo numbers
+ * @return int 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 = $this->getDB( DB_MASTER );
+ $this->beginTransaction( $dbw, __METHOD__ );
# Count things
$this->output( "Checking current edits..." );
- $res = $dbw->select( 'revision', 'COUNT(*) AS count', $this->userConditions( $from, 'rev_user', 'rev_user_text' ), __METHOD__ );
+ $res = $dbw->select(
+ 'revision',
+ 'COUNT(*) AS count',
+ $this->userConditions( $from, 'rev_user', 'rev_user_text' ),
+ __METHOD__
+ );
$row = $dbw->fetchObject( $res );
$cur = $row->count;
$this->output( "found {$cur}.\n" );
$this->output( "Checking deleted edits..." );
- $res = $dbw->select( 'archive', 'COUNT(*) AS count', $this->userConditions( $from, 'ar_user', 'ar_user_text' ), __METHOD__ );
+ $res = $dbw->select(
+ 'archive',
+ 'COUNT(*) AS count',
+ $this->userConditions( $from, 'ar_user', 'ar_user_text' ),
+ __METHOD__
+ );
$row = $dbw->fetchObject( $res );
$del = $row->count;
$this->output( "found {$del}.\n" );
# Don't count recent changes if we're not supposed to
- if( $rc ) {
+ if ( $rc ) {
$this->output( "Checking recent changes..." );
- $res = $dbw->select( 'recentchanges', 'COUNT(*) AS count', $this->userConditions( $from, 'rc_user', 'rc_user_text' ), __METHOD__ );
+ $res = $dbw->select(
+ 'recentchanges',
+ 'COUNT(*) AS count',
+ $this->userConditions( $from, 'rc_user', 'rc_user_text' ),
+ __METHOD__
+ );
$row = $dbw->fetchObject( $res );
$rec = $row->count;
$this->output( "found {$rec}.\n" );
} else {
$rec = 0;
}
-
+
$total = $cur + $del + $rec;
$this->output( "\nTotal entries to change: {$total}\n" );
-
- if( !$report ) {
- if( $total ) {
+
+ 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 ) {
+ if ( $rc ) {
$this->output( "Updating recent changes..." );
- $res = $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();
- return (int)$total;
+
+ $this->commitTransaction( $dbw, __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 User $user User for the condition
+ * @param string $idfield Field name containing the identifier
+ * @param string $utfield 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->getId()
+ ? [ $idfield => $user->getId() ]
+ : [ $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 User $user User for the spec
+ * @param string $idfield Field name containing the identifier
+ * @param string $utfield Field name containing the user text
* @return array
*/
private function userSpecification( &$user, $idfield, $utfield ) {
- return array( $idfield => $user->getId(), $utfield => $user->getName() );
+ return [ $idfield => $user->getId(), $utfield => $user->getName() ];
}
-
+
/**
* Initialise the user object
*
- * @param $username Username or IP address
+ * @param string $username Username or IP address
* @return User
*/
private function initialiseUser( $username ) {
- if( User::isIP( $username ) ) {
+ if ( User::isIP( $username ) ) {
$user = new User();
$user->setId( 0 );
$user->setName( $username );
} else {
$user = User::newFromName( $username );
+ if ( !$user ) {
+ $this->error( "Invalid username", true );
+ }
}
$user->load();
+
return $user;
}
-
-
}
$maintClass = "ReassignEdits";
-require_once( DO_MAINTENANCE );
-
+require_once RUN_MAINTENANCE_IF_MAIN;
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff