MediaWiki REL1_32
BotPassword.php
Go to the documentation of this file.
1<?php
24
29class BotPassword implements IDBAccessObject {
30
31 const APPID_MAXLENGTH = 32;
32
34 private $isSaved;
35
37 private $centralId;
38
40 private $appId;
41
43 private $token;
44
47
49 private $grants;
50
52 private $flags = self::READ_NORMAL;
53
59 protected function __construct( $row, $isSaved, $flags = self::READ_NORMAL ) {
60 $this->isSaved = $isSaved;
61 $this->flags = $flags;
62
63 $this->centralId = (int)$row->bp_user;
64 $this->appId = $row->bp_app_id;
65 $this->token = $row->bp_token;
66 $this->restrictions = MWRestrictions::newFromJson( $row->bp_restrictions );
67 $this->grants = FormatJson::decode( $row->bp_grants );
68 }
69
75 public static function getDB( $db ) {
77
78 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
80 ? $lbFactory->getExternalLB( $wgBotPasswordsCluster )
81 : $lbFactory->getMainLB( $wgBotPasswordsDatabase );
82 return $lb->getConnectionRef( $db, [], $wgBotPasswordsDatabase );
83 }
84
92 public static function newFromUser( User $user, $appId, $flags = self::READ_NORMAL ) {
93 $centralId = CentralIdLookup::factory()->centralIdFromLocalUser(
94 $user, CentralIdLookup::AUDIENCE_RAW, $flags
95 );
96 return $centralId ? self::newFromCentralId( $centralId, $appId, $flags ) : null;
97 }
98
106 public static function newFromCentralId( $centralId, $appId, $flags = self::READ_NORMAL ) {
108
109 if ( !$wgEnableBotPasswords ) {
110 return null;
111 }
112
113 list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
114 $db = self::getDB( $index );
115 $row = $db->selectRow(
116 'bot_passwords',
117 [ 'bp_user', 'bp_app_id', 'bp_token', 'bp_restrictions', 'bp_grants' ],
118 [ 'bp_user' => $centralId, 'bp_app_id' => $appId ],
119 __METHOD__,
121 );
122 return $row ? new self( $row, true, $flags ) : null;
123 }
124
137 public static function newUnsaved( array $data, $flags = self::READ_NORMAL ) {
138 $row = (object)[
139 'bp_user' => 0,
140 'bp_app_id' => isset( $data['appId'] ) ? trim( $data['appId'] ) : '',
141 'bp_token' => '**unsaved**',
142 'bp_restrictions' => $data['restrictions'] ?? MWRestrictions::newDefault(),
143 'bp_grants' => $data['grants'] ?? [],
144 ];
145
146 if (
147 $row->bp_app_id === '' || strlen( $row->bp_app_id ) > self::APPID_MAXLENGTH ||
148 !$row->bp_restrictions instanceof MWRestrictions ||
149 !is_array( $row->bp_grants )
150 ) {
151 return null;
152 }
153
154 $row->bp_restrictions = $row->bp_restrictions->toJson();
155 $row->bp_grants = FormatJson::encode( $row->bp_grants );
156
157 if ( isset( $data['user'] ) ) {
158 if ( !$data['user'] instanceof User ) {
159 return null;
160 }
161 $row->bp_user = CentralIdLookup::factory()->centralIdFromLocalUser(
162 $data['user'], CentralIdLookup::AUDIENCE_RAW, $flags
163 );
164 } elseif ( isset( $data['username'] ) ) {
165 $row->bp_user = CentralIdLookup::factory()->centralIdFromName(
166 $data['username'], CentralIdLookup::AUDIENCE_RAW, $flags
167 );
168 } elseif ( isset( $data['centralId'] ) ) {
169 $row->bp_user = $data['centralId'];
170 }
171 if ( !$row->bp_user ) {
172 return null;
173 }
174
175 return new self( $row, false, $flags );
176 }
177
182 public function isSaved() {
183 return $this->isSaved;
184 }
185
190 public function getUserCentralId() {
191 return $this->centralId;
192 }
193
198 public function getAppId() {
199 return $this->appId;
200 }
201
206 public function getToken() {
207 return $this->token;
208 }
209
214 public function getRestrictions() {
215 return $this->restrictions;
216 }
217
222 public function getGrants() {
223 return $this->grants;
224 }
225
230 public static function getSeparator() {
233 }
234
239 protected function getPassword() {
240 list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $this->flags );
241 $db = self::getDB( $index );
242 $password = $db->selectField(
243 'bot_passwords',
244 'bp_password',
245 [ 'bp_user' => $this->centralId, 'bp_app_id' => $this->appId ],
246 __METHOD__,
248 );
249 if ( $password === false ) {
250 return PasswordFactory::newInvalidPassword();
251 }
252
253 $passwordFactory = MediaWikiServices::getInstance()->getPasswordFactory();
254 try {
255 return $passwordFactory->newFromCiphertext( $password );
256 } catch ( PasswordError $ex ) {
257 return PasswordFactory::newInvalidPassword();
258 }
259 }
260
266 public function isInvalid() {
267 return $this->getPassword() instanceof InvalidPassword;
268 }
269
276 public function save( $operation, Password $password = null ) {
277 $conds = [
278 'bp_user' => $this->centralId,
279 'bp_app_id' => $this->appId,
280 ];
281 $fields = [
283 'bp_restrictions' => $this->restrictions->toJson(),
284 'bp_grants' => FormatJson::encode( $this->grants ),
285 ];
286
287 if ( $password !== null ) {
288 $fields['bp_password'] = $password->toString();
289 } elseif ( $operation === 'insert' ) {
290 $fields['bp_password'] = PasswordFactory::newInvalidPassword()->toString();
291 }
292
293 $dbw = self::getDB( DB_MASTER );
294 switch ( $operation ) {
295 case 'insert':
296 $dbw->insert( 'bot_passwords', $fields + $conds, __METHOD__, [ 'IGNORE' ] );
297 break;
298
299 case 'update':
300 $dbw->update( 'bot_passwords', $fields, $conds, __METHOD__ );
301 break;
302
303 default:
304 return false;
305 }
306 $ok = (bool)$dbw->affectedRows();
307 if ( $ok ) {
308 $this->token = $dbw->selectField( 'bot_passwords', 'bp_token', $conds, __METHOD__ );
309 $this->isSaved = true;
310 }
311 return $ok;
312 }
313
318 public function delete() {
319 $conds = [
320 'bp_user' => $this->centralId,
321 'bp_app_id' => $this->appId,
322 ];
323 $dbw = self::getDB( DB_MASTER );
324 $dbw->delete( 'bot_passwords', $conds, __METHOD__ );
325 $ok = (bool)$dbw->affectedRows();
326 if ( $ok ) {
327 $this->token = '**unsaved**';
328 $this->isSaved = false;
329 }
330 return $ok;
331 }
332
338 public static function invalidateAllPasswordsForUser( $username ) {
339 $centralId = CentralIdLookup::factory()->centralIdFromName(
340 $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
341 );
342 return $centralId && self::invalidateAllPasswordsForCentralId( $centralId );
343 }
344
350 public static function invalidateAllPasswordsForCentralId( $centralId ) {
352
353 if ( !$wgEnableBotPasswords ) {
354 return false;
355 }
356
357 $dbw = self::getDB( DB_MASTER );
358 $dbw->update(
359 'bot_passwords',
360 [ 'bp_password' => PasswordFactory::newInvalidPassword()->toString() ],
361 [ 'bp_user' => $centralId ],
362 __METHOD__
363 );
364 return (bool)$dbw->affectedRows();
365 }
366
372 public static function removeAllPasswordsForUser( $username ) {
373 $centralId = CentralIdLookup::factory()->centralIdFromName(
374 $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
375 );
376 return $centralId && self::removeAllPasswordsForCentralId( $centralId );
377 }
378
384 public static function removeAllPasswordsForCentralId( $centralId ) {
386
387 if ( !$wgEnableBotPasswords ) {
388 return false;
389 }
390
391 $dbw = self::getDB( DB_MASTER );
392 $dbw->delete(
393 'bot_passwords',
394 [ 'bp_user' => $centralId ],
395 __METHOD__
396 );
397 return (bool)$dbw->affectedRows();
398 }
399
405 public static function generatePassword( $config ) {
406 return PasswordFactory::generateRandomPasswordString(
407 max( 32, $config->get( 'MinimalPasswordLength' ) ) );
408 }
409
419 public static function canonicalizeLoginData( $username, $password ) {
420 $sep = self::getSeparator();
421 // the strlen check helps minimize the password information obtainable from timing
422 if ( strlen( $password ) >= 32 && strpos( $username, $sep ) !== false ) {
423 // the separator is not valid in new usernames but might appear in legacy ones
424 if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
425 return [ $username, $password ];
426 }
427 } elseif ( strlen( $password ) > 32 && strpos( $password, $sep ) !== false ) {
428 $segments = explode( $sep, $password );
429 $password = array_pop( $segments );
430 $appId = implode( $sep, $segments );
431 if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
432 return [ $username . $sep . $appId, $password ];
433 }
434 }
435 return false;
436 }
437
445 public static function login( $username, $password, WebRequest $request ) {
447
448 if ( !$wgEnableBotPasswords ) {
449 return Status::newFatal( 'botpasswords-disabled' );
450 }
451
452 $manager = MediaWiki\Session\SessionManager::singleton();
453 $provider = $manager->getProvider( BotPasswordSessionProvider::class );
454 if ( !$provider ) {
455 return Status::newFatal( 'botpasswords-no-provider' );
456 }
457
458 // Split name into name+appId
459 $sep = self::getSeparator();
460 if ( strpos( $username, $sep ) === false ) {
461 return Status::newFatal( 'botpasswords-invalid-name', $sep );
462 }
463 list( $name, $appId ) = explode( $sep, $username, 2 );
464
465 // Find the named user
467 if ( !$user || $user->isAnon() ) {
468 return Status::newFatal( 'nosuchuser', $name );
469 }
470
471 if ( $user->isLocked() ) {
472 return Status::newFatal( 'botpasswords-locked' );
473 }
474
475 // Throttle
476 $throttle = null;
477 if ( !empty( $wgPasswordAttemptThrottle ) ) {
479 'type' => 'botpassword',
480 'cache' => ObjectCache::getLocalClusterInstance(),
481 ] );
482 $result = $throttle->increase( $user->getName(), $request->getIP(), __METHOD__ );
483 if ( $result ) {
484 $msg = wfMessage( 'login-throttled' )->durationParams( $result['wait'] );
485 return Status::newFatal( $msg );
486 }
487 }
488
489 // Get the bot password
490 $bp = self::newFromUser( $user, $appId );
491 if ( !$bp ) {
492 return Status::newFatal( 'botpasswords-not-exist', $name, $appId );
493 }
494
495 // Check restrictions
496 $status = $bp->getRestrictions()->check( $request );
497 if ( !$status->isOK() ) {
498 return Status::newFatal( 'botpasswords-restriction-failed' );
499 }
500
501 // Check the password
502 $passwordObj = $bp->getPassword();
503 if ( $passwordObj instanceof InvalidPassword ) {
504 return Status::newFatal( 'botpasswords-needs-reset', $name, $appId );
505 }
506 if ( !$passwordObj->equals( $password ) ) {
507 return Status::newFatal( 'wrongpassword' );
508 }
509
510 // Ok! Create the session.
511 if ( $throttle ) {
512 $throttle->clear( $user->getName(), $request->getIP() );
513 }
514 return Status::newGood( $provider->newSessionForRequest( $user, $bp, $request ) );
515 }
516}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgUserrightsInterwikiDelimiter
Character used as a delimiter when testing for interwiki userrights (In Special:UserRights,...
bool $wgEnableBotPasswords
Whether to enable bot passwords.
$wgPasswordAttemptThrottle
Limit password attempts to X attempts per Y seconds per IP per account.
string bool $wgBotPasswordsDatabase
Database name for the bot_passwords table.
string bool $wgBotPasswordsCluster
Cluster for the bot_passwords table If false, the normal cluster will be used.
Utility class for bot passwords.
static newFromUser(User $user, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
isInvalid()
Whether the password is currently invalid.
__construct( $row, $isSaved, $flags=self::READ_NORMAL)
const APPID_MAXLENGTH
static invalidateAllPasswordsForUser( $username)
Invalidate all passwords for a user, by name.
getRestrictions()
Get the restrictions.
MWRestrictions $restrictions
static generatePassword( $config)
Returns a (raw, unhashed) random password string.
getPassword()
Get the password.
getUserCentralId()
Get the central user ID.
getGrants()
Get the grants.
string[] $grants
string $token
static getDB( $db)
Get a database connection for the bot passwords database.
getAppId()
Get the app ID.
static newFromCentralId( $centralId, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
static login( $username, $password, WebRequest $request)
Try to log the user in.
static invalidateAllPasswordsForCentralId( $centralId)
Invalidate all passwords for a user, by central ID.
isSaved()
Indicate whether this is known to be saved.
string $appId
static removeAllPasswordsForUser( $username)
Remove all passwords for a user, by name.
static removeAllPasswordsForCentralId( $centralId)
Remove all passwords for a user, by central ID.
static newUnsaved(array $data, $flags=self::READ_NORMAL)
Create an unsaved BotPassword.
getToken()
Get the token.
static getSeparator()
Get the separator for combined user name + app ID.
save( $operation, Password $password=null)
Save the BotPassword to the database.
static canonicalizeLoginData( $username, $password)
There are two ways to login with a bot password: "username@appId", "password" and "username",...
Represents an invalid password hash.
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format.
A class to check request restrictions expressed as a JSON object.
static newFromJson( $json)
MediaWikiServices is the service locator for the application scope of MediaWiki.
Show an error when any operation involving passwords fails to run.
Represents a password hash for use in authentication.
Definition Password.php:66
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
const TOKEN_LENGTH
@const int Number of characters in user_token field.
Definition User.php:51
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
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
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:62
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:2880
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 since 1.16! 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 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:2042
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:1305
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:2050
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;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:815
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
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
Interface for database access objects.
Advanced database interface for IDatabase handles that include maintenance methods.
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))
const DB_MASTER
Definition defines.php:26