asciidoctor-pdf 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be0ccb9b1f50f98f904f500c7b2bf0118157714825e28739ab80df39ff101bf9
-  data.tar.gz: 1ce0fafde09b3e41ad86782397e0034bc8bd6f82d06dff01346bf055ead214d0
+  metadata.gz: f836f6c86c31a3bbd792bba4608f397422361bcc5b297355eccab266a3a5ac0b
+  data.tar.gz: b31b434d0d7bede025b4f3c25e71a518f120a66840dfb7df72308d17fda9bd8e
 SHA512:
-  metadata.gz: ea8d2b78a501da0ce41cc9dabf88f19fe1926262725661012c4f5f00ffc10f34e1a479ca4cf6b66a6601d4f9f2ada928fc23eb0cb422b391503955f21b072a8d
-  data.tar.gz: 3916e7d631167b57babd839b9f352932ca3df05022a4487195a2d8c8ee07165bdccb0127cd447d1e525f23a6bd2ef88d7710ad63075ec70c5763e5e7b8f6a237
+  metadata.gz: 84899cfb74ce8ef2c97111d585e73529318c3f0a44756f75674338f58c1d46693925fe1f9d42b9666f07d8a1bed68f606ec3ec2b664816d0c92998494e90a39a
+  data.tar.gz: a50053c502cf572929c49802208e18faa9f1e5bf0a2f3e47972c3863fafa3c43e157425e7b3c5a1ad12cc0e301d8e461a108907e48f5b80aaa0f05938dc2e6a2

data/CHANGELOG.adoc

@@ -5,6 +5,23 @@
 This document provides a high-level view of the changes to the {project-name} by release.
 For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
 
+== 2.0.7 (2022-06-03) - @mojavelinux
+
+Improvements::
+
+* don't recommend prawn-gmagick if PNG or JPG is corrupt or incomplete
+* add helper method to determine when to recommend the prawn-gmagick gem
+
+Bug Fixes::
+
+* fix crash when doctitle or section title with automatic ID contains inline image without explicit width (#2228)
+* use prawn-gmagick, if available, to read raster image referenced by SVG (#2223)
+* allow image path in SVG to refer to any location within Asciidoctor jail (no restriction if safe mode is unsafe) (#1941)
+
+=== Details
+
+{url-repo}/releases/tag/v2.0.7[git tag] | {url-repo}/compare/v2.0.6\...v2.0.7[full diff]
+
 == 2.0.6 (2022-05-30) - @mojavelinux
 
 Bug Fixes::

data/README.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor PDF: A native PDF converter for AsciiDoc
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.0.6, 2022-05-30
+v2.0.7, 2022-06-03
 // Settings:
 :experimental:
 :idprefix:
@@ -24,7 +24,7 @@ endif::[]
 :project-handle: asciidoctor-pdf
 // Variables:
 :release-line: 2.0.x
-:release-version: 2.0.6
+:release-version: 2.0.7
 // URLs:
 :url-gem: https://rubygems.org/gems/asciidoctor-pdf
 :url-project: https://github.com/asciidoctor/asciidoctor-pdf

data/lib/asciidoctor/pdf/converter.rb

@@ -20,6 +20,8 @@ module Asciidoctor
 
       attr_reader :cache_uri
 
+      attr_reader :jail_dir
+
       attr_accessor :font_color
 
       attr_accessor :font_scale
@@ -150,7 +152,7 @@ module Asciidoctor
           log :warn, %(missing convert handler for #{name} node in #{@backend} backend)
         end
         # NOTE: inline node handlers generate HTML-like strings; all other handlers write directly to the PDF object
-        ::Asciidoctor::Inline === node ? result : self
+        node.inline? ? result : self
       end
 
       def convert_document doc
@@ -336,7 +338,11 @@ module Asciidoctor
         #@page_opts = { size: pdf_opts[:page_size], layout: pdf_opts[:page_layout] }
         ((::Prawn::Document.instance_method :initialize).bind self).call pdf_opts
         renderer.min_version (@pdf_version = PDFVersions[doc.attr 'pdf-version'])
-        @media = doc.attr 'media', 'screen'
+        @tmp_files ||= {}
+        @allow_uri_read = doc.attr? 'allow-uri-read'
+        @cache_uri = doc.attr? 'cache-uri'
+        @jail_dir = doc.safe < ::Asciidoctor::SafeMode::SAFE ? nil : doc.base_dir
+        @media ||= doc.attr 'media', 'screen'
         @page_margin_by_side = { recto: (page_margin_recto = page_margin), verso: (page_margin_verso = page_margin), cover: page_margin }
         case doc.attr 'pdf-folio-placement', (@media == 'prepress' ? 'physical' : 'virtual')
         when 'physical'
@@ -361,13 +367,6 @@ module Asciidoctor
         else
           @ppbook = nil
         end
-        # QUESTION: should ThemeLoader handle registering fonts instead?
-        register_fonts theme.font_catalog, ((doc.attr 'pdf-fontsdir')&.sub '{docdir}', (doc.attr 'docdir')) || 'GEM_FONTS_DIR'
-        default_kerning theme.base_font_kerning != 'none'
-        @fallback_fonts = Array theme.font_fallbacks
-        @allow_uri_read = doc.attr? 'allow-uri-read'
-        @cache_uri = doc.attr? 'cache-uri'
-        @tmp_files = {}
         if (bg_image = resolve_background_image doc, theme, 'page-background-image')&.first
           @page_bg_image = { verso: bg_image, recto: bg_image }
         else
@@ -380,6 +379,10 @@ module Asciidoctor
           @page_bg_image[:recto] = bg_image[0] && bg_image
         end
         @page_bg_color = resolve_theme_color :page_background_color, 'FFFFFF'
+        # QUESTION: should ThemeLoader handle registering fonts instead?
+        register_fonts theme.font_catalog, ((doc.attr 'pdf-fontsdir')&.sub '{docdir}', (doc.attr 'docdir')) || 'GEM_FONTS_DIR'
+        default_kerning theme.base_font_kerning != 'none'
+        @fallback_fonts = Array theme.font_fallbacks
         @root_font_size = theme.base_font_size
         @font_scale = 1
         @font_color = theme.base_font_color
@@ -936,7 +939,7 @@ module Asciidoctor
                           height: label_height,
                           fallback_font_name: fallback_svg_font_name,
                           enable_web_requests: allow_uri_read ? (method :load_open_uri).to_proc : false,
-                          enable_file_requests_with_root: (::File.dirname icon_path),
+                          enable_file_requests_with_root: { base: (::File.dirname icon_path), root: @jail_dir },
                           cache_images: cache_uri
                         svg_obj.resize height: label_height if svg_obj.document.sizing.output_height > label_height
                         svg_obj.draw
@@ -1731,7 +1734,7 @@ module Asciidoctor
                 file_request_root = false
               else
                 svg_data = ::File.read image_path, mode: 'r:UTF-8'
-                file_request_root = ::File.dirname image_path
+                file_request_root = { base: (::File.dirname image_path), root: @jail_dir }
               end
               svg_obj = ::Prawn::SVG::Interface.new svg_data, self,
                 position: alignment,
@@ -1811,7 +1814,7 @@ module Asciidoctor
           end
         rescue => e
           raise if ::StopIteration === e
-          on_image_error :exception, node, target, (opts.merge align: alignment, message: %(could not embed image: #{image_path}; #{e.message}#{::Prawn::Errors::UnsupportedImageType === e && !(defined? ::GMagick::Image) ? '; install prawn-gmagick gem to add support' : ''}))
+          on_image_error :exception, node, target, (opts.merge align: alignment, message: %(could not embed image: #{image_path}; #{e.message}#{(recommend_prawn_gmagick? e, image_format) ? %(; install prawn-gmagick gem to add support for #{image_format&.upcase || 'unknown'} image format) : ''}))
         end
       end
 
@@ -2505,14 +2508,19 @@ module Asciidoctor
           # NOTE: an image with a data URI is handled using a temporary file
           elsif (image_path = resolve_image_path node, target, image_format)
             if ::File.readable? image_path
+              class_attr = (role = node.role) ? %( class="#{role}") : ''
+              fit_attr = (fit = node.attr 'fit') ? %( fit="#{fit}") : ''
               if (width = resolve_explicit_width node.attributes)
-                width += (intrinsic_image_dimensions image_path, image_format)[:width].to_s if node.parent.context == :table_cell && ::String === width && (width.end_with? '%')
+                if node.parent.context == :table_cell && ::String === width && (width.end_with? '%')
+                  width += (intrinsic_image_dimensions image_path, image_format)[:width].to_s
+                end
+                width_attr = %( width="#{width}")
+              elsif state # check that converter is initialized
+                width_attr = %( width="#{(intrinsic_image_dimensions image_path, image_format)[:width]}")
               else
-                width = (intrinsic_image_dimensions image_path, image_format)[:width]
+                width_attr = ' width="auto"' # defer operation until arranger runs
               end
-              class_attr = (role = node.role) ? %( class="#{role}") : ''
-              fit_attr = (fit = node.attr 'fit') ? %( fit="#{fit}") : ''
-              img = %(<img src="#{image_path}" format="#{image_format}" alt="#{encode_quotes node.attr 'alt'}" width="#{width}"#{class_attr}#{fit_attr}>)
+              img = %(<img src="#{image_path}" format="#{image_format}" alt="#{encode_quotes node.attr 'alt'}"#{width_attr}#{class_attr}#{fit_attr}>)
             else
               log :warn, %(image to embed not found or not readable: #{image_path})
               img = %([#{node.attr 'alt'}&#93;)
@@ -3838,6 +3846,27 @@ module Asciidoctor
         end
       end
 
+      # Retrieve the intrinsic image dimensions for the specified path in pt.
+      #
+      # Returns a Hash containing :width and :height keys that map to the image's
+      # intrinsic width and height values (in pt).
+      def intrinsic_image_dimensions path, format
+        if format == 'svg'
+          # NOTE: prawn-svg automatically converts intrinsic width and height to pt
+          img_obj = ::Prawn::SVG::Interface.new (::File.read path, mode: 'r:UTF-8'), self, {}
+          img_size = img_obj.document.sizing
+          { width: img_size.output_width, height: img_size.output_height }
+        else
+          # NOTE: build_image_object caches image data previously loaded
+          # NOTE: build_image_object computes intrinsic width and height in px
+          _, img_size = ::File.open(path, 'rb') {|fd| build_image_object fd }
+          { width: (to_pt img_size.width, :px), height: (to_pt img_size.height, :px) }
+        end
+      rescue
+        # NOTE: image can't be read, so it won't be used anyway
+        { width: 0, height: 0 }
+      end
+
       # Sends the specified message to the log unless this method is called from the scratch document
       def log severity, message = nil, &block
         logger.send severity, message, &block unless scratch?
@@ -4046,7 +4075,7 @@ module Asciidoctor
       def resolve_image_options image_path, image_format, image_attrs, opts = {}
         if image_format == 'svg'
           image_opts = {
-            enable_file_requests_with_root: (::File.dirname image_path),
+            enable_file_requests_with_root: { base: (::File.dirname image_path), root: @jail_dir },
             enable_web_requests: allow_uri_read ? (method :load_open_uri).to_proc : false,
             cache_images: cache_uri,
             fallback_font_name: fallback_svg_font_name,
@@ -4133,6 +4162,7 @@ module Asciidoctor
         else
           imagesdir = relative_to
         end
+        @tmp_files ||= {}
         # NOTE: base64 logic currently used for inline images
         if ::Base64 === image_path
           return @tmp_files[image_path] if @tmp_files.key? image_path

data/lib/asciidoctor/pdf/ext/prawn/images.rb

@@ -33,25 +33,8 @@ module Asciidoctor
         end
       end
 
-      # Retrieve the intrinsic image dimensions for the specified path in pt.
-      #
-      # Returns a Hash containing :width and :height keys that map to the image's
-      # intrinsic width and height values (in pt).
-      def intrinsic_image_dimensions path, format
-        if format == 'svg'
-          # NOTE: prawn-svg computes intrinsic width and height in pt
-          img_obj = ::Prawn::SVG::Interface.new (::File.read path, mode: 'r:UTF-8'), self, {}
-          img_size = img_obj.document.sizing
-          { width: img_size.output_width, height: img_size.output_height }
-        else
-          # NOTE: build_image_object caches image data previously loaded
-          # NOTE: build_image_object computes intrinsic width and height in px
-          _, img_size = ::File.open(path, 'rb') {|fd| build_image_object fd }
-          { width: (to_pt img_size.width, :px), height: (to_pt img_size.height, :px) }
-        end
-      rescue
-        # NOTE: image cannot be read, so it won't be used anyway
-        { width: 0, height: 0 }
+      def recommend_prawn_gmagick? err, image_format
+        ::Prawn::Errors::UnsupportedImageType === err && !(defined? ::GMagick::Image) && ((err.message.include? 'PNG') || (%w(jpg png).none? image_format))
       end
     end
 

data/lib/asciidoctor/pdf/ext/prawn-svg/elements/image.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Prawn::SVG::Elements::Image.prepend (Module.new do
+  def image_dimensions data
+    unless (handler = find_image_handler data)
+      raise ::Prawn::SVG::Elements::Base::SkipElementError, 'Unsupported image type supplied to image tag'
+    end
+    image = handler.new data
+    [image.width.to_f, image.height.to_f]
+  end
+
+  def find_image_handler data
+    Prawn.image_handler.find data rescue nil
+  end
+end)

data/lib/asciidoctor/pdf/ext/prawn-svg/loaders/file.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+Prawn::SVG::Loaders::File.prepend (Module.new do
+  attr_reader :jail_path
+
+  def initialize root_path
+    if Hash === root_path
+      @jail_path = root_path[:root]
+      root_path = root_path[:base]
+      super
+    else
+      super
+      @jail_path = self.root_path
+    end
+  end
+
+  def assert_valid_path! path
+    if jail_path && !(path.start_with? %(#{jail_path}#{File::SEPARATOR}))
+      raise Prawn::SVG::UrlLoader::Error, %(file path points to location outside of jail #{jail_path})
+    end
+  end
+end)

data/lib/asciidoctor/pdf/ext/prawn-svg.rb

@@ -2,7 +2,9 @@
 
 require 'prawn-svg'
 require_relative 'prawn-svg/calculators/document_sizing'
+require_relative 'prawn-svg/elements/image'
 require_relative 'prawn-svg/loaders/data'
+require_relative 'prawn-svg/loaders/file'
 require_relative 'prawn-svg/loaders/web'
 require_relative 'prawn-svg/url_loader'
 # NOTE: disable system fonts since they're non-portable

data/lib/asciidoctor/pdf/formatted_text/inline_image_arranger.rb

@@ -48,10 +48,11 @@ module Asciidoctor::PDF::FormattedText
           drop = scratch
         end
         image_path = fragment[:image_path]
-        image_w = fragment[:image_width] || '100%'
-
-        # NOTE: intrinsic width is stored behind % symbol
-        if (pctidx = image_w.index '%') && pctidx + 1 < image_w.length
+        image_format = fragment[:image_format]
+        if (image_w = fragment[:image_width] || '100%') == 'auto'
+          image_w = nil # use intrinsic width
+        elsif (pctidx = image_w.index '%') && pctidx + 1 < image_w.length
+          # NOTE: intrinsic width is stored behind % symbol
           pct = (image_w.slice 0, pctidx).to_f / 100
           intrinsic_w = (image_w.slice pctidx + 1, image_w.length).to_f
           image_w = [available_w, pct * intrinsic_w].min
@@ -62,26 +63,33 @@ module Asciidoctor::PDF::FormattedText
         max_image_h = fragment[:image_fit] == 'line' ? [available_h, doc.font.height].min : available_h
 
         # TODO: make helper method to calculate width and height of image
-        if fragment[:image_format] == 'svg'
+        if image_format == 'svg'
           svg_obj = ::Prawn::SVG::Interface.new ::File.read(image_path, mode: 'r:UTF-8'), doc,
             at: doc.bounds.top_left,
             width: image_w,
             fallback_font_name: doc.fallback_svg_font_name,
             enable_web_requests: doc.allow_uri_read ? (doc.method :load_open_uri).to_proc : false,
-            enable_file_requests_with_root: (::File.dirname image_path),
+            enable_file_requests_with_root: { base: (::File.dirname image_path), root: doc.jail_dir },
             cache_images: doc.cache_uri
           svg_size = svg_obj.document.sizing
           # NOTE: the best we can do is make the image fit within full height of bounds
           if (image_h = svg_size.output_height) > max_image_h
             image_w = (svg_obj.resize height: (image_h = max_image_h)).output_width
-          else
+          elsif image_w
             image_w = svg_size.output_width
+          else
+            fragment[:image_width] = (image_w = svg_size.output_width).to_s
+            image_w = available_w if image_w > available_w
           end
           fragment[:image_obj] = svg_obj
         else
           # TODO: cache image info based on path (Prawn caches based on SHA1 of content)
           # NOTE: image_obj is constrained to image_width by renderer
           image_obj, image_info = ::File.open(image_path, 'rb') {|fd| doc.build_image_object fd }
+          unless image_w
+            fragment[:image_width] = (image_w = to_pt image_info.width, :px).to_s
+            image_w = available_w if image_w > available_w
+          end
           if (image_h = image_w * (image_info.height.fdiv image_info.width)) > max_image_h
             # NOTE: the best we can do is make the image fit within full height of bounds
             image_w = (image_h = max_image_h) * (image_info.width.fdiv image_info.height)
@@ -117,7 +125,7 @@ module Asciidoctor::PDF::FormattedText
         fragment[:image_width] = fragment[:width] = image_w
         fragment[:image_height] = image_h
       rescue
-        logger.warn %(could not embed image: #{image_path}; #{$!.message}#{::Prawn::Errors::UnsupportedImageType === $! && !(defined? ::GMagick::Image) ? '; install prawn-gmagick gem to add support' : ''}) unless scratch
+        logger.warn %(could not embed image: #{image_path}; #{$!.message}#{(doc.recommend_prawn_gmagick? $!, image_format) ? %(; install prawn-gmagick gem to add support for #{image_format&.upcase || 'unknown'} image format) : ''}) unless scratch
         drop = true # delegate to cleanup logic in ensure block
       ensure
         # NOTE: skip rendering image in scratch document or if image can't be loaded

data/lib/asciidoctor/pdf/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module PDF
-    VERSION = '2.0.6'
+    VERSION = '2.0.7'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -261,7 +261,9 @@ files:
 - lib/asciidoctor/pdf/ext/prawn-gmagick.rb
 - lib/asciidoctor/pdf/ext/prawn-svg.rb
 - lib/asciidoctor/pdf/ext/prawn-svg/calculators/document_sizing.rb
+- lib/asciidoctor/pdf/ext/prawn-svg/elements/image.rb
 - lib/asciidoctor/pdf/ext/prawn-svg/loaders/data.rb
+- lib/asciidoctor/pdf/ext/prawn-svg/loaders/file.rb
 - lib/asciidoctor/pdf/ext/prawn-svg/loaders/web.rb
 - lib/asciidoctor/pdf/ext/prawn-svg/url_loader.rb
 - lib/asciidoctor/pdf/ext/prawn-table.rb