天天看點

LibCurl程式設計手冊以及代碼執行個體

1. LibCurl程式設計流程

在基于LibCurl的程式裡,主要采用callback function (回調函數)的形式完成傳輸任務,使用者在啟動傳輸前設定好各類參數和回調函數,當滿足條件時libcurl将調用使用者的回調函數實作特定功能。下面是利用libcurl完成傳輸任務的流程:

1.       調用curl_global_init()初始化libcurl

2.       調用 curl_easy_init()函數得到 easy interface型指針

3.       調用curl_easy_setopt設定傳輸選項

4.       根據curl_easy_setopt設定的傳輸選項,實作回調函數以完成使用者特定任務

5.       調用curl_easy_perform()函數完成傳輸任務

6.       調用curl_easy_cleanup()釋放記憶體

在整過過程中設定curl_easy_setopt()參數是最關鍵的,幾乎所有的libcurl程式都要使用它。

2. 重要函數

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類型的指針.

3. 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:[email protected]/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:

3.8.4 在UNIX平台下,通路FTP的使用者名和密碼可能會被儲存在$HOME/.netrc檔案中。libcurl支援直接從這個檔案中擷取使用者名與密碼:

3.8.5 在使用SSL時,可能需要提供一個私鑰用于資料安全傳輸,通過CURLOPT_KEYPASSWD來設定私鑰:

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

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;

    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)

////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

5.3 進度條執行個體??顯示檔案下載下傳進度

// 采用CURLOPT_NOPROGRESS, CURLOPT_PROGRESSFUNCTION    CURLOPT_PROGRESSDATA 實作檔案傳輸進度提示功能

//函數采用了gtk庫,故編譯時需指定gtk庫

//函數啟動專門的線程用于顯示gtk 進度條bar

#include <gtk/gtk.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 */

  }

  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");

  gtk_main();

編譯export PKG_CONFIG_PATH=/usr/lib/pkgconfig/

gcc progress.c –o progress ` pkg-config --libs –cflags gtk+-2..0` -lcurl –lgthread-2.0

5.4 斷點續傳執行個體

//采用CURLOPT_RESUME_FROM_LARGE 實作檔案斷點續傳功能

#include <sys/stat.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));

int main(int c, char **argv) {

       CURL *curlhandle = NULL;

       curl_global_init(CURL_GLOBAL_ALL);

       curlhandle = curl_easy_init();

       curl_easy_cleanup(curlhandle);

       curl_global_cleanup();

       return 0;

編譯gcc  resume.c  -o resume –lcurl

./ resume

5.5 LibCurl調試執行個體

//采用CURLOPT_DEBUGFUNCTION參數實作libcurl調試功能

struct data {

  char trace_ascii; /* 1 or 0 */

};

static

void 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);

    fputc('\n', stream); /* newline */

  fflush(stream);

int 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 */

  case CURLINFO_HEADER_OUT:

    text = "=> Send header";

    break;

  case CURLINFO_DATA_OUT:

    text = "=> Send data";

  case CURLINFO_SSL_DATA_OUT:

    text = "=> Send SSL data";

  case CURLINFO_HEADER_IN:

    text = "<= Recv header";

  case CURLINFO_DATA_IN:

    text = "<= Recv data";

  case CURLINFO_SSL_DATA_IN:

    text = "<= Recv SSL data";

  dump(text, stderr, (unsigned char *)data, size, config->trace_ascii);

int main(void)

  struct data config;

  config.trace_ascii = 1; /* enable ascii tracing */

繼續閱讀