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

Copy
1<?php
2
3/**
4 * 指定されたURLにHTTP GETリクエストを送信し、
5 * HTTPステータスコードと利用可能なHTTP認証情報を取得して表示します。
6 *
7 * @param string $url リクエストを送信するURL
8 * @return void
9 */
10function fetchAndDisplayCurlInfo(string $url): void
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    // cURLオプションを設定します。
16    // リクエストを送信するURLを指定します。
17    curl_setopt($ch, CURLOPT_URL, $url);
18    // レスポンスデータを文字列として取得し、直接出力しないように設定します。
19    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
20    // HTTPリダイレクトを自動的に追跡するように設定します。
21    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
22
23    // cURLセッションを実行し、レスポンスを取得します。
24    $response = curl_exec($ch);
25
26    // cURL実行中にエラーが発生したかチェックします。
27    if (curl_errno($ch)) {
28        echo "cURLエラーが発生しました: " . curl_error($ch) . "\n";
29        // エラーが発生した場合は、セッションを閉じ、関数を終了します。
30        curl_close($ch);
31        return;
32    }
33
34    // HTTPステータスコードを取得します。
35    // これは、キーワード「php curlinfo_http_code」に関連する情報で、
36    // 成功なら200、ページが見つからないなら404などを示します。
37    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
38    echo "URL: " . $url . "\n";
39    echo "HTTPステータスコード: " . $httpCode . "\n";
40
41    // 利用可能なHTTP認証情報を取得します。
42    // これは、リファレンス情報「CURLINFO_HTTPAUTH_AVAIL」に関連する情報です。
43    // サーバーがWWW-Authenticateヘッダを返した場合、利用可能な認証タイプを示す
44    // ビットマスク（複数の認証タイプを同時に示す値）を返します。
45    $httpAuthAvail = curl_getinfo($ch, CURLINFO_HTTPAUTH_AVAIL);
46    echo "利用可能なHTTP認証情報 (CURLINFO_HTTPAUTH_AVAIL): ";
47    if ($httpAuthAvail === 0) {
48        echo "なし (またはサーバーから認証情報が提供されていません)\n";
49    } else {
50        echo "利用可能 (ビットマスク値: " . $httpAuthAvail . ").\n";
51        // 具体的な認証タイプが利用可能かチェックします。
52        if ($httpAuthAvail & CURLAUTH_BASIC) {
53            echo "  - Basic認証が利用可能です。\n";
54        }
55        if ($httpAuthAvail & CURLAUTH_DIGEST) {
56            echo "  - Digest認証が利用可能です。\n";
57        }
58        // 他のCURLAUTH_*定数も同様にチェックできます。
59    }
60
61    // cURLセッションを閉じ、リソースを解放します。
62    curl_close($ch);
63}
64
65// --- サンプルコードの実行 ---
66// 一般的なウェブサイトの情報を取得する例です。
67// このURLでは通常、HTTP認証は不要なため、CURLINFO_HTTPAUTH_AVAILは「なし」と表示されます。
68fetchAndDisplayCurlInfo("https://www.example.com");

このPHPのサンプルコードは、fetchAndDisplayCurlInfo関数を通じて、指定されたURLへHTTP GETリクエストを送信し、その結果として得られる様々な情報を取得・表示する方法を示しています。この関数は引数としてリクエスト対象の$url（文字列）を受け取り、処理結果を直接画面に出力するため、戻り値はありません。

まず、curl_init()でcURLセッションを初期化し、curl_setopt()でリクエスト先のURL、レスポンスを文字列として取得する設定、HTTPリダイレクトの自動追跡などを指定します。その後、curl_exec()で実際にHTTPリクエストを実行し、エラーが発生した場合はcurl_errno()で検出して表示します。

リクエストが成功すると、curl_getinfo()関数を使って様々な情報を取得できます。キーワードであるCURLINFO_HTTP_CODEは、HTTPリクエストのステータスを示す数値（例えば成功なら200、ページが見つからないなら404など）を取得します。

本リファレンス情報であるCURLINFO_HTTPAUTH_AVAILは、サーバーがどのようなHTTP認証方法に対応しているかを示す情報です。これもcurl_getinfo()で取得し、サーバーがBasic認証やDigest認証などの認証情報を返した場合、そのタイプを示すビットマスク値が設定されます。この値が0の場合は利用可能な認証がないことを意味し、0以外の場合は対応する認証タイプが存在することを示します。サンプルコードでは、このビットマスク値を使って具体的な認証タイプ（例: CURLAUTH_BASIC）が利用可能かを確認する方法も示されています。最後に、curl_close()でcURLセッションを閉じ、リソースを解放します。

Copy
1<?php
2
3/**
4 * 指定されたURLへのHTTP GETリクエストを実行し、
5 * 実際にサーバーに送信されたリクエストヘッダを取得する関数です。
6 *
7 * システムエンジニアを目指す初心者向けに、PHPのcURLライブラリの
8 * 基本的な使い方と、curl_getinfo() 関数で送信ヘッダ情報を取得するための
9 * CURLINFO_HEADER_OUT 定数の利用方法を示します。
10 *
11 * @param string $url リクエストを送信するターゲットURL。
12 * @return string|null 送信されたリクエストヘッダの文字列。cURLエラーが発生した場合はnull。
13 */
14function getSentRequestHeader(string $url): ?string
15{
16    // cURLセッションを初期化します。
17    // これが失敗すると false が返されます。
18    $ch = curl_init();
19
20    // cURL初期化に失敗した場合はエラーメッセージを出力し、処理を終了します。
21    if ($ch === false) {
22        echo "エラー: cURLの初期化に失敗しました。\n";
23        return null;
24    }
25
26    // cURLオプションを設定します。
27    // CURLOPT_URL: リクエストを送信するURLを指定します。
28    curl_setopt($ch, CURLOPT_URL, $url);
29
30    // CURLOPT_RETURNTRANSFER: curl_exec() の実行結果を直接出力せず、
31    // 文字列として関数から返却するように設定します。
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33
34    // (CURLINFO_HEADER_OUT は curl_getinfo() の引数として渡す定数であり、
35    // curl_setopt() で設定するオプションではありません。
36    // リクエスト実行後にこの定数を指定して curl_getinfo() を呼び出すことで、
37    // 送信されたヘッダ情報を取得できます。)
38
39    // HTTPリクエストを実行し、サーバーからのレスポンスを取得します。
40    $response = curl_exec($ch);
41
42    // cURL実行中にエラーが発生したかチェックします。
43    // curl_errno() はエラーコードを返します（エラーがなければ0）。
44    if (curl_errno($ch)) {
45        echo 'cURLエラー: ' . curl_error($ch) . "\n";
46        curl_close($ch); // エラー発生時もセッションを閉じます。
47        return null;
48    }
49
50    // 実際にサーバーに送信されたHTTPリクエストヘッダの文字列を取得します。
51    // ここで CURLINFO_HEADER_OUT 定数を使用します。
52    $requestHeader = curl_getinfo($ch, CURLINFO_HEADER_OUT);
53
54    // cURLセッションを閉じ、使用したリソースを解放します。
55    curl_close($ch);
56
57    // 取得したリクエストヘッダを返します。
58    return $requestHeader;
59}
60
61// --- サンプル使用例 ---
62
63// リクエストを送信するターゲットURLを指定します。
64// 例として、一般的にアクセス可能なWebサイトのURLを使用します。
65$targetUrl = 'https://www.google.com';
66
67echo "ターゲットURL: " . $targetUrl . "\n\n";
68
69// 関数を呼び出して、送信されたリクエストヘッダを取得します。
70$headerOut = getSentRequestHeader($targetUrl);
71
72if ($headerOut !== null) {
73    echo "--- 実際に送信されたHTTPリクエストヘッダ ---\n";
74    echo $headerOut;
75    echo "--------------------------------------------\n";
76} else {
77    echo "リクエストヘッダの取得に失敗しました。\n";
78}
79

このPHPコードは、指定されたURLへHTTP GETリクエストを送信し、実際にサーバーに送られたリクエストヘッダの情報を取得する方法を示すものです。システムエンジニアを目指す初心者の方のために、PHPのcURLライブラリの基本的な使い方を解説しています。

まず、getSentRequestHeader関数は、リクエスト先のURLを$url引数として受け取ります。内部ではcurl_init()でcURLセッションを初期化し、curl_setopt()を使ってリクエストのURLや、結果を文字列として返す設定を行います。リクエストの実行はcurl_exec()で行われ、その後にcurl_getinfo()関数とCURLINFO_HEADER_OUT定数を使用することで、実際に送信されたHTTPリクエストヘッダの文字列を取得します。CURLINFO_HEADER_OUTは、cURLセッションが送信したヘッダ情報を取得するための定数であり、リクエストの詳細な挙動を確認する際に役立ちます。最後に、curl_close()でセッションを閉じ、リソースを解放します。この関数は、成功した場合は送信ヘッダの文字列を返し、cURLエラーが発生した場合はnullを返します。エラーチェックにはcurl_errno()やcurl_error()が利用されます。