Class: ContentTypes

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby3mf/content_types.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(found = {}, over = {}) ⇒ ContentTypes

Returns a new instance of ContentTypes.



3
4
5
6
 
# File 'lib/ruby3mf/content_types.rb', line 3

def initialize(found={}, over={})
  @found_types=found
  @found_overrides=over
end

Class Method Details

.parse(zip_entry) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ruby3mf/content_types.rb', line 33

def self.parse(zip_entry)
  found_types = {}
  found_overrides = {}
  Log3mf.context "parse" do |l|
    begin
      doc = XmlVal.validate_parse(zip_entry)

      l.warning '[Content_Types].xml must contain exactly one root node' unless doc.children.size == 1
      l.warning '[Content_Types].xml must contain root name Types' unless doc.children.first.name == "Types"

      required_content_types = ['application/vnd.openxmlformats-package.relationships+xml']

      extensions = doc.css(*['Default']).map{|node| node.attributes['Extension']&.value}.flatten
      l.error :duplicate_content_extension_types unless extensions.uniq.length == extensions.length

      l.error :empty_default_extension if extensions.include?("")

      override_extensions = doc.css(*['Override']).map{|node| node.attributes['PartName']&.value}.flatten
      l.error :duplicate_content_override_types unless override_extensions.uniq.length == override_extensions.length

      found_types     = Hash[*doc.css(*['Default']).map{|node| [node.attributes['Extension']&.value&.downcase,node.attributes['ContentType']&.value]}.flatten]
      found_overrides = Hash[*doc.css(*['Override']).map{|node| [node.attributes['PartName']&.value&.downcase,node.attributes['ContentType']&.value]}.flatten]

      required_content_types.each do |req_type|
        l.error :invalid_content_type, mt: req_type unless found_types.values.include?(req_type)
      end

      doc.css(*['Default']).each do |node|
        extension = node['Extension']&.downcase
        l.info "Setting type hash #{extension}=#{node['ContentType']}"
      end

      doc.css(*['Override']).each do |node|
        l.error :empty_override_part_name if node['PartName']&.downcase&.empty?
      end

      doc.css('Types').xpath('.//*').select do |node|
        l.warning "[Content_Types].xml:#{node.line} contains unexpected element #{node.name}", page: 10 unless ['Default', 'Override'].include?(node.name)
      end

    rescue Nokogiri::XML::SyntaxError => e
      l.error :content_types_invalid_xml, e: "#{e}"
    end
  end
  return new(found_types, found_overrides)
end

Instance Method Details

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/ruby3mf/content_types.rb', line 12

def empty?
  size == 0
end

#get_type(target) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/ruby3mf/content_types.rb', line 16

def get_type(target)
  target = (target.start_with?('/') ? target : '/' + target).downcase
  if @found_overrides[target]
    content_type = @found_overrides[target]
  else
    extension = File.extname(target).strip.downcase[1..-1]
    content_type = @found_types[extension]
  end
  content_type
end

#get_types ⇒ Object 



27
28
29
 
# File 'lib/ruby3mf/content_types.rb', line 27

def get_types()
  return @found_types.values + @found_overrides.values
end

#size ⇒ Object 



8
9
10
 
# File 'lib/ruby3mf/content_types.rb', line 8

def size
  @found_types.size + @found_overrides.size
end