(bug 40829) Show cascading protection info on action=info
[lhc/web/wiklou.git] / maintenance / reassignEdits.php
index 16f9e3f..a91abf9 100644 (file)
  * 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();
@@ -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 ) );
-       
+
                        # 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,10 +100,10 @@ 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
@@ -116,41 +123,41 @@ class ReassignEdits extends Maintenance {
                                }
                        }
                }
-       
-               $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 ) {
@@ -160,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;
@@ -169,5 +179,5 @@ class ReassignEdits extends Maintenance {
 }
 
 $maintClass = "ReassignEdits";
-require_once( DO_MAINTENANCE );
+require_once( RUN_MAINTENANCE_IF_MAIN );