MediaWiki  1.33.0
CaptchaPreAuthenticationProviderTest.php
Go to the documentation of this file.
1 <?php
2 
5 use Wikimedia\TestingAccessWrapper;
6 
12  public function setUp() {
13  parent::setUp();
14  $this->setMwGlobals( [
15  'wgCaptchaClass' => SimpleCaptcha::class,
16  'wgCaptchaBadLoginAttempts' => 1,
17  'wgCaptchaBadLoginPerUserAttempts' => 1,
18  'wgCaptchaStorageClass' => CaptchaHashStore::class,
19  'wgMainCacheType' => __METHOD__,
20  ] );
22  CaptchaStore::get()->clearAll();
23  $services = \MediaWiki\MediaWikiServices::getInstance();
24  if ( method_exists( $services, 'getLocalClusterObjectCache' ) ) {
25  $this->setService( 'LocalClusterObjectCache', new HashBagOStuff() );
26  } else {
27  ObjectCache::$instances[__METHOD__] = new HashBagOStuff();
28  }
29  }
30 
31  public function tearDown() {
32  parent::tearDown();
33  // make sure $wgCaptcha resets between tests
34  TestingAccessWrapper::newFromClass( ConfirmEditHooks::class )->instanceCreated = false;
35  }
36 
41  $action, $username, $triggers, $needsCaptcha, $preTestCallback = null
42  ) {
43  $this->setTriggers( $triggers );
44  if ( $preTestCallback ) {
45  $fn = array_shift( $preTestCallback );
46  call_user_func_array( [ $this, $fn ], $preTestCallback );
47  }
48 
50  $request = RequestContext::getMain()->getRequest();
51  $request->setCookie( 'UserName', $username );
52 
53  $provider = new CaptchaPreAuthenticationProvider();
54  $provider->setManager( AuthManager::singleton() );
55  $reqs = $provider->getAuthenticationRequests( $action, [ 'username' => $username ] );
56  if ( $needsCaptcha ) {
57  $this->assertCount( 1, $reqs );
58  $this->assertInstanceOf( CaptchaAuthenticationRequest::class, $reqs[0] );
59  } else {
60  $this->assertEmpty( $reqs );
61  }
62  }
63 
65  return [
66  [ AuthManager::ACTION_LOGIN, null, [], false ],
67  [ AuthManager::ACTION_LOGIN, null, [ 'badlogin' ], false ],
68  [ AuthManager::ACTION_LOGIN, null, [ 'badlogin' ], true, [ 'blockLogin', 'Foo' ] ],
69  [ AuthManager::ACTION_LOGIN, null, [ 'badloginperuser' ], false, [ 'blockLogin', 'Foo' ] ],
70  [ AuthManager::ACTION_LOGIN, 'Foo', [ 'badloginperuser' ], false, [ 'blockLogin', 'Bar' ] ],
71  [ AuthManager::ACTION_LOGIN, 'Foo', [ 'badloginperuser' ], true, [ 'blockLogin', 'Foo' ] ],
72  [ AuthManager::ACTION_LOGIN, null, [ 'badloginperuser' ], true, [ 'flagSession' ] ],
73  [ AuthManager::ACTION_CREATE, null, [], false ],
74  [ AuthManager::ACTION_CREATE, null, [ 'createaccount' ], true ],
75  [ AuthManager::ACTION_CREATE, 'UTSysop', [ 'createaccount' ], false ],
76  [ AuthManager::ACTION_LINK, null, [], false ],
77  [ AuthManager::ACTION_CHANGE, null, [], false ],
78  [ AuthManager::ACTION_REMOVE, null, [], false ],
79  ];
80  }
81 
83  $this->setTriggers( [ 'createaccount' ] );
84  $captcha = new SimpleCaptcha();
85  $provider = new CaptchaPreAuthenticationProvider();
86  $provider->setManager( AuthManager::singleton() );
87 
88  $reqs = $provider->getAuthenticationRequests( AuthManager::ACTION_CREATE,
89  [ 'username' => 'Foo' ] );
90 
91  $this->assertCount( 1, $reqs );
92  $this->assertInstanceOf( CaptchaAuthenticationRequest::class, $reqs[0] );
93 
94  $id = $reqs[0]->captchaId;
95  $data = TestingAccessWrapper::newFromObject( $reqs[0] )->captchaData;
96  $this->assertEquals( $captcha->retrieveCaptcha( $id ), $data + [ 'index' => $id ] );
97  }
98 
102  public function testTestForAuthentication( $req, $isBadLoginTriggered,
103  $isBadLoginPerUserTriggered, $result
104  ) {
105  $this->setMwHook( 'PingLimiter', function ( $user, $action, &$result ) {
106  $result = false;
107  return false;
108  } );
109  CaptchaStore::get()->store( '345', [ 'question' => '2+2', 'answer' => '4' ] );
110  $captcha = $this->getMock( SimpleCaptcha::class,
111  [ 'isBadLoginTriggered', 'isBadLoginPerUserTriggered' ] );
112  $captcha->expects( $this->any() )->method( 'isBadLoginTriggered' )
113  ->willReturn( $isBadLoginTriggered );
114  $captcha->expects( $this->any() )->method( 'isBadLoginPerUserTriggered' )
115  ->willReturn( $isBadLoginPerUserTriggered );
116  $this->setMwGlobals( 'wgCaptcha', $captcha );
117  TestingAccessWrapper::newFromClass( ConfirmEditHooks::class )->instanceCreated = true;
118  $provider = new CaptchaPreAuthenticationProvider();
119  $provider->setManager( AuthManager::singleton() );
120 
121  $status = $provider->testForAuthentication( $req ? [ $req ] : [] );
122  $this->assertEquals( $result, $status->isGood() );
123  }
124 
125  public function provideTestForAuthentication() {
127  $fallback->username = 'Foo';
128  return [
129  // [ auth request, bad login?, bad login per user?, result ]
130  'no need to check' => [ $fallback, false, false, true ],
131  'badlogin' => [ $fallback, true, false, false ],
132  'badloginperuser, no username' => [ null, false, true, true ],
133  'badloginperuser' => [ $fallback, false, true, false ],
134  'non-existent captcha' => [ $this->getCaptchaRequest( '123', '4' ), true, true, false ],
135  'wrong captcha' => [ $this->getCaptchaRequest( '345', '6' ), true, true, false ],
136  'correct captcha' => [ $this->getCaptchaRequest( '345', '4' ), true, true, true ],
137  ];
138  }
139 
143  public function testTestForAccountCreation( $req, $creator, $result, $disableTrigger = false ) {
144  $this->setMwHook( 'PingLimiter', function ( &$user, $action, &$result ) {
145  $result = false;
146  return false;
147  } );
148  $this->setTriggers( $disableTrigger ? [] : [ 'createaccount' ] );
149  CaptchaStore::get()->store( '345', [ 'question' => '2+2', 'answer' => '4' ] );
150  $user = User::newFromName( 'Foo' );
151  $provider = new CaptchaPreAuthenticationProvider();
152  $provider->setManager( AuthManager::singleton() );
153 
154  $status = $provider->testForAccountCreation( $user, $creator, $req ? [ $req ] : [] );
155  $this->assertEquals( $result, $status->isGood() );
156  }
157 
158  public function provideTestForAccountCreation() {
159  $user = User::newFromName( 'Bar' );
160  $sysop = User::newFromName( 'UTSysop' );
161  return [
162  // [ auth request, creator, result, disable trigger? ]
163  'no captcha' => [ null, $user, false ],
164  'non-existent captcha' => [ $this->getCaptchaRequest( '123', '4' ), $user, false ],
165  'wrong captcha' => [ $this->getCaptchaRequest( '345', '6' ), $user, false ],
166  'correct captcha' => [ $this->getCaptchaRequest( '345', '4' ), $user, true ],
167  'user is exempt' => [ null, $sysop, true ],
168  'disabled' => [ null, $user, true, 'disable' ],
169  ];
170  }
171 
172  public function testPostAuthentication() {
173  $this->setTriggers( [ 'badlogin', 'badloginperuser' ] );
174  $captcha = new SimpleCaptcha();
175  $user = User::newFromName( 'Foo' );
176  $anotherUser = User::newFromName( 'Bar' );
177  $provider = new CaptchaPreAuthenticationProvider();
178  $provider->setManager( AuthManager::singleton() );
179 
180  $this->assertFalse( $captcha->isBadLoginTriggered() );
181  $this->assertFalse( $captcha->isBadLoginPerUserTriggered( $user ) );
182 
183  $provider->postAuthentication( $user, \MediaWiki\Auth\AuthenticationResponse::newFail(
184  wfMessage( '?' ) ) );
185 
186  $this->assertTrue( $captcha->isBadLoginTriggered() );
187  $this->assertTrue( $captcha->isBadLoginPerUserTriggered( $user ) );
188  $this->assertFalse( $captcha->isBadLoginPerUserTriggered( $anotherUser ) );
189 
190  $provider->postAuthentication( $user, \MediaWiki\Auth\AuthenticationResponse::newPass( 'Foo' ) );
191 
192  $this->assertFalse( $captcha->isBadLoginPerUserTriggered( $user ) );
193  }
194 
196  $this->setTriggers( [] );
197  $captcha = new SimpleCaptcha();
198  $user = User::newFromName( 'Foo' );
199  $provider = new CaptchaPreAuthenticationProvider();
200  $provider->setManager( AuthManager::singleton() );
201 
202  $this->assertFalse( $captcha->isBadLoginTriggered() );
203  $this->assertFalse( $captcha->isBadLoginPerUserTriggered( $user ) );
204 
205  $provider->postAuthentication( $user, \MediaWiki\Auth\AuthenticationResponse::newFail(
206  wfMessage( '?' ) ) );
207 
208  $this->assertFalse( $captcha->isBadLoginTriggered() );
209  $this->assertFalse( $captcha->isBadLoginPerUserTriggered( $user ) );
210  }
211 
215  public function testPingLimiter( array $attempts ) {
217  'wgRateLimits',
218  [
219  'badcaptcha' => [
220  'user' => [ 1, 1 ],
221  ],
222  ]
223  );
224  $provider = new CaptchaPreAuthenticationProvider();
225  $provider->setManager( AuthManager::singleton() );
226  $providerAccess = TestingAccessWrapper::newFromObject( $provider );
227 
228  foreach ( $attempts as $attempt ) {
229  if ( !empty( $attempts[3] ) ) {
230  $this->setMwHook( 'PingLimiter', function ( &$user, $action, &$result ) {
231  $result = false;
232  return false;
233  } );
234  } else {
235  $this->setMwHook( 'PingLimiter', function () {
236  } );
237  }
238 
239  $captcha = new SimpleCaptcha();
240  CaptchaStore::get()->store( '345', [ 'question' => '7+7', 'answer' => '14' ] );
241  $success = $providerAccess->verifyCaptcha( $captcha, [ $attempts[0] ], $attempts[1] );
242  $this->assertEquals( $attempts[2], $success );
243  }
244  }
245 
246  public function providePingLimiter() {
247  $sysop = User::newFromName( 'UTSysop' );
248  return [
249  // sequence of [ auth request, user, result, disable ping limiter? ]
250  'no failure' => [
251  [ $this->getCaptchaRequest( '345', '14' ), new User(), true ],
252  [ $this->getCaptchaRequest( '345', '14' ), new User(), true ],
253  ],
254  'limited' => [
255  [ $this->getCaptchaRequest( '345', '33' ), new User(), false ],
256  [ $this->getCaptchaRequest( '345', '14' ), new User(), false ],
257  ],
258  'exempt user' => [
259  [ $this->getCaptchaRequest( '345', '33' ), $sysop, false ],
260  [ $this->getCaptchaRequest( '345', '14' ), $sysop, true ],
261  ],
262  'pinglimiter disabled' => [
263  [ $this->getCaptchaRequest( '345', '33' ), new User(), false, 'disable' ],
264  [ $this->getCaptchaRequest( '345', '14' ), new User(), true, 'disable' ],
265  ],
266  ];
267  }
268 
269  protected function getCaptchaRequest( $id, $word, $username = null ) {
270  $req = new CaptchaAuthenticationRequest( $id, [ 'question' => '?', 'answer' => $word ] );
271  $req->captchaWord = $word;
272  $req->username = $username;
273  return $req;
274  }
275 
276  protected function blockLogin( $username ) {
277  $captcha = new SimpleCaptcha();
278  $captcha->increaseBadLoginCounter( $username );
279  }
280 
281  protected function flagSession() {
282  RequestContext::getMain()->getRequest()->getSession()
283  ->set( 'ConfirmEdit:loginCaptchaPerUserTriggered', true );
284  }
285 
286  protected function setTriggers( $triggers ) {
287  $types = [ 'edit', 'create', 'sendemail', 'addurl', 'createaccount', 'badlogin',
288  'badloginperuser' ];
289  $captchaTriggers = array_combine( $types, array_map( function ( $type ) use ( $triggers ) {
290  return in_array( $type, $triggers, true );
291  }, $types ) );
292  $this->setMwGlobals( 'wgCaptchaTriggers', $captchaTriggers );
293  }
294 
301  protected function setMwHook( $hook, callable $callback ) {
302  $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hook => $callback ] );
303  }
304 }
$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. '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:1266
CaptchaPreAuthenticationProviderTest\testGetAuthenticationRequests_store
testGetAuthenticationRequests_store()
Definition: CaptchaPreAuthenticationProviderTest.php:82
CaptchaStore\get
static get()
Get somewhere to store captcha data that will persist between requests.
Definition: CaptchaStore.php:42
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
MediaWikiTestCase\mergeMwGlobalArrayValue
mergeMwGlobalArrayValue( $name, $values)
Merges the given values into a MW global array variable.
Definition: MediaWikiTestCase.php:904
HashBagOStuff
Simple store for keeping values in an associative array for the current process.
Definition: HashBagOStuff.php:31
CaptchaPreAuthenticationProviderTest\provideTestForAuthentication
provideTestForAuthentication()
Definition: CaptchaPreAuthenticationProviderTest.php:125
CaptchaPreAuthenticationProviderTest\tearDown
tearDown()
Definition: CaptchaPreAuthenticationProviderTest.php:31
$fallback
$fallback
Definition: MessagesAb.php:11
$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. '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:1983
ObjectCache\$instances
static BagOStuff[] $instances
Map of (id => BagOStuff)
Definition: ObjectCache.php:82
$req
this hook is for auditing only $req
Definition: hooks.txt:979
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:585
CaptchaPreAuthenticationProviderTest\provideTestForAccountCreation
provideTestForAccountCreation()
Definition: CaptchaPreAuthenticationProviderTest.php:158
$success
$success
Definition: NoLocalSettings.php:42
User
User
Definition: All_system_messages.txt:425
CaptchaStore\unsetInstanceForTests
static unsetInstanceForTests()
Definition: CaptchaStore.php:54
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:35
CaptchaPreAuthenticationProviderTest\setMwHook
setMwHook( $hook, callable $callback)
Set a $wgHooks handler for a given hook and remove all other handlers (though not ones set via Hooks:...
Definition: CaptchaPreAuthenticationProviderTest.php:301
$data
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
CaptchaPreAuthenticationProviderTest\testGetAuthenticationRequests
testGetAuthenticationRequests( $action, $username, $triggers, $needsCaptcha, $preTestCallback=null)
provideGetAuthenticationRequests
Definition: CaptchaPreAuthenticationProviderTest.php:40
CaptchaPreAuthenticationProviderTest\testTestForAuthentication
testTestForAuthentication( $req, $isBadLoginTriggered, $isBadLoginPerUserTriggered, $result)
provideTestForAuthentication
Definition: CaptchaPreAuthenticationProviderTest.php:102
CaptchaPreAuthenticationProviderTest\provideGetAuthenticationRequests
provideGetAuthenticationRequests()
Definition: CaptchaPreAuthenticationProviderTest.php:64
CaptchaPreAuthenticationProviderTest\testTestForAccountCreation
testTestForAccountCreation( $req, $creator, $result, $disableTrigger=false)
provideTestForAccountCreation
Definition: CaptchaPreAuthenticationProviderTest.php:143
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:709
MediaWikiTestCase
Definition: MediaWikiTestCase.php:17
CaptchaPreAuthenticationProviderTest\flagSession
flagSession()
Definition: CaptchaPreAuthenticationProviderTest.php:281
CaptchaPreAuthenticationProviderTest\testPostAuthentication
testPostAuthentication()
Definition: CaptchaPreAuthenticationProviderTest.php:172
MediaWiki
A helper class for throttling authentication attempts.
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
MediaWiki\Auth\UsernameAuthenticationRequest
AuthenticationRequest to ensure something with a username is present.
Definition: UsernameAuthenticationRequest.php:29
array
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))
CaptchaPreAuthenticationProvider
Definition: CaptchaPreAuthenticationProvider.php:9
$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:2636
any
they could even be mouse clicks or menu items whatever suits your program You should also get your if any
Definition: COPYING.txt:326
CaptchaPreAuthenticationProviderTest\testPingLimiter
testPingLimiter(array $attempts)
providePingLimiter
Definition: CaptchaPreAuthenticationProviderTest.php:215
SimpleCaptcha
Demo CAPTCHA (not for production usage) and base class for real CAPTCHAs.
Definition: SimpleCaptcha.php:8
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:430
CaptchaPreAuthenticationProviderTest\blockLogin
blockLogin( $username)
Definition: CaptchaPreAuthenticationProviderTest.php:276
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:84
CaptchaPreAuthenticationProviderTest\getCaptchaRequest
getCaptchaRequest( $id, $word, $username=null)
Definition: CaptchaPreAuthenticationProviderTest.php:269
CaptchaPreAuthenticationProviderTest\providePingLimiter
providePingLimiter()
Definition: CaptchaPreAuthenticationProviderTest.php:246
CaptchaPreAuthenticationProviderTest\testPostAuthentication_disabled
testPostAuthentication_disabled()
Definition: CaptchaPreAuthenticationProviderTest.php:195
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
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:1985
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:52
$services
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2220
CaptchaPreAuthenticationProviderTest
CaptchaPreAuthenticationProvider Database.
Definition: CaptchaPreAuthenticationProviderTest.php:11
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 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
MediaWikiTestCase\setService
setService( $name, $object)
Sets a service, maintaining a stashed version of the previous service to be restored in tearDown.
Definition: MediaWikiTestCase.php:649
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:780
CaptchaPreAuthenticationProviderTest\setTriggers
setTriggers( $triggers)
Definition: CaptchaPreAuthenticationProviderTest.php:286
CaptchaAuthenticationRequest
Generic captcha authentication request class.
Definition: CaptchaAuthenticationRequest.php:10
CaptchaPreAuthenticationProviderTest\setUp
setUp()
Definition: CaptchaPreAuthenticationProviderTest.php:12
$type
$type
Definition: testCompression.php:48