Class: Model3mf

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

Constant Summary collapse

VALID_EXTENSIONS =
{
    'http://schemas.microsoft.com/3dmanufacturing/slice/2015/07' => {},
    'http://schemas.microsoft.com/3dmanufacturing/material/2015/02' => {},
    'http://schemas.microsoft.com/3dmanufacturing/production/2015/06' => {},
}.freeze
VALID_CORE_METADATA_NAMES =
['Title', 'Designer', 'Description', 'Copyright', 'LicenseTerms', 'Rating', 'CreationDate', 'ModificationDate'].freeze

Class Method Summary collapse

Class Method Details

.parse(document, zip_entry) ⇒ Object



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
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
# File 'lib/ruby3mf/model3mf.rb', line 11

def self.parse(document, zip_entry)
  model_doc = nil

  Log3mf.context "parsing model" do |l|
    begin
      model_doc = XmlVal.validate_parse(zip_entry, SchemaFiles::SchemaTemplate)
    rescue Nokogiri::XML::SyntaxError => e
      l.fatal_error "Model file invalid XML. Exception #{e}"
    end

    l.context "verifying requiredextensions" do |l|
      required_extensions = model_doc.css("//model")[0]["requiredextensions"]
      if required_extensions
        required_extensions.split(" ").each do |ns|
          namespace_uri = model_doc.namespaces["xmlns:#{ns}"]
          if namespace_uri
            if VALID_EXTENSIONS.has_key? namespace_uri
              l.info "Found a valid required extension: #{namespace_uri}"
            else
              l.error :unknown_required_extension, ext: namespace_uri
            end
          else
            l.error :missing_extension_namespace_uri, ns: ns
          end
        end
      end
    end

    l.context "verifying 3D payload required resources" do |l|
      # results = model_doc.css("model resources m:texture2d")
      required_resources = model_doc.css("//model//resources//*[path]").collect { |n| n["path"] }
      required_resources += model_doc.css("//model//resources//object[thumbnail]").collect { |n| n["thumbnail"] }

      # for each, ensure that they exist in m.relationships
      relationship_resources = []
      rel_file = "#{Pathname(zip_entry.name).dirname.to_s}/_rels/#{File.basename(zip_entry.name)}.rels"
      relationships = document.relationships[rel_file]
      unless (relationships.nil?)
        relationship_resources = relationships.map { |relationship| relationship[:target] }
      end

      missing_resources = (required_resources - relationship_resources)
      if missing_resources.empty?
        l.info "All model required resources are defined in .rels relationship files."
      else
        missing_resources.each { |mr|
          l.error :model_resource_not_in_rels, mr: mr
        }
      end

      l.context "verifying 3D resource types" do |l|
        model_types = model_doc.css("//model//resources//*[path]").collect { |t| t["contenttype"] }

        #for each, ensure they exist in ContentTypes
        all_types = document.types.map { |t, v| v }

        bad_types = (model_types - all_types)
        if bad_types.empty?
          l.info "All model resource contenttypes are valid"
        else
          bad_types.each { |bt|
            l.error :resource_contentype_invalid, bt: bt
          }
        end
      end

      l.context "verifying StartPart relationship points to the root 3D Model" do |l|
        #Find the root 3D model which is pointed to by the start part
        root_rels = document.relationships['_rels/.rels']
        unless root_rels.nil?
          start_part_rel = root_rels.select { |rel| rel[:type] == Document::MODEL_TYPE }.first
          unless start_part_rel.nil? || start_part_rel[:target] != '/' + zip_entry.name
            #Verify that the model is a valid root 3D model by checking if it has at least one object
            l.fatal_error :invalid_startpart_target, :target => start_part_rel[:target] if model_doc.css("//model//resources//object").size == 0
          end
        else
          l.fatal_error :missing_dot_rels_file
        end
      end

    end

    l.context 'verifying resources' do |l|
      resources = find_child(model_doc.root, 'resources')
      if resources
        ids = resources.children.map { |child| child.attributes['id'].to_s if child.attributes['id'] }
        l.error :resource_id_collision if ids.uniq.size != ids.size
        pids = resources.children.map { |child| child.attributes['pid'].to_s }
        missing_pids = pids.select { |pid| !pid.empty? and !ids.include? pid }
        missing_pids.each do |p|
          l.error :resource_pid_missing, pid: p
        end
      end
    end

    l.context "verifying build items" do |l|
      build = find_child(model_doc.root, "build")
      if build
        items = build.children.map { |child| child.attributes["objectid"].to_s() if child.name == "item" }

        resources = find_child(model_doc.root, "resources")
        resources.children.each do |resource|
          if resource.name == "object"
            object_id = resource.attributes["id"].to_s()
            l.error :build_with_other_item if resource.attributes["type"].to_s() == "other" and items.include?(object_id)
          end
        end
      end
    end

    l.context "checking metadata" do |l|
       = model_doc.root.css("metadata").map { |met| met['name'] }
      l.error :metadata_elements_with_same_name unless .uniq!.nil?

      unless ( - ).empty?
        extra_names =  - 
        ns_names = extra_names.select { |n| n.include? ':' }

        l.error :invalid_metadata_under_defaultns unless (extra_names - ns_names).empty?

        unless ns_names.empty?
          prefixes = model_doc.root.namespace_definitions.map { |defs| defs.prefix }.reject { |pre| pre.nil? }
          l.error :invalid_metadata_name unless (ns_names.collect { |i| i.split(':').first } - prefixes).empty?
        end
      end
    end

    MeshAnalyzer.validate(model_doc)
  end
  model_doc
end