origami 2.0.0 → 2.0.1

data/lib/origami/javascript.rb

@@ -23,16 +23,6 @@ module Origami
     begin
         require 'v8'
 
-        class V8::Object
-            #def inspect
-            #   case self
-            #   when V8::Array,V8::Function then super
-            #   else
-            #       "{#{self.to_a.map{|k,v| "#{k}:#{v.inspect}"}.join(', ')}}"
-            #   end
-            #end
-        end
-
         class PDF
 
             module JavaScript
@@ -105,37 +95,43 @@ module Origami
 
                     def self.check_method_args(args, def_args)
                         if args.first.is_a?(V8::Object)
-                            args = args.first
-                            members = args.entries.map{|k,v| k}
-                            argv = []
-                            def_args.each do |def_arg|
-                                raise MissingArgError if def_arg.required and not members.include?(def_arg.name)
-
-                                if members.include?(def_arg.name)
-                                    arg = args[def_arg.name]
-                                    raise TypeError if def_arg.type and not arg.is_a?(def_arg.type)
-                                else
-                                    arg = def_arg.default
-                                end
-
-                                argv.push(arg)
-                            end
-
-                            args = argv
+                            check_method_named_args(args.first, def_args)
                         else
-                            i = 0
-                            def_args.each do |def_arg|
-                                raise MissingArgError if def_arg.required and i >= args.length
-                                raise TypeError if def_arg.type and not args[i].is_a?(def_arg.type)
+                            check_method_ordered_args(args, def_args)
+                        end
+                    end
 
-                                args.push(def_arg.default) if i >= args.length
+                    def self.check_method_named_args(object, def_args)
+                        members = object.entries.map {|k, _| k}
+                        argv = []
+                        def_args.each do |def_arg|
+                            raise MissingArgError if def_arg.required and not members.include?(def_arg.name)
 
-                                i = i + 1
+                            if members.include?(def_arg.name)
+                                arg = object[def_arg.name]
+                                raise TypeError if def_arg.type and not arg.is_a?(def_arg.type)
+                            else
+                                arg = def_arg.default
                             end
+
+                            argv.push(arg)
+                        end
+
+                        argv
+                    end
+                    private_class_method :check_method_named_args
+
+                    def self.check_method_ordered_args(args, def_args)
+                        def_args.each_with_index do |def_arg, index|
+                            raise MissingArgError if def_arg.required and index >= args.length
+                            raise TypeError if def_arg.type and not args[index].is_a?(def_arg.type)
+
+                            args.push(def_arg.default) if index >= args.length
                         end
 
                         args
                     end
+                    private_class_method :check_method_ordered_args
 
                     def self.acro_method(name, *def_args, &b)
                         define_method(name) do |*args|
@@ -158,7 +154,9 @@ module Origami
                                 )
                             end
 
-                            raise NotAllowedError
+                            unless @engine.privileged?
+                                raise NotAllowedError, "Security settings prevent access to this property or method."
+                            end
 
                             args = AcrobatObject.check_method_args(args, def_args)
                             self.instance_exec(*args, &b) if b
@@ -230,12 +228,12 @@ module Origami
 
                     acro_method 'setPersistent',
                         Arg[name: 'cVariable', required: true],
-                        Arg[name: 'bPersist', required: true] do |cVariable, bPersist|
+                        Arg[name: 'bPersist', required: true] do |cVariable, _bPersist|
 
                         raise GeneralError unless @vars.include?(cVariable)
                     end
 
-                  acro_method 'subscribe',
+                    acro_method 'subscribe',
                         Arg[name: 'cVariable', required: true],
                         Arg[name: 'fCallback', type: V8::Function, require: true] do |cVariable, fCallback|
 
@@ -344,7 +342,7 @@ module Origami
 
                     acro_method 'getDataObjectContents',
                         Arg[name: 'cName', type: ::String, required: true],
-                        Arg[name: 'bAllowAuth', default: false] do |cName, bAllowAuth|
+                        Arg[name: 'bAllowAuth', default: false] do |cName, _bAllowAuth|
 
                         file_desc = @pdf.resolve_name(Names::EMBEDDED_FILES, cName)
 
@@ -359,7 +357,7 @@ module Origami
                         Arg[name: 'cName', type: ::String, required: true],
                         Arg[name: 'cDIPath' ],
                         Arg[name: 'bAllowAuth'],
-                        Arg[name: 'nLaunch'] do |cName, cDIPath, bAllowAuth, nLaunch|
+                        Arg[name: 'nLaunch'] do |cName, _cDIPath, _bAllowAuth, _nLaunch|
 
                         file_desc = @pdf.resolve_name(Names::EMBEDDED_FILES, cName)
 
@@ -454,7 +452,7 @@ module Origami
                 class Console < AcrobatObject
                     def println(*args)
                         raise MissingArgError unless args.length > 0
-                        
+
                         @engine.options[:console].puts(args.first.to_s)
                     end
 
@@ -466,14 +464,14 @@ module Origami
                 class Util < AcrobatObject
                     acro_method 'streamFromString',
                         Arg[name: 'cString', type: ::Object, required: true],
-                        Arg[name: 'cCharset', type: ::Object, default: 'utf-8'] do |cString, cCharset|
+                        Arg[name: 'cCharset', type: ::Object, default: 'utf-8'] do |cString, _cCharset|
 
                         ReadStream.new(@engine, cString.to_s)
                     end
 
                     acro_method 'stringFromStream',
                         Arg[name: 'oStream', type: ReadStream, required: true],
-                        Arg[name: 'cCharset', type: ::Object, default: 'utf-8'] do |oStream, cCharset|
+                        Arg[name: 'cCharset', type: ::Object, default: 'utf-8'] do |oStream, _cCharset|
 
                         oStream.instance_variable_get(:@data).dup
                     end
@@ -500,32 +498,46 @@ module Origami
                     end
 
                     def type
-                        (if @field.has_key?(:FT)
-                            case @field.FT.value
-                            when PDF::Field::Type::BUTTON
-                                if @fields.has_key?(:Ff)
-                                    flags = @field.Ff.value
-
-                                    if (flags & Origami::Annotation::Widget::Button::Flags::PUSHBUTTON) != 0
-                                        'button'
-                                    elsif (flags & Origami::Annotation::Widget::Button::Flags::RADIO) != 0
-                                        'radiobox'
-                                    else
-                                        'checkbox'
-                                    end
-                                end
-                            when PDF::Field::Type::TEXT then 'text'
-                            when PDF::Field::Type::SIGNATURE then 'signature'
-                            when PDF::Field::Type::CHOICE
-                                if @field.has_key?(:Ff)
-                                    if (@field.Ff.value & Origami::Annotation::Widget::Choice::Flags::COMBO).zero?
-                                        'listbox'
-                                    else
-                                        'combobox'
-                                    end
-                                end
-                            end
-                        end).to_s
+                        return '' unless @field.key?(:FT)
+
+                        type_name =
+                        case @field.FT.value
+                        when PDF::Field::Type::BUTTON
+                            button_type
+
+                        when PDF::Field::Type::TEXT then 'text'
+                        when PDF::Field::Type::SIGNATURE then 'signature'
+                        when PDF::Field::Type::CHOICE
+                            choice_type
+                        end
+
+                        type_name.to_s
+                    end
+
+                    private
+
+                    def button_type
+                        return if @field.key?(:Ff) and not @field.Ff.is_a?(Integer)
+
+                        flags = @field.Ff.to_i
+                        
+                       if (flags & Annotation::Widget::Button::Flags::PUSHBUTTON) != 0
+                           'button'
+                       elsif (flags & Annotation::Widget::Button::Flags::RADIO) != 0
+                           'radiobox'
+                       else
+                           'checkbox'
+                       end
+                    end
+
+                    def choice_type
+                        return if @field.key?(:Ff) and not @field.Ff.is_a?(Integer)
+
+                        if (@field.Ff.to_i & Annotation::Widget::Choice::Flags::COMBO) != 0
+                            'combobox'
+                        else
+                            'listbox'
+                        end
                     end
                 end
 
@@ -553,6 +565,7 @@ module Origami
                 attr_reader :doc
                 attr_reader :context
                 attr_reader :options
+                attr_reader :privileged_mode
                 attr_reader :parseInt
 
                 def initialize(pdf)
@@ -563,16 +576,26 @@ module Origami
                         viewerVariation: JavaScript::Viewers::ADOBE_READER,
                         platform: JavaScript::Platforms::WINDOWS,
                         console: STDOUT,
-                        log_method_calls: false
+                        log_method_calls: false,
+                        privileged_mode: false
                     }
 
                     @doc = JavaScript::Doc.new(self, pdf)
                     @context = V8::Context.new(with: @doc)
+                    @privileged_mode = @options[:privileged_mode]
 
                     @parseInt = V8::Context.new['parseInt']
                     @hooks = {}
                 end
 
+                #
+                # Returns true if the engine is set to execute in privileged mode.
+                # Allows execution of security protected methods.
+                #
+                def privileged?
+                    @privileged_mode
+                end
+
                 #
                 # Evaluates a JavaScript code in the current context.
                 #

data/lib/origami/linearization.rb

@@ -50,29 +50,17 @@ module Origami
             #
             prev_trailer = @revisions.first.trailer
 
-            lin_dict = @revisions.first.objects.min_by{|obj| obj.file_offset}
-            hints = lin_dict[:H]
+            linear_dict = @revisions.first.objects.min_by{|obj| obj.file_offset}
 
             #
             # Removes hint streams used by linearization.
             #
-            if hints.is_a?(::Array)
-                if hints.length > 0 and hints[0].is_a?(Integer)
-                    hint_stream = get_object_by_offset(hints[0])
-                    delete_object(hint_stream.reference) if hint_stream.is_a?(Stream)
-                end
-
-                if hints.length > 2 and hints[2].is_a?(Integer)
-                    overflow_stream = get_object_by_offset(hints[2])
-                    delete_object(overflow_stream.reference) if overflow_stream.is_a?(Stream)
-                end
-            end
+            delete_hint_streams(linear_dict)
 
             #
             # Update the trailer.
             #
             last_trailer = (@revisions.last.trailer ||= Trailer.new)
-
             last_trailer.dictionary ||= Dictionary.new
 
             if prev_trailer.has_dictionary?
@@ -98,13 +86,30 @@ module Origami
             #
             # Remove the linearization revision.
             #
-            @revisions.first.body.delete(lin_dict.reference)
+            @revisions.first.body.delete(linear_dict.reference)
             @revisions.last.body.merge! @revisions.first.body
 
             remove_revision(0)
 
             self
         end
+
+        private
+
+        #
+        # Strip the document from Hint streams given a linearization dictionary.
+        #
+        def delete_hint_streams(linearization_dict)
+            hints = linearization_dict[:H]
+            return unless hints.is_a?(Array)
+
+            hints.each_slice(2) do |offset, _length|
+                next unless offset.is_a?(Integer)
+
+                stream = get_object_by_offset(offset)
+                delete_object(stream.reference) if stream.is_a?(Stream)
+            end
+        end
     end
 
     #
@@ -192,10 +197,9 @@ module Origami
                 data << [ item_data ].pack("B*")
             end
 
-            i = 0
             nitems = self.class.nb_entry_items
-            @entries.each do |entry|
-                for no in (1..items)
+            @entries.each_with_index do |entry, i|
+                for no in (1..nitems)
                     unless entry.include?(no)
                         raise InvalidHintTableError, "Missing item #{no} in entry #{i} of #{self.class}"
                     end
@@ -209,8 +213,6 @@ module Origami
 
                     data << [ item_data ].pack("B*")
                 end
-
-                i = i + 1
             end
 
             data

data/lib/origami/metadata.rb

@@ -87,7 +87,7 @@ module Origami
         #
         def create_metadata(info = {})
             skeleton = <<-XMP
-            <?packet begin="#{"\xef\xbb\xbf"}" id="W5M0MpCehiHzreSzNTczkc9d"?>
+            <?packet begin="\xef\xbb\xbf" id="W5M0MpCehiHzreSzNTczkc9d"?>
               <x:xmpmeta xmlns:x="adobe:ns:meta/">
                 <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
                   <rdf:Description rdf:about="" xmlns:pdf="http://ns.adobe.com/pdf/1.3/">

data/lib/origami/name.rb

@@ -76,7 +76,7 @@ module Origami
             super(TOKENS.first + Name.expand(@value))
         end
 
-        def self.parse(stream, parser = nil) #:nodoc:
+        def self.parse(stream, _parser = nil) #:nodoc:
             offset = stream.pos
 
             name =
@@ -127,8 +127,6 @@ module Origami
                 "#" + c.ord.to_s(16).rjust(2,"0")
             end
         end
-
-        def self.native_type ; Name end
     end
 
 end

data/lib/origami/null.rb

@@ -36,7 +36,7 @@ module Origami
             super
         end
 
-        def self.parse(stream, parser = nil) #:nodoc:
+        def self.parse(stream, _parser = nil) #:nodoc:
             offset = stream.pos
 
             if stream.skip(@@regexp).nil?
@@ -59,8 +59,6 @@ module Origami
         def to_s #:nodoc:
             super(TOKENS.first)
         end
-
-        def self.native_type ; Null end
     end
 
 end

data/lib/origami/numeric.rb

@@ -86,22 +86,12 @@ module Origami
         def to_s
             super(value.to_s)
         end
-
-        module ClassMethods #:nodoc:all
-            def native_type; Number end
-        end
-
-        def self.included(receiver) #:nodoc:
-            receiver.extend(ClassMethods)
-        end
-
-        def self.native_type; Number end #:nodoc:
     end
 
     #
     # Class representing an Integer Object.
     #
-    class Integer < DelegateClass(Bignum)
+    class Integer < DelegateClass(::Integer)
         include Number
 
         TOKENS = [ "(\\+|-)?[\\d]+[^.]?" ] #:nodoc:
@@ -121,7 +111,7 @@ module Origami
             super(i)
         end
 
-        def self.parse(stream, parser = nil) #:nodoc:
+        def self.parse(stream, _parser = nil) #:nodoc:
             offset = stream.pos
 
             if not stream.scan(@@regexp)
@@ -165,7 +155,7 @@ module Origami
             super(f)
         end
 
-        def self.parse(stream, parser = nil) #:nodoc:
+        def self.parse(stream, _parser = nil) #:nodoc:
             offset = stream.pos
 
             if not stream.scan(@@regexp)

data/lib/origami/object.rb

@@ -25,13 +25,7 @@ module Origami
 
     module TypeConversion
 
-        refine ::Bignum do
-            def to_o
-                Origami::Integer.new(self)
-            end
-        end
-
-        refine ::Fixnum do
+        refine ::Integer do
             def to_o
                 Origami::Integer.new(self)
             end
@@ -92,6 +86,30 @@ module Origami
     class Error < StandardError
     end
 
+    #
+    # Provides an easier syntax for field access.
+    # The object must have the defined the methods #[] and #[]=.
+    #
+    # Once included, object.Field will automatically resolve to object[:Field].
+    # References are automatically followed.
+    #
+    module FieldAccessor
+        def method_missing(field, *args)
+            raise NoMethodError, "No method `#{field}' for #{self.class}" unless field =~ /^[[:upper:]]/
+
+            if field[-1] == '='
+                self[field[0..-2].to_sym] = args.first
+            else
+                object = self[field]
+                object.is_a?(Reference) ? object.solve : object
+            end
+        end
+
+        def respond_to_missing?(field, *)
+            not (field =~ /^[[:upper:]]/).nil? or super
+        end
+    end
+
     #
     # Mixin' module for objects which can store their options into an inner Dictionary.
     #
@@ -114,9 +132,12 @@ module Origami
                 @fields
             end
 
+            #
+            # Define a new field with given attributes.
+            #
             def field(name, attributes)
                 if attributes[:Required] == true and attributes.has_key?(:Default) and attributes[:Type] == Name
-                    self.add_type_info(self, name, attributes[:Default])
+                    self.add_type_signature(name, attributes[:Default])
                 end
 
                 if @fields.has_key?(name)
@@ -128,7 +149,30 @@ module Origami
                 define_field_methods(name)
             end
 
-            def define_field_methods(field)
+            #
+            # Returns an array of required fields for the current Object.
+            #
+            def required_fields
+                fields = []
+                @fields.each_pair do |name, attributes|
+                    fields << name if attributes[:Required] == true
+                end
+
+                fields
+            end
+
+            #
+            # Returns the expected type for a field name.
+            #
+            def hint_type(name)
+                if @fields.has_key?(name)
+                    @fields[name][:Type]
+                end
+            end
+
+            private
+
+            def define_field_methods(field) #:nodoc:
 
                 #
                 # Getter method.
@@ -157,24 +201,6 @@ module Origami
                     self
                 end
             end
-
-            #
-            # Returns an array of required fields for the current Object.
-            #
-            def required_fields
-                fields = []
-                @fields.each_pair do |name, attributes|
-                    fields << name if attributes[:Required] == true
-                end
-
-                fields
-            end
-
-            def hint_type(name)
-                if @fields.has_key?(name)
-                    @fields[name][:Type]
-                end
-            end
         end
 
         def pre_build #:nodoc:
@@ -184,14 +210,6 @@ module Origami
             super
         end
 
-        #
-        # Check if an attribute is set in the current Object.
-        # _attr_:: The attribute name.
-        #
-        def has_field? (field)
-            not self[field].nil?
-        end
-
         #
         # Returns the version and level required by the current Object.
         #
@@ -218,6 +236,8 @@ module Origami
             max
         end
 
+        private
+
         def set_default_value(field) #:nodoc:
             if self.class.fields[field][:Default]
                 self[field] = self.class.fields[field][:Default]
@@ -227,7 +247,7 @@ module Origami
 
         def set_default_values #:nodoc:
             self.class.required_fields.each do |field|
-                set_default_value(field) unless has_field?(field)
+                set_default_value(field) unless self.key?(field)
             end
         end
 
@@ -238,18 +258,18 @@ module Origami
                 begin
                     field_value = self[field].solve
                 rescue InvalidReferenceError
-                    STDERR.puts "Warning: in object #{self.class}, field `#{field.to_s}' is an invalid reference (#{self[field].to_s})"
+                    STDERR.puts "Warning: in object #{self.class}, field `#{field}' is an invalid reference (#{self[field]})"
                     next
                 end
 
                 types = attributes[:Type].is_a?(::Array) ? attributes[:Type] : [ attributes[:Type] ]
 
                 unless types.any? {|type| not type.is_a?(Class) or field_value.is_a?(type.native_type)}
-                    STDERR.puts "Warning: in object #{self.class}, field `#{field.to_s}' has unexpected type #{field_value.class}"
+                    STDERR.puts "Warning: in object #{self.class}, field `#{field}' has unexpected type #{field_value.class}"
                 end
 
                 if attributes.key?(:Assert) and not (attributes[:Assert] === field_value)
-                    STDERR.puts "Warning: assertion failed for field `#{field.to_s}' in object #{self.class}"
+                    STDERR.puts "Warning: assertion failed for field `#{field}' in object #{self.class}"
                 end
             end
         end
@@ -267,7 +287,7 @@ module Origami
         end
     end
 
-    WHITESPACES = "([ \\f\\t\\r\\n\\0]|%[^\\n]*\\n)*" #:nodoc:
+    WHITESPACES = "([ \\f\\t\\r\\n\\0]|%[^\\n\\r]*(\\r\\n|\\r|\\n))*" #:nodoc:
     WHITECHARS_NORET = "[ \\f\\t\\0]*" #:nodoc:
     EOL = "\r\n" #:nodoc:
     WHITECHARS = "[ \\f\\t\\r\\n\\0]*" #:nodoc:
@@ -296,6 +316,36 @@ module Origami
         attr_accessor :no, :generation, :file_offset, :objstm_offset
         attr_accessor :parent
 
+        #
+        # Modules or classes including this module are considered native types.
+        #
+        def self.included(base)
+            base.class_variable_set(:@@native_type, base)
+            base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+            # Returns the native type of the derived class or module.
+            def native_type
+                self.class_variable_get(:@@native_type)
+            end
+
+            private
+
+            # Propagate native type to submodules.
+            def included(klass)
+                klass.class_variable_set(:@@native_type, self)
+                klass.extend(ClassMethods)
+            end
+        end
+
+        #
+        # Returns the native type of the Object.
+        #
+        def native_type
+            self.class.native_type
+        end
+
         #
         # Creates a new PDF Object.
         #
@@ -395,31 +445,18 @@ module Origami
         #
         def xrefs
             raise InvalidObjectError, "Cannot find xrefs to a direct object" unless self.indirect?
+            raise InvalidObjectError, "Not attached to any document" if self.document.nil?
 
-            if self.document.nil?
-                raise InvalidObjectError, "Not attached to any document"
-            end
-
-            refs = []
-            @document.root_objects.each do |obj|
-                if obj.is_a?(ObjectStream)
-                    obj.each do |child|
-                        case child
+            @document.each_object(compressed: true)
+                     .flat_map { |object|
+                        case object
+                        when Stream
+                            object.dictionary.xref_cache[self.reference]
                         when Dictionary, Array
-                            refs.concat child.xref_cache[self.reference] if child.xref_cache.key?(self.reference)
+                            object.xref_cache[self.reference]
                         end
-                    end
-                end
-
-                obj = obj.dictionary if obj.is_a?(Stream)
-
-                case obj
-                when Dictionary, Array
-                    refs.concat obj.xref_cache[self.reference] if obj.xref_cache.key?(self.reference)
-                end
-            end
-
-            refs
+                     }
+                     .compact!
         end
 
         #
@@ -459,7 +496,7 @@ module Origami
 
                 if obj.is_a?(ObjectStream)
                     obj.each do |subobj|
-                        resolve_all_references[obj, browsed, ref_cache]
+                        resolve_all_references[subobj, browsed, ref_cache]
                     end
                 end
 
@@ -629,15 +666,6 @@ module Origami
             name.split("::").last.to_sym
         end
 
-        def self.native_type; Origami::Object end #:nodoc:
-
-        #
-        # Returns the native PDF type of this Object.
-        #
-        def native_type
-          self.class.native_type
-        end
-
         def cast_to(type, _parser = nil) #:nodoc:
             if type.native_type != self.native_type
                 raise TypeError, "Incompatible cast from #{self.class} to #{type}"