vendor/dompdf/dompdf/src/Image/Cache.php line 58

Open in your IDE?
  1. <?php
  2. /**
  3.  * @package dompdf
  4.  * @link    http://dompdf.github.com/
  5.  * @author  Benj Carson <benjcarson@digitaljunkies.ca>
  6.  * @author  Helmut Tischer <htischer@weihenstephan.org>
  7.  * @author  Fabien Ménager <fabien.menager@gmail.com>
  8.  * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
  9.  */
  10. namespace Dompdf\Image;
  12. use Dompdf\Options;
  13. use Dompdf\Helpers;
  14. use Dompdf\Exception\ImageException;
  16. /**
  17.  * Static class that resolves image urls and downloads and caches
  18.  * remote images if required.
  19.  *
  20.  * @package dompdf
  21.  */
  22. class Cache
  23. {
  24.     /**
  25.      * Array of downloaded images.  Cached so that identical images are
  26.      * not needlessly downloaded.
  27.      *
  28.      * @var array
  29.      */
  30.     protected static $_cache = [];
  32.     /**
  33.      * @var array
  34.      */
  35.     protected static $tempImages = [];
  37.     /**
  38.      * The url to the "broken image" used when images can't be loaded
  39.      *
  40.      * @var string
  41.      */
  42.     public static $broken_image = "data:image/svg+xml;charset=utf8,%3C?xml version='1.0'?%3E%3Csvg width='64' height='64' xmlns='http://www.w3.org/2000/svg'%3E%3Cg%3E%3Crect stroke='%23666666' id='svg_1' height='60.499994' width='60.166667' y='1.666669' x='1.999998' stroke-width='1.5' fill='none'/%3E%3Cline stroke-linecap='null' stroke-linejoin='null' id='svg_3' y2='59.333253' x2='59.749916' y1='4.333415' x1='4.250079' stroke-width='1.5' stroke='%23999999' fill='none'/%3E%3Cline stroke-linecap='null' stroke-linejoin='null' id='svg_4' y2='59.999665' x2='4.062838' y1='3.750342' x1='60.062164' stroke-width='1.5' stroke='%23999999' fill='none'/%3E%3C/g%3E%3C/svg%3E";
  44.     public static $error_message = "Image not found or type unknown";
  45.     
  46.     /**
  47.      * Resolve and fetch an image for use.
  48.      *
  49.      * @param string $url       The url of the image
  50.      * @param string $protocol  Default protocol if none specified in $url
  51.      * @param string $host      Default host if none specified in $url
  52.      * @param string $base_path Default path if none specified in $url
  53.      * @param Options $options  An instance of Dompdf\Options
  54.      *
  55.      * @return array            An array with three elements: The local path to the image, the image
  56.      *                          extension, and an error message if the image could not be cached
  57.      */
  58.     static function resolve_url($url, $protocol, $host, $base_path, Options $options)
  59.     {
  60.         $tempfile = null;
  61.         $resolved_url = null;
  62.         $type = null;
  63.         $message = null;
  64.         
  65.         try {
  66.             $full_url = Helpers::build_url($protocol, $host, $base_path, $url);
  68.             if ($full_url === null) {
  69.                 throw new ImageException("Unable to parse image URL $url.", E_WARNING);
  70.             }
  72.             $parsed_url = Helpers::explode_url($full_url);
  73.             $protocol = strtolower($parsed_url["protocol"]);
  74.             $is_data_uri = strpos($protocol, "data:") === 0;
  75.             
  76.             if (!$is_data_uri) {
  77.                 $allowed_protocols = $options->getAllowedProtocols();
  78.                 if (!array_key_exists($protocol, $allowed_protocols)) {
  79.                     throw new ImageException("Permission denied on $url. The communication protocol is not supported.", E_WARNING);
  80.                 }
  81.                 foreach ($allowed_protocols[$protocol]["rules"] as $rule) {
  82.                     [$result, $message] = $rule($full_url);
  83.                     if (!$result) {
  84.                         throw new ImageException("Error loading $url: $message", E_WARNING);
  85.                     }
  86.                 }
  87.             }
  89.             if ($protocol === "file://") {
  90.                 $resolved_url = $full_url;
  91.             } elseif (isset(self::$_cache[$full_url])) {
  92.                 $resolved_url = self::$_cache[$full_url];
  93.             } else {
  94.                 $tmp_dir = $options->getTempDir();
  95.                 if (($resolved_url = @tempnam($tmp_dir, "ca_dompdf_img_")) === false) {
  96.                     throw new ImageException("Unable to create temporary image in " . $tmp_dir, E_WARNING);
  97.                 }
  98.                 $tempfile = $resolved_url;
  100.                 $image = null;
  101.                 if ($is_data_uri) {
  102.                     if (($parsed_data_uri = Helpers::parse_data_uri($url)) !== false) {
  103.                         $image = $parsed_data_uri["data"];
  104.                     }
  105.                 } else {
  106.                     list($image, $http_response_header) = Helpers::getFileContent($full_url, $options->getHttpContext());
  107.                 }
  109.                 // Image not found or invalid
  110.                 if ($image === null) {
  111.                     $msg = ($is_data_uri ? "Data-URI could not be parsed" : "Image not found");
  112.                     throw new ImageException($msg, E_WARNING);
  113.                 }
  115.                 if (@file_put_contents($resolved_url, $image) === false) {
  116.                     throw new ImageException("Unable to create temporary image in " . $tmp_dir, E_WARNING);
  117.                 }
  119.                 self::$_cache[$full_url] = $resolved_url;
  120.             }
  122.             // Check if the local file is readable
  123.             if (!is_readable($resolved_url) || !filesize($resolved_url)) {
  124.                 throw new ImageException("Image not readable or empty", E_WARNING);
  125.             }
  127.             list($width, $height, $type) = Helpers::dompdf_getimagesize($resolved_url, $options->getHttpContext());
  129.             if (($width && $height && in_array($type, ["gif", "png", "jpeg", "bmp", "svg","webp"], true)) === false) {
  130.                 throw new ImageException("Image type unknown", E_WARNING);
  131.             }
  133.             if ($type === "svg") {
  134.                 $parser = xml_parser_create("utf-8");
  135.                 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
  136.                 xml_set_element_handler(
  137.                     $parser,
  138.                     function ($parser, $name, $attributes) use ($options, $parsed_url, $full_url) {
  139.                         if ($name === "image") {
  140.                             $attributes = array_change_key_case($attributes, CASE_LOWER);
  141.                             $url = $attributes["xlink:href"] ?? $attributes["href"];
  142.                             if (!empty($url)) {
  143.                                 $inner_full_url = Helpers::build_url($parsed_url["protocol"], $parsed_url["host"], $parsed_url["path"], $url);
  144.                                 if ($inner_full_url === $full_url) {
  145.                                     throw new ImageException("SVG self-reference is not allowed", E_WARNING);
  146.                                 }
  147.                                 [$resolved_url, $type, $message] = self::resolve_url($url, $parsed_url["protocol"], $parsed_url["host"], $parsed_url["path"], $options);
  148.                                 if (!empty($message)) {
  149.                                     throw new ImageException("This SVG document references a restricted resource. $message", E_WARNING);
  150.                                 }
  151.                             }
  152.                         }
  153.                     },
  154.                     false
  155.                 );
  156.         
  157.                 if (($fp = fopen($resolved_url, "r")) !== false) {
  158.                     while ($line = fread($fp, 8192)) {
  159.                         xml_parse($parser, $line, false);
  160.                     }
  161.                     fclose($fp);
  162.                 }
  163.                 xml_parser_free($parser);
  164.             }
  165.         } catch (ImageException $e) {
  166.             if ($tempfile) {
  167.                 unlink($tempfile);
  168.             }
  169.             $resolved_url = self::$broken_image;
  170.             list($width, $height, $type) = Helpers::dompdf_getimagesize($resolved_url, $options->getHttpContext());
  171.             $message = self::$error_message;
  172.             Helpers::record_warnings($e->getCode(), $e->getMessage() . " \n $url", $e->getFile(), $e->getLine());
  173.             self::$_cache[$full_url] = $resolved_url;
  174.         }
  176.         return [$resolved_url, $type, $message];
  177.     }
  179.     /**
  180.      * Register a temp file for the given original image file.
  181.      *
  182.      * @param string $filePath The path of the original image.
  183.      * @param string $tempPath The path of the temp file to register.
  184.      * @param string $key      An optional key to register the temp file at.
  185.      */
  186.     static function addTempImage(string $filePath, string $tempPath, string $key = "default"): void
  187.     {
  188.         if (!isset(self::$tempImages[$filePath])) {
  189.             self::$tempImages[$filePath] = [];
  190.         }
  192.         self::$tempImages[$filePath][$key] = $tempPath;
  193.     }
  195.     /**
  196.      * Get the path of a temp file registered for the given original image file.
  197.      *
  198.      * @param string $filePath The path of the original image.
  199.      * @param string $key      The key the temp file is registered at.
  200.      */
  201.     static function getTempImage(string $filePath, string $key = "default"): ?string
  202.     {
  203.         return self::$tempImages[$filePath][$key] ?? null;
  204.     }
  206.     /**
  207.      * Unlink all cached images (i.e. temporary images either downloaded
  208.      * or converted) except for the bundled "broken image"
  209.      */
  210.     static function clear(bool $debugPng = false)
  211.     {
  212.         foreach (self::$_cache as $file) {
  213.             if ($file === self::$broken_image) {
  214.                 continue;
  215.             }
  216.             if ($debugPng) {
  217.                 print "[clear unlink $file]";
  218.             }
  219.             if (file_exists($file)) {
  220.                 unlink($file);
  221.             }
  222.         }
  224.         foreach (self::$tempImages as $versions) {
  225.             foreach ($versions as $file) {
  226.                 if ($file === self::$broken_image) {
  227.                     continue;
  228.                 }
  229.                 if ($debugPng) {
  230.                     print "[unlink temp image $file]";
  231.                 }
  232.                 if (file_exists($file)) {
  233.                     unlink($file);
  234.                 }
  235.             }
  236.         }
  238.         self::$_cache = [];
  239.         self::$tempImages = [];
  240.     }
  242.     static function detect_type($file, $context = null)
  243.     {
  244.         list(, , $type) = Helpers::dompdf_getimagesize($file, $context);
  246.         return $type;
  247.     }
  249.     static function is_broken($url)
  250.     {
  251.         return $url === self::$broken_image;
  252.     }
  253. }
  255. if (file_exists(realpath(__DIR__ . "/../../lib/res/broken_image.svg"))) {
  256.     Cache::$broken_image = realpath(__DIR__ . "/../../lib/res/broken_image.svg");
  257. }