MediaWiki  1.27.3
ResetPasswordSecondaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
38 
40  return [];
41  }
42 
43  public function beginSecondaryAuthentication( $user, array $reqs ) {
44  return $this->tryReset( $user, $reqs );
45  }
46 
47  public function continueSecondaryAuthentication( $user, array $reqs ) {
48  return $this->tryReset( $user, $reqs );
49  }
50 
51  public function beginSecondaryAccountCreation( $user, $creator, array $reqs ) {
52  return $this->tryReset( $user, $reqs );
53  }
54 
55  public function continueSecondaryAccountCreation( $user, $creator, array $reqs ) {
56  return $this->tryReset( $user, $reqs );
57  }
58 
64  protected function tryReset( \User $user, array $reqs ) {
65  $data = $this->manager->getAuthenticationSessionData( 'reset-pass' );
66  if ( !$data ) {
68  }
69 
70  if ( is_array( $data ) ) {
71  $data = (object)$data;
72  }
73  if ( !is_object( $data ) ) {
74  throw new \UnexpectedValueException( 'reset-pass is not valid' );
75  }
76 
77  if ( !isset( $data->msg ) ) {
78  throw new \UnexpectedValueException( 'reset-pass msg is missing' );
79  } elseif ( !$data->msg instanceof \Message ) {
80  throw new \UnexpectedValueException( 'reset-pass msg is not valid' );
81  } elseif ( !isset( $data->hard ) ) {
82  throw new \UnexpectedValueException( 'reset-pass hard is missing' );
83  } elseif ( isset( $data->req ) && (
84  !$data->req instanceof PasswordAuthenticationRequest ||
85  !array_key_exists( 'retype', $data->req->getFieldInfo() )
86  ) ) {
87  throw new \UnexpectedValueException( 'reset-pass req is not valid' );
88  }
89 
90  if ( !$data->hard ) {
92  if ( $req ) {
93  $this->manager->removeAuthenticationSessionData( 'reset-pass' );
95  }
96  }
97 
98  $needReq = isset( $data->req ) ? $data->req : new PasswordAuthenticationRequest();
99  if ( !$needReq->action ) {
100  $needReq->action = AuthManager::ACTION_CHANGE;
101  }
102  $needReq->required = $data->hard ? AuthenticationRequest::REQUIRED
104  $needReqs = [ $needReq ];
105  if ( !$data->hard ) {
106  $needReqs[] = new ButtonAuthenticationRequest(
107  'skipReset',
108  wfMessage( 'authprovider-resetpass-skip-label' ),
109  wfMessage( 'authprovider-resetpass-skip-help' )
110  );
111  }
112 
113  $req = AuthenticationRequest::getRequestByClass( $reqs, get_class( $needReq ) );
114  if ( !$req || !array_key_exists( 'retype', $req->getFieldInfo() ) ) {
115  return AuthenticationResponse::newUI( $needReqs, $data->msg );
116  }
117 
118  if ( $req->password !== $req->retype ) {
119  return AuthenticationResponse::newUI( $needReqs, new \Message( 'badretype' ) );
120  }
121 
122  $req->username = $user->getName();
123  $status = $this->manager->allowsAuthenticationDataChange( $req );
124  if ( !$status->isGood() ) {
125  return AuthenticationResponse::newUI( $needReqs, $status->getMessage() );
126  }
127  $this->manager->changeAuthenticationData( $req );
128 
129  $this->manager->removeAuthenticationSessionData( 'reset-pass' );
131  }
132 }
static getRequestByName(array $reqs, $name)
Fetch a ButtonAuthenticationRequest or subclass by name.
the array() calling protocol came about after MediaWiki 1.4rc1.
beginSecondaryAccountCreation($user, $creator, array $reqs)
Start an account creation flow.
continueSecondaryAuthentication($user, array $reqs)
Continue an authentication flow.
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2086
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:1008
static newUI(array $reqs, Message $msg)
const ACTION_CHANGE
Change a user's credentials.
Definition: AuthManager.php:60
getAuthenticationRequests($action, array $options)
Return the applicable list of AuthenticationRequests.
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 noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
const OPTIONAL
Indicates that the request is not required for authentication to proceed.
A base class that implements some of the boilerplate for a SecondaryAuthenticationProvider.
const REQUIRED
Indicates that the request is required for authentication to proceed.
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:246
This is a value object for authentication requests with a username and password.
String $action
Cache what action this request is.
Definition: MediaWiki.php:42
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:969
Reset the local password, if signalled via $this->manager->setAuthenticationSessionData() ...
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
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 $status
Definition: hooks.txt:1008
This is an authentication request that just implements a simple button.
continueSecondaryAccountCreation($user, $creator, array $reqs)
Continue an authentication flow.