Same name in other branches

1. 9 core/modules/image/src/Controller/ImageStyleDownloadController.php \Drupal\image\Controller\ImageStyleDownloadController::deliver()
2. 8.9.x core/modules/image/src/Controller/ImageStyleDownloadController.php \Drupal\image\Controller\ImageStyleDownloadController::deliver()
3. 11.x core/modules/image/src/Controller/ImageStyleDownloadController.php \Drupal\image\Controller\ImageStyleDownloadController::deliver()

Generates a derivative, given a style and image path.

After generating an image, transfer it to the requesting agent.

Parameters

\Symfony\Component\HttpFoundation\Request $request: The request object.

string $scheme: The file scheme, defaults to 'private'.

\Drupal\image\ImageStyleInterface $image_style: The image style to deliver.

string $required_derivative_scheme: The required scheme for the derivative image.

Return value

\Symfony\Component\HttpFoundation\BinaryFileResponse|\Symfony\Component\HttpFoundation\Response The transferred file as response or some error response.

Throws

\Symfony\Component\HttpKernel\Exception\NotFoundHttpException Thrown when the file request is invalid.

\Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException Thrown when the user does not have access to the file.

\Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException Thrown when the file is still being generated.

1 string reference to 'ImageStyleDownloadController::deliver'

image.routing.yml in core/modules/image/image.routing.yml

core/modules/image/image.routing.yml

File

core/modules/image/src/Controller/ImageStyleDownloadController.php, line 111

Class

ImageStyleDownloadController

Defines a controller to serve image styles.

Namespace

Drupal\image\Controller

Code

public function deliver(Request $request, $scheme, ImageStyleInterface $image_style, string $required_derivative_scheme) {
    $target = $request->query
        ->get('file');
    $image_uri = $scheme . '://' . $target;
    $image_uri = $this->streamWrapperManager
        ->normalizeUri($image_uri);
    $sample_image_uri = $scheme . '://' . $this->config('image.settings')
        ->get('preview_image');
    if ($this->streamWrapperManager
        ->isValidScheme($scheme)) {
        $normalized_target = $this->streamWrapperManager
            ->getTarget($image_uri);
        if ($normalized_target !== FALSE) {
            if (!in_array($scheme, Settings::get('file_sa_core_2023_005_schemes', []))) {
                $parts = explode('/', $normalized_target);
                if (array_intersect($parts, [
                    '.',
                    '..',
                ])) {
                    throw new NotFoundHttpException();
                }
            }
        }
    }
    // Check that the style is defined and the scheme is valid.
    $valid = !empty($image_style) && $this->streamWrapperManager
        ->isValidScheme($scheme);
    // Also validate the derivative token. Sites which require image
    // derivatives to be generated without a token can set the
    // 'image.settings:allow_insecure_derivatives' configuration to TRUE to
    // bypass this check, but this will increase the site's vulnerability
    // to denial-of-service attacks. To prevent this variable from leaving the
    // site vulnerable to the most serious attacks, a token is always required
    // when a derivative of a style is requested.
    // The $target variable for a derivative of a style has
    // styles/<style_name>/... as structure, so we check if the $target variable
    // starts with styles/.
    $token = $request->query
        ->get(IMAGE_DERIVATIVE_TOKEN, '');
    $token_is_valid = hash_equals($image_style->getPathToken($image_uri), $token) || hash_equals($image_style->getPathToken($scheme . '://' . $target), $token);
    if (!$this->config('image.settings')
        ->get('allow_insecure_derivatives') || str_starts_with(ltrim($target, '\\/'), 'styles/')) {
        $valid = $valid && $token_is_valid;
    }
    if (!$valid) {
        // Return a 404 (Page Not Found) rather than a 403 (Access Denied) as the
        // image token is for DDoS protection rather than access checking. 404s
        // are more likely to be cached (e.g. at a proxy) which enhances
        // protection from DDoS.
        throw new NotFoundHttpException();
    }
    $derivative_uri = $image_style->buildUri($image_uri);
    $derivative_scheme = $this->streamWrapperManager
        ->getScheme($derivative_uri);
    if ($required_derivative_scheme !== $derivative_scheme) {
        throw new AccessDeniedHttpException("The scheme for this image doesn't match the scheme for the original image");
    }
    if ($token_is_valid) {
        $is_public = $scheme !== 'private';
    }
    else {
        $core_schemes = [
            'public',
            'private',
            'temporary',
        ];
        $additional_public_schemes = array_diff(Settings::get('file_additional_public_schemes', []), $core_schemes);
        $public_schemes = array_merge([
            'public',
        ], $additional_public_schemes);
        $is_public = in_array($derivative_scheme, $public_schemes, TRUE);
    }
    $headers = [];
    // Don't try to generate file if source is missing.
    if ($image_uri !== $sample_image_uri && !$this->sourceImageExists($image_uri, $token_is_valid)) {
        // If the image style converted the extension, it has been added to the
        // original file, resulting in filenames like image.png.jpeg. So to find
        // the actual source image, we remove the extension and check if that
        // image exists.
        $converted_image_uri = static::getUriWithoutConvertedExtension($image_uri);
        if ($converted_image_uri !== $image_uri && $this->sourceImageExists($converted_image_uri, $token_is_valid)) {
            // The converted file does exist, use it as the source.
            $image_uri = $converted_image_uri;
        }
        else {
            $this->logger
                ->notice('Source image at %source_image_path not found while trying to generate derivative image at %derivative_path.', [
                '%source_image_path' => $image_uri,
                '%derivative_path' => $derivative_uri,
            ]);
            return new Response($this->t('Error generating image, missing source file.'), 404);
        }
    }
    // If not using a public scheme, let other modules provide headers and
    // control access to the file.
    if (!$is_public) {
        $headers = $this->moduleHandler()
            ->invokeAll('file_download', [
            $image_uri,
        ]);
        if (in_array(-1, $headers) || empty($headers)) {
            throw new AccessDeniedHttpException();
        }
    }
    // If it is default sample.png, ignore scheme.
    // This value swap must be done after hook_file_download is called since
    // the hooks are expecting a URI, not a file path.
    if ($image_uri === $sample_image_uri) {
        $image_uri = $target;
    }
    // Don't start generating the image if the derivative already exists or if
    // generation is in progress in another thread.
    if (!file_exists($derivative_uri)) {
        $lock_name = 'image_style_deliver:' . $image_style->id() . ':' . Crypt::hashBase64($image_uri);
        $lock_acquired = $this->lock
            ->acquire($lock_name);
        if (!$lock_acquired) {
            // Tell client to retry again in 3 seconds. Currently no browsers are
            // known to support Retry-After.
            throw new ServiceUnavailableHttpException(3, 'Image generation in progress. Try again shortly.');
        }
    }
    // Try to generate the image, unless another thread just did it while we
    // were acquiring the lock.
    $success = file_exists($derivative_uri) || $image_style->createDerivative($image_uri, $derivative_uri);
    if (!empty($lock_acquired)) {
        $this->lock
            ->release($lock_name);
    }
    if ($success) {
        $image = $this->imageFactory
            ->get($derivative_uri);
        $uri = $image->getSource();
        $headers += [
            'Content-Type' => $image->getMimeType(),
            'Content-Length' => $image->getFileSize(),
        ];
        // \Drupal\Core\EventSubscriber\FinishResponseSubscriber::onRespond()
        // sets response as not cacheable if the Cache-Control header is not
        // already modified. When $is_public is TRUE, the following sets the
        // Cache-Control header to "public".
        return new BinaryFileResponse($uri, 200, $headers, $is_public);
    }
    else {
        $this->logger
            ->notice('Unable to generate the derived image located at %path.', [
            '%path' => $derivative_uri,
        ]);
        return new Response($this->t('Error generating image.'), 500);
    }
}

---