Class: Struggle::FtpTool

Inherits:
Object
  • Object
show all
Defined in:
lib/struggle/ftp_tool.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host, user, password, port = 21, mode = true) ⇒ FtpTool

实例化



4
5
6
7
8
9
10
 
# File 'lib/struggle/ftp_tool.rb', line 4

def initialize(host, user, password, port = 21, mode = true)
  require "net/ftp"
  @current_ftp = Net::FTP.new
  @current_ftp.connect(host, port)
  @current_ftp.(user, password)
  @current_ftp.passive = mode
end

Class Method Details

.convert(src_file, dest_file, from_encode, to_encode) ⇒ Object

文件编码转换



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/struggle/ftp_tool.rb', line 129

def convert(src_file, dest_file, from_encode, to_encode)
  log_info("Convert #{src_file} to #{dest_file}")
  cd = Iconv.new(to_encode, from_encode)
  File.open(dest_file, "w") do |out|
    File.open(src_file) do |in_stream|
      in_stream.each_line do |line|
        begin
          new_line = cd.iconv(line)
          out.write(new_line)
        rescue => e
          log_info "convert line error : #{line}"
          next
        end
      end
    end
  end
  cd.close
  dest_file
end

Instance Method Details

#close ⇒ Object

关闭ftp



61
62
63
 
# File 'lib/struggle/ftp_tool.rb', line 61

def close
  @current_ftp.close if @current_ftp
end

#closed? ⇒ Boolean

ftp 是否关闭

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/struggle/ftp_tool.rb', line 123

def closed?
  @current_ftp.closed?
end

#copy(origin_file, file_path) ⇒ Object

服务器copy文件



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/struggle/ftp_tool.rb', line 66

def copy(origin_file, file_path)
  local_file = local_file(origin_file)
  _file_name = File.basename(origin_file)
  begin
    #1. 到本地
    log_info("FTP get file to:" + local_file+".tmp")
    @current_ftp.getbinaryfile(origin_file, local_file+".tmp")
    return nil if not File.exist?(local_file+".tmp")
    #2. 到服务器
    log_info("FTP put file to :" + file_path + _file_name + ".tmp")
    @current_ftp.putbinaryfile(local_file+".tmp", file_path + _file_name + ".tmp")
    #3. 改名字
    rename(file_path + _file_name + ".tmp", file_path + _file_name)
    #5. 删除本地
    delete_local_file(local_file + ".tmp")
  rescue => e
    log_info(e)
    #4. 删除服务器上临时文件
    delete(file_path + origin_file + ".tmp")
    #5. 删除本地
    delete_local_file(local_file + ".tmp")
  end
end

#delete(origin_file) ⇒ Object

删除服务器上的文件



115
116
117
118
119
120
 
# File 'lib/struggle/ftp_tool.rb', line 115

def delete(origin_file)
  if not @current_ftp.list(origin_file).blank?
    log_info("FTP delete #{origin_file}")
    @current_ftp.delete(origin_file)
  end
end

#fetch_remote_filenames(source) ⇒ Object

获取指定格式的文件名称列表 例如： source = “test/*.txt” 返回： [source/file_name.txt]



15
16
17
18
19
20
 
# File 'lib/struggle/ftp_tool.rb', line 15

def fetch_remote_filenames(source)
  return [] if source.blank?
  log_info("source is " + source)
  filenames = @current_ftp.nlst(source)
  filenames
end

#get(origin_file) ⇒ Object

获取服务器上确切名称的文件 例如： get(“test/test.txt”) 文件将被保存到本地 tmp/test/test.txt



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/struggle/ftp_tool.rb', line 25

def get(origin_file)
  local_file = local_file(origin_file)
  local_file.gsub("\\", "\\\\") #此处注意是window下执行， 在linux下需要注意改成/
  log_info("Ftp Get: #{origin_file} -> #{local_file}")
  begin
    @current_ftp.getbinaryfile(origin_file, local_file+".tmp")
  rescue
    delete_local_file(local_file+".tmp")
  end
  rename_local_file(local_file+".tmp", local_file) if File.exist?(local_file+".tmp")
end

#move(origin_file, file_path) ⇒ Object

服务器上移动文件



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/struggle/ftp_tool.rb', line 91

def move(origin_file, file_path)
  _file_name = File.basename(origin_file)
  begin
    copy(origin_file, file_path)
    # 删除服务器上源文件
    delete(origin_file)
  rescue => e
    log_info(e)
    # 删除临时文件，如果存在
    delete(file_path + _file_name + ".tmp")
    # 删除服务器上目标文件， 如果存在
    delete(file_path + _file_name)
  end
end

#put(origin_file, remote_path) ⇒ Object

上传文件到指定的路径 例如： put(“tmp\test\test.txt”, “/test/”)



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/struggle/ftp_tool.rb', line 40

def put(origin_file, remote_path)
  return nil if not File.exist?(origin_file)
  _file_name = File.basename(origin_file)
  _root = @current_ftp.getdir
  begin
    @current_ftp.chdir(remote_path)
  rescue
    @current_ftp.mkdir(remote_path)
    @current_ftp.chdir(remote_path)
  end
  log_info("Ftp put: #{origin_file} -> #{remote_path}")
  begin
    @current_ftp.putbinaryfile(origin_file, remote_path + _file_name + ".tmp")
  rescue
    delete(remote_path + _file_name + ".tmp")
  end
  @current_ftp.chdir(_root)
  rename(remote_path + _file_name + ".tmp", remote_path + _file_name)
end

#rename(origin_file, file) ⇒ Object

重命名服务器文件



107
108
109
110
111
112
 
# File 'lib/struggle/ftp_tool.rb', line 107

def rename(origin_file, file)
  if not @current_ftp.list(origin_file).blank?
    log_info("FTP rename #{origin_file} to #{file}")
    @current_ftp.rename(origin_file, file)
  end
end