Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 4
CRAP
0.00% covered (danger)
0.00%
0 / 27
MWFileProps
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 4
72
0.00% covered (danger)
0.00%
0 / 27
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
 getPropsFromPath
0.00% covered (danger)
0.00%
0 / 1
30
0.00% covered (danger)
0.00%
0 / 18
 extractImageSizeInfo
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 5
 newPlaceholderProps
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
<?php
/**
 * MimeMagic helper functions for detecting and dealing with MIME types.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */
/**
 * MimeMagic helper wrapper
 *
 * @since 1.28
 */
class MWFileProps {
    /** @var MimeAnalyzer */
    private $magic;
    /**
     * @param MimeAnalyzer $magic
     */
    public function __construct( MimeAnalyzer $magic ) {
        $this->magic = $magic;
    }
    /**
     * Get an associative array containing information about
     * a file with the given storage path.
     *
     * Resulting array fields include:
     *   - fileExists
     *   - size (filesize in bytes)
     *   - mime (as major/minor)
     *   - media_type (value to be used with the MEDIATYPE_xxx constants)
     *   - metadata (handler specific)
     *   - sha1 (in base 36)
     *   - width
     *   - height
     *   - bits (bitrate)
     *   - file-mime
     *   - major_mime
     *   - minor_mime
     *
     * @param string $path Filesystem path to a file
     * @param string|bool $ext The file extension, or true to extract it from the filename.
     *             Set it to false to ignore the extension.
     * @return array
     * @since 1.28
     */
    public function getPropsFromPath( $path, $ext ) {
        $fsFile = new FSFile( $path );
        $info = $this->newPlaceholderProps();
        $info['fileExists'] = $fsFile->exists();
        if ( $info['fileExists'] ) {
            $info['size'] = $fsFile->getSize(); // bytes
            $info['sha1'] = $fsFile->getSha1Base36();
            # MIME type according to file contents
            $info['file-mime'] = $this->magic->guessMimeType( $path, false );
            # Logical MIME type
            $ext = ( $ext === true ) ? FileBackend::extensionFromPath( $path ) : $ext;
            # XXX: MimeAnalyzer::improveTypeFromExtension() may return null (T253483).
            # Unclear if callers of this method expect that.
            $info['mime'] = $this->magic->improveTypeFromExtension( $info['file-mime'], $ext );
            list( $info['major_mime'], $info['minor_mime'] ) = File::splitMime( $info['mime'] );
            $info['media_type'] = $this->magic->getMediaType( $path, $info['mime'] );
            # Height, width and metadata
            $handler = MediaHandler::getHandler( $info['mime'] );
            if ( $handler ) {
                $info['metadata'] = $handler->getMetadata( $fsFile, $path );
                // @phan-suppress-next-line PhanParamTooMany
                $gis = $handler->getImageSize( $fsFile, $path, $info['metadata'] );
                if ( is_array( $gis ) ) {
                    $info = $this->extractImageSizeInfo( $gis ) + $info;
                }
            }
        }
        return $info;
    }
    /**
     * Exract image size information
     *
     * @param array $gis
     * @return array
     */
    private function extractImageSizeInfo( array $gis ) {
        $info = [];
        # NOTE: $gis[2] contains a code for the image type. This is no longer used.
        $info['width'] = $gis[0];
        $info['height'] = $gis[1];
        $info['bits'] = $gis['bits'] ?? 0;
        return $info;
    }
    /**
     * Empty place holder props for non-existing files
     *
     * Resulting array fields include:
     *   - fileExists
     *   - size (filesize in bytes)
     *   - mime (as major/minor)
     *   - media_type (value to be used with the MEDIATYPE_xxx constants)
     *   - metadata (handler specific)
     *   - sha1 (in base 36)
     *   - width
     *   - height
     *   - bits (bitrate)
     *   - file-mime
     *   - major_mime
     *   - minor_mime
     *
     * @return array
     * @since 1.28
     */
    public function newPlaceholderProps() {
        return FSFile::placeholderProps() + [
            'metadata' => '',
            'width' => 0,
            'height' => 0,
            'bits' => 0,
            'media_type' => MEDIATYPE_UNKNOWN
        ];
    }
}