MediaWiki  master
MWFileProps.php
Go to the documentation of this file.
1 <?php
28 class MWFileProps {
30  private $magic;
31 
35  public function __construct( MimeAnalyzer $magic ) {
36  $this->magic = $magic;
37  }
38 
64  public function getPropsFromPath( $path, $ext ) {
65  $fsFile = new FSFile( $path );
66 
67  $info = $this->newPlaceholderProps();
68  $info['fileExists'] = $fsFile->exists();
69  if ( $info['fileExists'] ) {
70  $info['size'] = $fsFile->getSize(); // bytes
71  $info['sha1'] = $fsFile->getSha1Base36();
72 
73  # MIME type according to file contents
74  $info['file-mime'] = $this->magic->guessMimeType( $path, false );
75  # Logical MIME type
76  $ext = ( $ext === true ) ? FileBackend::extensionFromPath( $path ) : (string)$ext;
77 
78  # XXX: MimeAnalyzer::improveTypeFromExtension() may return null (T253483).
79  # Unclear if callers of this method expect that.
80  $info['mime'] = $this->magic->improveTypeFromExtension( $info['file-mime'], $ext );
81 
82  [ $info['major_mime'], $info['minor_mime'] ] = File::splitMime( $info['mime'] );
83  $info['media_type'] = $this->magic->getMediaType( $path, $info['mime'] );
84 
85  # Height, width and metadata
86  // @phan-suppress-next-line PhanTypeMismatchArgumentNullable See XXX above
87  $handler = MediaHandler::getHandler( $info['mime'] );
88  if ( $handler ) {
89  $sizeAndMetadata = $handler->getSizeAndMetadataWithFallback( $fsFile, $path );
90  if ( $sizeAndMetadata ) {
91  $info = $sizeAndMetadata + $info;
92  }
93  }
94  }
95 
96  return $info;
97  }
98 
119  public function newPlaceholderProps() {
120  return FSFile::placeholderProps() + [
121  'metadata' => [],
122  'width' => 0,
123  'height' => 0,
124  'bits' => 0,
125  'media_type' => MEDIATYPE_UNKNOWN
126  ];
127  }
128 }
Class representing a non-directory file on the file system.
Definition: FSFile.php:32
static placeholderProps()
Placeholder file properties to use for files that don't exist.
Definition: FSFile.php:150
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
static splitMime(?string $mime)
Split an internet media type into its two components; if not a two-part name, set the minor type to '...
Definition: File.php:309
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
getPropsFromPath( $path, $ext)
Get an associative array containing information about a file with the given storage path.
Definition: MWFileProps.php:64
newPlaceholderProps()
Empty place holder props for non-existing files.
__construct(MimeAnalyzer $magic)
Definition: MWFileProps.php:35
static getHandler( $type)
Get a MediaHandler for a given MIME type from the instance cache.
Implements functions related to MIME types such as detection and mapping to file extension.
const MEDIATYPE_UNKNOWN
Definition: defines.php:26
return true
Definition: router.php:90
if(!is_readable( $file)) $ext
Definition: router.php:48