参考
libcurl使用心得
概述
Libcurl为一个免费开源的,客户端url传输库,支持 FTP,FTPS,TFTP,HTTP,HTTPS,GOPHER,TELNET,DICT,FILE和LDAP,跨平 台,支持Windows,Unix,Linux等,线程安全,支持Ipv6。并且易于使用。
编程流程
在基于 libcurl 的程序里,主要采用 callback function (回调函数)的形式 完成传输任务,用户在启动传输前设置好各类参数和回调函数,当满足条件时 libcurl 将调用用户的回调函数实现特定功能。流程:
curl_global_init() 初始化
curl_easy_init() 创建 easy interface 指针
curl_easy_setopt() 设置传输选项
根据 curl_easy_setopt() 传输的选项,实现回调函数完成特定任务
curl_easy_perform() 完成传输任务
curl_easy_cleanup() 释放内存
其中 curl_easy_setopt() 过程最关键,也最常用。
示例
最简单下载 html 页面
#include <stdio.h>
#include <curl/curl.h>
#include <stdlib.h>
int main (int argc, char **argv)
{
CURL *curl; //定义CURL类型的指针
CURLcode res; //定义CURLcode类型的变量,保存返回状态码
if (argc != 2)
{
printf ("用法 : %s <url>\n", argv[0]);
exit (1);
}
curl = curl_easy_init (); //初始化一个CURL类型的指针
if (curl != NULL)
{
//设置curl选项. 其中CURLOPT_URL是让用户指定url. argv[1]中存放的命令行传进来的网址
curl_easy_setopt (curl, CURLOPT_URL, argv[1]);
//调用curl_easy_perform 执行我们的设置.并进行相关的操作. 在这里只在屏幕上显示出来.
res = curl_easy_perform (curl);
//清除curl操作.
curl_easy_cleanup (curl);
}
return 0;
}
编译运行:
root @jianlee :~/lab/xml# gcc -Wall curl_html.c -o curl_html -lcurl
root @jianlee :~/lab/xml# ./curl_html
用法 : ./curl_html <url>
root @jianlee :~/lab/xml# ./curl_html www.gnu.org|head
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:
[email protected]" />
<link rel="icon" type="image/png" href="/graphics/gnu-head-mini.png" />
<meta name="ICBM" content="42.256233,-71.006581" />
<meta name="DC.title" content="gnu.org" />
html 下载保存为文件
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <curl/curl.h>
#include <curl/types.h>
#include <curl/easy.h>
FILE *fp; //定义FILE类型指针
//这个函数是为了符合CURLOPT_WRITEFUNCTION而构造的
//完成数据保存功能
size_t write_data (void *ptr, size_t size, size_t nmemb, void *stream)
{
int written = fwrite (ptr, size, nmemb, (FILE *) fp);
return written;
}
int main (int argc, char *argv[])
{
CURL *curl;
curl_global_init (CURL_GLOBAL_ALL);
curl = curl_easy_init ();
curl_easy_setopt (curl, CURLOPT_URL, argv[1]);
if ((fp = fopen (argv[2], "w")) == NULL)
{
curl_easy_cleanup (curl);
exit (1);
}
////CURLOPT_WRITEFUNCTION 将后继的动作交给write_data函数处理
curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, write_data);
curl_easy_perform (curl);
curl_easy_cleanup (curl);
exit (0);
}
编译运行:
root @jianlee :~/lab/xml# gcc -Wall save_html.c -o save_html -lcurl
root @jianlee :~/lab/xml# ./save_html www.gnu.org gnu.html
root @jianlee :~/lab/xml# head gnu.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:
[email protected]" />
<link rel="icon" type="image/png" href="/graphics/gnu-head-mini.png" />
<meta name="ICBM" content="42.256233,-71.006581" />
<meta name="DC.title" content="gnu.org" />
http 下载显示进度条
#include <stdio.h>
#include <gtk/gtk.h>
#include <curl/curl.h>
#include <curl/types.h> /* new for v7 */
#include <curl/easy.h> /* new for v7 */
GtkWidget *Bar;
////这个函数是为了符合CURLOPT_WRITEFUNCTION而构造的
//完成数据保存功能
size_t my_write_func(void *ptr, size_t size, size_t nmemb, FILE *stream)
{
return fwrite(ptr, size, nmemb, stream);
}
//这个函数是为了符合CURLOPT_READFUNCTION而构造的
//数据上传时使用
size_t my_read_func(void *ptr, size_t size, size_t nmemb, FILE *stream)
{
return fread(ptr, size, nmemb, stream);
}
//这个函数是为了符合CURLOPT_PROGRESSFUNCTION而构造的
//显示文件传输进度,t代表文件大小,d代表传输已经完成部分
int my_progress_func(GtkWidget *bar,
double t, /* dltotal */
double d, /* dlnow */
double ultotal,
double ulnow)
{
/* printf("%d / %d (%g %%)\n", d, t, d*100.0/t);*/
gdk_threads_enter();
gtk_progress_set_value(GTK_PROGRESS(bar), d*100.0/t);
gdk_threads_leave();
return 0;
}
void *my_thread(void *ptr)
{
CURL *curl;
CURLcode res;
FILE *outfile;
gchar *url = ptr;
curl = curl_easy_init();
if(curl)
{
outfile = fopen("test.curl", "w");
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, outfile);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, my_write_func);
curl_easy_setopt(curl, CURLOPT_READFUNCTION, my_read_func);
curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
curl_easy_setopt(curl, CURLOPT_PROGRESSFUNCTION, my_progress_func);
curl_easy_setopt(curl, CURLOPT_PROGRESSDATA, Bar);
res = curl_easy_perform(curl);
fclose(outfile);
/* always cleanup */
curl_easy_cleanup(curl);
}
return NULL;
}
int main(int argc, char **argv)
{
GtkWidget *Window, *Frame, *Frame2;
GtkAdjustment *adj;
/* Must initialize libcurl before any threads are started */
curl_global_init(CURL_GLOBAL_ALL);
/* Init thread */
g_thread_init(NULL);
gtk_init(&argc, &argv);
Window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
Frame = gtk_frame_new(NULL);
gtk_frame_set_shadow_type(GTK_FRAME(Frame), GTK_SHADOW_OUT);
gtk_container_add(GTK_CONTAINER(Window), Frame);
Frame2 = gtk_frame_new(NULL);
gtk_frame_set_shadow_type(GTK_FRAME(Frame2), GTK_SHADOW_IN);
gtk_container_add(GTK_CONTAINER(Frame), Frame2);
gtk_container_set_border_width(GTK_CONTAINER(Frame2), 5);
adj = (GtkAdjustment*)gtk_adjustment_new(0, 0, 100, 0, 0, 0);
Bar = gtk_progress_bar_new_with_adjustment(adj);
gtk_container_add(GTK_CONTAINER(Frame2), Bar);
gtk_widget_show_all(Window);
if (!g_thread_create(&my_thread, argv[1], FALSE, NULL) != 0)
g_warning("can't create the thread");
gdk_threads_enter();
gtk_main();
gdk_threads_leave();
return 0;
}
编译运行:
root @jianlee :~/lab/xml# gcc -Wall curl_进度条.c -o curl_进度条 `pkg-config --cflags --libs gtk+-2.0` -lcurl -lgthread-2.0
root @jianlee :~/lab/xml# ./curl_进度条 www.gnu.org
断点续传
#include <stdlib.h>
#include <stdio.h>
#include <sys/stat.h>
#include <curl/curl.h>
//这个函数为CURLOPT_HEADERFUNCTION参数构造
/* 从http头部获取文件size*/
size_t getcontentlengthfunc(void *ptr, size_t size, size_t nmemb, void *stream)
{
int r;
long len = 0;
/* _snscanf() is Win32 specific */
// r = _snscanf(ptr, size * nmemb, "Content-Length: %ld\n", &len);
r = sscanf(ptr, "Content-Length: %ld\n", &len);
if (r) /* Microsoft: we don't read the specs */
*((long *) stream) = len;
return size * nmemb;
}
/* 保存下载文件 */
size_t wirtefunc(void *ptr, size_t size, size_t nmemb, void *stream)
{
return fwrite(ptr, size, nmemb, stream);
}
/*读取上传文件 */
size_t readfunc(void *ptr, size_t size, size_t nmemb, void *stream)
{
FILE *f = stream;
size_t n;
if (ferror(f))
return CURL_READFUNC_ABORT;
n = fread(ptr, size, nmemb, f) * size;
return n;
}
// 下载 或者上传文件函数
int download(CURL *curlhandle, const char * remotepath, const char * localpath,
long timeout, long tries)
{
FILE *f;
curl_off_t local_file_len = -1 ;
long filesize =0 ;
CURLcode r = CURLE_GOT_NOTHING;
//int c;
struct stat file_info;
int use_resume = 0;
/* 得到本地文件大小 */
//if(access(localpath,F_OK) ==0)
if(stat(localpath, &file_info) == 0)
{
local_file_len = file_info.st_size;
use_resume = 1;
}
//采用追加方式打开文件,便于实现文件断点续传工作
f = fopen(localpath, "ab+");
if (f == NULL)
{
perror(NULL);
return 0;
}
//curl_easy_setopt(curlhandle, CURLOPT_UPLOAD, 1L);
curl_easy_setopt(curlhandle, CURLOPT_URL, remotepath);
curl_easy_setopt(curlhandle, CURLOPT_CONNECTTIMEOUT, timeout); // 设置连接超时,单位秒
//设置http 头部处理函数
curl_easy_setopt(curlhandle, CURLOPT_HEADERFUNCTION, getcontentlengthfunc);
curl_easy_setopt(curlhandle, CURLOPT_HEADERDATA, &filesize);
// 设置文件续传的位置给libcurl
curl_easy_setopt(curlhandle, CURLOPT_RESUME_FROM_LARGE, use_resume?local_file_len:0);
curl_easy_setopt(curlhandle, CURLOPT_WRITEDATA, f);
curl_easy_setopt(curlhandle, CURLOPT_WRITEFUNCTION, wirtefunc);
//curl_easy_setopt(curlhandle, CURLOPT_READFUNCTION, readfunc);
//curl_easy_setopt(curlhandle, CURLOPT_READDATA, f);
curl_easy_setopt(curlhandle, CURLOPT_NOPROGRESS, 1L);
curl_easy_setopt(curlhandle, CURLOPT_VERBOSE, 1L);
r = curl_easy_perform(curlhandle);
fclose(f);
if (r == CURLE_OK)
return 1;
else {
fprintf(stderr, "%s\n", curl_easy_strerror(r));
return 0;
}
}
int main(int c, char **argv) {
CURL *curlhandle = NULL;
curl_global_init(CURL_GLOBAL_ALL);
curlhandle = curl_easy_init();
//download(curlhandle, "ftp://user:pass@host/path/file", "C:\\file", 0, 3);
download(curlhandle , "www.gnu.org","./",1,3);
curl_easy_cleanup(curlhandle);
curl_global_cleanup();
return 0;
}
编译运行:
root @jianlee :~/lab/xml# gcc -Wall curl_resume.c -o curl_resume -lcurl
root @jianlee :~/lab/xml# ./curl_resume
函数介绍
初始化
curl_global_init
curlcode curl_global_init (long flags);
CURL_GLOBAL_ALL //初始化所有的可能的调用。
CURL_GLOBAL_SSL //初始化支持 安全套接字层。
CURL_GLOBAL_WIN32 //初始化win32套接字库。
CURL_GLOBAL_NOTHING //没有额外的初始化。
curl_easy_init
CURL *curl_easy_init ();
curl_easy_init 用来初始化一个CURL的指针(有些像返回FILE类型的指针一样). 相应的在调用结束时要用 curl_easy_cleanup 函数清理. 一般 curl_easy_init 意味着一个会话的开始. 它的返回值一般都用在easy系列的函数中
清理
curl_global_cleanup
void curl_global_cleanup (void);
在结束libcurl使用的时候,用来对 curl_global_init 做的工作清理。类似于 close的函数。
curl_easy_cleanup
void curl_easy_cleanup (CURL *handle);
这个调用用来结束一个会话.与curl_easy_init配合着用.
设置
curl_easy_setopt
CURLcode curl_easy_setopt (CURL *handle, CURLoption option, parameter);
这个函数最重要,几乎所有的 curl 程序都要频繁的使用它.它告诉curl库.程序 将有如何的行为. 比如要查看一个网页的 html 代码等.(这个函数有些像 ioctl 函数)参数:
CURL类型的指针
各种 CURLoption 类型的选项.(都在curl.h库里有定义,man 也可以查看到)
parameter 这个参数 既可以是个函数的指针,也可以是某个对象的指针,也可 以是个 long 型的变量.它用什么这取决于第二个参数.
执行
curl_easy_perform
CURLcode curl_easy_perform (CURL *handle);
这个函数在初始化CURL类型的指针 以及 curl_easy_setopt 完成后调用. 就像字 面的意思所说 perform 就像是个舞台.让我们设置的 option 运作起来.
返回 0 表示正确,非零表示错误码:
CURLE_OK 任务完成一切都好
CURLE_UNSUPPORTED_PROTOCOL 不支持的协议,由URL的头部指定
CURLE_COULDNT_CONNECT 不能连接到remote 主机或者代理
CURLE_REMOTE_ACCESS_DENIED 访问被拒绝
CURLE_HTTP_RETURNED_ERROR Http返回错误
CURLE_READ_ERROR 读本地文件错误
其他
char *curl_version ();
输出 libcurl 库的版本信息。
curl_easy_setopt
这个函数最常用,很重要,单独介绍。
和 http 有关的参数
CURLOPT_URL — 设置访问URL
CURLOPT_WRITEFUNCTION, CURLOPT_WRITEDATA
回调函数原型为:
size_t function( void *ptr, size_t size, size_t nmemb, void *stream);
函数将在 libcurl 接收到数据后被调用,因此函数多做数据保存的功能,如 处理下载文件。
CURLOPT_WRITEDATA 用于表明 CURLOPT_WRITEFUNCTION 函数中的 stream 指 针的来源。
CURLOPT_HEADERFUNCTION,CURLOPT_HEADERDATA
回调函数原型为
size_t function( void *ptr, size_t size,size_t nmemb, void *stream);
libcurl 一旦接收到 http 头部数据后将调用该函数。
CURLOPT_WRITEDATA 传递指针给libcurl,该指针表明 CURLOPT_HEADERFUNCTION 函数的 stream 指针的来源。
CURLOPT_READFUNCTION CURLOPT_READDATA
libcurl 需要读取数据传递给远程主机时将调用 CURLOPT_READFUNCTION 指定 的函数,函数原型是:
size_t function(void *ptr, size_t size, size_t nmemb,void *stream).
CURLOPT_READDATA 表明CURLOPT_READFUNCTION函数原型中的stream指针来源。
CURLOPT_NOPROGRESS,CURLOPT_PROGRESSFUNCTION,CURLOPT_PROGRESSDATA
跟数据传输进度相关的参数。
CURLOPT_PROGRESSFUNCTION 指定的函数正常情况下每秒被 libcurl 调用一 次,为了使 CURLOPT_PROGRESSFUNCTION 被调用, CURLOPT_NOPROGRESS 必须 被设置为 false , CURLOPT_PROGRESSDATA 指定的参数将作为 CURLOPT_PROGRESSFUNCTION 指定函数的第一个参数。
CURLOPT_TIMEOUT,CURLOPT_CONNECTIONTIMEOUT
CURLOPT_TIMEOUT 由于设置传输时间,CURLOPT_CONNECTIONTIMEOUT 设置连接 等待时间
CURLOPT_FOLLOWLOCATION
设置重定位URL
CURLOPT_RANGE: CURLOPT_RESUME_FROM
断点续传相关设置。CURLOPT_RANGE 指定 char 指针参数传递给libcurl,用于指 明http域的RANGE头域,例如:
表示头500个字节:bytes=0-499
表示第二个500字节:bytes=500-999
表示最后500个字节:bytes=-500
表示500字节以后的范围:bytes=500-
第一个和最后一个字节:bytes=0-0,-1
同时指定几个范围:bytes=500-600,601-999
CURLOPT_RESUME_FROM 传递一个long参数给libcurl,指定你希望开始传递的
偏移量。