MediaWiki  1.28.0
AbstractPrimaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
24 use User;
25 
34 {
35 
36  public function continuePrimaryAuthentication( array $reqs ) {
37  throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
38  }
39 
41  }
42 
43  public function testUserCanAuthenticate( $username ) {
44  // Assume it can authenticate if it exists
45  return $this->testUserExists( $username );
46  }
47 
54  public function providerNormalizeUsername( $username ) {
56  return $name === false ? null : $name;
57  }
58 
65  $reqs = $this->getAuthenticationRequests(
66  AuthManager::ACTION_REMOVE, [ 'username' => $username ]
67  );
68  foreach ( $reqs as $req ) {
69  $req->username = $username;
70  $req->action = AuthManager::ACTION_REMOVE;
71  $this->providerChangeAuthenticationData( $req );
72  }
73  }
74 
76  return true;
77  }
78 
79  public function testForAccountCreation( $user, $creator, array $reqs ) {
80  return \StatusValue::newGood();
81  }
82 
83  public function continuePrimaryAccountCreation( $user, $creator, array $reqs ) {
84  throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
85  }
86 
88  return null;
89  }
90 
92  }
93 
94  public function testUserForCreation( $user, $autocreate, array $options = [] ) {
95  return \StatusValue::newGood();
96  }
97 
98  public function autoCreatedAccount( $user, $source ) {
99  }
100 
101  public function beginPrimaryAccountLink( $user, array $reqs ) {
102  if ( $this->accountCreationType() === self::TYPE_LINK ) {
103  throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
104  } else {
105  throw new \BadMethodCallException(
106  __METHOD__ . ' should not be called on a non-link provider.'
107  );
108  }
109  }
110 
111  public function continuePrimaryAccountLink( $user, array $reqs ) {
112  throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
113  }
114 
116  }
117 
118 }
the array() calling protocol came about after MediaWiki 1.4rc1.
$property
providerAllowsPropertyChange($property)
Determine whether a property can change.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getCanonicalName($name, $validate= 'valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid...
Definition: User.php:1046
continuePrimaryAccountLink($user, array $reqs)
Continue linking an account to an existing user.
testForAccountCreation($user, $creator, array $reqs)
Determine whether an account creation may begin.
$source
providerNormalizeUsername($username)
Normalize the username for authentication.Any two inputs that would result in the same user being aut...
testUserExists($username, $flags=User::READ_NORMAL)
Test whether the named user exists.
This is a value object to hold authentication response data.
this hook is for auditing only $response
Definition: hooks.txt:802
A primary authentication provider is responsible for associating the submitted authentication data wi...
beginPrimaryAccountLink($user, array $reqs)
Start linking an account to an existing user.
testUserCanAuthenticate($username)
Test whether the named user can authenticate with this provider.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
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:9
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 local account $user
Definition: hooks.txt:242
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:35
this hook is for auditing only $req
Definition: hooks.txt:1007
A base class that implements some of the boilerplate for a PrimaryAuthenticationProvider.
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:802
testUserForCreation($user, $autocreate, array $options=[])
Determine whether an account may be created.
A base class that implements some of the boilerplate for an AuthenticationProvider.
const ACTION_REMOVE
Remove a user's credentials.
finishAccountCreation($user, $creator, AuthenticationResponse $response)
Post-creation callback.
accountCreationType()
Fetch the account-creation type.
continuePrimaryAuthentication(array $reqs)
Continue an authentication flow.
continuePrimaryAccountCreation($user, $creator, array $reqs)
Continue an account creation flow.
getAuthenticationRequests($action, array $options)
{Return the applicable list of AuthenticationRequests.Possible values for $action depend on whether t...
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
providerRevokeAccessForUser($username)
Revoke the user's credentials.This may cause the user to no longer exist for the provider, or the user may continue to exist in a "disabled" state.The intention is that the named account will never again be usable for normal login (i.e. there is no way to undo the revocation of access).
postAccountCreation($user, $creator, AuthenticationResponse $response)
Post-creation callback.
postAuthentication($user, AuthenticationResponse $response)
Post-login callback.
postAccountLink($user, AuthenticationResponse $response)
Post-link callback.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300