MediaWiki  1.28.0
FileTest.php
Go to the documentation of this file.
1 <?php
2 
4 
10  function testCanAnimateThumbIfAppropriate( $filename, $expected ) {
11  $this->setMwGlobals( 'wgMaxAnimatedGifArea', 9000 );
12  $file = $this->dataFile( $filename );
13  $this->assertEquals( $file->canAnimateThumbIfAppropriate(), $expected );
14  }
15 
16  function providerCanAnimate() {
17  return [
18  [ 'nonanimated.gif', true ],
19  [ 'jpeg-comment-utf.jpg', true ],
20  [ 'test.tiff', true ],
21  [ 'Animated_PNG_example_bouncing_beach_ball.png', false ],
22  [ 'greyscale-png.png', true ],
23  [ 'Toll_Texas_1.svg', true ],
24  [ 'LoremIpsum.djvu', true ],
25  [ '80x60-2layers.xcf', true ],
26  [ 'Soccer_ball_animated.svg', false ],
27  [ 'Bishzilla_blink.gif', false ],
28  [ 'animated.gif', true ],
29  ];
30  }
31 
36  public function testGetThumbnailBucket( $data ) {
37  $this->setMwGlobals( 'wgThumbnailBuckets', $data['buckets'] );
38  $this->setMwGlobals( 'wgThumbnailMinimumBucketDistance', $data['minimumBucketDistance'] );
39 
40  $fileMock = $this->getMockBuilder( 'File' )
41  ->setConstructorArgs( [ 'fileMock', false ] )
42  ->setMethods( [ 'getWidth' ] )
43  ->getMockForAbstractClass();
44 
45  $fileMock->expects( $this->any() )
46  ->method( 'getWidth' )
47  ->will( $this->returnValue( $data['width'] ) );
48 
49  $this->assertEquals(
50  $data['expectedBucket'],
51  $fileMock->getThumbnailBucket( $data['requestedWidth'] ),
52  $data['message'] );
53  }
54 
55  public function getThumbnailBucketProvider() {
56  $defaultBuckets = [ 256, 512, 1024, 2048, 4096 ];
57 
58  return [
59  [ [
60  'buckets' => $defaultBuckets,
61  'minimumBucketDistance' => 0,
62  'width' => 3000,
63  'requestedWidth' => 120,
64  'expectedBucket' => 256,
65  'message' => 'Picking bucket bigger than requested size'
66  ] ],
67  [ [
68  'buckets' => $defaultBuckets,
69  'minimumBucketDistance' => 0,
70  'width' => 3000,
71  'requestedWidth' => 300,
72  'expectedBucket' => 512,
73  'message' => 'Picking bucket bigger than requested size'
74  ] ],
75  [ [
76  'buckets' => $defaultBuckets,
77  'minimumBucketDistance' => 0,
78  'width' => 3000,
79  'requestedWidth' => 1024,
80  'expectedBucket' => 2048,
81  'message' => 'Picking bucket bigger than requested size'
82  ] ],
83  [ [
84  'buckets' => $defaultBuckets,
85  'minimumBucketDistance' => 0,
86  'width' => 3000,
87  'requestedWidth' => 2048,
88  'expectedBucket' => false,
89  'message' => 'Picking no bucket because none is bigger than the requested size'
90  ] ],
91  [ [
92  'buckets' => $defaultBuckets,
93  'minimumBucketDistance' => 0,
94  'width' => 3000,
95  'requestedWidth' => 3500,
96  'expectedBucket' => false,
97  'message' => 'Picking no bucket because requested size is bigger than original'
98  ] ],
99  [ [
100  'buckets' => [ 1024 ],
101  'minimumBucketDistance' => 0,
102  'width' => 3000,
103  'requestedWidth' => 1024,
104  'expectedBucket' => false,
105  'message' => 'Picking no bucket because requested size equals biggest bucket'
106  ] ],
107  [ [
108  'buckets' => null,
109  'minimumBucketDistance' => 0,
110  'width' => 3000,
111  'requestedWidth' => 1024,
112  'expectedBucket' => false,
113  'message' => 'Picking no bucket because no buckets have been specified'
114  ] ],
115  [ [
116  'buckets' => [ 256, 512 ],
117  'minimumBucketDistance' => 10,
118  'width' => 3000,
119  'requestedWidth' => 245,
120  'expectedBucket' => 256,
121  'message' => 'Requested width is distant enough from next bucket for it to be picked'
122  ] ],
123  [ [
124  'buckets' => [ 256, 512 ],
125  'minimumBucketDistance' => 10,
126  'width' => 3000,
127  'requestedWidth' => 246,
128  'expectedBucket' => 512,
129  'message' => 'Requested width is too close to next bucket, picking next one'
130  ] ],
131  ];
132  }
133 
138  public function testGetThumbnailSource( $data ) {
139  $backendMock = $this->getMockBuilder( 'FSFileBackend' )
140  ->setConstructorArgs( [ [ 'name' => 'backendMock', 'wikiId' => wfWikiID() ] ] )
141  ->getMock();
142 
143  $repoMock = $this->getMockBuilder( 'FileRepo' )
144  ->setConstructorArgs( [ [ 'name' => 'repoMock', 'backend' => $backendMock ] ] )
145  ->setMethods( [ 'fileExists', 'getLocalReference' ] )
146  ->getMock();
147 
148  $fsFile = new FSFile( 'fsFilePath' );
149 
150  $repoMock->expects( $this->any() )
151  ->method( 'fileExists' )
152  ->will( $this->returnValue( true ) );
153 
154  $repoMock->expects( $this->any() )
155  ->method( 'getLocalReference' )
156  ->will( $this->returnValue( $fsFile ) );
157 
158  $handlerMock = $this->getMock( 'BitmapHandler', [ 'supportsBucketing' ] );
159  $handlerMock->expects( $this->any() )
160  ->method( 'supportsBucketing' )
161  ->will( $this->returnValue( $data['supportsBucketing'] ) );
162 
163  $fileMock = $this->getMockBuilder( 'File' )
164  ->setConstructorArgs( [ 'fileMock', $repoMock ] )
165  ->setMethods( [ 'getThumbnailBucket', 'getLocalRefPath', 'getHandler' ] )
166  ->getMockForAbstractClass();
167 
168  $fileMock->expects( $this->any() )
169  ->method( 'getThumbnailBucket' )
170  ->will( $this->returnValue( $data['thumbnailBucket'] ) );
171 
172  $fileMock->expects( $this->any() )
173  ->method( 'getLocalRefPath' )
174  ->will( $this->returnValue( 'localRefPath' ) );
175 
176  $fileMock->expects( $this->any() )
177  ->method( 'getHandler' )
178  ->will( $this->returnValue( $handlerMock ) );
179 
180  $reflection = new ReflectionClass( $fileMock );
181  $reflection_property = $reflection->getProperty( 'handler' );
182  $reflection_property->setAccessible( true );
183  $reflection_property->setValue( $fileMock, $handlerMock );
184 
185  if ( !is_null( $data['tmpBucketedThumbCache'] ) ) {
186  $reflection_property = $reflection->getProperty( 'tmpBucketedThumbCache' );
187  $reflection_property->setAccessible( true );
188  $reflection_property->setValue( $fileMock, $data['tmpBucketedThumbCache'] );
189  }
190 
191  $result = $fileMock->getThumbnailSource(
192  [ 'physicalWidth' => $data['physicalWidth'] ] );
193 
194  $this->assertEquals( $data['expectedPath'], $result['path'], $data['message'] );
195  }
196 
197  public function getThumbnailSourceProvider() {
198  return [
199  [ [
200  'supportsBucketing' => true,
201  'tmpBucketedThumbCache' => null,
202  'thumbnailBucket' => 1024,
203  'physicalWidth' => 2048,
204  'expectedPath' => 'fsFilePath',
205  'message' => 'Path downloaded from storage'
206  ] ],
207  [ [
208  'supportsBucketing' => true,
209  'tmpBucketedThumbCache' => [ 1024 => '/tmp/shouldnotexist' . rand() ],
210  'thumbnailBucket' => 1024,
211  'physicalWidth' => 2048,
212  'expectedPath' => 'fsFilePath',
213  'message' => 'Path downloaded from storage because temp file is missing'
214  ] ],
215  [ [
216  'supportsBucketing' => true,
217  'tmpBucketedThumbCache' => [ 1024 => '/tmp' ],
218  'thumbnailBucket' => 1024,
219  'physicalWidth' => 2048,
220  'expectedPath' => '/tmp',
221  'message' => 'Temporary path because temp file was found'
222  ] ],
223  [ [
224  'supportsBucketing' => false,
225  'tmpBucketedThumbCache' => null,
226  'thumbnailBucket' => 1024,
227  'physicalWidth' => 2048,
228  'expectedPath' => 'localRefPath',
229  'message' => 'Original file path because bucketing is unsupported by handler'
230  ] ],
231  [ [
232  'supportsBucketing' => true,
233  'tmpBucketedThumbCache' => null,
234  'thumbnailBucket' => false,
235  'physicalWidth' => 2048,
236  'expectedPath' => 'localRefPath',
237  'message' => 'Original file path because no width provided'
238  ] ],
239  ];
240  }
241 
246  public function testGenerateBucketsIfNeeded( $data ) {
247  $this->setMwGlobals( 'wgThumbnailBuckets', $data['buckets'] );
248 
249  $backendMock = $this->getMockBuilder( 'FSFileBackend' )
250  ->setConstructorArgs( [ [ 'name' => 'backendMock', 'wikiId' => wfWikiID() ] ] )
251  ->getMock();
252 
253  $repoMock = $this->getMockBuilder( 'FileRepo' )
254  ->setConstructorArgs( [ [ 'name' => 'repoMock', 'backend' => $backendMock ] ] )
255  ->setMethods( [ 'fileExists', 'getLocalReference' ] )
256  ->getMock();
257 
258  $fileMock = $this->getMockBuilder( 'File' )
259  ->setConstructorArgs( [ 'fileMock', $repoMock ] )
260  ->setMethods( [ 'getWidth', 'getBucketThumbPath', 'makeTransformTmpFile',
261  'generateAndSaveThumb', 'getHandler' ] )
262  ->getMockForAbstractClass();
263 
264  $handlerMock = $this->getMock( 'JpegHandler', [ 'supportsBucketing' ] );
265  $handlerMock->expects( $this->any() )
266  ->method( 'supportsBucketing' )
267  ->will( $this->returnValue( true ) );
268 
269  $fileMock->expects( $this->any() )
270  ->method( 'getHandler' )
271  ->will( $this->returnValue( $handlerMock ) );
272 
273  $reflectionMethod = new ReflectionMethod( 'File', 'generateBucketsIfNeeded' );
274  $reflectionMethod->setAccessible( true );
275 
276  $fileMock->expects( $this->any() )
277  ->method( 'getWidth' )
278  ->will( $this->returnValue( $data['width'] ) );
279 
280  $fileMock->expects( $data['expectedGetBucketThumbPathCalls'] )
281  ->method( 'getBucketThumbPath' );
282 
283  $repoMock->expects( $data['expectedFileExistsCalls'] )
284  ->method( 'fileExists' )
285  ->will( $this->returnValue( $data['fileExistsReturn'] ) );
286 
287  $fileMock->expects( $data['expectedMakeTransformTmpFile'] )
288  ->method( 'makeTransformTmpFile' )
289  ->will( $this->returnValue( $data['makeTransformTmpFileReturn'] ) );
290 
291  $fileMock->expects( $data['expectedGenerateAndSaveThumb'] )
292  ->method( 'generateAndSaveThumb' )
293  ->will( $this->returnValue( $data['generateAndSaveThumbReturn'] ) );
294 
295  $this->assertEquals( $data['expectedResult'],
296  $reflectionMethod->invoke(
297  $fileMock,
298  [
299  'physicalWidth' => $data['physicalWidth'],
300  'physicalHeight' => $data['physicalHeight'] ]
301  ),
302  $data['message'] );
303  }
304 
306  $defaultBuckets = [ 256, 512, 1024, 2048, 4096 ];
307 
308  return [
309  [ [
310  'buckets' => $defaultBuckets,
311  'width' => 256,
312  'physicalWidth' => 256,
313  'physicalHeight' => 100,
314  'expectedGetBucketThumbPathCalls' => $this->never(),
315  'expectedFileExistsCalls' => $this->never(),
316  'fileExistsReturn' => null,
317  'expectedMakeTransformTmpFile' => $this->never(),
318  'makeTransformTmpFileReturn' => false,
319  'expectedGenerateAndSaveThumb' => $this->never(),
320  'generateAndSaveThumbReturn' => false,
321  'expectedResult' => false,
322  'message' => 'No bucket found, nothing to generate'
323  ] ],
324  [ [
325  'buckets' => $defaultBuckets,
326  'width' => 5000,
327  'physicalWidth' => 300,
328  'physicalHeight' => 200,
329  'expectedGetBucketThumbPathCalls' => $this->once(),
330  'expectedFileExistsCalls' => $this->once(),
331  'fileExistsReturn' => true,
332  'expectedMakeTransformTmpFile' => $this->never(),
333  'makeTransformTmpFileReturn' => false,
334  'expectedGenerateAndSaveThumb' => $this->never(),
335  'generateAndSaveThumbReturn' => false,
336  'expectedResult' => false,
337  'message' => 'File already exists, no reason to generate buckets'
338  ] ],
339  [ [
340  'buckets' => $defaultBuckets,
341  'width' => 5000,
342  'physicalWidth' => 300,
343  'physicalHeight' => 200,
344  'expectedGetBucketThumbPathCalls' => $this->once(),
345  'expectedFileExistsCalls' => $this->once(),
346  'fileExistsReturn' => false,
347  'expectedMakeTransformTmpFile' => $this->once(),
348  'makeTransformTmpFileReturn' => false,
349  'expectedGenerateAndSaveThumb' => $this->never(),
350  'generateAndSaveThumbReturn' => false,
351  'expectedResult' => false,
352  'message' => 'Cannot generate temp file for bucket'
353  ] ],
354  [ [
355  'buckets' => $defaultBuckets,
356  'width' => 5000,
357  'physicalWidth' => 300,
358  'physicalHeight' => 200,
359  'expectedGetBucketThumbPathCalls' => $this->once(),
360  'expectedFileExistsCalls' => $this->once(),
361  'fileExistsReturn' => false,
362  'expectedMakeTransformTmpFile' => $this->once(),
363  'makeTransformTmpFileReturn' => new TempFSFile( '/tmp/foo' ),
364  'expectedGenerateAndSaveThumb' => $this->once(),
365  'generateAndSaveThumbReturn' => false,
366  'expectedResult' => false,
367  'message' => 'Bucket image could not be generated'
368  ] ],
369  [ [
370  'buckets' => $defaultBuckets,
371  'width' => 5000,
372  'physicalWidth' => 300,
373  'physicalHeight' => 200,
374  'expectedGetBucketThumbPathCalls' => $this->once(),
375  'expectedFileExistsCalls' => $this->once(),
376  'fileExistsReturn' => false,
377  'expectedMakeTransformTmpFile' => $this->once(),
378  'makeTransformTmpFileReturn' => new TempFSFile( '/tmp/foo' ),
379  'expectedGenerateAndSaveThumb' => $this->once(),
380  'generateAndSaveThumbReturn' => new ThumbnailImage( false, 'bar', false, false ),
381  'expectedResult' => true,
382  'message' => 'Bucket image could not be generated'
383  ] ],
384  ];
385  }
386 }
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
This class is used to hold the location and do limited manipulation of files stored temporarily (this...
Definition: TempFSFile.php:30
getThumbnailSourceProvider()
Definition: FileTest.php:197
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. '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 '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
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:1936
Media transform output for images.
dataFile($name, $type=null)
Utility function: Get a new file object for a file on disk but not actually in db.
providerCanAnimate()
Definition: FileTest.php:16
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
testGetThumbnailSource($data)
getThumbnailSourceProvider File::getThumbnailSource
Definition: FileTest.php:138
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:35
Class representing a non-directory file on the file system.
Definition: FSFile.php:29
getThumbnailBucketProvider()
Definition: FileTest.php:55
generateBucketsIfNeededProvider()
Definition: FileTest.php:305
testGenerateBucketsIfNeeded($data)
generateBucketsIfNeededProvider File::generateBucketsIfNeeded
Definition: FileTest.php:246
testCanAnimateThumbIfAppropriate($filename, $expected)
Definition: FileTest.php:10
setMwGlobals($pairs, $value=null)
testGetThumbnailBucket($data)
getThumbnailBucketProvider File::getThumbnailBucket
Definition: FileTest.php:36
Specificly for testing Media handlers.