【闲暇一写】基于TCP协议写的FTP管理工具
这是一个FTP(文件传输协议)管理工具,能够支持文件上传下载以及操作服务端的文件。
该工具由客户端和服务端组成。客户端与服务端通过Socket连接实现通信,客户端发送命令,服务端解析并执行相应的操作。部分代码已省略,下面是服务端和客户端代码的详细解释。
GitHub:https://github.com/ITchujian/ftp_manager
服务端
以下是服务端代码中的模块及其功能:
- import shutil:导入shutil模块,提供了高级文件操作支持,包括文件复制、删除、移动等功能。
- import sys:导入sys模块,提供了一些与Python解释器及其环境有关的变量和函数。
- import time:导入time模块,提供了与时间相关的函数。
- from threading import Thread:导入Thread类,提供了线程支持。
- from socket import *:导入所有的socket模块的函数和变量,包括socket、AF_INET、SOCK_STREAM等。
- import os:导入os模块,提供了与操作系统交互的函数。
File类的方法:
- ls():返回当前目录下的所有文件和文件夹。
- format(ls_msg: dict):将ls()方法的返回结果格式化为可读字符串。
- cd(directory):将当前目录更改为directory指定的目录。
- pwd():返回当前目录路径。
- mkdir(directory):创建名为directory的文件夹。
- rm(directory):删除名为directory的文件或文件夹。
Handle类的方法:
- run():处理客户端的请求,接收并解析客户端发送的命令,调用File类的相应方法进行处理,将处理结果发送给客户端。如果客户端发送了"quit"或"exit"命令,表示客户端主动断开连接,方法退出。
接收命令:
- quit 或 exit:断开连接。
- ls:列出当前目录下的所有文件和文件夹。
- pwd:返回当前目录路径。
- cd:将当前目录更改为指定目录。
- mkdir:创建指定的文件夹。
- rm:删除指定的文件或文件夹。
- dl:下载指定的文件
- up:上传指定的文件
客户端
首先是一个基于socket的FTPClient程序中的进度条ProgressBar类。ProgressBar类用于显示FTP客户端上传或下载文件的进度,它可以显示一个进度条,并在文件传输完成时自动退出。
ProgressBar 类的初始化
ProgressBar类的构造函数接收四个参数:current
、target
、tag
和count
。
def __init__(self, current: int, target: int, tag: str = "#", count: int = 100):
self.current = current
self.target = target
self.tag = tag
self.count = count
self.loaded = False
其中,current
表示当前传输的数据量(单位为字节),target
表示总的数据量(单位为字节),tag
表示进度条的填充字符(默认为“#”),count
表示进度条的长度(默认为100)。
ProgressBar 类的方法
update(value)
update()
方法用于更新进度条的当前值,它接收一个整数参数value
,表示需要更新的数据量(单位为字节)。
def update(self, value):
self.current += value
finished()
finished()
方法返回一个布尔值,用于判断文件是否传输完成。
def finished(self) -> bool:
if self.loaded:
return self.current >= self.target
return self.loaded
如果进度条已经加载,就判断当前传输的数据量是否大于等于总的数据量;否则返回loaded
属性的值(默认为False)。
listen()
listen()
方法用于实时显示进度条,并在文件传输完成时自动退出。它使用一个循环来监听数据传输的进度,并根据数据的大小更新进度条的显示。方法内部使用time.sleep()
函数来降低CPU占用率。
def listen(self):
part = self.target // self.count + 1
print("[", end="")
finished = 0
while True:
if finished >= self.count:
break
time.sleep(0.01)
if self.current >= part * (finished + 1):
print("#", end="")
finished += 1
print("]", end="\n")
self.loaded = True
其中,part
表示每个“#”字符代表的数据量大小,finished
表示已经完成的进度条长度。
run()
run()
方法用于启动listen()
方法,并将其作为一个线程运行。
def run(self):
thread = Thread(target=self.listen)
thread.start()
ProgressBar类用于FTPClient的上传和下载进度显示,进度条会根据文件传输的进度实时更新,直到文件传输完成。
FTPClient类详解
该代码是一个FTP客户端,其主要功能包括与FTP服务器建立连接、上传文件、下载文件、创建文件夹、删除文件等操作。接下来将对代码中的FTPClient
类进行详细讲解。
ProgressBar类
在FTPClient
类中,有一个名为ProgressBar
的类。该类是一个用于进度条显示的类,包括当前进度、目标进度、显示标记、显示长度等属性,以及update
、finished
、listen
、run
等方法。
在listen
方法中,使用while True循环来更新进度条,并使用time.sleep()
方法来控制更新频率。在每个循环迭代中,根据当前进度和目标进度计算出当前百分比,并根据标记和长度进行输出。
在run
方法中,使用多线程的方式调用listen
方法,从而实现进度条的实时更新。
FTPClient类
FTPClient
类是整个FTP客户端的核心类。在类中包含一系列方法,用于与FTP服务器进行交互。
属性
FTPClient
类中包含一些属性:
host
: FTP服务器的地址port
: FTP服务器的端口server_addr
: FTP服务器的地址和端口sock
: 用于与FTP服务器进行通信的套接字download_file
: 正在下载的文件event
: 用于线程同步的事件
方法
FTPClient
类中包含许多方法,下面分别进行介绍。
__connect方法
__connect
方法用于连接FTP服务器。在方法中,使用socket
库创建一个TCP套接字,并通过该套接字连接FTP服务器。
__stop方法
__stop
方法用于断开与FTP服务器的连接。在方法中,关闭TCP套接字,并使用sys.exit()
方法退出客户端程序。
run方法
run
方法是整个FTP客户端的主要方法。在该方法中,首先调用__connect
方法连接FTP服务器,并使用Event
对象设置事件。
之后,使用循环来等待用户输入FTP命令。在每次循环中,通过TCP套接字发送用户输入的FTP命令,并根据不同的命令调用不同的方法(如__download
、__upload
等)。
当命令为quit
或exit
时,退出循环并调用__stop
方法断开连接。
__send方法
__send
方法用于向FTP服务器发送消息。在该方法中,通过TCP套接字发送字符串类型的消息。
__recv方法
__recv
方法用于接收FTP服务器返回的消息。在该方法中,使用TCP套接字接收FTP服务器发送的数据,并将数据转换为字符串类型。
__download方法
__download
方法用于从FTP服务器下载文件。在该方法中,使用TCP套接字接收FTP服务器发送的文件数据,并将文件数据写入本地
__upload方法
__upload
方法用于上传文件到FTP服务器。在该方法中,使用TCP套接字发送文件数据到FTP服务器