origamindee 3.0.0

data/lib/origami/optionalcontent.rb

@@ -0,0 +1,183 @@
+=begin
+
+    This file is part of Origami, PDF manipulation framework for Ruby
+    Copyright (C) 2017	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
+
+module Origami
+
+    module OptionalContent
+
+        class Usage < Dictionary
+            include StandardObject
+
+            class CreatorInfo < Dictionary
+                include StandardObject
+
+                field   :Creator,       :Type => String, :Required => true
+                field   :Subtype,       :Type => Name, :Required => true 
+            end
+
+            class Language < Dictionary
+                include StandardObject
+
+                field   :Lang,          :Type => String, :Required => true
+                field   :Preferred,     :Type => Name, :Default => :OFF
+            end
+
+            class Export < Dictionary
+                include StandardObject
+
+                field   :ExportState,   :Type => Name, :Required => true
+            end
+
+            class Zoom < Dictionary
+                include StandardObject
+
+                field   :min,           :Type => Real, :Default => 0
+                field   :max,           :Type => Real, :Default => Float::INFINITY
+            end
+
+            class Print < Dictionary
+                include StandardObject
+
+                field   :Subtype,       :Type => Name
+                field   :PrintState,    :Type => Name
+            end
+
+            class View < Dictionary
+                include StandardObject
+
+                field   :ViewState,     :Type => Name, :Required => true
+            end
+
+            class User < Dictionary
+                include StandardObject
+
+                module Type
+                    INDIVIDUAL      = :Ind
+                    TITLE           = :Ttl
+                    ORGANIZATION    = :Org
+                end
+
+                field   :Type,          :Type => Name, :Required => true
+                field   :Name,          :Type => [ String, Array.of(String) ], :Required => true
+            end
+
+            class PageElement < Dictionary
+                include StandardObject
+
+                module Type
+                    HEADER_FOOTER   = :HF
+                    FOREGROUND      = :FG
+                    BACKGROUND      = :BG
+                    LOGO            = :L
+                end
+
+                field   :Subtype,       :Type => Name, :Required => true
+            end
+
+            field   :CreatorInfo,   :Type => CreatorInfo
+            field   :Language,      :Type => Language
+            field   :Export,        :Type => Export
+            field   :Zoom,          :Type => Zoom
+            field   :Print,         :Type => Print
+            field   :View,          :Type => View
+            field   :User,          :Type => User
+            field   :PageElement,   :Type => PageElement
+        end
+
+        class Group < Dictionary
+            include StandardObject
+
+            module Intent
+                VIEW    = :View
+                DESIGN  = :Design
+            end
+
+            field   :Type,      :Type => Name, :Required => true, :Default => :OCG
+            field   :Name,      :Type => String, :Required => true
+            field   :Intent,    :Type => [ Name, Array.of(Name) ]
+            field   :Usage,     :Type => Usage
+        end
+
+        class Membership < Dictionary
+            include StandardObject
+
+            module Policy
+                ALL_ON  = :AllOn
+                ANY_ON  = :AnyOn
+                ALL_OFF = :AllOff
+                ANY_OFF = :AnyOff
+            end
+
+            field   :Type,      :Type => Name, :Required => true, :Default => :OCMD
+            field   :OCGs,      :Type => [ Group, Array.of(Group) ]
+            field   :P,         :Type => Name, :Default => Policy::ANY_ON
+            field   :VE,        :Type => Array, :Version => "1.6"
+        end
+
+        class UsageApplication < Dictionary
+            include StandardObject
+
+            module Event
+                VIEW    = :View
+                PRINT   = :Print
+                EXPORT  = :Export
+            end
+
+            field   :Event,     :Type => Name, :Required => true
+            field   :OCGs,      :Type => Array.of(Group), :Default => []
+            field   :Category,  :Type => Array.of(Name), :Required => true
+        end
+
+        class Configuration < Dictionary
+            include StandardObject
+
+            module State
+                ON          = :On
+                OFF         = :Off
+                UNCHANGED   = :Unchanged
+            end
+
+            module Mode
+                ALL_PAGES       = :AllPages
+                VISIBLE_PAGES   = :VisiblePages
+            end
+
+            field   :Name,      :Type => String
+            field   :Creator,   :Type => String
+            field   :BaseState, :Type => Name, :Default => State::ON
+            field   :ON,        :Type => Array.of(Group)
+            field   :OFF,       :Type => Array.of(Group)
+            field   :Intent,    :Type => [ Name, Array.of(Name) ]
+            field   :AS,        :Type => Array.of(UsageApplication)
+            field   :Order,     :Type => Array
+            field   :ListMode,  :Type => Name, :Default => Mode::ALL_PAGES
+            field   :RBGroups,  :Type => Array.of(Array.of(Group)), :Default => []
+            field   :Locked,    :Type => Array.of(Group), :Default => [], :Version => "1.6"
+        end
+
+        class Properties < Dictionary
+            include StandardObject
+
+            field   :OCGs,      :Type => Array.of(Group), :Required => true
+            field   :D,         :Type => Configuration, :Required => true
+            field   :Configs,   :Type => Array.of(Configuration)
+        end
+    end
+end

data/lib/origami/outline.rb

@@ -0,0 +1,54 @@
+=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
+
+module Origami
+
+    class OutlineItem < Dictionary
+        include StandardObject
+
+        module Style
+            ITALIC  = 1 << 0
+            BOLD    = 1 << 1
+        end
+
+        field   :Title,           :Type => String, :Required => true
+        field   :Parent,          :Type => Dictionary, :Required => true
+        field   :Prev,            :Type => OutlineItem
+        field   :Next,            :Type => OutlineItem
+        field   :First,           :Type => OutlineItem
+        field   :Last,            :Type => OutlineItem
+        field   :Count,           :Type => Integer
+        field   :Dest,            :Type => [ Name, String, Destination ]
+        field   :A,               :Type => Action, :Version => "1.1"
+        field   :SE,              :Type => Dictionary, :Version => "1.3"
+        field   :C,               :Type => Array.of(Number, length: 3), :Default => [ 0.0, 0.0, 0.0 ], :Version => "1.4"
+        field   :F,               :Type => Integer, :Default => 0, :Version => "1.4"
+    end
+
+    class Outline < Dictionary
+        include StandardObject
+
+        field   :Type,            :Type => Name, :Default => :Outlines
+        field   :First,           :Type => OutlineItem
+        field   :Last,            :Type => OutlineItem
+        field   :Count,           :Type => Integer
+    end
+
+end

data/lib/origami/outputintents.rb

@@ -0,0 +1,85 @@
+=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
+
+module Origami
+
+    class OutputIntent < Dictionary
+        include StandardObject
+
+        module Intent
+            PDFX = :GTS_PDFX
+            PDFA1 = :GTS_PDFA1
+            PDFE1 = :GTS_PDFE1
+        end
+
+        field :Type,                      :Type => Name, :Default => :OutputIntent
+        field :S,                         :Type => Name, :Version => '1.4', :Required => true
+        field :OutputCondition,           :Type => String
+        field :OutputConditionIdentifier, :Type => String
+        field :RegistryName,              :Type => String
+        field :Info,                      :Type => String
+        field :DestOutputProfile,         :Type => Stream
+    end
+
+    class PDF
+        def pdfa1?
+            self.Catalog.OutputIntents.is_a?(Array) and
+            self.Catalog.OutputIntents.any?{|intent|
+                intent.solve.S == OutputIntent::Intent::PDFA1
+            } and
+            self.metadata? and (
+                doc = REXML::Document.new self.Catalog.Metadata.data;
+                REXML::XPath.match(doc, "*/*/rdf:Description[@xmlns:pdfaid]").any? {|desc|
+                    desc.elements["pdfaid:conformance"].text == "A" and
+                    desc.elements["pdfaid:part"].text == "1"
+                }
+            )
+        end
+
+        private
+
+        def intents_as_pdfa1
+            return if self.pdfa1?
+
+            self.Catalog.OutputIntents ||= []
+            self.Catalog.OutputIntents << self.insert(
+                OutputIntent.new(
+                    :Type => :OutputIntent,
+                    :S => OutputIntent::Intent::PDFA1,
+                    :OutputConditionIdentifier => "RGB"
+                )
+            )
+
+            metadata = self.create_metadata
+            doc = REXML::Document.new(metadata.data)
+
+            desc = REXML::Element.new 'rdf:Description'
+            desc.add_attribute 'rdf:about', ''
+            desc.add_attribute 'xmlns:pdfaid', 'http://www.aiim.org/pdfa/ns/id/'
+            desc.add REXML::Element.new('pdfaid:conformance').add_text('A')
+            desc.add REXML::Element.new('pdfaid:part').add_text('1')
+            doc.elements["*/rdf:RDF"].add desc
+
+            xml = ""; doc.write(xml, 3)
+            metadata.data = xml
+        end
+    end
+
+end