origami 1.2.7 → 2.0.0

data/bin/shell/hexdump.rb

@@ -1,83 +1,59 @@
 =begin
 
-= File
-	hexdump.rb
+    This file is part of Origami, PDF manipulation framework for Ruby
+    Copyright (C) 2016	Guillaume Delugré.
 
-= Info
-	This file is part of Origami, PDF manipulation framework for Ruby
-	Copyright (C) 2009	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 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 free software: you can redistribute it and/or modify
+    it under the terms of the GNU 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 General Public License for more details.
+    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 General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
-  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+    You should have received a copy of the GNU General Public License
+    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
 
 =end
 
-if RUBY_VERSION < '1.9'
-  class Fixnum
-    def ord; self; end
-  end
-end
+require 'colorize'
 
 class String #:nodoc:
 
-  def hexdump(bytesperline = 16, upcase = true, offsets = true, delta = 0)
-    
-    dump = ""
-    counter = 0
+    def hexdump(bytesperline: 16, upcase: true, offsets: true, delta: 0)
+        dump = ""
+        counter = 0
     
-    while counter < length
+        while counter < length
+            offset = sprintf("%010X", counter + delta)
       
-      offset = sprintf("%010X", counter + delta)
+            linelen = (counter < length - bytesperline) ? bytesperline : (length - counter)
+            bytes = ""
+            linelen.times do |i|
+                byte = self[counter + i].ord.to_s(16)
+                byte.insert(0, "0") if byte.size < 2
+                bytes << byte
+                bytes << " " unless i == bytesperline - 1
+            end
+
+            ascii = self[counter, linelen].ascii_print
       
-      linelen = (counter < length - bytesperline) ? bytesperline : (length - counter)
-      bytes = ""
-      linelen.times do |i|
-        
-        byte = self[counter + i].ord.to_s(base=16)
-        if byte.size < 2 then byte.insert(0, "0") end
-        bytes << byte
-        bytes << " " unless i == bytesperline - 1
-        
-      end
-
-      ascii = self[counter, linelen].ascii_print
+            if upcase
+                offset.upcase!
+                bytes.upcase!
+            end
       
-      if upcase
-        offset.upcase!
-        bytes.upcase!
-      end
-      
-      if RUBY_PLATFORM =~ /win32/
-        dump << "#{offset if offsets}  #{bytes.to_s.ljust(bytesperline * 3 - 1)}  #{ascii}\n"
-      else
-        dump << "#{Console.colorize(offset, Console::Colors::YELLOW) if offsets}  #{Console.colorize(bytes.to_s.ljust(bytesperline * 3 - 1), Console::Colors::BRIGHT_GREY)}  #{ascii}\n"
-      end
-
-      counter += bytesperline
-    end
-
-    dump
-  end
-  
-  def ascii_print
+            dump << "#{offset.yellow if offsets}  #{bytes.to_s.ljust(bytesperline * 3 - 1).bold}  #{ascii}\n"
 
-    printable = ""
-    self.each_byte { |c|
-      if c >= ' '[0].ord && c <= '~'[0].ord then printable << c else printable << '.' end
-    }
+            counter += bytesperline
+        end
 
-    return printable
-  end
+        dump
+    end
   
+    def ascii_print
+        self.gsub(/[^[[:print:]]]/, ".")
+    end
 end

data/examples/README.md

@@ -0,0 +1,34 @@
+# Origami samples
+
+## ``attachments``
+
+Adding a file attachment to a PDF document.
+
+## ``javascript``
+
+Adding JavaScript to a document and emulating it.
+
+## ``encryption``
+
+PDF encryption (supports RC4 40-128 bits, and AES128).
+Create a new encrypted document.
+
+## ``signature``
+
+PDF digital signatures. Create a new document and signs it.
+
+## ``flash``
+
+Create a document with an embedded SWF file.
+
+## ``loop``
+
+Create a looping document using ``GoTo`` and ``Named``  actions.
+
+## ``events``
+
+Create a document running JavaScript on various events.
+
+## ``uri``
+
+Various methods for connecting to a remote URL.

data/examples/attachments/attachment.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+# Creating a new file
+pdf = PDF.new
+
+# Embedding the file into the PDF.
+pdf.attach_file(DATA,
+    name: "README.txt",
+    filter: :ASCIIHexDecode
+)
+
+contents = ContentStream.new
+contents.write "File attachment sample",
+    x: 150, y: 750, rendering: Text::Rendering::FILL, size: 30
+
+pdf.append_page Page.new.setContents(contents)
+
+pdf.onDocumentOpen Action::JavaScript <<JS
+    this.exportDataObject({cName:"README.txt", nLaunch:2});
+JS
+
+
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."
+
+__END__
+This is the attached file contents.

data/examples/attachments/nested_document.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, '../../lib')
+    require 'origami'
+end
+include Origami
+
+require 'stringio'
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+EMBEDDED_NAME = "#{('a'..'z').to_a.sample(8).join}.pdf"
+
+#
+# Creates the nested document.
+# A simple document displaying a message box.
+#
+output_str = StringIO.new
+nested_doc = PDF.write(output_str) do |pdf|
+    pdf.onDocumentOpen Action::JavaScript "app.alert('Hello world!');" 
+end
+
+output_str.rewind
+
+# The envelope document.
+pdf = PDF.new.append_page
+
+# Create an object stream to compress objects.
+objstm = ObjectStream.new
+objstm.Filter = :FlateDecode
+
+pdf.insert(objstm)
+
+objstm.insert pdf.attach_file(output_str, register: true, name: EMBEDDED_NAME)
+
+# Compress the page tree.
+objstm.insert(pdf.Catalog.Pages)
+objstm.insert(pdf.pages.first)
+
+# Compress the name tree.
+objstm.insert(pdf.Catalog.Names)
+objstm.insert(pdf.Catalog.Names.EmbeddedFiles)
+
+# Compress the catalog.
+objstm.insert(pdf.Catalog)
+
+pdf.pages.first.onOpen Action::GoToE[EMBEDDED_NAME]
+
+pdf.save(OUTPUT_FILE, noindent: true)

data/examples/encryption/encryption.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+#
+# Encrypts a document with an empty password.
+#
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+# Creates an encrypted document with AES256 and a null password.
+pdf = PDF.new.encrypt(cipher: 'aes', key_size: 256)
+
+contents = ContentStream.new
+contents.write "Encrypted document sample",
+    x: 100, y: 750, rendering: Text::Rendering::STROKE, size: 30
+
+pdf.append_page Page.new.setContents(contents)
+
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/{samples/actions/triggerevents/trigger.rb → examples/events/events.rb}

@@ -1,25 +1,22 @@
-#!/usr/bin/ruby 
+#!/usr/bin/ruby
 
 begin
-  require 'origami'
+    require 'origami'
 rescue LoadError
-  ORIGAMIDIR = "#{File.dirname(__FILE__)}/../../../lib"
-  $: << ORIGAMIDIR
-  require 'origami'
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
 end
 include Origami
 
-OUTPUTFILE = "#{File.basename(__FILE__, ".rb")}.pdf"
-
-puts "Now generating a new PDF file from scratch!"
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
 
 pdf = PDF.new
 
 page = Page.new
 
 contents = ContentStream.new
-contents.write "Pass your mouse over the yellow square",
-  :x => 250, :y => 750, :size => 15
+contents.write "Pass your mouse over the square",
+    x: 180, y: 750, size: 15
 
 page.setContents( contents )
 
@@ -41,9 +38,9 @@ pdf.onDocumentOpen(ondocumentopen)
 pdf.onDocumentClose(ondocumentclose)
 page.onOpen(onpageopen).onClose(onpageclose)
 
-pdf.register(Names::Root::JAVASCRIPT, "test", namedscript)
+pdf.register(Names::JAVASCRIPT, "test", namedscript)
 
-rect_coord = Rectangle[:llx => 350, :lly => 700, :urx => 415, :ury => 640]
+rect_coord = Rectangle[llx: 270, lly: 700, urx: 330, ury: 640]
 
 # Just draw a yellow rectangle.
 rect = Annotation::Square.new
@@ -64,12 +61,12 @@ annot.onPageClose(onparentclose)
 annot.onPageVisible(onparentvisible)
 annot.onPageInvisible(onparentinvisible)
 
-page.add_annot(annot)
-page.add_annot(rect)
+page.add_annotation(annot)
+page.add_annotation(rect)
 
 pdf.append_page(page)
 
 # Save the resulting file.
-pdf.save(OUTPUTFILE)
+pdf.save(OUTPUT_FILE)
 
-puts "PDF file saved as #{OUTPUTFILE}."
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/flash/flash.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+#
+# Embeding a Flash asset inside a PDF document.
+#
+
+SWF_PATH = File.join(__dir__, "helloworld.swf")
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+# Creating a new file
+pdf = PDF.new
+
+# Embedding the SWF file into the PDF.
+swf = pdf.attach_file(SWF_PATH)
+
+# Creating a Flash annotation on the page.
+pdf.append_page do |page|
+    annot = page.add_flash_application(swf,
+                                       windowed: true,
+                                       navigation_pane: true,
+                                       toolbar: true)
+
+    # Setting the player position on the page.
+    annot.Rect = Rectangle.new [204, 573, 403, 718]
+end
+
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/forms/javascript.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+#
+# Interactive JavaScript interpreter using an Acrobat Form.
+#
+
+require 'origami/template/widgets'
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+pdf = PDF.new.append_page(page = Page.new)
+
+contents = ContentStream.new.setFilter(:FlateDecode)
+
+contents.write "Write your JavaScript below and run it",
+    x: 100, y: 750, size: 24, rendering: Text::Rendering::FILL,
+    fill_color: Graphics::Color::RGB.new(0xFF, 0x80, 0x80)
+
+contents.write "You need at least Acrobat Reader 8 to use this document.",
+    x: 50, y: 80, size: 12, rendering: Text::Rendering::FILL
+
+contents.write "\nGenerated with Origami #{Origami::VERSION}.",
+    color: Graphics::Color::RGB.new(0, 0, 255)
+
+contents.draw_rectangle(45, 35, 320, 60,
+                        line_width: 2.0, dash: Graphics::DashPattern.new([3]),
+                        fill: false, stroke: true, stroke_color: Graphics::Color::GrayScale.new(0.7))
+
+page.Contents = contents
+
+ml = Template::MultiLineEdit.new('scriptedit', x: 50, y: 280, width: 500, height: 400)
+ml.V = <<JS
+console.show();
+console.println('Script entry point');
+app.alert("Hello");
+JS
+
+button = Template::Button.new("Run!", x: 490, y: 240, width: 60, height: 30)
+button.onActivate Action::JavaScript["eval(this.getField('scriptedit').value);"]
+
+page.add_annotation(ml, button)
+pdf.create_form(button, ml)
+
+pdf.save(OUTPUT_FILE, noindent: true)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/forms/xfa.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/ruby 
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+require 'origami/template/widgets'
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+#
+# Interactive FormCalc interpreter using a XFA form.
+#
+
+#
+# XDP Packet holding the Form.
+#
+class SampleXDP < XDP::Package
+    def initialize(script = "")
+        super()
+
+        self.root.add_element(create_config_packet)
+        self.root.add_element(create_template_packet(script))
+        self.root.add_element(create_datasets_packet)
+    end
+
+    def create_config_packet
+        config = XDP::Packet::Config.new
+
+        present = config.add_element(XFA::Element.new("present"))
+        pdf = present.add_element(XFA::Element.new("pdf"))
+        interactive = pdf.add_element(XFA::Element.new("interactive"))
+        interactive.text = 1
+
+        config
+    end
+
+    def create_template_packet(script)
+        template = XDP::Packet::Template.new
+
+        form1 = template.add_subform(layout: 'tb', name: 'form1')
+        form1.add_pageSet
+        form1.add_event(activity: 'initialize', name: 'event__ready')
+             .add_script(contentType: 'application/x-formcalc')
+             .text = script
+
+        subform = form1.add_subform
+
+        button = subform.add_field(name: 'Button1')
+        button.add_ui.add_button(highlight: 'inverted')
+        btncaption = button.add_caption
+        btncaption.add_value.add_text.text = "Send!"
+        btncaption.add_para(vAlign: 'middle', hAlign: 'center')
+        button.add_bind(match: 'none')
+        button.add_event(activity: 'click', name: 'event__click')
+              .add_script(contentType: 'application/x-formcalc')
+              .text = script
+
+        txtfield = subform.add_field(name: 'TextField1')
+        txtfield.add_ui.add_textEdit.add_border.add_edge(stroke: 'lowered')
+
+        template
+    end
+
+    def create_datasets_packet
+        datasets = XDP::Packet::Datasets.new
+        data = datasets.add_element(XDP::Packet::Datasets::Data.new)
+
+        data.add_element(XFA::Element.new('form1'))
+            .add_element(XFA::Element.new('TextField1'))
+            .text = '$host.messageBox("Hello from FormCalc!")'
+
+        datasets
+    end
+end
+
+pdf = PDF.new.append_page(page = Page.new)
+
+contents = ContentStream.new.setFilter(:FlateDecode)
+
+contents.write "Write your FormCalc below and run it",
+    x: 100, y: 750, size: 24, rendering: Text::Rendering::FILL,
+    fill_color: Graphics::Color::RGB.new(0xFF, 0x80, 0x80)
+
+contents.write "You need at least Acrobat Reader 8 to use this document.",
+    x: 50, y: 80, size: 12, rendering: Text::Rendering::FILL
+
+contents.write "\nGenerated with Origami #{Origami::VERSION}.",
+    color: Graphics::Color::RGB.new(0, 0, 255)
+
+contents.draw_rectangle(45, 35, 320, 60,
+                        line_width: 2.0, dash: Graphics::DashPattern.new([3]),
+                        fill: false, stroke: true, stroke_color: Graphics::Color::GrayScale.new(0.7))
+
+page.Contents = contents
+
+ml = Template::MultiLineEdit.new('TextField1[0]', x: 50, y: 280, width: 500, height: 400)
+button = Template::Button.new('Send!', id: 'Button1[0]', x: 490, y: 240, width: 60, height: 30)
+
+page.add_annotation(ml, button)
+
+form1 = Field::Subform.new(T: "form1[0]")
+form1.add_fields(subform = Field::Subform.new(T: "#subform[0]"))
+subform.add_fields(ml, button)
+
+xdp = SampleXDP.new('Eval(Ref(form1[0].#subform[0].TextField1[0]))').to_s
+pdf.create_xfa_form(xdp, form1)
+
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."