aspera-cli 4.13.0 → 4.15.0

data/lib/aspera/cli/transfer_agent.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'aspera/fasp/transfer_spec'
-require 'aspera/cli/listener/logger'
-require 'aspera/cli/listener/progress_multi'
 require 'aspera/cli/info'
 
 module Aspera
@@ -16,7 +14,7 @@ module Aspera
       # special value for --sources : read file list from transfer spec (--ts)
       FILE_LIST_FROM_TRANSFER_SPEC = '@ts'
       FILE_LIST_OPTIONS = [FILE_LIST_FROM_ARGS, FILE_LIST_FROM_TRANSFER_SPEC, 'Array'].freeze
-      DEFAULT_TRANSFER_NOTIF_TMPL = <<~END_OF_TEMPLATE
+      DEFAULT_TRANSFER_NOTIFY_TEMPLATE = <<~END_OF_TEMPLATE
         From: <%=from_name%> <<%=from_email%>>
         To: <<%=to%>>
         Subject: <%=subject%>
@@ -29,7 +27,7 @@ module Aspera
       private_constant :FILE_LIST_FROM_ARGS,
         :FILE_LIST_FROM_TRANSFER_SPEC,
         :FILE_LIST_OPTIONS,
-        :DEFAULT_TRANSFER_NOTIF_TMPL
+        :DEFAULT_TRANSFER_NOTIFY_TEMPLATE
       TRANSFER_AGENTS = %i[direct node connect httpgw trsdk].freeze
 
       class << self
@@ -43,81 +41,79 @@ module Aspera
       end
 
       # @param env external objects: option manager, config file manager
-      def initialize(opt_mgr, config)
+      def initialize(opt_mgr, config_plugin)
         @opt_mgr = opt_mgr
-        @config = config
+        @config = config_plugin
         # command line can override transfer spec
-        @transfer_spec_cmdline = {'create_dir' => true}
+        @transfer_spec_command_line = {'create_dir' => true}
+        # options for transfer agent
         @transfer_info = {}
         # the currently selected transfer agent
         @agent = nil
-        @progress_listener = Listener::ProgressMulti.new
         # source/destination pair, like "paths" of transfer spec
         @transfer_paths = nil
-        @opt_mgr.set_obj_attr(:ts, self, :option_transfer_spec)
-        @opt_mgr.set_obj_attr(:transfer_info, self, :option_transfer_info)
-        @opt_mgr.add_opt_simple(:ts, "Override transfer spec values (Hash, e.g. use @json: prefix), current=#{@opt_mgr.get_option(:ts)}")
-        @opt_mgr.add_opt_simple(:to_folder, 'Destination folder for transferred files')
-        @opt_mgr.add_opt_simple(:sources, "How list of transferred files is provided (#{FILE_LIST_OPTIONS.join(',')})")
-        @opt_mgr.add_opt_list(:src_type, %i[list pair], 'Type of file list')
-        @opt_mgr.add_opt_list(:transfer, TRANSFER_AGENTS, 'Type of transfer agent')
-        @opt_mgr.add_opt_simple(:transfer_info, 'Parameters for transfer agent (Hash)')
-        @opt_mgr.add_opt_list(:progress, %i[none native multi], 'Type of progress bar')
-        @opt_mgr.set_option(:transfer, :direct)
-        @opt_mgr.set_option(:src_type, :list)
-        @opt_mgr.set_option(:progress, :native) # use native ascp progress bar as it is more reliable
+        @opt_mgr.declare(:ts, 'Override transfer spec values', types: Hash, handler: {o: self, m: :option_transfer_spec})
+        @opt_mgr.declare(:to_folder, 'Destination folder for transferred files')
+        @opt_mgr.declare(:sources, "How list of transferred files is provided (#{FILE_LIST_OPTIONS.join(',')})")
+        @opt_mgr.declare(:src_type, 'Type of file list', values: %i[list pair], default: :list)
+        @opt_mgr.declare(:transfer, 'Type of transfer agent', values: TRANSFER_AGENTS, default: :direct)
+        @opt_mgr.declare(:transfer_info, 'Parameters for transfer agent', types: Hash, handler: {o: self, m: :transfer_info})
         @opt_mgr.parse_options!
       end
 
-      def option_transfer_spec; @transfer_spec_cmdline; end
+      def option_transfer_spec; @transfer_spec_command_line; end
 
       # multiple option are merged
       def option_transfer_spec=(value)
         raise 'option ts shall be a Hash' unless value.is_a?(Hash)
-        @transfer_spec_cmdline.merge!(value)
+        @transfer_spec_command_line.deep_merge!(value)
       end
 
-      def option_transfer_info; @transfer_info; end
+      # add other transfer spec parameters
+      def option_transfer_spec_deep_merge(ts); @transfer_spec_command_line.deep_merge!(ts); end
 
-      # multiple option are merged
-      def option_transfer_info=(value)
-        raise 'option transfer_info shall be a Hash' unless value.is_a?(Hash)
-        @transfer_info.merge!(value)
+      # @return [Hash] transfer spec with updated values from command line, including removed values
+      def updated_ts(transfer_spec={})
+        transfer_spec.deep_merge!(@transfer_spec_command_line)
+        # recursively remove values that are nil (user wants to delete)
+        transfer_spec.deep_do { |hash, key, value, _unused| hash.delete(key) if value.nil?}
+        return transfer_spec
       end
 
-      def option_transfer_spec_deep_merge(ts); @transfer_spec_cmdline.deep_merge!(ts); end
+      attr_reader :transfer_info
+
+      # multiple option are merged
+      def transfer_info=(value)
+        @transfer_info.deep_merge!(value)
+      end
 
       def agent_instance=(instance)
         @agent = instance
-        @agent.add_listener(Listener::Logger.new)
-        # use local progress bar if asked so, or if native and non local ascp (because only local ascp has native progress bar)
-        if @opt_mgr.get_option(:progress, is_type: :mandatory).eql?(:multi) ||
-            (@opt_mgr.get_option(:progress, is_type: :mandatory).eql?(:native) && !instance.class.to_s.eql?('Aspera::Fasp::AgentDirect'))
-          @agent.add_listener(@progress_listener)
-        end
       end
 
       # analyze options and create new agent if not already created or set
       def set_agent_by_options
         return nil unless @agent.nil?
-        agent_type = @opt_mgr.get_option(:transfer, is_type: :mandatory)
+        agent_type = @opt_mgr.get_option(:transfer, mandatory: true)
         # agent plugin is loaded on demand to avoid loading unnecessary dependencies
         require "aspera/fasp/agent_#{agent_type}"
-        agent_options = @opt_mgr.get_option(:transfer_info)
-        raise CliBadArgument, "the transfer agent configuration shall be Hash, not #{agent_options.class} (#{agent_options}), "\
-          'e.g. use @json:<json>' unless agent_options.is_a?(Hash)
-        # special case: use default node
-        if agent_type.eql?(:node) && agent_options.empty?
-          param_set_name = @config.get_plugin_default_config_name(:node)
-          raise CliBadArgument, "No default node configured. Please specify #{Manager.option_name_to_line(:transfer_info)}" if param_set_name.nil?
-          agent_options = @config.preset_by_name(param_set_name)
-        end
-        # special case: native progress bar
-        if agent_type.eql?(:direct) && @opt_mgr.get_option(:progress, is_type: :mandatory).eql?(:native)
-          agent_options[:quiet] = false
+        # set keys as symbols
+        agent_options = @opt_mgr.get_option(:transfer_info).symbolize_keys
+        # special cases
+        case agent_type
+        when :node
+          if agent_options.empty?
+            param_set_name = @config.get_plugin_default_config_name(:node)
+            raise Cli::BadArgument, "No default node configured. Please specify #{Manager.option_name_to_line(:transfer_info)}" if param_set_name.nil?
+            agent_options = @config.preset_by_name(param_set_name).symbolize_keys
+          end
+        when :direct
+          # by default do not display ascp native progress bar
+          agent_options[:quiet] = true unless agent_options.key?(:quiet)
+          agent_options[:check_ignore] = ->(host, port){@config.ignore_cert?(host, port)}
+          agent_options[:trusted_certs] = @config.trusted_cert_locations(files_only: true) unless agent_options.key?(:trusted_certs)
         end
-        # normalize after getting from user or default node
-        agent_options = agent_options.symbolize_keys
+        agent_options[:progress] = @config.progress_bar
         # get agent instance
         new_agent = Kernel.const_get("Aspera::Fasp::Agent#{agent_type.capitalize}").new(agent_options)
         self.agent_instance = new_agent
@@ -131,7 +127,7 @@ module Aspera
         dest_folder = @opt_mgr.get_option(:to_folder)
         # do not expand path, if user wants to expand path: user @path:
         return dest_folder unless dest_folder.nil?
-        dest_folder = @transfer_spec_cmdline['destination_root']
+        dest_folder = @transfer_spec_command_line['destination_root']
         return dest_folder unless dest_folder.nil?
         # default: / on remote, . on local
         case direction.to_s
@@ -157,7 +153,7 @@ module Aspera
         # return cache if set
         return @transfer_paths unless @transfer_paths.nil?
         # start with lower priority : get paths from transfer spec on command line
-        @transfer_paths = @transfer_spec_cmdline['paths'] if @transfer_spec_cmdline.key?('paths')
+        @transfer_paths = @transfer_spec_command_line['paths'] if @transfer_spec_command_line.key?('paths')
         # is there a source list option ?
         file_list = @opt_mgr.get_option(:sources)
         case file_list
@@ -165,32 +161,32 @@ module Aspera
           Log.log.debug('getting file list as parameters')
           # get remaining arguments
           file_list = @opt_mgr.get_next_argument('source file list', expected: :multiple)
-          raise CliBadArgument, 'specify at least one file on command line or use '\
+          raise Cli::BadArgument, 'specify at least one file on command line or use ' \
             "--sources=#{FILE_LIST_FROM_TRANSFER_SPEC} to use transfer spec" if !file_list.is_a?(Array) || file_list.empty?
         when FILE_LIST_FROM_TRANSFER_SPEC
           Log.log.debug('assume list provided in transfer spec')
           special_case_direct_with_list =
-            @opt_mgr.get_option(:transfer, is_type: :mandatory).eql?(:direct) &&
-            Fasp::Parameters.ts_has_ascp_file_list(@transfer_spec_cmdline, @opt_mgr.get_option(:transfer_info))
-          raise CliBadArgument, 'transfer spec on command line must have sources' if @transfer_paths.nil? && !special_case_direct_with_list
+            @opt_mgr.get_option(:transfer, mandatory: true).eql?(:direct) &&
+            Fasp::Parameters.ts_has_ascp_file_list(@transfer_spec_command_line, @opt_mgr.get_option(:transfer_info))
+          raise Cli::BadArgument, 'transfer spec on command line must have sources' if @transfer_paths.nil? && !special_case_direct_with_list
           # here we assume check of sources is made in transfer agent
           return @transfer_paths
         when Array
           Log.log.debug('getting file list as extended value')
-          raise CliBadArgument, 'sources must be a Array of String' if !file_list.reject{|f|f.is_a?(String)}.empty?
+          raise Cli::BadArgument, 'sources must be a Array of String' if !file_list.reject{|f|f.is_a?(String)}.empty?
         else
-          raise CliBadArgument, "sources must be a Array, not #{file_list.class}"
+          raise Cli::BadArgument, "sources must be a Array, not #{file_list.class}"
         end
         # here, file_list is an Array or String
         if !@transfer_paths.nil?
           Log.log.warn('--sources overrides paths from --ts')
         end
-        case @opt_mgr.get_option(:src_type, is_type: :mandatory)
+        case @opt_mgr.get_option(:src_type, mandatory: true)
         when :list
           # when providing a list, just specify source
           @transfer_paths = file_list.map{|i|{'source' => i}}
         when :pair
-          raise CliBadArgument, "When using pair, provide an even number of paths: #{file_list.length}" unless file_list.length.even?
+          raise Cli::BadArgument, "When using pair, provide an even number of paths: #{file_list.length}" unless file_list.length.even?
           @transfer_paths = file_list.each_slice(2).to_a.map{|s, d|{'source' => s, 'destination' => d}}
         else raise 'Unsupported src_type'
         end
@@ -208,40 +204,37 @@ module Aspera
         case transfer_spec['direction']
         when Fasp::TransferSpec::DIRECTION_RECEIVE
           # init default if required in any case
-          @transfer_spec_cmdline['destination_root'] ||= destination_folder(transfer_spec['direction'])
+          @transfer_spec_command_line['destination_root'] ||= destination_folder(transfer_spec['direction'])
         when Fasp::TransferSpec::DIRECTION_SEND
           if transfer_spec.dig('tags', Fasp::TransferSpec::TAG_RESERVED, 'node', 'access_key')
             # gen4
-            @transfer_spec_cmdline.delete('destination_root') if @transfer_spec_cmdline.key?('destination_root_id')
+            @transfer_spec_command_line.delete('destination_root') if @transfer_spec_command_line.key?('destination_root_id')
           elsif transfer_spec.key?('token')
             # gen3
             # in that case, destination is set in return by application (API/upload_setup)
             # but to_folder was used in initial API call
-            @transfer_spec_cmdline.delete('destination_root')
+            @transfer_spec_command_line.delete('destination_root')
           else
             # init default if required
-            @transfer_spec_cmdline['destination_root'] ||= destination_folder(transfer_spec['direction'])
+            @transfer_spec_command_line['destination_root'] ||= destination_folder(transfer_spec['direction'])
           end
         end
         # update command line paths, unless destination already has one
-        @transfer_spec_cmdline['paths'] = transfer_spec['paths'] || ts_source_paths
-        transfer_spec.merge!(@transfer_spec_cmdline)
-        # remove values that are nil (user wants to delete)
-        transfer_spec.delete_if { |_key, value| value.nil? }
+        @transfer_spec_command_line['paths'] = transfer_spec['paths'] || ts_source_paths
+        # updated transfer spec with command line
+        updated_ts(transfer_spec)
         # create transfer agent
         set_agent_by_options
         Log.log.debug{"transfer agent is a #{@agent.class}"}
         @agent.start_transfer(transfer_spec, token_regenerator: rest_token)
-        # list of : :success or error message
-        result = @agent.wait_for_transfers_completion
-        @progress_listener.reset
-        Fasp::AgentBase.validate_status_list(result)
+        # list of: :success or "error message string"
+        result = @agent.wait_for_completion
         send_email_transfer_notification(transfer_spec, result)
         return result
       end
 
       def send_email_transfer_notification(transfer_spec, statuses)
-        return if @opt_mgr.get_option(:notif_to).nil?
+        return if @opt_mgr.get_option(:notify_to).nil?
         global_status = self.class.session_status(statuses)
         email_vars = {
           global_transfer_status: global_status,
@@ -249,7 +242,7 @@ module Aspera
           body:                   "Transfer is: #{global_status}",
           ts:                     transfer_spec
         }
-        @config.send_email_template(email_template_default: DEFAULT_TRANSFER_NOTIF_TMPL, values: email_vars)
+        @config.send_email_template(email_template_default: DEFAULT_TRANSFER_NOTIFY_TEMPLATE, values: email_vars)
       end
 
       # shut down if agent requires it

data/lib/aspera/cli/transfer_progress.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'aspera/log'
+require 'ruby-progressbar'
+
+module Aspera
+  module Cli
+    # progress bar for transfers, supports multi-session
+    class TransferProgress
+      def initialize
+        reset
+      end
+
+      def reset
+        @progress_bar = nil
+        # key is session id
+        @sessions = {}
+        @completed = false
+        @title = ''
+      end
+
+      def total(key)
+        @sessions.values.inject(0){|m, s|m + s[key]}
+      end
+
+      def event(session_id:, type:, info: nil)
+        Log.log.debug{"progress: #{type} #{session_id} #{info}"}
+        if session_id.nil? && !type.eql?(:pre_start)
+          raise 'Internal error: session_id is nil'
+        end
+        return if @completed
+        if @progress_bar.nil?
+          @progress_bar = ProgressBar.create(
+            format:      '%t %a %B %p%% %r Mbps %E',
+            rate_scale:  lambda{|rate|rate / Environment::BYTES_PER_MEBIBIT},
+            title:       '',
+            total:       nil)
+        end
+        need_increment = true
+        case type
+        when :pre_start
+          @title = info
+        when :session_start
+          raise "Session #{session_id} already started" if @sessions[session_id]
+          @sessions[session_id] = {
+            job_size: 0, # total size of transfer (pre-calc)
+            current:  0
+          }
+          @title = ''
+        when :session_size
+          @sessions[session_id][:job_size] = info.to_i
+          current_total = total(:job_size)
+          @progress_bar.total = current_total unless current_total.eql?(@progress_bar.total) || current_total < @progress_bar.progress
+        when :transfer
+          if !@progress_bar.total.nil?
+            need_increment = false
+            @sessions[session_id][:current] = info.to_i
+            current_total = total(:current)
+            @progress_bar.progress = current_total unless @progress_bar.progress.eql?(current_total)
+          end
+        when :end
+          @title = ''
+          @completed = true
+          @progress_bar.finish
+        else
+          raise "Unknown event type #{type}"
+        end
+        new_title = @sessions.length < 2 ? @title : "[#{@sessions.length}] #{@title}"
+        @progress_bar.title = new_title unless @progress_bar.title.eql?(new_title)
+        @progress_bar.increment if need_increment && !@completed
+      end
+    end
+  end
+end

data/lib/aspera/cli/version.rb

@@ -4,6 +4,6 @@ module Aspera
   module Cli
     # for beta add extension : .beta1
     # for dev version add extension : .pre
-    VERSION = '4.13.0'
+    VERSION = '4.15.0'
   end
 end

data/lib/aspera/colors.rb

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
+# cspell:words
+
 # simple vt100 colors
 class String
   class << self
     private
 
-    def vtcmd(code); "\e[#{code}m"; end
+    def vt_cmd(code); "\e[#{code}m"; end
   end
   # see https://en.wikipedia.org/wiki/ANSI_escape_code
   # symbol is the method name added to String
   # it adds control chars to set color (and reset at the end).
-  VTSTYLES = {
+  VT_STYLES = {
     bold:          1,
+    dim:           2,
     italic:        3,
     underline:     4,
     blink:         5,
     reverse_color: 7,
+    invisible:     8,
     black:         30,
     red:           31,
     green:         32,
@@ -33,17 +37,17 @@ class String
     bg_cyan:       46,
     bg_gray:       47
   }.freeze
-  private_constant :VTSTYLES
-  # defines methods to String, one per entry in VTSTYLES
-  VTSTYLES.each do |name, code|
-    if $stderr.tty?
-      begin_seq = vtcmd(code)
+  private_constant :VT_STYLES
+  # defines methods to String, one per entry in VT_STYLES
+  VT_STYLES.each do |name, code|
+    if $stdout.tty?
+      begin_seq = vt_cmd(code)
       end_code = 0 # by default reset all
       if code <= 7 then code + 20
       elsif code <= 37 then 39
       elsif code <= 47 then 49
       end
-      end_seq = vtcmd(end_code)
+      end_seq = vt_cmd(end_code)
       define_method(name){"#{begin_seq}#{self}#{end_seq}"}
     else
       define_method(name){self}

data/lib/aspera/command_line_builder.rb

@@ -55,31 +55,34 @@ module Aspera
 
     attr_reader :params_definition
 
-    # @param param_hash
+    # @param [Hash] param_hash with parameters
+    # @param [Hash] params_definition with definition of parameters
     def initialize(param_hash, params_definition)
       @param_hash = param_hash # keep reference so that it can be modified by caller before calling `process_params`
       @params_definition = params_definition
-      @result_env = {}
-      @result_args = []
+      @result = {
+        env:  {},
+        args: []
+      }
       @used_param_names = []
     end
 
-    # adds keys :env :args with resulting values after processing
-    # warns if some parameters were not used
-    def add_env_args(env, args)
-      Log.log.debug{"ENV=#{@result_env}, ARGS=#{@result_args}"}
+    # add processed parameters to env and args, warns about unused parameters
+    # @param [Hash] env_args with :env and :args
+    def add_env_args(env_args)
+      Log.log.debug{"add_env_args: ENV=#{@result[:env]}, ARGS=#{@result[:args]}"}
       # warn about non translated arguments
       @param_hash.each_pair{|key, val|Log.log.warn{"unrecognized parameter: #{key} = \"#{val}\""} if !@used_param_names.include?(key)}
       # set result
-      env.merge!(@result_env)
-      args.push(*@result_args)
+      env_args[:env].merge!(@result[:env])
+      env_args[:args].push(*@result[:args])
       return nil
     end
 
     # add options directly to command line
     def add_command_line_options(options)
       return if options.nil?
-      options.each{|o|@result_args.push(o.to_s)}
+      options.each{|o|@result[:args].push(o.to_s)}
     end
 
     def process_params
@@ -157,7 +160,7 @@ module Aspera
         return
       when :envvar # set in env var
         raise 'error' unless options[:cli].key?(:variable)
-        @result_env[options[:cli][:variable]] = parameter_value
+        @result[:env][options[:cli][:variable]] = parameter_value
       when :opt_without_arg # if present and true : just add option without value
         add_param = false
         case parameter_value

data/lib/aspera/cos_node.rb

@@ -2,12 +2,13 @@
 
 require 'aspera/log'
 require 'aspera/rest'
+require 'aspera/oauth'
 require 'xmlsimple'
 
 module Aspera
   class CosNode < Aspera::Node
     class << self
-      def parameters_from_svc_creds(service_credentials, bucket_region)
+      def parameters_from_svc_credentials(service_credentials, bucket_region)
         # check necessary contents
         raise 'service_credentials must be a Hash' unless service_credentials.is_a?(Hash)
         %w[apikey resource_instance_id endpoints].each do |field|
@@ -85,7 +86,7 @@ module Aspera
           receiver_client_ids: 'aspera_ats'
         }})
       # get delegated token to be placed in rest call header and in transfer tags
-      @storage_credentials['token'][TOKEN_FIELD] = delegated_oauth.get_authorization.gsub(/^Bearer /, '')
+      @storage_credentials['token'][TOKEN_FIELD] = Oauth.bearer_extract(delegated_oauth.get_authorization)
       @params[:headers] = {'X-Aspera-Storage-Credentials' => JSON.generate(@storage_credentials)}
     end
   end

data/lib/aspera/environment.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+# cspell:ignore USERPROFILE HOMEDRIVE HOMEPATH LC_CTYPE msys aarch
 require 'aspera/log'
 require 'rbconfig'
 
+# cspell:words MEBI mswin bccwin
+
 module Aspera
   # detect OS, architecture, and specific stuff
   class Environment
@@ -50,7 +53,7 @@ module Aspera
           return CPU_PPC64
         when /s390/
           return CPU_S390
-        when /arm/
+        when /arm/, /aarch64/
           # arm on mac has rosetta 2
           return CPU_X86_64 if os.eql?(OS_X)
         end
@@ -69,9 +72,9 @@ module Aspera
       # on Windows, the env var %USERPROFILE% provides the path to user's home more reliably than %HOMEDRIVE%%HOMEPATH%
       # so, tell Ruby the right way
       def fix_home
-        return unless os.eql?(OS_WINDOWS) && ENV.key?('USERPROFILE') && Dir.exist?(ENV['USERPROFILE'])
-        ENV['HOME'] = ENV['USERPROFILE']
-        Log.log.debug{"Windows: set home to USERPROFILE: #{ENV['HOME']}"}
+        return unless os.eql?(OS_WINDOWS) && ENV.key?('USERPROFILE') && Dir.exist?(ENV.fetch('USERPROFILE', nil))
+        ENV['HOME'] = ENV.fetch('USERPROFILE', nil)
+        Log.log.debug{"Windows: set HOME to USERPROFILE: #{Dir.home}"}
       end
 
       def empty_binding
@@ -79,17 +82,19 @@ module Aspera
       end
 
       # secure execution of Ruby code
-      def secure_eval(code)
-        Kernel.send('lave'.reverse, code, empty_binding, __FILE__, __LINE__)
+      def secure_eval(code, file, line)
+        Kernel.send('lave'.reverse, code, empty_binding, file, line)
       end
 
       # value is provided in block
-      def write_file_restricted(path, force: false)
+      def write_file_restricted(path, force: false, mode: nil)
         raise 'coding error, missing content block' unless block_given?
         if force || !File.exist?(path)
-          File.unlink(path) rescue nil # Windows may give error
+          # Windows may give error
+          File.unlink(path) rescue nil
+          # content provided by block
           File.write(path, yield)
-          restrict_file_access(path)
+          restrict_file_access(path, mode: mode)
         end
         return path
       end
@@ -109,6 +114,16 @@ module Aspera
       rescue => e
         Log.log.warn(e.message)
       end
+
+      def terminal?
+        $stdout.tty?
+      end
+
+      # @return true if we can display Unicode characters
+      def use_unicode?
+        @use_unicode = terminal? && ENV.values_at('LC_ALL', 'LC_CTYPE', 'LANG').compact.first.include?('UTF-8') if @use_unicode.nil?
+        return @use_unicode
+      end
     end # self
   end # Environment
 end # Aspera