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

Copy
1<?php
2
3/**
4 * 指定されたURLにcURLリクエストを送信し、レスポンスヘッダとボディを取得します。
5 * システムエンジニアを目指す初心者向けに、cURLの基本的な使い方、
6 * レスポンスヘッダの取得、およびエラーハンドリングを含みます。
7 *
8 * @param string $url リクエストを送信するURL。
9 * @return array 成功した場合は、HTTPコード、解析されたヘッダ、ボディを含む連想配列。
10 *               失敗した場合は、成功フラグ、エラーメッセージ、cURLエラーコードを含む連想配列。
11 */
12function fetchDataWithHeaders(string $url): array
13{
14    // cURLセッションを初期化します。
15    // cURLはURLへのデータ転送を行うためのライブラリです。
16    $ch = curl_init();
17
18    // cURLオプションを設定します。
19    // CURLOPT_URL: リクエストを送信するURL。
20    curl_setopt($ch, CURLOPT_URL, $url);
21    // CURLOPT_HEADER: レスポンスヘッダをボディと一緒に出力に含めるように設定します。
22    // これにより、ヘッダ情報を取得できます。
23    curl_setopt($ch, CURLOPT_HEADER, true);
24    // CURLOPT_RETURNTRANSFER: curl_exec()の実行結果を画面に出力せず、文字列として返すように設定します。
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
26    // CURLOPT_FOLLOWLOCATION: HTTP 3xx リダイレクトを自動的に追跡します。
27    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
28    // CURLOPT_SSL_VERIFYPEER, CURLOPT_SSL_VERIFYHOST:
29    // SSL証明書の検証をスキップします。これは開発環境向けの設定であり、
30    // 本番環境ではセキュリティのため適切に証明書を設定し検証を有効にすることを強く推奨します。
31    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
32    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
33    // CURLOPT_TIMEOUT: cURL操作の最大実行時間を秒単位で設定します。
34    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
35
36    // cURLリクエストを実行し、サーバーからのレスポンスを取得します。
37    $response = curl_exec($ch);
38
39    // cURLリクエストの実行中にエラーが発生したかどうかを確認します。
40    if (curl_errno($ch)) {
41        $errorCode = curl_errno($ch); // cURLエラーコードを取得
42        $errorMessage = curl_error($ch); // cURLエラーメッセージを取得
43
44        // `CURLPX_REPLY_HOST_UNREACHABLE` は、提供されたリファレンス情報に存在する定数ですが、
45        // PHP標準のcURL拡張機能には直接は定義されていない可能性があります。
46        // この定数は「ホストが到達不能である」という状態を示すものと解釈されます。
47        // そのようなネットワークエラーは、PHPのcURLでは通常、以下のようなエラーコードで表されます。
48        // - `CURLE_COULDNT_CONNECT`: ホストまたはプロキシサーバーに接続できませんでした。
49        // - `CURLE_HOST_RESOLVER_ERROR`: ホスト名解決に失敗しました。
50        // もしこの定数がシステムで定義されており、特定のエラーコードを表す場合、
51        // 以下のようにコード内で利用できますが、ここでは一般的なエラーハンドリングを行います。
52        /*
53        if ($errorCode === CURLPX_REPLY_HOST_UNREACHABLE) {
54            return [
55                'success' => false,
56                'error' => '指定されたホストに到達できませんでした。ネットワーク接続またはURLを確認してください。',
57                'curl_error_code' => $errorCode,
58                'curl_error_message' => $errorMessage,
59            ];
60        }
61        */
62
63        // その他のcURLエラーが発生した場合
64        return [
65            'success' => false,
66            'error' => 'cURLリクエスト中にエラーが発生しました。',
67            'curl_error_code' => $errorCode,
68            'curl_error_message' => $errorMessage,
69        ];
70    }
71
72    // HTTPステータスコード (例: 200 OK, 404 Not Found など) を取得します。
73    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
74
75    // ヘッダのサイズを取得し、レスポンス全体をヘッダ部分とボディ部分に分割します。
76    $headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
77    $responseHeaders = substr($response, 0, $headerSize);
78    $responseBody = substr($response, $headerSize);
79
80    // レスポンスヘッダをパース（解析）して、扱いやすい連想配列形式に変換します。
81    $parsedHeaders = [];
82    // ヘッダは通常、CRLF (`\r\n`) で区切られています。
83    $headerLines = explode("\r\n", trim($responseHeaders));
84    foreach ($headerLines as $line) {
85        // HTTPステータスライン (例: "HTTP/1.1 200 OK") は特殊な形式なので、個別に処理します。
86        if (strpos($line, 'HTTP/') === 0) {
87            $parsedHeaders['Status-Line'] = $line;
88        } elseif (strpos($line, ':') !== false) {
89            // "Key: Value" 形式のヘッダをキーと値に分割します。
90            list($key, $value) = explode(':', $line, 2);
91            $parsedHeaders[trim($key)] = trim($value);
92        }
93    }
94
95    // cURLセッションを終了し、使用したリソースを解放します。
96    curl_close($ch);
97
98    // 成功した結果を返します。
99    return [
100        'success' => true,
101        'http_code' => $httpCode,
102        'headers' => $parsedHeaders,
103        'body' => $responseBody,
104    ];
105}
106
107// --- サンプルコードの実行例 ---
108
109// 1. 成功するリクエストの例 (Googleのトップページにアクセス)
110$successUrl = 'https://www.google.com'; // アクセス可能なURLを指定してください
111echo "--- 成功するリクエストの例: {$successUrl} ---\n";
112$resultSuccess = fetchDataWithHeaders($successUrl);
113
114if ($resultSuccess['success']) {
115    echo "リクエスト成功！\n";
116    echo "HTTPステータスコード: " . $resultSuccess['http_code'] . "\n";
117    echo "レスポンスヘッダ:\n";
118    // 取得したヘッダ情報をループで表示します。
119    foreach ($resultSuccess['headers'] as $key => $value) {
120        echo "  " . $key . ": " . $value . "\n";
121    }
122    echo "レスポンスボディの一部 (最初の200文字):\n";
123    echo substr($resultSuccess['body'], 0, 200) . "...\n\n";
124} else {
125    echo "リクエスト失敗！\n";
126    echo "エラー: " . $resultSuccess['error'] . "\n";
127    echo "cURLエラーコード: " . $resultSuccess['curl_error_code'] . "\n";
128    echo "cURLエラーメッセージ: " . $resultSuccess['curl_error_message'] . "\n\n";
129}
130
131// 2. ホストに到達できないリクエストの例 (エラーハンドリングの確認)
132// 存在しないドメインや、ネットワーク的に到達できないURLを指定します。
133// 環境によってはDNSキャッシュなどの影響で、結果が異なる場合があります。
134$unreachableUrl = 'http://nonexistent-domain-for-test-123456.com'; // 確実に存在しないであろうドメイン
135echo "--- 到達できないリクエストの例: {$unreachableUrl} ---\n";
136$resultUnreachable = fetchDataWithHeaders($unreachableUrl);
137
138if ($resultUnreachable['success']) {
139    echo "リクエスト成功 (予期せぬ結果)！\n\n"; // 滅多に起こらないはず
140} else {
141    echo "リクエスト失敗 (エラーハンドリング確認)！\n";
142    echo "エラー: " . $resultUnreachable['error'] . "\n";
143    echo "cURLエラーコード: " . $resultUnreachable['curl_error_code'] . "\n";
144    echo "cURLエラーメッセージ: " . $resultUnreachable['curl_error_message'] . "\n";
145
146    // ホストが到達不能であることに関連する可能性のあるエラーコードをチェックします。
147    if (in_array($resultUnreachable['curl_error_code'], [CURLE_COULDNT_CONNECT, CURLE_HOST_RESOLVER_ERROR])) {
148        echo "  => これはホスト到達不能、またはホスト名解決エラーである可能性が高いです。\n";
149    }
150    echo "\n";
151}

このPHPサンプルコードは、指定されたURLへcURLリクエストを送信し、サーバーからのレスポンスヘッダとボディを取得する基本的な方法をシステムエンジニアを目指す初心者向けに示しています。fetchDataWithHeaders関数は、引数にリクエストを送信する$urlを受け取り、成功時にはHTTPコード、解析されたヘッダ、ボディを含む連想配列を返します。失敗時には成功フラグ、エラーメッセージ、cURLエラーコードを返します。

関数内ではまずcurl_init()でcURLセッションを初期化し、curl_setopt()で各種オプションを設定します。特にCURLOPT_URLで送信先URLを指定し、CURLOPT_HEADERをtrueにすることでレスポンスヘッダも取得対象とし、CURLOPT_RETURNTRANSFERをtrueにすることでcurl_exec()の戻り値を文字列として扱えるように設定します。リクエストはcurl_exec()で実行され、エラーが発生した場合はcurl_errno()とcurl_error()で詳細を取得し、エラー情報を返します。

ここで参照情報にあるCURLPX_REPLY_HOST_UNREACHABLE定数について触れます。この定数は「ホストが到達不能である」状態を示すものですが、PHP標準のcURL拡張機能には直接定義されていない可能性があります。しかし、その概念は重要であり、類似のエラーはCURLE_COULDNT_CONNECT（接続失敗）やCURLE_HOST_RESOLVER_ERROR（ホスト名解決失敗）といった標準のcURLエラーコードで検出できます。

リクエストが成功した場合、curl_getinfo()でHTTPステータスコードやヘッダサイズを取得し、レスポンス文字列からヘッダとボディを分離、ヘッダを扱いやすい連想配列にパースします。最後にcurl_close()でcURLセッションを終了し、取得したデータを含む結果を返します。このコードを通じて、外部リソースとのHTTP通信におけるヘッダ情報の取得と基本的なエラーハンドリングを学ぶことができます。

Copy
1<?php
2
3/**
4 * 指定されたURLにcURLリクエストを送信し、そのレスポンスを取得する関数。
5 * ネットワークエラーやHTTPエラーのハンドリングも行い、
6 * システムエンジニア初心者がWeb APIや外部サービス連携を学ぶ上で重要な
7 * リクエストの成功/失敗判定とエラー情報の取得方法を示す。
8 *
9 * @param string $url リクエストを送信するURL。
10 * @return array レスポンスデータとステータス情報を含む連想配列。
11 *               - 'body': string レスポンスボディ。エラー時は空文字列。
12 *               - 'http_code': int HTTPステータスコード。ネットワークエラー時は0。
13 *               - 'curl_errno': int cURLのエラー番号。0はエラーなし。
14 *               - 'curl_error': string cURLのエラーメッセージ。エラーなし時は空文字列。
15 */
16function getUrlContentWithCurl(string $url): array
17{
18    // cURLセッションを初期化
19    $ch = curl_init();
20
21    // cURLオプションを設定
22    curl_setopt($ch, CURLOPT_URL, $url);
23    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列として取得
24    curl_setopt($ch, CURLOPT_TIMEOUT, 10);          // 処理全体のタイムアウトを10秒に設定
25    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);     // 接続タイムアウトを5秒に設定
26    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); // リダイレクトを自動的に追跡
27
28    // HTTPSサイトにアクセスする場合、SSL証明書の検証を行います。
29    // 自己署名証明書など特殊な場合は無効にすることもありますが、セキュリティ上推奨されません。
30    // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
31    // curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
32
33    // cURLリクエストを実行し、レスポンスボディを取得
34    $responseBody = curl_exec($ch);
35
36    // cURL実行後の情報を取得
37    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); // HTTPステータスコード (例: 200, 404, 500)
38    $curlErrno = curl_errno($ch);                      // cURLのエラー番号 (0はエラーなし)
39    $curlError = curl_error($ch);                      // cURLのエラーメッセージ
40
41    // cURLセッションを閉じる
42    curl_close($ch);
43
44    // レスポンスとエラー情報をまとめた配列を返す
45    // curl_execがfalseを返し、$curlErrnoが0でない場合、ネットワークレベルのエラーと判断
46    // これは、提供された定数 "CURLPX_REPLY_HOST_UNREACHABLE" が示すような
47    // ホストへの到達が不可能であったり、接続が確立できなかった状況を含みます。
48    // 標準のcURL拡張では CURLE_COULDNT_CONNECT (エラー番号7) などが該当します。
49    return [
50        'body'       => ($responseBody !== false) ? $responseBody : '',
51        'http_code'  => $httpCode,
52        'curl_errno' => $curlErrno,
53        'curl_error' => $curlError,
54    ];
55}
56
57// --- 以下、サンプル実行コード ---
58
59// 1. 正常なURLへのリクエスト例
60echo "--- 正常なURLへのリクエスト ---" . PHP_EOL;
61$normalUrl = 'https://www.google.com';
62$resultNormal = getUrlContentWithCurl($normalUrl);
63
64if ($resultNormal['curl_errno'] !== 0) {
65    echo "cURLエラーが発生しました:" . PHP_EOL;
66    echo "  URL: " . $normalUrl . PHP_EOL;
67    echo "  エラーコード: " . $resultNormal['curl_errno'] . PHP_EOL;
68    echo "  エラーメッセージ: " . $resultNormal['curl_error'] . PHP_EOL;
69} elseif ($resultNormal['http_code'] >= 200 && $resultNormal['http_code'] < 300) {
70    echo "リクエスト成功 (HTTP " . $resultNormal['http_code'] . "):" . PHP_EOL;
71    echo "  レスポンスボディの長さ: " . strlen($resultNormal['body']) . " バイト" . PHP_EOL;
72    // 実際のレスポンスボディの一部を表示 (長すぎる場合に備えて制限)
73    echo "  レスポンスボディの一部: " . substr($resultNormal['body'], 0, 150) . "..." . PHP_EOL;
74} else {
75    echo "HTTPエラーが発生しました (HTTP " . $resultNormal['http_code'] . "):" . PHP_EOL;
76    echo "  URL: " . $normalUrl . PHP_EOL;
77    echo "  レスポンスボディの長さ: " . strlen($resultNormal['body']) . " バイト" . PHP_EOL;
78}
79echo PHP_EOL;
80
81// 2. 存在しない（到達不能な）ホストへのリクエスト例
82// この例は、CURLPX_REPLY_HOST_UNREACHABLEが示唆するような、
83// ホストに接続できない状況を再現します。
84// ローカルの存在しないポートや、解決できないドメインを使用します。
85echo "--- 到達不能なホストへのリクエスト ---" . PHP_EOL;
86$unreachableUrl = 'http://localhost:9999/test'; // 通常、このポートには何も起動していないため接続エラーになる
87// または $unreachableUrl = 'http://nonexistent-domain-example-12345.com'; // 解決できないドメイン
88
89$resultUnreachable = getUrlContentWithCurl($unreachableUrl);
90
91if ($resultUnreachable['curl_errno'] !== 0) {
92    echo "cURLエラーが発生しました (到達不能なホスト):" . PHP_EOL;
93    echo "  URL: " . $unreachableUrl . PHP_EOL;
94    echo "  エラーコード: " . $resultUnreachable['curl_errno'] . PHP_EOL;
95    echo "  エラーメッセージ: " . $resultUnreachable['curl_error'] . PHP_EOL;
96    echo "  HTTPステータスコード: " . $resultUnreachable['http_code'] . PHP_EOL;
97    // PHP標準のcURL拡張では、例えばエラーコード7 (CURLE_COULDNT_CONNECT) は
98    // リモートホストへの接続に失敗したことを示し、CURLPX_REPLY_HOST_UNREACHABLEに相当する状況です。
99    if ($resultUnreachable['curl_errno'] === CURLE_COULDNT_CONNECT) {
100        echo "  (このエラーはホストへの接続ができなかったことを示しています。)" . PHP_EOL;
101    }
102} else {
103    echo "予期せぬ成功: 到達不能なURLにアクセスできました。" . PHP_EOL;
104    echo "  HTTPステータスコード: " . $resultUnreachable['http_code'] . PHP_EOL;
105    echo "  レスポンスボディの長さ: " . strlen($resultUnreachable['body']) . " バイト" . PHP_EOL;
106}
107echo PHP_EOL;
108
109// 3. 存在するがコンテンツがない（404など）URLへのリクエスト例
110echo "--- 404エラーとなるURLへのリクエスト ---" . PHP_EOL;
111$notFoundUrl = 'https://www.google.com/nonexistent-page-12345';
112$resultNotFound = getUrlContentWithCurl($notFoundUrl);
113
114if ($resultNotFound['curl_errno'] !== 0) {
115    echo "cURLエラーが発生しました (URL: " . $notFoundUrl . "):" . PHP_EOL;
116    echo "  エラーコード: " . $resultNotFound['curl_errno'] . PHP_EOL;
117    echo "  エラーメッセージ: " . $resultNotFound['curl_error'] . PHP_EOL;
118} elseif ($resultNotFound['http_code'] >= 200 && $resultNotFound['http_code'] < 300) {
119    echo "リクエスト成功 (HTTP " . $resultNotFound['http_code'] . "):" . PHP_EOL;
120    echo "  レスポンスボディの長さ: " . strlen($resultNotFound['body']) . " バイト" . PHP_EOL;
121} else {
122    echo "HTTPエラーが発生しました (HTTP " . $resultNotFound['http_code'] . "):" . PHP_EOL;
123    echo "  URL: " . $notFoundUrl . PHP_EOL;
124    echo "  レスポンスボディの長さ: " . strlen($resultNotFound['body']) . " バイト" . PHP_EOL;
125    echo "  レスポンスボディの一部: " . substr($resultNotFound['body'], 0, 150) . "..." . PHP_EOL;
126}
127echo PHP_EOL;
128

PHPのcURL拡張は、Web APIや外部サービスとの連携でHTTPリクエストを送信するために広く利用されます。提示されたサンプルコードは、getUrlContentWithCurl関数を通じて、指定されたURLにcURLリクエストを送り、その結果を取得する方法を示しています。この関数は、引数としてリクエスト先のURL（$url）を受け取ります。

戻り値は、レスポンスボディ、HTTPステータスコード、cURLのエラー番号、そしてcURLのエラーメッセージを含む連想配列です。これにより、リクエストが成功したか、どのようなHTTPエラーが発生したか、あるいはネットワークレベルの接続エラーがあったかなど、詳細な状況を把握できます。

特に、curl_exec関数は、リクエスト実行時に成功すればレスポンスボディの文字列を、ネットワーク接続の失敗などのエラーが発生した場合にはfalseを返します。参照情報にあるCURLPX_REPLY_HOST_UNREACHABLE定数が示す「ホストに到達できない」ような状況は、PHPの標準cURL拡張ではCURLE_COULDNT_CONNECT（エラー番号7）といったエラーコードとしてcurl_errnoで捕捉されます。

このサンプルコードは、ネットワークエラーやHTTPエラーを適切にハンドリングし、システムエンジニア初心者がWeb API連携におけるリクエストの成功・失敗判定やエラー情報の取得方法を正確に学ぶ上で非常に役立ちます。