MediaWiki  1.29.1
SpecialPasswordReset.php
Go to the documentation of this file.
1 <?php
25 
37  private $passwordReset = null;
38 
42  private $passwords = [];
43 
47  private $result;
48 
52  private $method;
53 
54  public function __construct() {
55  parent::__construct( 'PasswordReset', 'editmyprivateinfo' );
56  }
57 
58  private function getPasswordReset() {
59  if ( $this->passwordReset === null ) {
60  $this->passwordReset = new PasswordReset( $this->getConfig(), AuthManager::singleton() );
61  }
62  return $this->passwordReset;
63  }
64 
65  public function doesWrites() {
66  return true;
67  }
68 
69  public function userCanExecute( User $user ) {
70  return $this->getPasswordReset()->isAllowed( $user )->isGood();
71  }
72 
73  public function checkExecutePermissions( User $user ) {
74  $status = Status::wrap( $this->getPasswordReset()->isAllowed( $user ) );
75  if ( !$status->isGood() ) {
76  throw new ErrorPageError( 'internalerror', $status->getMessage() );
77  }
78 
79  parent::checkExecutePermissions( $user );
80  }
81 
82  protected function getFormFields() {
83  $resetRoutes = $this->getConfig()->get( 'PasswordResetRoutes' );
84  $a = [];
85  if ( isset( $resetRoutes['username'] ) && $resetRoutes['username'] ) {
86  $a['Username'] = [
87  'type' => 'text',
88  'label-message' => 'passwordreset-username',
89  ];
90 
91  if ( $this->getUser()->isLoggedIn() ) {
92  $a['Username']['default'] = $this->getUser()->getName();
93  }
94  }
95 
96  if ( isset( $resetRoutes['email'] ) && $resetRoutes['email'] ) {
97  $a['Email'] = [
98  'type' => 'email',
99  'label-message' => 'passwordreset-email',
100  ];
101  }
102 
103  return $a;
104  }
105 
106  protected function getDisplayFormat() {
107  return 'ooui';
108  }
109 
110  public function alterForm( HTMLForm $form ) {
111  $resetRoutes = $this->getConfig()->get( 'PasswordResetRoutes' );
112 
113  $form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
114 
115  $i = 0;
116  if ( isset( $resetRoutes['username'] ) && $resetRoutes['username'] ) {
117  $i++;
118  }
119  if ( isset( $resetRoutes['email'] ) && $resetRoutes['email'] ) {
120  $i++;
121  }
122 
123  $message = ( $i > 1 ) ? 'passwordreset-text-many' : 'passwordreset-text-one';
124 
125  $form->setHeaderText( $this->msg( $message, $i )->parseAsBlock() );
126  $form->setSubmitTextMsg( 'mailmypassword' );
127  }
128 
138  public function onSubmit( array $data ) {
139  $username = isset( $data['Username'] ) ? $data['Username'] : null;
140  $email = isset( $data['Email'] ) ? $data['Email'] : null;
141 
142  $this->method = $username ? 'username' : 'email';
143  $this->result = Status::wrap(
144  $this->getPasswordReset()->execute( $this->getUser(), $username, $email ) );
145 
146  if ( $this->result->hasMessage( 'actionthrottledtext' ) ) {
147  throw new ThrottledError;
148  }
149 
150  return $this->result;
151  }
152 
153  public function onSuccess() {
154  if ( $this->method === 'email' ) {
155  $this->getOutput()->addWikiMsg( 'passwordreset-emailsentemail' );
156  } else {
157  $this->getOutput()->addWikiMsg( 'passwordreset-emailsentusername' );
158  }
159 
160  $this->getOutput()->returnToMain();
161  }
162 
167  public function isListed() {
168  if ( $this->getPasswordReset()->isAllowed( $this->getUser() )->isGood() ) {
169  return parent::isListed();
170  }
171 
172  return false;
173  }
174 
175  protected function getGroupName() {
176  return 'users';
177  }
178 }
SpecialPasswordReset
Special page for requesting a password reset email.
Definition: SpecialPasswordReset.php:35
SpecialPasswordReset\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialPasswordReset.php:175
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
SpecialPasswordReset\isListed
isListed()
Hide the password reset page if resets are disabled.
Definition: SpecialPasswordReset.php:167
SpecialPasswordReset\$result
Status $result
Definition: SpecialPasswordReset.php:47
SpecialPasswordReset\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialPasswordReset.php:65
SpecialPasswordReset\getFormFields
getFormFields()
Get an HTMLForm descriptor array.
Definition: SpecialPasswordReset.php:82
HTMLForm\setHeaderText
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:786
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$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:246
FormSpecialPage
Special page which uses an HTMLForm to handle processing.
Definition: FormSpecialPage.php:31
SpecialPasswordReset\getDisplayFormat
getDisplayFormat()
Get display format for the form.
Definition: SpecialPasswordReset.php:106
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:35
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
SpecialPasswordReset\__construct
__construct()
Definition: SpecialPasswordReset.php:54
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
SpecialPasswordReset\onSubmit
onSubmit(array $data)
Process the form.
Definition: SpecialPasswordReset.php:138
SpecialPasswordReset\$passwordReset
PasswordReset $passwordReset
Definition: SpecialPasswordReset.php:37
Status\wrap
static wrap( $sv)
Succinct helper method to wrap a StatusValue.
Definition: Status.php:55
FormSpecialPage\execute
execute( $par)
Basic SpecialPage workflow: get a form, send it to the user; get some data back,.
Definition: FormSpecialPage.php:147
SpecialPasswordReset\$passwords
string[] $passwords
Temporary storage for the passwords which have been sent out, keyed by username.
Definition: SpecialPasswordReset.php:42
ThrottledError
Show an error when the user hits a rate limit.
Definition: ThrottledError.php:27
SpecialPasswordReset\checkExecutePermissions
checkExecutePermissions(User $user)
Called from execute() to check if the given user can perform this action.
Definition: SpecialPasswordReset.php:73
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
SpecialPasswordReset\onSuccess
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
Definition: SpecialPasswordReset.php:153
SpecialPage\msg
msg()
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:665
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:82
HTMLForm\setSubmitTextMsg
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1359
SpecialPasswordReset\userCanExecute
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
Definition: SpecialPasswordReset.php:69
HTMLForm\addHiddenFields
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:918
SpecialPasswordReset\alterForm
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Definition: SpecialPasswordReset.php:110
SpecialPasswordReset\getPasswordReset
getPasswordReset()
Definition: SpecialPasswordReset.php:58
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:783
PasswordReset
Helper class for the password reset functionality shared by the web UI and the API.
Definition: PasswordReset.php:36
SpecialPasswordReset\$method
$method
Definition: SpecialPasswordReset.php:52
array
the array() calling protocol came about after MediaWiki 1.4rc1.
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:128