ftplib源码剖析

最新推荐文章于 2024-05-13 09:44:00 发布

luoxn28

最新推荐文章于 2024-05-13 09:44:00 发布

阅读量9.3k

点赞数 2

分类专栏：开源代码学习文章标签： ftplib ftplib教程 ftplib源码分析

本文链接：https://blog.csdn.net/u012796139/article/details/46794291

版权

ftplib是一组例程实现FTP协议。他们允许应用程序创建和访问远程文件通过函数调用,而不是需要叉和执行一个交互式的ftp客户端程序。
ftplib已经在Linux上构建和测试(X86)、Mac os x和OpenVMS(AXP)。
很快:我正在使用autotools版本。这应该是释放不久。

以上是ftplib官网上的说明文字。。(FTP官网链接，可以下载代码：http://www.nbpfaus.net/~pfau/ftplib/)

ftplib是一个小巧的实现FTP协议的一组例程，里面包含了关于FTP各种操作的函数。阅读代码，不仅可以了解一下FTP的具体工作原理，还可以看一下FTP网络编程相关的知识，可谓一举两得。OK，闲话少说，还是直接上代码比较实在

关于FTP的原理说明及FTP的应代码的介绍请参考：计算机网络中关于FTP的介绍和 FTP应答码

我用的是ftplib-4.0的版本，下载链接：http://download.csdn.net/detail/u012796139/8877857

代码结构说明

ftplib代码量比较小(总共也就1500行左右代码)，主要有2个函数构成，ftplib.c和ftplib.h文件，还有一个测试程序qftp.c文件。

其中，ftplib最主要的一个结构就是NetBuf结构体了，它是ftplib的整个操作核心，包括了一下FTP相关的操作成员等，如下：

struct NetBuf {
    char *cput,*cget; 			/* cput和cget指向该buf的接收缓冲区 */
    int handle;					/* 待处理的文件描述符(比如在handle上设置的select I/O复用) */
    int cavail,cleft;			/* cavail 可用的字节数，*/
    char *buf;					/* 读写缓冲区 */
    int dir;					/* 表明执行的操作，比如write操作时，dir为FTPLIB_WRITE，read操作时，dir为FTPLIB_READ*/
    netbuf *ctrl;				/* 指向控制连接的netbuf */
    netbuf *data;    			/* 指向数据连接的netbuf */   
    int cmode;					/* connection mode 连接模式 可选值：FTPLIB_PASSIVE(被动传输模式) FTPLIB_PORT(主动传输模式) */
    struct timeval idletime;	/* IO复用函数的超时时间，暂时看到select用到了 */
    FtpCallback idlecb;			/* 回调函数，用于IO复用函数的等待 */
    void *idlearg;				/* 传递给idlecb回调函数的参数 */
    unsigned long int xfered;
    unsigned long int cbbytes;	/* 回调函数传输的字节数 */
    unsigned long int xfered1;
    char response[RESPONSE_BUFSIZ]; /* 存放服务器的应答数据*/
};

关于NetBuf中成员的含义直接看注释就行，就不在贴出来了。

FTP的控制操作有两个连接，一个是控制连接，负责命令的传输；另一个是数据连接，负责数据的收发等，比如上传下载等就是走的数据连接。

源代码分析

下面是ftplib.h头文件

/***************************************************************************/
/*									   */
/* ftplib.h - header file for callable ftp access routines                 */
/* Copyright (C) 1996-2001, 2013 Thomas Pfau, tfpfau@gmail.com		   */
/*	1407 Thomas Ave, North Brunswick, NJ, 08902			   */
/*									   */
/* This library is free software.  You can redistribute it and/or	   */
/* modify it under the terms of the Artistic License 2.0.		   */
/* 									   */
/* This library is distributed in the hope that it will be useful,	   */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of	   */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the	   */
/* Artistic License 2.0 for more details.				   */
/* 									   */
/* See the file LICENSE or 						   */
/* http://www.perlfoundation.org/artistic_license_2_0			   */
/*									   */
/***************************************************************************/

#if !defined(__FTPLIB_H)
#define __FTPLIB_H

#if defined(__unix__) || defined(VMS)
#define GLOBALDEF
#define GLOBALREF extern
#elif defined(_WIN32)
#if defined BUILDING_LIBRARY
#define GLOBALDEF __declspec(dllexport)
#define GLOBALREF __declspec(dllexport)
#else
#define GLOBALREF __declspec(dllimport)
#endif
#endif

#include <limits.h>
#include <inttypes.h>

/* FtpAccess() type codes */
#define FTPLIB_DIR 1
#define FTPLIB_DIR_VERBOSE 2
#define FTPLIB_FILE_READ 3
#define FTPLIB_FILE_WRITE 4

/* FtpAccess() mode codes */
#define FTPLIB_ASCII 'A'
#define FTPLIB_IMAGE 'I'
#define FTPLIB_TEXT FTPLIB_ASCII
#define FTPLIB_BINARY FTPLIB_IMAGE

/* connection modes */
#define FTPLIB_PASSIVE 1
#define FTPLIB_PORT 2

/* connection option names */
#define FTPLIB_CONNMODE 1
#define FTPLIB_CALLBACK 2
#define FTPLIB_IDLETIME 3
#define FTPLIB_CALLBACKARG 4
#define FTPLIB_CALLBACKBYTES 5

#ifdef __cplusplus
extern "C" {
#endif

#if defined(__UINT64_MAX)
typedef uint64_t fsz_t;
#else
typedef uint32_t fsz_t;
#endif

typedef struct NetBuf netbuf;
typedef int (*FtpCallback)(netbuf *nControl, fsz_t xfered, void *arg);

typedef struct FtpCallbackOptions {
    FtpCallback cbFunc;		/* function to call */
    void *cbArg;		/* argument to pass to function */
    unsigned int bytesXferred;	/* callback if this number of bytes transferred */
    unsigned int idleTime;	/* callback if this many milliseconds have elapsed */
} FtpCallbackOptions;

GLOBALREF int ftplib_debug;
GLOBALREF void FtpInit(void);
GLOBALREF char *FtpLastResponse(netbuf *nControl);
GLOBALREF int FtpConnect(const char *host, netbuf **nControl);
GLOBALREF int FtpOptions(int opt, long val, netbuf *nControl);
GLOBALREF int FtpSetCallback(const FtpCallbackOptions *opt, netbuf *nControl);
GLOBALREF int FtpClearCallback(netbuf *nControl);
GLOBALREF int FtpLogin(const char *user, const char *pass, netbuf *nControl);
GLOBALREF int FtpAccess(const char *path, int typ, int mode, netbuf *nControl,
    netbuf **nData);
GLOBALREF int FtpRead(void *buf, int max, netbuf *nData);
GLOBALREF int FtpWrite(const void *buf, int len, netbuf *nData);
GLOBALREF int FtpClose(netbuf *nData);
GLOBALREF int FtpSite(const char *cmd, netbuf *nControl);
GLOBALREF int FtpSysType(char *buf, int max, netbuf *nControl);
GLOBALREF int FtpMkdir(const char *path, netbuf *nControl);
GLOBALREF int FtpChdir(const char *path, netbuf *nControl);
GLOBALREF int FtpCDUp(netbuf *nControl);
GLOBALREF int FtpRmdir(const char *path, netbuf *nControl);
GLOBALREF int FtpPwd(char *path, int max, netbuf *nControl);
GLOBALREF int FtpNlst(const char *output, const char *path, netbuf *nControl);
GLOBALREF int FtpDir(const char *output, const char *path, netbuf *nControl);
GLOBALREF int FtpSize(const char *path, unsigned int *size, char mode, netbuf *nControl);
#if defined(__UINT64_MAX)
GLOBALREF int FtpSizeLong(const char *path, fsz_t *size, char mode, netbuf *nControl);
#endif
GLOBALREF int FtpModDate(const char *path, char *dt, int max, netbuf *nControl);
GLOBALREF int FtpGet(const char *output, const char *path, char mode,
	netbuf *nControl);
GLOBALREF int FtpPut(const char *input, const char *path, char mode,
	netbuf *nControl);
GLOBALREF int FtpRename(const char *src, const char *dst, netbuf *nControl);
GLOBALREF int FtpDelete(const char *fnm, netbuf *nControl);
GLOBALREF void FtpQuit(netbuf *nControl);

#ifdef __cplusplus
};
#endif

#endif /* __FTPLIB_H */

下面是ftplib.c文件

/***************************************************************************/
/*									   */
/* ftplib.c - callable ftp access routines				   */
/* Copyright (C) 1996-2001, 2013 Thomas Pfau, tfpfau@gmail.com		   */
/*	1407 Thomas Ave, North Brunswick, NJ, 08902			   */
/*									   */
/* This library is free software.  You can redistribute it and/or	   */
/* modify it under the terms of the Artistic License 2.0.		   */
/* 									   */
/* This library is distributed in the hope that it will be useful,	   */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of	   */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the	   */
/* Artistic License 2.0 for more details.				   */
/* 									   */
/* See the file LICENSE or 						   */
/* http://www.perlfoundation.org/artistic_license_2_0			   */
/* 									   */
/***************************************************************************/

#if defined(__unix__) || defined(__VMS)
#include <unistd.h>
#e

最低0.47元/天解锁文章

luoxn28

关注

2
点赞
踩
21

收藏

觉得还不错? 一键收藏
0
评论
ftplib源码剖析

ftplib是一组例程实现FTP协议。他们允许应用程序创建和访问远程文件通过函数调用,而不是需要叉和执行一个交互式的ftp客户端程序。ftplib已经在Linux上构建和测试(X86)、Mac os x和OpenVMS(AXP)。很快:我正在使用autotools版本。这应该是释放不久。以上是ftplib官网上的说明文字。。(FTP官网链接，可以下载代码：http://www.nb
复制链接

扫一扫