Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
100.00% |
33 / 33 |
|
100.00% |
2 / 2 |
CRAP | |
100.00% |
1 / 1 |
| InvalidateUserSessions | |
100.00% |
33 / 33 |
|
100.00% |
2 / 2 |
13 | |
100.00% |
1 / 1 |
| __construct | |
100.00% |
7 / 7 |
|
100.00% |
1 / 1 |
1 | |||
| execute | |
100.00% |
26 / 26 |
|
100.00% |
1 / 1 |
12 | |||
| 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\Maintenance\Maintenance; |
| 26 | use MediaWiki\Session\SessionManager; |
| 27 | use MediaWiki\User\User; |
| 28 | |
| 29 | // @codeCoverageIgnoreStart |
| 30 | require_once __DIR__ . '/Maintenance.php'; |
| 31 | // @codeCoverageIgnoreEnd |
| 32 | |
| 33 | /** |
| 34 | * Invalidate the sessions of certain users on the wiki. |
| 35 | * If you want to invalidate all sessions, use $wgAuthenticationTokenVersion instead. |
| 36 | * |
| 37 | * @ingroup Maintenance |
| 38 | */ |
| 39 | class InvalidateUserSessions extends Maintenance { |
| 40 | public function __construct() { |
| 41 | parent::__construct(); |
| 42 | $this->addDescription( |
| 43 | 'Invalidate the sessions of certain users on the wiki.' |
| 44 | ); |
| 45 | $this->addOption( 'user', 'Username', false, true, 'u' ); |
| 46 | $this->addOption( 'file', 'File with one username per line', false, true, 'f' ); |
| 47 | $this->setBatchSize( 1000 ); |
| 48 | } |
| 49 | |
| 50 | public function execute() { |
| 51 | $username = $this->getOption( 'user' ); |
| 52 | $file = $this->getOption( 'file' ); |
| 53 | |
| 54 | if ( $username === null && $file === null ) { |
| 55 | $this->fatalError( 'Either --user or --file is required' ); |
| 56 | } elseif ( $username !== null && $file !== null ) { |
| 57 | $this->fatalError( 'Cannot use both --user and --file' ); |
| 58 | } |
| 59 | |
| 60 | if ( $username !== null ) { |
| 61 | $usernames = [ $username ]; |
| 62 | } else { |
| 63 | $usernames = is_readable( $file ) ? |
| 64 | file( $file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES ) : false; |
| 65 | if ( $usernames === false ) { |
| 66 | $this->fatalError( "Could not open $file", 2 ); |
| 67 | } |
| 68 | } |
| 69 | |
| 70 | $i = 0; |
| 71 | $sessionManager = SessionManager::singleton(); |
| 72 | foreach ( $usernames as $username ) { |
| 73 | $i++; |
| 74 | $user = User::newFromName( $username ); |
| 75 | try { |
| 76 | $sessionManager->invalidateSessionsForUser( $user ); |
| 77 | if ( $user->isRegistered() ) { |
| 78 | $this->output( "Invalidated sessions for user $username\n" ); |
| 79 | } else { |
| 80 | # session invalidation might still work if there is a central identity provider |
| 81 | $this->output( "Could not find user $username, tried to invalidate anyway\n" ); |
| 82 | } |
| 83 | } catch ( Exception $e ) { |
| 84 | $this->output( "Failed to invalidate sessions for user $username | " |
| 85 | . str_replace( [ "\r", "\n" ], ' ', $e->getMessage() ) . "\n" ); |
| 86 | } |
| 87 | |
| 88 | if ( $i % $this->getBatchSize() ) { |
| 89 | $this->waitForReplication(); |
| 90 | } |
| 91 | } |
| 92 | } |
| 93 | } |
| 94 | |
| 95 | // @codeCoverageIgnoreStart |
| 96 | $maintClass = InvalidateUserSessions::class; |
| 97 | require_once RUN_MAINTENANCE_IF_MAIN; |
| 98 | // @codeCoverageIgnoreEnd |