cURL

導入

Windowsでは、

• libeay32.dll (OpenSSL 1.1以降ならば、libcrypto-*.dll)
• ssleay32.dll (OpenSSL 1.1以降ならば、libssl-*.dll)

の2つのファイルにPATHが通っていなければなりません。これらのファイルは既定ではphp.exeと同一のディレクトリにあります。もしcURLの関数の呼び出しで「PHP Fatal error: Call to undefined function curl_init()」のように、または定数の呼び出しで「PHP Fatal error: Uncaught Error: Undefined constant "***"」のようにエラーとなるならば、このPATHの設定が原因です。PHP: インストール手順 - Manual

基本的な使用方法

cURLは、基本的に次の手順で使用します。

1. セッションの初期化 … curl_init()
2. オプションの設定 … curl_setopt()
3. 転送の実行 … curl_exec()
4. セッションの終了 … curl_close()

同一のクエリでも異なる結果を返す場合、キャッシュの有効期限を指示するようにします。さもなくばブラウザなどのキャッシュが参照されてしまい、サーバにリクエストされないことがあります。

file_get_contents()との比較

file_get_contents()ならば、

$response = file_get_contents( $url );

で$urlの内容を取得できます。curlでこれと同じ結果を得るには、

$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, TRUE );

$response = curl_exec( $ch );
curl_close( $ch );

のようにします。

file_get_contents()のリクエスト先にはファイル名を使用できますが、curl_init()のそれはつねにURLです。よってホスト名から指定する必要があり、さもなくばcurl_error()では「Could not resolve host: xx; Host not found」というエラーとなります。

転送オプション (curl_setopt)

curl_setopt()で、転送時のオプションを設定できます。

bool curl_setopt ( resource $ch , int $option , mixed $value )

$optionには下表の値を、$valueにはそのオプションの値を指定します。

設定するオプションが大量にある場合には、それらを配列で一括して設定できるcurl_setopt_array()があります。

bool curl_setopt_array ( resource $ch , array $options )

エラーの確認 (curl_error)

直近に発生したエラーについて、curl_error()によって文字列でその情報を取得できます。

string curl_error ( resource $ch )

$response = curl_exec( $ch );
if( $response === FALSE )
{
    // エラー文字列を出力する
    echo curl_error( $ch );
}

エラー発生の判定

エラー発生の判定は、curl_exec()の戻り値で行えます。しかしオプションでCURLOPT_RETURNTRANSFERを指定していると、成功時には文字列が返されるため

$response = curl_exec( $ch );
if( ! $response )

のようにエラーを判定しようとすると、文字列の'0'や空の文字列が返されたときに誤判定してしまいます。よって前述のように比較演算子 (===) を用いて、FALSEと厳密に判定するようにします。

メソッド

GETメソッド

既定でGETのため、これを使用するのに特別な指定は必要ありません。クエリもURLに含めるだけです。

$params = array( 'data1'=>123, 'data2'=>'foo' );

$ch = curl_init( $url.'?'.http_build_query( $params ) );

curl_exec( $ch );
curl_close( $ch );

POSTメソッド

POSTメソッドを使用するには、CURLOPT_POSTFIELDで送信するデータを指定します。

curl_setopt( $ch, CURLOPT_POSTFIELDS, $params );

CURLOPT_POSTFIELDを指定するとCURLOPT_POSTも暗黙的に指定されるため、これを別に指定する必要はありません。逆にこれをFALSEとしてもその指定は無視されるため、POSTを用いないならばCURLOPT_POSTFIELDを削除します。

$params = array( 'data1'=>123, 'data2'=>'foo' );

$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_POSTFIELDS, $params );

curl_exec( $ch );
curl_close( $ch );

Content-Typeの値

$paramsの型によって、リクエストされるときのContent-Typeが変化します。

multipart/form-data

パラメータの名前と値を「'name'=>value」とした連想配列とします。このとき値をURLエンコードする必要はありません。

$params = array( 'a'=>'abc', 'b'=>100, 'c'=>'&' );

POST /sample.php HTTP/1.1
Host: localhost
Accept: */*
Content-Length: 256
Expect: 100-continue
Content-Type: multipart/form-data; boundary=----------------------------aaaaaaaaaaaa

配列でデータを渡すとき、その要素の文字列は「@」で始めてはなりません。それはファイルを指定するときの書式であり、そのファイルの指定が正しくなければ通信に失敗します。そしてcurl_error()では「failed creating formpost data」または「couldn't open file "xx"」が返されます。

フィールドを配列で渡すときは、curl_setopt()で

curl_setopt( $ch, CURLOPT_HTTPHEADER, array( 'Content-Type: application/x-www-form-urlencoded' ) );

のようにヘッダを明示的に指定しても、リクエストは

Content-Type: application/x-www-form-urlencoded; boundary=----------------------------xxxxxxxxxxxx

のようにmultipart/form-dataの形式になります。

application/x-www-form-urlencoded

パラメータの名前と値を「name=value」とした文字列とします。値はURLエンコードし、複数のパラメータは&で連結します。

$params = 'a=abc&b=100&c='.rawurlencode( '&' );

POST /sample.php HTTP/1.1
Host: localhost
Accept: */*
Content-Length: 256
Content-Type: application/x-www-form-urlencoded

ファイルの送信

ファイルを送信するには、ファイル名の先頭を@としてフルパスで指定します。そのときファイル タイプを明示するには、ファイル名の後に「;type=MIME Type」の形式で記述します。PHP: curl_setopt - Manual

データは必ず配列でなければなりません。

ファイルの指定に誤りがあるときは、curl_error()で「failed creating formpost data」というエラーとなります。

$params = array( 'foo'=>'@/home/user/sample.png' );

$params = array( 'foo'=>'@C:/sample.png' ); // Windows環境でのローカル

ファイルを受信する側は、$_FILESでデータにアクセスできます。

HEADメソッド

HEADメソッドを使用するには、curl_setopt()でCURLOPT_NOBODYをTRUEと指定します。こうすることで出力から本文が削除され、メソッドはHEADとなります。

curl_setopt( $ch, CURLOPT_NOBODY, TRUE );

DELETEメソッド

DELETEメソッドを使用するには、curl_setopt()でCURLOPT_CUSTOMREQUESTを'DELETE'と指定します。

$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'DELETE' );

curl_exec( $ch );
curl_close( $ch );

通信に関する情報の取得 (curl_getinfo)

curl_getinfo()で、直近の通信に関する情報を取得できます。

mixed curl_getinfo ( resource $ch [, int $opt = 0 ] )

$optで取得する情報を指定できます。それを省略すると、すべての値が配列で返されます。

なお取得対象のcURLハンドルがすでに閉じられていると、Warning: curl_getinfo(): 2 is not a valid cURL handle resourceのように警告され処理に失敗します。

curl_setopt($ch, CURLINFO_HEADER_OUT, TRUE);

第2引数で取得する情報を指定すると、

$info = curl_getinfo( $ch, CURLINFO_EFFECTIVE_URL );

echo $info;
// http://www.yahoo.com/

のように結果を得られ、指定しないと次のようになります。

$info = curl_getinfo( $ch );

print_r( $info );
// Array
// (
//     [url] => http://www.yahoo.com/
//     [content_type] => text/html;charset=utf-8
//     [http_code] => 200
//     [header_size] => 2402
//     [request_size] => 52
//     [filetime] => -1
//     [ssl_verify_result] => 0
//     [redirect_count] => 0
//     [total_time] => 2.262
//     [namelookup_time] => 0.031
//     [connect_time] => 0.171
//     [pretransfer_time] => 0.171
//     [size_upload] => 0
//     [size_download] => 226941
//     [speed_download] => 100327
//     [speed_upload] => 0
//     [download_content_length] => -1
//     [upload_content_length] => 0
//     [starttransfer_time] => 0.593
//     [redirect_time] => 0
//     [request_header] => GET / HTTP/1.1\r\nHost: www.yahoo.com\r\nAccept: */*\r\n\r\n
// )

ヘッダの取得

期待する結果を得られない場合には、ヘッダを確認するのが有効です。

$ch = curl_init( 'http://example.com' );
curl_setopt( $ch, CURLOPT_HEADER, TRUE );
curl_setopt( $ch, CURLINFO_HEADER_OUT, TRUE );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, TRUE );

$response = curl_exec( $ch );

header( 'Content-Type: text/plain; charset=utf-8' );
echo curl_getinfo( $ch , CURLINFO_HEADER_OUT ); // リクエスト ヘッダ
echo $response; // レスポンス ヘッダを最初に含む、すべての結果
curl_close( $ch );

並列通信 (curl_multi)

前処理

resource curl_multi_init ( void )

int curl_multi_add_handle ( resource $mh , resource $ch )

実行

curl_multi_exec()で処理を実行します。

int curl_multi_exec ( resource $mh , int &$still_running )

$still_runningで、処理中のハンドルの数を確認できます。よってすべての処理の完了を待つには、これが0となるまでループさせます。

データの取得

cURLハンドルからデータを文字列で取得するには、curl_setopt()でCURLOPT_RETURNTRANSFERを指定し、curl_multi_getcontent()で結果を取得します。

string curl_multi_getcontent ( resource $ch )

これはCURLOPT_RETURNTRANSFERが指定されているときの、curl_exec()の戻り値と同じです。

情報の取得

array curl_multi_info_read (
    resource $mh
    [, int &$msgs_in_queue = NULL ]
    )

取得する結果が存在しないときは、FALSEが返されます。

print_r( curl_multi_info_read( $mh ) );
// Array
// (
//     [msg] => 1
//     [result] => 0
//     [handle] => Resource id #2
// )

['result']は下表の値のいずれかです。その値は定数「CURLE_*」で定義され、その意味はlibcurl - Error Codesにあります。

後処理

次の3つの処理が必要です。

1. マルチハンドルからのcURLハンドルの削除
2. マルチハンドルのクローズ
3. cURLハンドルのクローズ

マルチハンドルからcURLハンドルを削除するには、curl_multi_remove_handle()を呼び出します。

int curl_multi_remove_handle ( resource $mh , resource $ch )

void curl_multi_close ( resource $mh )

cURLハンドルのクローズは、curl_close()で行います。

サンプルコード

$ch1 = curl_init( $url1 );
$ch2 = curl_init( $url2 );

curl_setopt( $ch1, CURLOPT_RETURNTRANSFER, TRUE );
curl_setopt( $ch2, CURLOPT_RETURNTRANSFER, TRUE );

$mh = curl_multi_init();

curl_multi_add_handle( $mh, $ch1 );
curl_multi_add_handle( $mh, $ch2 );

$running = null;
do
{
    curl_multi_exec( $mh, $running );
} while( $running );

$response1 = curl_multi_getcontent( $ch1 );
$response2 = curl_multi_getcontent( $ch1 );

curl_multi_remove_handle( $mh, $ch1 );
curl_multi_remove_handle( $mh, $ch2 );

curl_multi_close( $mh );

curl_close( $ch1 );
curl_close( $ch2 );

より汎用的には、次のようにします。

$urls = array( $url1, $url2 );

$chs = array();
foreach( $urls as $url ) $chs[] = curl_init( $url );

$mh = curl_multi_init();
foreach( $chs as $ch )
{
    curl_setopt( $ch, CURLOPT_RETURNTRANSFER, TRUE );
    curl_setopt( $ch, CURLOPT_TIMEOUT, 1 );

    curl_multi_add_handle( $mh, $ch );
}

$running = null;
do
{
    curl_multi_exec( $mh, $running );
} while( $running );

$responses = array();
foreach( $chs as $ch )
{
    $responses[] = curl_multi_getcontent( $ch );

    curl_multi_remove_handle( $mh, $ch );
    curl_close( $ch );
}
curl_multi_close( $mh );

連続したリクエスト

前述の例ではすべての接続を同時に行おうとしますが、次の例では最大接続数を維持しながら、接続の完了を待って次の接続を行います。

次の関数は指定URLへ順次リクエストを送り、そのレスポンスのHTTPコードを出力します。

function CheckResponse( $urls, $maxConnection )
{
    $mh = curl_multi_init();
    $chs = array();

    $running = 0;
    do
    {
        if( $running < maxConnection && 0 < count( $urls ) )
        {
            $ch = curl_init( array_shift( $urls ) );
            curl_setopt( $ch, CURLOPT_NOBODY, TRUE );
            curl_setopt( $ch, CURLOPT_TIMEOUT, 30 );

            curl_multi_add_handle( $mh, $ch );
            $chs[] = $ch;
        }

        usleep( 1000 );
        curl_multi_exec( $mh, $running );

        foreach( $chs as $key=>$ch )
        {
            $info = curl_getinfo( $ch );
            if( $info[ 'http_code' ] != 0 )
            {
                echo "{$info[ 'http_code' ]} : {$info[ 'url' ]}\n";
                @ob_flush();
                @flush();

                curl_multi_remove_handle( $mh, $ch );
                curl_close( $ch );

                unset( $chs[ $key ] );
            }
        }

    } while( 0 < $running );

    print_r( curl_multi_info_read( $mh ) );
    curl_multi_close( $mh );
}

次のように呼び出します。

$urls = array(
    'http://example.com/1/',
    'http://example.com/2/',
    'http://example.com/3/',
    'http://example.com/4/',
    'http://example.com/5/',
    );
CheckResponse( $urls, 3 );

HTTPS接続

cURLは既定ではすべての認証局 (Certificate Authority : CA) を信頼しないため、HTTPS接続できません。接続を試みても失敗し、curl_error()では

SSL certificate problem, verify that the CA cert is OK. Details:
error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed

のように返されます。これを解決するには証明書を入手し、それを利用するように転送オプションで指示します。

curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, TRUE );
curl_setopt( $ch, CURLOPT_CAINFO, 'ca.crt' );

もしくは証明書の検証が不要ならば、

curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, FALSE );

として、検証自体を無効にします。

ファイルのダウンロードと保存

curl_setopt()で、CURLOPT_FILEに保存先のファイルのポインタを指定します。

$downloadPath = 'http://example.com/'; // ダウンロードするファイルのURL
$savePath = 'sample.txt';              // 保存先のファイルのパス

$ch = curl_init( $downloadPath );
$fp = fopen( $savePath, 'w' );

curl_setopt( $ch, CURLOPT_FILE, $fp );
curl_setopt( $ch, CURLOPT_HEADER, FALSE );

curl_close( $ch );
fclose( $fp );

• 導入
  • PHPのインストール
    • Apacheとの関連付け
    • 設定オプション
• 文法
  • 変数
  • データ型
    • 数値
    • 文字列
      • 正規表現
      • ヒアドキュメント
    • 配列
    • オブジェクト
  • 演算子
  • 制御構造
  • 関数
    • 関数の引数
  • クラス
  • 例外
• 日時
• ファイル
  • アップロード
  • PDF
• ネットワーク
  • HTTP
    • HTTPヘッダ
  • cURL
  • キャッシュ
    • キャッシュ無効化
  • メール送信
• セッション管理
  • セッション
  • クッキー
• データベース
  • SQLite
• HTML
• XML
  • XPath
  • SimpleXML
• JSON
• グラフィック
• バイナリ データ
• ライブラリ
  • PEAR
  • PECL
  • HTML Parser
• 外部プログラムの実行
• エラー処理
• セキュリティ
• 最適化
• サンプルコード
  • JavaScriptとの連携
  • 処理途中で出力
• ツール
  • デバッガ
• デバッグ
• フレームワーク

• お問い合わせ
• プライバシーポリシー
• サイトマップ