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