wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-09-25 11:17:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sanitize gadget name

Browse source 
MediaWikiGadgetsDefinition does some basic gadget name sanitization
and we have to do the same when checking "is gadget enabled for user"

Changes:
 - sanitize gadget name same way as
   MediaWikiGadgetsDefinitionRepo::newFromDefinition() does.
 - add try{} catch() when loading gadget as getGadget might throw an
   exception

Bug: T160081
Change-Id: Ia7a57e9dcfa3b25129d6d2bf75795372fad2b251
This commit is contained in:
Piotr Miazga 2017-04-11 00:27:19 +02:00 committed by Jdlrobson
parent 037179b263
commit 9590284c70
2 changed files with 106 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
includes/PopupsGadgetsIntegration.php
View file

@ -51,9 +51,19 @@ class PopupsGadgetsIntegration {
*/
public function __construct( Config $config , ExtensionRegistry $extensionRegistry ) {
$this->extensionRegistry = $extensionRegistry;
$this->navPopupsGadgetName = $config->get( self::CONFIG_NAVIGATION_POPUPS_NAME );
$this->navPopupsGadgetName = $this->sanitizeGadgetName(
$config->get( self::CONFIG_NAVIGATION_POPUPS_NAME ) );
}
/**
* Sanitize gadget name
*
* @param $gadgetName
* @return string
*/
private function sanitizeGadgetName( $gadgetName ) {
return str_replace( ' ', '_', trim( $gadgetName ) );
}
/**
* @return bool
*/
@ -73,7 +83,12 @@ class PopupsGadgetsIntegration {
$gadgetsRepo = \GadgetRepo::singleton();
$match = array_search( $this->navPopupsGadgetName, $gadgetsRepo->getGadgetIds() );
if ( $match !== false ) {
return $gadgetsRepo->getGadget( $this->navPopupsGadgetName )->isEnabled( $user );
try {
return $gadgetsRepo->getGadget( $this->navPopupsGadgetName )
->isEnabled( $user );
} catch ( \InvalidArgumentException $e ) {
return false;
}
}
}
return false;

96
tests/phpunit/PopupsGadgetsIntegrationTest.php
View file

@ -106,8 +106,8 @@ class PopupsGadgetsIntegrationTest extends MediaWikiTestCase
->method( 'getGadgetIds' )
->willReturn( [] );
$this->executeConflictsWithNavPopupsGadgetSafeCheck( $user, $gadgetRepoMock,
self::GADGET_DISABLED );
$this->executeConflictsWithNavPopupsGadgetSafeCheck( $user, $this->getConfigMock(),
$gadgetRepoMock, self::GADGET_DISABLED );
}
/**
@ -132,7 +132,7 @@ class PopupsGadgetsIntegrationTest extends MediaWikiTestCase
[ 'getGadgetIds', 'getGadget' ] );
$gadgetRepoMock->expects( $this->once() )
->method( 'getGadgetids' )
->method( 'getGadgetIds' )
->willReturn( [ self::NAV_POPUPS_GADGET_NAME ] );
$gadgetRepoMock->expects( $this->once() )
@ -140,22 +140,104 @@ class PopupsGadgetsIntegrationTest extends MediaWikiTestCase
->with( self::NAV_POPUPS_GADGET_NAME )
->willReturn( $gadgetMock );
$this->executeConflictsWithNavPopupsGadgetSafeCheck( $user, $gadgetRepoMock,
$this->executeConflictsWithNavPopupsGadgetSafeCheck( $user, $this->getConfigMock(),
$gadgetRepoMock, self::GADGET_ENABLED );
}
/**
* Test the edge case when GadgetsRepo::getGadget throws an exception
* @covers ::conflictsWithNavPopupsGadget
*/
public function testConflictsWithNavPopupsGadgetWhenGadgetNotExists() {
$this->checkRequiredDependencies();
$user = $this->getTestUser()->getUser();
$gadgetRepoMock = $this->getMock( GadgetRepo::class,
[ 'getGadgetIds', 'getGadget' ] );
$gadgetRepoMock->expects( $this->once() )
->method( 'getGadgetIds' )
->willReturn( [ self::NAV_POPUPS_GADGET_NAME ] );
$gadgetRepoMock->expects( $this->once() )
->method( 'getGadget' )
->with( self::NAV_POPUPS_GADGET_NAME )
->willThrowException( new InvalidArgumentException() );
$this->executeConflictsWithNavPopupsGadgetSafeCheck( $user, $this->getConfigMock(),
$gadgetRepoMock, self::GADGET_DISABLED );
}
/**
* @covers ::sanitizeGadgetName
* @dataProvider provideGadgetNamesWithSanitizedVersion
*/
public function testConflictsWithNavPopupsGadgetNameSanitization( $name, $sanitized ) {
$this->checkRequiredDependencies();
$user = $this->getTestUser()->getUser();
$configMock = $this->getMockBuilder( 'Config' )
->setMethods( [ 'get', 'has' ] )
->getMock();
$configMock->expects( $this->once() )
->method( 'get' )
->with( PopupsGadgetsIntegration::CONFIG_NAVIGATION_POPUPS_NAME )
->willReturn( $name );
$gadgetMock = $this->getMockBuilder( Gadget::class )
->setMethods( [ 'isEnabled' ] )
->disableOriginalConstructor()
->getMock();
$gadgetMock->expects( $this->once() )
->method( 'isEnabled' )
->willReturn( self::GADGET_ENABLED );
$gadgetRepoMock = $this->getMock( GadgetRepo::class,
[ 'getGadgetIds', 'getGadget' ] );
$gadgetRepoMock->expects( $this->once() )
->method( 'getGadgetIds' )
->willReturn( [ $sanitized ] );
$gadgetRepoMock->expects( $this->once() )
->method( 'getGadget' )
->with( $sanitized )
->willReturn( $gadgetMock );
$this->executeConflictsWithNavPopupsGadgetSafeCheck( $user, $configMock, $gadgetRepoMock,
self::GADGET_ENABLED );
}
/**
* Execute test and restore orGadgetRepo
* @return array
*/
public function provideGadgetNamesWithSanitizedVersion() {
return [
[ ' Popups ', 'Popups' ],
[ 'Navigation_popups-API', 'Navigation_popups-API' ],
[ 'Navigation popups ', 'Navigation_popups' ]
];
}
/**
* Execute test and restore GadgetRepo
*
* @param $user
* @param $config
* @param $repoMock
* @param $expected
*/
private function executeConflictsWithNavPopupsGadgetSafeCheck( $user, $repoMock, $expected ) {
private function executeConflictsWithNavPopupsGadgetSafeCheck( $user, $config, $repoMock,
$expected ) {
$origGadgetsRepo = GadgetRepo::singleton();
GadgetRepo::setSingleton( $repoMock );
$integration = new PopupsGadgetsIntegration( $this->getConfigMock(),
$integration = new PopupsGadgetsIntegration( $config,
$this->getExtensionRegistryMock( true ) );
$this->assertEquals( $expected, $integration->conflictsWithNavPopupsGadget( $user ) );