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

Copy
1<?php
2
3/**
4 * CURLでのホスト解決エラーに対処するサンプル関数。
5 *
6 * 特定のホスト名がDNSで解決できない、または特定のアドレスに強制的に解決したい場合に、
7 * `CURLOPT_RESOLVE` オプションを使用してホスト名をIPアドレスにマッピングします。
8 * これにより、「Could not resolve host」のようなエラーを回避できます。
9 *
10 * @param string $url リクエストを送信するURL。通常はホスト名を含む。
11 * @param array $resolveMap ホスト名とIPアドレスのマッピング配列。
12 *                          例: `['example.com:80:192.0.2.1']`
13 *                          形式は `ホスト名:ポート:IPアドレス`。
14 * @return string|false CURLリクエストのレスポンス本文、またはエラー時にfalse。
15 */
16function handleCurlHostResolveError(string $url, array $resolveMap = []): string|false
17{
18    $ch = curl_init();
19
20    if ($ch === false) {
21        echo "Error: Failed to initialize CURL." . PHP_EOL;
22        return false;
23    }
24
25    // CURLリクエストのURLを設定
26    curl_setopt($ch, CURLOPT_URL, $url);
27    // レスポンスを文字列として取得
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29    // 接続試行の最大時間を設定（秒）
30    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
31    // リクエスト全体の最大時間を設定（秒）
32    curl_setopt($ch, CURLOPT_TIMEOUT, 30);
33
34    // ホスト解決のカスタマイズに対応するため、`CURLOPT_RESOLVE` オプションを使用します。
35    // このオプションは、指定されたホスト名をDNSではなく、指定されたIPアドレスに強制的に解決させます。
36    if (!empty($resolveMap)) {
37        curl_setopt($ch, CURLOPT_RESOLVE, $resolveMap);
38    }
39
40    // CURLリクエストを実行
41    $response = curl_exec($ch);
42
43    // エラーチェック
44    if (curl_errno($ch)) {
45        echo 'CURL Error (' . curl_errno($ch) . '): ' . curl_error($ch) . PHP_EOL;
46        curl_close($ch);
47        return false;
48    }
49
50    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
51    echo "HTTP Status Code: {$httpCode}" . PHP_EOL;
52
53    curl_close($ch);
54
55    return $response;
56}
57
58// --- サンプル使用例 ---
59
60// この例では、存在しない可能性のあるホスト名 'nonexistent-host.local' を
61// ローカルホストのIPアドレス '127.0.0.1' に強制的に解決させます。
62// ローカルでWebサーバーがポート80で動作している場合、そのサーバーにリクエストが送信されます。
63// そうでない場合でも、DNS解決エラーは回避されます。
64
65echo "--- 1. `CURLOPT_RESOLVE` を使用してホスト解決エラーを回避 ---" . PHP_EOL;
66
67// 解決したい問題のあるホスト名を含むURL
68$problematicUrl = 'http://nonexistent-host.local/';
69
70// ホスト名とIPアドレスのマッピングを設定
71// この例では、'nonexistent-host.local' のポート80へのアクセスを '127.0.0.1' にマッピングします。
72$customResolveMap = [
73    'nonexistent-host.local:80:127.0.0.1',
74];
75
76$result = handleCurlHostResolveError($problematicUrl, $customResolveMap);
77
78if ($result !== false) {
79    echo "CURLリクエストが成功しました (DNS解決エラーは回避されました)。" . PHP_EOL;
80    // 必要に応じてレスポンスの最初の200文字を表示
81    // echo "レスポンスの抜粋: " . substr($result, 0, 200) . "..." . PHP_EOL;
82} else {
83    echo "CURLリクエストが失敗しました。" . PHP_EOL;
84}
85
86echo PHP_EOL;
87
88echo "--- 2. 通常のドメインに `CURLOPT_RESOLVE` を適用して挙動を確認 ---" . PHP_EOL;
89// 既存のドメイン（例: example.com）を別のIP（例: ローカルホスト）にマッピングする例
90$existingDomainUrl = 'http://example.com/';
91$overrideResolveMap = [
92    'example.com:80:127.0.0.1', // example.com へのアクセスを127.0.0.1へ
93];
94
95$resultOverride = handleCurlHostResolveError($existingDomainUrl, $overrideResolveMap);
96
97if ($resultOverride !== false) {
98    echo "CURLリクエストが成功しました (example.comへのアクセスが127.0.0.1に転送されました)。" . PHP_EOL;
99} else {
100    echo "CURLリクエストが失敗しました。" . PHP_EOL;
101}
102

このPHPサンプルコードは、CURLリクエストで発生する「Could not resolve host」といったホスト解決エラーを回避し、特定のホスト名を強制的に任意のIPアドレスに解決させる方法を示しています。

handleCurlHostResolveError関数は、指定された$urlに対してCURLリクエストを実行します。重要な点は、$resolveMap引数に['ホスト名:ポート:IPアドレス']の形式で配列を渡すことで、CURLOPT_RESOLVEオプションを使用してホスト名の解決方法をカスタマイズできることです。これにより、DNSに登録されていないホスト名や、特定のテスト環境のIPアドレスへリクエストを強制的に送ることができます。

例えば、nonexistent-host.localという存在しないホスト名を127.0.0.1（ローカルホスト）に解決させることで、通常のDNS解決ではエラーとなるリクエストを成功させることが可能です。

関数は、リクエストが成功した場合はレスポンス本文の文字列を、CURLの初期化失敗や実行時のエラーが発生した場合はfalseを戻り値として返します。この機能は、開発やテストの段階で、特定のサーバーへのアクセスを柔軟に制御したい場合に特に役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたURLへのHTTPリクエストを行い、レスポンスヘッダを取得します。
5 *
6 * @param string $url リクエストを送信するURL。
7 * @return array|false レスポンスヘッダの連想配列、またはcURLエラーが発生した場合はfalse。
8 */
9function getHttpResponseHeaders(string $url): array|false
10{
11    // cURLセッションを初期化します。
12    $ch = curl_init();
13
14    // 初期化に失敗した場合はfalseを返します。
15    if ($ch === false) {
16        return false;
17    }
18
19    // ターゲットURLを設定します。
20    curl_setopt($ch, CURLOPT_URL, $url);
21
22    // レスポンスのヘッダ情報も結果に含めるように設定します。
23    curl_setopt($ch, CURLOPT_HEADER, true);
24
25    // cURL実行結果を直接出力せず、文字列として返すように設定します。
26    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
27
28    // HTTPリダイレクトを自動的に追跡しないように設定します。
29    // これにより、最初のリクエストに対するヘッダを取得しやすくなります。
30    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, false);
31
32    // HTTPSサイトの場合、SSL証明書の検証をスキップするオプション (開発環境向け、本番環境では非推奨)
33    // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
34    // curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
35
36    // cURLセッションを実行し、HTTPレスポンス全体（ヘッダとボディ）を取得します。
37    $response = curl_exec($ch);
38
39    // cURLエラーが発生した場合はfalseを返します。
40    if (curl_errno($ch)) {
41        // デバッグ目的でエラーメッセージを表示することもできます:
42        // echo 'cURL Error: ' . curl_error($ch);
43        curl_close($ch);
44        return false;
45    }
46
47    // レスポンス文字列からヘッダ部分のサイズを取得します。
48    // この関数はcurl_exec()の後に呼び出す必要があります。
49    $headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
50    
51    // cURLセッションを閉じ、リソースを解放します。
52    curl_close($ch);
53
54    // 取得したレスポンスからヘッダ部分を抽出します。
55    $headerText = substr($response, 0, $headerSize);
56    // ボディ部分が必要な場合は、以下のように抽出できますが、今回は不要です。
57    // $body = substr($response, $headerSize);
58
59    // ヘッダ文字列を解析して連想配列に変換します。
60    $headers = [];
61    // ヘッダ行を改行コードで分割し、余分な空白を除去します。
62    $headerLines = explode("\r\n", trim($headerText));
63    
64    foreach ($headerLines as $line) {
65        // 空行はスキップします。
66        if (trim($line) === '') {
67            continue;
68        }
69
70        // ステータスライン (例: HTTP/1.1 200 OK) は特別に扱います。
71        if (str_starts_with($line, 'HTTP/')) {
72            $headers['Status-Line'] = $line;
73            continue;
74        }
75
76        // ヘッダ名と値を分割します。最初のコロンで分割します。
77        $parts = explode(':', $line, 2);
78        if (count($parts) === 2) {
79            $name = trim($parts[0]);
80            $value = trim($parts[1]);
81            
82            // 同じヘッダ名が複数ある場合 (例: Set-Cookie)、配列として追加します。
83            // HTTP/1.1では、同じヘッダ名が複数存在することが許可されています。
84            if (isset($headers[$name])) {
85                if (!is_array($headers[$name])) {
86                    $headers[$name] = [$headers[$name]];
87                }
88                $headers[$name][] = $value;
89            } else {
90                $headers[$name] = $value;
91            }
92        }
93    }
94
95    return $headers;
96}
97
98// --- サンプル使用例 ---
99// 取得したいURLを指定します。
100$targetUrl = 'https://www.example.com'; 
101
102// 関数を呼び出してレスポンスヘッダを取得します。
103$headers = getHttpResponseHeaders($targetUrl);
104
105// ヘッダが正常に取得できたかを確認し、表示します。
106if ($headers !== false) {
107    echo "ターゲットURL: " . $targetUrl . "\n";
108    echo "--- HTTP レスポンスヘッダ ---\n";
109    foreach ($headers as $name => $value) {
110        if (is_array($value)) {
111            // 値が配列の場合はカンマ区切りで表示します。
112            echo $name . ": " . implode(", ", $value) . "\n";
113        } else {
114            echo $name . ": " . $value . "\n";
115        }
116    }
117} else {
118    echo "エラー: " . $targetUrl . " のHTTPレスポンスヘッダを取得できませんでした。\n";
119}
120
121?>

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたURLへHTTPリクエストを送信し、そのレスポンスヘッダを取得する手順を具体的に示しています。

getHttpResponseHeaders関数は、引数としてリクエスト先のURL（文字列）を受け取ります。関数内部では、まずcurl_init()でcURLセッションを初期化し、curl_setopt()を使ってターゲットURLの設定や、レスポンスにヘッダ情報を含める設定、結果を直接出力せずに文字列として返す設定などを行います。

設定後、curl_exec()でHTTPリクエストを実行し、応答全体を取得します。リクエスト中にエラーが発生した場合は、curl_errno()でエラーを確認し、関数はfalseを返します。成功した場合、curl_getinfo()でヘッダ部分のサイズを取得し、その情報に基づいてレスポンス文字列からヘッダ部分を正確に抽出します。

抽出されたヘッダの文字列は、改行コードで分割され、HTTPステータスラインや各ヘッダ名と値のペアが解析されて、扱いやすい連想配列に変換されます。同じヘッダ名が複数存在する場合は、値が配列として格納されます。最後にcurl_close()でcURLセッションのリソースを解放します。

この関数は、HTTPリクエストが成功し、ヘッダ情報が正常に解析できた場合は、ヘッダ名と値の連想配列を戻り値として返します。cURLの初期化失敗や実行エラーが発生した場合はfalseを返します。サンプル使用例では、この関数を用いて指定URLのヘッダを取得し、その内容を画面に表示する方法が示されています。