rdbms: reduce LoadBalancer replication log spam
[lhc/web/wiklou.git] / maintenance / resetUserTokens.php
index 9847ccc..284db2c 100644 (file)
@@ -30,13 +30,22 @@ require_once __DIR__ . '/Maintenance.php';
  * Maintenance script to reset the user_token for all users on the wiki.
  *
  * @ingroup Maintenance
+ * @deprecated since 1.27, use $wgAuthenticationTokenVersion instead.
  */
 class ResetUserTokens extends Maintenance {
        public function __construct() {
                parent::__construct();
-               $this->mDescription = "Reset the user_token of all users on the wiki. Note that this may log some of them out.";
+               $this->addDescription(
+                       "Reset the user_token of all users on the wiki. Note that this may log some of them out.\n"
+                       . "Deprecated, use \$wgAuthenticationTokenVersion instead."
+               );
                $this->addOption( 'nowarn', "Hides the 5 seconds warning", false, false );
-               $this->addOption( 'nulls', 'Only reset tokens that are currently null (string of \x00\'s)', false, false );
+               $this->addOption(
+                       'nulls',
+                       'Only reset tokens that are currently null (string of \x00\'s)',
+                       false,
+                       false
+               );
                $this->setBatchSize( 1000 );
        }
 
@@ -45,39 +54,41 @@ class ResetUserTokens extends Maintenance {
 
                if ( !$this->getOption( 'nowarn' ) ) {
                        if ( $this->nullsOnly ) {
-                               $this->output( "The script is about to reset the user_token for USERS WITH NULL TOKENS in the database.\n" );
+                               $this->output( "The script is about to reset the user_token "
+                                       . "for USERS WITH NULL TOKENS in the database.\n" );
                        } else {
                                $this->output( "The script is about to reset the user_token for ALL USERS in the database.\n" );
                                $this->output( "This may log some of them out and is not necessary unless you believe your\n" );
                                $this->output( "user table has been compromised.\n" );
                        }
                        $this->output( "\n" );
-                       $this->output( "Abort with control-c in the next five seconds (skip this countdown with --nowarn) ... " );
-                       wfCountDown( 5 );
+                       $this->output( "Abort with control-c in the next five seconds "
+                               . "(skip this countdown with --nowarn) ... " );
+                       $this->countDown( 5 );
                }
 
-               // We list user by user_id from one of the slave database
-               $dbr = wfGetDB( DB_SLAVE );
+               // We list user by user_id from one of the replica DBs
+               $dbr = $this->getDB( DB_REPLICA );
 
-               $where = array();
+               $where = [];
                if ( $this->nullsOnly ) {
                        // Have to build this by hand, because \ is escaped in helper functions
-                       $where = array( 'user_token = \'' . str_repeat( '\0', 32) . '\'' );
+                       $where = [ 'user_token = \'' . str_repeat( '\0', 32 ) . '\'' ];
                }
 
-               $maxid = $dbr->selectField( 'user', 'MAX(user_id)', array(), __METHOD__ );
+               $maxid = $dbr->selectField( 'user', 'MAX(user_id)', [], __METHOD__ );
 
                $min = 0;
-               $max = $this->mBatchSize;
+               $max = $this->getBatchSize();
 
                do {
                        $result = $dbr->select( 'user',
-                               array( 'user_id' ),
+                               [ 'user_id' ],
                                array_merge(
                                        $where,
-                                       array( 'user_id > ' . $dbr->addQuotes( $min ),
+                                       [ 'user_id > ' . $dbr->addQuotes( $min ),
                                                'user_id <= ' . $dbr->addQuotes( $max )
-                                       )
+                                       ]
                                ),
                                __METHOD__
                        );
@@ -87,12 +98,10 @@ class ResetUserTokens extends Maintenance {
                        }
 
                        $min = $max;
-                       $max = $min + $this->mBatchSize;
+                       $max = $min + $this->getBatchSize();
 
                        wfWaitForSlaves();
-
                } while ( $min <= $maxid );
-
        }
 
        private function updateUser( $userid ) {
@@ -106,5 +115,5 @@ class ResetUserTokens extends Maintenance {
        }
 }
 
-$maintClass = "ResetUserTokens";
+$maintClass = ResetUserTokens::class;
 require_once RUN_MAINTENANCE_IF_MAIN;