pdfrb 0.3.0 → 0.7.1

data/lib/pdfrb/model/type/popup_annotation.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Popup annotation (s12.5.6.14). Displays text/markup in a pop-up window.
+      class PopupAnnotation < Annotation
+        def parent; self[:Parent]; end
+        def open?; !!value[:Open]; end
+
+        def markup_annotation
+          ref = parent
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/printer_mark_annotation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Printer-mark annotation (s12.5.6.17). Marks page for trimming,
+      # registration, etc.
+      class PrinterMarkAnnotation < Annotation
+        def mark_subtype; self[:MN]; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/redact_annotation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Redaction annotation (s12.5.6.16). Marks content for removal.
+      class RedactAnnotation < MarkupAnnotation
+        def overlay_text; self[:OverlayText]; end
+        def repeat_overlay?; truthy?(self[:Repeat]); end
+        def quadding; self[:Q]; end
+        def interior_color; self[:IC]; end
+        def da; self[:DA]; end
+
+        def alignment
+          case quadding
+          when 1 then :center
+          when 2 then :right
+          else :left
+          end
+        end
+
+        def has_overlay_text?
+          !!overlay_text && (!overlay_text.is_a?(String) || !overlay_text.empty?)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rendition.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rendition dictionary (s13.3.5). Describes a media clip plus
+      # how it should be played.
+      class Rendition < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:S]&.to_sym; end
+        def media_clip; self[:C]; end
+        def operation; self[:OP]; end
+
+        def media?
+          subtype == :MR
+        end
+
+        def selector?
+          subtype == :SR
+        end
+
+        def resolved_media_clip
+          ref = media_clip
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/resources.rb

@@ -8,36 +8,81 @@ module Pdfrb
       class Resources < Pdfrb::Model::Cos::Dictionary
         arlington_object "Resource"
 
-        def font(name)
-          lookup_named(:Font, name)
+        def fonts; self[:Font]; end
+        def xobjects; self[:XObject]; end
+        def ext_gstates; self[:ExtGState]; end
+        def color_spaces; self[:ColorSpace]; end
+        def patterns; self[:Pattern]; end
+        def shadings; self[:Shading]; end
+        def properties_dict; self[:Properties]; end
+        def proc_set; self[:ProcSet]; end
+
+        def font_names
+          dict_keys(fonts)
+        end
+
+        def xobject_names
+          dict_keys(xobjects)
         end
 
-        def xobject(name)
-          lookup_named(:XObject, name)
+        def ext_gstate_names
+          dict_keys(ext_gstates)
         end
 
-        def ext_gstate(name)
-          lookup_named(:ExtGState, name)
+        def color_space_names
+          dict_keys(color_spaces)
         end
 
-        def color_space(name)
-          lookup_named(:ColorSpace, name)
+        def pattern_names
+          dict_keys(patterns)
         end
 
-        def pattern(name)
-          lookup_named(:Pattern, name)
+        def shading_names
+          dict_keys(shadings)
         end
 
-        def shading(name)
-          lookup_named(:Shading, name)
+        def font(name); lookup_named(:Font, name); end
+        def xobject(name); lookup_named(:XObject, name); end
+        def ext_gstate(name); lookup_named(:ExtGState, name); end
+        def color_space(name); lookup_named(:ColorSpace, name); end
+        def pattern(name); lookup_named(:Pattern, name); end
+        def shading(name); lookup_named(:Shading, name); end
+        def properties(name); lookup_named(:Properties, name); end
+
+        def has_procset?(name)
+          return false unless proc_set
+
+          arr = proc_set.is_a?(Pdfrb::Model::PdfArray) ? proc_set.to_a : proc_set
+          arr.is_a?(Array) && arr.include?(name)
         end
 
-        def properties(name)
-          lookup_named(:Properties, name)
+        def empty?
+          %i[Font XObject ExtGState ColorSpace Pattern Shading Properties].all? do |k|
+            value[k].nil? || empty_collection?(value[k])
+          end
         end
 
         private
 
+        def empty_collection?(value)
+          case value
+          when ::Array, ::Hash then value.empty?
+          when Pdfrb::Model::Cos::Dictionary, Pdfrb::Model::PdfArray then value.value.empty?
+          else false
+          end
+        end
+
+        def dict_keys(dict)
+          return [] unless dict
+
+          obj = dict.is_a?(Pdfrb::Model::Reference) && document ? document.object(dict) : dict
+          case obj
+          when Hash then obj.keys
+          when Pdfrb::Model::Cos::Dictionary then obj.value.keys
+          else []
+          end
+        end
+
         def lookup_named(key, name)
           sub = self[key]
           return nil unless sub.is_a?(::Hash) || sub.is_a?(Pdfrb::Model::Cos::Dictionary)

data/lib/pdfrb/model/type/rich_media_activation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Activation (s13.6.1). Activation behaviour settings.
+      class RichMediaActivation < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def condition; self[:Condition]&.to_sym; end
+        def configuration; self[:Configuration]; end
+        def presentation; self[:Presentation]; end
+        def scripts; self[:Scripts]; end
+
+        def activation_on_click?; condition == :PO; end
+        def activation_on_page_open?; condition == :PV; end
+        def activation_on_page_visible?; condition == :XA; end
+
+        def has_configuration?
+          !!configuration
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_animation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Animation (s13.6.2). Playback control for
+      # rich media instances.
+      class RichMediaAnimation < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+        def play_count; self[:PlayCount] || -1; end
+        def speed; self[:Speed] || 1; end
+        def animation_offset; self[:AO] || 0; end
+
+        def no_animation?; subtype == :None; end
+        def linear?; subtype == :Linear; end
+        def oscillating?; subtype == :Oscillating; end
+
+        def loop_forever?
+          play_count.negative?
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_annotation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media annotation (s12.5.6.20, PDF 1.7 ExtensionLevel 3 +
+      # PDF 2.0). Hosts interactive rich media content (Flash, video).
+      class RichMediaAnnotation < Annotation
+        def rich_media_settings; self[:RichMediaSettings]; end
+        def rich_media_content; self[:RichMediaContent]; end
+
+        def has_rich_media?
+          !!rich_media_content
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Command (s13.6.4). A command sent to a rich media
+      # instance.
+      class RichMediaCommand < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def command_name; self[:Cmd]; end
+        def arguments; self[:Args]; end
+
+        def has_arguments?
+          !!arguments && (!arguments.is_a?(Array) || !arguments.empty?)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_configuration.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Configuration (s13.6.2). A media instance list.
+      class RichMediaConfiguration < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def instances; self[:Instances]; end
+        def name; self[:Name]; end
+
+        def instance_count
+          return 0 unless instances
+
+          arr = instances.is_a?(Pdfrb::Model::PdfArray) ? instances.to_a : instances
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def each_instance
+          return enum_for(:each_instance) unless block_given?
+          return unless instances && document
+
+          arr = instances.is_a?(Pdfrb::Model::PdfArray) ? instances.to_a : instances
+          arr.each do |ref|
+            obj = ref.is_a?(Pdfrb::Model::Reference) ? document.object(ref) : ref
+            yield obj if obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_content.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Content (s13.6.5). Top-level rich media assets bundle.
+      class RichMediaContent < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def configurations; self[:Configurations]; end
+        def assets; self[:Assets]; end
+
+        def configuration_count
+          return 0 unless configurations
+
+          arr = configurations.is_a?(Pdfrb::Model::PdfArray) ? configurations.to_a : configurations
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def asset_count
+          return 0 unless assets
+
+          obj = assets.is_a?(Pdfrb::Model::Reference) && document ? document.object(assets) : assets
+          obj.is_a?(Pdfrb::Model::Cos::Dictionary) ? obj.value.size : 0
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_cue_point.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Cue Point (s13.6.6). Time marker in a media playback.
+      class RichMediaCuePoint < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def time; self[:Time]; end
+        def name; self[:Name]; end
+
+        def has_time?
+          !!time
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_deactivation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Deactivation (s13.6.1). Deactivation behaviour.
+      class RichMediaDeactivation < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def condition; self[:Condition]&.to_sym; end
+
+        def deactivation_on_click?; condition == :PC; end
+        def deactivation_on_page_close?; condition == :PI; end
+        def deactivation_on_page_hidden?; condition == :XD; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_instance.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Instance (s13.6.3). A single playable instance.
+      class RichMediaInstance < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+        def media_clip; self[:Asset]; end
+
+        def flash?
+          subtype == :Flash
+        end
+
+        def sound?
+          subtype == :Sound
+        end
+
+        def video?
+          subtype == :Video
+        end
+
+        def resolved_media_clip
+          ref = media_clip
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_presentation.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Presentation (s13.6.1). Visual presentation settings
+      # for a RichMedia annotation (style, window, transparency, etc.).
+      class RichMediaPresentation < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def style; self[:Style]&.to_sym; end
+        def window; self[:Window]; end
+        def transparent?; truthy?(self[:Transparent]); end
+        def navigation_pane?; truthy?(self[:NavigationPane]); end
+        def toolbar?; truthy?(self[:Toolbar]); end
+        def pass_context_click?; truthy?(self[:PassContextClick]); end
+
+        def embedded_style?; style == :Embedded; end
+        def windowed_style?; style == :Windowed; end
+
+        def resolved_window
+          ref = window
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_settings.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Settings (s13.6.2). Top-level activation/deactivation
+      # configuration for a RichMedia annotation.
+      class RichMediaSettings < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def activation; self[:Activation]; end
+        def deactivation; self[:Deactivation]; end
+
+        def has_activation?
+          !!activation
+        end
+
+        def resolved_activation
+          ref = activation
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def resolved_deactivation
+          ref = deactivation
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/rich_media_window.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rich Media Window (s13.6.1). Window dimensions and position
+      # for windowed rich media.
+      class RichMediaWindow < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def width; self[:Width]; end
+        def height; self[:Height]; end
+        def position; self[:Position]; end
+
+        def has_dimensions?
+          !!width && !!height
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/screen_annotation.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Screen annotation (s12.5.6.18). Holds media played via Action
+      # triggers. /Subtype /Screen.
+      class ScreenAnnotation < Annotation
+        def attachment_point; self[:AP]; end
+        def media_type; self[:T]; end
+        def actions; self[:AA]; end
+
+        def has_media?
+          !!media_type
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/separation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Separation color space (s8.6.6.3). A single custom colorant
+      # mapped through a tint-transform function. Used for spot colors
+      # like PANTONE 185 C.
+      class Separation < Pdfrb::Model::Cos::Dictionary
+        def alternate_space; self[:AlternateSpace]; end
+        def tint_transform; self[:TintTransform]; end
+        def colorant_name; self[:Colorant]; end
+
+        def components; 1; end
+
+        def resolved_tint_transform
+          ref = tint_transform
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/sig_field_lock.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Signature field lock (s12.7.6.5). Specifies which fields are
+      # locked after signing.
+      class SigFieldLock < Pdfrb::Model::Cos::Dictionary
+        def action; self[:Action]&.to_sym; end
+        def fields; self[:Fields]; end
+
+        def all_locked?; action == :All; end
+        def include_locked?; action == :Include; end
+        def exclude_locked?; action == :Exclude; end
+
+        def locked_field_names
+          return [] unless include_locked? && fields
+
+          arr = fields.is_a?(Pdfrb::Model::PdfArray) ? fields.to_a : fields
+          arr.is_a?(Array) ? arr : []
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/sig_field_seed_value.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Signature field seed value (s12.7.6.6). Constraints the signer
+      # must obey when signing (cert issuers, hash algorithms, etc.).
+      class SigFieldSeedValue < Pdfrb::Model::Cos::Dictionary
+        def filter; self[:Filter]; end
+        def sub_filter; self[:SubFilter]; end
+        def digest_method; self[:DigestMethod]; end
+        def cert; self[:Cert]; end
+        def flags; self[:F] || 0; end
+        def legal_attestation; self[:LegalAttestation]; end
+        def add_rev_info?; flags & 1 != 0; end
+        def add_doc_mdp?; flags & 2 != 0; end
+        def add_field_mdp?; flags & 4 != 0; end
+        def required_filter?; filter && flags.anybits?(0x100); end
+        def required_subfilter?; sub_filter && flags.anybits?(0x200); end
+        def required_digest?; digest_method && flags.anybits?(0x400); end
+        def required_cert?; cert && flags.anybits?(0x800); end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/signature.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Signature dictionary (s12.8.2). Carries the PKCS#7 / CMS
+      # signature payload. Lives in a Signature field's /V entry.
+      class Signature < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def filter; self[:Filter]; end
+        def sub_filter; self[:SubFilter]; end
+        def contents; self[:Contents]; end
+        def cert; self[:Cert]; end
+        def byte_range; self[:ByteRange]; end
+        def reference; self[:Reference]; end
+        def changes; self[:Changes]; end
+        def name; self[:Name]; end
+        def reason; self[:Reason]; end
+        def location; self[:Location]; end
+        def contact_info; self[:ContactInfo]; end
+        def m; self[:M]; end
+        def prop_build; self[:Prop_Build]; end
+        def prop_auth_time; self[:Prop_AuthTime]; end
+        def prop_auth_type; self[:Prop_AuthType]; end
+
+        def signed_time
+          return nil unless m
+
+          m.is_a?(Time) ? m : parse_pdf_date(m)
+        end
+
+        def pkcs7_detached?
+          sub_filter == :"adbe.pkcs7.detached"
+        end
+
+        def pkcs7_sha1?
+          sub_filter == :"adbe.pkcs7.sha1"
+        end
+
+        def pkcs1?
+          sub_filter == :"adbe.x509.rsa_sha1"
+        end
+
+        def has_byte_range?
+          byte_range.is_a?(Array) && byte_range.size == 4
+        end
+
+        private
+
+        def parse_pdf_date(str)
+          return nil unless str
+
+          match = str.to_s.match(/^D:(\d{4})(\d{2})(\d{2})(\d{2})?(\d{2})?(\d{2})?/)
+          return nil unless match
+
+          Time.new(match[1].to_i, match[2].to_i, match[3].to_i,
+                   (match[4] || 0).to_i, (match[5] || 0).to_i, (match[6] || 0).to_i,
+                   "+00:00")
+        rescue StandardError
+          nil
+        end
+      end
+    end
+  end
+end