u3d 1.1.5 → 1.2.0

data/lib/u3d.rb

@@ -32,11 +32,13 @@ require 'u3d/commands_generator'
 require 'u3d/download_validator'
 require 'u3d/downloader'
 require 'u3d/failure_reporter'
-require 'u3d/iniparser'
+require 'u3d/ini_modules_parser'
 require 'u3d/installation'
 require 'u3d/installer'
+require 'u3d/hub_modules_parser'
 require 'u3d/log_analyzer'
 require 'u3d/unity_license'
+require 'u3d/unity_module'
 require 'u3d/unity_project'
 require 'u3d/unity_runner'
 require 'u3d/unity_version_definition'

data/lib/u3d/commands.rb

@@ -124,19 +124,16 @@ module U3d
         end
         sorted_keys = vcomparators.sort.map { |v| v.version.to_s }
 
+        show_packages = options[:packages]
+        packages = UnityModule.load_modules(sorted_keys, cache_versions, os: os) if show_packages
+
         sorted_keys.each do |k|
           v = cache_versions[k]
           UI.message "Version #{k}: " + v.to_s.cyan.underline
-          next unless options[:packages]
-          inif = nil
-          begin
-            inif = U3d::INIparser.load_ini(k, cache_versions, os: os)
-          rescue StandardError => e
-            UI.error "Could not load packages for this version (#{e})"
-          else
-            UI.message 'Packages:'
-            inif.each_key { |pack| UI.message " - #{pack}" }
-          end
+          next unless show_packages
+          version_packages = packages[k]
+          UI.message 'Packages:'
+          version_packages.each { |package| UI.message " - #{package.id.capitalize}" }
         end
       end
 
@@ -146,8 +143,6 @@ module U3d
         UI.user_error!("You cannot use the --operating_system and the --install options together") if options[:install] && options[:operating_system]
         os = valid_os_or_current(options[:operating_system])
 
-        packages = packages_with_unity_first(options)
-
         cache_versions = cache_versions(os, offline: !options[:download])
         version = interpret_latest(version, cache_versions)
         unless cache_versions[version]
@@ -157,7 +152,13 @@ module U3d
 
         definition = UnityVersionDefinition.new(version, os, cache_versions)
         unity = check_unity_presence(version: version)
-        return unless enforce_setup_coherence(packages, options, unity, definition)
+        packages = options[:packages] || ['Unity']
+
+        begin
+          packages = enforce_setup_coherence(packages, options, unity, definition)
+        rescue InstallationSetupError
+          return
+        end
 
         verify_package_names(definition, packages)
 
@@ -332,12 +333,6 @@ module U3d
         iversion
       end
 
-      def packages_with_unity_first(options)
-        temp = options[:packages] || ['Unity']
-        temp.insert(0, 'Unity') if temp.delete('Unity')
-        temp
-      end
-
       def check_unity_presence(version: nil)
         # idea: we could support matching 5.3.6p3 if passed 5.3.6
         installed = Installer.create.installed
@@ -357,6 +352,7 @@ module U3d
           packages.clear
           packages.concat(definition.available_packages)
         end
+        packages = sort_packages(packages, definition)
         if options[:install]
           if unity
             UI.important "Unity #{unity.version} is already installed"
@@ -369,22 +365,64 @@ module U3d
               # FIXME: Move me to the WindowsInstaller
               options[:installation_path] ||= unity.root_path if definition.os == :win
             end
-            packages.select { |pack| unity.package_installed?(pack) }.each do |pack|
-              packages.delete pack
-              UI.important "Ignoring #{pack} module, it is already installed"
-            end
-            return false if packages.empty?
+            # FIXME: unity.package_installed? is not reliable
+            packages = detect_installed_packages(packages, unity)
+            packages = detect_missing_dependencies(packages, unity, definition)
+            raise InstallationSetupError if packages.empty?
           else
-            unless packages.include?('Unity')
+            unless packages.map(&:downcase).include?('unity')
               UI.error 'Please install Unity before any of its packages'
-              return false
+              raise InstallationSetupError
             end
           end
         end
-        true
+        packages
       end
       # rubocop:enable Metrics/BlockNesting
 
+      def sort_packages(packages, definition)
+        packages.sort do |a, b|
+          package_a = definition[a]
+          package_b = definition[b]
+          if package_a.depends_on?(package_b) # b must come first
+            1
+          elsif package_b.depends_on?(package_a) # a must come first
+            -1
+          else
+            a <=> b # Resort to alphabetical sorting
+          end
+        end
+      end
+
+      def detect_installed_packages(packages, unity)
+        result = packages
+        packages.select { |pack| unity.package_installed?(pack) }.each do |pack|
+          result.delete pack
+          UI.important "Ignoring #{pack} module, it is already installed"
+        end
+        result
+      end
+
+      def detect_missing_dependencies(packages, unity, definition)
+        result = packages
+        packages.reject { |package| can_install?(package, unity, definition, packages) }.each do |pack|
+          # See FIXME for package_installed?
+          # result.delete pack
+          package = definition[pack]
+          UI.important "#{package.name} depends on #{package.depends_on}, but it's neither installed nor being installed."
+        end
+        result
+      end
+
+      def can_install?(package_name, unity, definition, installing)
+        package = definition[package_name]
+        return true unless package.depends_on
+        return true if unity.package_installed?(package.depends_on)
+        installing.map { |other| definition[other] }.any? do |other|
+          other.id == package.depends_on || other.name == package.depends_on
+        end
+      end
+
       def get_administrative_privileges(options)
         U3dCore::Globals.use_keychain = true if options[:keychain] && Helper.mac?
         UI.important 'Root privileges are required'
@@ -394,3 +432,6 @@ module U3d
   end
   # rubocop:enable ClassLength
 end
+
+class InstallationSetupError < StandardError
+end

data/lib/u3d/download_validator.rb

@@ -51,7 +51,7 @@ module U3d
 
   class LinuxValidator < DownloadValidator
     def validate(package, file, definition)
-      return size_validation(expected: definition[package]['size'], actual: File.size(file)) if definition.ini && definition[package]['size']
+      return size_validation(expected: definition[package].download_size, actual: File.size(file)) if definition[package] && definition[package].download_size
       UI.important "No file validation available, #{file} is assumed to be correct"
       true
     end
@@ -59,25 +59,25 @@ module U3d
 
   class MacValidator < DownloadValidator
     def validate(package, file, definition)
-      if definition[package]['size'] % 1000 && definition[package]['md5'].nil?
-        UI.verbose "File '#{definition[package]['title']}' seems external. Validation skipped"
+      if definition[package].download_size % 1000 && definition[package].checksum.nil?
+        UI.verbose "File '#{definition[package].name}' seems external. Validation skipped"
         return true
       end
-      size_validation(expected: definition[package]['size'], actual: File.size(file)) &&
-        hash_validation(expected: definition[package]['md5'], actual: Utils.hashfile(file))
+      size_validation(expected: definition[package].download_size, actual: File.size(file)) &&
+        hash_validation(expected: definition[package].checksum, actual: Utils.hashfile(file))
     end
   end
 
   class WindowsValidator < DownloadValidator
     def validate(package, file, definition)
       # External packages have no md5 and a false size value
-      if definition[package]['size'] % 1000 && definition[package]['md5'].nil?
-        UI.verbose "File '#{definition[package]['title']}' seems external. Validation skipped"
+      if definition[package].download_size % 1000 && definition[package].checksum.nil?
+        UI.verbose "File '#{definition[package].name}' seems external. Validation skipped"
         return true
       end
       rounded_size = (File.size(file).to_f / 1024).floor
-      size_validation(expected: definition[package]['size'], actual: rounded_size) &&
-        hash_validation(expected: definition[package]['md5'], actual: Utils.hashfile(file))
+      size_validation(expected: definition[package].download_size, actual: rounded_size) &&
+        hash_validation(expected: definition[package].checksum, actual: Utils.hashfile(file))
     end
   end
 end

data/lib/u3d/downloader.rb

@@ -30,6 +30,8 @@ module U3d
     DOWNLOAD_DIRECTORY = 'Unity_Packages'.freeze
     # Path to the directory for the package downloading
     DOWNLOAD_PATH = "#{ENV['HOME']}/Downloads".freeze
+    # Regex to get the name of a localization asset
+    UNITY_LANGUAGE_FILE_REGEX = %r{\/\d+/[0-9\.]+\/([\w-]+)$}
     # Regex to get the name of a package out of its file name
     UNITY_MODULE_FILE_REGEX = %r{\/([\w\-_\.\+]+\.(?:pkg|exe|zip|sh|deb|msi|xz))[^\/]*$}
 
@@ -101,11 +103,12 @@ module U3d
 
       def get_package(downloader, validator, package, definition, files)
         path, url = downloader.destination_and_url_for(package, definition)
+        package_info = definition[package]
         if File.file?(path)
-          UI.verbose "Installer file for #{package} seems to be present at #{path}"
+          UI.verbose "Installer file for #{package_info.name} seems to be present at #{path}"
           if validator.validate(package, path, definition)
-            UI.message "#{package.capitalize} is already downloaded"
-            files << [package, path, definition[package]]
+            UI.message "#{package_info.name} is already downloaded"
+            files << [package, path, package_info]
             return
           else
             extension = File.extname(path)
@@ -115,14 +118,14 @@ module U3d
           end
         end
 
-        UI.header "Downloading #{package} version #{definition.version}"
+        UI.header "Downloading #{package_info.name} version #{definition.version}"
         UI.message 'Downloading from ' + url.to_s.cyan.underline
         UI.message 'Download will be found at ' + path
-        download_package(path, url, size: definition.size_in_bytes(package))
+        download_package(path, url, size: package_info.download_size)
 
         if validator.validate(package, path, definition)
           UI.success "Successfully downloaded #{package}."
-          files << [package, path, definition[package]]
+          files << [package, path, package_info]
         else
           UI.error "Failed to download #{package}"
         end
@@ -148,7 +151,14 @@ module U3d
 
         dir = File.join(Downloader.download_directory, definition.version)
         Utils.ensure_dir(dir)
-        file_name = UNITY_MODULE_FILE_REGEX.match(final_url)[1]
+
+        file_name = if (language_match = UNITY_LANGUAGE_FILE_REGEX.match(final_url))
+                      language_match[1] + '.po' # Unity uses PO (Portable object files) for localization
+                    elsif (module_match = UNITY_MODULE_FILE_REGEX.match(final_url))
+                      module_match[1]
+                    else
+                      raise "Unable to download file at #{final_url}. Please report it to the u3d issues on Github: https://github.com/DragonBox/u3d/issues/new"
+                    end
 
         destination = File.expand_path(file_name, dir)
 
@@ -156,7 +166,7 @@ module U3d
       end
 
       def url_for(package, definition)
-        url = definition[package]['url']
+        url = definition[package].url
         if url
           if url =~ /^http/
             Utils.final_url(url)

data/lib/u3d/hub_modules_parser.rb

@@ -0,0 +1,88 @@
+## --- BEGIN LICENSE BLOCK ---
+# Copyright (c) 2016-present WeWantToKnow AS
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+## --- END LICENSE BLOCK ---
+
+require 'json'
+require 'u3d/unity_versions'
+require 'u3d/utils'
+require 'u3d_core/helper'
+
+module U3d
+  module HubModulesParser
+    class << self
+      HUB_MODULES_NAME = '%<version>s-%<os>s-modules.json'.freeze
+
+      def load_modules(version, os: U3dCore::Helper.operating_system, offline: false)
+        path = modules_path(version, os)
+
+        unless File.file?(path) && File.size(path) > 0
+          return [] if offline # Should not raise, not all versions have hub modules
+          versions = download_modules(os: os)
+
+          unless versions.include? version
+            UI.verbose "No modules registered for UnityHub for version #{version}"
+            return []
+          end
+        end
+
+        return JSON.parse(File.read(path))
+      end
+
+      def download_modules(os: U3dCore::Helper.operating_system)
+        url = UnityVersions.json_url_for(json_os(os))
+        builds = UnityVersions.fetch_json(url, UnityVersions::UNITY_LATEST_JSON)
+        builds.each { |build| write_modules(build, os) }
+        return builds.map { |build| build['versions'] }
+      end
+
+      private
+
+      def json_os(os)
+        platform_versions = case os
+                            when :win
+                              UnityVersions::WindowsVersions
+                            when :linux
+                              UnityVersions::LinuxVersions
+                            when :mac
+                              UnityVersions::MacVersions
+                            end
+
+        return platform_versions::JSON_OS
+      end
+
+      def modules_path(version, os)
+        file_name = format(HUB_MODULES_NAME, version: version, os: os)
+        File.join(default_modules_path, file_name)
+      end
+
+      def default_modules_path
+        File.join(U3dCore::Helper.data_path, 'unity_hub_modules')
+      end
+
+      def write_modules(build, os)
+        path = modules_path(build['version'], os)
+        Utils.ensure_dir(File.dirname(path))
+
+        File.open(path, 'w') { |file| file.write build['modules'].to_json }
+      end
+    end
+  end
+end

data/lib/u3d/{iniparser.rb → ini_modules_parser.rb}

@@ -25,8 +25,32 @@ require 'u3d/utils'
 require 'u3d_core/helper'
 
 module U3d
+  # Backwards compatibility
+  module INIParser
+    class << self
+      def method_missing(method_name, *arguments, &block)
+        UI.deprecated 'INIParser is obsolete, Use INIModulesParser instead'
+        if INIModulesParser.respond_to?(method_name)
+          INIModulesParser.send(method_name, *arguments, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to?(method_name, include_private = false)
+        UI.deprecated 'INIParser is obsolete, Use INIModulesParser instead'
+        INIModulesParser.respond_to?(method_name, include_private)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        UI.deprecated 'INIParser is obsolete, Use INIModulesParser instead'
+        INIModulesParser.respond_to_missing?(method_name, include_private)
+      end
+    end
+  end
+
   # Load and parse INI files
-  module INIparser
+  module INIModulesParser
     #####################################################
     # @!group INI parameters to load and save ini files
     #####################################################
@@ -42,7 +66,7 @@ module U3d
         ini_name = format(INI_NAME, version: version, os: os)
         Utils.ensure_dir(default_ini_path)
         ini_path = File.expand_path(ini_name, default_ini_path)
-        unless File.file?(ini_path)
+        unless File.file?(ini_path) && File.size(ini_path) > 0
           raise "INI file does not exist at #{ini_path}" if offline
           download_ini(version, cached_versions, os, ini_name, ini_path)
         end
@@ -58,9 +82,8 @@ module U3d
         ini_name = format(INI_NAME, version: version, os: 'linux')
         Utils.ensure_dir(default_ini_path)
         ini_path = File.expand_path(ini_name, default_ini_path)
-        return if File.file? ini_path
-        File.open(ini_path, 'wb') do |f|
-          f.write %([Unity]
+        return if File.file?(ini_path) && File.size(ini_path) > 0
+        data = %([Unity]
 ; -- NOTE --
 ; This is not an official Unity file
 ; This has been created by u3d
@@ -69,7 +92,7 @@ title=Unity
 size=#{size}
 url=#{url}
 )
-        end
+        write_ini_file(ini_path, data)
       end
 
       private
@@ -89,10 +112,16 @@ url=#{url}
         end
         uri = URI(cached_versions[version] + ini_name)
         UI.verbose("Searching for ini file at #{uri}")
+
+        data = Net::HTTP.get(uri)
+        data.tr!("\"", '')
+        data.gsub!(/Note:.+\n/, '')
+
+        write_ini_file(ini_path, data)
+      end
+
+      def write_ini_file(ini_path, data)
         File.open(ini_path, 'wb') do |f|
-          data = Net::HTTP.get(uri)
-          data.tr!("\"", '')
-          data.gsub!(/Note:.+\n/, '')
           f.write(data)
         end
       end

data/lib/u3d/installation.rb

@@ -296,8 +296,21 @@ module U3d
   end
 
   class WindowsInstallationHelper
-    def build_number(exe_path)
-      s = string_file_info("Unity Version", exe_path)
+    def initialize(exe_path)
+      @exe_path = exe_path
+    end
+
+    def version
+      s = unity_version_info
+      if s
+        a = s.split("_")
+        return a[0] unless a.empty?
+      end
+      nil
+    end
+
+    def build_number
+      s = unity_version_info
       if s
         a = s.split("_")
         return a[1] if a.count > 1
@@ -307,6 +320,10 @@ module U3d
 
     private
 
+    def unity_version_info
+      @uvf ||= string_file_info('Unity Version', @exe_path)
+    end
+
     def string_file_info(info, path)
       require "Win32API"
       get_file_version_info_size = Win32API.new('version.dll', 'GetFileVersionInfoSize', 'PP', 'L')
@@ -347,6 +364,9 @@ module U3d
 
   class WindowsInstallation < Installation
     def version
+      version = helper.version
+      return version unless version.nil?
+
       path = "#{root_path}/Editor/Data/"
       package = PlaybackEngineUtils.list_module_configs(path).first
       raise "Couldn't find a module under #{path}" unless package
@@ -354,7 +374,7 @@ module U3d
     end
 
     def build_number
-      @build_number ||= WindowsInstallationHelper.new.build_number(exe_path)
+      helper.build_number
     end
 
     def default_log_file
@@ -408,5 +428,11 @@ module U3d
     def clean_install?
       do_not_move? || !(root_path =~ UNITY_DIR_CHECK).nil?
     end
+
+    private
+
+    def helper
+      @helper ||= WindowsInstallationHelper.new(exe_path)
+    end
   end
 end