Contrib.social

When uploading images with extensions not supported by GDToolkit (such as svg) you can encounter a deprecation warning

Open on Drupal.org →
Created on 17 September 2024, 7 months ago
Updated 18 September 2024, 7 months ago

Problem/Motivation

Uploading an svg (if the widget is properly configured to allow an svg, so not related to #3461515 ) we see a deprecation when using PHP 8.1 as described in https://www.drupal.org/project/drupal/issues/3338962#comment-15776120 🐛 PHP 8.1 deprecation (passing null to non-nullable argument) in GDToolkit when uploading SVG files. Closed: cannot reproduce . This occurs because svg is not in the array returned by GDToolkit::supportedTypes(). Therefore the $type property is not set during parsing in GDToolkit::parseFile(). When GDToolkit::load() runs it passes null to the function image_type_to_extension(), which is deprecated in PHP 8.1. This can only happen as there is trickery done to support svg in Rokka despite GDToolkit not supporting svg. 

/**
   * Get the mime type.
   *
   * @return string
   *   Mime type.
   */
  public function getMimeType(): string {
    $mime_type = $this->getType() ? image_type_to_mime_type($this->getType()) : '';

    // GD library does not support SVG, but Rokka does. So we will trick the
    // toolkit and detect SVG as a mime time the first time the file is uploaded
    // to the tmp folder. If we detect an SVG image, we allow the upload.
    if (empty($mime_type)) {
      $uri = $this->getSource();
      if ($uri && file_exists($uri) && strpos($uri, 'rokka://') === FALSE) {
        $rokka_additional_allowed_mime_types = ['image/svg', 'image/svg+xml'];
        $mime_type_guessed = mime_content_type($uri);
        if (in_array($mime_type_guessed, $rokka_additional_allowed_mime_types)) {
          $mime_type = $mime_type_guessed;
        }
      }
    }

    return $mime_type;
  }

Steps to reproduce

Install Rokka.
Allow svg on the file upload.
Upload an SVG
See warning Deprecated: image_type_to_extension(): Passing null to parameter #1 ($image_type) of type int is deprecated in /app/docroot/core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php on line 261.

Proposed resolution

Override the load() function to check getType() and only call the parent load if this is the case.

Remaining tasks

An MR is to follow.

User interface changes

None.

API changes

None.

Data model changes

None.

🐛 Bug report
Status

RTBC

Version

3.0

Component

Code

Created by

🇨🇭Switzerland tcrawford

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024