MediaWiki  REL1_31
BotPasswordTest.php
Go to the documentation of this file.
1 <?php
2 
4 use Wikimedia\ScopedCallback;
5 use Wikimedia\TestingAccessWrapper;
6 
12 
14  private $testUser;
15 
17  private $testUserName;
18 
19  protected function setUp() {
20  parent::setUp();
21 
22  $this->setMwGlobals( [
23  'wgEnableBotPasswords' => true,
24  'wgBotPasswordsDatabase' => false,
25  'wgCentralIdLookupProvider' => 'BotPasswordTest OkMock',
26  'wgGrantPermissions' => [
27  'test' => [ 'read' => true ],
28  ],
29  'wgUserrightsInterwikiDelimiter' => '@',
30  ] );
31 
32  $this->testUser = $this->getMutableTestUser();
33  $this->testUserName = $this->testUser->getUser()->getName();
34 
35  $mock1 = $this->getMockForAbstractClass( CentralIdLookup::class );
36  $mock1->expects( $this->any() )->method( 'isAttached' )
37  ->will( $this->returnValue( true ) );
38  $mock1->expects( $this->any() )->method( 'lookupUserNames' )
39  ->will( $this->returnValue( [ $this->testUserName => 42, 'UTDummy' => 43, 'UTInvalid' => 0 ] ) );
40  $mock1->expects( $this->never() )->method( 'lookupCentralIds' );
41 
42  $mock2 = $this->getMockForAbstractClass( CentralIdLookup::class );
43  $mock2->expects( $this->any() )->method( 'isAttached' )
44  ->will( $this->returnValue( false ) );
45  $mock2->expects( $this->any() )->method( 'lookupUserNames' )
46  ->will( $this->returnArgument( 0 ) );
47  $mock2->expects( $this->never() )->method( 'lookupCentralIds' );
48 
49  $this->mergeMwGlobalArrayValue( 'wgCentralIdLookupProviders', [
50  'BotPasswordTest OkMock' => [ 'factory' => function () use ( $mock1 ) {
51  return $mock1;
52  } ],
53  'BotPasswordTest FailMock' => [ 'factory' => function () use ( $mock2 ) {
54  return $mock2;
55  } ],
56  ] );
57 
59  }
60 
61  public function addDBData() {
62  $passwordFactory = new \PasswordFactory();
63  $passwordFactory->init( \RequestContext::getMain()->getConfig() );
64  $passwordHash = $passwordFactory->newFromPlaintext( 'foobaz' );
65 
66  $dbw = wfGetDB( DB_MASTER );
67  $dbw->delete(
68  'bot_passwords',
69  [ 'bp_user' => [ 42, 43 ], 'bp_app_id' => 'BotPassword' ],
70  __METHOD__
71  );
72  $dbw->insert(
73  'bot_passwords',
74  [
75  [
76  'bp_user' => 42,
77  'bp_app_id' => 'BotPassword',
78  'bp_password' => $passwordHash->toString(),
79  'bp_token' => 'token!',
80  'bp_restrictions' => '{"IPAddresses":["127.0.0.0/8"]}',
81  'bp_grants' => '["test"]',
82  ],
83  [
84  'bp_user' => 43,
85  'bp_app_id' => 'BotPassword',
86  'bp_password' => $passwordHash->toString(),
87  'bp_token' => 'token!',
88  'bp_restrictions' => '{"IPAddresses":["127.0.0.0/8"]}',
89  'bp_grants' => '["test"]',
90  ],
91  ],
92  __METHOD__
93  );
94  }
95 
96  public function testBasics() {
97  $user = $this->testUser->getUser();
98  $bp = BotPassword::newFromUser( $user, 'BotPassword' );
99  $this->assertInstanceOf( BotPassword::class, $bp );
100  $this->assertTrue( $bp->isSaved() );
101  $this->assertSame( 42, $bp->getUserCentralId() );
102  $this->assertSame( 'BotPassword', $bp->getAppId() );
103  $this->assertSame( 'token!', trim( $bp->getToken(), " \0" ) );
104  $this->assertEquals( '{"IPAddresses":["127.0.0.0/8"]}', $bp->getRestrictions()->toJson() );
105  $this->assertSame( [ 'test' ], $bp->getGrants() );
106 
107  $this->assertNull( BotPassword::newFromUser( $user, 'DoesNotExist' ) );
108 
109  $this->setMwGlobals( [
110  'wgCentralIdLookupProvider' => 'BotPasswordTest FailMock'
111  ] );
112  $this->assertNull( BotPassword::newFromUser( $user, 'BotPassword' ) );
113 
114  $this->assertSame( '@', BotPassword::getSeparator() );
115  $this->setMwGlobals( [
116  'wgUserrightsInterwikiDelimiter' => '#',
117  ] );
118  $this->assertSame( '#', BotPassword::getSeparator() );
119  }
120 
121  public function testUnsaved() {
122  $user = $this->testUser->getUser();
123  $bp = BotPassword::newUnsaved( [
124  'user' => $user,
125  'appId' => 'DoesNotExist'
126  ] );
127  $this->assertInstanceOf( BotPassword::class, $bp );
128  $this->assertFalse( $bp->isSaved() );
129  $this->assertSame( 42, $bp->getUserCentralId() );
130  $this->assertSame( 'DoesNotExist', $bp->getAppId() );
131  $this->assertEquals( MWRestrictions::newDefault(), $bp->getRestrictions() );
132  $this->assertSame( [], $bp->getGrants() );
133 
134  $bp = BotPassword::newUnsaved( [
135  'username' => 'UTDummy',
136  'appId' => 'DoesNotExist2',
137  'restrictions' => MWRestrictions::newFromJson( '{"IPAddresses":["127.0.0.0/8"]}' ),
138  'grants' => [ 'test' ],
139  ] );
140  $this->assertInstanceOf( BotPassword::class, $bp );
141  $this->assertFalse( $bp->isSaved() );
142  $this->assertSame( 43, $bp->getUserCentralId() );
143  $this->assertSame( 'DoesNotExist2', $bp->getAppId() );
144  $this->assertEquals( '{"IPAddresses":["127.0.0.0/8"]}', $bp->getRestrictions()->toJson() );
145  $this->assertSame( [ 'test' ], $bp->getGrants() );
146 
147  $user = $this->testUser->getUser();
148  $bp = BotPassword::newUnsaved( [
149  'centralId' => 45,
150  'appId' => 'DoesNotExist'
151  ] );
152  $this->assertInstanceOf( BotPassword::class, $bp );
153  $this->assertFalse( $bp->isSaved() );
154  $this->assertSame( 45, $bp->getUserCentralId() );
155  $this->assertSame( 'DoesNotExist', $bp->getAppId() );
156 
157  $user = $this->testUser->getUser();
158  $bp = BotPassword::newUnsaved( [
159  'user' => $user,
160  'appId' => 'BotPassword'
161  ] );
162  $this->assertInstanceOf( BotPassword::class, $bp );
163  $this->assertFalse( $bp->isSaved() );
164 
165  $this->assertNull( BotPassword::newUnsaved( [
166  'user' => $user,
167  'appId' => '',
168  ] ) );
169  $this->assertNull( BotPassword::newUnsaved( [
170  'user' => $user,
171  'appId' => str_repeat( 'X', BotPassword::APPID_MAXLENGTH + 1 ),
172  ] ) );
173  $this->assertNull( BotPassword::newUnsaved( [
174  'user' => $this->testUserName,
175  'appId' => 'Ok',
176  ] ) );
177  $this->assertNull( BotPassword::newUnsaved( [
178  'username' => 'UTInvalid',
179  'appId' => 'Ok',
180  ] ) );
181  $this->assertNull( BotPassword::newUnsaved( [
182  'appId' => 'Ok',
183  ] ) );
184  }
185 
186  public function testGetPassword() {
187  $bp = TestingAccessWrapper::newFromObject( BotPassword::newFromCentralId( 42, 'BotPassword' ) );
188 
189  $password = $bp->getPassword();
190  $this->assertInstanceOf( Password::class, $password );
191  $this->assertTrue( $password->equals( 'foobaz' ) );
192 
193  $bp->centralId = 44;
194  $password = $bp->getPassword();
195  $this->assertInstanceOf( InvalidPassword::class, $password );
196 
197  $bp = TestingAccessWrapper::newFromObject( BotPassword::newFromCentralId( 42, 'BotPassword' ) );
198  $dbw = wfGetDB( DB_MASTER );
199  $dbw->update(
200  'bot_passwords',
201  [ 'bp_password' => 'garbage' ],
202  [ 'bp_user' => 42, 'bp_app_id' => 'BotPassword' ],
203  __METHOD__
204  );
205  $password = $bp->getPassword();
206  $this->assertInstanceOf( InvalidPassword::class, $password );
207  }
208 
210  $bp1 = TestingAccessWrapper::newFromObject( BotPassword::newFromCentralId( 42, 'BotPassword' ) );
211  $bp2 = TestingAccessWrapper::newFromObject( BotPassword::newFromCentralId( 43, 'BotPassword' ) );
212 
213  $this->assertNotInstanceOf( InvalidPassword::class, $bp1->getPassword(), 'sanity check' );
214  $this->assertNotInstanceOf( InvalidPassword::class, $bp2->getPassword(), 'sanity check' );
215  BotPassword::invalidateAllPasswordsForUser( $this->testUserName );
216  $this->assertInstanceOf( InvalidPassword::class, $bp1->getPassword() );
217  $this->assertNotInstanceOf( InvalidPassword::class, $bp2->getPassword() );
218 
219  $bp = TestingAccessWrapper::newFromObject( BotPassword::newFromCentralId( 42, 'BotPassword' ) );
220  $this->assertInstanceOf( InvalidPassword::class, $bp->getPassword() );
221  }
222 
223  public function testRemoveAllPasswordsForUser() {
224  $this->assertNotNull( BotPassword::newFromCentralId( 42, 'BotPassword' ), 'sanity check' );
225  $this->assertNotNull( BotPassword::newFromCentralId( 43, 'BotPassword' ), 'sanity check' );
226 
227  BotPassword::removeAllPasswordsForUser( $this->testUserName );
228 
229  $this->assertNull( BotPassword::newFromCentralId( 42, 'BotPassword' ) );
230  $this->assertNotNull( BotPassword::newFromCentralId( 43, 'BotPassword' ) );
231  }
232 
236  public function testCanonicalizeLoginData( $username, $password, $expectedResult ) {
238  if ( is_array( $expectedResult ) ) {
239  $this->assertArrayEquals( $expectedResult, $result, true, true );
240  } else {
241  $this->assertSame( $expectedResult, $result );
242  }
243  }
244 
245  public function provideCanonicalizeLoginData() {
246  return [
247  [ 'user', 'pass', false ],
248  [ 'user', 'abc@def', false ],
249  [ 'legacy@user', 'pass', false ],
250  [ 'user@bot', '12345678901234567890123456789012',
251  [ 'user@bot', '12345678901234567890123456789012', true ] ],
252  [ 'user', 'bot@12345678901234567890123456789012',
253  [ 'user@bot', '12345678901234567890123456789012', true ] ],
254  [ 'user', 'bot@12345678901234567890123456789012345',
255  [ 'user@bot', '12345678901234567890123456789012345', true ] ],
256  [ 'user', 'bot@x@12345678901234567890123456789012',
257  [ 'user@bot@x', '12345678901234567890123456789012', true ] ],
258  ];
259  }
260 
261  public function testLogin() {
262  // Test failure when bot passwords aren't enabled
263  $this->setMwGlobals( 'wgEnableBotPasswords', false );
264  $status = BotPassword::login( "{$this->testUserName}@BotPassword", 'foobaz', new FauxRequest );
265  $this->assertEquals( Status::newFatal( 'botpasswords-disabled' ), $status );
266  $this->setMwGlobals( 'wgEnableBotPasswords', true );
267 
268  // Test failure when BotPasswordSessionProvider isn't configured
269  $manager = new SessionManager( [
270  'logger' => new Psr\Log\NullLogger,
271  'store' => new EmptyBagOStuff,
272  ] );
274  $this->assertNull(
275  $manager->getProvider( MediaWiki\Session\BotPasswordSessionProvider::class ),
276  'sanity check'
277  );
278  $status = BotPassword::login( "{$this->testUserName}@BotPassword", 'foobaz', new FauxRequest );
279  $this->assertEquals( Status::newFatal( 'botpasswords-no-provider' ), $status );
280  ScopedCallback::consume( $reset );
281 
282  // Now configure BotPasswordSessionProvider for further tests...
283  $mainConfig = RequestContext::getMain()->getConfig();
284  $config = new HashConfig( [
285  'SessionProviders' => $mainConfig->get( 'SessionProviders' ) + [
287  'class' => MediaWiki\Session\BotPasswordSessionProvider::class,
288  'args' => [ [ 'priority' => 40 ] ],
289  ]
290  ],
291  ] );
292  $manager = new SessionManager( [
293  'config' => new MultiConfig( [ $config, RequestContext::getMain()->getConfig() ] ),
294  'logger' => new Psr\Log\NullLogger,
295  'store' => new EmptyBagOStuff,
296  ] );
298 
299  // No "@"-thing in the username
300  $status = BotPassword::login( $this->testUserName, 'foobaz', new FauxRequest );
301  $this->assertEquals( Status::newFatal( 'botpasswords-invalid-name', '@' ), $status );
302 
303  // No base user
304  $status = BotPassword::login( 'UTDummy@BotPassword', 'foobaz', new FauxRequest );
305  $this->assertEquals( Status::newFatal( 'nosuchuser', 'UTDummy' ), $status );
306 
307  // No bot password
308  $status = BotPassword::login( "{$this->testUserName}@DoesNotExist", 'foobaz', new FauxRequest );
309  $this->assertEquals(
310  Status::newFatal( 'botpasswords-not-exist', $this->testUserName, 'DoesNotExist' ),
311  $status
312  );
313 
314  // Failed restriction
315  $request = $this->getMockBuilder( FauxRequest::class )
316  ->setMethods( [ 'getIP' ] )
317  ->getMock();
318  $request->expects( $this->any() )->method( 'getIP' )
319  ->will( $this->returnValue( '10.0.0.1' ) );
320  $status = BotPassword::login( "{$this->testUserName}@BotPassword", 'foobaz', $request );
321  $this->assertEquals( Status::newFatal( 'botpasswords-restriction-failed' ), $status );
322 
323  // Wrong password
325  "{$this->testUserName}@BotPassword", $this->testUser->getPassword(), new FauxRequest );
326  $this->assertEquals( Status::newFatal( 'wrongpassword' ), $status );
327 
328  // Success!
329  $request = new FauxRequest;
330  $this->assertNotInstanceOf(
332  $request->getSession()->getProvider(),
333  'sanity check'
334  );
335  $status = BotPassword::login( "{$this->testUserName}@BotPassword", 'foobaz', $request );
336  $this->assertInstanceOf( Status::class, $status );
337  $this->assertTrue( $status->isGood() );
338  $session = $status->getValue();
339  $this->assertInstanceOf( MediaWiki\Session\Session::class, $session );
340  $this->assertInstanceOf(
341  MediaWiki\Session\BotPasswordSessionProvider::class, $session->getProvider()
342  );
343  $this->assertSame( $session->getId(), $request->getSession()->getId() );
344 
345  ScopedCallback::consume( $reset );
346  }
347 
352  public function testSave( $password ) {
353  $passwordFactory = new \PasswordFactory();
354  $passwordFactory->init( \RequestContext::getMain()->getConfig() );
355 
356  $bp = BotPassword::newUnsaved( [
357  'centralId' => 42,
358  'appId' => 'TestSave',
359  'restrictions' => MWRestrictions::newFromJson( '{"IPAddresses":["127.0.0.0/8"]}' ),
360  'grants' => [ 'test' ],
361  ] );
362  $this->assertFalse( $bp->isSaved(), 'sanity check' );
363  $this->assertNull(
364  BotPassword::newFromCentralId( 42, 'TestSave', BotPassword::READ_LATEST ), 'sanity check'
365  );
366 
367  $passwordHash = $password ? $passwordFactory->newFromPlaintext( $password ) : null;
368  $this->assertFalse( $bp->save( 'update', $passwordHash )->isGood() );
369  $this->assertTrue( $bp->save( 'insert', $passwordHash )->isGood() );
370 
371  $bp2 = BotPassword::newFromCentralId( 42, 'TestSave', BotPassword::READ_LATEST );
372  $this->assertInstanceOf( BotPassword::class, $bp2 );
373  $this->assertEquals( $bp->getUserCentralId(), $bp2->getUserCentralId() );
374  $this->assertEquals( $bp->getAppId(), $bp2->getAppId() );
375  $this->assertEquals( $bp->getToken(), $bp2->getToken() );
376  $this->assertEquals( $bp->getRestrictions(), $bp2->getRestrictions() );
377  $this->assertEquals( $bp->getGrants(), $bp2->getGrants() );
378 
380  $pw = TestingAccessWrapper::newFromObject( $bp )->getPassword();
381  if ( $password === null ) {
382  $this->assertInstanceOf( InvalidPassword::class, $pw );
383  } else {
384  $this->assertTrue( $pw->equals( $password ) );
385  }
386 
387  $token = $bp->getToken();
388  $this->assertEquals( 42, $bp->getUserCentralId() );
389  $this->assertEquals( 'TestSave', $bp->getAppId() );
390  $this->assertFalse( $bp->save( 'insert' )->isGood() );
391  $this->assertTrue( $bp->save( 'update' )->isGood() );
392  $this->assertNotEquals( $token, $bp->getToken() );
393 
394  $bp2 = BotPassword::newFromCentralId( 42, 'TestSave', BotPassword::READ_LATEST );
395  $this->assertInstanceOf( BotPassword::class, $bp2 );
396  $this->assertEquals( $bp->getToken(), $bp2->getToken() );
397  $pw = TestingAccessWrapper::newFromObject( $bp )->getPassword();
398  if ( $password === null ) {
399  $this->assertInstanceOf( InvalidPassword::class, $pw );
400  } else {
401  $this->assertTrue( $pw->equals( $password ) );
402  }
403 
404  $passwordHash = $passwordFactory->newFromPlaintext( 'XXX' );
405  $token = $bp->getToken();
406  $this->assertTrue( $bp->save( 'update', $passwordHash )->isGood() );
407  $this->assertNotEquals( $token, $bp->getToken() );
408 
410  $pw = TestingAccessWrapper::newFromObject( $bp )->getPassword();
411  $this->assertTrue( $pw->equals( 'XXX' ) );
412 
413  $this->assertTrue( $bp->delete() );
414  $this->assertFalse( $bp->isSaved() );
415  $this->assertNull( BotPassword::newFromCentralId( 42, 'TestSave', BotPassword::READ_LATEST ) );
416 
417  $this->expectException( UnexpectedValueException::class );
418  $bp->save( 'foobar' )->isGood();
419  }
420 
421  public static function provideSave() {
422  return [
423  [ null ],
424  [ 'foobar' ],
425  ];
426  }
427 
431  public function testSaveValidation() {
432  $lotsOfIPs = [
433  'IPAddresses' => array_fill(
434  0,
435  5000,
436  "127.0.0.0/8"
437  )
438  ];
439 
440  $bp = BotPassword::newUnsaved( [
441  'centralId' => 42,
442  'appId' => 'TestSave',
443  // When this becomes JSON, it'll be 70,017 characters, which is
444  // greater than BotPassword::GRANTS_MAXLENGTH, so it will cause an error.
445  'restrictions' => MWRestrictions::newFromArray( $lotsOfIPs ),
446  'grants' => [
447  // Maximum length of the JSON is BotPassword::RESTRICTIONS_MAXLENGTH characters.
448  // So one long grant name should be good. Turning it into JSON will add
449  // a couple of extra characters, taking it over BotPassword::RESTRICTIONS_MAXLENGTH
450  // characters long, so it will cause an error.
451  str_repeat( '*', BotPassword::RESTRICTIONS_MAXLENGTH )
452  ],
453  ] );
454 
455  $status = $bp->save( 'insert' );
456 
457  $this->assertFalse( $status->isGood() );
458  $this->assertNotEmpty( $status->getErrors() );
459 
460  $this->assertSame(
461  'botpasswords-toolong-restrictions',
462  $status->getErrors()[0]['message']
463  );
464 
465  $this->assertSame(
466  'botpasswords-toolong-grants',
467  $status->getErrors()[1]['message']
468  );
469  }
470 }
$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
BotPasswordTest\setUp
setUp()
Definition: BotPasswordTest.php:19
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
MediaWikiTestCase\assertArrayEquals
assertArrayEquals(array $expected, array $actual, $ordered=false, $named=false)
Assert that two arrays are equal.
Definition: MediaWikiTestCase.php:1771
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWikiTestCase\mergeMwGlobalArrayValue
mergeMwGlobalArrayValue( $name, $values)
Merges the given values into a MW global array variable.
Definition: MediaWikiTestCase.php:813
EmptyBagOStuff
A BagOStuff object with no objects in it.
Definition: EmptyBagOStuff.php:29
BotPasswordTest\testInvalidateAllPasswordsForUser
testInvalidateAllPasswordsForUser()
Definition: BotPasswordTest.php:209
MultiConfig
Provides a fallback sequence for Config objects.
Definition: MultiConfig.php:28
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
HashConfig
A Config instance which stores all settings as a member variable.
Definition: HashConfig.php:28
BotPasswordTest\testGetPassword
testGetPassword()
Definition: BotPasswordTest.php:186
BotPassword\getSeparator
static getSeparator()
Get the separator for combined user name + app ID.
Definition: BotPassword.php:244
BotPasswordTest\testSaveValidation
testSaveValidation()
Tests for error handling when bp_restrictions and bp_grants are too long.
Definition: BotPasswordTest.php:431
BotPasswordTest\$testUser
TestUser $testUser
Definition: BotPasswordTest.php:14
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
MediaWiki\Session\TestUtils\setSessionManagerSingleton
static setSessionManagerSingleton(SessionManager $manager=null)
Override the singleton for unit testing.
Definition: TestUtils.php:18
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
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
TestUser
Wraps the user object, so we can also retain full access to properties like password if we log in via...
Definition: TestUser.php:7
BotPasswordTest\testSave
testSave( $password)
provideSave
Definition: BotPasswordTest.php:352
BotPassword\newUnsaved
static newUnsaved(array $data, $flags=self::READ_NORMAL)
Create an unsaved BotPassword.
Definition: BotPassword.php:149
BotPassword\RESTRICTIONS_MAXLENGTH
const RESTRICTIONS_MAXLENGTH
Maximum length of the json representation of restrictions.
Definition: BotPassword.php:37
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
BotPasswordTest\testCanonicalizeLoginData
testCanonicalizeLoginData( $username, $password, $expectedResult)
provideCanonicalizeLoginData
Definition: BotPasswordTest.php:236
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:678
MediaWikiTestCase
Definition: MediaWikiTestCase.php:17
BotPasswordTest\addDBData
addDBData()
Stub.
Definition: BotPasswordTest.php:61
MediaWiki
A helper class for throttling authentication attempts.
DB_MASTER
const DB_MASTER
Definition: defines.php:29
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
CentralIdLookup\resetCache
static resetCache()
Reset internal cache for unit testing.
Definition: CentralIdLookup.php:101
MediaWikiTestCase\getMutableTestUser
static getMutableTestUser( $groups=[])
Convenience method for getting a mutable test user.
Definition: MediaWikiTestCase.php:165
BotPassword\invalidateAllPasswordsForUser
static invalidateAllPasswordsForUser( $username)
Invalidate all passwords for a user, by name.
Definition: BotPassword.php:380
BotPasswordTest\testRemoveAllPasswordsForUser
testRemoveAllPasswordsForUser()
Definition: BotPasswordTest.php:223
MediaWiki\Session\SessionManager
This serves as the entry point to the MediaWiki session handling system.
Definition: SessionManager.php:50
BotPasswordTest\testBasics
testBasics()
Definition: BotPasswordTest.php:96
$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
BotPasswordTest\provideCanonicalizeLoginData
provideCanonicalizeLoginData()
Definition: BotPasswordTest.php:245
BotPasswordTest\$testUserName
string $testUserName
Definition: BotPasswordTest.php:17
MWRestrictions\newFromJson
static newFromJson( $json)
Definition: MWRestrictions.php:61
MWRestrictions\newFromArray
static newFromArray(array $restrictions)
Definition: MWRestrictions.php:52
BotPasswordTest
BotPassword Database.
Definition: BotPasswordTest.php:11
$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
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
BotPasswordTest\testLogin
testLogin()
Definition: BotPasswordTest.php:261
BotPasswordTest\testUnsaved
testUnsaved()
Definition: BotPasswordTest.php:121
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
BotPasswordTest\provideSave
static provideSave()
Definition: BotPasswordTest.php:421