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

Copy
1<?php
2
3/**
4 * 指定されたURLからHTTPレスポンスヘッダを取得します。
5 *
6 * この関数はPHPのCURL拡張機能を使用して、WebサーバーからのHTTPレスポンスの
7 * ヘッダ部分を抽出し、連想配列として返します。
8 *
9 * @param string $url ヘッダを取得する対象のURL。
10 * @return array|false レスポンスヘッダの連想配列 (例: ['Content-Type' => 'text/html'])、
11 *                     またはCURLエラーが発生した場合はfalse。
12 */
13function getHttpResponseHeaders(string $url): array|false
14{
15    // CURLハンドルの初期化
16    $ch = curl_init();
17
18    // URLを設定
19    curl_setopt($ch, CURLOPT_URL, $url);
20
21    // ヘッダ情報をレスポンスに含めるように設定
22    curl_setopt($ch, CURLOPT_HEADER, true);
23
24    // 転送結果を文字列として返すように設定（直接出力しない）
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
26
27    // リダイレクトを自動的に追跡
28    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
29
30    // 最大リダイレクト回数を設定
31    curl_setopt($ch, CURLOPT_MAXREDIRS, 10);
32
33    // 接続のタイムアウト秒数を設定
34    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
35
36    // CURLリクエストを実行し、レスポンス全体（ヘッダとボディ）を取得
37    $response = curl_exec($ch);
38
39    // CURL実行時のエラーをチェック
40    if (curl_errno($ch)) {
41        // エラーが発生した場合、ログに出力して処理を終了
42        error_log("CURL Error fetching headers from {$url}: " . curl_error($ch));
43        curl_close($ch);
44        return false;
45    }
46
47    // レスポンスからヘッダ部分のバイトサイズを取得
48    $headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
49    
50    // CURLハンドルを閉じる
51    curl_close($ch);
52
53    // レスポンスが空の場合
54    if ($response === false) {
55        return false;
56    }
57
58    // レスポンス文字列からヘッダ部分を抽出
59    $headerString = substr($response, 0, $headerSize);
60
61    $headers = [];
62    // ヘッダ文字列を改行で分割し、各行を処理
63    // trim()で末尾の余分な改行を削除
64    $headerLines = explode("\r\n", trim($headerString));
65
66    foreach ($headerLines as $line) {
67        // HTTPステータスライン (例: HTTP/1.1 200 OK) はスキップ
68        if (str_starts_with($line, 'HTTP/')) {
69            continue;
70        }
71
72        // ヘッダ名と値に分割 (最初のコロンのみで分割)
73        $parts = explode(':', $line, 2);
74        if (count($parts) === 2) {
75            $name = trim($parts[0]);
76            $value = trim($parts[1]);
77            
78            // 同じヘッダ名が複数存在する場合 (例: Set-Cookie)、配列として格納
79            if (isset($headers[$name])) {
80                if (!is_array($headers[$name])) {
81                    $headers[$name] = [$headers[$name]];
82                }
83                $headers[$name][] = $value;
84            } else {
85                $headers[$name] = $value;
86            }
87        }
88    }
89
90    return $headers;
91}
92
93// --- サンプル使用例 ---
94
95// ヘッダを取得したいターゲットURLを指定
96$targetUrl = 'https://www.example.com'; 
97
98echo "Fetching HTTP headers from: " . $targetUrl . "\n\n";
99
100// 関数を呼び出してHTTPレスポンスヘッダを取得
101$headers = getHttpResponseHeaders($targetUrl);
102
103// 取得結果を表示
104if ($headers !== false) {
105    echo "--- HTTP Response Headers ---\n";
106    foreach ($headers as $name => $value) {
107        if (is_array($value)) {
108            // 値が配列の場合（同じヘッダ名が複数存在する場合）
109            echo $name . ": " . implode("; ", $value) . "\n";
110        } else {
111            // 値が単一の場合
112            echo $name . ": " . $value . "\n";
113        }
114    }
115} else {
116    echo "エラー: レスポンスヘッダの取得に失敗しました。\n";
117}

このPHPコードは、CURL拡張機能を用いて、指定されたURLからHTTPレスポンスヘッダを取得する関数とその具体的な使用例を提供しています。主要な機能はgetHttpResponseHeaders関数に集約されており、この関数は、引数としてヘッダを取得したいウェブサイトのURL文字列を受け取ります。

関数内では、まずcurl_init()でCURL通信セッションを開始し、curl_setopt()を使ってターゲットURL、レスポンスにヘッダを含める設定、通信結果を直接出力せず文字列として返す設定、リダイレクトの追跡といった各種通信オプションを設定します。その後、curl_exec()を実行してHTTPリクエストを送信し、サーバーからの応答全体を取得します。通信エラーがないことを確認後、curl_getinfo()でレスポンス内のヘッダ部分のサイズを特定し、その情報に基づいてヘッダ文字列を抽出し、連想配列として扱いやすい形に整形します。処理の最後にcurl_close()でCURLセッションを閉じます。

この関数は、HTTPヘッダの取得に成功した場合、ヘッダ名と値のペアを格納した連想配列を返します。例えば、ページのコンテンツタイプやキャッシュに関する情報などを簡単に確認できます。もしCURLの実行中にエラーが発生したり、何らかの理由でヘッダを取得できなかった場合は、戻り値としてfalseを返します。これは、ウェブサービスの応答内容を検証したり、外部APIとの連携時にレスポンスの詳細を解析したりする際に非常に有用な処理です。

Copy
1<?php
2
3/**
4 * CURL_RTSPREQ_DESCRIBE 定数を使用してRTSP DESCRIBE リクエストを送信し、
5 * 詳細なデバッグ情報をファイルに出力するサンプル関数です。
6 *
7 * この関数は、RTSPプロトコルを用いたストリーミングコンテンツの情報を取得する
8 * (DESCRIBEリクエスト) と同時に、cURLがどのように動作しているかを示すデバッグログを
9 * 生成する方法を、システムエンジニアを目指す初心者の方向けに示します。
10 *
11 * 実際のRTSPサーバーは不要ですが、デバッグログは生成されます。
12 * 動作には cURL 拡張機能が有効になっているPHP環境が必要です。
13 */
14function sendRTSPD escribeRequestWithDebug(): void
15{
16    // ダミーのRTSP URL。実際には有効なストリームURLを指定します。
17    $rtspUrl = 'rtsp://example.com/my-stream';
18    // デバッグ情報を書き込むログファイル名
19    $debugLogFile = 'curl_rtsp_debug.log';
20
21    echo "RTSP DESCRIBE リクエストを {$rtspUrl} へ送信しようとしています。\n";
22    echo "詳細なデバッグ情報は {$debugLogFile} に出力されます。\n";
23
24    // cURL セッションを初期化
25    $ch = curl_init();
26
27    if ($ch === false) {
28        echo "cURL セッションの初期化に失敗しました。\n";
29        return;
30    }
31
32    // デバッグログファイルを開く
33    $debugHandle = fopen($debugLogFile, 'w+');
34    if ($debugHandle === false) {
35        echo "デバッグログファイル '{$debugLogFile}' を開けませんでした。書き込み権限を確認してください。\n";
36        curl_close($ch);
37        return;
38    }
39
40    // cURL オプションを設定
41    curl_setopt($ch, CURLOPT_URL, $rtspUrl);
42    // RTSP DESCRIBE リクエストタイプを指定
43    curl_setopt($ch, CURLOPT_RTSP_REQUEST, CURL_RTSPREQ_DESCRIBE);
44    // 詳細なデバッグ情報を有効にする
45    curl_setopt($ch, CURLOPT_VERBOSE, true);
46    // デバッグ情報の出力先をファイルポインタに設定
47    curl_setopt($ch, CURLOPT_STDERR, $debugHandle);
48    // 実行結果を文字列として取得する（通常RTSPではボディはあまり気にしませんが、設定はしておきます）
49    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
50    // ヘッダーも結果に含める
51    curl_setopt($ch, CURLOPT_HEADER, true);
52    // サーバーエラーが発生してもPHPエラーを発生させない
53    curl_setopt($ch, CURLOPT_FAILONERROR, false);
54
55    // cURL リクエストを実行
56    $response = curl_exec($ch);
57
58    // エラーチェック
59    if (curl_errno($ch)) {
60        echo "cURL エラーが発生しました: " . curl_error($ch) . "\n";
61    } else {
62        echo "cURL リクエストが完了しました。\n";
63        // 実際のRTSP DESCRIBEリクエストは通常、SDP (Session Description Protocol) を含むレスポンスボディを返します。
64        // ここではダミーURLのため、接続エラーやタイムアウトなどの情報がデバッグログに記録されます。
65        echo "RTSPサーバーからの応答（ある場合）:\n";
66        echo "--- レスポンスボディ (抜粋) ---\n";
67        echo substr($response, 0, 500) . (strlen($response) > 500 ? '...' : '') . "\n";
68        echo "-------------------------------\n";
69    }
70
71    // cURL セッションを終了
72    curl_close($ch);
73    // デバッグログファイルを閉じる
74    fclose($debugHandle);
75
76    echo "デバッグログファイル '{$debugLogFile}' を確認してください。\n";
77}
78
79// 関数を実行
80sendRTSPD escribeRequestWithDebug();
81
82?>

PHP 8で利用可能なCURL_RTSPREQ_DESCRIBEは、cURL拡張機能が提供する定数の一つです。この定数自体は引数を取らず、戻り値もありません。RTSP（Real Time Streaming Protocol）において、メディアストリームのセッション情報（例えば、利用可能なコーデックや転送プロトコルなど）を取得するための「DESCRIBE」リクエストを行う際に使用されます。具体的には、curl_setopt()関数でCURLOPT_RTSP_REQUESTオプションにこの定数を設定することで、cURLがDESCRIBEリクエストを生成するように指示します。

サンプルコードでは、このCURL_RTSPREQ_DESCRIBE定数を用いてRTSP DESCRIBEリクエストをダミーのURLに対して送信しています。さらに、CURLOPT_VERBOSEオプションをtrueに、CURLOPT_STDERRオプションをファイルポインタに設定することで、cURLの内部的な通信の詳細やエラーメッセージなどのデバッグ情報を指定したログファイルに記録しています。これにより、RTSP通信がどのように行われているか、また問題が発生した場合に何が原因かを、初心者のシステムエンジニアの方でもデバッグログから確認できるようになります。cURLの初期化からオプション設定、リクエスト実行、エラーチェック、リソース解放までの一連の流れが示されており、通信処理のデバッグ手法を学ぶ上で役立つでしょう。ログファイルを確認することで、リクエストの送信状況やサーバーからの応答（またはエラー）を詳細に把握できます。