【PHP8.x】CURLOPT_HTTP_CONTENT_DECODING定数の使い方

Copy
1<?php
2
3/**
4 * CURLOPT_HTTP_CONTENT_DECODING を false に設定して、HTTPコンテンツの自動デコードを無効にするサンプル。
5 *
6 * この関数は、指定されたURLからコンテンツを取得する際に、cURLの自動コンテンツデコード機能
7 * (例: gzip, deflate) を明示的に無効にします。
8 * これにより、サーバーから返された圧縮済みの生データがそのまま取得されます。
9 *
10 * @param string $url 取得するURL。圧縮されたコンテンツを返すURLが適しています。
11 * @return string|false 圧縮されたままのコンテンツ、またはエラー時にfalse。
12 */
13function fetchRawCompressedContent(string $url): string|false
14{
15    // cURLセッションを初期化します
16    $ch = curl_init();
17
18    // 初期化に失敗した場合はエラーを出力して終了
19    if ($ch === false) {
20        echo "cURLセッションの初期化に失敗しました。\n";
21        return false;
22    }
23
24    // 取得するURLを設定
25    curl_setopt($ch, CURLOPT_URL, $url);
26
27    // 取得したデータを文字列として関数から返すように設定
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29
30    // ここが重要なポイント: HTTPコンテンツの自動デコードを無効にします。
31    // 例えば、サーバーがgzip圧縮したデータを返した場合、cURLはこれを自動で解凍せず、
32    // 圧縮されたバイナリデータをそのまま返します。
33    curl_setopt($ch, CURLOPT_HTTP_CONTENT_DECODING, false);
34
35    // cURLセッションを実行し、コンテンツを取得
36    $response = curl_exec($ch);
37
38    // エラーが発生した場合はエラーメッセージを出力
39    if (curl_errno($ch)) {
40        echo 'cURLエラー: ' . curl_error($ch) . "\n";
41        $response = false;
42    }
43
44    // cURLセッションを閉じます
45    curl_close($ch);
46
47    return $response;
48}
49
50// --- 関数利用例 ---
51// httpbin.org/gzip はgzip圧縮されたJSONコンテンツを返します。
52// CURLOPT_HTTP_CONTENT_DECODING が false のため、圧縮された生データが返るはずです。
53$targetUrl = 'https://httpbin.org/gzip';
54
55echo "CURLOPT_HTTP_CONTENT_DECODING を false に設定してコンテンツを取得します。\n";
56echo "ターゲットURL: " . $targetUrl . "\n\n";
57
58$rawContent = fetchRawCompressedContent($targetUrl);
59
60if ($rawContent !== false) {
61    echo "コンテンツの取得に成功しました。\n";
62    echo "取得したコンテンツの最初の50バイト (圧縮された生データ):\n";
63    // 圧縮されたデータは通常、テキストとして読めないバイナリデータです。
64    // そのため、ここではその一部をそのまま出力しています。
65    echo substr($rawContent, 0, 50) . "...\n";
66    echo "コンテンツのバイト数: " . strlen($rawContent) . " バイト\n";
67    echo "\n(注意: CURLOPT_HTTP_CONTENT_DECODING が false のため、内容はデコードされていません。)\n";
68} else {
69    echo "コンテンツの取得に失敗しました。\n";
70}

CURLOPT_HTTP_CONTENT_DECODINGは、PHPのcURL拡張機能で使用される定数です。この定数は、HTTP通信で取得するコンテンツの自動デコード機能を制御するために利用されます。通常、ウェブサーバーがgzipやdeflateなどの圧縮形式でコンテンツを返した場合、cURLはそれを自動的に解凍してからアプリケーションに渡しますが、この定数をfalseに設定することで、その自動デコード機能を明示的に無効にできます。

サンプルコードでは、fetchRawCompressedContent関数内でcurl_setopt($ch, CURLOPT_HTTP_CONTENT_DECODING, false);と設定することで、指定されたURLから取得したHTTPコンテンツをcURLが自動的にデコードしないようにしています。これにより、サーバーから返される圧縮された生データ（バイナリデータ）を、そのままの状態で取得することが可能になります。

この関数は引数として$url（取得対象のURL）を受け取ります。そして、戻り値として、デコードされていない圧縮済みのコンテンツを文字列で返すか、またはcURLの処理中にエラーが発生した場合はfalseを返します。この機能は、圧縮されたデータの完全な制御が必要な場合や、特定の圧縮形式を自身で処理したい場合に特に有用です。

Copy
1<?php
2
3/**
4 * 指定されたURLからcURLオプションを適用してコンテンツを取得します。
5 *
6 * この関数は、HTTPリクエストヘッダーの設定 (CURLOPT_HTTPHEADER) と、
7 * 受信したコンテンツの自動デコードの無効化 (CURLOPT_HTTP_CONTENT_DECODING) の
8 * 具体的な使用例を示します。
9 *
10 * @param string $url 取得するURL。
11 * @return array{headers: string, body: string}|false 成功した場合はヘッダーとボディの連想配列、失敗した場合はfalse。
12 */
13function fetchUrlContentWithCurlOptions(string $url): array|false
14{
15    // cURLセッションを初期化
16    $ch = curl_init();
17
18    if ($ch === false) {
19        error_log("cURLセッションの初期化に失敗しました。");
20        return false;
21    }
22
23    // cURLオプションを設定
24    curl_setopt_array($ch, [
25        CURLOPT_URL => $url,
26        CURLOPT_RETURNTRANSFER => true, // 実行結果を文字列で返す
27        CURLOPT_HEADER => true,         // レスポンスヘッダーも結果に含める
28        CURLOPT_FOLLOWLOCATION => true, // リダイレクトを自動的に追跡する
29        CURLOPT_TIMEOUT => 10,          // タイムアウトを10秒に設定
30
31        // テスト目的でSSL証明書の検証を無効にする場合があります（本番環境では非推奨）
32        // CURLOPT_SSL_VERIFYPEER => false,
33        // CURLOPT_SSL_VERIFYHOST => false,
34
35        // キーワード: CURLOPT_HTTPHEADER
36        // リクエストヘッダーを設定します。ここでは、サーバにgzipまたはdeflateでの圧縮を要求します。
37        // これにより、サーバが圧縮されたレスポンスを返す可能性が高まります。
38        CURLOPT_HTTPHEADER => [
39            'Accept-Encoding: gzip, deflate',
40            'User-Agent: BeginnerCurlClient/1.0' // ユーザーエージェントも設定
41        ],
42
43        // リファレンス情報: CURLOPT_HTTP_CONTENT_DECODING
44        // true (デフォルト) の場合、cURLはContent-Encodingヘッダーに従って
45        // 受信したコンテンツのデコードを試みます。
46        // ここでは false に設定し、自動デコードを無効にしています。
47        // もしサーバが圧縮されたコンテンツを返した場合、cURLはデコードせずに
48        // 圧縮された生のバイト列をそのまま返します。
49        CURLOPT_HTTP_CONTENT_DECODING => false,
50    ]);
51
52    // cURLセッションを実行し、結果を取得
53    $response = curl_exec($ch);
54
55    // エラーチェック
56    if (curl_errno($ch)) {
57        $error = curl_error($ch);
58        curl_close($ch);
59        error_log("cURLエラー: " . $error);
60        return false;
61    }
62
63    // レスポンスヘッダーサイズを取得
64    $headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
65    
66    // cURLセッションを閉じる
67    curl_close($ch);
68
69    // レスポンスをヘッダーとボディに分割
70    $responseHeader = substr($response, 0, $headerSize);
71    $responseBody = substr($response, $headerSize);
72
73    return [
74        'headers' => $responseHeader,
75        'body' => $responseBody
76    ];
77}
78
79// --- スクリプトの実行例 ---
80
81// テスト用のURLを設定します。
82// 例: https://www.google.com/
83// 例: https://httpbin.org/gzip (gzip圧縮されたレスポンスを返すテスト用サイト)
84$targetUrl = 'https://httpbin.org/gzip'; 
85
86echo "PHP cURLオプションの使用例\n";
87echo "---------------------------------\n";
88echo "対象URL: " . $targetUrl . "\n";
89echo "CURLOPT_HTTPHEADERで 'Accept-Encoding: gzip, deflate' を送信し、\n";
90echo "CURLOPT_HTTP_CONTENT_DECODING を false に設定しています。\n";
91echo "これにより、もしサーバが圧縮レスポンスを返した場合、cURLはコンテンツの\n";
92echo "自動デコードを行わず、圧縮された生のデータがそのまま取得されます。\n";
93echo "---------------------------------\n\n";
94
95$result = fetchUrlContentWithCurlOptions($targetUrl);
96
97if ($result !== false) {
98    echo "--- レスポンスヘッダー ---\n";
99    echo $result['headers'];
100
101    echo "\n--- レスポンスボディ (最初の500バイト、UTF-8エンコードで表示) ---\n";
102    // mb_substrで安全に切り出し、もし圧縮されていた場合は読めないバイト列になることを示します。
103    echo mb_substr($result['body'], 0, 500) . (mb_strlen($result['body']) > 500 ? '...' : '') . "\n";
104
105    echo "\n--- コンテンツデコード状況 ---\n";
106    if (strpos($result['headers'], 'Content-Encoding: gzip') !== false || strpos($result['headers'], 'Content-Encoding: deflate') !== false) {
107        echo "レスポンスヘッダーに 'Content-Encoding' が含まれています。\n";
108        echo "CURLOPT_HTTP_CONTENT_DECODING を false に設定したため、\n";
109        echo "cURLはコンテンツの自動デコードを行っていません。\n";
110        echo "上記のボディは圧縮された生のデータである可能性が高いです。\n";
111        echo "もし内容が判読できない場合、それは圧縮されたデータだからです。\n";
112        // 圧縮されたデータをデコードする例 (このコードの範囲外ですが、参考として):
113        // echo "\n--- (参考) gzipデコード後のボディ --- \n";
114        // echo gzdecode($result['body']);
115    } else {
116        echo "レスポンスヘッダーに 'Content-Encoding' は含まれていません。\n";
117        echo "コンテンツは圧縮されていないか、サーバが圧縮を適用しなかった可能性があります。\n";
118    }
119} else {
120    echo "URLコンテンツの取得に失敗しました。詳細についてはエラーログを確認してください。\n";
121}
122
123echo "\n--- スクリプト実行終了 ---\n";
124

このPHPサンプルコードは、cURLライブラリを使用してWebコンテンツを取得する方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。

メインとなるfetchUrlContentWithCurlOptions関数は、引数としてコンテンツを取得したいURL（文字列）を受け取ります。この関数が成功すると、取得したHTTPレスポンスのヘッダー情報とボディ（本体）を含む連想配列を返しますが、エラーが発生した場合はfalseを返します。

このコードでは、二つの重要なcURLオプションを設定しています。一つ目はCURLOPT_HTTPHEADERで、これはHTTPリクエストヘッダーを設定するオプションです。ここでは'Accept-Encoding: gzip, deflate'を指定し、Webサーバーに対してコンテンツをgzipやdeflate形式で圧縮して送るよう要求しています。

二つ目は、今回のリファレンス情報であるCURLOPT_HTTP_CONTENT_DECODINGです。このオプションをfalseに設定することで、cURLの自動コンテンツデコード機能を無効にしています。通常、cURLはサーバーから圧縮されたコンテンツ（例: Content-Encoding: gzip）を受け取ると、自動的に解凍して元のデータに戻そうとします。しかし、falseに設定することで、たとえサーバーが圧縮されたコンテンツを返してきたとしても、cURLはその圧縮された生のデータをそのまま受け取ります。これにより、開発者はコンテンツが圧縮された状態であるかを確認し、必要に応じて独自のデコード処理を行うことが可能になります。