ruby3mf 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b924df1af6b462ddf619c0cd9d1d4d21435275d
-  data.tar.gz: 960b2be3c49a86a51adf0ba7882434e74a7317a8
+  metadata.gz: 53cf0043b4bcebef905de98f2137ad6db1b36fc4
+  data.tar.gz: 3a970b15e198109bf6638f7206569e0b90bc51fc
 SHA512:
-  metadata.gz: 99e441a31af2a9a92392da4afc48469e7f286f97bf93d0cbfbae12ca6c5445c3e2b0276415aa85bf57285fec12650a18a12e1c25e07970bbe75ca9e9e08027aa
-  data.tar.gz: 95fb5fcca5571bb3925fb20318a088cba5d7e8fa7969fcd3ef00156cb3fd1903fd1ae2174281f4cc12e678ef43ae252dc5c761230bf12da95c7aa0f33d29fd63
+  metadata.gz: 91a20f9e6da5bf9f89b582509764e0ef3cf0a320c798c0020fd5fc4fd6e9e1a931193005549c0777e30b19292fcb33b7b044fee6ff70ba6ec8b36fcd0411e7e7
+  data.tar.gz: a2203b11cb4f4ecdd9ec342ae73ae5fa2b59e46d58474671ff2123e7dd88c3438c85d7cfe54bfb3c59ac024f501dfd8ed6a818a43647dc02d9bb3866ca137095

data/bin/cli.rb

@@ -3,3 +3,10 @@
 require_relative '../lib/ruby3mf'
 
 doc = Document.read(ARGV.first)
+
+errors = Log3mf.entries(:error, :fatal_error)
+puts "Validating file: #{ARGV.first}"
+errors.each do |ent|
+  h = { context: ent[0], severity: ent[1], message: ent[2] }
+  puts h
+end

data/lib/ruby3mf.rb

@@ -6,14 +6,15 @@ require_relative "ruby3mf/model3mf"
 require_relative "ruby3mf/relationships"
 require_relative "ruby3mf/thumbnail3mf"
 require_relative "ruby3mf/texture3mf"
+require_relative "ruby3mf/global_xml_validations"
 
 require 'zip'
 require 'nokogiri'
 require 'json'
 require 'mimemagic'
-# require 'csv'
+require 'uri'
+require 'yaml'
 
 module Ruby3mf
-
   # Your code goes here...
 end

data/lib/ruby3mf/content_types.rb

@@ -6,9 +6,7 @@ class ContentTypes
     Log3mf.context "parse" do |l|
       begin
 
-        doc = Nokogiri::XML(zip_entry.get_input_stream) do |config|
-          config.strict.nonet.noblanks
-        end
+        doc = GlobalXMLValidations.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"

data/lib/ruby3mf/document.rb

@@ -28,7 +28,6 @@ class Document
   def self.read(input_file)
 
     m = new(input_file)
-
     begin
       Log3mf.context "zip" do |l|
         begin
@@ -43,6 +42,25 @@ class Document
 
             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'
+                  begin
+                    u = URI part.name
+                  rescue ArgumentError
+                    l.error :err_uri_bad
+                    next
+                  end
+
+                  u.path.split('/').each do |segment|
+                    l.error :err_uri_hidden_file if (segment.start_with? '.') && !(segment.end_with? '.rels')
+                  end
+                end
+              end
+            end
+
             l.context "content types" do |l|
               # 1. Get Content Types
               content_type_match = zip_file.glob('\[Content_Types\].xml').first
@@ -71,7 +89,19 @@ class Document
               # 3. Validate all relationships
               m.relationships.each do |rel|
                 l.context rel[:target] do |l|
+
+                  begin
+                    u = URI rel[:target]
+                  rescue URI::InvalidURIError
+                    l.error :err_uri_bad
+                    next
+                  end
+
+                  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? '/../'
                   relationship_file = zip_file.glob(target).first
 
                   if relationship_file
@@ -92,6 +122,7 @@ class Document
               end
             end
           end
+
           return m
         rescue Zip::Error
           l.fatal_error 'File provided is not a valid ZIP archive', page: 9
@@ -123,7 +154,7 @@ class Document
         end
       end
 
-      File.open(output_file, "wb") {|f| f.write(buffer.string) }
+      File.open(output_file, "wb") { |f| f.write(buffer.string) }
 
     end
 

data/lib/ruby3mf/edge_list.rb

@@ -0,0 +1,61 @@
+class EdgeList
+
+  def initialize()
+    @edges = { }
+  end
+
+  def add_edge(first_vertex, second_vertex)
+    if first_vertex < second_vertex
+      edge = "#{first_vertex}:#{second_vertex}"
+    else
+      edge = "#{second_vertex}:#{first_vertex}"
+    end
+
+    (pos_count, neg_count) = @edges[edge]
+
+    if pos_count == nil or neg_count == nil
+      pos_count = 0
+      neg_count = 0
+    end
+
+    pos_count += 1 if first_vertex < second_vertex
+    neg_count += 1 if second_vertex < first_vertex
+
+    @edges[edge] = [pos_count, neg_count]
+  end
+
+  def edge_count(first_vertex, second_vertex)
+    if first_vertex < second_vertex
+      edge = "#{first_vertex}:#{second_vertex}"
+    else
+      edge = "#{second_vertex}:#{first_vertex}"
+    end
+
+    @edges[edge]
+  end
+
+  def print_list()
+    @edges.each do |key, value|
+      (pos, neg) = value
+      puts "#{pos} : #{neg}"
+    end
+  end
+
+  def verify_edges()
+    @edges.each do |key, value|
+      (pos, neg) = value
+
+      if (pos > 1 and neg == 0) or (pos == 0 and neg > 1)
+        return :bad_orientation
+      elsif pos + neg == 1
+        return :hole
+      elsif pos != 1 or neg != 1
+        return :nonmanifold
+      end
+    end
+
+    :ok
+  end
+
+end
+

data/lib/ruby3mf/errors.yml

@@ -0,0 +1,96 @@
+resource_contentype_invalid:
+  msg: "resource in model has invalid contenttype %{bt}"
+  page: 10
+err_uri_empty_segment:
+  msg: 'No segment of a 3MF part name path may be empty'
+  page: 13
+err_uri_hidden_file:
+  msg: "Other than /_rels/.rels, no segment of a 3MF part name may start with the '.' character"
+  page: 13
+err_uri_bad:
+  msg: 'Path names must be valid Open Package Convention URIs or IRIs'
+  page: 13
+err_uri_relative_path:
+  msg: 'Part names must not include relative paths'
+  page: 13
+model_resource_not_in_rels:
+  msg: "Missing required resource: %{mr} Resource referenced in model, but not in .rels relationship file"
+  page: 10
+resource_3dmodel_orientation:
+  msg: "Bad triangle orientation"
+  page: 27
+resource_3dmodel_hole:
+  msg: "Hole in model"
+  page: 27
+resource_3dmodel_nonmanifold:
+  msg: "Non-manifold edge in 3dmodel"
+  page: 27
+3d_model_invalid_xml:
+  msg: "Model file invalid XML. Exception Start tag expected, '<' not found"
+  page:
+3d_payload_files:
+  msg: "Relationship Target file /3D/Texture/texture2.texture not found"
+  page: 11
+content_types_invalid_xml:
+  msg: "[Content_Types].xml file is not valid XML. Start tag expected, '<' not found"
+  page: 15
+dot_rels_file_has_invalid_xml:
+  msg: "Relationships (.rel) file is not a valid XML file: Start tag expected, '<' not found"
+  page: 4
+dot_rels_file_missing_relationships_element:
+  msg: ".rels XML must have &lt;Relationships&gt; root element"
+  page: 4
+dot_rels_file_no_relationship_element:
+  msg: "No relationship elements found"
+  page: 4
+invalid_content_type:
+  msg: "[Content_Types].xml is missing required ContentType \"application/vnd.openxmlformats-package.relationships+xml\""
+  page: 10
+invalid_startpart_type:
+  msg: "rels/.rels Relationship file has an invalid attribute type for the root 3D Model (StartPart). The required type is \"http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel\""
+  page: 10
+invalid_thumbnail_colorspace:
+  msg: "CMYK JPEG images must not be used for the thumbnail"
+  page: 36
+invalid_thumbnail_file_type:
+  msg: "Expected a png or jpeg thumbnail but the thumbnail was of type image/gif"
+  page: 36
+invalid_texture_file_type:
+  msg: "Expected a png or jpeg texture but the texture was of type image/gif"
+  page: 16
+missing_content_types:
+  msg: "Missing required file: [Content_Types].xml"
+  page: 4
+missing_dot_rels_file:
+  msg: "Missing required file _rels/.rels"
+  page: 4
+missing_rels_folder:
+  msg: "Missing required file _rels/.rels"
+  page: 4
+multiple_relationships:
+  msg: "There MUST NOT be more than one relationship of a given relationship type from one part to a second part"
+  page: 10
+no_3d_model:
+  msg: "Relationship Target file /3D/3dmodel.model not found"
+  page: 11
+not_a_zip:
+  msg: "File provided is not a valid ZIP archive"
+  page: 9
+zero_size_texture:
+  msg: "Texture file must be valid image file"
+  page: 16
+resource_contentype_invalid:
+  msg: "resource in model has invalid contenttype image/ping"
+  page: 10
+has_xml_space_attribute:
+  msg: "found an xml:space attribute when it is not allowed"
+  page: 16
+wrong_encoding:
+  msg: "found XML content that was not UTF8 encoded"
+  page: 15
+missing_object_pid:
+  msg: "object with triangle color override missing object level pid"
+  page: 26
+missing_model_children:
+  msg: "model element must include resources and build as child elements"
+  page: 20

data/lib/ruby3mf/global_xml_validations.rb

@@ -0,0 +1,36 @@
+class GlobalXMLValidations
+
+  def self.validate_parse(file)
+    doc = Nokogiri::XML(file.get_input_stream) do |config|
+      config.strict.nonet.noblanks
+    end
+    validate(file, doc)
+    doc
+  end
+
+  def self.validate(file, document)
+    Log3mf.context "global xml validations" do |l|
+      l.error :has_xml_space_attribute if space_attribute_exists?(document)
+      l.error :wrong_encoding if xml_not_utf8_encoded?(document)
+      l.error :dtd_not_allowed if dtd_exists?(file)
+    end
+  end
+
+  def self.space_attribute_exists?(document)
+    !(document.xpath('//*[@xml:space]').empty?)
+  end
+
+  def self.xml_not_utf8_encoded?(document)
+    !(document.encoding == 'UTF-8' || document.encoding == 'utf-8')
+  end
+
+  def self.dtd_exists?(file)
+    found = file.get_input_stream.find { |line| line =~ /(!DOCTYPE\b)|(!ELEMENT\b)|(!ENTITY\b)|(!NOTATION\b)|(!ATTLIST\b)/ }
+    !found.nil?
+  end
+end
+
+
+
+
+

data/lib/ruby3mf/log3mf.rb

@@ -1,4 +1,5 @@
 require 'singleton'
+require 'yaml'
 
 # Example usage:
 
@@ -33,6 +34,8 @@ class Log3mf
     @log_list = []
     @context_stack = []
     @ledger = []
+    errormap_path = File.join(File.dirname(__FILE__),"errors.yml")
+    @errormap = YAML.load_file(errormap_path)
   end
 
   def reset_log
@@ -68,11 +71,20 @@ class Log3mf
   end
 
   def log(severity, message, options={})
-    @log_list << ["#{@context_stack.join("/")}", severity, message, options] unless severity==:debug && ENV['LOGDEBUG'].nil?
-    # puts "[#{@context_stack.join("/")}] #{severity.to_s.upcase} #{message}"
+    if message.is_a?(Symbol)
+      new_log(severity, message, options)
+    else
+      @log_list << ["#{@context_stack.join("/")}", severity, message, options] unless severity==:debug && ENV['LOGDEBUG'].nil?
+      # puts "[#{@context_stack.join("/")}] #{severity.to_s.upcase} #{message}"
+    end
     raise FatalError if severity == :fatal_error
   end
 
+  def new_log(severity, message, options={})
+    error_info = @errormap.fetch(message.to_s)
+    @log_list << ["#{@context_stack.join("/")}", severity, error_info["msg"], page: error_info["page"]] unless severity==:debug && ENV['LOGDEBUG'].nil?
+  end
+
   def count_entries(*levels)
     entries(*levels).count
   end
@@ -120,4 +132,3 @@ class Log3mf
     Log3mf.instance.to_json
   end
 end
-

data/lib/ruby3mf/mesh_analyzer.rb

@@ -0,0 +1,78 @@
+require_relative 'edge_list'
+
+
+def find_child(node, child_name)
+  node.children.each do |child|
+    if child.name == child_name
+      return child
+    end
+  end
+
+  nil
+end
+
+
+class MeshAnalyzer
+
+  def self.validate_object(object)
+    Log3mf.context "validating geometry" do |l|
+      list = EdgeList.new
+
+      # if a triangle has a pid, then the object needs a pid
+      has_triangle_pid = false
+
+      mesh = find_child(object, "mesh")
+      if mesh
+        triangles = find_child(mesh, "triangles")
+
+        if triangles
+          triangles.children.each do |triangle|
+            v1 = triangle.attributes["v1"].to_s().to_i()
+            v2 = triangle.attributes["v2"].to_s().to_i()
+            v3 = triangle.attributes["v3"].to_s().to_i()
+
+            list.add_edge(v1, v2)
+            list.add_edge(v2, v3)
+            list.add_edge(v3, v1)
+
+            if not has_triangle_pid
+              has_triangle_pid = triangle.attributes["pid"] != nil
+            end
+          end
+
+          has_object_material = object.attributes["pid"] and object.attributes["pindex"]
+          if has_triangle_pid and not has_object_material
+            l.error :missing_object_pid
+          end
+
+          result = list.verify_edges()
+          if result == :bad_orientation
+            l.fatal_error :resource_3dmodel_orientation
+          elsif result == :hole
+            l.fatal_error :resource_3dmodel_hole
+          elsif result == :nonmanifold
+            l.fatal_error :resource_3dmodel_nonmanifold
+          end
+        end
+      end
+    end
+  end
+
+  def self.validate(model_doc)
+    root = model_doc.root
+    node = root
+
+    if node.name == "model"
+      resources = find_child(node, "resources")
+
+      if resources
+        resources.children.each do |resource|
+          solid_model = resource.attributes["type"].to_s() == "model" or resource.attributes["type"].to_s() == "solidsupport"
+          if resource.name == "object" and solid_model
+            validate_object(resource)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby3mf/model3mf.rb

@@ -1,3 +1,5 @@
+require_relative 'mesh_analyzer'
+
 class Model3mf
 
   def self.parse(document, zip_entry)
@@ -5,10 +7,7 @@ class Model3mf
 
     Log3mf.context "parsing model" do |l|
       begin
-        model_doc = Nokogiri::XML(zip_entry.get_input_stream) do |config|
-          config.strict.nonet.noblanks
-        end
-        l.info "We Found a Model, and it's XML!"
+        model_doc = GlobalXMLValidations.validate_parse(zip_entry)
       rescue Nokogiri::XML::SyntaxError => e
         l.fatal_error "Model file invalid XML. Exception #{e}"
       end
@@ -25,7 +24,7 @@ class Model3mf
           l.info "All model required resources are defined in .rels relationship files."
         else
           missing_resources.each { |mr|
-            l.error "Missing required resource: #{mr} Resource referenced in model, but not in .rels relationship file", page: 10
+            l.error :model_resource_not_in_rels, mr: mr
           }
         end
 
@@ -40,13 +39,22 @@ class Model3mf
             l.info "All model resource contenttypes are valid"
           else
             bad_types.each { |bt|
-              puts "bad type: #{bt}"
-              l.error "resource in model has invalid contenttype #{bt}", page: 10
+              l.error :resource_contentype_invalid, bt: bt
             }
           end
         end
 
       end
+
+      l.context "verifying model structure" do |l|
+        root = model_doc.root
+        l.error :root_3dmodel_element_not_model if root.name != "model"
+
+        children = model_doc.root.children.map { |child| child.name }
+        l.error :missing_model_children unless children.include?("resources") && children.include?("build")
+      end
+
+      MeshAnalyzer.validate(model_doc)
     end
     model_doc
   end

data/lib/ruby3mf/relationships.rb

@@ -5,9 +5,7 @@ class Relationships
     Log3mf.context "parsing relationships" do |l|
       begin
         # Parse Relationships XML
-        doc = Nokogiri::XML(zip_entry.get_input_stream) do |config|
-          config.strict.nonet.noblanks
-        end
+        doc = GlobalXMLValidations.validate_parse(zip_entry)
 
         # Verify <Relationships><Relationship/></Relationships>
         root_element = doc.children[0]
@@ -16,6 +14,11 @@ class Relationships
           if relationship_elements.size > 0
             relationship_elements.each do |node|
               if node.is_a?(Nokogiri::XML::Element) && node.name == "Relationship"
+                relationships.each do |previous_rel|
+                  if previous_rel[:target] == node['Target'] && previous_rel[:type] == node['Type']
+                    l.error :multiple_relationships
+                  end
+                end
                 relationships << {target: node['Target'], type: node['Type'], id: node['Id']}
                 l.info "adding relationship: #{relationships.last.inspect}"
               else
@@ -30,8 +33,7 @@ class Relationships
                 start_part_type = "http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel"
                 start_part_count = relationships.select { |r| r[:type] == start_part_type }.size
                 if start_part_count != 1
-                  l.error "rels/.rels Relationship file has an invalide attribute type for the root 3D Model (StartPart).
-                         The correct attribute type should be \"#{start_part_type}\"", page: 10
+                  l.error :invalid_startpart_type
                 end
               end
             end

data/lib/ruby3mf/texture3mf.rb

@@ -6,7 +6,6 @@ class Texture3mf
   end
 
   def self.parse(document, relationship_file)
-
     t = new(document)
     t.name = relationship_file.name
     stream = relationship_file.get_input_stream

data/lib/ruby3mf/thumbnail3mf.rb

@@ -1,12 +1,18 @@
+require 'mini_magick'
+
 class Thumbnail3mf
 
   def self.parse(doc, relationship_file)
     img_type = MimeMagic.by_magic(relationship_file.get_input_stream)
+    img_colorspace = MiniMagick::Image.read(relationship_file.get_input_stream).colorspace
+
     Log3mf.context "Thumbnail3mf" do |l|
       l.fatal_error "thumbnail file must be valid image file", page: 10 unless img_type
+      l.fatal_error "CMYK JPEG images must not be used for the thumbnail", page: 36 if img_colorspace.include? "CMYK"
       l.debug "thumbnail is of type: #{img_type}"
       l.error "Expected a png or jpeg thumbnail but the thumbnail was of type #{img_type}", page: 12 unless ['image/png', 'image/jpeg'].include? img_type.type
     end
 
   end
+
 end

data/lib/ruby3mf/version.rb

@@ -1,3 +1,3 @@
 module Ruby3mf
-  VERSION = "0.1.11"
+  VERSION = "0.1.13"
 end

data/ruby3mf.gemspec

@@ -14,14 +14,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/IPGPTP/ruby3mf"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  # end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -35,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rubyzip'
   spec.add_runtime_dependency 'nokogiri', '~>1.6.8'
   spec.add_runtime_dependency 'mimemagic'
+  spec.add_runtime_dependency 'mini_magick', '~> 4.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby3mf
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Mike Whitmarsh, Jeff Porter, and William Hertling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
 description: Read, write and validate 3MF files with Ruby easily.
 email:
 - mwhit@hp.com
@@ -133,7 +147,11 @@ files:
 - lib/ruby3mf.rb
 - lib/ruby3mf/content_types.rb
 - lib/ruby3mf/document.rb
+- lib/ruby3mf/edge_list.rb
+- lib/ruby3mf/errors.yml
+- lib/ruby3mf/global_xml_validations.rb
 - lib/ruby3mf/log3mf.rb
+- lib/ruby3mf/mesh_analyzer.rb
 - lib/ruby3mf/model3mf.rb
 - lib/ruby3mf/relationships.rb
 - lib/ruby3mf/texture3mf.rb