maintenance/invalidateUserSessions.php

   1 <?php
   2 /**
   3  * Invalidate the sessions of certain users on the wiki.
   4  * If you want to invalidate all sessions, use $wgAuthenticationTokenVersion instead.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  */
  24
  25 use MediaWiki\Session\SessionManager;
  26
  27 require_once __DIR__ . '/Maintenance.php';
  28
  29 /**
  30  * Invalidate the sessions of certain users on the wiki.
  31  * If you want to invalidate all sessions, use $wgAuthenticationTokenVersion instead.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class InvalidateUserSessions extends Maintenance {
  36         public function __construct() {
  37                 parent::__construct();
  38                 $this->addDescription(
  39                         'Invalidate the sessions of certain users on the wiki.'
  40                 );
  41                 $this->addOption( 'user', 'Username', false, true, 'u' );
  42                 $this->addOption( 'file', 'File with one username per line', false, true, 'f' );
  43                 $this->setBatchSize( 1000 );
  44         }
  45
  46         public function execute() {
  47                 $username = $this->getOption( 'user' );
  48                 $file = $this->getOption( 'file' );
  49
  50                 if ( $username === null && $file === null ) {
  51                         $this->fatalError( 'Either --user or --file is required' );
  52                 } elseif ( $username !== null && $file !== null ) {
  53                         $this->fatalError( 'Cannot use both --user and --file' );
  54                 }
  55
  56                 if ( $username !== null ) {
  57                         $usernames = [ $username ];
  58                 } else {
  59                         $usernames = is_readable( $file ) ?
  60                                 file( $file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES ) : false;
  61                         if ( $usernames === false ) {
  62                                 $this->fatalError( "Could not open $file", 2 );
  63                         }
  64                 }
  65
  66                 $i = 0;
  67                 $sessionManager = SessionManager::singleton();
  68                 foreach ( $usernames as $username ) {
  69                         $i++;
  70                         $user = User::newFromName( $username );
  71                         try {
  72                                 $sessionManager->invalidateSessionsForUser( $user );
  73                                 if ( $user->isRegistered() ) {
  74                                         $this->output( "Invalidated sessions for user $username\n" );
  75                                 } else {
  76                                         # session invalidation might still work if there is a central identity provider
  77                                         $this->output( "Could not find user $username, tried to invalidate anyway\n" );
  78                                 }
  79                         } catch ( Exception $e ) {
  80                                 $this->output( "Failed to invalidate sessions for user $username | "
  81                                         . str_replace( [ "\r", "\n" ], ' ', $e->getMessage() ) . "\n" );
  82                         }
  83
  84                         if ( $i % $this->getBatchSize() ) {
  85                                 $this->waitForReplication();
  86                         }
  87                 }
  88         }
  89 }
  90
  91 $maintClass = InvalidateUserSessions::class;
  92 require_once RUN_MAINTENANCE_IF_MAIN;