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 函数调用时还没调用，它讲由lib curl库自动完成。

参数：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); 函数将在lib curl接收到数据后被调用，因此函数多做数据保存的功能，如处理下载文件。CURLOPT_WRITEDATA 用于表明CURLOPT_WRITEFUNCTION函数中的stream 指针的来源。

3. CURLOPT_HEADERFUNCTION，CURLOPT_HEADERDATA

回调函数原型为 size_t function( void *ptr, size_t size,size_t nmemb, void *stream); lib curl一旦接收到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 指定的函数正常情况下每秒被lib curl调用一次，为了使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 * 参数传递给lib curl，用于指明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参数给lib curl，指定你希望开始传递的

偏移量。

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

读本地文件错误

===========================================================

本篇主要是一些使用示例，由于部分代码是来源网上，原作者已经无法考证，所以如有原作者看到，可以告诉我，我给注明~

上一篇链接–lib curl的使用总结（一）

另：文末附有所有代码的打包下载，均在suse 10下编译运行通过

1.下载文件到本地

/*==============================================

# FileName: test_download.cpp

# Version: 1.0

# LastChange: 2010-03-09 14:20:44

# Description:

# History:

============================================*/

#include <iostream>

#include <string>

#include <vector>

#include <map>

#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;

string buffer;

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;

}

注意

编辑

：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参数)也被删除。