libcurl

libcurl

libcurl主要功能就是用不同的協議連接和溝通不同的伺服器~也就是相當封裝了的sockPHP 支持libcurl(允許你用不同的協議連接和溝通不同的伺服器)。, libcurl當前支持http, https, ftp, gopher, telnet, dict, file, 和ldap 協議。libcurl同樣支持HTTPS證書授權,HTTP POST, HTTP PUT, FTP 上傳(當然你也可以使用PHP的ftp擴展), HTTP基本表單上傳,代理,cookies,和用戶認證。

簡介


為了使用CURL函數你需要安裝CURL包。PHP需要你使用CURL 7.0.2-beta或更高版。如果CURL的版本低於7.0.2-beta,PHP將不工作。
要使用PHP的CURL支持,你必須用帶有--with-curl[=DIR]參數重新編譯PHP(DIR是包含庫和頭文件的目錄)。
這些函數是在PHP 4.0.2中新增得。
一旦你編譯了帶有CURL支持的PHP,你可以使用curl函數。基本思路是:你使用curl_init()函數初始化 CURL會話,而後你可以設置你的所有選項,通過curl_exec()函數執行,最後你可以作用curl_close()函數來結束你的會話。以下是一個例子:是把PHP的主頁取回放到一個文件中。
例 1. 使用PHP的CURL模塊取回PHP主頁
$ch = curl_init ("http://www.php..net/");
$fp = fopen ("php_homepage.txt", "w");
curl_setopt ($ch, CURLOPT_FILE, $fp);
curl_setopt ($ch, CURLOPT_HEADER, 0);
curl_exec ($ch);
curl_close ($ch);
fclose ($fp);
?>

目錄列表


curl_init — 初始化一個CURL會話
curl_setopt — 為CURL調用設置一個選項
curl_exec — 執行一個CURL會話
curl_close — 關閉一個CURL會話
curl_version — 返回當前CURL版本
* curl擴展的安裝
PHP已經內置有php_curl.dll,在ext目錄下,此DLL用於支持SSL和zlib.
在php.ini中找到有extension=php_curl.dll, 去掉前面的註釋.
設置extension_dir=你的php的ext目錄(例如c:\php\ext)
把ext目錄下的libeay32.dll, ssleay32.dll, php5ts.dll, php_curl.dll 都拷貝到system32目錄下,重啟apache即可。
curl_init
curl_init -- 初始化一個CURL會話

描述


int curl_init ([string url])
curl_init()函數將初始化一個新的會話,返回一個CURL句柄供curl_setopt(), curl_exec(),和 curl_close() 函數使用。如果可選參數被提供,那麼CURLOPT_URL選項將被設置成這個參數的值。你可以使用curl_setopt()函數人工設置。
例 1. 初始化一個新的CURL會話,且取回一個網頁
$ch = curl_init();
curl_setopt ($ch, CURLOPT_URL, "http://www.zend..com/");
curl_setopt ($ch, CURLOPT_HEADER, 0);
curl_exec ($ch);
curl_close ($ch);
?>
參見:curl_close(), curl_setopt()
* curl_setopt
curl_setopt -- 為CURL調用設置一個選項
描述
bool curl_setopt (int ch, string option, mixed value)
curl_setopt()函數將為一個CURL會話設置選項。option參數是你想要的設置,value是這個選項給定的值。
下列選項的值將被作為長整形使用(在option參數中指定):
CURLOPT_INFILESIZE: 當你上傳一個文件到遠程站點,這個選項告訴PHP你上傳文件的大小。
CURLOPT_VERBOSE: 如果你想CURL報告每一件意外的事情,設置這個選項為一個非零值。
CURLOPT_HEADER: 如果你想把一個頭包含在輸出中,設置這個選項為一個非零值。
CURLOPT_NOPROGRESS: 如果你不會PHP為CURL傳輸顯示一個進程條,設置這個選項為一個非零值。

使用總結


一。下載安裝
1.下載最新版本,由於公司的機器安裝rpm有依賴關係,所以直接下載了source
2.編譯。解壓後進入curl的目錄,直接執行 make all 就行。
3.等待編譯結束后,可以查看目錄結構。
curl/include/curl :頭文件目錄(一般只要包含curl.h即可)
curl/lib/.lib/ : lib文件目錄(有libcurl.a,注意,如果這兩個文件在同一目錄下,-lcurl默認是鏈接.so滴)
二。函數簡要說明
在基於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程序都要使用它。
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)void curl_global_cleanup(void);
描述:在結束libcurl使用的時候,用來對curl_global_init做的工作清理。類似於close的函數。
3.char *curl_version( );
描述: 列印當前libcurl庫的版本。
4)CURL *curl_easy_init( );
描述:
curl_easy_init用來初始化一個CURL的指針(有些像返回FILE類型的指針一樣). 相應的在調用結束時要用curl_easy_cleanup函數清理.
一般curl_easy_init意味著一個會話的開始. 它的返回值一般都用在easy系列的函數中.
5)void curl_easy_cleanup(CURL *handle);
描述:
這個調用用來結束一個會話。與curl_easy_init配合著用.
參數:
CURL類型的指針.
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手冊.
7)CURLcode curl_easy_perform(CURL *handle);
描述:這個函數在初始化CURL類型的指針 以及curl_easy_setopt完成後調用. 就像字面的意思所說perform就像是個舞台。讓我們設置的
option 運作起來。參數:
CURL類型的指針.
三。重要函數詳解
1)curl_easy_setopt函數介紹
本節主要介紹curl_easy_setopt中跟http相關的參數。注意本節的闡述都是以libcurl作為主體,其它為客體來闡述的。
1. CURLOPT_URL
設置訪問URL
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. CURLOPT_HEADERFUNCTION,CURLOPT_HEADERDATA
回調函數原型為 size_t function( void *ptr, size_t size,size_t nmemb, void *stream); libcurl一旦接收到http 頭部數據后將調用該函數。CURLOPT_HEADERDATA傳遞指針給libcurl,該指針表明CURLOPT_HEADERFUNCTION 函數的stream指針的來源。
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指針來源。
5. CURLOPT_NOPROGRESS,CURLOPT_PROGRESSFUNCTION,CURLOPT_PROGRESSDATA
跟數據傳輸進度相關的參數。CURLOPT_PROGRESSFUNCTION 指定的函數正常情況下每秒被libcurl調用一次,為了使CURLOPT_PROGRESSFUNCTION被調用,CURLOPT_NOPROGRESS必須被設置為false,CURLOPT_PROGRESSDATA指定的參數將作為CURLOPT_PROGRESSFUNCTION指定函數的第一個參數
6. CURLOPT_TIMEOUT,CURLOPT_CONNECTIONTIMEOUT:
CURLOPT_TIMEOUT 由於設置傳輸時間,CURLOPT_CONNECTIONTIMEOUT 設置連接等待時間
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,指定你希望開始傳遞的
偏移量。
2)curl_easy_perform 函數說明(error 狀態碼)
該函數完成curl_easy_setopt指定的所有選項,本節重點介紹curl_easy_perform的返回值。返回0意味一切ok,非0代表錯誤發生。主要錯誤碼說明:
1. CURLE_OK
任務完成一切都好
2 CURLE_UNSUPPORTED_PROTOCOL
不支持的協議,由URL的頭部指定
3 CURLE_COULDNT_CONNECT
不能連接到remote 主機或者代理
4 CURLE_REMOTE_ACCESS_DENIED
訪問被拒絕
5 CURLE_HTTP_RETURNED_ERROR
Http返回錯誤
6 CURLE_READ_ERROR
讀本地文件錯誤
===========================================================
本篇主要是一些使用示例,由於部分代碼是來源網上,原作者已經無法考證,所以如有原作者看到,可以告訴我,我給註明~
上一篇鏈接–libcurl的使用總結(一)
另:文末附有所有代碼的打包下載,均在suse 10下編譯運行通過
1.下載文件到本地
#include
#include
#include
#include
#include “curl/curl.h”
using namespace std;
static char errorBuffer[CURL_ERROR_SIZE];
static int writer(char *, size_t, size_t, string *);
static bool init(CURL *&, char *,string *);
int main()
{
CURL *conn = NULL;
CURLcode code;
curl_global_init(CURL_GLOBAL_DEFAULT);
char* url=”172.16.211.50/cc2/cc/getfile.php”;
if (!init(conn,url,&buffer ))
{
fprintf(stderr, “Connection initializion failed\n”);
exit(EXIT_FAILURE);
}
code = curl_easy_perform(conn);
if (code != CURLE_OK)
{
fprintf(stderr, “Failed to get ‘%s’ [%s]\n”, url, errorBuffer);
exit(EXIT_FAILURE);
}
FILE * file = fopen(“1.gif”,”wb”);
fseek(file,0,SEEK_SET);
fwrite(buffer.c_str(),1,buffer.size(),file);
fclose(file);
curl_easy_cleanup(conn);
printf(“%s\n”,buffer.c_str());
return 0;
}
static bool init(CURL *&conn, char *url,string *p_buffer)
{
CURLcode code;
conn = curl_easy_init();
if (conn == NULL)
{
fprintf(stderr, “Failed to create CURL connection\n”);
exit(EXIT_FAILURE);
}
code = curl_easy_setopt(conn, CURLOPT_ERRORBUFFER, errorBuffer);
if (code != CURLE_OK)
{
fprintf(stderr, “Failed to set error buffer [%d]\n”, code);
return false;
}
code = curl_easy_setopt(conn, CURLOPT_URL, url);
if (code != CURLE_OK)
{
fprintf(stderr, “Failed to set URL [%s]\n”, errorBuffer);
return false;
}
code = curl_easy_setopt(conn, CURLOPT_FOLLOWLOCATION, 1);
if (code != CURLE_OK)
{
fprintf(stderr, “Failed to set redirect option [%s]\n”, errorBuffer);
return false;
}
code = curl_easy_setopt(conn, CURLOPT_WRITEFUNCTION, writer);
if (code != CURLE_OK)
{
fprintf(stderr, “Failed to set writer [%s]\n”, errorBuffer);
return false;
}
code = curl_easy_setopt(conn, CURLOPT_WRITEDATA, p_buffer);
if (code != CURLE_OK)
{
fprintf(stderr, “Failed to set write data [%s]\n”, errorBuffer);
return false;
}
return true;
}
static int writer(char *data, size_t size, size_t nmemb, string *writerData)
{
unsigned long sizes = size * nmemb;
if (writerData == NULL) return 0;
writerData->append(data, sizes);
return sizes;
}
2.通過multipart/form-data方式上傳文件
模仿的HTML代碼:
charset=gb2312″>
File Upload
C代碼:
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include “curl/curl.h”
using namespace std;
#define MAX_BUFF_LEN 1048576
#define POST_URL “172.16.211.50/cc2/cc/setfile.php”
int check_file_existed(char *filename)
{
struct stat st;
return (stat( filename, &st )==0 && S_ISREG(st. st_mode));
}
int get_file_size(char *filename)
{
int file_len = 0;
int fd = 0;
fd = open(filename, O_RDONLY);
if(fd < 0)
{
perror(“open”);
exit(-1);
}
file_len = lseek(fd, 0, SEEK_END);
if(file_len < 0)
{
perror(“lseek”);
exit(-1);
}
return file_len;
}
int http_post_file(const char *url, const char *filename)
{
CURL *curl = NULL;
CURLcode res;
int timeout = 5;
struct curl_httppost *post=NULL;
struct curl_httppost *last=NULL;
struct curl_slist *headerlist=NULL;
if(filename == NULL || url == NULL)
return -1;
printf(“URL: %s\n”, url);
printf(“filename: %s\n”, filename);
if( curl_formadd(&post, &last, CURLFORM_COPYNAME, “content”,
CURLFORM_FILE, filename, CURLFORM_END) != 0)
{
fprintf(stderr, “curl_formadd error.\n”);
goto out;
}
curl_formadd(&post, &last,
CURLFORM_COPYNAME, “submit”,
CURLFORM_COPYCONTENTS, “OK”,
CURLFORM_END);
//curl_global_init(CURL_GLOBAL_ALL);
curl = curl_easy_init();
if(curl == NULL)
{
fprintf(stderr, “curl_easy_init() error.\n”);
goto out;
}
curl_easy_setopt(curl, CURLOPT_HEADER, 0);
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_HTTPPOST, post);
curl_easy_setopt(curl, CURLOPT_TIMEOUT, timeout);
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0);
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 1);
res = curl_easy_perform(curl);
if(res != CURLE_OK)
{
fprintf(stderr, “curl_easy_perform[%d] error.\n”, res);
goto out;
}
curl_easy_cleanup(curl);
out:
curl_formfree(post);
//curl_global_cleanup();
return 0;
}
int main(int argc, char *argv[])
{
char buff[MAX_BUFF_LEN]={0};
//Check Argument
//argv[1] upload filename
if(argc != 2)
{
fprintf(stderr, “Usage: %s filename\n”, argv[0]);
return 1;
}
//Check File Existed
if(!check_file_existed(argv[1]))
{
fprintf(stderr, “File Not Existed.\n”);
return 1;
}
//Check File Size
if( get_file_size(argv[1]) >= MAX_BUFF_LEN)
{
fprintf(stderr, “File Size is Big!\n”);
return 1;
}
//POST File
http_post_file(POST_URL, argv[1]);
return 0;
}
3)makefile的編寫(注意鏈接的庫,及庫的順序)
#=========================================
# FileName: makefile
# Version: 1.0
# LastChange: 2010-03-09 14:46:48
# Description:
# History:
#=========================================
CXX = g++
TARGET = test_download test_post
C_FLAGS += -g -Wall
INC+=-I../include -I /home/dantezhu/curl-7.20.0/include/
LIB+=-L. -lcurl -lz -lrt -lcrypto -lssl
LIB_FLAGS = -pthread
all: $(TARGET)
test_download: test_download.o
$(CXX) -o $@ $^ $(LIB_FLAGS) $(LIB) $(C_FLAGS)
test_post: test_post.o
$(CXX) -o $@ $^ $(LIB_FLAGS) $(LIB) $(C_FLAGS)
.cpp.o:
$(CXX) -c -o $*.o $(INC) $(C_FLAGS) $*.cpp
.cc.o:
$(CXX) -c -o $*.o $(INC) $(C_FLAGS) $*.cc
clean:
-rm -f *.o $(TARGET)

注意


:PHP自動設置這個選項為非零值,你應該僅僅為了調試的目的來改變這個選項。
CURLOPT_NOBODY: 如果你不想在輸出中包含body部分,設置這個選項為一個非零值。
CURLOPT_FAILONERROR: 如果你想讓PHP在發生錯誤(HTTP代碼返回大於等於300)時,不顯示,設置這個選項為一人非零值。默認行為是返回一個正常頁,忽略代碼。
CURLOPT_UPLOAD: 如果你想讓PHP為上傳做準備,設置這個選項為一個非零值。
CURLOPT_POST: 如果你想PHP去做一個正規的HTTP POST,設置這個選項為一個非零值。這個POST是普通的 application/x-www-from-urlencoded 類型,多數被HTML表單使用。
CURLOPT_FTPLISTONLY: 設置這個選項為非零值,PHP將列出FTP的目錄名列表。
CURLOPT_FTPAPPEND: 設置這個選項為一個非零值,PHP將應用遠程文件代替覆蓋它。
CURLOPT_NETRC: 設置這個選項為一個非零值,PHP將在你的 ~./netrc 文件中查找你要建立連接的遠程站點的用戶名及密碼。
CURLOPT_FOLLOWLOCATION: 設置這個選項為一個非零值(象 "Location: ")的頭,伺服器會把它當做HTTP頭的一部分發送(注意這是遞歸的,PHP將發送形如 "Location: "的頭)。
CURLOPT_PUT: 設置這個選項為一個非零值去用HTTP上傳一個文件。要上傳這個文件必須設置CURLOPT_INFILE和CURLOPT_INFILESIZE選項.
CURLOPT_MUTE: 設置這個選項為一個非零值,PHP對於CURL函數將完全沉默。
CURLOPT_TIMEOUT: 設置一個長整形數,作為最大延續多少秒。
CURLOPT_LOW_SPEED_LIMIT: 設置一個長整形數, 速度閥值, 當速度低於這個值, 時間又超過CURLOPT_LOW_SPEED_TIME設定的秒數, 則返回並報錯。
CURLOPT_LOW_SPEED_TIME: 設置一個長整形數,低速時間閥值, 當設定的時間內, 速度低於 CURLOPT_LOW_SPEED_LIMIT設定的位元組數, 則返回並報錯。
此兩項可以用來在easy模式下判斷文件傳輸狀態的網路超時。
CURLOPT_RESUME_FROM: 傳遞一個包含位元組偏移地址的長整形參數,(你想轉移到的開始表單)。
CURLOPT_SSLVERSION: 傳遞一個包含SSL版本的長參數。默認PHP將被它自己努力的確定,在更多的安全中你必須手工設置。
CURLOPT_TIMECONDITION: 傳遞一個長參數,指定怎麼處理CURLOPT_TIMEVALUE參數。你可以設置這個參數為TIMECOND_IFMODSINCE 或 TIMECOND_ISUNMODSINCE。這僅用於HTTP。
CURLOPT_TIMEVALUE: 傳遞一個從1970-1-1開始到現在的秒數。這個時間將被CURLOPT_TIMEVALUE選項作為指定值使用,或被默認TIMECOND_IFMODSINCE使用。
下列選項的值將被作為字元串
CURLOPT_URL: 這是你想用PHP取回的URL地址。你也可以在用curl_init()函數初始化時設置這個選項。
CURLOPT_USERPWD: 傳遞一個形如[username]:[password]風格的字元串,作用PHP去連接。
CURLOPT_PROXYUSERPWD: 傳遞一個形如[username]:[password] 格式的字元串去連接HTTP代理。
CURLOPT_RANGE: 傳遞一個你想指定的範圍。它應該是"X-Y"格式,X或Y是被除外的。HTTP傳送同樣支持幾個間隔,用逗句來分隔(X-Y,N-M)。
CURLOPT_POSTFIELDS: 傳遞一個作為HTTP “POST”操作的所有數據的字元串。
CURLOPT_REFERER: 在HTTP請求中包含一個"referer"頭的字元串。
CURLOPT_USERAGENT: 在HTTP請求中包含一個"user-agent"頭的字元串。
CURLOPT_FTPPORT: 傳遞一個包含被ftp "POST"指令使用的IP地址。這個POST指令告訴遠程伺服器去連接我們指定的IP地址。這個字元串可以是一個IP地址,一個主機名,一個網路界面名(在UNIX下),或是'-’(使用系統默認IP地址)。
CURLOPT_COOKIE: 傳遞一個包含HTTP cookie的頭連接。
CURLOPT_SSLCERT: 傳遞一個包含PEM格式證書的字元串。
CURLOPT_SSLCERTPASSWD: 傳遞一個包含使用CURLOPT_SSLCERT證書必需的密碼。
CURLOPT_COOKIEFILE: 傳遞一個包含cookie數據的文件的名字的字元串。這個cookie文件可以是Netscape格式,或是堆存在文件中的HTTP風格的頭。
CURLOPT_CUSTOMREQUEST: 當進行HTTP請求時,傳遞一個字元被GET或HEAD使用。為進行DELETE或其它操作是有益的,更Pass a string to be used instead of GET or HEAD when doing an HTTP request. This is useful for doing or another, more obscure, HTTP request.
注意: 在確認你的伺服器支持命令先不要去這樣做。
下列的選項要求一個文件描述(通過使用fopen()函數獲得):
CURLOPT_FILE: 這個文件將是你放置傳送的輸出文件,默認是STDOUT.
CURLOPT_INFILE: 這個文件是你傳送過來的輸入文件。
CURLOPT_WRITEHEADER: 這個文件寫有你輸出的頭部分。
CURLOPT_STDERR: 這個文件寫有錯誤而不是stderr。
* curl_exec
curl_exec -- 執行一個CURL會話
描述
bool curl_exec (int ch)
在你初始化一個CURL會話,及為這個會話設置了所有的選項后,這個函數將被調用。它的目的僅僅是執行預先確定的CURL會話(通過給定的ch參數)。
* curl_close
curl_close -- 關閉一個CURL會話
描述
void curl_close (int ch)
這個函數關閉一個CURL會話,並且釋放所有的資源。CURL句柄(ch參數)也被刪除。
* curl_version
curl_version -- 返回當前CURL版本
描述
string curl_version (void)
curl_version()函數返回一個包含CURL版本的字元串。