MediaWiki  master
TemporaryPasswordPrimaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
24 use User;
25 
39 {
41  protected $emailEnabled = null;
42 
44  protected $newPasswordExpiry = null;
45 
47  protected $passwordReminderResendTime = null;
48 
56  public function __construct( $params = [] ) {
57  parent::__construct( $params );
58 
59  if ( isset( $params['emailEnabled'] ) ) {
60  $this->emailEnabled = (bool)$params['emailEnabled'];
61  }
62  if ( isset( $params['newPasswordExpiry'] ) ) {
63  $this->newPasswordExpiry = (int)$params['newPasswordExpiry'];
64  }
65  if ( isset( $params['passwordReminderResendTime'] ) ) {
66  $this->passwordReminderResendTime = $params['passwordReminderResendTime'];
67  }
68  }
69 
70  public function setConfig( \Config $config ) {
71  parent::setConfig( $config );
72 
73  if ( $this->emailEnabled === null ) {
74  $this->emailEnabled = $this->config->get( 'EnableEmail' );
75  }
76  if ( $this->newPasswordExpiry === null ) {
77  $this->newPasswordExpiry = $this->config->get( 'NewPasswordExpiry' );
78  }
79  if ( $this->passwordReminderResendTime === null ) {
80  $this->passwordReminderResendTime = $this->config->get( 'PasswordReminderResendTime' );
81  }
82  }
83 
84  protected function getPasswordResetData( $username, $data ) {
85  // Always reset
86  return (object)[
87  'msg' => wfMessage( 'resetpass-temp-emailed' ),
88  'hard' => true,
89  ];
90  }
91 
93  switch ( $action ) {
95  return [ new PasswordAuthenticationRequest() ];
96 
99 
101  if ( isset( $options['username'] ) && $this->emailEnabled ) {
102  // Creating an account for someone else
104  } else {
105  // It's not terribly likely that an anonymous user will
106  // be creating an account for someone else.
107  return [];
108  }
109 
112 
113  default:
114  return [];
115  }
116  }
117 
118  public function beginPrimaryAuthentication( array $reqs ) {
120  if ( !$req || $req->username === null || $req->password === null ) {
122  }
123 
124  $username = User::getCanonicalName( $req->username, 'usable' );
125  if ( $username === false ) {
127  }
128 
129  $dbr = wfGetDB( DB_REPLICA );
130  $row = $dbr->selectRow(
131  'user',
132  [
133  'user_id', 'user_newpassword', 'user_newpass_time',
134  ],
135  [ 'user_name' => $username ],
136  __METHOD__
137  );
138  if ( !$row ) {
140  }
141 
142  $status = $this->checkPasswordValidity( $username, $req->password );
143  if ( !$status->isOK() ) {
144  // Fatal, can't log in
145  return AuthenticationResponse::newFail( $status->getMessage() );
146  }
147 
148  $pwhash = $this->getPassword( $row->user_newpassword );
149  if ( !$pwhash->equals( $req->password ) ) {
150  return $this->failResponse( $req );
151  }
152 
153  if ( !$this->isTimestampValid( $row->user_newpass_time ) ) {
154  return $this->failResponse( $req );
155  }
156 
157  // Add an extra log entry since a temporary password is
158  // an unusual way to log in, so its important to keep track
159  // of in case of abuse.
160  $this->logger->info( "{user} successfully logged in using temp password",
161  [
162  'user' => $username,
163  'requestIP' => $this->manager->getRequest()->getIP()
164  ]
165  );
166 
168 
170  }
171 
172  public function testUserCanAuthenticate( $username ) {
174  if ( $username === false ) {
175  return false;
176  }
177 
178  $dbr = wfGetDB( DB_REPLICA );
179  $row = $dbr->selectRow(
180  'user',
181  [ 'user_newpassword', 'user_newpass_time' ],
182  [ 'user_name' => $username ],
183  __METHOD__
184  );
185  if ( !$row ) {
186  return false;
187  }
188 
189  if ( $this->getPassword( $row->user_newpassword ) instanceof \InvalidPassword ) {
190  return false;
191  }
192 
193  if ( !$this->isTimestampValid( $row->user_newpass_time ) ) {
194  return false;
195  }
196 
197  return true;
198  }
199 
200  public function testUserExists( $username, $flags = User::READ_NORMAL ) {
202  if ( $username === false ) {
203  return false;
204  }
205 
207  return (bool)wfGetDB( $db )->selectField(
208  [ 'user' ],
209  [ 'user_id' ],
210  [ 'user_name' => $username ],
211  __METHOD__,
212  $options
213  );
214  }
215 
217  AuthenticationRequest $req, $checkData = true
218  ) {
219  if ( get_class( $req ) !== TemporaryPasswordAuthenticationRequest::class ) {
220  // We don't really ignore it, but this is what the caller expects.
221  return \StatusValue::newGood( 'ignored' );
222  }
223 
224  if ( !$checkData ) {
225  return \StatusValue::newGood();
226  }
227 
228  $username = User::getCanonicalName( $req->username, 'usable' );
229  if ( $username === false ) {
230  return \StatusValue::newGood( 'ignored' );
231  }
232 
233  $row = wfGetDB( DB_MASTER )->selectRow(
234  'user',
235  [ 'user_id', 'user_newpass_time' ],
236  [ 'user_name' => $username ],
237  __METHOD__
238  );
239 
240  if ( !$row ) {
241  return \StatusValue::newGood( 'ignored' );
242  }
243 
244  $sv = \StatusValue::newGood();
245  if ( $req->password !== null ) {
246  $sv->merge( $this->checkPasswordValidity( $username, $req->password ) );
247 
248  if ( $req->mailpassword ) {
249  if ( !$this->emailEnabled ) {
250  return \StatusValue::newFatal( 'passwordreset-emaildisabled' );
251  }
252 
253  // We don't check whether the user has an email address;
254  // that information should not be exposed to the caller.
255 
256  // do not allow temporary password creation within
257  // $wgPasswordReminderResendTime from the last attempt
258  if (
259  $this->passwordReminderResendTime
260  && $row->user_newpass_time
261  && time() < wfTimestamp( TS_UNIX, $row->user_newpass_time )
262  + $this->passwordReminderResendTime * 3600
263  ) {
264  // Round the time in hours to 3 d.p., in case someone is specifying
265  // minutes or seconds.
266  return \StatusValue::newFatal( 'throttled-mailpassword',
267  round( $this->passwordReminderResendTime, 3 ) );
268  }
269 
270  if ( !$req->caller ) {
271  return \StatusValue::newFatal( 'passwordreset-nocaller' );
272  }
273  if ( !\IP::isValid( $req->caller ) ) {
274  $caller = User::newFromName( $req->caller );
275  if ( !$caller ) {
276  return \StatusValue::newFatal( 'passwordreset-nosuchcaller', $req->caller );
277  }
278  }
279  }
280  }
281  return $sv;
282  }
283 
285  $username = $req->username !== null ? User::getCanonicalName( $req->username, 'usable' ) : false;
286  if ( $username === false ) {
287  return;
288  }
289 
290  $dbw = wfGetDB( DB_MASTER );
291 
292  $sendMail = false;
293  if ( $req->action !== AuthManager::ACTION_REMOVE &&
295  ) {
296  $pwhash = $this->getPasswordFactory()->newFromPlaintext( $req->password );
297  $newpassTime = $dbw->timestamp();
298  $sendMail = $req->mailpassword;
299  } else {
300  // Invalidate the temporary password when any other auth is reset, or when removing
301  $pwhash = $this->getPasswordFactory()->newFromCiphertext( null );
302  $newpassTime = null;
303  }
304 
305  $dbw->update(
306  'user',
307  [
308  'user_newpassword' => $pwhash->toString(),
309  'user_newpass_time' => $newpassTime,
310  ],
311  [ 'user_name' => $username ],
312  __METHOD__
313  );
314 
315  if ( $sendMail ) {
316  // Send email after DB commit
317  $dbw->onTransactionCommitOrIdle(
318  function () use ( $req ) {
320  $this->sendPasswordResetEmail( $req );
321  },
322  __METHOD__
323  );
324  }
325  }
326 
327  public function accountCreationType() {
328  return self::TYPE_CREATE;
329  }
330 
331  public function testForAccountCreation( $user, $creator, array $reqs ) {
335  );
336 
338  if ( $req ) {
339  if ( $req->mailpassword ) {
340  if ( !$this->emailEnabled ) {
341  $ret->merge( \StatusValue::newFatal( 'emaildisabled' ) );
342  } elseif ( !$user->getEmail() ) {
343  $ret->merge( \StatusValue::newFatal( 'noemailcreate' ) );
344  }
345  }
346 
347  $ret->merge(
348  $this->checkPasswordValidity( $user->getName(), $req->password )
349  );
350  }
351  return $ret;
352  }
353 
354  public function beginPrimaryAccountCreation( $user, $creator, array $reqs ) {
358  );
359  if ( $req ) {
360  if ( $req->username !== null && $req->password !== null ) {
361  // Nothing we can do yet, because the user isn't in the DB yet
362  if ( $req->username !== $user->getName() ) {
363  $req = clone $req;
364  $req->username = $user->getName();
365  }
366 
367  if ( $req->mailpassword ) {
368  // prevent EmailNotificationSecondaryAuthenticationProvider from sending another mail
369  $this->manager->setAuthenticationSessionData( 'no-email', true );
370  }
371 
373  $ret->createRequest = $req;
374  return $ret;
375  }
376  }
378  }
379 
380  public function finishAccountCreation( $user, $creator, AuthenticationResponse $res ) {
382  $req = $res->createRequest;
383  $mailpassword = $req->mailpassword;
384  $req->mailpassword = false; // providerChangeAuthenticationData would send the wrong email
385 
386  // Now that the user is in the DB, set the password on it.
388 
389  if ( $mailpassword ) {
390  // Send email after DB commit
391  wfGetDB( DB_MASTER )->onTransactionCommitOrIdle(
392  function () use ( $user, $creator, $req ) {
393  $this->sendNewAccountEmail( $user, $creator, $req->password );
394  },
395  __METHOD__
396  );
397  }
398 
399  return $mailpassword ? 'byemail' : null;
400  }
401 
407  protected function isTimestampValid( $timestamp ) {
408  $time = wfTimestampOrNull( TS_MW, $timestamp );
409  if ( $time !== null ) {
410  $expiry = wfTimestamp( TS_UNIX, $time ) + $this->newPasswordExpiry;
411  if ( time() >= $expiry ) {
412  return false;
413  }
414  }
415  return true;
416  }
417 
425  protected function sendNewAccountEmail( User $user, User $creatingUser, $password ) {
426  $ip = $creatingUser->getRequest()->getIP();
427  // @codeCoverageIgnoreStart
428  if ( !$ip ) {
429  return \Status::newFatal( 'badipaddress' );
430  }
431  // @codeCoverageIgnoreEnd
432 
433  \Hooks::run( 'User::mailPasswordInternal', [ &$creatingUser, &$ip, &$user ] );
434 
435  $mainPageUrl = \Title::newMainPage()->getCanonicalURL();
436  $userLanguage = $user->getOption( 'language' );
437  $subjectMessage = wfMessage( 'createaccount-title' )->inLanguage( $userLanguage );
438  $bodyMessage = wfMessage( 'createaccount-text', $ip, $user->getName(), $password,
439  '<' . $mainPageUrl . '>', round( $this->newPasswordExpiry / 86400 ) )
440  ->inLanguage( $userLanguage );
441 
442  $status = $user->sendMail( $subjectMessage->text(), $bodyMessage->text() );
443 
444  // TODO show 'mailerror' message on error, 'accmailtext' success message otherwise?
445  // @codeCoverageIgnoreStart
446  if ( !$status->isGood() ) {
447  $this->logger->warning( 'Could not send account creation email: ' .
448  $status->getWikiText( false, false, 'en' ) );
449  }
450  // @codeCoverageIgnoreEnd
451 
452  return $status;
453  }
454 
460  $user = User::newFromName( $req->username );
461  if ( !$user ) {
462  return \Status::newFatal( 'noname' );
463  }
464  $userLanguage = $user->getOption( 'language' );
465  $callerIsAnon = \IP::isValid( $req->caller );
466  $callerName = $callerIsAnon ? $req->caller : User::newFromName( $req->caller )->getName();
467  $passwordMessage = wfMessage( 'passwordreset-emailelement', $user->getName(),
468  $req->password )->inLanguage( $userLanguage );
469  $emailMessage = wfMessage( $callerIsAnon ? 'passwordreset-emailtext-ip'
470  : 'passwordreset-emailtext-user' )->inLanguage( $userLanguage );
471  $emailMessage->params( $callerName, $passwordMessage->text(), 1,
472  '<' . \Title::newMainPage()->getCanonicalURL() . '>',
473  round( $this->newPasswordExpiry / 86400 ) );
474  $emailTitle = wfMessage( 'passwordreset-emailtitle' )->inLanguage( $userLanguage );
475  return $user->sendMail( $emailTitle->text(), $emailMessage->text() );
476  }
477 }
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))
checkPasswordValidity( $username, $password)
Check that the password is valid.
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
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:597
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 & $ret
Definition: hooks.txt:1996
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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:1277
getOption( $oname, $defaultOverride=null, $ignoreHidden=false)
Get the user&#39;s current setting for a given option.
Definition: User.php:3184
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
sendMail( $subject, $body, $from=null, $replyto=null)
Send an e-mail to this user&#39;s account.
Definition: User.php:4748
Represents an invalid password hash.
string $action
Cache what action this request is.
Definition: MediaWiki.php:48
This is a value object to hold authentication response data.
sendNewAccountEmail(User $user, User $creatingUser, $password)
Send an email about the new account creation and the temporary password.
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
finishAccountCreation( $user, $creator, AuthenticationResponse $res)
Post-creation callback.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1813
const DB_MASTER
Definition: defines.php:26
static getDBOptions( $bitfield)
Get an appropriate DB index, options, and fallback DB index for a query.
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2469
setPasswordResetFlag( $username, Status $status, $data=null)
Check if the password should be reset.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid...
Definition: User.php:1233
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
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 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 unset offset - wrap String Wrap the message in html(usually something like "&lt
testUserExists( $username, $flags=User::READ_NORMAL)
Test whether the named user exists.
Interface for configuration instances.
Definition: Config.php:28
$res
Definition: database.txt:21
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
static isValid( $ip)
Validate an IP address.
Definition: IP.php:111
const ACTION_CHANGE
Change a user&#39;s credentials.
A primary authentication provider that uses the temporary password field in the &#39;user&#39; table...
$params
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 & $options
Definition: hooks.txt:1996
Basic framework for a primary authentication provider that uses passwords.
This represents the intention to set a temporary password for the user.
This is a value object for authentication requests with a username and password.
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
getRequest()
Get the WebRequest object to use with this object.
Definition: User.php:3916
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:990
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
static newRandom()
Return an instance with a new, random password.
const ACTION_REMOVE
Remove a user&#39;s credentials.
beginPrimaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
const ACTION_CREATE
Create a new user.
Definition: AuthManager.php:90
const DB_REPLICA
Definition: defines.php:25
failResponse(PasswordAuthenticationRequest $req)
Return the appropriate response for failure.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:585
const ACTION_LOGIN
Log in with an existing (not necessarily local) user.
Definition: AuthManager.php:85
isTimestampValid( $timestamp)
Check that a temporary password is still valid (hasn&#39;t expired).
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487
This is a value object for authentication requests.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200