MediaWiki  REL1_31
invalidateUserSessions.php
Go to the documentation of this file.
1 <?php
27 
28 require_once __DIR__ . '/Maintenance.php';
29 
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  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
69  $sessionManager = SessionManager::singleton();
70  foreach ( $usernames as $username ) {
71  $i++;
73  try {
74  $sessionManager->invalidateSessionsForUser( $user );
75  if ( $user->getId() ) {
76  $this->output( "Invalidated sessions for user $username\n" );
77  } else {
78  # session invalidation might still work if there is a central identity provider
79  $this->output( "Could not find user $username, tried to invalidate anyway\n" );
80  }
81  } catch ( Exception $e ) {
82  $this->output( "Failed to invalidate sessions for user $username | "
83  . str_replace( [ "\r", "\n" ], ' ', $e->getMessage() ) . "\n" );
84  }
85 
86  if ( $i % $this->getBatchSize() ) {
87  $lbFactory->waitForReplication();
88  }
89  }
90  }
91 }
92 
94 require_once RUN_MAINTENANCE_IF_MAIN;
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
InvalidateUserSesssions
Invalidate the sessions of certain users on the wiki.
Definition: invalidateUserSessions.php:36
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
InvalidateUserSesssions\__construct
__construct()
Default constructor.
Definition: invalidateUserSessions.php:37
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:106
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
MediaWiki\Session\SessionManager
This serves as the entry point to the MediaWiki session handling system.
Definition: SessionManager.php:50
$maintClass
$maintClass
Definition: invalidateUserSessions.php:93
InvalidateUserSesssions\execute
execute()
Do the actual work.
Definition: invalidateUserSessions.php:47
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
Maintenance\getBatchSize
getBatchSize()
Returns batch size.
Definition: Maintenance.php:321
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
Maintenance\setBatchSize
setBatchSize( $s=0)
Set the batch size.
Definition: Maintenance.php:329
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171