MediaWiki  REL1_31
CheckBlocksSecondaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
24 use Config;
26 
34 
36  protected $blockDisablesLogin = null;
37 
43  public function __construct( $params = [] ) {
44  if ( isset( $params['blockDisablesLogin'] ) ) {
45  $this->blockDisablesLogin = (bool)$params['blockDisablesLogin'];
46  }
47  }
48 
49  public function setConfig( Config $config ) {
50  parent::setConfig( $config );
51 
52  if ( $this->blockDisablesLogin === null ) {
53  $this->blockDisablesLogin = $this->config->get( 'BlockDisablesLogin' );
54  }
55  }
56 
58  return [];
59  }
60 
61  public function beginSecondaryAuthentication( $user, array $reqs ) {
62  if ( !$this->blockDisablesLogin ) {
64  } elseif ( $user->isBlocked() ) {
66  new \Message( 'login-userblocked', [ $user->getName() ] )
67  );
68  } else {
70  }
71  }
72 
73  public function beginSecondaryAccountCreation( $user, $creator, array $reqs ) {
75  }
76 
77  public function testUserForCreation( $user, $autocreate, array $options = [] ) {
78  $block = $user->isBlockedFromCreateAccount();
79  if ( $block ) {
80  if ( $block->mReason ) {
81  $reason = $block->mReason;
82  } else {
83  $msg = \Message::newFromKey( 'blockednoreason' );
84  if ( !\RequestContext::getMain()->getUser()->isSafeToLoad() ) {
85  $msg->inContentLanguage();
86  }
87  $reason = $msg->text();
88  }
89 
90  $errorParams = [
91  $block->getTarget(),
92  $reason,
93  $block->getByName()
94  ];
95 
96  if ( $block->getType() === \Block::TYPE_RANGE ) {
97  $errorMessage = 'cantcreateaccount-range-text';
98  $errorParams[] = $this->manager->getRequest()->getIP();
99  } else {
100  $errorMessage = 'cantcreateaccount-text';
101  }
102 
103  return StatusValue::newFatal(
104  new \Message( $errorMessage, $errorParams )
105  );
106  } else {
107  return StatusValue::newGood();
108  }
109  }
110 
111 }
$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
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\testUserForCreation
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
Definition: CheckBlocksSecondaryAuthenticationProvider.php:77
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
Check if the user is blocked, and prevent authentication if so.
Definition: CheckBlocksSecondaryAuthenticationProvider.php:33
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
MediaWiki\$action
String $action
Cache what action this request is.
Definition: MediaWiki.php:48
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWiki\Auth\AbstractSecondaryAuthenticationProvider
A base class that implements some of the boilerplate for a SecondaryAuthenticationProvider.
Definition: AbstractSecondaryAuthenticationProvider.php:32
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Block\TYPE_RANGE
const TYPE_RANGE
Definition: Block.php:85
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\$blockDisablesLogin
bool $blockDisablesLogin
Definition: CheckBlocksSecondaryAuthenticationProvider.php:36
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\__construct
__construct( $params=[])
Definition: CheckBlocksSecondaryAuthenticationProvider.php:43
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
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\setConfig
setConfig(Config $config)
Set configuration.
Definition: CheckBlocksSecondaryAuthenticationProvider.php:49
MediaWiki\Auth\AuthenticationResponse\newAbstain
static newAbstain()
Definition: AuthenticationResponse.php:170
Config
Interface for configuration instances.
Definition: Config.php:28
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
MediaWiki\Auth\AuthenticationResponse\newFail
static newFail(Message $msg)
Definition: AuthenticationResponse.php:146
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\beginSecondaryAccountCreation
beginSecondaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
Definition: CheckBlocksSecondaryAuthenticationProvider.php:73
Message
The Message class provides methods which fulfil two basic services:
Definition: Message.php:159
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\beginSecondaryAuthentication
beginSecondaryAuthentication( $user, array $reqs)
Start an authentication flow.
Definition: CheckBlocksSecondaryAuthenticationProvider.php:61
MediaWiki\Auth
Definition: AbstractAuthenticationProvider.php:22
Message\newFromKey
static newFromKey( $key)
Factory function that is just wrapper for the real constructor.
Definition: Message.php:395
MediaWiki\Auth\AuthenticationResponse\newPass
static newPass( $username=null)
Definition: AuthenticationResponse.php:134
MediaWiki\Auth\AbstractAuthenticationProvider\$config
Config $config
Definition: AbstractAuthenticationProvider.php:38
MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\getAuthenticationRequests
getAuthenticationRequests( $action, array $options)
Return the applicable list of AuthenticationRequests.
Definition: CheckBlocksSecondaryAuthenticationProvider.php:57