0a2b654e55
Why: There are extensions that need to check a handful of users for temp-ness at once (such as GrowthExperiments). This is not really possible as of now (it would be necessary to call UserIdentityUtils::isTemp several times, which can get slow for large bulks of users). What: Add TempUserConfig::getMatchPattern() that can be used to generate a LIKE database condition. While at it, this patch also adds named() and temp() to UserSelectQueryBuilder. Bug: T341389 Change-Id: I90b5c59462c5c98bf5dcf9fa15d20553ef6599a5
134 lines
3.3 KiB
PHP
134 lines
3.3 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\User\TempUser;
|
|
|
|
use BadMethodCallException;
|
|
use MediaWiki\Permissions\Authority;
|
|
|
|
/**
|
|
* The real TempUserConfig including internal methods used by TempUserCreator.
|
|
*
|
|
* @since 1.39
|
|
*/
|
|
class RealTempUserConfig implements TempUserConfig {
|
|
/** @var bool */
|
|
private $enabled = false;
|
|
|
|
/** @var array */
|
|
private $serialProviderConfig = [];
|
|
|
|
/** @var array */
|
|
private $serialMappingConfig = [];
|
|
|
|
/** @var string[] */
|
|
private $autoCreateActions;
|
|
|
|
/** @var Pattern|null */
|
|
private $genPattern;
|
|
|
|
/** @var Pattern|null */
|
|
private $matchPattern;
|
|
|
|
/** @var Pattern|null */
|
|
private $reservedPattern;
|
|
|
|
/**
|
|
* @param array $config See the documentation of $wgAutoCreateTempUser.
|
|
* - enabled: bool
|
|
* - actions: array
|
|
* - genPattern: string
|
|
* - matchPattern: string, optional
|
|
* - reservedPattern: string, optional
|
|
* - serialProvider: array
|
|
* - serialMapping: array
|
|
*/
|
|
public function __construct( $config ) {
|
|
if ( $config['enabled'] ?? false ) {
|
|
$this->enabled = true;
|
|
$this->autoCreateActions = $config['actions'];
|
|
$this->genPattern = new Pattern( 'genPattern', $config['genPattern'] );
|
|
if ( isset( $config['matchPattern'] ) ) {
|
|
$this->matchPattern = new Pattern( 'matchPattern', $config['matchPattern'] );
|
|
} else {
|
|
$this->matchPattern = $this->genPattern;
|
|
}
|
|
$this->serialProviderConfig = $config['serialProvider'];
|
|
$this->serialMappingConfig = $config['serialMapping'];
|
|
}
|
|
if ( isset( $config['reservedPattern'] ) ) {
|
|
$this->reservedPattern = new Pattern( 'reservedPattern', $config['reservedPattern'] );
|
|
}
|
|
}
|
|
|
|
public function isEnabled() {
|
|
return $this->enabled;
|
|
}
|
|
|
|
public function isAutoCreateAction( string $action ) {
|
|
if ( $action === 'create' ) {
|
|
$action = 'edit';
|
|
}
|
|
return $this->enabled
|
|
&& in_array( $action, $this->autoCreateActions, true );
|
|
}
|
|
|
|
public function shouldAutoCreate( Authority $authority, string $action ) {
|
|
return $this->isAutoCreateAction( $action )
|
|
&& !$authority->isRegistered()
|
|
&& $authority->isAllowed( 'createaccount' );
|
|
}
|
|
|
|
public function isTempName( string $name ) {
|
|
return $this->enabled
|
|
&& $this->matchPattern->isMatch( $name );
|
|
}
|
|
|
|
public function isReservedName( string $name ) {
|
|
return ( $this->enabled && $this->matchPattern->isMatch( $name ) )
|
|
|| ( $this->reservedPattern && $this->reservedPattern->isMatch( $name ) );
|
|
}
|
|
|
|
public function getPlaceholderName(): string {
|
|
if ( $this->enabled ) {
|
|
return $this->genPattern->generate( '*' );
|
|
} else {
|
|
throw new BadMethodCallException( __METHOD__ . ' is disabled' );
|
|
}
|
|
}
|
|
|
|
public function getMatchPattern(): Pattern {
|
|
if ( $this->enabled ) {
|
|
return $this->matchPattern;
|
|
} else {
|
|
throw new BadMethodCallException( __METHOD__ . ' is disabled' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @internal For TempUserCreator only
|
|
* @return Pattern
|
|
*/
|
|
public function getGeneratorPattern(): Pattern {
|
|
if ( $this->enabled ) {
|
|
return $this->genPattern;
|
|
} else {
|
|
throw new BadMethodCallException( __METHOD__ . ' is disabled' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @internal For TempUserCreator only
|
|
* @return array
|
|
*/
|
|
public function getSerialProviderConfig(): array {
|
|
return $this->serialProviderConfig;
|
|
}
|
|
|
|
/**
|
|
* @internal For TempUserCreator only
|
|
* @return array
|
|
*/
|
|
public function getSerialMappingConfig(): array {
|
|
return $this->serialMappingConfig;
|
|
}
|
|
}
|