origami 1.0.2

data/origami/export.rb

@@ -0,0 +1,283 @@
+=begin
+
+= File
+	export.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
+    
+    #
+    # Exports the document to a dot Graphiz file.
+    # _filename_:: The path where to save the file.
+    #
+    def export_to_graph(filename)
+      
+      def appearance(object) #:nodoc:
+      
+        label = object.type.to_s
+        case object
+          when Catalog
+            fontcolor = "red"
+            color = "mistyrose"
+            shape = "ellipse"
+          when Name, Number
+            label = object.value 
+            fontcolor = "brown"
+            color = "lightgoldenrodyellow"
+            shape = "polygon"
+           when String
+            label = object.value unless (object.is_binary_data? or object.length > 50)
+            fontcolor = "red"
+            color = "white"
+            shape = "polygon"
+          when Array
+            fontcolor = "darkgreen"
+            color = "lightcyan"
+            shape = "ellipse"
+        else
+          fontcolor = "blue"
+          color = "aliceblue"
+          shape = "ellipse"
+        end
+      
+        { :label => label, :fontcolor => fontcolor, :color => color, :shape => shape }
+      end
+      
+      def add_edges(pdf, fd, object) #:nodoc:
+        
+        if object.is_a?(Array) or object.is_a?(ObjectStream)
+          
+          object.each { |subobj|
+            subobj = subobj.solve if subobj.is_a?(Reference) 
+            fd << "\t#{object.object_id} -> #{subobj.object_id}\n" unless subobj.nil?
+          }
+          
+        elsif object.is_a?(Dictionary)
+          
+          object.each_pair { |name, subobj|
+            subobj = subobj.solve if subobj.is_a?(Reference) 
+            fd << "\t#{object.object_id} -> #{subobj.object_id} [label=\"#{name.value}\",fontsize=9];\n" unless subobj.nil?
+          }
+          
+        end
+        
+        if object.is_a?(Stream)
+          
+          object.dictionary.each_pair { |key, value|
+            value = value.solve if value.is_a?(Reference)
+            fd << "\t#{object.object_id} -> #{value.object_id} [label=\"#{key.value}\",fontsize=9];\n" unless value.nil?
+          }
+          
+        end
+        
+      end
+      
+      graphname = "PDF" if graphname.nil? or graphname.empty?
+      fd = File.open(filename, "w")
+    
+      begin
+        fd << "digraph #{graphname} {\n\n"
+        
+        objects = self.objects(:include_keys => false).find_all{ |obj| not obj.is_a?(Reference) }
+        
+        objects.each { |object|
+          attr = appearance(object)
+          
+          fd << "\t#{object.object_id} [label=\"#{attr[:label]}\",shape=#{attr[:shape]},color=#{attr[:color]},style=filled,fontcolor=#{attr[:fontcolor]},fontsize=16];\n"
+          
+          if object.is_a?(Stream)
+            
+            object.dictionary.each { |value|
+              unless value.is_a?(Reference)
+                attr = appearance(value)
+                fd << "\t#{value.object_id} [label=\"#{attr[:label]}\",shape=#{attr[:shape]},color=#{attr[:color]},style=filled,fontcolor=#{attr[:fontcolor]},fontsize=16];\n"
+              end
+            }
+            
+          end
+          
+          add_edges(self, fd, object)
+        }
+        fd << "\n}"
+      ensure
+        fd.close
+      end
+      
+    end
+    
+    #
+    # Exports the document to a GraphML file.
+    # _filename_:: The path where to save the file.
+    #
+    def export_to_graphml(filename)
+      
+      def declare_node(id, attr) #:nodoc:
+        " <node id=\"#{id}\">\n" <<
+        "  <data key=\"d0\">\n" <<
+        "    <y:ShapeNode>\n" <<
+        "     <y:NodeLabel>#{attr[:label]}</y:NodeLabel>\n" <<
+        #~ "     <y:Shape type=\"#{attr[:shape]}\"/>\n" <<
+        "    </y:ShapeNode>\n" <<
+        "  </data>\n" <<
+        " </node>\n"
+      end
+      
+      def declare_edge(id, src, dest, label = nil) #:nodoc:
+        " <edge id=\"#{id}\" source=\"#{src}\" target=\"#{dest}\">\n" << 
+        "  <data key=\"d1\">\n" <<
+        "   <y:PolyLineEdge>\n" <<
+        "    <y:LineStyle type=\"line\" width=\"1.0\" color=\"#000000\"/>\n" <<
+        "    <y:Arrows source=\"none\" target=\"standard\"/>\n" << 
+        "    <y:EdgeLabel>#{label.to_s}</y:EdgeLabel>\n" <<
+        "   </y:PolyLineEdge>\n" <<
+        "  </data>\n" <<
+        " </edge>\n"
+      end
+      
+      def appearance(object) #:nodoc:
+      
+        label = object.type.to_s
+        case object
+          when Catalog
+            fontcolor = "red"
+            color = "mistyrose"
+            shape = "doublecircle"
+          when Name, Number
+            label = object.value 
+            fontcolor = "orange"
+            color = "lightgoldenrodyellow"
+            shape = "polygon"
+          when String
+            label = object.value unless (object.is_binary_data? or object.length > 50)
+            fontcolor = "red"
+            color = "white"
+            shape = "polygon"
+          when Array
+            fontcolor = "green"
+            color = "lightcyan"
+            shape = "ellipse"
+        else
+          fontcolor = "blue"
+          color = "aliceblue"
+          shape = "ellipse"
+        end
+      
+        { :label => label, :fontcolor => fontcolor, :color => color, :shape => shape }
+      end
+      
+     def add_edges(pdf, fd, object, id) #:nodoc:
+        
+        if object.is_a?(Array) or object.is_a?(ObjectStream)
+          
+          object.each { |subobj|
+            
+            subobj = subobj.solve if subobj.is_a?(Reference)
+            
+            unless subobj.nil?
+              fd << declare_edge("e#{id}", "n#{object.object_id}", "n#{subobj.object_id}")
+              id = id + 1
+            end
+          }
+          
+        elsif object.is_a?(Dictionary)
+          
+          object.each_pair { |name, subobj|
+            
+            subobj = subobj.solve if subobj.is_a?(Reference)
+            
+            unless subobj.nil?
+              fd << declare_edge("e#{id}", "n#{object.object_id}", "n#{subobj.object_id}", name.value)
+              id = id + 1
+            end
+          }
+          
+        end
+        
+        if object.is_a?(Stream)
+          
+          object.dictionary.each_pair { |key, value|
+          
+            value = value.solve if value.is_a?(Reference)
+            
+            unless value.nil?
+              fd << declare_edge("e#{id}", "n#{object.object_id}", "n#{value.object_id}", key.value)
+              id = id + 1
+            end
+          }
+          
+        end
+        
+        id
+      end
+      
+      @@edge_nb = 1
+      
+      graphname = "PDF" if graphname.nil? or graphname.empty?
+      
+      fd = File.open(filename, "w")
+      
+      edge_nb = 1
+      begin
+        
+        fd << '<?xml version="1.0" encoding="UTF-8"?>' << "\n"
+        fd << '<graphml xmlns="http://graphml.graphdrawing.org/xmlns/graphml"' << "\n"
+        fd << ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' << "\n"
+        fd << ' xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns/graphml ' << "\n"
+        fd << ' http://www.yworks.com/xml/schema/graphml/1.0/ygraphml.xsd"' << "\n"
+        fd << ' xmlns:y="http://www.yworks.com/xml/graphml">' << "\n"
+        fd << '<key id="d0" for="node" yfiles.type="nodegraphics"/>' << "\n"
+        fd << '<key id="d1" for="edge" yfiles.type="edgegraphics"/>' << "\n"
+        fd << "<graph id=\"#{graphname}\" edgedefault=\"directed\">\n"
+        
+        objects = self.objects(:include_keys => false).find_all{ |obj| not obj.is_a?(Reference) }
+        
+        objects.each { |object|
+          
+          fd << declare_node("n#{object.object_id}", appearance(object))
+          
+          if object.is_a?(Stream)
+            
+            object.dictionary.each { |value|
+            
+              unless value.is_a?(Reference)
+                fd << declare_node(value.object_id, appearance(value))
+              end
+            }
+          end
+          
+          edge_nb = add_edges(self, fd, object, edge_nb)
+        }
+        
+        fd << '</graph>' << "\n"
+        fd << '</graphml>'
+        
+      ensure
+        fd.close
+      end
+      
+    end
+
+  end
+  
+end

data/origami/file.rb

@@ -0,0 +1,222 @@
+=begin
+
+= File
+	file.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
+
+    #
+    # Attachs an embedded file to the PDF.
+    # _path_:: The path to the file to attach.
+    # _options_:: A set of options to configure the attachment. 
+    #
+    def attach_file(path, options = {})
+
+      #
+      # Default options.
+      #
+      params = 
+      {
+        :Register => true,                      # Shall the file be registered in the name directory ?
+        :EmbeddedName => nil,                   # The inner filename of the attachment.
+        :Filter => :FlateDecode                 # The stream filter used to store data.
+      }.update(options)
+
+      if path.respond_to?(:read)
+        fd = path
+        params[:EmbeddedName] ||= ''
+      else
+        fd = File.open(path, 'r').binmode
+        params[:EmbeddedName] ||= File.basename(path)
+      end
+      
+      fstream = EmbeddedFileStream.new
+      fstream.data = fd.read
+      fstream.setFilter(params[:Filter])
+      
+      name = params[:EmbeddedName]
+      fspec = FileSpec.new.setType(:Filespec).setF(name.dup).setEF(
+        FileSpec.new(:F => fstream)
+      )
+      
+      register(
+        Names::Root::EMBEDDEDFILES, 
+        name.dup, 
+        fspec
+      ) if params[:Register] == true
+      
+      fd.close
+
+      fspec
+    end
+
+    #
+    # Lookup embedded file in the embedded files name directory.
+    #
+    def get_embedded_file_by_name(name)
+      resolve_name Names::Root::EMBEDDEDFILES, name
+    end
+    
+    #
+    # Calls block for each named embedded file.
+    #
+    def each_named_embedded_file(&b)
+      each_name(Names::Root::EMBEDDEDFILES, &b) 
+    end
+  end
+
+  #
+  # Class used to convert system-dependent pathes into PDF pathes.
+  # PDF path specification offers a single form for representing file pathes over operating systems.
+  #
+  class Filename
+    
+    class << self
+      
+      #
+      # Converts UNIX file path into PDF file path.
+      #
+      def Unix(file)
+        ByteString.new(file)
+      end
+      
+      #
+      # Converts MacOS file path into PDF file path.
+      #
+      def Mac(file)
+        ByteString.new("/" + file.gsub(":", "/"))
+      end
+      
+      #
+      # Converts Windows file path into PDF file path.
+      #
+      def DOS(file)
+        path = ""
+        # Absolute vs relative path
+        if file.include? ":"
+          path << "/"
+          file.sub!(":","")
+        end
+        
+        file.gsub!("\\", "/")
+        ByteString.new(path + file)
+      end
+      
+    end
+    
+  end
+  
+  
+  #
+  # Class representing  a file specification.
+  # File specifications can be used to reference external files, as well as embedded files and URIs.
+  #
+  class FileSpec < Dictionary
+    
+    include StandardObject
+   
+    field   :Type,          :Type => Name, :Default => :FileSpec
+    field   :FS,            :Type => Name, :Default => :URL
+    field   :F,             :Type => [ ByteString, Stream ]
+    field   :UF,            :Type => String
+    field   :DOS,           :Type => ByteString
+    field   :Mac,           :Type => ByteString
+    field   :Unix,          :Type => ByteString
+    field   :ID,            :Type => Array
+    field   :V,             :Type => Boolean, :Default => false, :Version => "1.2"
+    field   :EF,            :Type => Dictionary, :Version => "1.3"
+    field   :RF,            :Type => Dictionary, :Version => "1.3"
+    field   :Desc,          :Type => ByteString, :Version => "1.6"
+    field   :CI,            :Type => Dictionary, :Version => "1.7"
+    field   :Thumb,         :Type => Stream, :Version => "1.7", :ExtensionLevel => 3
+
+  end
+    
+    #
+    # Class representing a Uniform Resource Locator (URL)
+    #
+    class URL < FileSpec
+    
+      field   :Type,        :Type => Name, :Default => :URL, :Required => true
+
+      def initialize(url)
+        super(:F => url)
+      end
+    end
+    
+    #
+    # A class representing a file outside the current PDF file.
+    #
+    class ExternalFile < FileSpec
+     
+      field   :Type,        :Type => Name, :Default => :FileSpec, :Required => true
+
+      #
+      # Creates a new external file specification.
+      # _dos_:: The Windows path to this file.
+      # _mac_:: The MacOS path to this file.
+      # _unix_:: The UNIX path to this file.
+      #
+      def initialize(dos, mac = "", unix = "")
+        
+        if not mac.empty? or not unix.empty?
+          super(:DOS => Filename.DOS(dos), :Mac => Filename.Mac(mac), :Unix => Filename.Unix(unix))
+        else
+         super(:F => dos)
+        end
+        
+      end
+
+    end
+    
+    #
+    # Class representing the data of an embedded file.
+    #
+    class EmbeddedFileStream < Stream
+     
+      include StandardObject
+      
+      field   :Type,          :Type => Name, :Default => :EmbeddedFile
+      field   :Subtype,       :Type => Name
+      field   :Params,        :Type => Dictionary
+      
+    end
+    
+    #
+    # Class representing parameters for a EmbeddedFileStream.
+    #
+    class EmbeddedFileParameters < Dictionary
+      
+      include StandardObject
+      
+      field   :Size,          :Type => Integer
+      field   :CreationDate,  :Type => ByteString
+      field   :ModDate,       :Type => ByteString
+      field   :Mac,           :Type => Dictionary
+      field   :Checksum,      :Type => String
+     
+    end
+
+end