origami 1.0.2

data/origami/actions.rb

@@ -0,0 +1,299 @@
+=begin
+
+= File
+	actions.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
+
+    #
+    # Lookup script in the scripts name directory.
+    #
+    def get_script_by_name(name)
+      resolve_name Names::Root::JAVASCRIPT, name
+    end
+    
+    #
+    # Calls block for each named JavaScript script.
+    #
+    def each_named_script(&b)
+      each_name(Names::Root::JAVASCRIPT, &b) 
+    end
+  end
+
+  #
+  # Class representing an action to launch in a PDF.
+  #
+  class Action < Dictionary
+    
+    include StandardObject
+
+    field   :Type,    :Type => Name, :Default => :Action
+    field   :S,       :Type => Name, :Required => true
+    field   :Next,    :Type => [ Array, Dictionary ], :Version => "1.2"
+   
+    #
+    # Class representing a action going to a destination in the current document.
+    #
+    class GoTo < Action
+
+      field   :S,       :Type => Name, :Default => :GoTo, :Required => true
+      field   :D,       :Type => [ Array, Name, ByteString ], :Required => true
+
+      #
+      # Creates a new GoTo Action.
+      # _hash_:: A hash of options to set for this jump.
+      #
+      def initialize(hash = {})
+        
+        if hash.is_a? Destination
+          super(:S => :GoTo, :D => hash)
+        else
+          super(hash)
+        end
+        
+      end
+      
+    end
+    
+    #
+    # Class representing an action launching an URL.
+    #
+    class URI < Action
+     
+      field   :S,       :Type => Name, :Default => :URI, :Required => true
+      field   :URI,     :Type => ByteString, :Required => true
+      field   :IsMap,   :Type => Boolean, :Default => false
+
+      #
+      # Creates a new URI Action.
+      # _uri_:: The URI to launch.
+      # _ismap_::
+      #
+      def initialize(uri, ismap = false)
+        super(:URI => uri, :IsMap => ismap)
+      end
+    
+    end
+
+    #
+    # Class representing a JavaScript Action.
+    #
+    class JavaScript < Action
+      
+      field   :S,       :Type => Name, :Default => :JavaScript, :Required => true
+      field   :JS,      :Type => [ Stream, String ], :Required => true
+
+      #
+      # Creates a new JavaScript Action.
+      # _script_:: The script to be executed.
+      #
+      def initialize(script)
+        super(:JS => script)
+      end
+      
+    end
+
+    #
+    # Class representing an Action which run a command on the current system.
+    #
+    class Launch < Action
+     
+      field   :S,         :Type => Name, :Default => :Launch, :Required => true
+      field   :F,         :Type => [ ByteString, Dictionary ]
+      field   :Win,       :Type => Dictionary
+      field   :Mac,       :Type => Object
+      field   :Unix,      :Type => Object
+      field   :NewWindow, :Type => Boolean
+
+      #
+      # Dictionary for passing parameter to Windows applications during Launch.
+      #
+      class WindowsLaunchParams < Dictionary
+        
+        include StandardObject
+       
+        field   :F,         :Type => ByteString, :Required => true
+        field   :D,         :Type => ByteString
+        field   :O,         :Type => ByteString, :Default => "open"
+        field   :P,         :Type => ByteString
+
+      end
+    end
+    
+    #
+    # Class representing a Named Action.
+    # Named actions are predefined GoTo actions.
+    #
+    class Named < Action
+      
+      NEXTPAGE = :NextPage
+      PREVPAGE = :PrevPage
+      FIRSTPAGE = :FirstPage
+      LASTPAGE = :LastPage
+      PRINT = :Print
+   
+      field   :S,         :Type => Name, :Default => :Named, :Required => true
+      field   :N,         :Type => Name, :Required => true
+
+      def initialize(type)
+        super(:N => type)
+      end
+
+    end
+    
+    #
+    # Class representing a GoTo Action to an external file.
+    #
+    class GoToR < Action
+
+      field   :S,         :Type => Name, :Default => :GoToR, :Required => true
+      field   :F,         :Type => [ ByteString, Dictionary ], :Required => true
+      field   :D,         :Type => [ Array, Name, ByteString ], :Required => true
+      field   :NewWindow, :Type => Boolean, :Version => "1.2"
+
+      #
+      # Creates a new GoTo remote Action.
+      # _file_:: A FileSpec describing the file.
+      # _dest_:: A Destination in the file.
+      # _newwindow_:: Specifies whether the file has to be opened in a new window.
+      #
+      def initialize(file, dest = Destination::GlobalFit.new(0), newwindow = false)
+        super(:F => file, :D => dest, :NewWindow => newwindow)
+      end
+      
+    end
+    
+    #
+    # Class representing a GoTo Action to an embedded pdf file.
+    #
+    class GoToE < Action
+  
+      field   :S,         :Type => Name, :Default => :GoToE, :Required => true
+      field   :F,         :Type => [ Dictionary, ByteString ]
+      field   :D,         :Type => [ Array, Name, ByteString ], :Required => true
+      field   :NewWindow, :Type => Boolean
+      field   :T,         :Type => Dictionary
+
+      #
+      # A class representing a target for a GoToE to an embedded file.
+      #
+      class EmbeddedTarget < Dictionary
+        
+        include StandardObject
+        
+        module Relationship
+          PARENT = :P
+          CHILD = :C
+        end
+
+        field   :R,           :Type => Name, :Required => true
+        field   :N,           :Type => ByteString
+        field   :P,           :Type => [ Integer, ByteString ]
+        field   :A,           :Type => [ Integer, ByteString ]
+        field   :T,           :Type => Dictionary
+        
+      end
+    
+      def initialize(filename, dest, newwindow = false)
+        super(:T => EmbeddedTarget.new(:R => :C, :N => filename), :D => dest, :NewWindow => newwindow)
+      end
+      
+    end
+    
+    #
+    # (PDF 1.2) Send data to a uniform resource locator. p703
+    #
+    class SubmitForm < Action
+      
+      module Flags
+        INCLUDEEXCLUDE       = 1 << 0
+        INCLUDENOVALUEFIELDS = 1 << 1
+        EXPORTFORMAT         = 1 << 2
+        GETMETHOD            = 1 << 3
+        SUBMITCOORDINATES    = 1 << 4
+        XFDF                 = 1 << 5 
+        INCLUDEAPPENDSAVES   = 1 << 6
+        INCLUDEANNOTATIONS   = 1 << 7
+        SUBMITPDF            = 1 << 8
+        CANONICALFORMAT      = 1 << 9
+        EXCLNONUSERANNOTS    = 1 << 10
+        EXCLFKEY             = 1 << 11
+        EMBEDFORM            = 1 << 12
+      end
+     
+      field   :S,           :Type => Name, :Default => :SubmitForm, :Required => true
+      field   :F,           :Type => Dictionary
+      field   :Fields,      :Type => Array
+      field   :Flags,       :Type => Integer, :Default => 0
+
+      def initialize(url, fields = [], flags = 0)
+        if not url.is_a? FileSpec
+          url = FileSpec.new(:FS => :URL, :F => url)
+        end
+        
+        super(:F => url, :Fields => fields, :Flags => flags)
+      end
+      
+    end
+
+    class ImportData < Action
+
+      field   :S,           :Type => Name, :Default => :ImportData, :Required => true
+      field   :F,           :Type => Dictionary, :Required => true
+
+      def initialize(file)
+        if not file.is_a? FileSpec
+          file = FileSpec.new(:FS => :File, :F => file)
+        end
+        
+        super(:F => file)
+      end
+    
+    end
+
+    class RichMediaExecute < Action
+
+      field   :S,           :Type => Name, :Default => :RichMediaExecute, :Version => "1.7", :ExtensionLevel => 3, :Required => true
+      field   :TA,          :Type => Dictionary, :Version => "1.7", :ExtensionLevel => 3, :Required => true
+      field   :TI,          :Type => Dictionary, :Version => "1.7", :ExtensionLevel => 3
+      field   :CMD,         :Type => Dictionary, :Version => "1.7", :ExtensionLevel => 3, :Required => true
+
+      class Command < Dictionary
+        include StandardObject
+
+        field   :Type,      :Type => Name, :Default => :RichMediaCommand, :Version => "1.7", :ExtensionLevel => 3
+        field   :C,         :Type => String, :Version => "1.7", :ExtensionLevel => 3, :Required => true
+        field   :A,         :Type => Object, :Version => "1.7", :ExtensionLevel => 3
+      end
+
+      def initialize(annotation, command, *params)
+        super(:TA => annotation, :CMD => Command.new(:C => command, :A => params))
+      end
+    
+    end
+  
+  end
+
+end

data/origami/adobe/fdf.rb

@@ -0,0 +1,259 @@
+=begin
+
+= File
+	adobe/fdf.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
+
+require 'origami/object'
+require 'origami/name'
+require 'origami/dictionary'
+require 'origami/reference'
+require 'origami/boolean'
+require 'origami/numeric'
+require 'origami/string'
+require 'origami/array'
+require 'origami/trailer'
+require 'origami/xreftable'
+
+module Origami
+
+  module Adobe
+    
+    #
+    # Class representing an AcroForm Forms Data Format file.
+    #
+    class FDF
+      
+      class Header
+
+        MAGIC = /\A%FDF-(\d)\.(\d)/
+        
+        attr_accessor :majorversion, :minorversion
+        
+        #
+        # Creates a file header, with the given major and minor versions.
+        # _majorversion_:: Major version.
+        # _minorversion_:: Minor version.
+        #
+        def initialize(majorversion = 2, minorversion = 1)
+          @majorversion, @minorversion = majorversion, minorversion
+        end
+        
+        def self.parse(stream) #:nodoc:
+          
+          if not stream.scan(MAGIC).nil?
+            maj = stream[1].to_i
+            min = stream[2].to_i
+          else
+            raise InvalidHeader, "Invalid header format"
+          end
+          
+          PPKLite::Header.new(maj,min)
+        end
+        
+        def to_s
+          "%FDF-#{@majorversion}.#{@minorversion}" + EOL
+        end
+        
+        def to_sym #:nodoc:
+          "#{@majorversion}.#{@minorversion}".to_sym
+        end
+        
+        def to_f #:nodoc:
+          to_sym.to_s.to_f
+        end
+      
+      end
+
+      class Revision #:nodoc;
+        attr_accessor :pdf
+        attr_accessor :body, :xreftable, :trailer
+        
+        def initialize(adbk)
+          @pdf = adbk
+          @body = {}
+          @xreftable = nil
+          @trailer = nil
+        end
+
+        def trailer=(trl)
+          trl.pdf = @pdf
+          @trailer = trl
+        end
+      end
+
+      attr_accessor :header, :revisions
+      
+      def initialize #:nodoc:
+        @header = FDF::Header.new
+        @revisions = [ Revision.new(self) ]
+        @revisions.first.trailer = Trailer.new
+      end
+      
+      def objects
+        def append_subobj(root, objset)
+          if objset.find{ |o| o.object_id == root.object_id }.nil?
+            objset << root
+            if root.is_a?(Array) or root.is_a?(Dictionary)
+              root.each { |subobj| append_subobj(subobj, objset) unless subobj.is_a?(Reference) }
+            end
+          end
+        end
+        
+        objset = []
+        @revisions.first.body.values.each do |object|
+          unless object.is_a?(Reference)
+            append_subobj(object, objset)
+          end
+        end
+        
+        objset
+      end
+      
+      def <<(object)
+        
+        object.set_indirect(true)
+        
+        if object.no.zero?
+        maxno = 1
+          while get_object(maxno) do maxno = maxno.succ end
+          
+          object.generation = 0
+          object.no = maxno
+        end
+        
+        @revisions.first.body[object.reference] = object
+        
+        object.reference
+      end
+      
+      def Catalog
+        get_object(@trailer.Root)
+      end
+      
+      def save(filename)
+        
+        bin = ""
+        bin << @header.to_s
+
+        lastno, brange = 0, 0
+          
+        xrefs = [ XRef.new(0, XRef::LASTFREE, XRef::FREE) ]
+        xrefsection = XRef::Section.new
+ 
+        @revisions.first.body.values.sort.each { |obj|
+          if (obj.no - lastno).abs > 1
+            xrefsection << XRef::Subsection.new(brange, xrefs)
+            brange = obj.no
+            xrefs.clear
+          end
+          
+          xrefs << XRef.new(bin.size, obj.generation, XRef::USED)
+          lastno = obj.no
+
+          bin << obj.to_s
+        }
+        
+        xrefsection << XRef::Subsection.new(brange, xrefs)
+        
+        @xreftable = xrefsection
+        @trailer ||= Trailer.new
+        @trailer.Size = rev.body.size + 1
+        @trailer.startxref = bin.size
+
+        bin << @xreftable.to_s
+        bin << @trailer.to_s
+
+        fd = File.open(filename, "w").binmode
+          fd << bin 
+        fd.close
+        
+        show_entries
+      end
+      alias saveas save
+      
+      private
+      
+      def rebuildxrefs #:nodoc:
+        
+        startxref = @header.to_s.size
+        
+        @revisions.first.body.values.each { |object|
+          startxref += object.to_s.size
+        }
+          
+        @xreftable = buildxrefs(@revisions.first.body)
+        
+        @trailer ||= Trailer.new
+        @trailer.Size = @revisions.first.body.size + 1
+        @trailer.startxref = startxref
+        
+        self
+      end
+      
+      def buildxrefs(objects) #:nodoc:
+        
+        lastno = 0
+        brange = 0
+        
+        xrefs = [ XRef.new(0, XRef::LASTFREE, XRef::FREE) ]
+        
+        xrefsection = XRef::Section.new
+        objects.sort.each { |object|
+          if (object.no - lastno).abs > 1
+            xrefsection << XRef::Subsection.new(brange, xrefs)
+            brange = object.no
+            xrefs.clear
+          end
+          
+          xrefs << XRef.new(get_object_offset(object.no, object.generation), object.generation, XRef::USED)
+
+          lastno = object.no
+        }
+        
+        xrefsection << XRef::Subsection.new(brange, xrefs)
+        
+        xrefsection
+      end
+     
+      def get_object_offset(no,generation) #:nodoc:
+
+        bodyoffset = @header.to_s.size
+        
+        objectoffset = bodyoffset
+          
+        @revisions.first.body.values.each { |object|
+          if object.no == no and object.generation == generation then return objectoffset
+          else
+            objectoffset += object.to_s.size
+          end
+        }
+        
+        nil
+      end
+      
+    end
+    
+  end
+  
+end
+