hexapdf 0.5.0 → 0.6.0

data/lib/hexapdf/encryption/security_handler.rb

@@ -132,6 +132,32 @@ module HexaPDF
     #   EncryptionDictionary class.
     class SecurityHandler
 
+      # Provides additional encryption specific information for HexaPDF::StreamData objects.
+      class EncryptedStreamData < StreamData
+
+        # The encryption key.
+        attr_reader :key
+
+        # The encryption algorithm.
+        attr_reader :algorithm
+
+        # Creates a new encrypted stream data object by utilizing the given stream data object as
+        # template. The arguments +key+ and +algorithm+ are used for decrypting purposes.
+        def initialize(obj, key, algorithm)
+          obj.instance_variables.each {|v| instance_variable_set(v, obj.instance_variable_get(v))}
+          @key = key
+          @algorithm = algorithm
+        end
+
+        alias :undecrypted_fiber :fiber
+
+        # Returns a fiber like HexaPDF::StreamData#fiber, but one wrapped in a decrypting fiber.
+        def fiber(*args)
+          @algorithm.decryption_fiber(@key, super(*args))
+        end
+
+      end
+
       # :call-seq:
       #   SecurityHandler.set_up_encryption(document, handler_name, **options)   -> handler
       #
@@ -143,8 +169,8 @@ module HexaPDF
       #
       # See: #set_up_encryption (for the common encryption options).
       def self.set_up_encryption(document, handler_name, **options)
-        handler = GlobalConfiguration.constantize('encryption.filter_map', handler_name) do
-          GlobalConfiguration.constantize('encryption.sub_filter_map', handler_name) do
+        handler = document.config.constantize('encryption.filter_map', handler_name) do
+          document.config.constantize('encryption.sub_filter_map', handler_name) do
             raise HexaPDF::EncryptionError, "Could not find the specified security handler"
           end
         end
@@ -170,8 +196,8 @@ module HexaPDF
         if dict.nil?
           raise HexaPDF::EncryptionError, "No /Encrypt dictionary found"
         end
-        handler = HexaPDF::GlobalConfiguration.constantize('encryption.filter_map', dict[:Filter]) do
-          HexaPDF::GlobalConfiguration.constantize('encryption.sub_filter_map', dict[:SubFilter]) do
+        handler = document.config.constantize('encryption.filter_map', dict[:Filter]) do
+          document.config.constantize('encryption.sub_filter_map', dict[:SubFilter]) do
             raise HexaPDF::EncryptionError, "Could not find a suitable security handler"
           end
         end
@@ -237,8 +263,7 @@ module HexaPDF
           unless string_algorithm == stream_algorithm
             key = object_key(obj.oid, obj.gen, stream_algorithm)
           end
-          obj.raw_stream.filter.unshift(:Encryption)
-          obj.raw_stream.decode_parms.unshift(key: key, algorithm: stream_algorithm)
+          obj.data.stream = EncryptedStreamData.new(obj.raw_stream, key, stream_algorithm)
         end
 
         obj
@@ -259,7 +284,14 @@ module HexaPDF
         return obj.stream_encoder if obj.type == :XRef
 
         key = object_key(obj.oid, obj.gen, stream_algorithm)
-        obj.stream_encoder(:Encryption, key: key, algorithm: stream_algorithm)
+        source = obj.stream_source
+        result = obj.stream_encoder(source)
+        if result == source && obj.raw_stream.kind_of?(EncryptedStreamData) &&
+            obj.raw_stream.key == key && obj.raw_stream.algorithm == stream_algorithm
+          obj.raw_stream.undecrypted_fiber
+        else
+          stream_algorithm.encryption_fiber(key, result)
+        end
       end
 
       # Computes the encryption key and sets up the algorithms for encrypting the document based on
@@ -420,12 +452,12 @@ module HexaPDF
 
       # Returns the class that is used for ARC4 encryption.
       def arc4_algorithm
-        @arc4_algorithm ||= HexaPDF::GlobalConfiguration.constantize('encryption.arc4')
+        @arc4_algorithm ||= document.config.constantize('encryption.arc4')
       end
 
       # Returns the class that is used for AES encryption.
       def aes_algorithm
-        @aes_algorithm ||= HexaPDF::GlobalConfiguration.constantize('encryption.aes')
+        @aes_algorithm ||= document.config.constantize('encryption.aes')
       end
 
       # Returns the class that is used for the identity algorithm which passes back the data as is

data/lib/hexapdf/filter/flate_decode.rb

@@ -81,7 +81,7 @@ module HexaPDF
             Fiber.yield(data)
           end
           begin
-            inflater.finish
+            (data = inflater.finish).empty? ? nil : data
           rescue
             raise FilterError, "Problem while decoding Flate encoded stream: #{$!}"
           end

data/lib/hexapdf/filter/lzw_decode.rb

@@ -85,7 +85,7 @@ module HexaPDF
               case table.size
               when 510, 1022, 2046
                 code_length += 1
-              when 4095
+              when 4096
                 if code != CLEAR_TABLE
                   raise FilterError, "Maximum of 12bit for codes in LZW stream exceeded"
                 end

data/lib/hexapdf/filter/predictor.rb

@@ -33,6 +33,7 @@
 
 require 'fiber'
 require 'hexapdf/error'
+require 'hexapdf/configuration'
 require 'hexapdf/utils/bit_stream'
 
 module HexaPDF
@@ -254,8 +255,13 @@ module HexaPDF
             Fiber.yield(result) unless result.empty?
           end
 
-          unless pos == data.length
+          if pos != data.length && GlobalConfiguration['filter.predictor.strict']
             raise FilterError, "Data is missing for PNG predictor"
+          elsif pos != data.length && data.length != 1
+            result = ''.b
+            bytes_per_row = data.length - pos
+            row_action.call(result)
+            result
           end
         end
       end

data/lib/hexapdf/font/true_type/font.rb

@@ -162,6 +162,26 @@ module HexaPDF
           weight / 5
         end
 
+        # Returns the distance from the baseline to the top of the underline.
+        def underline_position
+          self[:post].underline_position
+        end
+
+        # Returns the stroke width for the underline.
+        def underline_thickness
+          self[:post].underline_thickness
+        end
+
+        # Returns the distance from the baseline to the top of the strikeout line.
+        def strikeout_position
+          self[:"OS/2"].strikeout_position
+        end
+
+        # Returns the stroke width for the strikeout line.
+        def strikeout_thickness
+          self[:"OS/2"].strikeout_size
+        end
+
         # Returns th glyph ID of the missing glyph, i.e. 0.
         def missing_glyph_id
           0

data/lib/hexapdf/font/type1/font.rb

@@ -76,6 +76,7 @@ module HexaPDF
         def_delegators :@metrics, :weight, :weight_class, :bounding_box, :italic_angle
         def_delegators :@metrics, :ascender, :descender, :cap_height, :x_height
         def_delegators :@metrics, :dominant_horizontal_stem_width, :dominant_vertical_stem_width
+        def_delegators :@metrics, :underline_thickness
 
         # Creates a new Type1 font object with the given font metrics.
         def initialize(metrics)
@@ -128,6 +129,28 @@ module HexaPDF
           end
         end
 
+        # Returns the distance from the baseline to the top of the underline.
+        def underline_position
+          @metrics.underline_position + @metrics.underline_thickness / 2.0
+        end
+
+        # Returns the distance from the baseline to the top of the strikeout line.
+        def strikeout_position
+          # We use the suggested value from the OpenType spec.
+          225
+        end
+
+        # Returns the thickness of the strikeout line.
+        def strikeout_thickness
+          # The OpenType spec suggests the width of an em-dash or 50, so we use that as
+          # approximation since the AFM files don't contain this information.
+          if (bbox = @metrics.character_metrics[:emdash]&.bbox)
+            bbox[3] - bbox[1]
+          else
+            50
+          end
+        end
+
       end
 
     end

data/lib/hexapdf/font_loader.rb

@@ -79,6 +79,7 @@ module HexaPDF
 
     autoload(:Standard14, 'hexapdf/font_loader/standard14')
     autoload(:FromConfiguration, 'hexapdf/font_loader/from_configuration')
+    autoload(:FromFile, 'hexapdf/font_loader/from_file')
 
   end
 

data/lib/hexapdf/font_loader/from_configuration.rb

@@ -32,6 +32,7 @@
 #++
 
 require 'hexapdf/font/true_type_wrapper'
+require 'hexapdf/font_loader/from_file'
 
 module HexaPDF
   module FontLoader
@@ -62,9 +63,7 @@ module HexaPDF
         unless File.file?(file)
           raise HexaPDF::Error, "The configured font file #{file} does not exist"
         end
-
-        font = HexaPDF::Font::TrueType::Font.new(File.open(file))
-        HexaPDF::Font::TrueTypeWrapper.new(document, font, subset: subset)
+        FromFile.call(document, file, subset: subset)
       end
 
     end

data/lib/hexapdf/font_loader/from_file.rb

@@ -0,0 +1,65 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2017 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#++
+
+require 'hexapdf/font/true_type_wrapper'
+
+module HexaPDF
+  module FontLoader
+
+    # This module interprets the font name as file name and tries to load it.
+    module FromFile
+
+      # Loads the given font by interpreting the font name as file name.
+      #
+      # The file object representing the font file is *not* closed and if needed must be closed by
+      # the caller once the font is not needed anymore.
+      #
+      # +document+::
+      #     The PDF document to associate the font object with.
+      #
+      # +name+::
+      #     The file name.
+      #
+      # +subset+::
+      #     Specifies whether the font should be subset if possible.
+      def self.call(document, name, subset: true, **)
+        return nil unless File.file?(name)
+
+        font = HexaPDF::Font::TrueType::Font.new(File.open(name, 'rb'))
+        HexaPDF::Font::TrueTypeWrapper.new(document, font, subset: subset)
+      end
+
+    end
+
+  end
+end

data/lib/hexapdf/image_loader/png.rb

@@ -347,7 +347,7 @@ module HexaPDF
         image_data = ''.b
         mask_data = ''.b
 
-        flate_decode = GlobalConfiguration.constantize('filter.map', :FlateDecode)
+        flate_decode = @document.config.constantize('filter.map', :FlateDecode)
         source = flate_decode.decoder(Fiber.new(&image_data_proc(offset)))
 
         data = ''.b
@@ -381,7 +381,7 @@ module HexaPDF
         bpc = decode_parms[:BitsPerComponent]
         bytes_per_row = (width * bpc + 7) / 8 + 1
 
-        flate_decode = GlobalConfiguration.constantize('filter.map', :FlateDecode)
+        flate_decode = @document.config.constantize('filter.map', :FlateDecode)
         source = flate_decode.decoder(Fiber.new(&image_data_proc(offset)))
 
         mask_data = ''.b

data/lib/hexapdf/layout.rb

@@ -42,9 +42,10 @@ module HexaPDF
     autoload(:Style, 'hexapdf/layout/style')
     autoload(:TextFragment, 'hexapdf/layout/text_fragment')
     autoload(:InlineBox, 'hexapdf/layout/inline_box')
-    autoload(:LineFragment, 'hexapdf/layout/line_fragment')
+    autoload(:Line, 'hexapdf/layout/line')
     autoload(:TextShaper, 'hexapdf/layout/text_shaper')
-    autoload(:TextBox, 'hexapdf/layout/text_box')
+    autoload(:TextLayouter, 'hexapdf/layout/text_layouter')
+    autoload(:Box, 'hexapdf/layout/box')
 
   end
 

data/lib/hexapdf/layout/box.rb

@@ -0,0 +1,146 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2017 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#++
+require 'hexapdf/layout/style'
+
+module HexaPDF
+  module Layout
+
+    # The base class for all layout boxes.
+    #
+    # HexaPDF uses the following box model:
+    #
+    # * Each box can specify a content width and content height. Padding, border and margin are
+    #   *outside* of this content rectangle.
+    #
+    # * The #width and #height accessors can be used to get the width and height of the box
+    #   including padding and the border.
+    #
+    class Box
+
+      # The width of the content box, i.e. without padding or borders.
+      #
+      # The value 0 means that the width is dynamically determined.
+      attr_reader :content_width
+
+      # The height of the content box, i.e. without padding or borders.
+      #
+      # The value 0 means that the height is dynamically determined.
+      attr_reader :content_height
+
+      # The style to be applied.
+      #
+      # Only the following properties are used:
+      #
+      # * Style#background_color
+      # * Style#padding
+      # * Style#border
+      # * Style#overlay_callback
+      # * Style#underlay_callback
+      attr_reader :style
+
+      # :call-seq:
+      #    Box.new(content_width: 0, content_height: 0, style: Style.new) {|canvas, box| block} -> box
+      #    Box.new(width: 0, height: 0, style: Style.new) {|canvas, box| block} -> box
+      #
+      # Creates a new Box object with the given width and height for its content that uses the
+      # provided block when it is asked to draw itself on a canvas (see #draw).
+      #
+      # Alternative to specifying the content width/height, it is also possible to specify the box
+      # width/height. The content width is then immediately calculated using the border and padding
+      # information from the style and stored.
+      #
+      # Since the final location of the box is not known beforehand, the drawing operations inside
+      # the block should draw inside the rectangle (0, 0, content_width, content_height) - note that
+      # the width and height of the box may not be known beforehand.
+      def initialize(content_width: 0, content_height: 0, width: 0, height: 0,
+                     style: Style.new, &block)
+        @style = (style.kind_of?(Style) ? style : Style.new(style))
+        @draw_block = block
+        @content_width = content_width
+        @content_width = [width - self.width, 0].max if width != 0 && @content_width == 0
+        @content_height = content_height
+        @content_height = [height - self.height, 0].max if height != 0 && @content_height == 0
+      end
+
+      # Returns the width of the box, including padding and border widths.
+      def width
+        @content_width + @style.padding.left + @style.padding.right +
+          @style.border.width.left + @style.border.width.right
+      end
+
+      # Returns the height of the box, including padding and border widths.
+      def height
+        @content_height + @style.padding.top + @style.padding.bottom +
+          @style.border.width.top + @style.border.width.bottom
+      end
+
+      # :call-seq:
+      #   box.draw(canvas, x, y)
+      #
+      # Draws the contents of the box onto the canvas at the position (x, y).
+      #
+      # The coordinate system is translated so that the origin is at the lower left corner of the
+      # contents box during the drawing operations.
+      def draw(canvas, x, y)
+        if style.background_color
+          canvas.save_graphics_state do
+            canvas.fill_color(style.background_color).rectangle(x, y, width, height).fill
+          end
+        end
+
+        style.underlays.draw(canvas, x, y, self)
+
+        unless style.border.none?
+          style.border.draw(canvas, x, y, width, height)
+        end
+
+        if @draw_block
+          canvas.translate(x + style.padding.left + style.border.width.left,
+                           y + style.padding.bottom + style.border.width.bottom) do
+            @draw_block.call(canvas, self)
+          end
+        end
+
+        style.overlays.draw(canvas, x, y, self)
+      end
+
+      # Returns +true+ if no drawing operations are performed.
+      def empty?
+        !(@draw_block || style.background_color || !style.underlays.none? ||
+          !style.border.none? || !style.overlays.none?)
+      end
+
+    end
+
+  end
+end