MediaWiki  master
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  $this->getOutput()->addBacklinkSubtitle( $this->getPageTitle() );
91 
92  $status = $this->trySubmit();
93 
94  if ( $status === false || !$status->isOK() ) {
95  $this->displayForm( $status );
96  return;
97  }
98 
99  $response = $status->getValue();
100 
101  switch ( $response->status ) {
102  case AuthenticationResponse::PASS:
103  $this->success();
104  break;
105  case AuthenticationResponse::FAIL:
106  $this->displayForm( Status::newFatal( $response->message ) );
107  break;
108  default:
109  throw new LogicException( 'invalid AuthenticationResponse' );
110  }
111  }
112 
113  protected function loadAuth( $subPage, $authAction = null, $reset = false ) {
114  parent::loadAuth( $subPage, $authAction );
115  if ( $subPage ) {
116  $this->authRequests = array_filter( $this->authRequests, function ( $req ) use ( $subPage ) {
117  return $req->getUniqueId() === $subPage;
118  } );
119  if ( count( $this->authRequests ) > 1 ) {
120  throw new LogicException( 'Multiple AuthenticationRequest objects with same ID!' );
121  }
122  }
123  }
124 
125  protected function getAuthFormDescriptor( $requests, $action ) {
126  if ( !static::$loadUserData ) {
127  return [];
128  } else {
129  $descriptor = parent::getAuthFormDescriptor( $requests, $action );
130 
131  $any = false;
132  foreach ( $descriptor as &$field ) {
133  if ( $field['type'] === 'password' && $field['name'] !== 'retype' ) {
134  $any = true;
135  if ( isset( $field['cssclass'] ) ) {
136  $field['cssclass'] .= ' mw-changecredentials-validate-password';
137  } else {
138  $field['cssclass'] = 'mw-changecredentials-validate-password';
139  }
140  }
141  }
142 
143  if ( $any ) {
144  $this->getOutput()->addModules( [
145  'mediawiki.special.changecredentials.js'
146  ] );
147  }
148 
149  return $descriptor;
150  }
151  }
152 
153  protected function getAuthForm( array $requests, $action ) {
154  $form = parent::getAuthForm( $requests, $action );
155  $req = reset( $requests );
156  $info = $req->describeCredentials();
157 
158  $form->addPreText(
159  Html::openElement( 'dl' )
160  . Html::element( 'dt', [], $this->msg( 'credentialsform-provider' )->text() )
161  . Html::element( 'dd', [], $info['provider'] )
162  . Html::element( 'dt', [], $this->msg( 'credentialsform-account' )->text() )
163  . Html::element( 'dd', [], $info['account'] )
164  . Html::closeElement( 'dl' )
165  );
166 
167  // messages used: changecredentials-submit removecredentials-submit
168  $form->setSubmitTextMsg( static::$messagePrefix . '-submit' );
169  $form->showCancel()->setCancelTarget( $this->getReturnUrl() ?: Title::newMainPage() );
170 
171  return $form;
172  }
173 
174  protected function needsSubmitButton( array $requests ) {
175  // Change/remove forms show are built from a single AuthenticationRequest and do not allow
176  // for redirect flow; they always need a submit button.
177  return true;
178  }
179 
180  public function handleFormSubmit( $data ) {
181  // remove requests do not accept user input
183  if ( static::$loadUserData ) {
184  $requests = AuthenticationRequest::loadRequestsFromSubmission( $this->authRequests, $data );
185  }
186 
187  $response = $this->performAuthenticationStep( $this->authAction, $requests );
188 
189  // we can't handle FAIL or similar as failure here since it might require changing the form
190  return Status::newGood( $response );
191  }
192 
196  protected function showSubpageList( $error = null ) {
197  $out = $this->getOutput();
198 
199  if ( $error ) {
200  $out->addHTML( $error->parse() );
201  }
202 
203  $groupedRequests = [];
204  foreach ( $this->authRequests as $req ) {
205  $info = $req->describeCredentials();
206  $groupedRequests[(string)$info['provider']][] = $req;
207  }
208 
209  $linkRenderer = $this->getLinkRenderer();
210  $out->addHTML( Html::openElement( 'dl' ) );
211  foreach ( $groupedRequests as $group => $members ) {
212  $out->addHTML( Html::element( 'dt', [], $group ) );
213  foreach ( $members as $req ) {
215  $info = $req->describeCredentials();
216  $out->addHTML( Html::rawElement( 'dd', [],
217  $linkRenderer->makeLink(
218  $this->getPageTitle( $req->getUniqueId() ),
219  $info['account']
220  )
221  ) );
222  }
223  }
224  $out->addHTML( Html::closeElement( 'dl' ) );
225  }
226 
227  protected function success() {
228  $session = $this->getRequest()->getSession();
229  $user = $this->getUser();
230  $out = $this->getOutput();
231  $returnUrl = $this->getReturnUrl();
232 
233  // change user token and update the session
234  SessionManager::singleton()->invalidateSessionsForUser( $user );
235  $session->setUser( $user );
236  $session->resetId();
237 
238  if ( $returnUrl ) {
239  $out->redirect( $returnUrl );
240  } else {
241  // messages used: changecredentials-success removecredentials-success
242  $out->wrapWikiMsg( "<div class=\"successbox\">\n$1\n</div>", static::$messagePrefix
243  . '-success' );
244  $out->returnToMain();
245  }
246  }
247 
251  protected function getReturnUrl() {
252  $request = $this->getRequest();
253  $returnTo = $request->getText( 'returnto' );
254  $returnToQuery = $request->getText( 'returntoquery', '' );
255 
256  if ( !$returnTo ) {
257  return null;
258  }
259 
260  $title = Title::newFromText( $returnTo );
261  return $title->getFullUrlForRedirect( $returnToQuery );
262  }
263 
264  protected function getRequestBlacklist() {
265  return $this->getConfig()->get( 'ChangeCredentialsBlacklist' );
266  }
267 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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:822
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
A special page subclass for authentication-related special pages.
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:597
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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 use $formDescriptor instead & $formDescriptor
Definition: hooks.txt:2125
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1314
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing &#39;/&#39;...
Definition: Html.php:252
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
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:175
getOutput()
Get the OutputPage being used for this instance.
__construct( $name='ChangeCredentials')
this hook is for auditing only $response
Definition: hooks.txt:822
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
getAuthForm(array $requests, $action)
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
$params
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:310
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:304
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:973
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
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
getAuthFormDescriptor( $requests, $action)
this hook is for auditing only $req
Definition: hooks.txt:1027
displayForm( $status)
Display the form.
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.
msg( $key)
Wrapper around wfMessage that sets the current context.
performAuthenticationStep( $action, array $requests)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
string $subPage
Subpage of the special page.
static $loadUserData
Change action needs user data; remove action does not.
loadAuth( $subPage, $authAction=null, $reset=false)
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2685
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
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:244
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
string $authAction
one of the AuthManager::ACTION_* constants.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280
trySubmit()
Attempts to do an authentication step with the submitted data.