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 
63  public function getPropsFromPath( $path, $ext ) {
64  $fsFile = new FSFile( $path );
65 
66  $info = $this->newPlaceholderProps();
67  $info['fileExists'] = $fsFile->exists();
68  if ( $info['fileExists'] ) {
69  $info['size'] = $fsFile->getSize(); // bytes
70  $info['sha1'] = $fsFile->getSha1Base36();
71 
72  # MIME type according to file contents
73  $info['file-mime'] = $this->magic->guessMimeType( $path, false );
74  # Logical MIME type
76 
77  # XXX: MimeAnalyzer::improveTypeFromExtension() may return null (T253483).
78  # Unclear if callers of this method expect that.
79  $info['mime'] = $this->magic->improveTypeFromExtension( $info['file-mime'], $ext );
80 
81  list( $info['major_mime'], $info['minor_mime'] ) = File::splitMime( $info['mime'] );
82  $info['media_type'] = $this->magic->getMediaType( $path, $info['mime'] );
83 
84  # Height, width and metadata
85  $handler = MediaHandler::getHandler( $info['mime'] );
86  if ( $handler ) {
87  $info['metadata'] = $handler->getMetadata( $fsFile, $path );
88  // @phan-suppress-next-line PhanParamTooMany
89  $gis = $handler->getImageSize( $fsFile, $path, $info['metadata'] );
90  if ( is_array( $gis ) ) {
91  $info = $this->extractImageSizeInfo( $gis ) + $info;
92  }
93  }
94  }
95 
96  return $info;
97  }
98 
105  private function extractImageSizeInfo( array $gis ) {
106  $info = [];
107  # NOTE: $gis[2] contains a code for the image type. This is no longer used.
108  $info['width'] = $gis[0];
109  $info['height'] = $gis[1];
110  $info['bits'] = $gis['bits'] ?? 0;
111 
112  return $info;
113  }
114 
135  public function newPlaceholderProps() {
136  return FSFile::placeholderProps() + [
137  'metadata' => '',
138  'width' => 0,
139  'height' => 0,
140  'bits' => 0,
141  'media_type' => MEDIATYPE_UNKNOWN
142  ];
143  }
144 }
MWFileProps\$magic
MimeAnalyzer $magic
Definition: MWFileProps.php:30
MWFileProps\getPropsFromPath
getPropsFromPath( $path, $ext)
Get an associative array containing information about a file with the given storage path.
Definition: MWFileProps.php:63
MimeAnalyzer
Implements functions related to MIME types such as detection and mapping to file extension.
Definition: MimeAnalyzer.php:33
true
return true
Definition: router.php:90
FileBackend\extensionFromPath
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
Definition: FileBackend.php:1602
MWFileProps\__construct
__construct(MimeAnalyzer $magic)
Definition: MWFileProps.php:35
MEDIATYPE_UNKNOWN
const MEDIATYPE_UNKNOWN
Definition: defines.php:26
File\splitMime
static splitMime( $mime)
Split an internet media type into its two components; if not a two-part name, set the minor type to '...
Definition: File.php:290
FSFile\placeholderProps
static placeholderProps()
Placeholder file properties to use for files that don't exist.
Definition: FSFile.php:150
MWFileProps
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
MWFileProps\newPlaceholderProps
newPlaceholderProps()
Empty place holder props for non-existing files.
Definition: MWFileProps.php:135
FSFile
Class representing a non-directory file on the file system.
Definition: FSFile.php:32
MWFileProps\extractImageSizeInfo
extractImageSizeInfo(array $gis)
Exract image size information.
Definition: MWFileProps.php:105
$path
$path
Definition: NoLocalSettings.php:25
MediaHandler\getHandler
static getHandler( $type)
Get a MediaHandler for a given MIME type from the instance cache.
Definition: MediaHandler.php:53
$ext
if(!is_readable( $file)) $ext
Definition: router.php:48