MediaWiki  REL1_31
BotPassword.php
Go to the documentation of this file.
1 <?php
24 
29 class BotPassword implements IDBAccessObject {
30 
31  const APPID_MAXLENGTH = 32;
32 
37  const RESTRICTIONS_MAXLENGTH = 65535;
38 
43  const GRANTS_MAXLENGTH = 65535;
44 
46  private $isSaved;
47 
49  private $centralId;
50 
52  private $appId;
53 
55  private $token;
56 
58  private $restrictions;
59 
61  private $grants;
62 
64  private $flags = self::READ_NORMAL;
65 
71  protected function __construct( $row, $isSaved, $flags = self::READ_NORMAL ) {
72  $this->isSaved = $isSaved;
73  $this->flags = $flags;
74 
75  $this->centralId = (int)$row->bp_user;
76  $this->appId = $row->bp_app_id;
77  $this->token = $row->bp_token;
78  $this->restrictions = MWRestrictions::newFromJson( $row->bp_restrictions );
79  $this->grants = FormatJson::decode( $row->bp_grants );
80  }
81 
87  public static function getDB( $db ) {
89 
90  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
92  ? $lbFactory->getExternalLB( $wgBotPasswordsCluster )
93  : $lbFactory->getMainLB( $wgBotPasswordsDatabase );
94  return $lb->getConnectionRef( $db, [], $wgBotPasswordsDatabase );
95  }
96 
104  public static function newFromUser( User $user, $appId, $flags = self::READ_NORMAL ) {
105  $centralId = CentralIdLookup::factory()->centralIdFromLocalUser(
107  );
109  }
110 
118  public static function newFromCentralId( $centralId, $appId, $flags = self::READ_NORMAL ) {
120 
121  if ( !$wgEnableBotPasswords ) {
122  return null;
123  }
124 
126  $db = self::getDB( $index );
127  $row = $db->selectRow(
128  'bot_passwords',
129  [ 'bp_user', 'bp_app_id', 'bp_token', 'bp_restrictions', 'bp_grants' ],
130  [ 'bp_user' => $centralId, 'bp_app_id' => $appId ],
131  __METHOD__,
132  $options
133  );
134  return $row ? new self( $row, true, $flags ) : null;
135  }
136 
149  public static function newUnsaved( array $data, $flags = self::READ_NORMAL ) {
150  $row = (object)[
151  'bp_user' => 0,
152  'bp_app_id' => isset( $data['appId'] ) ? trim( $data['appId'] ) : '',
153  'bp_token' => '**unsaved**',
154  'bp_restrictions' => isset( $data['restrictions'] )
155  ? $data['restrictions']
157  'bp_grants' => isset( $data['grants'] ) ? $data['grants'] : [],
158  ];
159 
160  if (
161  $row->bp_app_id === '' || strlen( $row->bp_app_id ) > self::APPID_MAXLENGTH ||
162  !$row->bp_restrictions instanceof MWRestrictions ||
163  !is_array( $row->bp_grants )
164  ) {
165  return null;
166  }
167 
168  $row->bp_restrictions = $row->bp_restrictions->toJson();
169  $row->bp_grants = FormatJson::encode( $row->bp_grants );
170 
171  if ( isset( $data['user'] ) ) {
172  if ( !$data['user'] instanceof User ) {
173  return null;
174  }
175  $row->bp_user = CentralIdLookup::factory()->centralIdFromLocalUser(
176  $data['user'], CentralIdLookup::AUDIENCE_RAW, $flags
177  );
178  } elseif ( isset( $data['username'] ) ) {
179  $row->bp_user = CentralIdLookup::factory()->centralIdFromName(
180  $data['username'], CentralIdLookup::AUDIENCE_RAW, $flags
181  );
182  } elseif ( isset( $data['centralId'] ) ) {
183  $row->bp_user = $data['centralId'];
184  }
185  if ( !$row->bp_user ) {
186  return null;
187  }
188 
189  return new self( $row, false, $flags );
190  }
191 
196  public function isSaved() {
197  return $this->isSaved;
198  }
199 
204  public function getUserCentralId() {
205  return $this->centralId;
206  }
207 
212  public function getAppId() {
213  return $this->appId;
214  }
215 
220  public function getToken() {
221  return $this->token;
222  }
223 
228  public function getRestrictions() {
229  return $this->restrictions;
230  }
231 
236  public function getGrants() {
237  return $this->grants;
238  }
239 
244  public static function getSeparator() {
247  }
248 
253  protected function getPassword() {
254  list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $this->flags );
255  $db = self::getDB( $index );
256  $password = $db->selectField(
257  'bot_passwords',
258  'bp_password',
259  [ 'bp_user' => $this->centralId, 'bp_app_id' => $this->appId ],
260  __METHOD__,
261  $options
262  );
263  if ( $password === false ) {
265  }
266 
267  $passwordFactory = new \PasswordFactory();
268  $passwordFactory->init( \RequestContext::getMain()->getConfig() );
269  try {
270  return $passwordFactory->newFromCiphertext( $password );
271  } catch ( PasswordError $ex ) {
273  }
274  }
275 
281  public function isInvalid() {
282  return $this->getPassword() instanceof InvalidPassword;
283  }
284 
292  public function save( $operation, Password $password = null ) {
293  // Ensure operation is valid
294  if ( $operation !== 'insert' && $operation !== 'update' ) {
295  throw new UnexpectedValueException(
296  "Expected 'insert' or 'update'; got '{$operation}'."
297  );
298  }
299 
300  $conds = [
301  'bp_user' => $this->centralId,
302  'bp_app_id' => $this->appId,
303  ];
304 
305  $res = Status::newGood();
306 
307  $restrictions = $this->restrictions->toJson();
308 
309  if ( strlen( $restrictions ) > self::RESTRICTIONS_MAXLENGTH ) {
310  $res->fatal( 'botpasswords-toolong-restrictions' );
311  }
312 
313  $grants = FormatJson::encode( $this->grants );
314 
315  if ( strlen( $grants ) > self::GRANTS_MAXLENGTH ) {
316  $res->fatal( 'botpasswords-toolong-grants' );
317  }
318 
319  if ( !$res->isGood() ) {
320  return $res;
321  }
322 
323  $fields = [
325  'bp_restrictions' => $restrictions,
326  'bp_grants' => $grants,
327  ];
328 
329  if ( $password !== null ) {
330  $fields['bp_password'] = $password->toString();
331  } elseif ( $operation === 'insert' ) {
332  $fields['bp_password'] = PasswordFactory::newInvalidPassword()->toString();
333  }
334 
335  $dbw = self::getDB( DB_MASTER );
336 
337  if ( $operation === 'insert' ) {
338  $dbw->insert( 'bot_passwords', $fields + $conds, __METHOD__, [ 'IGNORE' ] );
339  } else {
340  // Must be update, already checked above
341  $dbw->update( 'bot_passwords', $fields, $conds, __METHOD__ );
342  }
343 
344  $ok = (bool)$dbw->affectedRows();
345  if ( $ok ) {
346  $this->token = $dbw->selectField( 'bot_passwords', 'bp_token', $conds, __METHOD__ );
347  $this->isSaved = true;
348 
349  return $res;
350  }
351 
352  // Messages: botpasswords-insert-failed, botpasswords-update-failed
353  return Status::newFatal( "botpasswords-{$operation}-failed", $this->appId );
354  }
355 
360  public function delete() {
361  $conds = [
362  'bp_user' => $this->centralId,
363  'bp_app_id' => $this->appId,
364  ];
365  $dbw = self::getDB( DB_MASTER );
366  $dbw->delete( 'bot_passwords', $conds, __METHOD__ );
367  $ok = (bool)$dbw->affectedRows();
368  if ( $ok ) {
369  $this->token = '**unsaved**';
370  $this->isSaved = false;
371  }
372  return $ok;
373  }
374 
380  public static function invalidateAllPasswordsForUser( $username ) {
381  $centralId = CentralIdLookup::factory()->centralIdFromName(
382  $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
383  );
385  }
386 
392  public static function invalidateAllPasswordsForCentralId( $centralId ) {
394 
395  if ( !$wgEnableBotPasswords ) {
396  return false;
397  }
398 
399  $dbw = self::getDB( DB_MASTER );
400  $dbw->update(
401  'bot_passwords',
402  [ 'bp_password' => PasswordFactory::newInvalidPassword()->toString() ],
403  [ 'bp_user' => $centralId ],
404  __METHOD__
405  );
406  return (bool)$dbw->affectedRows();
407  }
408 
414  public static function removeAllPasswordsForUser( $username ) {
415  $centralId = CentralIdLookup::factory()->centralIdFromName(
416  $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
417  );
419  }
420 
426  public static function removeAllPasswordsForCentralId( $centralId ) {
428 
429  if ( !$wgEnableBotPasswords ) {
430  return false;
431  }
432 
433  $dbw = self::getDB( DB_MASTER );
434  $dbw->delete(
435  'bot_passwords',
436  [ 'bp_user' => $centralId ],
437  __METHOD__
438  );
439  return (bool)$dbw->affectedRows();
440  }
441 
447  public static function generatePassword( $config ) {
449  max( 32, $config->get( 'MinimalPasswordLength' ) ) );
450  }
451 
463  public static function canonicalizeLoginData( $username, $password ) {
464  $sep = self::getSeparator();
465  // the strlen check helps minimize the password information obtainable from timing
466  if ( strlen( $password ) >= 32 && strpos( $username, $sep ) !== false ) {
467  // the separator is not valid in new usernames but might appear in legacy ones
468  if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
469  return [ $username, $password, true ];
470  }
471  } elseif ( strlen( $password ) > 32 && strpos( $password, $sep ) !== false ) {
472  $segments = explode( $sep, $password );
473  $password = array_pop( $segments );
474  $appId = implode( $sep, $segments );
475  if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
476  return [ $username . $sep . $appId, $password, true ];
477  }
478  }
479  return false;
480  }
481 
489  public static function login( $username, $password, WebRequest $request ) {
491 
492  if ( !$wgEnableBotPasswords ) {
493  return Status::newFatal( 'botpasswords-disabled' );
494  }
495 
497  $provider = $manager->getProvider( BotPasswordSessionProvider::class );
498  if ( !$provider ) {
499  return Status::newFatal( 'botpasswords-no-provider' );
500  }
501 
502  // Split name into name+appId
503  $sep = self::getSeparator();
504  if ( strpos( $username, $sep ) === false ) {
505  return Status::newFatal( 'botpasswords-invalid-name', $sep );
506  }
507  list( $name, $appId ) = explode( $sep, $username, 2 );
508 
509  // Find the named user
511  if ( !$user || $user->isAnon() ) {
512  return Status::newFatal( 'nosuchuser', $name );
513  }
514 
515  if ( $user->isLocked() ) {
516  return Status::newFatal( 'botpasswords-locked' );
517  }
518 
519  // Throttle
520  $throttle = null;
521  if ( !empty( $wgPasswordAttemptThrottle ) ) {
523  'type' => 'botpassword',
525  ] );
526  $result = $throttle->increase( $user->getName(), $request->getIP(), __METHOD__ );
527  if ( $result ) {
528  $msg = wfMessage( 'login-throttled' )->durationParams( $result['wait'] );
529  return Status::newFatal( $msg );
530  }
531  }
532 
533  // Get the bot password
534  $bp = self::newFromUser( $user, $appId );
535  if ( !$bp ) {
536  return Status::newFatal( 'botpasswords-not-exist', $name, $appId );
537  }
538 
539  // Check restrictions
540  $status = $bp->getRestrictions()->check( $request );
541  if ( !$status->isOK() ) {
542  return Status::newFatal( 'botpasswords-restriction-failed' );
543  }
544 
545  // Check the password
546  $passwordObj = $bp->getPassword();
547  if ( $passwordObj instanceof InvalidPassword ) {
548  return Status::newFatal( 'botpasswords-needs-reset', $name, $appId );
549  }
550  if ( !$passwordObj->equals( $password ) ) {
551  return Status::newFatal( 'wrongpassword' );
552  }
553 
554  // Ok! Create the session.
555  if ( $throttle ) {
556  $throttle->clear( $user->getName(), $request->getIP() );
557  }
558  return Status::newGood( $provider->newSessionForRequest( $user, $bp, $request ) );
559  }
560 }
MWRestrictions
A class to check request restrictions expressed as a JSON object.
Definition: MWRestrictions.php:26
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
BotPassword\getRestrictions
getRestrictions()
Get the restrictions.
Definition: BotPassword.php:228
object
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 For a description of the see design txt $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:64
BotPassword\getUserCentralId
getUserCentralId()
Get the central user ID.
Definition: BotPassword.php:204
$wgBotPasswordsDatabase
string bool $wgBotPasswordsDatabase
Database name for the bot_passwords table.
Definition: DefaultSettings.php:5955
ObjectCache\getLocalClusterInstance
static getLocalClusterInstance()
Get the main cluster-local cache object.
Definition: ObjectCache.php:367
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWiki\Session\Session\BotPasswordSessionProvider
Session provider for bot passwords.
Definition: BotPasswordSessionProvider.php:34
BotPassword\$flags
int $flags
Definition: BotPassword.php:64
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
BotPassword\canonicalizeLoginData
static canonicalizeLoginData( $username, $password)
There are two ways to login with a bot password: "username@appId", "password" and "username",...
Definition: BotPassword.php:463
BotPassword
Utility class for bot passwords.
Definition: BotPassword.php:29
BotPassword\getSeparator
static getSeparator()
Get the separator for combined user name + app ID.
Definition: BotPassword.php:244
$wgBotPasswordsCluster
string bool $wgBotPasswordsCluster
Cluster for the bot_passwords table If false, the normal cluster will be used.
Definition: DefaultSettings.php:5945
BotPassword\generatePassword
static generatePassword( $config)
Returns a (raw, unhashed) random password string.
Definition: BotPassword.php:447
BotPassword\$grants
string[] $grants
Definition: BotPassword.php:61
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
PasswordError
Show an error when any operation involving passwords fails to run.
Definition: PasswordError.php:26
BotPassword\isInvalid
isInvalid()
Whether the password is currently invalid.
Definition: BotPassword.php:281
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
BotPassword\getAppId
getAppId()
Get the app ID.
Definition: BotPassword.php:212
PasswordFactory\generateRandomPasswordString
static generateRandomPasswordString( $minLength=10)
Generate a random string suitable for a password.
Definition: PasswordFactory.php:198
MWCryptRand\generateHex
static generateHex( $chars, $forceStrong=false)
Generate a run of (ideally) cryptographically random data and return it in hexadecimal string format.
Definition: MWCryptRand.php:76
MediaWiki\Auth\Throttler
Definition: Throttler.php:37
$res
$res
Definition: database.txt:21
DBAccessObjectUtils\getDBOptions
static getDBOptions( $bitfield)
Get an appropriate DB index, options, and fallback DB index for a query.
Definition: DBAccessObjectUtils.php:52
InvalidPassword
Represents an invalid password hash.
Definition: InvalidPassword.php:32
BotPassword\getToken
getToken()
Get the token.
Definition: BotPassword.php:220
BotPassword\getDB
static getDB( $db)
Get a database connection for the bot passwords database.
Definition: BotPassword.php:87
BotPassword\invalidateAllPasswordsForCentralId
static invalidateAllPasswordsForCentralId( $centralId)
Invalidate all passwords for a user, by central ID.
Definition: BotPassword.php:392
BotPassword\APPID_MAXLENGTH
const APPID_MAXLENGTH
Definition: BotPassword.php:31
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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:1993
BotPassword\$isSaved
bool $isSaved
Definition: BotPassword.php:46
IDBAccessObject
Interface for database access objects.
Definition: IDBAccessObject.php:55
BotPassword\__construct
__construct( $row, $isSaved, $flags=self::READ_NORMAL)
Definition: BotPassword.php:71
BotPassword\save
save( $operation, Password $password=null)
Save the BotPassword to the database.
Definition: BotPassword.php:292
true
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 just before the function returns a value If you return true
Definition: hooks.txt:2006
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
flags
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database etc For and for historical it also represents a few features of articles that don t involve their such as access rights See also title txt Article Encapsulates access to the page table of the database The object represents a an and maintains state such as flags
Definition: design.txt:34
BotPassword\$token
string $token
Definition: BotPassword.php:55
FormatJson\decode
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:187
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
BotPassword\isSaved
isSaved()
Indicate whether this is known to be saved.
Definition: BotPassword.php:196
BotPassword\newUnsaved
static newUnsaved(array $data, $flags=self::READ_NORMAL)
Create an unsaved BotPassword.
Definition: BotPassword.php:149
BotPassword\$appId
string $appId
Definition: BotPassword.php:52
MWRestrictions\toJson
toJson( $pretty=false)
Return the restrictions as a JSON string.
Definition: MWRestrictions.php:113
BotPassword\RESTRICTIONS_MAXLENGTH
const RESTRICTIONS_MAXLENGTH
Maximum length of the json representation of restrictions.
Definition: BotPassword.php:37
MediaWiki\Session\SessionManager\singleton
static singleton()
Get the global SessionManager.
Definition: SessionManager.php:92
$wgUserrightsInterwikiDelimiter
$wgUserrightsInterwikiDelimiter
Character used as a delimiter when testing for interwiki userrights (In Special:UserRights,...
Definition: DefaultSettings.php:4941
User\TOKEN_LENGTH
const TOKEN_LENGTH
@const int Number of characters in user_token field.
Definition: User.php:57
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
MWRestrictions\newDefault
static newDefault()
Definition: MWRestrictions.php:43
BotPassword\newFromUser
static newFromUser(User $user, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
Definition: BotPassword.php:104
list
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
BotPassword\getPassword
getPassword()
Get the password.
Definition: BotPassword.php:253
$options
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:2001
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
BotPassword\invalidateAllPasswordsForUser
static invalidateAllPasswordsForUser( $username)
Invalidate all passwords for a user, by name.
Definition: BotPassword.php:380
BotPassword\$centralId
int $centralId
Definition: BotPassword.php:49
$wgPasswordAttemptThrottle
$wgPasswordAttemptThrottle
Limit password attempts to X attempts per Y seconds per IP per account.
Definition: DefaultSettings.php:5782
$status
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. '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:1255
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
BotPassword\newFromCentralId
static newFromCentralId( $centralId, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
Definition: BotPassword.php:118
BotPassword\login
static login( $username, $password, WebRequest $request)
Try to log the user in.
Definition: BotPassword.php:489
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:38
BotPassword\getGrants
getGrants()
Get the grants.
Definition: BotPassword.php:236
PasswordFactory\newInvalidPassword
static newInvalidPassword()
Create an InvalidPassword.
Definition: PasswordFactory.php:214
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
MWRestrictions\newFromJson
static newFromJson( $json)
Definition: MWRestrictions.php:61
BotPassword\GRANTS_MAXLENGTH
const GRANTS_MAXLENGTH
Maximum length of the json representation of grants.
Definition: BotPassword.php:43
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
BotPassword\removeAllPasswordsForUser
static removeAllPasswordsForUser( $username)
Remove all passwords for a user, by name.
Definition: BotPassword.php:414
$wgEnableBotPasswords
bool $wgEnableBotPasswords
Whether to enable bot passwords.
Definition: DefaultSettings.php:5938
class
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:56
$request
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:2806
CentralIdLookup\AUDIENCE_RAW
const AUDIENCE_RAW
Definition: CentralIdLookup.php:33
MediaWikiServices
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:25
Password
Represents a password hash for use in authentication.
Definition: Password.php:66
CentralIdLookup\factory
static factory( $providerId=null)
Fetch a CentralIdLookup.
Definition: CentralIdLookup.php:46
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Wikimedia\Rdbms\IMaintainableDatabase
Advanced database interface for IDatabase handles that include maintenance methods.
Definition: IMaintainableDatabase.php:38
BotPassword\removeAllPasswordsForCentralId
static removeAllPasswordsForCentralId( $centralId)
Remove all passwords for a user, by central ID.
Definition: BotPassword.php:426
BotPassword\$restrictions
MWRestrictions $restrictions
Definition: BotPassword.php:58