MediaWiki  master
BotPassword.php
Go to the documentation of this file.
1 <?php
25 
30 class BotPassword implements IDBAccessObject {
31 
32  const APPID_MAXLENGTH = 32;
33 
35  private $isSaved;
36 
38  private $centralId;
39 
41  private $appId;
42 
44  private $token;
45 
47  private $restrictions;
48 
50  private $grants;
51 
53  private $flags = self::READ_NORMAL;
54 
60  protected function __construct( $row, $isSaved, $flags = self::READ_NORMAL ) {
61  $this->isSaved = $isSaved;
62  $this->flags = $flags;
63 
64  $this->centralId = (int)$row->bp_user;
65  $this->appId = $row->bp_app_id;
66  $this->token = $row->bp_token;
67  $this->restrictions = MWRestrictions::newFromJson( $row->bp_restrictions );
68  $this->grants = FormatJson::decode( $row->bp_grants );
69  }
70 
76  public static function getDB( $db ) {
78 
79  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
80  $lb = $wgBotPasswordsCluster
81  ? $lbFactory->getExternalLB( $wgBotPasswordsCluster )
82  : $lbFactory->getMainLB( $wgBotPasswordsDatabase );
83  return $lb->getConnectionRef( $db, [], $wgBotPasswordsDatabase );
84  }
85 
93  public static function newFromUser( User $user, $appId, $flags = self::READ_NORMAL ) {
94  $centralId = CentralIdLookup::factory()->centralIdFromLocalUser(
96  );
97  return $centralId ? self::newFromCentralId( $centralId, $appId, $flags ) : null;
98  }
99 
107  public static function newFromCentralId( $centralId, $appId, $flags = self::READ_NORMAL ) {
108  global $wgEnableBotPasswords;
109 
110  if ( !$wgEnableBotPasswords ) {
111  return null;
112  }
113 
115  $db = self::getDB( $index );
116  $row = $db->selectRow(
117  'bot_passwords',
118  [ 'bp_user', 'bp_app_id', 'bp_token', 'bp_restrictions', 'bp_grants' ],
119  [ 'bp_user' => $centralId, 'bp_app_id' => $appId ],
120  __METHOD__,
121  $options
122  );
123  return $row ? new self( $row, true, $flags ) : null;
124  }
125 
138  public static function newUnsaved( array $data, $flags = self::READ_NORMAL ) {
139  $row = (object)[
140  'bp_user' => 0,
141  'bp_app_id' => isset( $data['appId'] ) ? trim( $data['appId'] ) : '',
142  'bp_token' => '**unsaved**',
143  'bp_restrictions' => $data['restrictions'] ?? MWRestrictions::newDefault(),
144  'bp_grants' => $data['grants'] ?? [],
145  ];
146 
147  if (
148  $row->bp_app_id === '' || strlen( $row->bp_app_id ) > self::APPID_MAXLENGTH ||
149  !$row->bp_restrictions instanceof MWRestrictions ||
150  !is_array( $row->bp_grants )
151  ) {
152  return null;
153  }
154 
155  $row->bp_restrictions = $row->bp_restrictions->toJson();
156  $row->bp_grants = FormatJson::encode( $row->bp_grants );
157 
158  if ( isset( $data['user'] ) ) {
159  if ( !$data['user'] instanceof User ) {
160  return null;
161  }
162  $row->bp_user = CentralIdLookup::factory()->centralIdFromLocalUser(
163  $data['user'], CentralIdLookup::AUDIENCE_RAW, $flags
164  );
165  } elseif ( isset( $data['username'] ) ) {
166  $row->bp_user = CentralIdLookup::factory()->centralIdFromName(
167  $data['username'], CentralIdLookup::AUDIENCE_RAW, $flags
168  );
169  } elseif ( isset( $data['centralId'] ) ) {
170  $row->bp_user = $data['centralId'];
171  }
172  if ( !$row->bp_user ) {
173  return null;
174  }
175 
176  return new self( $row, false, $flags );
177  }
178 
183  public function isSaved() {
184  return $this->isSaved;
185  }
186 
191  public function getUserCentralId() {
192  return $this->centralId;
193  }
194 
199  public function getAppId() {
200  return $this->appId;
201  }
202 
207  public function getToken() {
208  return $this->token;
209  }
210 
215  public function getRestrictions() {
216  return $this->restrictions;
217  }
218 
223  public function getGrants() {
224  return $this->grants;
225  }
226 
231  public static function getSeparator() {
234  }
235 
240  protected function getPassword() {
241  list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $this->flags );
242  $db = self::getDB( $index );
243  $password = $db->selectField(
244  'bot_passwords',
245  'bp_password',
246  [ 'bp_user' => $this->centralId, 'bp_app_id' => $this->appId ],
247  __METHOD__,
248  $options
249  );
250  if ( $password === false ) {
252  }
253 
254  $passwordFactory = MediaWikiServices::getInstance()->getPasswordFactory();
255  try {
256  return $passwordFactory->newFromCiphertext( $password );
257  } catch ( PasswordError $ex ) {
259  }
260  }
261 
267  public function isInvalid() {
268  return $this->getPassword() instanceof InvalidPassword;
269  }
270 
277  public function save( $operation, Password $password = null ) {
278  $conds = [
279  'bp_user' => $this->centralId,
280  'bp_app_id' => $this->appId,
281  ];
282  $fields = [
284  'bp_restrictions' => $this->restrictions->toJson(),
285  'bp_grants' => FormatJson::encode( $this->grants ),
286  ];
287 
288  if ( $password !== null ) {
289  $fields['bp_password'] = $password->toString();
290  } elseif ( $operation === 'insert' ) {
291  $fields['bp_password'] = PasswordFactory::newInvalidPassword()->toString();
292  }
293 
294  $dbw = self::getDB( DB_MASTER );
295  switch ( $operation ) {
296  case 'insert':
297  $dbw->insert( 'bot_passwords', $fields + $conds, __METHOD__, [ 'IGNORE' ] );
298  break;
299 
300  case 'update':
301  $dbw->update( 'bot_passwords', $fields, $conds, __METHOD__ );
302  break;
303 
304  default:
305  return false;
306  }
307  $ok = (bool)$dbw->affectedRows();
308  if ( $ok ) {
309  $this->token = $dbw->selectField( 'bot_passwords', 'bp_token', $conds, __METHOD__ );
310  $this->isSaved = true;
311  }
312  return $ok;
313  }
314 
319  public function delete() {
320  $conds = [
321  'bp_user' => $this->centralId,
322  'bp_app_id' => $this->appId,
323  ];
324  $dbw = self::getDB( DB_MASTER );
325  $dbw->delete( 'bot_passwords', $conds, __METHOD__ );
326  $ok = (bool)$dbw->affectedRows();
327  if ( $ok ) {
328  $this->token = '**unsaved**';
329  $this->isSaved = false;
330  }
331  return $ok;
332  }
333 
339  public static function invalidateAllPasswordsForUser( $username ) {
340  $centralId = CentralIdLookup::factory()->centralIdFromName(
341  $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
342  );
343  return $centralId && self::invalidateAllPasswordsForCentralId( $centralId );
344  }
345 
351  public static function invalidateAllPasswordsForCentralId( $centralId ) {
352  global $wgEnableBotPasswords;
353 
354  if ( !$wgEnableBotPasswords ) {
355  return false;
356  }
357 
358  $dbw = self::getDB( DB_MASTER );
359  $dbw->update(
360  'bot_passwords',
361  [ 'bp_password' => PasswordFactory::newInvalidPassword()->toString() ],
362  [ 'bp_user' => $centralId ],
363  __METHOD__
364  );
365  return (bool)$dbw->affectedRows();
366  }
367 
373  public static function removeAllPasswordsForUser( $username ) {
374  $centralId = CentralIdLookup::factory()->centralIdFromName(
375  $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
376  );
377  return $centralId && self::removeAllPasswordsForCentralId( $centralId );
378  }
379 
385  public static function removeAllPasswordsForCentralId( $centralId ) {
386  global $wgEnableBotPasswords;
387 
388  if ( !$wgEnableBotPasswords ) {
389  return false;
390  }
391 
392  $dbw = self::getDB( DB_MASTER );
393  $dbw->delete(
394  'bot_passwords',
395  [ 'bp_user' => $centralId ],
396  __METHOD__
397  );
398  return (bool)$dbw->affectedRows();
399  }
400 
406  public static function generatePassword( $config ) {
408  max( 32, $config->get( 'MinimalPasswordLength' ) ) );
409  }
410 
420  public static function canonicalizeLoginData( $username, $password ) {
421  $sep = self::getSeparator();
422  // the strlen check helps minimize the password information obtainable from timing
423  if ( strlen( $password ) >= 32 && strpos( $username, $sep ) !== false ) {
424  // the separator is not valid in new usernames but might appear in legacy ones
425  if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
426  return [ $username, $password ];
427  }
428  } elseif ( strlen( $password ) > 32 && strpos( $password, $sep ) !== false ) {
429  $segments = explode( $sep, $password );
430  $password = array_pop( $segments );
431  $appId = implode( $sep, $segments );
432  if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
433  return [ $username . $sep . $appId, $password ];
434  }
435  }
436  return false;
437  }
438 
446  public static function login( $username, $password, WebRequest $request ) {
448 
449  if ( !$wgEnableBotPasswords ) {
450  return Status::newFatal( 'botpasswords-disabled' );
451  }
452 
454  $provider = $manager->getProvider( BotPasswordSessionProvider::class );
455  if ( !$provider ) {
456  return Status::newFatal( 'botpasswords-no-provider' );
457  }
458 
459  // Split name into name+appId
460  $sep = self::getSeparator();
461  if ( strpos( $username, $sep ) === false ) {
462  return self::loginHook( $username, null, Status::newFatal( 'botpasswords-invalid-name', $sep ) );
463  }
464  list( $name, $appId ) = explode( $sep, $username, 2 );
465 
466  // Find the named user
468  if ( !$user || $user->isAnon() ) {
469  return self::loginHook( $user ?: $name, null, Status::newFatal( 'nosuchuser', $name ) );
470  }
471 
472  if ( $user->isLocked() ) {
473  return Status::newFatal( 'botpasswords-locked' );
474  }
475 
476  $throttle = null;
477  if ( !empty( $wgPasswordAttemptThrottle ) ) {
478  $throttle = new MediaWiki\Auth\Throttler( $wgPasswordAttemptThrottle, [
479  'type' => 'botpassword',
481  ] );
482  $result = $throttle->increase( $user->getName(), $request->getIP(), __METHOD__ );
483  if ( $result ) {
484  $msg = wfMessage( 'login-throttled' )->durationParams( $result['wait'] );
485  return self::loginHook( $user, null, Status::newFatal( $msg ) );
486  }
487  }
488 
489  // Get the bot password
490  $bp = self::newFromUser( $user, $appId );
491  if ( !$bp ) {
492  return self::loginHook( $user, $bp,
493  Status::newFatal( 'botpasswords-not-exist', $name, $appId ) );
494  }
495 
496  // Check restrictions
497  $status = $bp->getRestrictions()->check( $request );
498  if ( !$status->isOK() ) {
499  return self::loginHook( $user, $bp, Status::newFatal( 'botpasswords-restriction-failed' ) );
500  }
501 
502  // Check the password
503  $passwordObj = $bp->getPassword();
504  if ( $passwordObj instanceof InvalidPassword ) {
505  return self::loginHook( $user, $bp,
506  Status::newFatal( 'botpasswords-needs-reset', $name, $appId ) );
507  }
508  if ( !$passwordObj->verify( $password ) ) {
509  return self::loginHook( $user, $bp, Status::newFatal( 'wrongpassword' ) );
510  }
511 
512  // Ok! Create the session.
513  if ( $throttle ) {
514  $throttle->clear( $user->getName(), $request->getIP() );
515  }
516  return self::loginHook( $user, $bp,
517  Status::newGood( $provider->newSessionForRequest( $user, $bp, $request ) ) );
518  }
519 
531  private static function loginHook( $user, $bp, Status $status ) {
532  $extraData = [];
533  if ( $user instanceof User ) {
534  $name = $user->getName();
535  if ( $bp ) {
536  $extraData['appId'] = $name . self::getSeparator() . $bp->getAppId();
537  }
538  } else {
539  $name = $user;
540  $user = null;
541  }
542 
543  if ( $status->isGood() ) {
544  $response = AuthenticationResponse::newPass( $name );
545  } else {
546  $response = AuthenticationResponse::newFail( $status->getMessage() );
547  }
548  Hooks::run( 'AuthManagerLoginAuthenticateAudit', [ $response, $user, $name, $extraData ] );
549 
550  return $status;
551  }
552 }
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
$wgPasswordAttemptThrottle
Limit password attempts to X attempts per Y seconds per IP per account.
static getSeparator()
Get the separator for combined user name + app ID.
static generatePassword( $config)
Returns a (raw, unhashed) random password string.
getIP()
Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of...
static generateRandomPasswordString( $minLength=10)
Generate a random string suitable for a password.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static invalidateAllPasswordsForCentralId( $centralId)
Invalidate all passwords for a user, by central ID.
getUserCentralId()
Get the central user ID.
const TOKEN_LENGTH
Number of characters required for the user_token field.
Definition: User.php:56
isInvalid()
Whether the password is currently invalid.
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 $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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords $extraData
Definition: hooks.txt:780
const APPID_MAXLENGTH
Definition: BotPassword.php:32
static canonicalizeLoginData( $username, $password)
There are two ways to login with a bot password: "username@appId", "password" and "username"...
getToken()
Get the token.
Represents an invalid password hash.
isGood()
Returns whether the operation completed and didn&#39;t have any error or warnings.
static getLocalClusterInstance()
Get the main cluster-local cache object.
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 MediaWikiServices
Definition: injection.txt:23
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
save( $operation, Password $password=null)
Save the BotPassword to the database.
this hook is for auditing only $response
Definition: hooks.txt:780
array bool $wgEnableBotPasswords
Whether to enable bot passwords.
string [] $grants
Definition: BotPassword.php:50
const DB_MASTER
Definition: defines.php:26
static getDBOptions( $bitfield)
Get an appropriate DB index, options, and fallback DB index for a query.
static newUnsaved(array $data, $flags=self::READ_NORMAL)
Create an unsaved BotPassword.
isSaved()
Indicate whether this is known to be saved.
getMessage( $shortContext=false, $longContext=false, $lang=null)
Get a bullet list of the errors as a Message object.
Definition: Status.php:231
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
__construct( $row, $isSaved, $flags=self::READ_NORMAL)
Definition: BotPassword.php:60
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
getAppId()
Get the app ID.
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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 '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:1263
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
static getDB( $db)
Get a database connection for the bot passwords database.
Definition: BotPassword.php:76
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
string $token
Definition: BotPassword.php:44
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:174
getPassword()
Get the password.
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:1982
A class to check request restrictions expressed as a JSON object.
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format...
Definition: MWCryptRand.php:36
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
string $appId
Definition: BotPassword.php:41
static newFromJson( $json)
static login( $username, $password, WebRequest $request)
Try to log the user in.
static singleton()
Get the global SessionManager.
static newInvalidPassword()
Create an InvalidPassword.
static loginHook( $user, $bp, Status $status)
Call AuthManagerLoginAuthenticateAudit.
static newFromUser(User $user, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
Definition: BotPassword.php:93
string bool $wgBotPasswordsCluster
Cluster for the bot_passwords table If false, the normal cluster will be used.
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 or null if authentication failed before getting that far $username
Definition: hooks.txt:780
static factory( $providerId=null)
Fetch a CentralIdLookup.
Show an error when any operation involving passwords fails to run.
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 invalidateAllPasswordsForUser( $username)
Invalidate all passwords for a user, by name.
static newFromCentralId( $centralId, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static newDefault()
static removeAllPasswordsForCentralId( $centralId)
Remove all passwords for a user, by central ID.
$wgUserrightsInterwikiDelimiter
Character used as a delimiter when testing for interwiki userrights (In Special:UserRights, it is possible to modify users on different databases if the delimiter is used, e.g.
getGrants()
Get the grants.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:594
string bool $wgBotPasswordsDatabase
Database name for the bot_passwords table.
MWRestrictions $restrictions
Definition: BotPassword.php:47
getRestrictions()
Get the restrictions.
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:2633
static removeAllPasswordsForUser( $username)
Remove all passwords for a user, by name.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200