Class: RestFtpDaemon::Remote::RemoteSFTP

Inherits:
RemoteBase
  • Object
show all
Defined in:
lib/rest-ftp-daemon/remote/sftp.rb

Instance Attribute Summary collapse

Attributes inherited from RemoteBase

#job, #log_prefix

Instance Method Summary collapse

Methods inherited from RemoteBase

#initialize, #prepare

Methods included from CommonHelpers

#dashboard_url, #exception_to_error, #format_bytes, #identifier, #underscore

Constructor Details

This class inherits a constructor from RestFtpDaemon::Remote::RemoteBase

Instance Attribute Details

#sftp ⇒ Object (readonly)

Class options



9
10
11
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 9

def sftp
  @sftp
end

Instance Method Details

#chdir_or_create(directory, mkdir = false) ⇒ Object

Raises:

  • (JobTargetShouldBeDirectory) 


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
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 61

def chdir_or_create directory, mkdir = false
  # Init, extract my parent name and my own name
  log_debug "chdir_or_create mkdir[#{mkdir}] dir[#{directory}]"
  parent, _current = split_path(directory)

  # Access this directory
  begin
    @sftp.opendir! directory

  rescue Net::SFTP::StatusException => _e
    # If not allowed to create path, that's over, we're stuck
    return false unless mkdir

    # Recurse upward
    chdir_or_create parent, mkdir

    # Now I was able to chdir into my parent, create the current directory
    mkdir directory

    # Finally retry the chdir
    retry
  else
    return true
  end

  # We should never get here
  raise JobTargetShouldBeDirectory
end

#close ⇒ Object 



135
136
137
138
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 135

def close
  # Close init
  super
end

#connect ⇒ Object

def prepare end



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 14

def connect
  super

  # Connect init
  log_debug "connect [#{@target.user}]@[#{@target.host}]:[#{@target.port}]"

  # Debug level
  verbosity =  @debug ? Logger::DEBUG : false

  # Connect remote server
  @sftp = Net::SFTP.start(@target.host.to_s, @target.user.to_s,
      password: @target.password.to_s,
      verbose: verbosity,
      port: @target.port,
      non_interactive: true,
      timeout: DEFAULT_SFTP_TIMEOUT
      )
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 140

def connected?
  @sftp && !@sftp.closed?
end

#mkdir(directory) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 53

def mkdir directory
  log_debug "mkdir [#{directory}]"
  @sftp.mkdir! directory

  rescue StandardError => ex
    raise TargetPermissionError, ex.message
end

#remove!(target) ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 43

def remove! target
  log_debug "remove! [#{target.name}]"
  @sftp.remove target.path_fs

rescue Net::SFTP::StatusException
  log_debug "#{LOG_INDENT}[#{target.name}] file not found"
else
  log_debug "#{LOG_INDENT}[#{target.name}] removed"
end

#size_if_exists(target) ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 33

def size_if_exists target
  log_debug "size_if_exists [#{target.name}]"
  stat = @sftp.stat! target.path_fs

rescue Net::SFTP::StatusException
  return false
else
  return stat.size
end

#upload(source, target, use_temp_name = false, &callback) ⇒ Object

Raises:



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
127
128
129
130
131
132
133
 
# File 'lib/rest-ftp-daemon/remote/sftp.rb', line 90

def upload source, target, use_temp_name = false, &callback
  # Push init
  raise RestFtpDaemon::AssertionFailed, "upload/sftp" if @sftp.nil?

  # Temp file if needed
  dest = target.clone
  if use_temp_name
    dest.generate_temp_name!
  end

  # Do the transfer
  log_debug "upload temp[#{use_temp_name}] name[#{dest.name}]"
  @sftp.upload! source.path_fs, dest.path_fs do |event, _uploader, *args|
    case event
    when :open then
      # args[0] : file metadata
    when :put then
      # args[0] : file metadata
      # args[1] : byte offset in remote file
      # args[2] : data being written (as string)
      # puts "writing #{args[2].length} bytes to #{args[0].remote} starting at #{args[1]}"

      # Update job status after this block transfer
      yield args[2].length, dest.name

    when :close then
      # args[0] : file metadata
    when :mkdir
      # args[0] : remote path name
    when :finish
    end

  end

  # Move the file back to its original name
  if use_temp_name
    flags = 0x00000001
    log_debug "upload rename [#{dest.name}] > [#{target.name}]"
    @sftp.rename! dest.path_fs, target.path_fs, flags
  end

  # progress:
  # Net::SFTP::StatusException
end