origamindee 3.0.0

data/bin/pdfmetadata

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+
+=begin
+
+= Info
+    Prints out the metadata contained in a PDF document.
+
+= License
+    Copyright (C) 2019  Guillaume Delugré.
+
+    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
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, '../lib')
+    require 'origami'
+end
+include Origami
+
+require 'rainbow'
+require 'optparse'
+require 'json'
+
+class OptParser
+    BANNER = <<USAGE
+Usage: #{$0} [<PDF-file>] [-i] [-x]
+Prints out the metadata contained in a PDF document.
+Bug reports or feature requests at: http://github.com/gdelugre/origami
+
+Options:
+USAGE
+
+    def self.parser(options)
+        OptionParser.new do |opts|
+            opts.banner = BANNER
+
+            opts.on("-i", "--info", "Extracts document info metadata") do
+                options[:doc_info] = true
+            end
+
+            opts.on("-x", "--xmp", "Extracts XMP document metadata stream") do
+                options[:doc_stream] = true
+            end
+
+            opts.on("-f", "--format [FORMAT]", %i{text json}, "Output format ('text', 'json')") do |format|
+                options[:output_format] = format
+            end
+
+            opts.on("-n", "--no-color", "Turn off colorized output.") do
+                options[:colors_enabled] = false
+            end
+
+            opts.on_tail("-h", "--help", "Show this message") do
+                puts opts
+                exit
+            end
+        end
+    end
+
+    def self.parse(args)
+        options = {
+            output_format: :text,
+            colors_enabled: true
+        }
+
+        self.parser(options).parse!(args)
+
+        options
+    end
+end
+
+def print_section(name, elements)
+    puts Rainbow("[*] #{name}:").magenta
+
+    elements.each_pair do |name, item|
+        print Rainbow(name.ljust(20, ' ')).green
+        puts ": #{item}"
+    end
+end
+
+begin
+    @options = OptParser.parse(ARGV)
+
+    unless @options[:doc_info] or @options[:doc_stream]
+        @options[:doc_info] = @options[:doc_stream] = true
+    end
+
+    Rainbow.enabled = @options[:colors_enabled]
+
+    target = (ARGV.empty?) ? STDIN : ARGV.shift
+    params =
+    {
+        verbosity: Parser::VERBOSE_QUIET,
+        lazy: true
+    }
+
+    pdf = PDF.read(target, params)
+    result = {}
+
+    if @options[:doc_info] and pdf.document_info?
+        result[:document_info] = pdf.document_info.map {|k,v| 
+            key = k.value.to_s
+            obj = v.solve
+            str_value = obj.respond_to?(:to_utf8) ? obj.to_utf8 : obj.value.to_s
+
+            [ key, str_value ]
+        }.to_h
+    end
+
+    if @options[:doc_stream] and pdf.metadata?
+        result[:xmp_metadata] = pdf.metadata
+    end
+
+
+    if @options[:output_format] == :text
+        print_section("Document information dictionary", result[:document_info]) if result.key?(:document_info)
+        
+        if result.key?(:xmp_metadata)
+            puts if result.key?(:document_info)
+            print_section("Metadata stream", result[:xmp_metadata])
+        end
+    elsif @options[:output_format] == :json
+        puts JSON.pretty_generate(result)
+    end
+
+rescue
+    puts $!.backtrace.join $/
+    abort "#{$!.class}: #{$!.message}"
+end

data/bin/pdfsh

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+begin
+    require 'irb'
+rescue LoadError
+    abort "Error: you need to install irb to run this application."
+end
+
+$:.unshift File.join(__dir__, 'shell')
+ENV["IRBRC"] = File.join(__dir__, "shell", "irbrc")
+
+IRB.start

data/bin/shell/console.rb

@@ -0,0 +1,128 @@
+=begin
+
+    This file is part of Origami, PDF manipulation framework for Ruby
+    Copyright (C) 2016	Guillaume Delugré.
+
+    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 'tempfile'
+require 'hexdump'
+require 'colorize'
+
+String.disable_colorization(false)
+
+module Origami
+    module Object
+        def inspect
+            to_s
+        end
+    end
+
+    class Stream
+        def edit(editor = ENV['EDITOR'])
+            Tempfile.open("origami") do |tmpfile|
+                tmpfile.write(self.data)
+                tmpfile.flush
+
+                Process.wait Kernel.spawn "#{editor} #{tmpfile.path}"
+
+                self.data = File.read(tmpfile.path)
+                tmpfile.unlink
+            end
+
+            true
+        end
+
+        def inspect
+            self.data.hexdump
+        end
+    end
+
+    class Page < Dictionary
+        def edit
+            each_content_stream do |stream|
+                stream.edit
+            end
+        end
+    end
+
+    class PDF
+        if defined?(PDF::JavaScript::Engine)
+            class JavaScript::Engine
+                def shell
+                    loop do
+                        print "js > ".magenta
+                        break if (line = gets).nil?
+
+                        begin
+                            puts exec(line)
+                        rescue V8::JSError => e
+                            puts "Error: #{e.message}"
+                        end
+                    end
+                end
+            end
+        end
+
+        class Revision
+            def to_s
+                puts "----------  Body  ----------".white.bold
+                @body.each_value do |obj|
+                    print "#{obj.reference.to_s.rjust(8,' ')}".ljust(10).magenta
+                    puts "#{obj.type}".yellow
+                end
+
+                puts "---------- Trailer ---------".white.bold
+                if not @trailer.dictionary
+                    puts "  [x] No trailer found.".blue
+                else
+                    @trailer.dictionary.each_pair do |entry, value|
+                        print "  [*] ".magenta
+                        print "#{entry}: ".yellow
+                        puts "#{value}".red
+                    end
+
+                    print "  [+] ".magenta
+                    print "startxref: ".yellow
+                    puts "#{@trailer.startxref}".red
+                end
+            end
+
+            def inspect
+                to_s
+            end
+        end
+
+        def to_s
+            puts
+
+            puts "---------- Header ----------".white.bold
+            print "  [+] ".magenta
+            print "Version: ".yellow
+            puts "#{@header.major_version}.#{@header.minor_version}".red
+
+            @revisions.each do |revision|
+                revision.to_s
+            end
+            puts
+        end
+
+        def inspect
+            to_s
+        end
+    end
+
+end

data/bin/shell/hexdump.rb

@@ -0,0 +1,59 @@
+=begin
+
+    This file is part of Origami, PDF manipulation framework for Ruby
+    Copyright (C) 2016	Guillaume Delugré.
+
+    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.
+
+    You should have received a copy of the GNU General Public License
+    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+require 'colorize'
+
+class String #:nodoc:
+
+    def hexdump(bytesperline: 16, upcase: true, offsets: true, delta: 0)
+        dump = ""
+        counter = 0
+    
+        while counter < self.length
+            offset = sprintf("%010X", counter + delta)
+      
+            linelen = [ self.length - counter, bytesperline ].min
+            bytes = ""
+            linelen.times do |i|
+                byte = self[counter + i].ord.to_s(16).rjust(2, '0')
+
+                bytes << byte
+                bytes << " " unless i == bytesperline - 1
+            end
+
+            ascii = self[counter, linelen].ascii_print
+      
+            if upcase
+                offset.upcase!
+                bytes.upcase!
+            end
+      
+            dump << "#{offset.yellow if offsets}  #{bytes.to_s.ljust(bytesperline * 3 - 1).bold}  #{ascii}\n"
+
+            counter += bytesperline
+        end
+
+        dump
+    end
+  
+    def ascii_print
+        self.gsub(/[^[[:print:]]]/, ".")
+    end
+end

data/bin/shell/irbrc

@@ -0,0 +1,69 @@
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, '../../lib')
+    require 'origami'
+end
+include Origami
+
+require 'console.rb'
+require 'readline'
+
+OPENSSL_SUPPORT = (defined?(OpenSSL).nil?) ? 'no' : 'yes'
+JAVASCRIPT_SUPPORT = (defined?(PDF::JavaScript::Engine).nil?) ? 'no' : 'yes'
+DEFAULT_BANNER = "Welcome to the PDF shell (Origami release #{Origami::VERSION}) [OpenSSL: #{OPENSSL_SUPPORT}, JavaScript: #{JAVASCRIPT_SUPPORT}]\n"
+
+def set_completion
+    completionProc = proc { |input|
+        bind = IRB.conf[:MAIN_CONTEXT].workspace.binding
+
+        case input
+        when /^(.*)::$/
+            begin
+                space = eval("Origami::#{$1}", bind)
+            rescue Exception
+                return []
+            end
+
+            return space.constants.reject{|const| space.const_get(const) <= Exception}
+
+        when /^(.*).$/
+            begin
+                space = eval($1, bind)
+            rescue
+                return []
+            end
+
+            return space.public_methods
+        end
+    }
+
+    if Readline.respond_to?("basic_word_break_characters=")
+        Readline.basic_word_break_characters= " \t\n\"\\'`><=;|&{("
+    end
+
+    Readline.completion_append_character = nil
+    Readline.completion_proc = completionProc
+end
+
+def set_prompt
+    IRB.conf[:PROMPT][:PDFSH] = {
+        PROMPT_C: "?>> ",
+        RETURN: "%s\n",
+        PROMPT_I: ">>> ",
+        PROMPT_N: ">>> ",
+        PROMPT_S: nil
+    }
+
+    IRB.conf[:PROMPT_MODE] = :PDFSH
+    IRB.conf[:AUTO_INDENT] = true
+end
+
+# Print the shell banner.
+puts DEFAULT_BANNER.green
+
+# Import the type conversion helper routines.
+TOPLEVEL_BINDING.eval("using Origami::TypeConversion")
+
+#set_completion
+set_prompt

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
+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/examples/events/events.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+pdf = PDF.new
+
+page = Page.new
+
+contents = ContentStream.new
+contents.write "Pass your mouse over the square",
+    x: 180, y: 750, size: 15
+
+page.setContents( contents )
+
+onpageopen = Action::JavaScript "app.alert('Page Opened');"
+onpageclose = Action::JavaScript "app.alert('Page Closed');"
+ondocumentopen = Action::JavaScript "app.alert('Document is opened');"
+ondocumentclose = Action::JavaScript "app.alert('Document is closing');"
+onmouseover = Action::JavaScript "app.alert('Mouse over');"
+onmouseleft = Action::JavaScript "app.alert('Mouse left');"
+onmousedown = Action::JavaScript "app.alert('Mouse down');"
+onmouseup = Action::JavaScript "app.alert('Mouse up');"
+onparentopen = Action::JavaScript "app.alert('Parent page has opened');"
+onparentclose = Action::JavaScript "app.alert('Parent page has closed');"
+onparentvisible = Action::JavaScript "app.alert('Parent page is visible');"
+onparentinvisible = Action::JavaScript "app.alert('Parent page is no more visible');"
+namedscript = Action::JavaScript "app.alert('Names directory script');"
+
+pdf.onDocumentOpen(ondocumentopen)
+pdf.onDocumentClose(ondocumentclose)
+page.onOpen(onpageopen).onClose(onpageclose)
+
+pdf.register(Names::JAVASCRIPT, "test", namedscript)
+
+rect_coord = Rectangle[llx: 270, lly: 700, urx: 330, ury: 640]
+
+# Just draw a yellow rectangle.
+rect = Annotation::Square.new
+rect.Rect = rect_coord
+rect.IC = [ 255, 255, 0 ]
+
+# Creates a new annotation which will catch mouse actions.
+annot = Annotation::Screen.new
+annot.Rect = rect_coord
+
+# Bind the scripts to numerous triggers.
+annot.onMouseOver(onmouseover)
+annot.onMouseOut(onmouseleft)
+annot.onMouseDown(onmousedown)
+annot.onMouseUp(onmouseup)
+annot.onPageOpen(onparentopen)
+annot.onPageClose(onparentclose)
+annot.onPageVisible(onparentvisible)
+annot.onPageInvisible(onparentinvisible)
+
+page.add_annotation(annot)
+page.add_annotation(rect)
+
+pdf.append_page(page)
+
+# Save the resulting file.
+pdf.save(OUTPUT_FILE)
+
+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}."