Class: Aspera::Cli::Plugins::Node

Inherits:
BasicAuthPlugin show all
Includes:
SyncActions
Defined in:
lib/aspera/cli/plugins/node.rb

Constant Summary collapse

CENTRAL_SOAP_API_TEST =

spellchecker: disable SOAP API call to test central API

'<?xml version="1.0" encoding="UTF-8"?>' \
'<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="urn:Aspera:XML:FASPSessionNET:2009/11:Types">' \
'<soapenv:Header></soapenv:Header>' \
'<soapenv:Body><typ:GetSessionInfoRequest><SessionFilter><SessionStatus>running</SessionStatus></SessionFilter></typ:GetSessionInfoRequest></soapenv:Body>' \
'</soapenv:Envelope>'
SEARCH_REMOVE_FIELDS =

fields removed in result of search

%w[basename permissions].freeze
COMMANDS_GEN3 =

actions in execute_command_gen3

%i[search space mkdir mklink mkfile rename delete browse upload download http_node_download sync transport]
BASE_ACTIONS = 
%i[api_details].concat(COMMANDS_GEN3).freeze
SPECIAL_ACTIONS = 
%i[health events info slash license].freeze
V3_IN_V4_ACTIONS =

actions available in v3 in gen4

%i[access_keys].concat(BASE_ACTIONS).concat(SPECIAL_ACTIONS).freeze
COMMON_ACTIONS =

actions used commonly when a node is involved

%i[access_keys].concat(BASE_ACTIONS).concat(SPECIAL_ACTIONS).freeze
NODE4_READ_ACTIONS =

used in aoc

%i[bearer_token_node node_info browse find].freeze
COMMANDS_GEN4 =

commands for execute_command_gen4

%i[mkdir rename delete upload download sync http_node_download show modify permission thumbnail v3].concat(NODE4_READ_ACTIONS).freeze
COMMANDS_COS = 
%i[upload download info access_keys api_details transfer].freeze
COMMANDS_SHARES = 
(BASE_ACTIONS - %i[search]).freeze
COMMANDS_FASPEX = 
COMMON_ACTIONS
FOLDER_TYPE =

directory: node, container: shares

%w[directory container].freeze
ACTIONS = 
%i[
async
ssync
stream
transfer
service
watch_folder
central
asperabrowser
basic_token
bearer_token
simulator].concat(COMMON_ACTIONS).freeze

Constants inherited from Aspera::Cli::Plugin

Aspera::Cli::Plugin::ALL_OPS, Aspera::Cli::Plugin::GLOBAL_OPS, Aspera::Cli::Plugin::INIT_PARAMS, Aspera::Cli::Plugin::INSTANCE_OPS, Aspera::Cli::Plugin::MAX_ITEMS, Aspera::Cli::Plugin::MAX_PAGES, Aspera::Cli::Plugin::REGEX_LOOKUP_ID_BY_FIELD

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SyncActions

#execute_sync_action, #sync_args_to_params

Methods inherited from BasicAuthPlugin

#basic_auth_api, #basic_auth_params

Methods inherited from Aspera::Cli::Plugin

declare_generic_options, #do_bulk_operation, #entity_action, #entity_command, #init_params, #instance_identifier, #query_option, #query_read_delete, #value_create_modify

Constructor Details

#initialize(api: nil, **env) ⇒ Node

Returns a new instance of Node.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/aspera/cli/plugins/node.rb', line 121

def initialize(api: nil, **env)
  super(**env, basic_options: api.nil?)
  Node.declare_options(options) if api.nil?
  return if only_manual
  @api_node =
    if !api.nil?
      # this can be Api::Node or Rest (shares)
      api
    elsif OAuth::Factory.bearer?(options.get_option(:password, mandatory: true))
      # info is provided like node_info of aoc
      Api::Node.new(
        base_url: options.get_option(:url, mandatory: true),
        headers:  Api::Node.bearer_headers(options.get_option(:password, mandatory: true))
      )
    else
      # this is normal case
      Api::Node.new(
        base_url: options.get_option(:url, mandatory: true),
        auth:     {
          type:     :basic,
          username: options.get_option(:username, mandatory: true),
          password: options.get_option(:password, mandatory: true)
        })
    end
end

Class Method Details

.application_name ⇒ Object 



25
26
27
 
# File 'lib/aspera/cli/plugins/node.rb', line 25

def application_name
  'HSTS Node API'
end

.declare_options(options) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspera/cli/plugins/node.rb', line 71

def declare_options(options)
  options.declare(:validator, 'Identifier of validator (optional for central)')
  options.declare(:asperabrowserurl, 'URL for simple aspera web ui', default: 'https://asperabrowser.mybluemix.net')
  options.declare(:sync_name, 'Sync name')
  options.declare(
    :default_ports, 'Use standard FASP ports or get from node api (gen4)', values: :bool, default: :yes,
    handler: {o: Api::Node, m: :use_standard_ports})
  options.declare(:root_id, 'File id of top folder if using bearer tokens')
  SyncActions.declare_options(options)
  options.parse_options!
end

.detect(address_or_url) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/aspera/cli/plugins/node.rb', line 29

def detect(address_or_url)
  urls = if address_or_url.match?(%r{^[a-z]{1,6}://})
    [address_or_url]
  else
    [
      "https://#{address_or_url}",
      "https://#{address_or_url}:9092",
      "http://#{address_or_url}:9091"
    ]
  end
  error = nil
  urls.each do |base_url|
    next unless base_url.match?('https?://')
    api = Rest.new(base_url: base_url)
    test_endpoint = 'ping'
    result = api.call(operation: 'GET', subpath: test_endpoint)
    next unless result[:http].body.eql?('')
    url_length = -2 - test_endpoint.length
    return {
      url:     result[:http].uri.to_s[0..url_length],
      version: 'requires authentication'
    }
  rescue StandardError => e
    error = e
    Log.log.debug{"detect error: #{e}"}
  end
  raise error if error
  return nil
end

.wizard(object:, private_key_path: nil, pub_key_pem: nil) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/aspera/cli/plugins/node.rb', line 59

def wizard(object:, private_key_path: nil, pub_key_pem: nil)
  options = object.options
  return {
    preset_value: {
      url:      options.get_option(:url, mandatory: true),
      username: options.get_option(:username, mandatory: true),
      password: options.get_option(:password, mandatory: true)
    },
    test_args:    'info'
  }
end

Instance Method Details

#apifid_from_next_arg(top_file_id) ⇒ Hash

Allows to specify a file by its path or by its id on the node

Returns:

  • (Hash) —

    api and main file id for given path or id



437
438
439
440
441
442
443
444
445
 
# File 'lib/aspera/cli/plugins/node.rb', line 437

def apifid_from_next_arg(top_file_id)
  file_path = instance_identifier(description: 'path or %id:<id>') do |attribute, value|
    raise 'Only selection "id" is supported (file id)' unless attribute.eql?('id')
    # directly return result for method
    return {api: @api_node, file_id: value}
  end
  # there was no selector, so it is a path
  return @api_node.resolve_api_fid(top_file_id, file_path)
end

#browse_gen3(prefix_path) ⇒ Object

Raises:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aspera/cli/plugins/node.rb', line 186

def browse_gen3(prefix_path)
  folders_to_process = [get_one_argument_with_prefix(prefix_path, 'path')]
  query = options.get_option(:query, default: {})
  # special parameter: max number of entries in result
  max_items = query.delete('max')
  # special parameter: recursive browsing
  recursive = query.delete('recursive')
  # special parameter: only return one entry for the path, even if folder
  only_path = query.delete('self')
  # allow user to specify a single call, and not recursive
  single_call = query.key?('skip')
  # API default is 100, so use 1000 for default
  query['count'] ||= 1000
  raise Cli::BadArgument, 'options recursive and skip cannot be used together' if recursive && single_call
  all_items = []
  until folders_to_process.empty?
    path = folders_to_process.shift
    query['path'] = path
    offset = 0
    total_count = nil
    result = nil
    loop do
      # example: send_result={'items'=>[{'file'=>"filename1","permissions"=>[{'name'=>'read'},{'name'=>'write'}]}]}
      response = @api_node.call(
        operation:   'POST',
        subpath:     'files/browse',
        headers:     {'Accept' => 'application/json'},
        body:        query,
        body_type:   :json)
      # 'file','symbolic_link'
      if only_path || !FOLDER_TYPE.include?(response[:data]['self']['type'])
        result = { type: :single_object, data: response[:data]['self']}
        break
      end
      items = response[:data]['items']
      total_count ||= response[:data]['total_count']
      all_items.concat(items)
      if single_call
        formatter.display_item_count(response[:data]['item_count'], total_count)
        break
      end
      if recursive
        folders_to_process.concat(items.select{|i|FOLDER_TYPE.include?(i['type'])}.map{|i|i['path']})
      end
      if !max_items.nil? && (all_items.count >= max_items)
        all_items = all_items.slice(0, max_items) if all_items.count > max_items
        break
      end
      break if all_items.count >= total_count
      offset += items.count
      query['skip'] = offset
      formatter.long_operation_running(all_items.count)
    end
    query.delete('skip')
  end
  result ||= {type: :object_list, data: all_items}
  return c_result_remove_prefix_path(result, 'path', prefix_path)
end

#c_result_remove_prefix_path(result, column, path_prefix) ⇒ Object

reduce the path from a result on given named column



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/aspera/cli/plugins/node.rb', line 148

def c_result_remove_prefix_path(result, column, path_prefix)
  if !path_prefix.nil?
    case result[:type]
    when :object_list
      result[:data].each do |item|
        item[column] = item[column][path_prefix.length..-1] if item[column].start_with?(path_prefix)
      end
    when :single_object
      item = result[:data]
      item[column] = item[column][path_prefix.length..-1] if item[column].start_with?(path_prefix)
    end
  end
  return result
end

#c_result_translate_rem_prefix(response, type, success_msg, path_prefix) ⇒ Object

translates paths results into CLI result, and removes prefix



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspera/cli/plugins/node.rb', line 164

def c_result_translate_rem_prefix(response, type, success_msg, path_prefix)
  errors = []
  final_result = {type: :object_list, data: [], fields: [type, 'result']}
  JSON.parse(response[:http].body)['paths'].each do |p|
    result = success_msg
    if p.key?('error')
      Log.log.error{"#{p['error']['user_message']} : #{p['path']}"}
      result = "ERROR: #{p['error']['user_message']}"
      errors.push([p['path'], p['error']['user_message']])
    end
    final_result[:data].push({type => p['path'], 'result' => result})
  end
  # one error make all fail
  unless errors.empty?
    raise errors.map{|i|"#{i.first}: #{i.last}"}.join(', ')
  end
  return c_result_remove_prefix_path(final_result, type, path_prefix)
end

#execute_action(command = nil, prefix_path = nil) ⇒ Object 



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/aspera/cli/plugins/node.rb', line 732

def execute_action(command=nil, prefix_path=nil)
  command ||= options.get_next_command(ACTIONS)
  case command
  when *COMMON_ACTIONS then return execute_simple_common(command, prefix_path)
  when :async then return execute_async # former API
  when :ssync
    # newer API
    sync_command = options.get_next_command(%i[start stop bandwidth counters files state summary].concat(Plugin::ALL_OPS) - %i[modify])
    case sync_command
    when *Plugin::ALL_OPS then return entity_command(sync_command, @api_node, 'asyncs', item_list_key: 'ids'){|field, value|ssync_lookup(field, value)}
    else
      asyncs_id = instance_identifier {|field, value|ssync_lookup(field, value)}
      if %i[start stop].include?(sync_command)
        @api_node.call(
          operation: 'POST',
          subpath:   "asyncs/#{asyncs_id}/#{sync_command}",
          body:      '',
          body_type: :text)[:http].body
        return Main.result_status('Done')
      end
      parameters = nil
      parameters = query_option(default: {}) if %i[bandwidth counters files].include?(sync_command)
      return { type: :single_object, data: @api_node.read("asyncs/#{asyncs_id}/#{sync_command}", parameters)[:data] }
    end
  when :stream
    command = options.get_next_command(%i[list create show modify cancel])
    case command
    when :list
      resp = @api_node.read('ops/transfers', query_read_delete)
      return { type: :object_list, data: resp[:data], fields: %w[id status] } # TODO: useful?
    when :create
      resp = @api_node.create('streams', value_create_modify(command: command))
      return { type: :single_object, data: resp[:data] }
    when :show
      resp = @api_node.read("ops/transfers/#{options.get_next_argument('transfer id')}")
      return { type: :other_struct, data: resp[:data] }
    when :modify
      resp = @api_node.update("streams/#{options.get_next_argument('transfer id')}", value_create_modify(command: command))
      return { type: :other_struct, data: resp[:data] }
    when :cancel
      resp = @api_node.cancel("streams/#{options.get_next_argument('transfer id')}")
      return { type: :other_struct, data: resp[:data] }
    else
      raise 'error'
    end
  when :transfer
    command = options.get_next_command(%i[list cancel show modify bandwidth_average sessions])
    res_class_path = 'ops/transfers'
    if %i[cancel show modify].include?(command)
      one_res_id = instance_identifier
      one_res_path = "#{res_class_path}/#{one_res_id}"
    end
    case command
    when :list
      transfers_data = @api_node.read(res_class_path, query_read_delete)[:data]
      return {
        type:   :object_list,
        data:   transfers_data,
        fields: %w[id status start_spec.direction start_spec.remote_user start_spec.remote_host start_spec.destination_path]
      }
    when :sessions
      transfers_data = @api_node.read(res_class_path, query_read_delete)[:data]
      sessions = transfers_data.map{|t|t['sessions']}.flatten
      sessions.each do |session|
        session['start_time'] = Time.at(session['start_time_usec'] / 1_000_000.0).utc.iso8601(0)
        session['end_time'] = Time.at(session['end_time_usec'] / 1_000_000.0).utc.iso8601(0)
      end
      return {
        type:   :object_list,
        data:   sessions,
        fields: %w[id status start_time end_time target_rate_kbps]
      }
    when :cancel
      resp = @api_node.cancel(one_res_path)
      return { type: :other_struct, data: resp[:data] }
    when :show
      resp = @api_node.read(one_res_path)
      return { type: :other_struct, data: resp[:data] }
    when :modify
      resp = @api_node.update(one_res_path, options.get_next_argument('update value', validation: Hash))
      return { type: :other_struct, data: resp[:data] }
    when :bandwidth_average
      transfers_data = @api_node.read(res_class_path, query_read_delete)[:data]
      # collect all key dates
      bandwidth_period = {}
      dir_info = %i[avg_kbps sessions].freeze
      transfers_data.each do |transfer|
        session = transfer
        # transfer['sessions'].each do |session|
        next if session['avg_rate_kbps'].zero?
        bandwidth_period[session['start_time_usec']] = 0
        bandwidth_period[session['end_time_usec']] = 0
        # end
      end
      result = []
      # all dates sorted numerically
      all_dates = bandwidth_period.keys.sort
      all_dates.each_with_index do |start_date, index|
        end_date = all_dates[index + 1]
        # do not process last one
        break if end_date.nil?
        # init data for this period
        period_bandwidth = Transfer::Spec::DIRECTION_ENUM_VALUES.map(&:to_sym).each_with_object({}) do |direction, h|
          h[direction] = dir_info.each_with_object({}) do |k2, h2|
            h2[k2] = 0
          end
        end
        # find all transfers that were active at this time
        transfers_data.each do |transfer|
          session = transfer
          # transfer['sessions'].each do |session|
          # skip if not information for this period
          next if session['avg_rate_kbps'].zero?
          # skip if not in this period
          next if session['start_time_usec'] >= end_date || session['end_time_usec'] <= start_date
          info = period_bandwidth[transfer['start_spec']['direction'].to_sym]
          info[:avg_kbps] += session['avg_rate_kbps']
          info[:sessions] += 1
          # end
        end
        next if Transfer::Spec::DIRECTION_ENUM_VALUES.map(&:to_sym).all? do |dir|
          period_bandwidth[dir][:sessions].zero?
        end
        result.push({start: Time.at(start_date / 1_000_000), end: Time.at(end_date / 1_000_000)}.merge(period_bandwidth))
      end
      return { type: :object_list, data: result }
    else
      raise 'error'
    end
  when :service
    command = options.get_next_command(%i[list create delete])
    if [:delete].include?(command)
      service_id = instance_identifier
    end
    case command
    when :list
      resp = @api_node.read('rund/services')
      return { type: :object_list, data: resp[:data]['services'] }
    when :create
      # @json:'{"type":"WATCHFOLDERD","run_as":{"user":"user1"}}'
      params = options.get_next_argument('creation data', validation: Hash)
      resp = @api_node.create('rund/services', params)
      return Main.result_status("#{resp[:data]['id']} created")
    when :delete
      @api_node.delete("rund/services/#{service_id}")
      return Main.result_status("#{service_id} deleted")
    end
  when :watch_folder
    res_class_path = 'v3/watchfolders'
    command = options.get_next_command(%i[create list show modify delete state])
    if %i[show modify delete state].include?(command)
      one_res_id = instance_identifier
      one_res_path = "#{res_class_path}/#{one_res_id}"
    end
    # hum, to avoid: Unable to convert 2016_09_14 configuration
    @api_node.params[:headers] ||= {}
    @api_node.params[:headers]['X-aspera-WF-version'] = '2017_10_23'
    case command
    when :create
      resp = @api_node.create(res_class_path, value_create_modify(command: command))
      return Main.result_status("#{resp[:data]['id']} created")
    when :list
      resp = @api_node.read(res_class_path, query_read_delete)
      return { type: :value_list, data: resp[:data]['ids'], name: 'id' }
    when :show
      return { type: :single_object, data: @api_node.read(one_res_path)[:data]}
    when :modify
      @api_node.update(one_res_path, query_option(mandatory: true))
      return Main.result_status("#{one_res_id} updated")
    when :delete
      @api_node.delete(one_res_path)
      return Main.result_status("#{one_res_id} deleted")
    when :state
      return { type: :single_object, data: @api_node.read("#{one_res_path}/state")[:data] }
    end
  when :central
    command = options.get_next_command(%i[session file])
    validator_id = options.get_option(:validator)
    validation = {'validator_id' => validator_id} unless validator_id.nil?
    request_data = query_option(default: {})
    case command
    when :session
      command = options.get_next_command([:list])
      case command
      when :list
        request_data.deep_merge!({'validation' => validation}) unless validation.nil?
        resp = @api_node.create('services/rest/transfers/v1/sessions', request_data)
        return {
          type:   :object_list,
          data:   resp[:data]['session_info_result']['session_info'],
          fields: %w[session_uuid status transport direction bytes_transferred]
        }
      end
    when :file
      command = options.get_next_command(%i[list modify])
      case command
      when :list
        request_data.deep_merge!({'validation' => validation}) unless validation.nil?
        resp = @api_node.create('services/rest/transfers/v1/files', request_data)[:data]
        resp = JSON.parse(resp) if resp.is_a?(String)
        Log.log.debug{Log.dump(:resp, resp)}
        return { type: :object_list, data: resp['file_transfer_info_result']['file_transfer_info'], fields: %w[session_uuid file_id status path]}
      when :modify
        request_data.deep_merge!(validation) unless validation.nil?
        @api_node.update('services/rest/transfers/v1/files', request_data)
        return Main.result_status('updated')
      end
    end
  when :asperabrowser
    browse_params = {
      'nodeUser' => options.get_option(:username, mandatory: true),
      'nodePW'   => options.get_option(:password, mandatory: true),
      'nodeURL'  => options.get_option(:url, mandatory: true)
    }
    # encode parameters so that it looks good in url
    encoded_params = Base64.strict_encode64(Zlib::Deflate.deflate(JSON.generate(browse_params))).gsub(/=+$/, '').tr('+/', '-_').reverse
    Environment.instance.open_uri("#{options.get_option(:asperabrowserurl)}?goto=#{encoded_params}")
    return Main.result_status('done')
  when :basic_token
    return Main.result_status(Rest.basic_token(options.get_option(:username, mandatory: true), options.get_option(:password, mandatory: true)))
  when :bearer_token
    private_key = OpenSSL::PKey::RSA.new(options.get_next_argument('private RSA key PEM value', validation: String))
    token_info = options.get_next_argument('user and group identification', validation: Hash)
    access_key = options.get_option(:username, mandatory: true)
    return Main.result_status(Api::Node.bearer_token(payload: token_info, access_key: access_key, private_key: private_key))
  when :simulator
    require 'aspera/node_simulator'
    parameters = value_create_modify(command: command)
    parameters = parameters.symbolize_keys
    raise 'Missing key: url' unless parameters.key?(:url)
    uri = URI.parse(parameters[:url])
    server = WebServerSimple.new(uri, certificate: parameters[:certificate])
    server.mount(uri.path, NodeSimulatorServlet, parameters[:credentials], transfer)
    server.start
    return Main.result_status('Simulator terminated')
  end
  raise 'ERROR: shall not reach this line'
end

#execute_async ⇒ Object

This is older API



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/aspera/cli/plugins/node.rb', line 628

def execute_async
  command = options.get_next_command(%i[list delete files show counters bandwidth])
  unless command.eql?(:list)
    async_name = options.get_option(:sync_name)
    if async_name.nil?
      async_id = instance_identifier
      if async_id.eql?(SpecialValues::ALL) && %i[show delete].include?(command)
        async_ids = @api_node.read('async/list')[:data]['sync_ids']
      else
        Integer(async_id) # must be integer
        async_ids = [async_id]
      end
    else
      async_ids = @api_node.read('async/list')[:data]['sync_ids']
      summaries = @api_node.create('async/summary', {'syncs' => async_ids})[:data]['sync_summaries']
      selected = summaries.find{|s|s['name'].eql?(async_name)}
      raise "no such sync: #{async_name}" if selected.nil?
      async_id = selected['snid']
      async_ids = [async_id]
    end
    post_data = {'syncs' => async_ids}
  end
  case command
  when :list
    resp = @api_node.read('async/list')[:data]['sync_ids']
    return { type: :value_list, data: resp, name: 'id' }
  when :show
    resp = @api_node.create('async/summary', post_data)[:data]['sync_summaries']
    return Main.result_empty if resp.empty?
    return { type: :object_list, data: resp, fields: %w[snid name local_dir remote_dir] } if async_id.eql?(SpecialValues::ALL)
    return { type: :single_object, data: resp.first }
  when :delete
    resp = @api_node.create('async/delete', post_data)[:data]
    return { type: :single_object, data: resp, name: 'id' }
  when :bandwidth
    post_data['seconds'] = 100 # TODO: as parameter with --value
    resp = @api_node.create('async/bandwidth', post_data)[:data]
    data = resp['bandwidth_data']
    return Main.result_empty if data.empty?
    data = data.first[async_id]['data']
    return { type: :object_list, data: data, name: 'id' }
  when :files
    # count int
    # filename str
    # skip int
    # status int
    filter = query_option
    post_data.merge!(filter) unless filter.nil?
    resp = @api_node.create('async/files', post_data)[:data]
    data = resp['sync_files']
    data = data.first[async_id] unless data.empty?
    iteration_data = []
    skip_ids_persistency = nil
    if options.get_option(:once_only, mandatory: true)
      skip_ids_persistency = PersistencyActionOnce.new(
        manager: persistency,
        data:    iteration_data,
        id:      IdGenerator.from_list([
          'sync_files',
          options.get_option(:url, mandatory: true),
          options.get_option(:username, mandatory: true),
          async_id]))
      unless iteration_data.first.nil?
        data.select!{|l| l['fnid'].to_i > iteration_data.first}
      end
      iteration_data[0] = data.last['fnid'].to_i unless data.empty?
    end
    return Main.result_empty if data.empty?
    skip_ids_persistency&.save
    return { type: :object_list, data: data, name: 'id' }
  when :counters
    resp = @api_node.create('async/counters', post_data)[:data]['sync_counters'].first[async_id].last
    return Main.result_empty if resp.nil?
    return { type: :single_object, data: resp }
  end
end

#execute_command_gen3(command, prefix_path) ⇒ Object

file and folder related commands



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/aspera/cli/plugins/node.rb', line 246

def execute_command_gen3(command, prefix_path)
  case command
  when :delete
    # TODO: add query for recursive
    paths_to_delete = get_all_arguments_with_prefix(prefix_path, 'file list')
    resp = @api_node.create('files/delete', { paths: paths_to_delete.map{|i| {'path' => i.start_with?('/') ? i : "/#{i}"} }})
    return c_result_translate_rem_prefix(resp, 'file', 'deleted', prefix_path)
  when :search
    search_root = get_one_argument_with_prefix(prefix_path, 'search root')
    parameters = {'path' => search_root}
    other_options = query_option
    parameters.merge!(other_options) unless other_options.nil?
    resp = @api_node.create('files/search', parameters)
    result = { type: :object_list, data: resp[:data]['items']}
    return Main.result_empty if result[:data].empty?
    result[:fields] = result[:data].first.keys.reject{|i|SEARCH_REMOVE_FIELDS.include?(i)}
    formatter.display_item_count(resp[:data]['item_count'], resp[:data]['total_count'])
    formatter.display_status("params: #{resp[:data]['parameters'].keys.map{|k|"#{k}:#{resp[:data]['parameters'][k]}"}.join(',')}")
    return c_result_remove_prefix_path(result, 'path', prefix_path)
  when :space
    path_list = get_all_arguments_with_prefix(prefix_path, 'folder path or ext.val. list')
    resp = @api_node.create('space', { 'paths' => path_list.map {|i| { path: i} } })
    result = { type: :object_list, data: resp[:data]['paths']}
    # return c_result_translate_rem_prefix(resp,'folder','created',prefix_path)
    return c_result_remove_prefix_path(result, 'path', prefix_path)
  when :mkdir
    path_list = get_all_arguments_with_prefix(prefix_path, 'folder path or ext.val. list')
    resp = @api_node.create('files/create', { 'paths' => path_list.map{|i|{ type: :directory, path: i }}})
    return c_result_translate_rem_prefix(resp, 'folder', 'created', prefix_path)
  when :mklink
    target = get_one_argument_with_prefix(prefix_path, 'target')
    one_path = get_one_argument_with_prefix(prefix_path, 'link path')
    resp = @api_node.create('files/create', { 'paths' => [{ type: :symbolic_link, path: one_path, target: { path: target} }] })
    return c_result_translate_rem_prefix(resp, 'folder', 'created', prefix_path)
  when :mkfile
    one_path = get_one_argument_with_prefix(prefix_path, 'file path')
    contents64 = Base64.strict_encode64(options.get_next_argument('contents'))
    resp = @api_node.create('files/create', { 'paths' => [{ type: :file, path: one_path, contents: contents64 }] })
    return c_result_translate_rem_prefix(resp, 'folder', 'created', prefix_path)
  when :rename
    # TODO: multiple ?
    path_base = get_one_argument_with_prefix(prefix_path, 'path_base')
    path_src = get_one_argument_with_prefix(prefix_path, 'path_src')
    path_dst = get_one_argument_with_prefix(prefix_path, 'path_dst')
    resp = @api_node.create('files/rename', { 'paths' => [{ 'path' => path_base, 'source' => path_src, 'destination' => path_dst }] })
    return c_result_translate_rem_prefix(resp, 'entry', 'moved', prefix_path)
  when :browse
    return browse_gen3(prefix_path)
  when :sync
    return execute_sync_action do |sync_direction, local_path, remote_path|
      # Gen3 API
      # empty transfer spec for authorization request
      request_transfer_spec = {
        type:  case sync_direction
               when :push then :sync_upload
               when :pull then :sync_download
               when :bidi then :sync
               end,
        paths: [{
          source:      remote_path,
          destination: local_path
        }]
      }
      # add fixed parameters if any (for COS)
      @api_node.add_tspec_info(request_transfer_spec) if @api_node.respond_to?(:add_tspec_info)
      # prepare payload for single request
      setup_payload = {transfer_requests: [{transfer_request: request_transfer_spec}]}
      # only one request, so only one answer
      transfer_spec = @api_node.create('files/sync_setup', setup_payload)[:data]['transfer_specs'].first['transfer_spec']
      # API returns null tag... but async does not like it
      transfer_spec.delete_if{ |_k, v| v.nil? }
      # delete this part, as the returned value contains only destination, and not sources
      # transfer_spec.delete('paths') if command.eql?(:upload)
      Log.log.debug{Log.dump(:ts, transfer_spec)}
      transfer_spec
    end
  when :upload, :download
    # empty transfer spec for authorization request
    request_transfer_spec = {}
    # set requested paths depending on direction
    request_transfer_spec[:paths] = if command.eql?(:download)
      transfer.ts_source_paths
    else
      [{ destination: transfer.destination_folder(Transfer::Spec::DIRECTION_SEND) }]
    end
    # add fixed parameters if any (for COS)
    @api_node.add_tspec_info(request_transfer_spec) if @api_node.respond_to?(:add_tspec_info)
    # prepare payload for single request
    setup_payload = {transfer_requests: [{transfer_request: request_transfer_spec}]}
    # only one request, so only one answer
    transfer_spec = @api_node.create("files/#{command}_setup", setup_payload)[:data]['transfer_specs'].first['transfer_spec']
    # delete this part, as the returned value contains only destination, and not sources
    transfer_spec.delete('paths') if command.eql?(:upload)
    return Main.result_transfer(transfer.start(transfer_spec))
  when :http_node_download
    remote_path = get_one_argument_with_prefix(prefix_path, 'remote path')
    file_name = File.basename(remote_path)
    @api_node.call(
      operation: 'GET',
      subpath: "files/#{URI.encode_www_form_component(remote_path)}/contents",
      save_to_file: File.join(transfer.destination_folder(Transfer::Spec::DIRECTION_RECEIVE), file_name))
    return Main.result_status("downloaded: #{file_name}")
  when :transport
    return {type: :single_object, data: @api_node.transport_params}
  end
  Aspera.error_unreachable_line
end

#execute_command_gen4(command_repo, top_file_id) ⇒ Object 



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/aspera/cli/plugins/node.rb', line 447

def execute_command_gen4(command_repo, top_file_id)
  case command_repo
  when :v3
    # NOTE: other common actions are unauthorized with user scope
    command_legacy = options.get_next_command(V3_IN_V4_ACTIONS)
    # TODO: shall we support all methods here ? what if there is a link ?
    apifid = @api_node.resolve_api_fid(top_file_id, '')
    return Node.new(**init_params, api: apifid[:api]).execute_action(command_legacy)
  when :node_info, :bearer_token_node
    apifid = @api_node.resolve_api_fid(top_file_id, options.get_next_argument('path'))
    result = {
      url:     apifid[:api].base_url,
      root_id: apifid[:file_id]
    }
    Aspera.assert_values(apifid[:api].auth_params[:type], %i[basic oauth2])
    case apifid[:api].auth_params[:type]
    when :basic
      result[:username] = apifid[:api].auth_params[:username]
      result[:password] = apifid[:api].auth_params[:password]
    when :oauth2
      result[:username] = apifid[:api].params[:headers][Api::Node::HEADER_X_ASPERA_ACCESS_KEY]
      result[:password] = apifid[:api].oauth.token
    else Aspera.error_unreachable_line
    end
    return {type: :single_object, data: result} if command_repo.eql?(:node_info)
    # check format of bearer token
    OAuth::Factory.bearer_extract(result[:password])
    return Main.result_status(result[:password])
  when :browse
    apifid = @api_node.resolve_api_fid(top_file_id, options.get_next_argument('path'))
    file_info = apifid[:api].read("files/#{apifid[:file_id]}")[:data]
    if file_info['type'].eql?('folder')
      result = apifid[:api].read("files/#{apifid[:file_id]}/files", query_read_delete)
      items = result[:data]
      formatter.display_item_count(result[:data].length, result[:http]['X-Total-Count'])
    else
      items = [file_info]
    end
    return {type: :object_list, data: items, fields: %w[name type recursive_size size modified_time access_level]}
  when :find
    apifid = @api_node.resolve_api_fid(top_file_id, options.get_next_argument('path'))
    test_block = Api::Node.file_matcher_from_argument(options)
    return {type: :object_list, data: @api_node.find_files(apifid[:file_id], test_block), fields: ['path']}
  when :mkdir
    containing_folder_path = options.get_next_argument('path').split(Api::Node::PATH_SEPARATOR)
    new_folder = containing_folder_path.pop
    apifid = @api_node.resolve_api_fid(top_file_id, containing_folder_path.join(Api::Node::PATH_SEPARATOR))
    result = apifid[:api].create("files/#{apifid[:file_id]}/files", {name: new_folder, type: :folder})[:data]
    return Main.result_status("created: #{result['name']} (id=#{result['id']})")
  when :rename
    file_path = options.get_next_argument('source path')
    apifid = @api_node.resolve_api_fid(top_file_id, file_path)
    newname = options.get_next_argument('new name')
    result = apifid[:api].update("files/#{apifid[:file_id]}", {name: newname})[:data]
    return Main.result_status("renamed to #{newname}")
  when :delete
    return do_bulk_operation(command: command_repo, descr: 'path', values: String, id_result: 'path') do |l_path|
      apifid = @api_node.resolve_api_fid(top_file_id, l_path)
      result = apifid[:api].delete("files/#{apifid[:file_id]}")[:data]
      {'path' => l_path}
    end
  when :sync
    return execute_sync_action do |sync_direction, _local_path, remote_path|
      # Gen4 API
      # direction is push pull, bidi
      Aspera.assert_values(sync_direction, %i[push pull bidi])
      ts_direction = case sync_direction
      when :push, :bidi then Transfer::Spec::DIRECTION_SEND
      when :pull then Transfer::Spec::DIRECTION_RECEIVE
      else Aspera.error_unreachable_line
      end
      # remote is specified by option to_folder
      apifid = @api_node.resolve_api_fid(top_file_id, remote_path)
      transfer_spec = apifid[:api].transfer_spec_gen4(apifid[:file_id], ts_direction)
      Log.log.debug{Log.dump(:ts, transfer_spec)}
      transfer_spec
    end
  when :upload
    apifid = @api_node.resolve_api_fid(top_file_id, transfer.destination_folder(Transfer::Spec::DIRECTION_SEND))
    return Main.result_transfer(transfer.start(apifid[:api].transfer_spec_gen4(apifid[:file_id], Transfer::Spec::DIRECTION_SEND)))
  when :download
    source_paths = transfer.ts_source_paths
    # special case for AoC : all files must be in same folder
    source_folder = source_paths.shift['source']
    # if a single file: split into folder and path
    apifid = @api_node.resolve_api_fid(top_file_id, source_folder)
    if source_paths.empty?
      # get precise info in this element
      file_info = apifid[:api].read("files/#{apifid[:file_id]}")[:data]
      case file_info['type']
      when 'file'
        # if the single source is a file, we need to split into folder path and filename
        src_dir_elements = source_folder.split(Api::Node::PATH_SEPARATOR)
        # filename is the last one, source folder is what remains
        source_paths = [{'source' => src_dir_elements.pop}]
        # add trailing / so that link is resolved, if it's a shared folder
        src_dir_elements.push('')
        source_folder = src_dir_elements.join(Api::Node::PATH_SEPARATOR)
        apifid = @api_node.resolve_api_fid(top_file_id, source_folder)
      when 'link', 'folder'
        # single source is 'folder' or 'link'
        # TODO: add this ? , 'destination'=>file_info['name']
        source_paths = [{'source' => '.'}]
      else
        raise "Unknown source type: #{file_info['type']}"
      end
    end
    return Main.result_transfer(transfer.start(apifid[:api].transfer_spec_gen4(apifid[:file_id], Transfer::Spec::DIRECTION_RECEIVE, {'paths'=>source_paths})))
  when :http_node_download
    source_paths = transfer.ts_source_paths
    source_folder = source_paths.shift['source']
    if source_paths.empty?
      source_folder = source_folder.split(Api::Node::PATH_SEPARATOR)
      source_paths = [{'source' => source_folder.pop}]
      source_folder = source_folder.join(Api::Node::PATH_SEPARATOR)
    end
    raise Cli::BadArgument, 'one file at a time only in HTTP mode' if source_paths.length > 1
    file_name = source_paths.first['source']
    apifid = @api_node.resolve_api_fid(top_file_id, File.join(source_folder, file_name))
    apifid[:api].call(
      operation: 'GET',
      subpath: "files/#{apifid[:file_id]}/content",
      save_to_file: File.join(transfer.destination_folder(Transfer::Spec::DIRECTION_RECEIVE), file_name))
    return Main.result_status("downloaded: #{file_name}")
  when :show
    apifid = apifid_from_next_arg(top_file_id)
    items = apifid[:api].read("files/#{apifid[:file_id]}")[:data]
    return {type: :single_object, data: items}
  when :modify
    apifid = apifid_from_next_arg(top_file_id)
    update_param = options.get_next_argument('update data', validation: Hash)
    apifid[:api].update("files/#{apifid[:file_id]}", update_param)[:data]
    return Main.result_status('Done')
  when :thumbnail
    apifid = apifid_from_next_arg(top_file_id)
    result = apifid[:api].call(
      operation: 'GET',
      subpath: "files/#{apifid[:file_id]}/preview",
      headers: {'Accept' => 'image/png'}
    )
    return Main.result_image(result[:http].body, formatter: formatter)
  when :permission
    apifid = apifid_from_next_arg(top_file_id)
    command_perm = options.get_next_command(%i[list create delete])
    case command_perm
    when :list
      # generic options : TODO: as arg ? query_read_delete
      list_options ||= {'include' => Rest.array_params(%w[access_level permission_count])}
      # add which one to get
      list_options['file_id'] = apifid[:file_id]
      list_options['inherited'] ||= false
      items = apifid[:api].read('permissions', list_options)[:data]
      return {type: :object_list, data: items}
    when :delete
      return do_bulk_operation(command: command_perm, descr: 'identifier', values: :identifier) do |one_id|
        apifid[:api].delete("permissions/#{one_id}")
        # notify application of deletion
        the_app[:api].permissions_send_event(created_data: created_data, app_info: the_app, types: ['permission.deleted']) unless the_app.nil?
        {'id' => one_id}
      end
    when :create
      create_param = options.get_next_argument('creation data', validation: Hash)
      raise 'no file_id' if create_param.key?('file_id')
      create_param['file_id'] = apifid[:file_id]
      create_param['access_levels'] = Api::Node::ACCESS_LEVELS unless create_param.key?('access_levels')
      # add application specific tags (AoC)
      the_app = apifid[:api].app_info
      the_app[:api].permissions_set_create_params(create_param: create_param, app_info: the_app) unless the_app.nil?
      # create permission
      created_data = apifid[:api].create('permissions', create_param)[:data]
      # notify application of creation
      the_app[:api].permissions_send_event(created_data: created_data, app_info: the_app) unless the_app.nil?
      return { type: :single_object, data: created_data}
    else Aspera.error_unreachable_line
    end
  else Aspera.error_unreachable_line
  end
  Aspera.error_unreachable_line
end

#execute_simple_common(command, prefix_path) ⇒ Object

common API to node and Shares prefix_path is used to list remote sources in Faspex



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/aspera/cli/plugins/node.rb', line 356

def execute_simple_common(command, prefix_path)
  case command
  when *COMMANDS_GEN3
    execute_command_gen3(command, prefix_path)
  when :access_keys
    ak_command = options.get_next_command(%i[do set_bearer_key].concat(Plugin::ALL_OPS))
    case ak_command
    when *Plugin::ALL_OPS
      return entity_command(ak_command, @api_node, 'access_keys') do |field, value|
               raise 'only selector: %id:self' unless field.eql?('id') && value.eql?('self')
               @api_node.read('access_keys/self')[:data]['id']
             end
    when :do
      access_key_id = options.get_next_argument('access key id')
      root_file_id = options.get_option(:root_id)
      if root_file_id.nil?
        ak_info = @api_node.read("access_keys/#{access_key_id}")[:data]
        # change API credentials if different access key
        if !access_key_id.eql?('self')
          @api_node.auth_params[:username] = ak_info['id']
          @api_node.auth_params[:password] = config.lookup_secret(url: @api_node.base_url, username: ak_info['id'], mandatory: true)
        end
        root_file_id = ak_info['root_file_id']
      end
      command_repo = options.get_next_command(COMMANDS_GEN4)
      return execute_command_gen4(command_repo, root_file_id)
    when :set_bearer_key
      access_key_id = options.get_next_argument('access key id')
      access_key_id = @api_node.read('access_keys/self')[:data]['id'] if access_key_id.eql?('self')
      bearer_key_pem = options.get_next_argument('public or private RSA key PEM value', validation: String)
      key = OpenSSL::PKey.read(bearer_key_pem)
      key = key.public_key if key.private?
      bearer_key_pem = key.to_pem
      @api_node.update("access_keys/#{access_key_id}", {token_verification_key: bearer_key_pem})
      return Main.result_status('public key updated')
    end
  when :health
    nagios = Nagios.new
    begin
      info = @api_node.read('info')[:data]
      nagios.add_ok('node api', 'accessible')
      nagios.check_time_offset(info['current_time'], 'node api')
      nagios.check_product_version('node api', 'entsrv', info['version'])
    rescue StandardError => e
      nagios.add_critical('node api', e.to_s)
    end
    begin
      @api_node.call(
        operation: 'POST',
        subpath:   'services/soap/Transfer-201210',
        headers:   {'Content-Type' => 'text/xml;charset=UTF-8', 'SOAPAction' => 'FASPSessionNET-200911#GetSessionInfo'},
        body:      CENTRAL_SOAP_API_TEST,
        body_type: :text)[:http].body
      nagios.add_ok('central', 'accessible by node')
    rescue StandardError => e
      nagios.add_critical('central', e.to_s)
    end
    return nagios.result
  when :events
    events = @api_node.read('events', query_read_delete)[:data]
    return { type: :object_list, data: events, fields: ->(f){!f.start_with?('data')} }
  when :info
    nd_info = @api_node.read('info')[:data]
    return { type: :single_object, data: nd_info}
  when :slash
    nd_info = @api_node.read('')[:data]
    return { type: :single_object, data: nd_info}
  when :license
    # requires: asnodeadmin -mu <node user> --acl-add=internal --internal
    node_license = @api_node.read('license')[:data]
    if node_license['failure'].is_a?(String) && node_license['failure'].include?('ACL')
      Log.log.error('server must have: asnodeadmin -mu <node user> --acl-add=internal --internal')
    end
    return {type: :single_object, data: node_license}
  when :api_details
    return {type: :single_object, data: {base_url: @api_node.base_url}.merge(@api_node.params)}
  end
end

#ssync_lookup(field, value) ⇒ Integer

Returns id of the sync.

Parameters:

  • field (String) —

    name of the field to search

  • value (String) —

    value of the field to search

Returns:

  • (Integer) —

    id of the sync

Raises:



709
710
711
712
713
714
715
716
717
 
# File 'lib/aspera/cli/plugins/node.rb', line 709

def ssync_lookup(field, value)
  raise Cli::BadArgument, "Only search by name is supported (#{field})" unless field.eql?('name')
  @api_node.read('asyncs')[:data]['ids'].each do |id|
    sync_info = @api_node.read("asyncs/#{id}")[:data]['configuration']
    # name is unique, so we can return
    return id if sync_info[field].eql?(value)
  end
  raise Cli::BadArgument, "no such sync: #{field}=#{value}"
end