ImageHandler.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Media;
 
use MediaWiki\FileRepo\File\File;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
 
abstract class ImageHandler extends MediaHandler {
    public function canRender( $file ) {
        return ( $file->getWidth() && $file->getHeight() );
    }
 
    public function getParamMap() {
        return [ 'img_width' => 'width' ];
    }
 
    public function validateParam( $name, $value ) {
        return in_array( $name, [ 'width', 'height' ] ) && (int)$value > 0;
    }
 
    public function makeParamString( $params ) {
        if ( isset( $params['physicalWidth'] ) ) {
            $width = $params['physicalWidth'];
        } elseif ( isset( $params['width'] ) ) {
            $width = $params['width'];
        } else {
            throw new MediaTransformInvalidParametersException( 'No width specified to ' . __METHOD__ );
        }
 
        # Removed for ProofreadPage
        # $width = intval( $width );
        return "{$width}px";
    }
 
    public function parseParamString( $str ) {
        $m = false;
        if ( preg_match( '/^(\d+)px$/', $str, $m ) ) {
            return [ 'width' => $m[1] ];
        }
        return false;
    }
 
    protected function getScriptParams( $params ) {
        return [ 'width' => $params['width'] ];
    }
 
    public function normaliseParams( $image, &$params ) {
        if ( !isset( $params['width'] ) ) {
            return false;
        }
 
        if ( !isset( $params['page'] ) ) {
            $params['page'] = 1;
        } else {
            $params['page'] = (int)$params['page'];
            if ( $params['page'] > $image->pageCount() ) {
                $params['page'] = $image->pageCount();
            }
 
            if ( $params['page'] < 1 ) {
                $params['page'] = 1;
            }
        }
 
        $srcWidth = $image->getWidth( $params['page'] );
        $srcHeight = $image->getHeight( $params['page'] );
 
        if ( isset( $params['height'] ) && $params['height'] !== -1 ) {
            # Height & width were both set
            if ( $params['width'] * $srcHeight > $params['height'] * $srcWidth ) {
                # Height is the relative smaller dimension, so scale width accordingly
                $params['width'] = self::fitBoxWidth( $srcWidth, $srcHeight, $params['height'] );
 
                if ( $params['width'] == 0 ) {
                    # Very small image, so we need to rely on client side scaling :(
                    $params['width'] = 1;
                }
 
                $params['physicalWidth'] = $params['width'];
            } else {
                # Height was crap, unset it so that it will be calculated later
                unset( $params['height'] );
            }
        }
 
        if ( !isset( $params['physicalWidth'] ) ) {
            # Passed all validations, so set the physicalWidth
            $params['physicalWidth'] = $params['width'];
        }
 
        # Because thumbs are only referred to by width, the height always needs
        # to be scaled by the width to keep the thumbnail sizes consistent,
        # even if it was set inside the if block above
        $params['physicalHeight'] = File::scaleHeight( $srcWidth, $srcHeight,
            $params['physicalWidth'] );
 
        # Set the height if it was not validated in the if block higher up
        if ( !isset( $params['height'] ) || $params['height'] === -1 ) {
            $params['height'] = $params['physicalHeight'];
        }
 
        if ( !$this->validateThumbParams( $params['physicalWidth'],
            $params['physicalHeight'], $srcWidth, $srcHeight )
        ) {
            return false;
        }
 
        return true;
    }
 
    protected function getSteppedThumbWidth(
        File $image, int $requestWidth, int $srcWidth, int $srcHeight
    ): int {
        $mainConfig = MediaWikiServices::getInstance()->getMainConfig();
        $thumbnailSteps = $mainConfig->get( MainConfigNames::ThumbnailSteps );
 
        if ( !$thumbnailSteps ) {
            return $requestWidth;
        }
 
        $prevStep = $thumbnailSteps[0];
        foreach ( $thumbnailSteps as $widthStep ) {
            if ( ( $widthStep > $srcWidth ) && !$image->isVectorized() ) {
                if ( $this->mustRender( $image ) ) {
                    // Not web-safe: Round down to previous step
                    //
                    // While unlikely, this tries to upscale an original that is smaller than the smallest step
                    // (e.g. smaller than 20px if that's the smallest step configured), which is disallowed
                    // by default in MediaWiki core with HTTP 400 (ThumbnailEntryPoint::generateThumbnail).
                    return $prevStep;
                } else {
                    // Web-safe: Round up or down and use the original
                    //
                    // There was no step between the requested width and the original width
                    // (so either a thumb between penultimate step and original,
                    // or a thumb beyond original jpg but under penultimate step).
                    //
                    // NOTE: This thumb-at-original-width is replaced with the original
                    // in a higher-level code path after this method runs.
                    return $srcWidth;
                }
            }
            if ( $widthStep == $requestWidth ) {
                return $requestWidth;
            }
            if ( $widthStep > $requestWidth ) {
                return $widthStep;
            }
            $prevStep = $widthStep;
        }
 
        // Respond with the largest step if it's too big.
        return $prevStep;
    }
 
    private function validateThumbParams( &$width, &$height, $srcWidth, $srcHeight ) {
        $width = (int)$width;
 
        if ( $width <= 0 ) {
            wfDebug( __METHOD__ . ": Invalid destination width: $width" );
 
            return false;
        }
        if ( $srcWidth <= 0 ) {
            wfDebug( __METHOD__ . ": Invalid source width: $srcWidth" );
 
            return false;
        }
 
        $height = File::scaleHeight( $srcWidth, $srcHeight, $width );
        if ( $height == 0 ) {
            # Force height to be at least 1 pixel
            $height = 1;
        }
 
        return true;
    }
 
    public function getScriptedTransform( $image, $script, $params ) {
        if ( !$this->normaliseParams( $image, $params ) ) {
            return false;
        }
        $url = wfAppendQuery( $script, $this->getScriptParams( $params ) );
 
        if ( $image->mustRender() || $params['width'] < $image->getWidth() ) {
            return new ThumbnailImage( $image, $url, false, $params );
        }
    }
 
    public function getImageSize( $image, $path ) {
        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
        return @getimagesize( $path );
    }
 
    public function getSizeAndMetadata( $state, $path ) {
        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
        $gis = @getimagesize( $path );
        if ( $gis ) {
            $info = [
                'width' => $gis[0],
                'height' => $gis[1],
            ];
            if ( isset( $gis['bits'] ) ) {
                $info['bits'] = $gis['bits'];
            }
        } else {
            $info = [];
        }
        return $info;
    }
 
    public function getImageArea( $image ) {
        return $image->getWidth() * $image->getHeight();
    }
 
    public function getShortDesc( $file ) {
        $lang = $this->getLanguage();
        $nbytes = htmlspecialchars( $lang->formatSize( $file->getSize() ), ENT_QUOTES );
        $widthheight = wfMessage( 'widthheight' )
            ->numParams( $file->getWidth(), $file->getHeight() )
            ->inLanguage( $lang )
            ->escaped();
 
        return "$widthheight ($nbytes)";
    }
 
    public function getLongDesc( $file ) {
        $pages = $file->pageCount();
        if ( $pages === false || $pages <= 1 ) {
            $msg = wfMessage( 'file-info-size' )
                ->numParams( $file->getWidth(), $file->getHeight() )
                ->sizeParams( $file->getSize() )
                ->params( '<span class="mime-type">' . $file->getMimeType() . '</span>' )
                ->inLanguage( $this->getLanguage() )
                ->parse();
        } else {
            $msg = wfMessage( 'file-info-size-pages' )
                ->numParams( $file->getWidth(), $file->getHeight() )
                ->sizeParams( $file->getSize() )
                ->params( '<span class="mime-type">' . $file->getMimeType() . '</span>' )->numParams( $pages )
                ->inLanguage( $this->getLanguage() )
                ->parse();
        }
 
        return $msg;
    }
 
    public function getDimensionsString( $file ) {
        $pages = $file->pageCount();
        $lang = $this->getLanguage();
        if ( $pages > 1 ) {
            return wfMessage( 'widthheightpage' )
                ->numParams( $file->getWidth(), $file->getHeight(), $pages )
                ->inLanguage( $lang )->text();
        }
        return wfMessage( 'widthheight' )
            ->numParams( $file->getWidth(), $file->getHeight() )->inLanguage( $lang )->text();
    }
 
    public function sanitizeParamsForBucketing( $params ) {
        $params = parent::sanitizeParamsForBucketing( $params );
 
        // We unset the height parameters in order to let normaliseParams recalculate them
        // Otherwise there might be a height discrepancy
        unset( $params['height'] );
        unset( $params['physicalHeight'] );
 
        return $params;
    }
}
 
class_alias( ImageHandler::class, 'ImageHandler' );