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

Copy
1<?php
2
3/**
4 * 指定されたURLへのHTTPリクエストを実行し、そのHTTPステータスコードを取得します。
5 * この関数は、ウェブサイトの可用性を確認したり、APIの応答をチェックしたりする際に役立ちます。
6 *
7 * @param string $url HTTPリクエストを送信するターゲットURL。
8 * @return int|false HTTPステータスコード（例: 200, 404, 500）を返します。
9 *                  リクエストの実行に失敗した場合は false を返します。
10 */
11function getUrlHttpStatusCode(string $url): int|false
12{
13    // cURLセッションを初期化します。
14    // cURLは様々なプロトコル（HTTP, HTTPS, FTPなど）でデータ転送を行うためのライブラリです。
15    $ch = curl_init();
16
17    // cURLセッションの初期化に失敗した場合はエラーを記録し、falseを返します。
18    if ($ch === false) {
19        error_log('cURLセッションの初期化に失敗しました。');
20        return false;
21    }
22
23    // cURLオプションを設定します。
24    // CURLOPT_URL: リクエストを送信するURLを指定します。
25    curl_setopt($ch, CURLOPT_URL, $url);
26    // CURLOPT_RETURNTRANSFER: レスポンスボディを文字列として返却するように設定します。
27    // これをtrueにしないと、curl_exec()がレスポンスを直接出力してしまいます。
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29    // CURLOPT_NOBODY: ボディ部分を取得せず、ヘッダー情報のみを取得するように設定します。
30    // ステータスコードの取得だけであれば、ボディは不要なため、パフォーマンスが向上します。
31    curl_setopt($ch, CURLOPT_NOBODY, true);
32    // CURLOPT_TIMEOUT: 接続と転送の最大秒数を設定します。長すぎる待機を防ぎます。
33    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
34    // CURLOPT_FAILONERROR: HTTPステータスコードが400以上の場合にエラーを発生させます。
35    // （ただし、curl_getinfo()でステータスコードは取得可能）
36    curl_setopt($ch, CURLOPT_FAILONERROR, true);
37
38    // cURLセッションを実行します。
39    // CURLOPT_NOBODYがtrueの場合、この関数の戻り値は通常true（成功）またはfalse（失敗）です。
40    // レスポンスボディは取得されません。
41    curl_exec($ch);
42
43    // curl_errno() を使用して、cURLセッション中にエラーが発生したかを確認します。
44    if (curl_errno($ch)) {
45        // エラーが発生した場合、エラーメッセージを記録します。
46        $error_msg = curl_error($ch);
47        error_log("cURLエラーが発生しました: {$error_msg} (URL: {$url})");
48        // セッションを閉じ、falseを返します。
49        curl_close($ch);
50        return false;
51    }
52
53    // curl_getinfo() を使用して、cURLセッションに関する情報を取得します。
54    // CURLINFO_HTTP_CODE: 実行されたHTTPリクエストの最後のHTTPステータスコードを取得します。
55    // 例えば、200 (OK), 404 (Not Found), 500 (Internal Server Error) などです。
56    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
57
58    // cURLセッションを閉じ、リソースを解放します。
59    curl_close($ch);
60
61    return $httpCode;
62}
63
64// --- 関数利用の例 ---
65
66// 存在すると想定されるURL
67$workingUrl = 'https://www.google.com';
68echo "URL: {$workingUrl}\n";
69$statusCode = getUrlHttpStatusCode($workingUrl);
70
71if ($statusCode !== false) {
72    echo "  HTTPステータスコード: {$statusCode}\n";
73    if ($statusCode >= 200 && $statusCode < 300) {
74        echo "  - 成功 (2xx台)\n";
75    } elseif ($statusCode >= 400 && $statusCode < 500) {
76        echo "  - クライアントエラー (4xx台)\n";
77    } elseif ($statusCode >= 500 && $statusCode < 600) {
78        echo "  - サーバーエラー (5xx台)\n";
79    } else {
80        echo "  - その他のステータスコード\n";
81    }
82} else {
83    echo "  HTTPステータスコードの取得に失敗しました。\n";
84}
85
86echo "\n";
87
88// 存在しない（404を返す可能性が高い）URL
89$notFoundUrl = 'https://www.google.com/non_existent_page_123456789';
90echo "URL: {$notFoundUrl}\n";
91$statusCodeNotFound = getUrlHttpStatusCode($notFoundUrl);
92
93if ($statusCodeNotFound !== false) {
94    echo "  HTTPステータスコード: {$statusCodeNotFound}\n";
95    if ($statusCodeNotFound >= 200 && $statusCodeNotFound < 300) {
96        echo "  - 成功 (2xx台)\n";
97    } elseif ($statusCodeNotFound >= 400 && $statusCodeNotFound < 500) {
98        echo "  - クライアントエラー (4xx台)\n";
99    } elseif ($statusCodeNotFound >= 500 && $statusCodeNotFound < 600) {
100        echo "  - サーバーエラー (5xx台)\n";
101    } else {
102        echo "  - その他のステータスコード\n";
103    }
104} else {
105    echo "  HTTPステータスコードの取得に失敗しました。\n";
106}
107
108?>

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたURLのHTTPステータスコードを取得する方法を示しています。getUrlHttpStatusCode関数は、引数としてHTTPリクエストを送信するターゲットURL（文字列）を受け取ります。関数内部では、まずcURLセッションを初期化し、CURLOPT_URLで送信先URLを設定するほか、CURLOPT_NOBODYをtrueにすることで、ページのコンテンツ（ボディ）を取得せずヘッダー情報のみを要求し、効率的にステータスコードの確認ができるようにしています。

cURLセッションの実行後、curl_getinfo関数と定数CURLINFO_HTTP_CODEを使用し、最終的にサーバーから返されたHTTPステータスコード（例: 200, 404, 500など）を取得します。この関数は、リクエストが成功しステータスコードを取得できた場合はその整数値を返し、cURLの初期化失敗や実行中のエラーが発生した場合はfalseを返します。これにより、ウェブサイトやAPIの稼働状況をプログラム的に確認できるため、システムエンジニアがシステムの健全性を監視する際などに役立ちます。最後に、cURLセッションはcurl_closeで確実に閉じられ、リソースが解放されます。

Copy
1<?php
2
3/**
4 * CURLINFO_PROXYAUTH_AVAIL 定数の使用例を示します。
5 * この定数は、curl_getinfo() 関数に渡すことで、現在利用可能なプロキシ認証方式のビットマスクを取得します。
6 * システムエンジニアを目指す初心者の方へ：
7 * cURL拡張機能が有効になっているか、phpinfo() 関数で確認することをお勧めします。
8 * コマンドラインで `php -i | grep curl` と入力しても確認できます。
9 */
10function demonstrateCurlProxyAuthAvailability(): void
11{
12    // cURL セッションを初期化します。
13    $ch = curl_init();
14
15    if ($ch === false) {
16        echo "エラー: cURLセッションの初期化に失敗しました。" . PHP_EOL;
17        return;
18    }
19
20    // テスト用のURLを設定します。
21    // この例ではプロキシを設定しないため、通常はプロキシ認証は利用不可と判断されます。
22    // 実際にプロキシサーバーが設定されている環境では、異なる認証方式が「利用可能」と表示されることがあります。
23    curl_setopt($ch, CURLOPT_URL, 'https://www.example.com');
24    // リクエストの実行結果を文字列として取得します。
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
26
27    // cURL リクエストを実行します。
28    $response = curl_exec($ch);
29
30    if ($response === false) {
31        echo "エラー: cURLリクエストが失敗しました: " . curl_error($ch) . PHP_EOL;
32        curl_close($ch);
33        return;
34    }
35
36    // CURLINFO_PROXYAUTH_AVAIL 定数を curl_getinfo() に渡して、
37    // 利用可能なプロキシ認証方式のビットマスクを取得します。
38    // リファレンスの「戻り値なし」は、定数自体が関数のように値を返さないという意味です。
39    // この定数を curl_getinfo() に渡すことで、特定の情報を取得できます。
40    $proxyAuthAvailBitmask = curl_getinfo($ch, CURLINFO_PROXYAUTH_AVAIL);
41
42    echo "--- cURL プロキシ認証の利用可能性 ---" . PHP_EOL;
43    echo "利用可能なプロキシ認証方式 (ビットマスク): " . $proxyAuthAvailBitmask . PHP_EOL;
44    echo "（0 はプロキシ認証が利用できないことを意味する場合が多いです）" . PHP_EOL;
45
46    // 取得したビットマスクと、個々の認証方式を示す定数をビットAND演算子で比較し、
47    // 特定の認証方式が利用可能かどうかをチェックします。
48    echo "個々のプロキシ認証方式のチェック:" . PHP_EOL;
49
50    // CURLAUTH_BASIC: 基本認証
51    if ($proxyAuthAvailBitmask & CURLAUTH_BASIC) {
52        echo "  - Basic認証: 利用可能" . PHP_EOL;
53    } else {
54        echo "  - Basic認証: 利用不可" . PHP_EOL;
55    }
56
57    // CURLAUTH_DIGEST: ダイジェスト認証
58    if ($proxyAuthAvailBitmask & CURLAUTH_DIGEST) {
59        echo "  - Digest認証: 利用可能" . PHP_EOL;
60    } else {
61        echo "  - Digest認証: 利用不可" . PHP_EOL;
62    }
63
64    // CURLAUTH_NTLM: NTLM認証
65    if ($proxyAuthAvailBitmask & CURLAUTH_NTLM) {
66        echo "  - NTLM認証: 利用可能" . PHP_EOL;
67    } else {
68        echo "  - NTLM認証: 利用不可" . PHP_EOL;
69    }
70
71    // cURL セッションを閉じます。
72    curl_close($ch);
73}
74
75// 定義した関数を実行します。
76demonstrateCurlProxyAuthAvailability();
77

PHP 8で提供されるCURLINFO_PROXYAUTH_AVAILは、cURL拡張機能で利用できる定数です。この定数自体には引数や戻り値はありませんが、curl_getinfo()関数に第二引数として渡すことで、現在利用可能なプロキシ認証方式をビットマスクとして取得することができます。この機能は、Webアプリケーションがプロキシサーバー経由で外部リソースにアクセスする際に、どのような認証方式に対応しているかを確認するのに役立ちます。

システムエンジニアを目指す初心者の方は、まずphpinfo()関数やコマンドラインでphp -i | grep curlと入力し、PHPにcURL拡張機能が有効になっているか確認してください。

サンプルコードでは、まずcurl_init()でcURLセッションを初期化し、CURLOPT_URLオプションでアクセス先のURLを設定しています。curl_exec()でリクエストを実行した後、curl_getinfo($ch, CURLINFO_PROXYAUTH_AVAIL)を呼び出すことで、利用可能なプロキシ認証方式を示すビットマスク（整数値）を取得しています。このビットマスクは、複数の認証方式が利用可能な場合に、それぞれを示す値を組み合わせた整数値です。例えば、取得したビットマスクとCURLAUTH_BASICなどの定数をビットAND演算子&で比較することで、特定の認証方式が利用可能かどうかを判断できます。最後にcurl_close()でセッションを終了します。これにより、プロキシ認証が設定されている環境で、どの認証方式が利用可能か動的に判定し、適切な処理を行うための基礎を学ぶことができます。