ruby3mf 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49c3ed54c8588a2979b63822dbab8f3e339b5207
-  data.tar.gz: 50e088646a7159cf293fb896ce6ce7a5284b1131
+  metadata.gz: 152e1cd32d11dadcadb62904f2942100278d059c
+  data.tar.gz: 3359551e080d311dbdbe6a8607f0336cbfedf298
 SHA512:
-  metadata.gz: 9ecf6eaf61cbb478408212ef0741133b8c1d88d6891eaa6b330dc3102c752572da8b13f664f35067d5a167fbc25bc0333d07885a8dfb94ea29c6421a0f06e085
-  data.tar.gz: f220c8fc02162b03dbfbb2fa66b4e380f19e7a684ca0d59a5ab8cba6342333b00c35060802b9a2758f7109ff823792f62847e9b61ac6f606049ccd5c222db9fc
+  metadata.gz: 670d9a203081c4da7d93cdb8dc81e8db53352a5bd6635511f028a29e073bc8ffb5325365f7539d9718227bd6646fb2d5b00b5c6b1cc3161dfe77528cea6ae242
+  data.tar.gz: 48bf7933386810d11e503953607545b3db168949c97123836fadec03fb10392530732b11b02b40d02c761eccac96fca9e62bb5716c2d289da3c32c46a5026bdb

data/bin/batch.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/ruby3mf'
+
+files = Dir["spec/ruby3mf-testfiles/#{ARGV[0] || "failing_cases"}/*.#{ARGV[1] || '3mf'}"]
+
+files.each do |file|
+
+  Log3mf.reset_log
+  doc = Document.read(file)
+  errors = Log3mf.entries(:error, :fatal_error)
+
+  puts "=" * 100
+  puts "Validating file: #{file}"
+  errors.each do |ent|
+    h = { context: ent[0], severity: ent[1], message: ent[2] }
+    puts h
+  end
+
+end

data/bin/cli.rb

@@ -2,11 +2,11 @@
 
 require_relative '../lib/ruby3mf'
 
-doc = Document.read(ARGV.first)
+filename = ARGV.first
+doc = Document.read(filename)
 
 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] }
+  h = { file: filename, context: ent[0], severity: ent[1], message: ent[2] }
   puts h
 end

data/bin/folder_test.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+NAME=$1
+echo "input: ${NAME}"
+echo "Starting test on: ${NAME}"
+echo "Starting test on: ${NAME}" >> ${NAME}_test.json
+
+for filename in ${NAME}/*.3mf; do
+  echo "Validating ${filename}"
+  ~/src/ruby3mf/bin/cli.rb ${filename} >> ${NAME}_test.json
+done
+
+echo "All Done."

data/lib/ruby3mf.rb

@@ -7,7 +7,7 @@ require_relative "ruby3mf/model3mf"
 require_relative "ruby3mf/relationships"
 require_relative "ruby3mf/thumbnail3mf"
 require_relative "ruby3mf/texture3mf"
-require_relative "ruby3mf/global_xml_validations"
+require_relative "ruby3mf/xml_val"
 
 require 'zip'
 require 'nokogiri'

data/lib/ruby3mf/content_types.rb

@@ -6,7 +6,7 @@ class ContentTypes
     Log3mf.context "parse" do |l|
       begin
 
-        doc = GlobalXMLValidations.validate_parse(zip_entry)
+        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"

data/lib/ruby3mf/document.rb

@@ -6,6 +6,7 @@ class Document
   attr_accessor :thumbnails
   attr_accessor :textures
   attr_accessor :objects
+  attr_accessor :parts
   attr_accessor :zip_filename
 
   # Relationship schemas
@@ -22,6 +23,8 @@ class Document
     PRINT_TICKET_TYPE => {}
   }
 
+  TEXTURE_TYPES = %w[image/jpeg image/png application/vnd.ms-package.3dmanufacturing-3dmodeltexture]
+
   def initialize(zip_filename)
     self.models=[]
     self.thumbnails=[]
@@ -29,25 +32,56 @@ class Document
     self.objects={}
     self.relationships=[]
     self.types=[]
+    self.parts=[]
     @zip_filename = zip_filename
   end
 
+  #verify that each texture part in the 3MF is related to the model through a texture relationship in a rels file
+  def self.validate_texture_parts(document, log)
+
+    return unless document.types.size > 0
+    document.parts.each do |filename|
+      ext = File::extname(filename).delete '.'
+      content_type = document.types[ext]
+      next unless TEXTURE_TYPES.include?(content_type)
+
+      has_relationship = false
+      document.textures.each do |texture_file|
+        if texture_file[:target] == filename
+          has_relationship = true
+          break
+        end
+      end
+
+      next unless !has_relationship
+      document.thumbnails.each do |thumbnail_file|
+        if thumbnail_file[:target] == filename
+          has_relationship = true
+          break
+        end
+      end
+      log.context "part names /#{filename}" do |l|
+        l.error :texture_without_relationship, name: filename unless has_relationship
+      end
+    end
+  end
+
   def self.read(input_file)
 
     m = new(input_file)
     begin
-      Log3mf.context "zip" do |l|
+      Log3mf.context 'zip' do |l|
         begin
           Zip.warn_invalid_date = false
 
           # check for the general purpose flag set - if so, warn that 3mf may not work on some systems
           if File.read(input_file)[6] == "\b"
-            l.warning "File format: this file may not open on all systems"
+            l.warning 'File format: this file may not open on all systems'
           end
 
           Zip::File.open(input_file) do |zip_file|
 
-            l.info "Zip file is valid"
+            l.info 'Zip file is valid'
 
             # check for valid, absolute URI's for each path name
 
@@ -56,7 +90,7 @@ class Document
                 unless part.name.end_with? '[Content_Types].xml'
                   begin
                     u = URI part.name
-                  rescue ArgumentError
+                  rescue ArgumentError, URI::InvalidURIError
                     l.error :err_uri_bad
                     next
                   end
@@ -64,28 +98,29 @@ class Document
                   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|
+            l.context 'content types' do |l|
               # 1. Get Content Types
               content_type_match = zip_file.glob('\[Content_Types\].xml').first
               if content_type_match
                 m.types = ContentTypes.parse(content_type_match)
               else
-                l.error "Missing required file: [Content_Types].xml", page: 4
+                l.error 'Missing required file: [Content_Types].xml', page: 4
               end
             end
 
-            l.context "relationships" do |l|
+            l.context 'relationships' do |l|
               # 2. Get Relationships
               # rel_folders = zip_file.glob('**/_rels')
               # l.fatal_error "Missing any _rels folder", page: 4 unless rel_folders.size>0
 
               # 2.1 Validate that the top level _rels/.rel file exists
               rel_file = zip_file.glob('_rels/.rels').first
-              l.fatal_error "Missing required file _rels/.rels", page: 4 unless rel_file
+              l.fatal_error 'Missing required file _rels/.rels', page: 4 unless rel_file
 
               zip_file.glob('**/*.rels').each do |rel|
                 m.relationships += Relationships.parse(rel)
@@ -135,6 +170,8 @@ class Document
                 end
               end
             end
+
+            validate_texture_parts(m, l)
           end
 
           return m
@@ -168,7 +205,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/errors.yml

@@ -52,11 +52,14 @@ invalid_startpart_type:
 invalid_relationship_type:
   msg: "Invalid relationship type '%{type}' specified in .rels relationship file. Parts in the 3D payload MUST use one of the appropriate relationship types to establish that relationship between two parts in the payload."
   page: 10
+invalid_thumbnail_file:
+  msg: "thumbnail file must be valid image file"
+  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"
+  msg: "Expected a png or jpeg thumbnail but the thumbnail was of type %{type}"
   page: 36
 invalid_texture_file_type:
   msg: "Expected a png or jpeg texture but the texture was of type image/gif"
@@ -117,4 +120,16 @@ unknown_required_extension:
   page: 14
 missing_extension_namespace_uri:
   msg: "Required extension '%{ns}' MUST refer to namespace with URI"
-  page: 14
+  page: 14
+texture_without_relationship:
+  msg: "%{name} appears to be a texture file but no rels file declares any relationship to the model"
+  page: 13
+invalid_metadata_under_defaultns:
+  msg: "Metadata without a namespace name must only contain allowed name values"
+  page: 21
+has_commas_for_floats:
+  msg: "numbers not formatted for the en-US locale"
+  page: 15
+invalid_language_locale:
+  msg: "locale should be en-US"
+  page: 15

data/lib/ruby3mf/model3mf.rb

@@ -14,7 +14,7 @@ class Model3mf
 
     Log3mf.context "parsing model" do |l|
       begin
-        model_doc = GlobalXMLValidations.validate_parse(zip_entry)
+        model_doc = XmlVal.validate_parse(zip_entry)
       rescue Nokogiri::XML::SyntaxError => e
         l.fatal_error "Model file invalid XML. Exception #{e}"
       end
@@ -108,6 +108,13 @@ class Model3mf
         metadata = model_doc.root.css("metadata")
         metadata_names = metadata.map { |met| met['name'] }
         l.error :metadata_elements_with_same_name unless metadata_names.uniq!.nil?
+
+        # metadata values allowed under default namespace (xmlns):
+        metadata_values = ['Title', 'Designer', 'Description', 'Copyright', 'LicenseTerms', 'Rating', 'CreationDate', 'ModificationDate' ]
+
+        unless model_doc.root.namespace.href.nil? || model_doc.root.namespace_definitions.count > 1
+          l.error :invalid_metadata_under_defaultns unless (metadata_names - metadata_values).empty?
+        end
       end
 
       MeshAnalyzer.validate(model_doc)

data/lib/ruby3mf/relationships.rb

@@ -5,7 +5,7 @@ class Relationships
     Log3mf.context "parsing relationships" do |l|
       begin
         # Parse Relationships XML
-        doc = GlobalXMLValidations.validate_parse(zip_entry)
+        doc = XmlVal.validate_parse(zip_entry)
 
         # Verify <Relationships><Relationship/></Relationships>
         root_element = doc.children[0]
@@ -14,11 +14,7 @@ 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
+                l.error :multiple_relationships if (relationships.select { |r| r[:target] == node['Target'] && r[:type] == node['Type'] }.size > 0)
                 relationships << {target: node['Target'], type: node['Type'], id: node['Id']}
                 l.info "adding relationship: #{relationships.last.inspect}"
               else

data/lib/ruby3mf/thumbnail3mf.rb

@@ -3,16 +3,14 @@ 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
+      img_type = MimeMagic.by_magic(relationship_file.get_input_stream)
+      l.fatal_error :invalid_thumbnail_file unless img_type
+      l.error(:invalid_thumbnail_file_type, type: img_type) unless ['image/png', 'image/jpeg'].include? img_type.type
 
+      img_colorspace = MiniMagick::Image.read(relationship_file.get_input_stream).colorspace
+      l.fatal_error :invalid_thumbnail_colorspace if img_colorspace.include? "CMYK"
+    end
+  end
 end

data/lib/ruby3mf/version.rb

@@ -1,3 +1,3 @@
 module Ruby3mf
-  VERSION = "0.1.15"
+  VERSION = "0.1.17"
 end

data/lib/ruby3mf/xml_val.rb

@@ -0,0 +1,47 @@
+require 'nokogiri'
+
+class XmlVal
+
+  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 "validations" do |l|
+      l.error :invalid_language_locale        if invalid_locale?(document)
+      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)
+      l.error :has_commas_for_floats          if bad_floating_numbers?(document)
+    end
+  end
+
+  def self.invalid_locale?(document)
+    !document.xpath('//@xml:lang').empty? && document.xpath('//@xml:lang').text != "en-US"
+  end
+
+  def self.bad_floating_numbers?(document)
+    !document.xpath('.//*[find_with_regex(., "[0-9]+\,[0-9]+")]', Class.new {
+      def find_with_regex node_set, regex
+        node_set.find_all { |node| node.values.any? {|v| v =~ /#{regex}/  } }
+      end
+    }.new).empty?
+  end
+
+  def self.space_attribute_exists?(document)
+    !(document.xpath('//*[@xml:space]').empty?)
+  end
+
+  def self.xml_not_utf8_encoded?(document)
+    !document.encoding.nil? && (document.encoding.to_s.downcase != '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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby3mf
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors:
 - Mike Whitmarsh, Jeff Porter, and William Hertling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,15 +141,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/batch.rb
 - bin/cli.rb
 - bin/console
+- bin/folder_test.sh
 - bin/setup
 - 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/interpolation.rb
 - lib/ruby3mf/log3mf.rb
 - lib/ruby3mf/mesh_analyzer.rb
@@ -158,6 +159,7 @@ files:
 - lib/ruby3mf/texture3mf.rb
 - lib/ruby3mf/thumbnail3mf.rb
 - lib/ruby3mf/version.rb
+- lib/ruby3mf/xml_val.rb
 - ruby3mf.gemspec
 homepage: https://github.com/IPGPTP/ruby3mf
 licenses:

data/lib/ruby3mf/global_xml_validations.rb

@@ -1,36 +0,0 @@
-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
-
-
-
-
-