libcurl

1. LibCurl编程流程
   在基于LibCurl的程序里，主要采用callback function （回调函数）的形式完成传输任务，用户在启动传输前设置好各类参数和回调函数，当满足条件时libcurl将调用用户的回调函数实现特定功能。下面是利用libcurl完成传输任务的流程：
2. 调用curl_global_init()初始化libcurl
3. 调用 curl_easy_init()函数得到 easy interface型指针
4. 调用curl_easy_setopt设置传输选项
5. 根据curl_easy_setopt设置的传输选项，实现回调函数以完成用户特定任务
6. 调用curl_easy_perform（）函数完成传输任务

7. 调用curl_easy_cleanup（）释放内存
   在整过过程中设置curl_easy_setopt()参数是最关键的，几乎所有的libcurl程序都要使用它。

8. 重要函数
   2.1 CURLcode curl_global_init(long flags);
   描述：
   这个函数只能用一次。(其实在调用curl_global_cleanup 函数后仍然可再用)
   如果这个函数在curl_easy_init函数调用时还没调用，它讲由libcurl库自动完成。
   参数：flags
   CURL_GLOBAL_ALL //初始化所有的可能的调用。
   CURL_GLOBAL_SSL //初始化支持 安全套接字层。
   CURL_GLOBAL_WIN32 //初始化win32套接字库。
   CURL_GLOBAL_NOTHING //没有额外的初始化。

2.2 void curl_global_cleanup(void);
描述：在结束libcurl使用的时候，用来对curl_global_init做的工作清理。类似于close的函数。

2.3 char *curl_version( );
描述: 打印当前libcurl库的版本。

2.4 CURL *curl_easy_init( );
描述:
curl_easy_init用来初始化一个CURL的指针(有些像返回FILE类型的指针一样). 相应的在调用结束时要用curl_easy_cleanup函数清理.
一般curl_easy_init意味着一个会话的开始. 它的返回值一般都用在easy系列的函数中.

2.5 void curl_easy_cleanup(CURL *handle);
描述:
这个调用用来结束一个会话.与curl_easy_init配合着用.
参数:
CURL类型的指针.

2.6 CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
描述: 这个函数最重要了.几乎所有的curl 程序都要频繁的使用它.它告诉curl库.程序将有如何的行为. 比如要查看一个网页的html代码等.(这个函数有些像ioctl函数)参数:
1 CURL类型的指针
2 各种CURLoption类型的选项.(都在curl.h库里有定义,man 也可以查看到)
3 parameter 这个参数 既可以是个函数的指针,也可以是某个对象的指针,也可以是个long型的变量.它用什么这取决于第二个参数.
CURLoption 这个参数的取值很多.具体的可以查看man手册.

2.7 CURLcode curl_easy_perform(CURL *handle);
描述:这个函数在初始化CURL类型的指针 以及curl_easy_setopt完成后调用. 就像字面的意思所说perform就像是个舞台.让我们设置的option 运作起来.参数:
CURL类型的指针.

1. curl_easy_setopt函数介绍
   本节主要介绍curl_easy_setopt中跟http相关的参数。注意本节的阐述都是以libcurl作为主体，其它为客体来阐述的。
   3.1 CURLOPT_URL
   设置访问URL

3.2 CURLOPT_WRITEFUNCTION，CURLOPT_WRITEDATA
回调函数原型为：size_t function( void *ptr, size_t size, size_t nmemb, void *stream); 函数将在libcurl接收到数据后被调用，因此函数多做数据保存的功能，如处理下载文件。CURLOPT_WRITEDATA 用于表明CURLOPT_WRITEFUNCTION函数中的stream指针的来源。

3.3 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指针的来源。

3.4 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指针来源。

3.5 CURLOPT_NOPROGRESS，CURLOPT_PROGRESSFUNCTION，CURLOPT_PROGRESSDATA
跟 数据传输进度相关的参数。CURLOPT_PROGRESSFUNCTION 指定的函数正常情况下每秒被libcurl调用一次，为了使CURLOPT_PROGRESSFUNCTION被调 用，CURLOPT_NOPROGRESS必须被设置为false，CURLOPT_PROGRESSDATA指定的参数将作为 CURLOPT_PROGRESSFUNCTION指定函数的第一个参数

3.6 CURLOPT_TIMEOUT，CURLOPT_CONNECTIONTIMEOUT:
CURLOPT_TIMEOUT 由于设置传输时间，CURLOPT_CONNECTIONTIMEOUT 设置连接等待时间

3.7 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，指定你希望开始传递的
偏移量。

CURLOPT_URL
字符串类型，该选项设置要处理的URL地址，该选项是进行curl_easy_perform之前唯一必须要设置的选项。

CURLOPT_COOKIE
字符串类型，设置http头中的cookie信息。

CURLOPT_COOKIEFILE
字符串类型，同CURLOPT_COOKIE，不过cookie信息从文件中读取。

CURLOPT_FOLLOWLOCATION
布尔值类型，该参数设置为非零值表示follow服务器返回的重定向信息。

CURLOPT_POSTFIELDS
字符串类型，提交http的post操作字符串数据。

CURLOPT_TIMEOUT
long数值类型，设置函数执行的最长时间，时间单位为s。

CURLOPT_CONNECTTIMEOUT
long数值类型，设置连接服务器最长时间，时间单位为s；当置为0时表示无限长。

CURLOPT_MAX_RECV_SPEED_LARGE
curl_off_t类型数据，指定下载过程中最大速度，单位bytes/s。

CURLOPT_HEADERFUNCTION
函数指针类型，该选项设置一个处理接收到的header数据的回调函数，函数原型为：
size_t function( void *ptr, size_t size, size_t nmemb, void *stream)；
其中，ptr指向接收到的header头数据，数据大小为size*nmemb，stream指向调用CURLOPT_WRITEHEADER选项设置的参数。该回调函数应返回实际处理的数据量大小，或者出错返回-1。

CURLOPT_WRITEFUNCTION
函数指针类型，该选项设置一个处理接收到的下载数据的回调函数，函数原型为：
size_t function( void *ptr, size_t size, size_t nmemb, void *stream);
其中，ptr指向接收到的数据，数据大小为size*nmemb，stream指向调用CURLOPT_WRITEDATA选项设置的参数。
如果函数指针置为NULL，则会调用默认的函数，将数据写入到由CURLOPT_WRITEDATA指定的FILE*中。

CURLOPT_HTTPHEADER
curl_slist结构体类型，该选项自定义请求头信息。

CURLOPT_NOPROGRESS
布尔值类型，设置该值为非零值关闭PHP为CRUL传输显示的进度条。

void curl_easy_reset(CURL *handle )
重新初始化CURL句柄的选项设置。

CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, … )
查询CRUL会话的内部信息，具体说明请参考curl自带文档。

void curl_easy_cleanup(CURL * handle )
该函数与curl_easy_init函数成对出现，handle即为调用curl_easy_init返回的句柄。该函数在CURL会话结束退出时调用，之后handle无效。

3.8 关于密码
客户端向服务器发送请求时，许多协议都要求提供用户名与密码。libcurl提供了多种方式来设置它们。

3.8.1 一些协议支持在URL中直接指定用户名和密码，类似于:protocol://user:[e-mail]/path/。libcurl能正确的识别这种URL中的用户名与密码并执行相应的操作。如果你提供的用户名和密码中有特殊字符，首先应该对其进行URL编码。
3.8.2 也可以通过CURLOPT_USERPWD属性来设置用户名与密码。参数是格式如 “user:password ”的字符串：

curl_easy_setopt(easy_handle, CURLOPT_USERPWD, “user_name:password”);

3.8.3 （下面这几段文字我理解地模模糊糊）有时候在访问代理服务器的时候，可能时时要求提供用户名和密码进行用户身份验证。这种情况下，libcurl提供了另一个属性CURLOPT_PROXYUSERPWD：

curl_easy_setopt(easy_handle, CURLOPT_PROXYUSERPWD, “user_name:password”);

3.8.4 在UNIX平台下，访问FTP的用户名和密码可能会被保存在$HOME/.netrc文件中。libcurl支持直接从这个文件中获取用户名与密码：

curl_easy_setopt(easy_handle, CURLOPT_NETRC, 1L);

3.8.5 在使用SSL时，可能需要提供一个私钥用于数据安全传输，通过CURLOPT_KEYPASSWD来设置私钥：

curl_easy_setopt(easy_handle, CURLOPT_KEYPASSWD, “keypassword”);

4.curl_easy_perform 函数说明（error 状态码）
该函数完成curl_easy_setopt指定的所有选项，本节重点介绍curl_easy_perform的返回值。返回0意味一切ok，非0代表错误发生。主要错误码说明：
4.1 CURLE_OK 任务完成一切都好

4.2 CURLE_UNSUPPORTED_PROTOCOL – 不支持的协议，由URL的头部指定

4.3 CURLE_COULDNT_CONNECT – 不能连接到remote 主机或者代理

4.4 CURLE_REMOTE_ACCESS_DENIED – 访问被拒绝

4.5 CURLE_HTTP_RETURNED_ERROR – Http返回错误

4.6 CURLE_READ_ERROR – 读本地文件错误

5【实例】
5.1 获取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("Usage : file <url>;\n");        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;}编译gcc  get_http.c  -o get_http –lcurl./ get_http www.baidu.com

5.2 网页下载保存实例
// 采用CURLOPT_WRITEFUNCTION 实现网页下载保存功能

#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);}编译gcc  save_http.c  -o save_http –lcurl./ save_http www.baidu.com  /tmp/baidu

5.3 进度条实例??显示文件下载进度

// 采用CURLOPT_NOPROGRESS， CURLOPT_PROGRESSFUNCTION    CURLOPT_PROGRESSDATA 实现文件传输进度提示功能//函数采用了gtk库，故编译时需指定gtk库//函数启动专门的线程用于显示gtk 进度条bar#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;}编译export PKG_CONFIG_PATH=/usr/lib/pkgconfig/gcc progress.c –o progress ` pkg-config --libs –cflags gtk+-2..0` -lcurl –lgthread-2.0./ progress  http://software.sky-union.cn/index.asp

5.4 断点续传实例
//采用CURLOPT_RESUME_FROM_LARGE 实现文件断点续传功能

#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 , "http://software.sky-union.cn/index.asp","/work/index.asp",1,3);       curl_easy_cleanup(curlhandle);       curl_global_cleanup();       return 0;}编译gcc  resume.c  -o resume –lcurl./ resume

5.5 LibCurl调试实例

//采用CURLOPT_DEBUGFUNCTION参数实现libcurl调试功能#include <stdio.h>#include <curl/curl.h>struct data {  char trace_ascii; /* 1 or 0 */};staticvoid dump(const char *text,          FILE *stream, unsigned char *ptr, size_t size,          char nohex){  size_t i;  size_t c;  unsigned int width=0x10;  if(nohex)    /* without the hex output, we can fit more on screen */    width = 0x40;  fprintf(stream, "%s, %zd bytes (0x%zx)\n", text, size, size);  for(i=0; i<size; i+= width) {    fprintf(stream, "%04zx: ", i);    if(!nohex) {      /* hex not disabled, show it */      for(c = 0; c < width; c++)        if(i+c < size)          fprintf(stream, "%02x ", ptr[i+c]);        else          fputs("   ", stream);    }    for(c = 0; (c < width) && (i+c < size); c++) {      /* check for 0D0A; if found, skip past and start a new line of output */      if (nohex && (i+c+1 < size) && ptr[i+c]==0x0D && ptr[i+c+1]==0x0A) {        i+=(c+2-width);        break;      }      fprintf(stream, "%c",              (ptr[i+c]>=0x20) && (ptr[i+c]<0x80)?ptr[i+c]:'.');      /* check again for 0D0A, to avoid an extra \n if it's at width */      if (nohex && (i+c+2 < size) && ptr[i+c+1]==0x0D && ptr[i+c+2]==0x0A) {        i+=(c+3-width);        break;      }    }    fputc('\n', stream); /* newline */  }  fflush(stream);}staticint my_trace(CURL *handle, curl_infotype type,             char *data, size_t size,             void *userp){  struct data *config = (struct data *)userp;  const char *text;  (void)handle; /* prevent compiler warning */  switch (type) {  case CURLINFO_TEXT:    fprintf(stderr, "== Info: %s", data);  default: /* in case a new one is introduced to shock us */    return 0;  case CURLINFO_HEADER_OUT:    text = "=> Send header";    break;  case CURLINFO_DATA_OUT:    text = "=> Send data";    break;  case CURLINFO_SSL_DATA_OUT:    text = "=> Send SSL data";    break;  case CURLINFO_HEADER_IN:    text = "<= Recv header";    break;  case CURLINFO_DATA_IN:    text = "<= Recv data";    break;  case CURLINFO_SSL_DATA_IN:    text = "<= Recv SSL data";    break;  }  dump(text, stderr, (unsigned char *)data, size, config->trace_ascii);  return 0;}int main(void){  CURL *curl;  CURLcode res;  struct data config;  config.trace_ascii = 1; /* enable ascii tracing */