u3d 0.9

data/lib/u3d/utils.rb

@@ -0,0 +1,121 @@
+## --- 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 'net/http'
+require 'fileutils'
+require 'filesize'
+require 'u3d_core/helper'
+
+module U3d
+  # Several different utility methods
+  module Utils
+    # Regex to capture each part of a version string (0.0.0x0)
+    CSIDL_LOCAL_APPDATA = 0x001c
+    UNITY_VERSION_REGEX = /(\d+)(?:\.(\d+)(?:\.(\d+))?)?(?:(\w)(?:(\d+))?)?/
+
+    class << self
+      def get_ssl(url, redirect_limit: 10)
+        raise 'Too many redirections' if redirect_limit.zero?
+        response = nil
+        request = nil
+        uri = URI(url)
+        begin
+          Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+            request = Net::HTTP::Get.new uri
+            response = http.request request
+          end
+        rescue OpenSSL::OpenSSLError => ssl_error
+          UI.error 'SSL has faced an error, you may want to check our README to fix it'
+          raise ssl_error
+        end
+
+        case response
+        when Net::HTTPSuccess then
+          response.body
+        when Net::HTTPRedirection then
+          UI.verbose "Redirected to #{response['location']}"
+          get_ssl(response['location'], redirect_limit: redirect_limit - 1)
+        else raise "Request failed with status #{response.code}"
+        end
+      end
+
+      def hashfile(file_path, blocksize: 65_536)
+        require 'digest'
+        raise ArgumentError, 'Not a file' unless File.file?(file_path)
+        md5 = Digest::MD5.new
+        File.open(file_path, 'r') do |f|
+          md5 << f.read(blocksize) until f.eof?
+        end
+        md5.hexdigest
+      end
+
+      def ensure_dir(dir)
+        FileUtils.mkpath(dir) unless File.directory?(dir)
+      end
+
+      def print_progress(current, total, started_at)
+        ratio = [current.to_f / total, 1.0].min
+        percent = (ratio * 100.0).round(1)
+        arrow = (ratio * 20.0).floor
+        time_spent = Time.now.to_i - started_at
+        print("\r[")
+        print('=' * [arrow - 1, 0].max)
+        print('>')
+        print('.' * (20 - arrow))
+        print("] #{pretty_filesize(current)}/#{pretty_filesize(total)} (#{percent}% at #{pretty_filesize(current.to_f / time_spent)}/s)     ")
+      end
+
+      def print_progress_nosize(current, started_at)
+        time_spent = Time.now.to_i - started_at
+        print("\r>#{pretty_filesize(current)} downloaded at #{pretty_filesize(current.to_f / time_spent)}/s)    ")
+      end
+
+      def parse_unity_version(version)
+        ver = UNITY_VERSION_REGEX.match(version)
+        if ver.nil?
+          raise ArgumentError, "Version (#{version}) does not match the Unity "\
+          'version format 0.0.0x0'
+        end
+        [ver[1], ver[2], ver[3], ver[4], ver[5]]
+      end
+
+      def windows_local_appdata
+        require 'win32api'
+
+        windir = ' ' * 261
+
+        getdir = Win32API.new('shell32', 'SHGetFolderPath', 'LLLLP', 'L')
+        result = getdir.call(0, CSIDL_LOCAL_APPDATA, 0, 0, windir)
+        raise "Unable to get Local Appdata directory, returned with value #{result}" unless result.zero?
+        windir.rstrip!
+        windir = File.expand_path(windir.rstrip)
+
+        return windir if Dir.exist? windir
+        raise "Local Appdata retrieved (#{windir}) is not correct"
+      end
+
+      def pretty_filesize(filesize)
+        Filesize.from(filesize.round.to_s + ' B').pretty
+      end
+    end
+  end
+end

data/lib/u3d/version.rb

@@ -0,0 +1,31 @@
+## --- 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 ---
+
+module U3d
+  VERSION = '0.9'.freeze
+  DESCRIPTION = 'Provides numerous tools for installing, managing and running the Unity3D game engine from command line.'.freeze
+  UNITY_VERSIONS_NOTE = "Unity3d uses the following version formatting: 0.0.0x0. The \'x\' can takes different values:\n"\
+  "\t. 'f' are the main release candidates for Unity3d\n"\
+  "\t. 'p' are patches fixing those releases\n"\
+  "\t. 'b' are the beta releases\n"\
+  "\t. 'a' are the alpha releases (not currently discovered)\n".freeze
+end

data/lib/u3d_core.rb

@@ -0,0 +1,30 @@
+## --- 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 'u3d_core/globals'
+require 'u3d_core/helper'
+require 'u3d_core/credentials'
+require 'u3d_core/ui/ui'
+require 'u3d_core/command_executor'
+require 'u3d_core/command_runner'
+require 'colored'
+require 'commander'

data/lib/u3d_core/command_executor.rb

@@ -0,0 +1,134 @@
+## --- BEGIN LICENSE BLOCK ---
+# Original work Copyright (c) 2015-present the fastlane authors
+# Modified work Copyright 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 'u3d_core/credentials'
+
+module U3dCore
+  # Executes commands and takes care of error handling and more
+  class CommandExecutor
+    class << self
+      # Cross-platform way of finding an executable in the $PATH. Respects the $PATHEXT, which lists
+      # valid file extensions for executables on Windows.
+      #
+      #    which('ruby') #=> /usr/bin/ruby
+      #
+      # Derived from http://stackoverflow.com/a/5471032/3005
+      def which(cmd)
+        # PATHEXT contains the list of file extensions that Windows considers executable, semicolon separated.
+        # e.g. ".COM;.EXE;.BAT;.CMD"
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          exts.each do |ext|
+            cmd_path = File.expand_path("#{cmd}#{ext}", path)
+            return cmd_path if File.executable?(cmd_path) && !File.directory?(cmd_path)
+          end
+        end
+
+        return nil
+      end
+
+      # @param command [String] The command to be executed
+      # @param print_all [Boolean] Do we want to print out the command output while running?
+      # @param print_command [Boolean] Should we print the command that's being executed
+      # @param error [Block] A block that's called if an error occurs
+      # @param prefix [Array] An array containg a prefix + block which might get applied to the output
+      # @param loading [String] A loading string that is shown before the first output
+      # @param admin [Boolean] Do we need admin privilege for this command?
+      # @param keychain [Boolean] Should we fetch admin rights from the keychain on OSX
+      # @return [String] All the output as string
+      def execute(command: nil, print_all: false, print_command: true, error: nil, prefix: nil, loading: nil, admin: false)
+        print_all = true if U3dCore::Globals.verbose?
+        prefix ||= {}
+
+        output = []
+        command = command.join(' ') if command.is_a?(Array)
+        UI.command(command) if print_command
+
+        # this is only used to show the "Loading text"...
+        UI.command_output(loading) if print_all && loading
+
+        if admin
+          cred = U3dCore::Credentials.new(user: ENV['USER'])
+          if Helper.windows?
+            raise CredentialsError, "The command \'#{command}\' must be run in administrative shell" unless has_admin_privileges?
+          else
+            command = "sudo -k && echo #{cred.password.shellescape} | sudo -S " + command
+          end
+          UI.verbose 'Admin privileges granted for command execution'
+        end
+
+        begin
+          status = U3dCore::Runner.run(command) do |stdin, _stdout, _pid|
+            stdin.each do |l|
+              line = l.strip # strip so that \n gets removed
+              output << line
+
+              next unless print_all
+
+              # Prefix the current line with a string
+              prefix.each do |element|
+                line = element[:prefix] + line if element[:block] && element[:block].call(line)
+              end
+
+              UI.command_output(line)
+            end
+          end
+          raise "Exit status: #{status}".red if status.nonzero? && !status.nil?
+        rescue => ex
+          # This could happen
+          # * if the status is failed
+          # * when the environment is wrong:
+          # > invalid byte sequence in US-ASCII (ArgumentError)
+          output << ex.to_s
+          o = output.join("\n")
+          UI.verbose o
+          raise ex unless error
+          error.call(o, nil)
+        end
+        return output.join("\n")
+      end
+
+      def has_admin_privileges?
+        if Helper.windows?
+          begin
+            result = system('reg query HKU\\S-1-5-19', out: File::NULL, err: File::NULL)
+          rescue
+            result = false
+          end
+        else
+          credentials = U3dCore::Credentials.new(user: ENV['USER'])
+          begin
+            # FIXME: hide / show output
+            result = system("sudo -k && echo #{credentials.password.shellescape} | sudo -S /usr/bin/whoami")
+          rescue
+            result = false
+          end
+          credentials.forget_credentials unless result # FIXME: why?
+        end
+        # returns false if result is nil (command execution fail)
+        return (result ? true : false)
+      end
+    end
+  end
+end

data/lib/u3d_core/command_runner.rb

@@ -0,0 +1,93 @@
+## --- BEGIN LICENSE BLOCK ---
+# Original work Copyright (c) 2015-present the fastlane authors
+# Modified work Copyright 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 ---
+
+module U3dCore
+  # this module is meant to be private to this lib
+  module Runner
+    class << self
+      def run(command, &block)
+        select_runner_impl.call(command, &block)
+      end
+
+      private
+
+      def select_runner_impl
+        # disable PTY by setting env variable
+        return U3dCore::SafePopen.method(:spawn) unless ENV['U3D_NO_TTY'].nil?
+        begin
+          require 'pty'
+          return U3dCore::SafePty.method(:spawn)
+        rescue LoadError
+          UI.important("No pty implementation found. Falling back to popen. Output might be buffered")
+          return U3dCore::SafePopen.method(:spawn)
+        end
+      end
+    end
+  end
+
+  # Executes commands using PTY and takes care of error handling and more
+  class SafePty
+    # Wraps the PTY.spawn() call, wait until the process completes.
+    # Also catch exceptions that might be raised
+    # See also https://www.omniref.com/ruby/gems/shell_test/0.5.0/files/lib/shell_test/shell_methods/utils.rb
+    def self.spawn(command, &_block)
+      require 'pty'
+      PTY.spawn(command) do |r, w, p|
+        begin
+          trap('INT') do
+            Process.kill("INT", p)
+          end
+          yield r, w, p
+        # if the process has closed, ruby might raise an exception if we try
+        # to do I/O on a closed stream. This behavior is platform specific
+        rescue Errno::EIO
+        ensure
+          begin
+            Process.wait p
+          # The process might have exited.
+          # This behavior is also ruby version dependent.
+          rescue Errno::ECHILD, PTY::ChildExited
+          end
+        end
+      end
+      $?.exitstatus
+    end
+  end
+
+  # Executes commands using popen2 and takes care of error handling and more
+  # Note that the executed program might buffer the output as it isn't run inside
+  # a pseudo terminal.
+  class SafePopen
+    # Wraps the Open3.popen2e() call, wait until the process completes.
+    def self.spawn(command, &_block)
+      require 'open3'
+      Open3.popen2e(command) do |r, w, p|
+        yield w, r, p.value.pid # note the inversion
+
+        r.close
+        w.close
+        p.value.exitstatus
+      end
+    end
+  end
+end

data/lib/u3d_core/credentials.rb

@@ -0,0 +1,116 @@
+## --- BEGIN LICENSE BLOCK ---
+# Original work Copyright (c) 2015-present the fastlane authors
+# Modified work Copyright 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 'u3d_core/helper'
+require 'security'
+
+module U3dCore
+  class Credentials
+    MAC_U3D_SERVER = 'u3d'.freeze
+    def initialize(user: nil, password: nil)
+      @user = user
+      @password = password
+      @use_keychain = U3dCore::Globals.use_keychain?
+    end
+
+    def user
+      @user ||= ENV['U3D_USER']
+
+      while @user.to_s.empty?
+        UI.verbose 'Username does not exist or is empty'
+        raise CredentialsError, 'Username missing and context is not interactive. Please check that the environment variable is correct' unless UI.interactive?
+        @user = UI.input 'Username for u3d:'
+      end
+
+      return @user
+    end
+
+    def password
+      @password ||= ENV['U3D_PASSWORD']
+
+      if Helper.mac? && @use_keychain
+        unless @password
+          UI.message 'Fetching password from keychain'
+          password_holder = Security::InternetPassword.find(server: MAC_U3D_SERVER)
+          @password = password_holder.password unless password_holder.nil?
+        end
+      end
+
+      if @password.to_s.empty?
+        UI.verbose 'Could not retrieve password'
+        if U3dCore::Globals.do_not_login?
+          UI.verbose 'Login disabled'
+        else
+          login
+        end
+      end
+
+      return @password
+    end
+
+    def login
+      UI.verbose 'Attempting to login'
+
+      raise CredentialsError, 'No username specified' unless user
+
+      while @password.to_s.empty?
+        UI.verbose 'Password does not exist or is empty'
+        raise CredentialsError, 'Password missing and context is not interactive. Please make sure it is correct' unless UI.interactive?
+        @password = UI.password "Password for #{user}:"
+      end
+
+      if remember_credentials
+        UI.success 'Credentials have been stored'
+      else
+        UI.important 'No credentials storage available'
+      end
+    end
+
+    def remember_credentials
+      ENV['U3D_USER'] = @user
+      ENV['U3D_PASSWORD'] = @password
+      if Helper.mac? && @use_keychain
+        UI.message 'Storing credentials to the keychain'
+        return Security::InternetPassword.add(MAC_U3D_SERVER, user, password)
+      end
+
+      return false
+    end
+
+    def forget_credentials(force: false)
+      @password = nil
+      ENV['U3D_PASSWORD'] = nil
+      if force || UI.interactive?
+        if Helper.mac? && @use_keychain && (force || UI.confirm('Remove credentials from the keychain?'))
+          UI.message 'Deleting credentials from the keychain'
+          Security::InternetPassword.delete(server: MAC_U3D_SERVER)
+        end
+      else
+        UI.verbose 'Keychain may store invalid credentials for u3d' if Helper.mac?
+      end
+    end
+  end
+
+  class CredentialsError < StandardError
+  end
+end