tests/phpunit/includes/api/ApiTestCaseUpload.php

   1 <?php
   2
   3 /**
   4  * Abstract class to support upload tests
   5  */
   6 abstract class ApiTestCaseUpload extends ApiTestCase {
   7         /**
   8          * Fixture -- run before every test
   9          */
  10         protected function setUp() {
  11                 parent::setUp();
  12
  13                 $this->setMwGlobals( [
  14                         'wgEnableUploads' => true,
  15                         'wgEnableAPI' => true,
  16                 ] );
  17
  18                 $this->clearFakeUploads();
  19         }
  20
  21         /**
  22          * Helper function -- remove files and associated articles by Title
  23          *
  24          * @param Title $title Title to be removed
  25          *
  26          * @return bool
  27          */
  28         public function deleteFileByTitle( $title ) {
  29                 if ( $title->exists() ) {
  30                         $file = wfFindFile( $title, [ 'ignoreRedirect' => true ] );
  31                         $noOldArchive = ""; // yes this really needs to be set this way
  32                         $comment = "removing for test";
  33                         $restrictDeletedVersions = false;
  34                         $status = FileDeleteForm::doDelete(
  35                                 $title,
  36                                 $file,
  37                                 $noOldArchive,
  38                                 $comment,
  39                                 $restrictDeletedVersions
  40                         );
  41
  42                         if ( !$status->isGood() ) {
  43                                 return false;
  44                         }
  45
  46                         $page = WikiPage::factory( $title );
  47                         $page->doDeleteArticle( "removing for test" );
  48
  49                         // see if it now doesn't exist; reload
  50                         $title = Title::newFromText( $title->getText(), NS_FILE );
  51                 }
  52
  53                 return !( $title && $title instanceof Title && $title->exists() );
  54         }
  55
  56         /**
  57          * Helper function -- remove files and associated articles with a particular filename
  58          *
  59          * @param string $fileName Filename to be removed
  60          *
  61          * @return bool
  62          */
  63         public function deleteFileByFileName( $fileName ) {
  64                 return $this->deleteFileByTitle( Title::newFromText( $fileName, NS_FILE ) );
  65         }
  66
  67         /**
  68          * Helper function -- given a file on the filesystem, find matching
  69          * content in the db (and associated articles) and remove them.
  70          *
  71          * @param string $filePath Path to file on the filesystem
  72          *
  73          * @return bool
  74          */
  75         public function deleteFileByContent( $filePath ) {
  76                 $hash = FSFile::getSha1Base36FromPath( $filePath );
  77                 $dupes = RepoGroup::singleton()->findBySha1( $hash );
  78                 $success = true;
  79                 foreach ( $dupes as $dupe ) {
  80                         $success &= $this->deleteFileByTitle( $dupe->getTitle() );
  81                 }
  82
  83                 return $success;
  84         }
  85
  86         /**
  87          * Fake an upload by dumping the file into temp space, and adding info to $_FILES.
  88          * (This is what PHP would normally do).
  89          *
  90          * @param string $fieldName Name this would have in the upload form
  91          * @param string $fileName Name to title this
  92          * @param string $type MIME type
  93          * @param string $filePath Path where to find file contents
  94          *
  95          * @throws Exception
  96          * @return bool
  97          */
  98         function fakeUploadFile( $fieldName, $fileName, $type, $filePath ) {
  99                 $tmpName = $this->getNewTempFile();
 100                 if ( !file_exists( $filePath ) ) {
 101                         throw new Exception( "$filePath doesn't exist!" );
 102                 }
 103
 104                 if ( !copy( $filePath, $tmpName ) ) {
 105                         throw new Exception( "couldn't copy $filePath to $tmpName" );
 106                 }
 107
 108                 clearstatcache();
 109                 $size = filesize( $tmpName );
 110                 if ( $size === false ) {
 111                         throw new Exception( "couldn't stat $tmpName" );
 112                 }
 113
 114                 $_FILES[$fieldName] = [
 115                         'name' => $fileName,
 116                         'type' => $type,
 117                         'tmp_name' => $tmpName,
 118                         'size' => $size,
 119                         'error' => null
 120                 ];
 121
 122                 return true;
 123         }
 124
 125         function fakeUploadChunk( $fieldName, $fileName, $type, & $chunkData ) {
 126                 $tmpName = $this->getNewTempFile();
 127                 // copy the chunk data to temp location:
 128                 if ( !file_put_contents( $tmpName, $chunkData ) ) {
 129                         throw new Exception( "couldn't copy chunk data to $tmpName" );
 130                 }
 131
 132                 clearstatcache();
 133                 $size = filesize( $tmpName );
 134                 if ( $size === false ) {
 135                         throw new Exception( "couldn't stat $tmpName" );
 136                 }
 137
 138                 $_FILES[$fieldName] = [
 139                         'name' => $fileName,
 140                         'type' => $type,
 141                         'tmp_name' => $tmpName,
 142                         'size' => $size,
 143                         'error' => null
 144                 ];
 145         }
 146
 147         /**
 148          * Remove traces of previous fake uploads
 149          */
 150         function clearFakeUploads() {
 151                 $_FILES = [];
 152         }
 153 }