[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Reassign edits from a user or IP address to another user
   4   *
   5   * This program is free software; you can redistribute it and/or modify
   6   * it under the terms of the GNU General Public License as published by
   7   * the Free Software Foundation; either version 2 of the License, or
   8   * (at your option) any later version.
   9   *
  10   * This program is distributed in the hope that it will be useful,
  11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13   * GNU General Public License for more details.
  14   *
  15   * You should have received a copy of the GNU General Public License along
  16   * with this program; if not, write to the Free Software Foundation, Inc.,
  17   * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18   * http://www.gnu.org/copyleft/gpl.html
  19   *
  20   * @file
  21   * @ingroup Maintenance
  22   * @author Rob Church <[email protected]>
  23   * @licence GNU General Public Licence 2.0 or later
  24   */
  25  
  26  require_once  __DIR__ . '/Maintenance.php';
  27  
  28  /**
  29   * Maintenance script that reassigns edits from a user or IP address
  30   * to another user.
  31   *
  32   * @ingroup Maintenance
  33   */
  34  class ReassignEdits extends Maintenance {
  35  	public function __construct() {
  36          parent::__construct();
  37          $this->mDescription = "Reassign edits from one user to another";
  38          $this->addOption( "force", "Reassign even if the target user doesn't exist" );
  39          $this->addOption( "norc", "Don't update the recent changes table" );
  40          $this->addOption( "report", "Print out details of what would be changed, but don't update it" );
  41          $this->addArg( 'from', 'Old user to take edits from' );
  42          $this->addArg( 'to', 'New user to give edits to' );
  43      }
  44  
  45  	public function execute() {
  46          if ( $this->hasArg( 0 ) && $this->hasArg( 1 ) ) {
  47              # Set up the users involved
  48              $from = $this->initialiseUser( $this->getArg( 0 ) );
  49              $to = $this->initialiseUser( $this->getArg( 1 ) );
  50  
  51              # If the target doesn't exist, and --force is not set, stop here
  52              if ( $to->getId() || $this->hasOption( 'force' ) ) {
  53                  # Reassign the edits
  54                  $report = $this->hasOption( 'report' );
  55                  $this->doReassignEdits( $from, $to, !$this->hasOption( 'norc' ), $report );
  56                  # If reporting, and there were items, advise the user to run without --report
  57                  if ( $report ) {
  58                      $this->output( "Run the script again without --report to update.\n" );
  59                  }
  60              } else {
  61                  $ton = $to->getName();
  62                  $this->error( "User '{$ton}' not found." );
  63              }
  64          }
  65      }
  66  
  67      /**
  68       * Reassign edits from one user to another
  69       *
  70       * @param User $from User to take edits from
  71       * @param User $to User to assign edits to
  72       * @param bool $rc Update the recent changes table
  73       * @param bool $report Don't change things; just echo numbers
  74       * @return int Number of entries changed, or that would be changed
  75       */
  76  	private function doReassignEdits( &$from, &$to, $rc = false, $report = false ) {
  77          $dbw = wfGetDB( DB_MASTER );
  78          $dbw->begin( __METHOD__ );
  79  
  80          # Count things
  81          $this->output( "Checking current edits..." );
  82          $res = $dbw->select(
  83              'revision',
  84              'COUNT(*) AS count',
  85              $this->userConditions( $from, 'rev_user', 'rev_user_text' ),
  86              __METHOD__
  87          );
  88          $row = $dbw->fetchObject( $res );
  89          $cur = $row->count;
  90          $this->output( "found {$cur}.\n" );
  91  
  92          $this->output( "Checking deleted edits..." );
  93          $res = $dbw->select(
  94              'archive',
  95              'COUNT(*) AS count',
  96              $this->userConditions( $from, 'ar_user', 'ar_user_text' ),
  97              __METHOD__
  98          );
  99          $row = $dbw->fetchObject( $res );
 100          $del = $row->count;
 101          $this->output( "found {$del}.\n" );
 102  
 103          # Don't count recent changes if we're not supposed to
 104          if ( $rc ) {
 105              $this->output( "Checking recent changes..." );
 106              $res = $dbw->select(
 107                  'recentchanges',
 108                  'COUNT(*) AS count',
 109                  $this->userConditions( $from, 'rc_user', 'rc_user_text' ),
 110                  __METHOD__
 111              );
 112              $row = $dbw->fetchObject( $res );
 113              $rec = $row->count;
 114              $this->output( "found {$rec}.\n" );
 115          } else {
 116              $rec = 0;
 117          }
 118  
 119          $total = $cur + $del + $rec;
 120          $this->output( "\nTotal entries to change: {$total}\n" );
 121  
 122          if ( !$report ) {
 123              if ( $total ) {
 124                  # Reassign edits
 125                  $this->output( "\nReassigning current edits..." );
 126                  $dbw->update( 'revision', $this->userSpecification( $to, 'rev_user', 'rev_user_text' ),
 127                      $this->userConditions( $from, 'rev_user', 'rev_user_text' ), __METHOD__ );
 128                  $this->output( "done.\nReassigning deleted edits..." );
 129                  $dbw->update( 'archive', $this->userSpecification( $to, 'ar_user', 'ar_user_text' ),
 130                      $this->userConditions( $from, 'ar_user', 'ar_user_text' ), __METHOD__ );
 131                  $this->output( "done.\n" );
 132                  # Update recent changes if required
 133                  if ( $rc ) {
 134                      $this->output( "Updating recent changes..." );
 135                      $dbw->update( 'recentchanges', $this->userSpecification( $to, 'rc_user', 'rc_user_text' ),
 136                          $this->userConditions( $from, 'rc_user', 'rc_user_text' ), __METHOD__ );
 137                      $this->output( "done.\n" );
 138                  }
 139              }
 140          }
 141  
 142          $dbw->commit( __METHOD__ );
 143  
 144          return (int)$total;
 145      }
 146  
 147      /**
 148       * Return the most efficient set of user conditions
 149       * i.e. a user => id mapping, or a user_text => text mapping
 150       *
 151       * @param User $user User for the condition
 152       * @param string $idfield Field name containing the identifier
 153       * @param string $utfield Field name containing the user text
 154       * @return array
 155       */
 156  	private function userConditions( &$user, $idfield, $utfield ) {
 157          return $user->getId()
 158              ? array( $idfield => $user->getId() )
 159              : array( $utfield => $user->getName() );
 160      }
 161  
 162      /**
 163       * Return user specifications
 164       * i.e. user => id, user_text => text
 165       *
 166       * @param User $user User for the spec
 167       * @param string $idfield Field name containing the identifier
 168       * @param string $utfield Field name containing the user text
 169       * @return array
 170       */
 171  	private function userSpecification( &$user, $idfield, $utfield ) {
 172          return array( $idfield => $user->getId(), $utfield => $user->getName() );
 173      }
 174  
 175      /**
 176       * Initialise the user object
 177       *
 178       * @param string $username Username or IP address
 179       * @return User
 180       */
 181  	private function initialiseUser( $username ) {
 182          if ( User::isIP( $username ) ) {
 183              $user = new User();
 184              $user->setId( 0 );
 185              $user->setName( $username );
 186          } else {
 187              $user = User::newFromName( $username );
 188              if ( !$user ) {
 189                  $this->error( "Invalid username", true );
 190              }
 191          }
 192          $user->load();
 193  
 194          return $user;
 195      }
 196  }
 197  
 198  $maintClass = "ReassignEdits";
 199  require_once RUN_MAINTENANCE_IF_MAIN;