Class: Aspera::Fasp::Local

Inherits:
Manager
  • Object
show all
Defined in:
lib/aspera/fasp/local.rb

Overview

executes a local “ascp”, connects mgt port, equivalent of “Fasp Manager”

Constant Summary

Constants inherited from Manager

Manager::LISTENER_SESSION_ID_B, Manager::LISTENER_SESSION_ID_S

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Manager

#add_listener, validate_status_list

Instance Attribute Details

#quiet ⇒ Object

set to false to keep ascp progress bar display (basically: removes ascp’s option -q)



27
28
29
 
# File 'lib/aspera/fasp/local.rb', line 27

def quiet
  @quiet
end

Instance Method Details

#send_command(job_id, session_index, data) ⇒ Object

send command of management port to ascp session ‘type’=>‘START’,‘source’=><em>path</em>,‘destination’=><em>path</em> ‘type’=>‘DONE’



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/aspera/fasp/local.rb', line 277

def send_command(job_id,session_index,data)
  job=@jobs[job_id]
  raise "no such job" if job.nil?
  session=job[:sessions][session_index]
  raise "no such session" if session.nil?
  Log.log.debug("command: #{data}")
  # build command
  command=data.
  keys.
  map{|k|"#{k.capitalize}: #{data[k]}"}.
  unshift('FASPMGR 2').
  push('','').
  join("\n")
  session[:io].puts(command)
end

#shutdown ⇒ Object

used by asession (to be removed ?)



148
149
150
 
# File 'lib/aspera/fasp/local.rb', line 148

def shutdown
  Log.log.debug("fasp local shutdown")
end

#start_transfer(transfer_spec, options = {}) ⇒ Object

start ascp transfer (non blocking), single or multi-session job information added to @jobs



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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aspera/fasp/local.rb', line 32

def start_transfer(transfer_spec,options={})
  raise "option: must be hash (or nil)" unless options.is_a?(Hash)
  job_options = options.clone
  job_options[:resumer] ||= @resume_policy
  job_options[:job_id] ||= SecureRandom.uuid
  # clone transfer spec because we modify it (first level keys)
  transfer_spec=transfer_spec.clone
  # if there is aspera tags
  if transfer_spec['tags'].is_a?(Hash) and transfer_spec['tags']['aspera'].is_a?(Hash)
    # TODO: what is this for ? only on local ascp ?
    # NOTE: important: transfer id must be unique: generate random id
    # using a non unique id results in discard of tags in AoC, and a package is never finalized
    transfer_spec['tags']['aspera']['xfer_id']||=SecureRandom.uuid
    Log.log.debug("xfer id=#{transfer_spec['xfer_id']}")
    # TODO: useful ? node only ?
    transfer_spec['tags']['aspera']['xfer_retry']||=3600
  end
  Log.dump('ts',transfer_spec)

  # add bypass keys when authentication is token and no auth is provided
  if transfer_spec.has_key?('token') and
  !transfer_spec.has_key?('remote_password') and
  !transfer_spec.has_key?('EX_ssh_key_paths')
    # transfer_spec['remote_password'] = Installation.instance.bypass_pass # not used
    transfer_spec['EX_ssh_key_paths'] = Installation.instance.bypass_keys
  end

  # TODO: check if changing fasp(UDP) port is really necessary, not clear from doc
  # compute this before using transfer spec, even if the var is not used in single session
  multi_session_udp_port_base=33001
  multi_session_number=nil
  if transfer_spec.has_key?('multi_session')
    multi_session_number=transfer_spec['multi_session'].to_i
    raise "multi_session(#{transfer_spec['multi_session']}) shall be integer > 1" unless multi_session_number >= 1
    # managed here, so delete from transfer spec
    transfer_spec.delete('multi_session')
    if transfer_spec.has_key?('fasp_port')
      multi_session_udp_port_base=transfer_spec['fasp_port']
      transfer_spec.delete('fasp_port')
    end
  end

  # compute known args
  env_args=Parameters.ts_to_env_args(transfer_spec,wss: @enable_wss)

  # add fallback cert and key as arguments if needed
  if ['1','force'].include?(transfer_spec['http_fallback'])
    env_args[:args].unshift('-Y',Installation.instance.path(:fallback_key))
    env_args[:args].unshift('-I',Installation.instance.path(:fallback_cert))
  end

  env_args[:args].unshift('-q') if @quiet

  # transfer job can be multi session
  xfer_job={
    :id            => job_options[:job_id],
    :sessions      => [] # all sessions as below
  }

  # generic session information
  session={
    :thread   => nil,         # Thread object monitoring management port, not nil when pushed to :sessions
    :error    => nil,         # exception if failed
    :io       => nil,         # management port server socket
    :id       => nil,         # SessionId from INIT message in mgt port
    :env_args => env_args,    # env vars and args to ascp (from transfer spec)
    :options  => job_options  # [Hash]
  }

  Log.log.debug("starting session thread(s)")
  if !multi_session_number
    # single session for transfer : simple
    session[:thread] = Thread.new(session) {|s|transfer_thread_entry(s)}
    xfer_job[:sessions].push(session)
  else
    1.upto(multi_session_number) do |i|
      # do deep copy (each thread has its own copy because it is modified here below and in thread)
      this_session=session.clone()
      this_session[:env_args]=this_session[:env_args].clone()
      this_session[:env_args][:args]=this_session[:env_args][:args].clone()
      this_session[:env_args][:args].unshift("-C#{i}:#{multi_session_number}")
      # necessary only if server is not linux, i.e. server does not support port re-use
      this_session[:env_args][:args].unshift("-O","#{multi_session_udp_port_base+i-1}")
      this_session[:thread] = Thread.new(this_session) {|s|transfer_thread_entry(s)}
      xfer_job[:sessions].push(this_session)
    end
  end
  Log.log.debug("started session thread(s)")

  # add job to list of jobs
  @jobs[job_options[:job_id]]=xfer_job
  Log.log.debug("jobs: #{@jobs.keys.count}")

  return job_options[:job_id]
end

#start_transfer_with_args_env(env_args, session) ⇒ Object

This is the low level method to start the “ascp” process currently, relies on command line arguments start ascp with management port. raises FaspError on error if there is a thread info: set and broadcast session id could be private method



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/aspera/fasp/local.rb', line 160

def start_transfer_with_args_env(env_args,session)
  raise "env_args must be Hash" unless env_args.is_a?(Hash)
  raise "session must be Hash" unless session.is_a?(Hash)
  begin
    Log.log.debug("env_args=#{env_args.inspect}")
    # get location of ascp executable
    ascp_path=@mutex.synchronize do
      Fasp::Installation.instance.path(env_args[:ascp_version])
    end
    # (optional) check it exists
    raise Fasp::Error.new("no such file: #{ascp_path}") unless File.exist?(ascp_path)
    # open random local TCP port for listening for ascp management
    mgt_sock = TCPServer.new('127.0.0.1',0)
    # clone arguments as we eed to modify with mgt port
    ascp_arguments=env_args[:args].clone
    # add management port
    ascp_arguments.unshift('-M', mgt_sock.addr[1].to_s)
    # start ascp in sub process
    Log.log.debug("execute: #{env_args[:env].map{|k,v| "#{k}=\"#{v}\""}.join(' ')} \"#{ascp_path}\" \"#{ascp_arguments.join('" "')}\"")
    # start process
    ascp_pid = Process.spawn(env_args[:env],[ascp_path,ascp_path],*ascp_arguments)
    # in parent, wait for connection to socket max 3 seconds
    Log.log.debug("before accept for pid (#{ascp_pid})")
    # init management socket
    ascp_mgt_io=nil
    Timeout.timeout(ASCP_SPAWN_TIMEOUT_SEC) do
      ascp_mgt_io = mgt_sock.accept
      # management messages include file names which may be utf8
      # by default socket is US-ASCII
      # TODO: use same value as Encoding.default_external
      ascp_mgt_io.set_encoding(Encoding::UTF_8)
    end
    Log.log.debug("after accept (#{ascp_mgt_io})")
    session[:io]=ascp_mgt_io
    # exact text for event, with \n
    current_event_text=''
    # parsed event (hash)
    current_event_data=nil
    # this is the last full status
    last_status_event=nil
    # read management port
    loop do
      # TODO: timeout here ?
      line = ascp_mgt_io.gets
      # nil when ascp process exits
      break if line.nil?
      current_event_text=current_event_text+line
      line.chomp!
      Log.log.debug("line=[#{line}]")
      case line
      when 'FASPMGR 2'
        # begin event
        current_event_data = Hash.new
        current_event_text = ''
      when /^([^:]+): (.*)$/
        # event field
        current_event_data[$1] = $2
      when ''
        # empty line is separator to end event information
        raise "unexpected empty line" if current_event_data.nil?
        current_event_data[Manager::LISTENER_SESSION_ID_B]=ascp_pid
        notify_listeners(current_event_text,current_event_data)
        case current_event_data['Type']
        when 'INIT'
          session[:id]=current_event_data['SessionId']
          Log.log.debug("session id: #{session[:id]}")
        when 'DONE','ERROR'
          # TODO: check if this is always the last event
          last_status_event = current_event_data
        end # event type
      else
        raise "unexpected line:[#{line}]"
      end # case
    end # loop (process mgt port lines)
    # check that last status was received before process exit
    raise "INTERNAL: nil last status" if last_status_event.nil?
    case last_status_event['Type']
    when 'DONE'
      # return method (or just don't do anything)
      return
    when 'ERROR'
      Log.log.error("code: #{last_status_event['Code']}")
      if last_status_event['Description']  =~ /bearer token/i
        Log.log.error("need to regenerate token".red)
        if session[:options].is_a?(Hash) and session[:options].has_key?(:regenerate_token)
          # regenerate token here, expired, or error on it
          env_args[:env]['ASPERA_SCP_TOKEN']=session[:options][:regenerate_token].call(true)
        end
      end
      raise Fasp::Error.new(last_status_event['Description'],last_status_event['Code'].to_i)
    else
      raise "unexpected last event type: #{last_status_event['Type']}"
    end
  rescue SystemCallError => e
    # Process.spawn
    raise Fasp::Error.new(e.message)
  rescue Timeout::Error => e
    raise Fasp::Error.new('timeout waiting mgt port connect')
  rescue Interrupt => e
    raise Fasp::Error.new('transfer interrupted by user')
  ensure
    # if ascp was successfully started
    unless ascp_pid.nil?
      # "wait" for process to avoid zombie
      Process.wait(ascp_pid)
      ascp_pid=nil
      session.delete(:io)
    end
  end # begin-ensure
end

#wait_for_transfers_completion ⇒ Object

wait for completion of all jobs started



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/aspera/fasp/local.rb', line 130

def wait_for_transfers_completion
  Log.log.debug("wait_for_transfers_completion")
  # set to non-nil to exit loop
  result=[]
  @jobs.each do |id,job|
    job[:sessions].each do |session|
      Log.log.debug("join #{session[:thread]}")
      session[:thread].join
      result.push(session[:error] ? session[:error] : :success)
    end
  end
  Log.log.debug("all transfers joined")
  # since all are finished and we return the result, clear statuses
  @jobs.clear
  return result
end