wiki.techinc.nl/tests/phpunit/includes/upload/UploadFromUrlTest.php
Umherirrender bc1af02d62 upload: Add missing documentation to class properties
Add doc-typehints to class properties found by the PropertyDocumentation
sniff to improve the documentation.

Once the sniff is enabled it avoids that new code is missing type
declarations. This is focused on documentation and does not change code.

Change-Id: I07ce1f37d1bfb18d6e73dd008a712b3ca60a80e9
2024-09-04 20:09:32 +00:00

309 lines
9.3 KiB
PHP

<?php
use MediaWiki\MainConfigNames;
use MediaWiki\Page\File\FileDeleteForm;
use MediaWiki\Tests\Api\ApiTestCase;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use Wikimedia\TestingAccessWrapper;
/**
* @group large
* @group Upload
* @group Database
*
* @covers \UploadFromUrl
*/
class UploadFromUrlTest extends ApiTestCase {
use MockHttpTrait;
/** @var User */
private $user;
protected function setUp(): void {
parent::setUp();
$this->user = $this->getTestSysop()->getUser();
$this->overrideConfigValues( [
MainConfigNames::EnableUploads => true,
MainConfigNames::AllowCopyUploads => true,
] );
$this->setGroupPermissions( 'sysop', 'upload_by_url', true );
if ( $this->getServiceContainer()->getRepoGroup()->getLocalRepo()
->newFile( 'UploadFromUrlTest.png' )->exists()
) {
$this->deleteFile( 'UploadFromUrlTest.png' );
}
$this->installMockHttp();
}
/**
* Ensure that the job queue is empty before continuing
*/
public function testClearQueue() {
$jobQueueGroup = $this->getServiceContainer()->getJobQueueGroup();
$job = $jobQueueGroup->pop();
while ( $job ) {
$job = $jobQueueGroup->pop();
}
$this->assertFalse( $job );
}
public function testIsAllowedHostEmpty() {
$this->overrideConfigValues( [
MainConfigNames::CopyUploadsDomains => [],
MainConfigNames::CopyUploadAllowOnWikiDomainConfig => false,
] );
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://foo.bar' ) );
}
public function testIsAllowedHostDirectMatch() {
$this->overrideConfigValues( [
MainConfigNames::CopyUploadsDomains => [
'foo.baz',
'bar.example.baz',
],
MainConfigNames::CopyUploadAllowOnWikiDomainConfig => false,
] );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://example.com' ) );
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://foo.baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://.foo.baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://example.baz' ) );
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://bar.example.baz' ) );
}
public function testIsAllowedHostLastWildcard() {
$this->overrideConfigValues( [
MainConfigNames::CopyUploadsDomains => [
'*.baz',
],
MainConfigNames::CopyUploadAllowOnWikiDomainConfig => false,
] );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo.example' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo.example.baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo/bar.baz' ) );
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://foo.baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://subdomain.foo.baz' ) );
}
public function testIsAllowedHostWildcardInMiddle() {
$this->overrideConfigValues( [
MainConfigNames::CopyUploadsDomains => [
'foo.*.baz',
],
MainConfigNames::CopyUploadAllowOnWikiDomainConfig => false,
] );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo.baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo.bar.bar.baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo.bar.baz.baz' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo.com/.baz' ) );
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://foo.example.baz' ) );
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://foo.bar.baz' ) );
}
public function testOnWikiDomainConfigEnabled() {
$this->overrideConfigValues( [
MainConfigNames::CopyUploadsDomains => [ 'example.com' ],
MainConfigNames::CopyUploadAllowOnWikiDomainConfig => true,
] );
$messageContent = "example.org # this is a comment\n# this too is commented foo.example.com\nexample.net";
$mock = $this->createMock( MessageCache::class );
$mock->method( 'get' )->willReturn( $messageContent );
$this->setService( 'MessageCache', $mock );
$this->assertEquals(
[ 'example.com', 'example.org', 'example.net' ],
TestingAccessWrapper::newFromClass( UploadFromUrl::class )->getAllowedHosts()
);
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://example.com' ) );
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://example.org' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://foo.example.com' ) );
}
public function testOnWikiDomainConfigDisabled() {
$this->overrideConfigValues( [
MainConfigNames::CopyUploadsDomains => [ 'example.com' ],
MainConfigNames::CopyUploadAllowOnWikiDomainConfig => false,
] );
$mock = $this->createMock( MessageCache::class );
$mock->expects( $this->never() )->method( 'get' );
$this->setService( 'MessageCache', $mock );
$this->assertEquals(
[ 'example.com' ],
TestingAccessWrapper::newFromClass( UploadFromUrl::class )->getAllowedHosts()
);
$this->assertTrue( UploadFromUrl::isAllowedHost( 'https://example.com' ) );
$this->assertFalse( UploadFromUrl::isAllowedHost( 'https://example.org' ) );
}
/**
* @depends testClearQueue
*/
public function testSetupUrlDownload( $data ) {
$token = $this->user->getEditToken();
$exception = false;
try {
$this->doApiRequest( [
'action' => 'upload',
] );
} catch ( ApiUsageException $e ) {
$exception = true;
$this->assertApiErrorCode( 'missingparam', $e );
}
$this->assertTrue( $exception, "Got exception" );
$exception = false;
try {
$this->doApiRequest( [
'action' => 'upload',
'token' => $token,
], $data );
} catch ( ApiUsageException $e ) {
$exception = true;
$this->assertApiErrorCode( 'missingparam', $e );
}
$this->assertTrue( $exception, "Got exception" );
$exception = false;
try {
$this->doApiRequest( [
'action' => 'upload',
'url' => 'http://www.example.com/test.png',
'token' => $token,
], $data );
} catch ( ApiUsageException $e ) {
$exception = true;
$this->assertApiErrorCode( 'nofilename', $e );
}
$this->assertTrue( $exception, "Got exception" );
$this->getServiceContainer()->getUserGroupManager()->removeUserFromGroup( $this->user, 'sysop' );
$exception = false;
try {
$this->doApiRequest( [
'action' => 'upload',
'url' => 'http://www.example.com/test.png',
'filename' => 'UploadFromUrlTest.png',
'token' => $token,
], $data );
} catch ( ApiUsageException $e ) {
$this->assertApiErrorCode( 'permissiondenied', $e );
$exception = true;
}
$this->assertTrue( $exception, "Got exception" );
}
private function assertUploadOk( UploadBase $upload ) {
$verificationResult = $upload->verifyUpload();
if ( $verificationResult['status'] !== UploadBase::OK ) {
$this->fail(
'Upload verification returned ' . $upload->getVerificationErrorCode(
$verificationResult['status']
)
);
}
}
/**
* @depends testClearQueue
*/
public function testSyncDownload( $data ) {
$file = __DIR__ . '/../../data/upload/png-plain.png';
$this->installMockHttp( file_get_contents( $file ) );
$this->getServiceContainer()->getUserGroupManager()->addUserToGroup( $this->user, 'users' );
$data = $this->doApiRequestWithToken( [
'action' => 'upload',
'filename' => 'UploadFromUrlTest.png',
'url' => 'http://upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png',
'ignorewarnings' => true,
], $data );
$this->assertEquals( 'Success', $data[0]['upload']['result'] );
$this->deleteFile( 'UploadFromUrlTest.png' );
return $data;
}
protected function deleteFile( $name ) {
$t = Title::newFromText( $name, NS_FILE );
$this->assertTrue( $t->exists(), "File '$name' exists" );
if ( $t->exists() ) {
$file = $this->getServiceContainer()->getRepoGroup()
->findFile( $name, [ 'ignoreRedirect' => true ] );
$empty = "";
FileDeleteForm::doDelete( $t, $file, $empty, "none", true, $this->user );
$page = $this->getServiceContainer()->getWikiPageFactory()->newFromTitle( $t );
$this->deletePage( $page );
}
$t = Title::newFromText( $name, NS_FILE );
$this->assertFalse( $t->exists(), "File '$name' was deleted" );
}
public function testUploadFromUrl() {
$file = __DIR__ . '/../../data/upload/png-plain.png';
$this->installMockHttp( file_get_contents( $file ) );
$upload = new UploadFromUrl();
$upload->initialize( 'Test.png', 'http://www.example.com/test.png' );
$status = $upload->fetchFile();
$this->assertStatusOK( $status );
$this->assertUploadOk( $upload );
}
public function testUploadFromUrlWithRedirect() {
$file = __DIR__ . '/../../data/upload/png-plain.png';
$this->installMockHttp( [
// First response is a redirect
$this->makeFakeHttpRequest(
'Blaba',
302,
[ 'Location' => 'http://static.example.com/files/test.png' ]
),
// Second response is a file
$this->makeFakeHttpRequest(
file_get_contents( $file )
),
] );
$upload = new UploadFromUrl();
$upload->initialize( 'Test.png', 'http://www.example.com/test.png' );
$status = $upload->fetchFile();
$this->assertStatusOK( $status );
$this->assertUploadOk( $upload );
}
public function testUploadFromUrlCacheKey() {
// Test we get back a properly formatted sha1 key out
$key = UploadFromUrl::getCacheKey( [ 'filename' => 'test.png', 'url' => 'https://example.com/example.png' ] );
$this->assertNotEmpty( $key );
$this->assertMatchesRegularExpression( "/^[0-9a-f]{40}$/", $key );
}
public function testUploadFromUrlCacheKeyMissingParam() {
$this->assertSame( "", UploadFromUrl::getCacheKey( [] ) );
}
}