MediaWiki master
ExpireTemporaryAccounts Class Reference

Expire temporary accounts that are registered for longer than expiryAfterDays days (defined in $wgAutoCreateTempUser) by forcefully logging them out. More...

Inherits Maintenance.

Collaboration diagram for ExpireTemporaryAccounts:

Public Member Functions

 __construct ()
 Default constructor.
 
 execute ()
 Do the actual work.All child classes will need to implement this
Returns
bool|null|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

 
- Public Member Functions inherited from Maintenance
 canExecuteWithoutLocalSettings ()
 Whether this script can run without LocalSettings.php.
 
 checkRequiredExtensions ()
 Verify that the required extensions are installed.
 
 cleanupChanneled ()
 Clean up channeled output.
 
 clearParamsAndArgs ()
 Clear all params and arguments.
 
 finalSetup (SettingsBuilder $settingsBuilder)
 Handle some last-minute setup here.
 
 getConfig ()
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 
 getName ()
 Get the script's name.
 
 getParameters ()
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments when running as a child script.
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments.
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts.
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support.
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records.
 
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script.
 
 setArg ( $argId, $value)
 Programmatically set the value of the given argument.
 
 setConfig (Config $config)
 
 setDB (IMaintainableDatabase $db)
 Sets database object to be returned by getDB().
 
 setDBProvider (IConnectionProvider $dbProvider)
 
 setName (string $name)
 
 setOption (string $name, $value)
 Programmatically set the value of the given option.
 
 setup ()
 Provides subclasses with an opportunity to perform initial checks.
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.
 

Protected Member Functions

 expireTemporaryAccount (UserIdentity $tempAccountUserIdentity)
 Expire a temporary account.
 
 getTempAccountsToExpireQueryBuilder (int $registeredBeforeUnix, int $frequencyDays)
 Return a SelectQueryBuilder that returns temp accounts to invalidate.
 
 initServices ()
 Construct services the script needs to use.
 
 queryBuilderToUserIdentities (SelectQueryBuilder $queryBuilder)
 Convert a SelectQueryBuilder into a list of user identities.
 
 verboseLog (string $log)
 If –verbose is passed, log to output.
 
- Protected Member Functions inherited from Maintenance
 addArg ( $arg, $description, $required=true, $multi=false)
 Add some args that are needed.
 
 addDefaultParams ()
 Add the default parameters to the scripts.
 
 addDescription ( $text)
 Set the description text.
 
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script.
 
 afterFinalSetup ()
 Override to perform any required operation at the end of initialisation.
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transaction on a DB.
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transaction on a DB handle and wait for replica DBs to catch up.
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.
 
 deleteOption ( $name)
 Remove an option.
 
 error ( $err, $die=0)
 Throw an error to the user.
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script.
 
 getArg ( $argId=0, $default=null)
 Get an argument.
 
 getArgs ( $offset=0)
 Get arguments.
 
 getBatchSize ()
 Returns batch size.
 
 getDB ( $db, $groups=[], $dbDomain=false)
 Returns a database to be used by current maintenance script.
 
 getDir ()
 Get the maintenance directory.
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 
 getHookRunner ()
 Get a HookRunner for running core hooks.
 
 getOption ( $name, $default=null)
 Get an option, or return the default.
 
 getPrimaryDB ()
 
 getReplicaDB ()
 
 getServiceContainer ()
 Returns the main service container.
 
 getStdin ( $len=null)
 Return input from stdin.
 
 hasArg ( $argId=0)
 Does a given argument exist?
 
 hasOption ( $name)
 Checks to see if a particular option was set.
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts.
 
 maybeHelp ( $force=false)
 Maybe show the help.
 
 output ( $out, $channel=null)
 Throw some output to the user.
 
 parseIntList ( $text)
 Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs).
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run.
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transaction on a DB handle.
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.
 
 setBatchSize ( $s=0)
 
 showHelp ()
 Definitely show the help.
 
 supportsOption ( $name)
 Checks to see if a particular option in supported.
 
 validateUserOption ( $errorMsg)
 
 waitForReplication ()
 Wait for replica DBs to catch up.
 

Protected Attributes

AuthManager $authManager
 
TempUserConfig $tempUserConfig
 
UserFactory $userFactory
 
UserIdentityLookup $userIdentityLookup
 
UserIdentityUtils $userIdentityUtils
 
- Protected Attributes inherited from Maintenance
array $mArgs = []
 This is the list of arguments that were actually passed.
 
int null $mBatchSize = null
 Batch size.
 
string $mDbPass = null
 
string $mDbUser = null
 
string $mDescription = ''
 A description of the script, children should change this via addDescription()
 
bool $mInputLoaded = false
 Have we already loaded our user input?
 
array $mOptions = []
 This is the list of options that were actually passed.
 
array[] $mParams = []
 Empty.
 
bool $mQuiet = false
 Special vars for params that are always used.
 
string null $mSelf
 Name of the script currently running.
 
MaintenanceParameters $parameters
 

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static getTermSize ()
 Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows).
 
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes.
 
static readconsole ( $prompt='> ')
 Prompt the console for input.
 
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory.
 
- Public Attributes inherited from Maintenance
resource null $fileHandle
 Used when creating separate schema files.
 
array $orderedOptions = []
 Used to read the options in the order they were passed.
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type.
 
const DB_STD = 1
 
const GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'
 
const SCRIPT_DEPENDENT_PARAMETERS = 'Common options'
 
const STDIN_ALL = -1
 

Detailed Description

Expire temporary accounts that are registered for longer than expiryAfterDays days (defined in $wgAutoCreateTempUser) by forcefully logging them out.

Extensions can extend this class to provide their own logic of determining a list of temporary accounts to expire.

Stability: stable
to extend
Since
1.42

Definition at line 26 of file expireTemporaryAccounts.php.

Constructor & Destructor Documentation

◆ __construct()

ExpireTemporaryAccounts::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stability: stable
to call

Reimplemented from Maintenance.

Definition at line 34 of file expireTemporaryAccounts.php.

References Maintenance\addDescription(), and Maintenance\addOption().

Member Function Documentation

◆ execute()

ExpireTemporaryAccounts::execute ( )

Do the actual work.All child classes will need to implement this

Returns
bool|null|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

Reimplemented from Maintenance.

Definition at line 148 of file expireTemporaryAccounts.php.

References wfTimestamp().

◆ expireTemporaryAccount()

ExpireTemporaryAccounts::expireTemporaryAccount ( UserIdentity $tempAccountUserIdentity)
protected

Expire a temporary account.

Default implementation calls AuthManager::revokeAccessForUser and SessionManager::invalidateSessionsForUser.

Stability: stable
to override
Parameters
UserIdentity$tempAccountUserIdentity

Definition at line 138 of file expireTemporaryAccounts.php.

◆ getTempAccountsToExpireQueryBuilder()

ExpireTemporaryAccounts::getTempAccountsToExpireQueryBuilder ( int $registeredBeforeUnix,
int $frequencyDays )
protected

Return a SelectQueryBuilder that returns temp accounts to invalidate.

This method should return temporary accounts that registered before $registeredBeforeUnix. To avoid returning an ever-growing set of accounts, the method should skip users that were supposedly invalidated by a previous script run (script runs each $frequencyDays days).

If you override this method, you probably also want to override queryBuilderToUserIdentities().

Stability: stable
to override
Parameters
int$registeredBeforeUnixCutoff Unix timestamp
int$frequencyDaysScript runs each $frequencyDays days
Returns
SelectQueryBuilder

Definition at line 90 of file expireTemporaryAccounts.php.

◆ initServices()

ExpireTemporaryAccounts::initServices ( )
protected

Construct services the script needs to use.

Stability: stable
to override

Definition at line 53 of file expireTemporaryAccounts.php.

◆ queryBuilderToUserIdentities()

ExpireTemporaryAccounts::queryBuilderToUserIdentities ( SelectQueryBuilder $queryBuilder)
protected

Convert a SelectQueryBuilder into a list of user identities.

Default implementation expects $queryBuilder is an instance of UserSelectQueryBuilder. If you override getTempAccountsToExpireQueryBuilder() to work with a different query builder, this method should be overriden to properly convert the query builder into user identities.

Exceptions
LogicExceptionif $queryBuilder is not UserSelectQueryBuilder
Stability: stable
to override
Parameters
SelectQueryBuilder$queryBuilder
Returns
Iterator<UserIdentity>

Definition at line 118 of file expireTemporaryAccounts.php.

◆ verboseLog()

ExpireTemporaryAccounts::verboseLog ( string $log)
protected

If –verbose is passed, log to output.

Parameters
string$log
Returns
void

Definition at line 69 of file expireTemporaryAccounts.php.

Member Data Documentation

◆ $authManager

AuthManager ExpireTemporaryAccounts::$authManager
protected

Definition at line 30 of file expireTemporaryAccounts.php.

◆ $tempUserConfig

TempUserConfig ExpireTemporaryAccounts::$tempUserConfig
protected

Definition at line 31 of file expireTemporaryAccounts.php.

◆ $userFactory

UserFactory ExpireTemporaryAccounts::$userFactory
protected

Definition at line 29 of file expireTemporaryAccounts.php.

◆ $userIdentityLookup

UserIdentityLookup ExpireTemporaryAccounts::$userIdentityLookup
protected

Definition at line 28 of file expireTemporaryAccounts.php.

◆ $userIdentityUtils

UserIdentityUtils ExpireTemporaryAccounts::$userIdentityUtils
protected

Definition at line 32 of file expireTemporaryAccounts.php.


The documentation for this class was generated from the following file: