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

Copy
1<?php
2
3/**
4 * 指定されたURLへのCURL接続を試み、接続拒否（または接続失敗）のエラーをチェックします。
5 *
6 * この関数は、PHPのCURL拡張を使用してリモートホストへの接続を試みます。
7 * 特に、接続拒否やネットワーク到達不能などの一般的な接続エラーを検出し、その情報を提供します。
8 *
9 * @param string $url 接続を試みるURL。
10 * @return array 接続結果とエラー情報を含む連想配列。
11 *               - 'status': 'success', 'connection_refused_or_failed', 'curl_error', 'initialization_failed' のいずれか。
12 *               - 'error_code': CURLエラーコード (エラーがない場合は0)。
13 *               - 'error_message': CURLエラーメッセージ (エラーがない場合は空文字列)。
14 *               - 'http_code': HTTPレスポンスコード (接続が成功した場合、またはサーバーが応答した場合)。
15 */
16function checkCurlConnection(string $url): array
17{
18    // CURLセッションを初期化します。
19    $ch = curl_init($url);
20
21    // CURLセッションの初期化に失敗した場合
22    if ($ch === false) {
23        return [
24            'status' => 'initialization_failed',
25            'error_code' => -1, // カスタムエラーコード
26            'error_message' => 'CURLセッションの初期化に失敗しました。',
27            'http_code' => 0,
28        ];
29    }
30
31    // 接続タイムアウトを短く設定し、接続拒否のエラーを早期に検出しやすくします。
32    // CURLOPT_CONNECTTIMEOUT: ホストへの接続試行の最大秒数。
33    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 2);
34    // CURLOPT_TIMEOUT: CURL実行全体の最大秒数。
35    curl_setopt($ch, CURLOPT_TIMEOUT, 5);
36    // CURLOPT_RETURNTRANSFER: curl_exec() が結果を文字列で返すようにします。
37    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
38    // CURLOPT_NOBODY: HTTPボディをダウンロードせず、ヘッダー情報のみを取得します。
39    // 接続の成否を判断するだけなら効率的です。
40    curl_setopt($ch, CURLOPT_NOBODY, true);
41
42    // CURLリクエストを実行します。
43    // CURLOPT_NOBODY が設定されている場合、成功すれば空文字列が返されます。
44    // 失敗すれば false が返されます。
45    $response = curl_exec($ch);
46
47    // CURLのエラー番号とエラーメッセージを取得します。
48    $errorNumber = curl_errno($ch);
49    $errorMessage = curl_error($ch);
50    // HTTPステータスコードを取得します。
51    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
52
53    // 結果を格納する配列を初期化します。
54    $result = [
55        'status' => 'unknown',
56        'error_code' => $errorNumber,
57        'error_message' => $errorMessage,
58        'http_code' => $httpCode,
59    ];
60
61    // エラー番号を基にCURLエラーをチェックします。
62    if ($errorNumber) {
63        // CURLE_COULDNT_CONNECT (エラーコード: 7) は、ホストへの接続失敗を示します。
64        // これはDNS解決失敗、IPアドレスへの接続拒否、ネットワーク到達不能などが含まれる
65        // 最も一般的な接続エラーです。
66        if ($errorNumber === CURLE_COULDNT_CONNECT) {
67            $result['status'] = 'connection_refused_or_failed';
68        } else {
69            $result['status'] = 'curl_error';
70        }
71    } elseif ($response === false) {
72        // curl_exec()がfalseを返した場合、CURLエラーコードが0でも
73        // 何らかの実行上の問題が発生している可能性があります。
74        $result['status'] = 'execution_failed';
75    } else {
76        // エラーがなく、レスポンスが取得できた場合 (CURLOPT_NOBODY=true の場合は空文字列)。
77        $result['status'] = 'success';
78    }
79
80    // CURLセッションを閉じ、リソースを解放します。
81    curl_close($ch);
82
83    return $result;
84}
85
86// -----------------------------------------------------
87// サンプルコードの実行例
88// -----------------------------------------------------
89
90/**
91 * 接続チェック結果をコンソールに表示するヘルパー関数
92 *
93 * @param string $testName テストの名称
94 * @param array $result checkCurlConnection関数の戻り値
95 * @param string $targetUrl テストしたURL
96 */
97function displayConnectionResult(string $testName, array $result, string $targetUrl): void
98{
99    echo "--- " . $testName . " ---\n";
100    echo "ターゲットURL: " . $targetUrl . "\n";
101    echo "ステータス: " . $result['status'] . "\n";
102
103    if ($result['status'] === 'success') {
104        echo "HTTPコード: " . $result['http_code'] . "\n";
105        echo "接続に成功しました。\n";
106    } elseif ($result['status'] === 'connection_refused_or_failed') {
107        echo "CURLエラーコード: " . $result['error_code'] . "\n";
108        echo "CURLエラーメッセージ: " . $result['error_message'] . "\n";
109        echo "接続拒否または接続に失敗しました。\n";
110        // 注: CURLPX_REPLY_CONNECTION_REFUSED はPHP標準のCURL拡張には存在しません。
111        // もし特定のライブラリや環境で接続拒否を示すカスタム定数が定義されている場合、
112        // このエラーコード (CURLエラーコード 7) とカスタム定数を比較して処理を分岐させることができます。
113        // 例: if ($result['error_code'] === CUSTOM_CONNECTION_REFUSED_CONSTANT) { /* ... */ }
114    } else {
115        echo "CURLエラーコード: " . $result['error_code'] . "\n";
116        echo "CURLエラーメッセージ: " . $result['error_message'] . "\n";
117        echo "その他のCURLエラーまたは実行失敗が発生しました。\n";
118    }
119    echo "\n";
120}
121
122// ケース1: 意図的に接続拒否を発生させるURL (存在しないローカルポート)
123// このURLは、通常、誰にもリスニングされていないポートなので、接続が拒否されます。
124$refusedUrl = "http://127.0.0.1:65535";
125$refusedResult = checkCurlConnection($refusedUrl);
126displayConnectionResult("接続拒否のテスト", $refusedResult, $refusedUrl);
127
128// ケース2: 正常に接続できるURL (公開されているWebサイト)
129$successUrl = "http://www.google.com";
130$successResult = checkCurlConnection($successUrl);
131displayConnectionResult("接続成功のテスト", $successResult, $successUrl);
132
133// ケース3: 存在しないドメイン (DNS解決エラー)
134// ホストが見つからないため、これも接続失敗の一種と見なされます。
135$nonExistentDomainUrl = "http://example.nonexistent-domain-12345.com/";
136$nonExistentDomainResult = checkCurlConnection($nonExistentDomainUrl);
137displayConnectionResult("DNS解決失敗のテスト", $nonExistentDomainResult, $nonExistentDomainUrl);
138

このPHPサンプルコードは、CURL拡張機能を用いて指定されたURLへのネットワーク接続を試み、その成否やエラー情報を詳細にチェックする方法を初心者にも分かりやすく示しています。特に、リモートサーバーへの接続拒否や接続失敗といった一般的なネットワーク問題を検出することに焦点を当てています。

主要な関数であるcheckCurlConnectionは、接続先のURL（$url）を引数に受け取ります。内部ではcurl_init()でCURLセッションを開始し、CURLOPT_CONNECTTIMEOUTなどのオプションで接続タイムアウトを短く設定することで、エラーを迅速に検出します。また、CURLOPT_NOBODYをtrueに設定することで、サーバーからの応答ヘッダーのみを取得し、コンテンツをダウンロードせずに接続の可否を効率的に判断します。

curl_exec()でリクエストを実行した後、curl_errno()とcurl_error()を用いて発生したCURLエラーのコードとメッセージを取得します。ここで重要なのはCURLE_COULDNT_CONNECT（エラーコード7）で、これはホストが見つからない、接続が拒否された、ネットワークに到達できないなど、様々な接続失敗を示す包括的なエラーです。なお、リファレンス情報にあったCURLPX_REPLY_CONNECTION_REFUSED定数は、PHP標準のCURL拡張には直接存在せず、このエラーコード7が接続拒否の状況を検出するために利用されます。

この関数は、接続ステータス、エラーコード、エラーメッセージ、HTTPステータスコードを含む連想配列を戻り値として返します。これにより、接続試行の結果を具体的な情報とともにシステムエンジニアが詳細に分析できるようになります。サンプルコードでは、意図的に接続拒否となるURL、正常に接続できるURL、存在しないドメインなど、複数のシナリオで関数を実行し、それぞれのケースでのエラー挙動を確認する方法が示されています。

Copy
1<?php
2
3/**
4 * 指定されたURLからHTTPレスポンスヘッダとボディを取得する関数
5 *
6 * この関数はPHPのcURL拡張機能を使用してHTTPリクエストを実行し、
7 * レスポンスヘッダとボディを分離して返します。
8 * ネットワーク接続拒否などのエラーも適切に処理し、
9 * システムエンジニアを目指す初心者にも理解しやすいように記述されています。
10 *
11 * @param string $url リクエストを送信するターゲットURL。
12 * @return array|false レスポンスヘッダ（配列）とボディ（文字列）、HTTPステータスコードを
13 *                     含む連想配列を返します。エラー発生時には false を返します。
14 *                     例: ['http_code' => 200, 'headers' => ['Content-Type: text/html', ...], 'body' => '<!DOCTYPE html>...']
15 */
16function fetchUrlWithHeadersAndErrorHandling(string $url): array|false
17{
18    // cURLセッションを初期化します。
19    $ch = curl_init();
20
21    // リクエスト対象のURLを設定します。
22    curl_setopt($ch, CURLOPT_URL, $url);
23
24    // レスポンスヘッダも出力結果に含めるように設定します。
25    curl_setopt($ch, CURLOPT_HEADER, true);
26
27    // curl_exec() の結果を直接出力せず、戻り値として文字列で返すように設定します。
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29
30    // 接続確立までのタイムアウトを設定します（秒）。
31    // 例: サーバーへの接続が拒否された場合、このタイムアウト設定が適用されます。
32    // CURLPX_REPLY_CONNECTION_REFUSED のような状況は、標準cURLでは
33    // CURLE_COULDNT_CONNECT (エラーコード 7) などとして扱われます。
34    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5秒で接続を試みる
35
36    // 全体のリクエスト実行に関するタイムアウトを設定します（秒）。
37    curl_setopt($ch, CURLOPT_TIMEOUT, 10); // 10秒で処理を完了する
38
39    // HTTPリクエストを実行し、レスポンス全体（ヘッダとボディ）を取得します。
40    $response = curl_exec($ch);
41
42    // cURLエラーが発生したかどうかを確認します。
43    if (curl_errno($ch)) {
44        // エラーが発生した場合、エラーメッセージとエラーコードを表示します。
45        $error_message = curl_error($ch);
46        $error_code = curl_errno($ch);
47        echo "CURLエラー発生 (コード: {$error_code}): {$error_message}\n";
48        curl_close($ch);
49        return false;
50    }
51
52    // レスポンスからHTTPステータスコードを取得します。
53    $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
54
55    // レスポンスのヘッダ部分のサイズを取得します。
56    $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
57
58    // レスポンス全体からヘッダ部分とボディ部分を分離します。
59    $headers_string = substr($response, 0, $header_size);
60    $body = substr($response, $header_size);
61
62    // ヘッダ文字列を改行で分割し、配列形式に変換します。
63    $headers_array = explode("\r\n", trim($headers_string));
64
65    // cURLセッションを終了し、リソースを解放します。
66    curl_close($ch);
67
68    // 取得した情報を連想配列として返します。
69    return [
70        'http_code' => $http_code,
71        'headers' => $headers_array,
72        'body' => $body,
73    ];
74}
75
76// --- 使用例 ---
77// 接続テスト用のURLを設定します。
78// 以下の例は、実際にはアクセスできないローカルのポートで「接続拒否」を意図的に発生させるためのものです。
79// 実際のWebサイトのURLを指定することも可能です。
80// $testUrl = 'http://localhost:9999'; // 接続拒否が予想されるURL
81$testUrl = 'https://www.example.com'; // 通常の成功例
82
83echo "URL: {$testUrl} へのHTTPリクエストを開始します。\n";
84
85$result = fetchUrlWithHeadersAndErrorHandling($testUrl);
86
87if ($result) {
88    echo "\n--- リクエスト成功 ---\n";
89    echo "HTTPステータスコード: " . $result['http_code'] . "\n\n";
90
91    echo "--- レスポンスヘッダ ---\n";
92    foreach ($result['headers'] as $header) {
93        if (!empty($header)) { // 空行は表示しない
94            echo $header . "\n";
95        }
96    }
97    echo "\n";
98
99    echo "--- レスポンスボディ (抜粋) ---\n";
100    // ボディ全体を表示すると長くなるため、最初の500文字のみ表示します。
101    echo substr($result['body'], 0, 500) . "...\n";
102} else {
103    echo "\n--- リクエスト失敗 ---\n";
104    echo "URL {$testUrl} へのリクエスト処理中に問題が発生しました。\n";
105    echo "（例えば、接続拒否、ホストが見つからない、タイムアウトなど）\n";
106}
107

このPHPのサンプルコードは、cURL拡張機能を利用して指定されたURLへHTTPリクエストを送信し、その応答であるヘッダ情報とボディの内容を詳しく取得する方法を示しています。システムエンジニアを目指す初心者の皆様がWebサービスとの連携機能を実装する際に非常に役立つ基本的な処理です。

コード内のfetchUrlWithHeadersAndErrorHandling関数は、引数としてリクエスト対象のURLを受け取ります。この関数では、curl_init()でcURLセッションを初期化し、CURLOPT_HEADERでレスポンスヘッダの取得を有効に、CURLOPT_RETURNTRANSFERでレスポンス全体を文字列として取得するよう設定しています。また、CURLOPT_CONNECTTIMEOUTとCURLOPT_TIMEOUTを設定することで、ネットワークの接続拒否や応答遅延といった問題が発生した場合でも、処理が長時間停止するのを防ぎ、安定した動作を確保しています。これは、参照情報にあるCURLPX_REPLY_CONNECTION_REFUSEDが示すような接続エラー（標準cURLではエラーコード7など）の状況にも対応する重要な設定です。

HTTPリクエストの実行後にはcurl_errno()でエラーの有無を確認し、ネットワーク接続の問題などで失敗した場合はエラーメッセージを表示しfalseを返します。成功した場合は、curl_getinfo()を用いてHTTPステータスコードやヘッダサイズを取得し、レスポンス全体からヘッダとボディを正確に分離します。最終的に、取得したHTTPステータスコード、ヘッダの配列、ボディの文字列をまとめた連想配列として関数は値を返します。これにより、Webサーバーからの応答内容を詳細に解析し、次の処理に活用することが可能になります。