HttpSocket

class HttpSocket(mixed $config = [])

CakePHP には、リクエストを簡単に行える HttpSocket クラスがあります。それは、外部のウェブサービスやリモート API との通信に役に立ちます。

リクエストの作成

異なる HTTP メソッドの多くの種類の HTTP リクエストを作成するために HttpSocket が使えます。

method HttpSocket::get($uri, $query, $request)

method HttpSocket::post($uri, $data, $request)

method HttpSocket::put($uri, $data, $request)

method HttpSocket::delete($uri, $query, $request)

method HttpSocket::patch($uri, $data, $request)

method HttpSocket::request($request)

レスポンスの処理

HttpSocket を使ったリクエストからのレスポンスは、 HttpResponse のインスタンスです。このオブジェクトは、HTTP レスポンスの内容にアクセスするための、いくつかのアクセッサーメソッドを持っています。このクラスは ArrayAccess と __toString() を実装していますので、 $http->response を配列として使用でき、リクエストメソッドの戻り値を文字列として使用できます。

$http = new HttpSocket();
$response = $http->get('https://cakephp.org');

// タイトルタグの存在をチェック
$titlePos = strpos($response->body, '<title>');

// レスポンスのステータスコードを取得
$code = $response->code;

HttpResponse は以下の属性を持ちます。

body は HTTP レスポンスのボディを返します (通常の HTML)。
headers は、ヘッダーの配列を返します。
cookies は、新しいクッキーの配列を返します (他のリクエストのクッキーは保存されません)。
httpVersion は、HTTP バージョンを文字列で返します (レスポンスの１行目から)。
code は、HTTP ステータスコードを整数で返します。
reasonPhrase は、HTTP ステータスコードと一緒の文字列を返します。
raw は、手を加えていないサーバーからのレスポンスを返します。

HttpResponse は、以下のメソッドを持ちます。

body() は、ボディを返します。
isOk() は、ステータスコードが 200 かどうかを返します。
isRedirect() は、ステータスコードが 301, 302, 303 もしくは 307 で Location ヘッダーがセットされているかどうかを返します。
getHeader() は、ヘッダーを取得します。次のセクションをご覧ください。

レスポンスのヘッダーを取得

コアの別の場所に従って、 HttpSocket はヘッダーの文字を変更しません。 2616 には、ヘッダーは大文字小文字を区別しないと書かれています。そして、 HttpSocket はリモートホストが送った値を保存します。

HTTP/1.1 200 OK
Date: Mon, 16 Apr 2007 04:14:16 GMT
server: CakeHttp Server
content-tyPe: text/html

$response->headers (もしくは $response['header']) は、実際に送られたキーを含みます。安全にヘッダーフィールドへのアクセスするために、 getHeader() を使用することが最良です。もし、ヘッダーが以下の場合:

Date: Mon, 16 Apr 2007 04:14:16 GMT
server: CakeHttp Server
content-tyPe: text/html

getHeader() で上記のヘッダーを取得できます。

// $response は HttpResponse のインスタンス。
// Content-Type を取得
$response->getHeader('Content-Type');

// date を取得
$response->getHeader('date');

ヘッダーは、大文字小文字の区別なく取得できます。

リダイレクトレスポンスの自動処理

レスポンスがリダイレクトステータスコードの場合 (HttpResponse::isRedirect 参照)、受信した Location ヘッダーに従って、自動的に追加のリクエスを行うことができます。

$HttpSocket = new HttpSocket();
$response = $HttpSocket->get('http://example.com/redirecting_url', [], ['redirect' => true]);

redirect オプションは、以下の値を指定できます。

true : すべてのリダイレクトするレスポンスは、一貫して新たなリクエストをします。
integer : 設定した値は、リダイレクトする回数の最大値です。 (回数に達した後は、 redirect 値を false とみなします。)
false (デフォルト) : リダイレクトしません。

$response は、設定に従って戻ってくる最後のレスポンスになります。

SSL 証明書の処理

SSL のサービスへのリクエストを作成する場合、 HttpSocket は、ピア検証で SSL 証明書の検証を試みます。もし、証明書がピア検証に失敗したり、アクセス先のホスト名と一致しなかった場合、接続は失敗し、例外が投げられます。ssl_cafile を指定しない場合、HttpSocket はシステムの CA 証明書 (openssl.cafile または openssl.capath) を使い、見つからなければ composer/ca-bundle パッケージに含まれる Mozilla の CA バンドルを使います。このバンドルは Composer で最新の状態に保てます。どのように SSL 証明書を処理するか設定するために以下のオプションが使えます。

ssl_verify_peer false にセットすると、SSL の検証を無効にします。これは、**非推奨** です。
ssl_verify_host 証明書を検証する際にホスト名の照合エラーを無視したい場合に false をセットします。
ssl_allow_self_signed 自己署名証明書を受け入れられるようにするために true をセットします。これは、 ssl_verify_peer を有効にする必要があります。
ssl_cafile SSL 証明書を検証するために使用したい証明書認証局ファイルの絶対パスをセットします。

Piece of Cake 2 fork

2016 年に最終更新された同梱の cacert.pem は削除され、システムの CA 証明書と composer/ca-bundle を使うようになりました。詳しくは脆弱性への対応を参照してください。

これらのオプションは、コンストラクタの引数として指定します。

$socket = new HttpSocket([
    'ssl_allow_self_signed' => true,
]);

上記の socket で作られたすべてのリクエストは自己署名証明書を許可します。

Added in version 2.3

SSL 証明書の検証は、 2.3 で追加されました。

独自レスポンスクラスの作成

HttpSocket で使用する独自のレスポンスクラスを作成することができます。以下の内容で src/Lib/Network/Http/YourResponse.php というファイルを作ることができます。

// src/Lib/Network/Http/YourResponse.php
class YourResponse extends HttpSocketResponse
{
    public function parseResponse($message)
    {
        parent::parseResponse($message);
        // Make what you want
    }
}

リクエストする前に、 responseClass プロパティを変更する必要があります。

$http = new HttpSocket();
$http->responseClass = 'YourResponse';

HttpSocket は App::uses() で Network/Http パッケージとしてクラスを登録します。そのため Composer の classmap を使わない場合は src/Lib/Network/Http/ から探されます。 'MyPlugin.YourResponse' のようにプラグイン記法を使った場合は、プラグインの Lib/Network/Http/ から探されます。

Changed in version 2.3

2.3.0 以降、 HttpResponse ではなく HttpSocketResponse を継承すべきです。これは、 HTTP PECL 拡張の一般的な問題を回避します。

結果のダウンロード

HttpSocket は、 setContentResponse() と呼ばれる新しいメソッドを持ちます。このメソッドでリソースをセットすることによって、 fwrite() を使ってこのリソースに内容を書き込ませられます。ファイルをダウンロードするためには、以下のようにします。

$http = new HttpSocket();
$f = fopen(TMP . 'comments.xml', 'w');
$http->setContentResource($f);
$http->get('https://example.com/comments.rss');
fclose($f);

NOTE

ヘッダーはファイル内に含まれません。リソースに書き込まれる内容は本文のみです。リソースへの保存を無効にしたい場合は、 $http->setContentResource(false) を使います。

認証の利用

HttpSocket は、 HTTP ベーシック認証とダイジェスト認証に対応しています。また、OAuth のようなプロトコルに対応するために独自の認証オブジェクトを作成することができます。任意の認証システムを利用するためには、 HttpSocket インスタンスを設定する必要があります。

$http = new HttpSocket();
$http->configAuth('Basic', 'user', 'password');

上記は、 user と password を証明情報としてベーシック認証のための HttpSocket インスタンスの設定です。

独自認証オブジェクトの作成

HttpSocket で利用するための独自の認証方法を作成することができます。以下の内容で、 src/Lib/Network/Http/YourMethodAuthentication.php ファイルを作成できました。

class YourMethodAuthentication
{
    /**
     * 認証
     *
     * @param HttpSocket $http
     * @param array $authInfo
     * @return void
     */
    public static function authentication(HttpSocket $http, &$authInfo)
    {
        // 何かをします。例えば、 $http->request['header']['Authentication'] の値をセット。
    }
}

独自認証を HttpSocket に設定するためには、新しい configAuth() メソッドを使用します。

$http->configAuth('YourMethod', ['config1' => 'value1', 'config2' => 'value2']);
$http->get('http://secure.your-site.com');

authentication() メソッドは、リクエストヘッダを追加するために呼ばれます。

プロクシ経由で HttpSoket の利用

認証設定の一部で、プロクシ認証の設定ができます。同じ認証クラスの中で、プロクシ認証のための独自のメソッドを作成します。

class YourMethodAuthentication
{
    /**
     * 認証
     *
     * @param HttpSocket $http
     * @param array $authInfo
     * @return void
     */
    public static function authentication(HttpSocket $http, &$authInfo)
    {
        // 何かします。例えば $http->request['header']['Authentication'] の値をセット。
    }

    /**
     * プロクシ認証
     *
     * @param HttpSocket $http
     * @param array $proxyInfo
     * @return void
     */
    public static function proxyAuthentication(HttpSocket $http, &$proxyInfo)
    {
        // 何かします。例えば $http->request['header']['Proxy-Authentication'] の値をセット。
    }
}

NOTE

プロクシを利用するためには、 HttpSocket::configAuth() と同様に HttpSocket::configProxy() を呼ばなければなりません。

HttpSocket ​

リクエストの作成 ​

レスポンスの処理 ​

レスポンスのヘッダーを取得 ​

リダイレクトレスポンスの自動処理 ​

SSL 証明書の処理 ​

独自レスポンスクラスの作成 ​

結果のダウンロード ​

認証の利用 ​

独自認証オブジェクトの作成 ​

プロクシ経由で HttpSoket の利用 ​