origami 1.0.2

data/origami/array.rb

@@ -0,0 +1,187 @@
+=begin
+
+= File
+	array.rb
+
+= Info
+	This file is part of Origami, PDF manipulation framework for Ruby
+	Copyright (C) 2010	Guillaume DelugrÈ <guillaume@security-labs.org>
+	All right reserved.
+	
+  Origami is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  Origami 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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+
+module Origami
+
+  class InvalidArrayObjectError < InvalidObjectError #:nodoc:
+  end
+
+  #
+  # Class representing an Array Object.
+  # Arrays contain a set of Object.
+  #
+  class Array < ::Array
+    include Origami::Object
+    
+    TOKENS = %w{ [ ] } #:nodoc:
+    @@regexp_open = Regexp.new(WHITESPACES + Regexp.escape(TOKENS.first) + WHITESPACES)   
+    @@regexp_close = Regexp.new(WHITESPACES + Regexp.escape(TOKENS.last) + WHITESPACES)    
+
+    attr_reader :strings_cache, :names_cache, :xref_cache
+
+    #
+    # Creates a new PDF Array Object.
+    # _data_:: An array of objects.
+    #
+    def initialize(data = [])
+      raise TypeError, "Expected type Array, received #{data.class}." unless data.is_a?(::Array)
+      super()
+
+      @strings_cache = []
+      @names_cache = []
+      @xref_cache = {}
+
+      i = 0
+      while i < data.size
+        case val = data[i].to_o
+          when String then @strings_cache.push(val)
+          when Name then @names_cache.push(val)
+          when Reference then 
+            (@xref_cache[val] ||= []).push(self)
+          when Dictionary,Array then 
+            @strings_cache.concat(val.strings_cache)
+            @names_cache.concat(val.names_cache)
+            @xref_cache.update(val.xref_cache) do |ref, cache1, cache2|
+              cache1.concat(cache2)  
+            end
+
+            val.strings_cache.clear
+            val.names_cache.clear
+            val.xref_cache.clear
+        end
+
+        self[i] = val
+        i = i + 1
+      end
+      
+    end
+    
+    def pre_build
+      self.map!{|obj| obj.to_o}
+      
+      super
+    end
+    
+    def self.parse(stream) #:nodoc:
+      data = []
+      offset = stream.pos
+      
+      if not stream.skip(@@regexp_open)
+        raise InvalidArrayObjectError, "No token '#{TOKENS.first}' found"
+      end
+      
+      while stream.skip(@@regexp_close).nil? do
+        
+        type = Object.typeof(stream)
+        if type.nil?
+          raise InvalidArrayObjectError, "Bad embedded object format"
+        end
+        
+        value = type.parse(stream)  
+        data << value
+      end
+    
+      array = Array.new(data)
+      array.file_offset = offset
+
+      array
+    end
+    
+    #
+    # Converts self into a Ruby array.
+    #
+    def to_a
+      super.map { |item|
+        item.is_a?(Origami::Object) ? item.value : item
+      }
+    end
+    
+    def to_s #:nodoc:
+      content = "#{TOKENS.first} "
+      self.each { |entry|
+        content << entry.to_o.to_s + ' '
+      }
+      content << TOKENS.last
+      
+      super(content)
+    end
+
+    def +(other)
+      
+      a = Origami::Array.new(self.to_a + other.to_a,  is_indirect?)
+      a.no, a.generation = @no, @generation
+      
+      return a
+    end
+
+    def <<(item)
+      obj = item.to_o
+      obj.parent = self unless obj.is_indirect?
+
+      super(obj)
+    end
+    
+    def []=(key,val)
+      key, val = key.to_o, val.to_o
+      super(key.to_o,val.to_o)
+ 
+      val.parent = self unless val.is_indirect? or val.parent.equal?(self)
+
+      val
+    end
+    
+    alias value to_a
+
+    def real_type ; Origami::Array end
+
+  end
+
+  #
+  # Class representing a location on a page or a bounding box.
+  #
+  class Rectangle < Array
+    
+    class << self
+      
+      def [](coords)
+        corners = coords.values_at(:llx, :lly, :urx, :ury)
+        
+        unless corners.all? { |corner| corner.is_a?(Numeric) }
+          raise TypeError, "All coords must be numbers"
+        end
+        
+        Rectangle.new(*corners)
+      end
+      
+    end
+    
+    def initialize(lowerleftx, lowerlefty, upperrightx, upperrighty)
+      super([ lowerleftx, lowerlefty, upperrightx, upperrighty ])
+    end
+    
+  end
+
+end

data/origami/boolean.rb

@@ -0,0 +1,101 @@
+=begin
+
+= File
+	boolean.rb
+
+= Info
+	This file is part of Origami, PDF manipulation framework for Ruby
+	Copyright (C) 2010	Guillaume DelugrÈ <guillaume@security-labs.org>
+	All right reserved.
+	
+  Origami is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  Origami 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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+module Origami
+
+  class InvalidBooleanObjectError < InvalidObjectError #:nodoc:
+  end
+
+  #
+  # Class representing a Boolean Object.
+  # A Boolean Object can be *true* or *false*.
+  #
+  class Boolean
+  
+    include Origami::Object
+    
+    TOKENS = [ %w{ true false } ] #:nodoc:
+  
+    @@regexp = Regexp.new(WHITESPACES + "(#{TOKENS.first.join('|')})")
+    
+    #
+    # Creates a new Boolean value.
+    # _value_:: *true* or *false*.
+    #
+    def initialize(value)
+      
+      unless value.is_a?(TrueClass) or value.is_a?(FalseClass)
+        raise TypeError, "Expected type TrueClass or FalseClass, received #{value.class}."
+      end
+      
+      super()
+      
+      @value = (value == nil || value == false) ? false : true
+    end
+    
+    def to_s #:nodoc:
+      super(@value.to_s)
+    end
+    
+    def self.parse(stream) #:nodoc:
+
+      offset = stream.pos
+    
+      if stream.scan(@@regexp).nil?
+        raise InvalidBooleanObjectError
+      end
+
+      value = stream[2] == "true" ? true : false
+        
+      bool = Boolean.new(value)
+      bool.file_offset = offset
+
+      bool
+    end
+    
+    #
+    # Converts self into a Ruby boolean, that is TrueClass or FalseClass instance.
+    #
+    def value
+      @value
+    end
+
+    def real_type ; Boolean end
+    
+    def false?
+      @value == false
+    end
+    
+    def true?
+      @value == true
+    end
+
+    def ==(bool)
+      @value == bool
+    end
+
+  end
+
+end

data/origami/catalog.rb

@@ -0,0 +1,486 @@
+=begin
+
+= File
+	catalog.rb
+
+= Info
+	This file is part of Origami, PDF manipulation framework for Ruby
+	Copyright (C) 2010	Guillaume Delugr� <guillaume@security-labs.org>
+	All right reserved.
+	
+  Origami is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  Origami 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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+module Origami
+
+  class PDF
+
+    #
+    # Sets PDF extension level and version. Only supported values are "1.7" and 3.
+    #
+    def set_extension_level(version, level)
+      exts = (self.Catalog.Extensions ||= Extensions.new)
+
+      exts[:ADBE] = DeveloperExtension.new
+      exts[:ADBE].BaseVersion = Name.new(version)
+      exts[:ADBE].ExtensionLevel = level
+
+      self
+    end
+
+    #
+    # Returns the current Catalog Dictionary.
+    #
+    def Catalog
+      cat = get_doc_attr(:Root)
+
+      case cat
+        when Catalog then
+          cat
+        when Dictionary then
+          casted = Catalog.new(cat)
+          casted.no, casted.generation = cat.no, cat.generation
+          casted.set_indirect(true)
+          casted.set_pdf(self)
+
+          casted
+        else
+          raise InvalidPDFError, "Broken catalog"
+      end
+    end
+    
+    #
+    # Sets the current Catalog Dictionary.
+    #
+    def Catalog=(cat)
+      #unless cat.is_a?(Catalog)
+      #  raise TypeError, "Expected type Catalog, received #{cat.class}"
+      #end
+      cat = Catalog.new(cat) unless cat.is_a? Catalog
+      
+      if @revisions.last.trailer.Root
+        delete_object(@revisions.last.trailer[:Root])
+      end
+      
+      @revisions.last.trailer.Root = self << cat
+    end
+ 
+    #
+    # Sets an action to run on document opening.
+    # _action_:: An Action Object.
+    #
+    def onDocumentOpen(action)   
+      
+      unless action.is_a?(Action) or action.is_a?(Destination) or action.is_a?(Reference)
+        raise TypeError, "An Action object must be passed."
+      end
+      
+      unless self.Catalog
+        raise InvalidPDFError, "A catalog object must exist to add this action."
+      end
+      
+      self.Catalog.OpenAction = action
+      
+      self
+    end
+    
+    #
+    # Sets an action to run on document closing.
+    # _action_:: A JavaScript Action Object.
+    #
+    def onDocumentClose(action)
+      
+      unless action.is_a?(Action::JavaScript) or action.is_a?(Reference)
+        raise TypeError, "An Action::JavaScript object must be passed."
+      end
+      
+      unless self.Catalog
+        raise InvalidPDFError, "A catalog object must exist to add this action."
+      end
+      
+      self.Catalog.AA ||= CatalogAdditionalActions.new
+      self.Catalog.AA.WC = action
+      
+      self
+    end
+    
+    #
+    # Sets an action to run on document printing.
+    # _action_:: A JavaScript Action Object.
+    #
+    def onDocumentPrint(action)
+      
+      unless action.is_a?(Action::JavaScript) or action.is_a?(Reference)
+        raise TypeError, "An Action::JavaScript object must be passed."
+      end
+      
+      unless self.Catalog
+        raise InvalidPDFError, "A catalog object must exist to add this action."
+      end
+      
+      self.Catalog.AA ||= CatalogAdditionalActions.new
+      self.Catalog.AA.WP = action
+      
+    end
+
+    #
+    # Registers an object into a specific Names root dictionary.
+    # _root_:: The root dictionary (see Names::Root)
+    # _name_:: The value name.
+    # _value_:: The value to associate with this name.
+    #
+    def register(root, name, value)
+      self.Catalog.Names ||= Names.new
+      
+      value.set_indirect(true) unless value.is_a? Reference
+      
+      namesroot = self.Catalog.Names[root]
+      if namesroot.nil?
+        names = NameTreeNode.new(:Names => []).set_indirect(true)
+        self.Catalog.Names[root] = names
+        names.Names << name << value
+      else
+        namesroot.solve[:Names] << name << value
+      end
+    end
+
+    def each_name(root, &b)
+      namesroot = get_names_root(root)
+      return if namesroot.nil?
+   
+      each_name_from_node(namesroot, [], &b)
+      self
+    end
+
+    #
+    # Retrieve the corresponding value associated with _name_ in
+    # the specified _root_ name directory, or nil if the value does
+    # not exist.
+    #
+    def resolve_name(root, name)
+      namesroot = get_names_root(root)
+      return nil if namesroot.nil?
+
+      resolve_name_from_node(namesroot, name)
+    end
+
+    #
+    # Returns a Hash of all names under specified _root_ name directory.
+    # Returns nil if the directory does not exist.
+    #
+    def ls_names(root)
+      namesroot = get_names_root(root)
+      return {} if namesroot.nil?
+
+      names = names_from_node(namesroot)
+      if names.length % 2 != 0
+        return InvalidNameTreeError, "Odd number of elements"
+      end
+
+      Hash[*names]
+    end
+
+    private
+
+    def names_from_node(node, browsed_nodes = []) #:nodoc:
+      children = []
+
+      unless browsed_nodes.any? {|browsed| browsed.equal?(node)}
+        browsed_nodes.push(node)
+        if node.has_key?(:Names) # leaf node
+          children.concat(node[:Names].solve)
+        elsif node.has_key?(:Kids) # intermediate node
+          node[:Kids].solve.each do |kid|
+            children.concat(names_from_node(kid.solve, browsed_nodes))
+          end
+        end
+      end
+
+      children
+    end
+
+    def resolve_name_from_node(node, name, browsed_nodes = []) #:nodoc:
+      unless browsed_nodes.any? {|browsed| browsed.equal?(node)}
+        browsed_nodes.push(node)
+
+        if node.has_key?(:Names) # leaf node
+          limits = node[:Limits]
+
+          if limits
+            limits = limits.solve
+            min, max = limits[0].value, limits[1].value          
+            if (min..max) === name.to_str
+              names = Hash[*node[:Names].solve]
+              target = names[name]
+              return target && target.solve
+            end
+          else
+            names = Hash[*node[:Names].solve]
+            target = names[name]
+            return target && target.solve
+          end
+
+        elsif node.has_key?(:Kids) # intermediate node
+          node[:Kids].solve.each do |kid|
+            kid = kid.solve
+            limits = kid[:Limits].solve
+            min, max = limits[0].value, limits[1].value          
+            
+            if (min..max) === name.to_str
+              return resolve_name_from_node(kid, name, browsed_nodes)
+            end
+          end
+        end
+      end
+    end
+
+    def each_name_from_node(node, browsed_nodes = [], &b) #:nodoc:
+      if node.has_key?(:Names) # leaf node
+        names = Hash[*node[:Names].solve]
+        names.each_pair do |name, value|
+          b.call(name, value.solve)
+        end
+      elsif node.has_key?(:Kids) # intermediate node
+        node[:Kids].solve.each do |kid|
+          each_name_from_node(kid.solve, browsed_nodes, &b)
+        end
+      end
+    end
+
+    def get_names_root(root) #:nodoc:
+      namedirs = self.Catalog.Names
+      return nil if namedirs.nil? or namedirs[root].nil?
+
+      namedirs[root].solve
+    end
+  end
+
+  module PageLayout #:nodoc:
+    SINGLE            = :SinglePage
+    ONE_COLUMN        = :OneColumn
+    TWO_COLUMN_LEFT   = :TwoColumnLeft
+    TWO_COLUMN_RIGHT  = :TwoColumnRight
+    TWO_PAGE_LEFT     = :TwoPageLeft
+    TWO_PAGE_RIGHT    = :TwoPageRight
+  end
+
+  module PageMode #:nodoc:
+    NONE        = :UseNone
+    OUTLINES    = :UseOutlines
+    THUMBS      = :UseThumbs
+    FULLSCREEN  = :FullScreen
+    OPTIONAL_CONTENT = :UseOC
+    ATTACHMENTS = :UseAttachments
+  end
+
+  #
+  # Class representing the Catalog Dictionary of a PDF file.
+  #
+  class Catalog < Dictionary
+    
+    include StandardObject
+
+    field   :Type,                :Type => Name, :Default => :Catalog, :Required => true
+    field   :Version,             :Type => Name, :Version => "1.4"
+    field   :Pages,               :Type => Dictionary, :Required => true
+    field   :PageLabels,          :Type => Dictionary, :Version => "1.3"
+    field   :Names,               :Type => Dictionary, :Version => "1.2"
+    field   :Dests,               :Type => Dictionary, :Version => "1.1"
+    field   :ViewerPreferences,   :Type => Dictionary, :Version => "1.2"  
+    field   :PageLayout,          :Type => Name, :Default => PageLayout::SINGLE
+    field   :PageMode,            :Type => Name, :Default => PageMode::NONE
+    field   :Outlines,            :Type => Dictionary
+    field   :Threads,             :Type => Array, :Version => "1.1"
+    field   :OpenAction,          :Type => [ Array, Dictionary ], :Version => "1.1"
+    field   :AA,                  :Type => Dictionary, :Version => "1.4"
+    field   :URI,                 :Type => Dictionary, :Version => "1.1"
+    field   :AcroForm,            :Type => Dictionary, :Version => "1.2"
+    field   :Metadata,            :Type => Stream, :Version => "1.4"
+    field   :StructTreeRoot,      :Type => Dictionary, :Version => "1.3"
+    field   :MarkInfo,            :Type => Dictionary, :Version => "1.4"
+    field   :Lang,                :Type => String, :Version => "1.4"
+    field   :SpiderInfo,          :Type => Dictionary, :Version => "1.3"
+    field   :OutputIntents,       :Type => Array, :Version => "1.4"
+    field   :PieceInfo,           :Type => Dictionary, :Version => "1.4"
+    field   :OCProperties,        :Type => Dictionary, :Version => "1.5"
+    field   :Perms,               :Type => Dictionary, :Version => "1.5"
+    field   :Legal,               :Type => Dictionary, :Version => "1.5"
+    field   :Requirements,        :Type => Array, :Version => "1.7"
+    field   :Collection,          :Type => Dictionary, :Version => "1.7"
+    field   :NeedsRendering,      :Type => Boolean, :Version => "1.7", :Default => false
+    field   :Extensions,          :Type => Dictionary, :Version => "1.7", :ExtensionLevel => 3
+
+    def initialize(hash = {})
+      set_indirect(true)
+
+      super(hash)
+    end
+    
+  end
+  
+  #
+  # Class representing additional actions which can be associated with a Catalog.
+  #
+  class CatalogAdditionalActions < Dictionary
+    include StandardObject
+   
+    field   :WC,                  :Type => Dictionary, :Version => "1.4"
+    field   :WS,                  :Type => Dictionary, :Version => "1.4"
+    field   :DS,                  :Type => Dictionary, :Version => "1.4"
+    field   :WP,                  :Type => Dictionary, :Version => "1.4"
+    field   :DP,                  :Type => Dictionary, :Version => "1.4"
+  end
+  
+  class InvalidNameTreeError < Exception #:nodoc:
+  end
+
+  #
+  # Class representing the Names Dictionary of a PDF file.
+  #
+  class Names < Dictionary
+    include StandardObject
+    
+    #
+    # Defines constants for Names tree root entries.
+    #
+    module Root
+      DESTS = :Dests
+      AP = :AP
+      JAVASCRIPT = :JavaScript
+      PAGES = :Pages
+      TEMPLATES = :Templates
+      IDS = :IDS
+      URLS = :URLS
+      EMBEDDEDFILES = :EmbeddedFiles
+      ALTERNATEPRESENTATIONS = :AlternatePresentations
+      RENDITIONS = :Renditions
+      XFARESOURCES = :XFAResources
+    end
+
+    field   Root::DESTS,        :Type => Dictionary, :Version => "1.2"
+    field   Root::AP,           :Type => Dictionary, :Version => "1.3"
+    field   Root::JAVASCRIPT,   :Type => Dictionary, :Version => "1.3"
+    field   Root::PAGES,        :Type => Dictionary, :Version => "1.3"
+    field   Root::TEMPLATES,    :Type => Dictionary, :Version => "1.3"
+    field   Root::IDS,          :Type => Dictionary, :Version => "1.3"
+    field   Root::URLS,         :Type => Dictionary, :Version => "1.3"
+    field   Root::EMBEDDEDFILES,  :Type => Dictionary, :Version => "1.4"
+    field   Root::ALTERNATEPRESENTATIONS, :Type => Dictionary, :Version => "1.4"
+    field   Root::RENDITIONS,   :Type => Dictionary, :Version => "1.5"
+    field   Root::XFARESOURCES, :Type => Dictionary, :Version => "1.7", :ExtensionLevel => 3
+  end
+  
+  #
+  # Class representing a node in a Name tree.
+  #
+  class NameTreeNode < Dictionary
+    include StandardObject
+   
+    field   :Kids,              :Type => Array
+    field   :Names,             :Type => Array
+    field   :Limits,            :Type => Array
+  end
+  
+  #
+  # Class representing a leaf in a Name tree.
+  #
+  class NameLeaf < Origami::Array
+    
+    #
+    # Creates a new leaf in a Name tree.
+    # _hash_:: A hash of couples, associating a Name with an Reference.
+    #
+    def initialize(hash = {})
+      
+      names = []
+      hash.each_pair do |k,v|
+        names << k.to_o << v.to_o
+      end
+      
+      super(names)
+    end
+  end
+
+  #
+  # Class representing the ViewerPreferences Dictionary of a PDF.
+  # This dictionary modifies the way the UI looks when the file is opened in a viewer.
+  #
+  class ViewerPreferences < Dictionary
+    include StandardObject
+
+    field   :HideToolbar,             :Type => Boolean, :Default => false
+    field   :HideMenubar,             :Type => Boolean, :Default => false
+    field   :HideWindowUI,            :Type => Boolean, :Default => false
+    field   :FitWindow,               :Type => Boolean, :Default => false
+    field   :CenterWindow,            :Type => Boolean, :Default => false
+    field   :DisplayDocTitle,         :Type => Boolean, :Default => false, :Version => "1.4"
+    field   :NonFullScreenPageMode,   :Type => Name, :Default => :UseNone
+    field   :Direction,               :Type => Name, :Default => :L2R
+    field   :ViewArea,                :Type => Name, :Default => :CropBox, :Version => "1.4"
+    field   :ViewClip,                :Type => Name, :Default => :CropBox, :Version => "1.4"
+    field   :PrintArea,               :Type => Name, :Default => :CropBox, :Version => "1.4"
+    field   :PrintClip,               :Type => Name, :Default => :CropBox, :Version => "1.4"
+    field   :PrintScaling,            :Type => Name, :Default => :AppDefault, :Version => "1.6"
+    field   :Duplex,                  :Type => Name, :Default => :Simplex, :Version => "1.7"
+    field   :PickTrayByPDFSize,       :Type => Boolean, :Version => "1.7"
+    field   :PrintPageRange,          :Type => Array, :Version => "1.7"
+    field   :NumCopies,               :Type => Integer, :Version => "1.7"
+    field   :Enforce,                 :Type => Array, :Version => "1.7", :ExtensionLevel => 3
+    
+  end
+
+  class Requirement < Dictionary
+    include StandardObject
+
+    class Handler < Dictionary
+      include StandardObject
+
+      module Type
+        JS    = :JS
+        NOOP  = :NoOp
+      end
+
+      field   :Type,                  :Type => Name, :Default => :ReqHandler
+      field   :S,                     :Type => Name, :Default => Type::NOOP, :Required => true
+      field   :Script,                :Type => ByteString
+    end
+
+    field   :Type,                    :Type => Name, :Default => :Requirement
+    field   :S,                       :Type => Name, :Default => :EnableJavaScripts, :Version => "1.7", :Required => true
+    field   :RH,                      :Type => Array
+  end
+
+  #
+  # Class representing an extension Dictionary.
+  #
+  class Extensions < Dictionary
+    include StandardObject
+
+    field   :Type,                    :Type => Name, :Default => :Extensions
+  end
+
+  #
+  # Class representing a developer extension.
+  #
+  class DeveloperExtension < Dictionary
+    include StandardObject
+
+    field   :Type,                    :Type => Name, :Default => :DeveloperExtensions
+    field   :BaseVersion,             :Type => Name, :Required => true
+    field   :ExtensionLevel,          :Type => Integer, :Required => true
+
+  end
+  
+end