origamindee 3.0.0

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}."

data/examples/javascript/hello_world.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "/../../lib")
+    require 'origami'
+end
+include Origami
+
+#
+# Displays a message box when the document is opened.
+#
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+# Creating a new file
+PDF.new
+   .onDocumentOpen(Action::JavaScript 'app.alert("Hello world");')
+   .save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/javascript/js_emulation.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "/../../lib")
+    require 'origami'
+end
+include Origami
+
+#
+# Emulating JavaScript inside a PDF object.
+#
+
+if defined?(PDF::JavaScript::Engine)
+
+    # Creating a new file
+    pdf = PDF.new
+
+    # Embedding the file into the PDF.
+    pdf.attach_file(DATA,
+        name: "README.txt",
+        filter: :ASCIIHexDecode
+    )
+
+    # Example of JS payload
+    pdf.onDocumentOpen Action::JavaScript <<-JS
+        if ( app.viewerVersion == 8 )
+          eval("this.exportDataObject({cName:'README.txt', nLaunch:2});");
+        this.closeDoc();
+    JS
+
+    # Tweaking the engine options
+    pdf.js_engine.options[:log_method_calls] = true
+    pdf.js_engine.options[:viewerVersion] = 10
+
+    # Hooking eval()
+    pdf.js_engine.hook 'eval' do |eval, expr|
+        puts "Hook: eval(#{expr.inspect})"
+        eval.call(expr) # calling the real eval method
+    end
+
+    # Example of inline JS evaluation
+    pdf.eval_js 'console.println(util.stringFromStream(this.getDataObjectContents("README.txt")))'
+
+    # Executes the string as a JS script
+    pdf.Catalog.OpenAction[:JS].eval_js
+
+else
+    abort "JavaScript support not found. You need to install therubyracer gem."
+end
+
+__END__
+** THIS IS THE EMBEDDED FILE **

data/examples/loop/goto.rb

@@ -0,0 +1,32 @@
+#!/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"
+
+pdf = PDF.new
+
+50.times do |n|
+    pdf.append_page do |page|
+        contents = ContentStream.new
+        contents.write "page #{n+1}",
+            x: 250, y: 450, rendering: Text::Rendering::FILL, size: 30
+
+        page.Contents = contents
+    end
+end
+
+pages = pdf.pages
+pages.each_with_index do |page, index|
+    page.onOpen Action::GoTo Destination::GlobalFit[pages[(index + 1) % pages.size]]
+end
+
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/loop/named.rb

@@ -0,0 +1,33 @@
+#!/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"
+
+pdf = PDF.new
+
+50.times do |n|
+    pdf.append_page do |page|
+        contents = ContentStream.new
+        contents.write "page #{n+1}",
+            x: 250, y: 450, rendering: Text::Rendering::FILL, size: 30
+
+        page.Contents = contents
+
+        if n != 49
+            page.onOpen Action::Named::NEXT_PAGE
+        else
+            page.onOpen Action::Named::FIRST_PAGE
+        end
+    end
+end
+
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/signature/signature.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby
+
+require 'openssl'
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
+
+puts "Generating a RSA key pair."
+key = OpenSSL::PKey::RSA.new 2048
+
+puts "Generating a self-signed certificate."
+name = OpenSSL::X509::Name.parse 'CN=origami/DC=example'
+
+cert = OpenSSL::X509::Certificate.new
+cert.version = 2
+cert.serial = 0
+cert.not_before = Time.now
+cert.not_after = Time.now + 3600
+
+cert.public_key = key.public_key
+cert.subject = name
+
+extension_factory = OpenSSL::X509::ExtensionFactory.new nil, cert
+
+cert.add_extension extension_factory.create_extension('basicConstraints', 'CA:TRUE', true)
+cert.add_extension extension_factory.create_extension('keyUsage', 'digitalSignature')
+cert.add_extension extension_factory.create_extension('subjectKeyIdentifier', 'hash')
+
+cert.issuer = name
+cert.sign key, OpenSSL::Digest::SHA256.new
+
+# Create the PDF contents
+contents = ContentStream.new.setFilter(:FlateDecode)
+contents.write OUTPUT_FILE,
+    x: 350, y: 750, rendering: Text::Rendering::STROKE, size: 30
+
+pdf = PDF.new
+page = Page.new.setContents(contents)
+pdf.append_page(page)
+
+sig_annot = Annotation::Widget::Signature.new
+sig_annot.Rect = Rectangle[llx: 89.0, lly: 386.0, urx: 190.0, ury: 353.0]
+
+page.add_annotation(sig_annot)
+
+# Sign the PDF with the specified keys
+pdf.sign(cert, key,
+    method: 'adbe.pkcs7.detached',
+    annotation: sig_annot,
+    location: "France",
+    contact: "gdelugre@localhost",
+    reason: "Signature sample"
+)
+
+# Save the resulting file
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/uri/javascript.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+OUTPUT_FILE = "#{File.basename(__FILE__, '.rb')}.pdf"
+URL = "http://google.fr"
+
+contents = ContentStream.new.setFilter(:FlateDecode)
+contents.write OUTPUT_FILE,
+  :x => 200, :y => 750, :rendering => Text::Rendering::FILL, :size => 30
+
+contents.write "The script first tries to run your browser using JavaScript.",
+  :x => 100, :y => 670, :size => 15
+
+# A JS script to execute at the opening of the document
+jscript = <<JS
+try {
+    app.launchURL("#{URL}");
+}
+catch(e) {}
+
+try {
+    this.submitForm(
+    {
+        cURL: "#{URL}",
+        bAnnotations: true,
+        bGet: true,
+        cSubmitAs: "XML"
+    });
+}
+catch(e) {}
+JS
+
+pdf = PDF.new
+
+pdf.append_page do |page|
+    page.Contents = contents
+end
+
+# Create a new action based on the script, compressed with zlib
+jsaction = Action::JavaScript Stream.new(jscript)#@ Filter: :FlateDecode)
+
+# Add the script into the document names dictionary.
+# Any scripts registered here will be executed at the document opening (with no OpenAction implied).
+pdf.register(Names::JAVASCRIPT, "Update", jsaction)
+
+# Save the resulting file
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/uri/open-uri.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+OUTPUT_FILE = "#{File.basename(__FILE__, '.rb')}.pdf"
+URL = "http://google.fr"
+
+pdf = PDF.new
+
+# Trigger an URI action when the document is opened.
+pdf.onDocumentOpen Action::URI[URL]
+
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/uri/submitform.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, "../../lib")
+    require 'origami'
+end
+include Origami
+
+OUTPUT_FILE = "#{File.basename(__FILE__, '.rb')}.pdf"
+URL = "http://mydomain/calc.pdf"
+
+pdf = PDF.new
+
+contents = ContentStream.new
+contents.write OUTPUT_FILE,
+    x: 210, y: 750, rendering: Text::Rendering::FILL, size: 30
+
+contents.write "When opened, this PDF connects to \"home\"",
+    x: 156, y: 690, rendering: Text::Rendering::FILL, size: 15
+
+contents.write "Click \"Allow\" to connect to #{URL} through your current Reader.",
+    x: 106, y: 670, size: 12
+
+contents.write "Comments:",
+    x: 75, y: 600, rendering: Text::Rendering::FILL_AND_STROKE, size: 12
+
+comment = <<-EOS
+    Adobe Reader will render the PDF file returned by the remote server.
+EOS
+
+contents.write comment,
+    x: 75, y: 580, rendering: Text::Rendering::FILL, size: 12
+
+pdf.append_page Page.new.setContents(contents)
+
+# Submit flags.
+flags = Action::SubmitForm::Flags::EXPORTFORMAT|Action::SubmitForm::Flags::GETMETHOD
+
+# Sends the form at the document opening.
+pdf.onDocumentOpen Action::SubmitForm[URL, [], flags]
+
+# Save the resulting file.
+pdf.save(OUTPUT_FILE)
+
+puts "PDF file saved as #{OUTPUT_FILE}."