Class: Document

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

Constant Summary collapse

MODEL_TYPE =

Relationship schemas

'http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel'
THUMBNAIL_TYPE = 
'http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail'
TEXTURE_TYPE = 
'http://schemas.microsoft.com/3dmanufacturing/2013/01/3dtexture'
'http://schemas.microsoft.com/3dmanufacturing/2013/01/printticket'
THUMBNAIL_TYPES =

Image Content Types

%w[image/jpeg image/png].freeze
TEXTURE_TYPES = 
%w[image/jpeg image/png application/vnd.ms-package.3dmanufacturing-3dmodeltexture].freeze
RELATIONSHIP_TYPES =

Relationship Type => Class validating relationship type

{
  MODEL_TYPE => {klass: 'Model3mf', collection: :models, valid_types: ['application/vnd.ms-package.3dmanufacturing-3dmodel+xml']},
  THUMBNAIL_TYPE => {klass: 'Thumbnail3mf', collection: :thumbnails, valid_types: THUMBNAIL_TYPES},
  TEXTURE_TYPE => {klass: 'Texture3mf', collection: :textures, valid_types: TEXTURE_TYPES},
  PRINT_TICKET_TYPE => {valid_types: ['application/vnd.ms-printing.printticket+xml']}
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(zip_filename) ⇒ Document

Returns a new instance of Document.



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/ruby3mf/document.rb', line 30

def initialize(zip_filename)
  self.models=[]
  self.thumbnails=[]
  self.textures=[]
  self.objects={}
  self.relationships={}
  self.types=nil
  self.parts=[]
  @zip_filename = zip_filename
end

Instance Attribute Details

#models ⇒ Object

Returns the value of attribute models.



5
6
7
 
# File 'lib/ruby3mf/document.rb', line 5

def models
  @models
end

#objects ⇒ Object

Returns the value of attribute objects.



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

def objects
  @objects
end

#parts ⇒ Object

Returns the value of attribute parts.



9
10
11
 
# File 'lib/ruby3mf/document.rb', line 9

def parts
  @parts
end

#relationships ⇒ Object

Returns the value of attribute relationships.



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

def relationships
  @relationships
end

#textures ⇒ Object

Returns the value of attribute textures.



7
8
9
 
# File 'lib/ruby3mf/document.rb', line 7

def textures
  @textures
end

#thumbnails ⇒ Object

Returns the value of attribute thumbnails.



6
7
8
 
# File 'lib/ruby3mf/document.rb', line 6

def thumbnails
  @thumbnails
end

#types ⇒ Object

Returns the value of attribute types.



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

def types
  @types
end

#zip_filename ⇒ Object

Returns the value of attribute zip_filename.



10
11
12
 
# File 'lib/ruby3mf/document.rb', line 10

def zip_filename
  @zip_filename
end

Class Method Details

.read(input_file) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/ruby3mf/document.rb', line 56

def self.read(input_file)

  m = new(input_file)
  begin
    Log3mf.context 'zip' do |l|
      begin
        Zip.warn_invalid_date = false
        Zip.unicode_names = true

        # check for the general purpose flag set - if so, warn that 3mf may not work on some systems
        File.open(input_file, "r") do |file|
          if file.read[6] == "\b"
            l.warning 'File format: this file may not open on all systems'
          end
        end

        Zip::File.open(input_file) do |zip_file|

          l.info 'Zip file is valid'

          # check for valid, absolute URI's for each path name

          zip_file.each do |part|
            l.context "part names /#{part.name}" do |l|
              unless part.name.end_with? '[Content_Types].xml'
                next unless u = parse_uri(l, part.name)

                u.path.split('/').each do |segment|
                  l.error :err_uri_hidden_file if (segment.start_with? '.') && !(segment.end_with? '.rels')
                end
                m.parts << '/' + part.name unless part.directory?
              end
            end
          end

          l.context 'content types' do |l|
            content_type_match = zip_file.glob('\[Content_Types\].xml').first
            if content_type_match
              m.types = ContentTypes.parse(content_type_match)
            else
              l.fatal_error :missing_content_types
            end
          end

          l.context 'relationships' do |l|
            rel_file = zip_file.glob('_rels/.rels').first
            l.fatal_error :missing_dot_rels_file unless rel_file

            zip_file.glob('**/*.rels').each do |rel|
              m.relationships[rel.name] = Relationships.parse(rel)
            end

            root_rels = m.relationships['_rels/.rels']
            unless root_rels.nil?
              start_part_rel = root_rels.select { |rel| rel[:type] == Document::MODEL_TYPE }.first
              if start_part_rel
                start_part_target = start_part_rel[:target]
                start_part_types = m.relationships.flat_map { |k, v| v }.select { |rel| rel[:type] == Document::MODEL_TYPE && rel[:target] == start_part_target }
                l.error :invalid_startpart_target, :target => start_part_target if start_part_types.size > 1
              end
            end

          end

          l.context "print tickets" do |l|
            print_ticket_types = m.relationships.flat_map { |k, v| v }.select { |rel| rel[:type] == PRINT_TICKET_TYPE }
            l.error :multiple_print_tickets if print_ticket_types.size > 1
          end

          l.context "relationship elements" do |l|
            m.relationships.each do |file_name, rels|
              rels.each do |rel|
                l.context rel[:target] do |l|
                  next unless u = parse_uri(l, rel[:target])

                  l.error :err_uri_relative_path unless u.to_s.start_with? '/'

                  target = rel[:target].gsub(/^\//, "")
                  l.error :err_uri_empty_segment if target.end_with? '/' or target.include? '//'
                  l.error :err_uri_relative_path if target.include? '/../'

                  # necessary since it has been observed that rubyzip treats all zip entry names
                  # as ASCII-8BIT regardless if they really contain unicode chars. Without forcing
                  # the encoding we are unable to find the target within the zip if the target contains
                  # unicode chars.
                  zip_target = target
                  zip_target.force_encoding('ASCII-8BIT')
                  relationship_file = zip_file.glob(zip_target).first

                  rel_type = rel[:type]
                  if relationship_file
                    relationship_type = RELATIONSHIP_TYPES[rel_type]
                    if relationship_type.nil?
                      l.warning :unsupported_relationship_type, type: rel[:type], target: rel[:target]
                    else
                      # check that relationships are valid; extensions and relationship types must jive
                      content_type = m.types.get_type(target)
                      expected_content_type = relationship_type[:valid_types]

                      if (expected_content_type)
                        l.error :missing_content_type, part: target unless content_type
                        l.error :resource_contentype_invalid, bt: content_type, rt: rel[:target] unless (content_type.nil? || expected_content_type.include?(content_type))
                      else
                        l.info "found unrecognized relationship type: #{rel_type}"
                      end

                      unless relationship_type[:klass].nil?
                        m.send(relationship_type[:collection]) << {
                          rel_id: rel[:id],
                          target: rel[:target],
                          object: Object.const_get(relationship_type[:klass]).parse(m, relationship_file)
                        }
                      end
                    end
                  else
                    l.error :rel_file_not_found, mf: "#{rel[:target]}"
                  end
                end
              end
            end
          end

          validate_texture_parts(m, l)
        end

        return m
      rescue Zip::Error
        l.fatal_error :not_a_zip
      end
    end
  rescue Log3mf::FatalError
    #puts "HALTING PROCESSING DUE TO FATAL ERROR"
    return nil
  end
end

.validate_texture_parts(document, log) ⇒ Object

verify that each texture part in the 3MF is related to the model through a texture relationship in a rels file



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/ruby3mf/document.rb', line 42

def self.validate_texture_parts(document, log)
  unless document.types.empty?
    document.parts.select { |part| TEXTURE_TYPES.include?(document.types.get_type(part)) }.each do |tfile|
      if document.textures.select { |f| f[:target] == tfile }.size == 0
        if document.thumbnails.select { |t| t[:target] == tfile }.size == 0
          log.context "part names" do |l|
            l.warning "#{tfile} appears to be a texture file but no rels file declares any relationship to the model", page: 13
          end
        end
      end
    end
  end
end

Instance Method Details

#contents_for(path) ⇒ Object 



218
219
220
221
222
 
# File 'lib/ruby3mf/document.rb', line 218

def contents_for(path)
  Zip::File.open(zip_filename) do |zip_file|
    zip_file.glob(path).first.get_input_stream.read
  end
end

#write(output_file = nil) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ruby3mf/document.rb', line 192

def write(output_file = nil)
  output_file = zip_filename if output_file.nil?

  Zip::File.open(zip_filename) do |input_zip_file|

    buffer = Zip::OutputStream.write_buffer do |out|
      input_zip_file.entries.each do |e|
        if e.directory?
          out.copy_raw_entry(e)
        else
          out.put_next_entry(e.name)
          if objects[e.name]
            out.write objects[e.name]
          else
            out.write e.get_input_stream.read
          end
        end
      end
    end

    File.open(output_file, 'wb') { |f| f.write(buffer.string) }

  end

end