Page MenuHomeWickedGov Phorge
Files F4034530

ApiUploadTestCase.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

ApiUploadTestCase.php
View Options

<?php
namespace MediaWiki\Tests\Api;
use Exception;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\File\FileDeleteForm;
use MediaWiki\Title\Title;
use Wikimedia\FileBackend\FSFile\FSFile;
use Wikimedia\Rdbms\IDBAccessObject;
/**
* Abstract class to support upload tests
*/
abstract class ApiUploadTestCase extends ApiTestCase {
/**
* @since 1.37
* @var array Used to fake $_FILES in tests and given to MediaWiki\Request\FauxRequest
*/
protected $requestDataFiles = [];
/**
* Fixture -- run before every test
*/
protected function setUp(): void {
parent::setUp();
$this->overrideConfigValue( MainConfigNames::EnableUploads, true );
$this->clearFakeUploads();
}
/**
* Helper function -- remove files and associated articles by Title
*
* @param Title $title Title to be removed
*
* @return bool
*/
public function deleteFileByTitle( $title ) {
if ( $title->exists() ) {
$file = $this->getServiceContainer()->getRepoGroup()
->findFile( $title, [ 'ignoreRedirect' => true ] );
$noOldArchive = ""; // yes this really needs to be set this way
$comment = "removing for test";
$restrictDeletedVersions = false;
$user = $this->getTestSysop()->getUser();
$status = FileDeleteForm::doDelete(
$title,
$file,
$noOldArchive,
$comment,
$restrictDeletedVersions,
$user
);
if ( !$status->isGood() ) {
return false;
}
$page = $this->getServiceContainer()->getWikiPageFactory()->newFromTitle( $title );
$this->deletePage( $page, "removing for test" );
}
return !( $title && $title instanceof Title && $title->exists( IDBAccessObject::READ_LATEST ) );
}
/**
* Helper function -- remove files and associated articles with a particular filename
*
* @param string $fileName Filename to be removed
*
* @return bool
*/
public function deleteFileByFileName( $fileName ) {
return $this->deleteFileByTitle( Title::newFromText( $fileName, NS_FILE ) );
}
/**
* Helper function -- given a file on the filesystem, find matching
* content in the db (and associated articles) and remove them.
*
* @param string $filePath Path to file on the filesystem
*
* @return bool
*/
public function deleteFileByContent( $filePath ) {
$hash = FSFile::getSha1Base36FromPath( $filePath );
$dupes = $this->getServiceContainer()->getRepoGroup()->findBySha1( $hash );
$success = true;
foreach ( $dupes as $dupe ) {
$success &= $this->deleteFileByTitle( $dupe->getTitle() );
}
return $success;
}
/**
* Fake an upload by dumping the file into temp space, and adding info to $_FILES.
* (This is what PHP would normally do).
*
* @param string $fieldName Name this would have in the upload form
* @param string $fileName Name to title this
* @param string $type MIME type
* @param string $filePath Path where to find file contents
*
* @throws Exception
* @return bool
*/
protected function fakeUploadFile( $fieldName, $fileName, $type, $filePath ) {
$tmpName = $this->getNewTempFile();
if ( !is_file( $filePath ) ) {
$this->fail( "$filePath doesn't exist!" );
}
if ( !copy( $filePath, $tmpName ) ) {
$this->fail( "couldn't copy $filePath to $tmpName" );
}
clearstatcache();
$size = filesize( $tmpName );
if ( $size === false ) {
$this->fail( "couldn't stat $tmpName" );
}
$this->requestDataFiles[$fieldName] = [
'name' => $fileName,
'type' => $type,
'tmp_name' => $tmpName,
'size' => $size,
'error' => UPLOAD_ERR_OK,
];
return true;
}
public function fakeUploadChunk( $fieldName, $fileName, $type, &$chunkData ) {
$tmpName = $this->getNewTempFile();
// copy the chunk data to temp location:
if ( !file_put_contents( $tmpName, $chunkData ) ) {
$this->fail( "couldn't copy chunk data to $tmpName" );
}
clearstatcache();
$size = filesize( $tmpName );
if ( $size === false ) {
$this->fail( "couldn't stat $tmpName" );
}
$this->requestDataFiles[$fieldName] = [
'name' => $fileName,
'type' => $type,
'tmp_name' => $tmpName,
'size' => $size,
'error' => UPLOAD_ERR_OK,
];
}
/** @inheritDoc */
protected function buildFauxRequest( $params, $session ) {
$request = parent::buildFauxRequest( $params, $session );
$request->setUploadData( $this->requestDataFiles );
return $request;
}
/**
* Remove traces of previous fake uploads
*/
public function clearFakeUploads() {
$this->requestDataFiles = [];
}
}
/** @deprecated class alias since 1.42 */
class_alias( ApiUploadTestCase::class, 'ApiUploadTestCase' );

File Metadata

Mime Type
text/x-php
Expires
Aug 15 2026, 01:28 (12 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
3e/cf/9a00d0c309611242b0705b7db90d
Default Alt Text
ApiUploadTestCase.php (4 KB)

Event Timeline