MediaWiki  1.28.1
SpecialChangeCredentials.php
Go to the documentation of this file.
1 <?php
2 
7 
14  protected static $allowedActions = [ AuthManager::ACTION_CHANGE ];
15 
16  protected static $messagePrefix = 'changecredentials';
17 
19  protected static $loadUserData = true;
20 
21  public function __construct( $name = 'ChangeCredentials' ) {
22  parent::__construct( $name, 'editmyprivateinfo' );
23  }
24 
25  protected function getGroupName() {
26  return 'users';
27  }
28 
29  public function isListed() {
30  $this->loadAuth( '' );
31  return (bool)$this->authRequests;
32  }
33 
34  public function doesWrites() {
35  return true;
36  }
37 
38  protected function getDefaultAction( $subPage ) {
39  return AuthManager::ACTION_CHANGE;
40  }
41 
42  protected function getPreservedParams( $withToken = false ) {
43  $request = $this->getRequest();
44  $params = parent::getPreservedParams( $withToken );
45  $params += [
46  'returnto' => $request->getVal( 'returnto' ),
47  'returntoquery' => $request->getVal( 'returntoquery' ),
48  ];
49  return $params;
50  }
51 
52  public function onAuthChangeFormFields(
53  array $requests, array $fieldInfo, array &$formDescriptor, $action
54  ) {
55  // This method is never called for remove actions.
56 
57  $extraFields = [];
58  Hooks::run( 'ChangePasswordForm', [ &$extraFields ], '1.27' );
59  foreach ( $extraFields as $extra ) {
60  list( $name, $label, $type, $default ) = $extra;
61  $formDescriptor[$name] = [
62  'type' => $type,
63  'name' => $name,
64  'label-message' => $label,
65  'default' => $default,
66  ];
67 
68  }
69 
70  return parent::onAuthChangeFormFields( $requests, $fieldInfo, $formDescriptor, $action );
71  }
72 
73  public function execute( $subPage ) {
74  $this->setHeaders();
75  $this->outputHeader();
76 
77  $this->loadAuth( $subPage );
78 
79  if ( !$subPage ) {
80  $this->showSubpageList();
81  return;
82  }
83 
84  if ( !$this->authRequests ) {
85  // messages used: changecredentials-invalidsubpage, removecredentials-invalidsubpage
86  $this->showSubpageList( $this->msg( static::$messagePrefix . '-invalidsubpage', $subPage ) );
87  return;
88  }
89 
90  $status = $this->trySubmit();
91 
92  if ( $status === false || !$status->isOK() ) {
93  $this->displayForm( $status );
94  return;
95  }
96 
97  $response = $status->getValue();
98 
99  switch ( $response->status ) {
100  case AuthenticationResponse::PASS:
101  $this->success();
102  break;
103  case AuthenticationResponse::FAIL:
104  $this->displayForm( Status::newFatal( $response->message ) );
105  break;
106  default:
107  throw new LogicException( 'invalid AuthenticationResponse' );
108  }
109  }
110 
111  protected function loadAuth( $subPage, $authAction = null, $reset = false ) {
112  parent::loadAuth( $subPage, $authAction );
113  if ( $subPage ) {
114  $this->authRequests = array_filter( $this->authRequests, function ( $req ) use ( $subPage ) {
115  return $req->getUniqueId() === $subPage;
116  } );
117  if ( count( $this->authRequests ) > 1 ) {
118  throw new LogicException( 'Multiple AuthenticationRequest objects with same ID!' );
119  }
120  }
121  }
122 
123  protected function getAuthFormDescriptor( $requests, $action ) {
124  if ( !static::$loadUserData ) {
125  return [];
126  } else {
127  return parent::getAuthFormDescriptor( $requests, $action );
128  }
129  }
130 
131  protected function getAuthForm( array $requests, $action ) {
132  $form = parent::getAuthForm( $requests, $action );
133  $req = reset( $requests );
134  $info = $req->describeCredentials();
135 
136  $form->addPreText(
137  Html::openElement( 'dl' )
138  . Html::element( 'dt', [], wfMessage( 'credentialsform-provider' ) )
139  . Html::element( 'dd', [], $info['provider'] )
140  . Html::element( 'dt', [], wfMessage( 'credentialsform-account' ) )
141  . Html::element( 'dd', [], $info['account'] )
142  . Html::closeElement( 'dl' )
143  );
144 
145  // messages used: changecredentials-submit removecredentials-submit
146  $form->setSubmitTextMsg( static::$messagePrefix . '-submit' );
147  $form->showCancel()->setCancelTarget( $this->getReturnUrl() ?: Title::newMainPage() );
148 
149  return $form;
150  }
151 
152  protected function needsSubmitButton( array $requests ) {
153  // Change/remove forms show are built from a single AuthenticationRequest and do not allow
154  // for redirect flow; they always need a submit button.
155  return true;
156  }
157 
158  public function handleFormSubmit( $data ) {
159  // remove requests do not accept user input
161  if ( static::$loadUserData ) {
162  $requests = AuthenticationRequest::loadRequestsFromSubmission( $this->authRequests, $data );
163  }
164 
165  $response = $this->performAuthenticationStep( $this->authAction, $requests );
166 
167  // we can't handle FAIL or similar as failure here since it might require changing the form
168  return Status::newGood( $response );
169  }
170 
174  protected function showSubpageList( $error = null ) {
175  $out = $this->getOutput();
176 
177  if ( $error ) {
178  $out->addHTML( $error->parse() );
179  }
180 
181  $groupedRequests = [];
182  foreach ( $this->authRequests as $req ) {
183  $info = $req->describeCredentials();
184  $groupedRequests[(string)$info['provider']][] = $req;
185  }
186 
187  $linkRenderer = $this->getLinkRenderer();
188  $out->addHTML( Html::openElement( 'dl' ) );
189  foreach ( $groupedRequests as $group => $members ) {
190  $out->addHTML( Html::element( 'dt', [], $group ) );
191  foreach ( $members as $req ) {
193  $info = $req->describeCredentials();
194  $out->addHTML( Html::rawElement( 'dd', [],
195  $linkRenderer->makeLink(
196  $this->getPageTitle( $req->getUniqueId() ),
197  $info['account']
198  )
199  ) );
200  }
201  }
202  $out->addHTML( Html::closeElement( 'dl' ) );
203  }
204 
205  protected function success() {
206  $session = $this->getRequest()->getSession();
207  $user = $this->getUser();
208  $out = $this->getOutput();
209  $returnUrl = $this->getReturnUrl();
210 
211  // change user token and update the session
212  SessionManager::singleton()->invalidateSessionsForUser( $user );
213  $session->setUser( $user );
214  $session->resetId();
215 
216  if ( $returnUrl ) {
217  $out->redirect( $returnUrl );
218  } else {
219  // messages used: changecredentials-success removecredentials-success
220  $out->wrapWikiMsg( "<div class=\"successbox\">\n$1\n</div>", static::$messagePrefix
221  . '-success' );
222  $out->returnToMain();
223  }
224  }
225 
229  protected function getReturnUrl() {
230  $request = $this->getRequest();
231  $returnTo = $request->getText( 'returnto' );
232  $returnToQuery = $request->getText( 'returntoquery', '' );
233 
234  if ( !$returnTo ) {
235  return null;
236  }
237 
239  return $title->getFullUrlForRedirect( $returnToQuery );
240  }
241 
242  protected function getRequestBlacklist() {
243  return $this->getConfig()->get( 'ChangeCredentialsBlacklist' );
244  }
245 }
static closeElement($element)
Returns "".
Definition: Html.php:305
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:802
the array() calling protocol came about after MediaWiki 1.4rc1.
A special page subclass for authentication-related special pages.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string & $returnToQuery
Definition: hooks.txt:2491
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:556
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:177
msg()
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
this hook is for auditing only $response
Definition: hooks.txt:802
displayForm($status)
Display the form.
outputHeader($summaryMessageKey= '')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getAuthForm(array $requests, $action)
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:247
getAuthFormDescriptor($requests, $action)
either a unescaped string or a HtmlArmor object 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
$params
performAuthenticationStep($action, array $requests)
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks hooks can tweak the array to change how login etc forms should look $requests
Definition: hooks.txt:302
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
loadAuth($subPage, $authAction=null, $reset=false)
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
AuthenticationRequest[] $authRequests
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
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
Special change to change credentials (such as the password).
getUser()
Shortcut to get the User executing this instance.
getConfig()
Shortcut to get main config object.
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:1046
__construct($name= 'ChangeCredentials')
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect & $returnTo
Definition: hooks.txt:2491
string $subPage
Subpage of the special page.
static $loadUserData
Change action needs user data; remove action does not.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
string $authAction
one of the AuthManager::ACTION_* constants.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300
trySubmit()
Attempts to do an authentication step with the submitted data.