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

Copy
1<?php
2
3/**
4 * CURLリクエストを実行し、その結果をログファイルに記録します。
5 *
6 * この関数は、指定されたURLに対してHTTP GETリクエストを送信し、
7 * リクエストの成否、HTTPステータスコード、およびCURLエラー情報を
8 * 指定されたログファイルに追記します。
9 * CURL_RTSPREQ_RECORD定数もCURL機能の一部としてログに記録されます。
10 *
11 * @param string $url リクエストを送信するターゲットURL。
12 * @param string $logFilePath ログを記録するファイルのパス。
13 * @return bool CURL操作とログ記録が成功した場合はtrue、それ以外はfalse。
14 */
15function executeCurlRequestAndLog(string $url, string $logFilePath): bool
16{
17    // CURL_RTSPREQ_RECORD はRTSPプロトコルのレコードリクエストを示す定数です。
18    // このサンプルではRTSP通信は行いませんが、CURL関連の定数としてその値をログに含めます。
19    $rtspRecordConstantValue = CURL_RTSPREQ_RECORD;
20
21    $logMessage = sprintf("--- CURL Request Log (%s) ---\n", date('Y-m-d H:i:s'));
22    $logMessage .= sprintf("Target URL: %s\n", $url);
23    $logMessage .= sprintf("CURL_RTSPREQ_RECORD constant value: %d\n", $rtspRecordConstantValue);
24
25    // cURLセッションを初期化
26    $ch = curl_init();
27
28    if (false === $ch) {
29        $logMessage .= "Error: Failed to initialize cURL session.\n";
30        file_put_contents($logFilePath, $logMessage, FILE_APPEND | LOCK_EX);
31        return false;
32    }
33
34    // 基本的なCURLオプションを設定
35    curl_setopt($ch, CURLOPT_URL, $url);
36    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);    // 結果を文字列で返す
37    curl_setopt($ch, CURLOPT_HEADER, false);          // レスポンスヘッダを含めない
38    curl_setopt($ch, CURLOPT_TIMEOUT, 10);            // タイムアウト秒数
39    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);   // リダイレクトを追跡
40
41    // cURLリクエストを実行
42    $response = curl_exec($ch);
43
44    // エラー情報とHTTPステータスコードを取得
45    $curlError = curl_error($ch);
46    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
47
48    if ($response === false) {
49        // リクエストが失敗した場合
50        $logMessage .= sprintf("CURL Error: %s\n", empty($curlError) ? "Unknown error" : $curlError);
51        $logMessage .= sprintf("HTTP Status Code: %d\n", $httpCode);
52        $logMessage .= "Request failed.\n";
53        $success = false;
54    } else {
55        // リクエストが成功した場合
56        $logMessage .= sprintf("Request successful. HTTP Status Code: %d\n", $httpCode);
57        $logMessage .= "Response length: " . strlen($response) . " bytes\n";
58        // ログファイル肥大化防止のため、通常はレスポンス本文を全て記録しません
59        $success = true;
60    }
61
62    // cURLセッションを終了（リソースを解放）
63    curl_close($ch);
64
65    $logMessage .= "---------------------------------------\n\n";
66
67    // ログファイルに追記 (FILE_APPEND:ファイルの末尾に追記, LOCK_EX:排他ロック)
68    if (file_put_contents($logFilePath, $logMessage, FILE_APPEND | LOCK_EX) === false) {
69        error_log("Failed to write to log file: " . $logFilePath);
70        return false;
71    }
72
73    return $success;
74}
75
76// --- サンプルコードの実行例 ---
77// このPHPスクリプトをCLIで実行すると、CURLリクエストが実行され、
78// その結果が 'curl_request.log' というファイルに記録されます。
79
80$targetUrl = "https://www.example.com"; // アクセスするターゲットURL
81// __DIR__ は現在のスクリプトが配置されているディレクトリのパスを表します。
82// この場合、スクリプトと同じディレクトリにログファイルが作成されます。
83$logFile = __DIR__ . '/curl_request.log';
84
85// 必要であれば、既存のログファイルをクリアするには以下の行のコメントを解除してください。
86// file_put_contents($logFile, '');
87
88echo "CURLリクエストを実行し、結果をログに記録します。\n";
89echo "ターゲットURL: " . $targetUrl . "\n";
90echo "ログファイル: " . $logFile . "\n\n";
91
92if (executeCurlRequestAndLog($targetUrl, $logFile)) {
93    echo "CURLリクエストの実行とログ記録が成功しました。\n";
94} else {
95    echo "CURLリクエストの実行またはログ記録に失敗しました。詳細はログファイル (" . $logFile . ") を確認してください。\n";
96}
97
98echo "\n--- 失敗例を試行中 (存在しないドメインへアクセス) ---\n";
99$failUrl = "http://nonexistent-domain-for-test-xyz123.com"; // 意図的に失敗させるための存在しないドメイン
100echo "ターゲットURL (失敗例): " . $failUrl . "\n\n";
101
102if (executeCurlRequestAndLog($failUrl, $logFile)) {
103    echo "CURLリクエストの実行とログ記録が成功しました。(これは通常、予期しない結果です)\n";
104} else {
105    echo "CURLリクエストの実行またはログ記録に失敗しました。(これは予期された結果です)\n";
106}

このPHPコードは、cURLという機能を使って指定されたURLへHTTPリクエストを送信し、その結果をログファイルに記録するものです。特に、CURL_RTSPREQ_RECORDという定数の値もログ情報の一部として記録しています。この定数はRTSPプロトコルにおける「レコード（記録）リクエスト」を示すものですが、このサンプルではCURL関連の定数としてその値を紹介するために含まれています。

コードの流れとしては、まずcurl_init()で通信セッションを開始し、curl_setopt()でリクエスト先のURLやレスポンスの取得方法、タイムアウト時間などの詳細な設定を行います。設定後、curl_exec()で実際にウェブサーバーへリクエストを送信し、その結果やHTTPステータスコード、エラー情報を取得します。

取得した情報は、file_put_contents()関数を使って、指定されたログファイルに追記されます。FILE_APPENDオプションはファイルの末尾に追記することを意味し、LOCK_EXオプションは同時に複数のプロセスが書き込もうとした際に競合しないよう、排他ロックをかける役割があります。

executeCurlRequestAndLog関数は、アクセスしたいウェブサイトのURLを$urlとして、ログを記録するファイルのパスを$logFilePathとして受け取ります。そして、CURLでの通信とログへの記録処理が全て成功した場合はtrueを、いずれかの段階で失敗した場合はfalseを戻り値として返します。このコードを通じて、ウェブ通信とその結果の記録方法の基本を学ぶことができます。

Copy
1<?php
2
3/**
4 * CURL_RTSPREQ_RECORD 定数を使用してRTSP RECORDリクエストを送信するサンプル関数。
5 *
6 * この関数は、RTSPプロトコルにおける「RECORD」（録画開始）リクエストを
7 * 送信するためのcURLオプション設定を示します。
8 * 実際のリクエストを成功させるには、適切なRTSPサーバーのURLが必要です。
9 *
10 * @param string $rtspUrl ターゲットのRTSPサーバーのURL
11 * @return string|false リクエストのレスポンス全体（ヘッダーとボディ）、または失敗時にはfalse
12 */
13function sendRTSPRecordRequest(string $rtspUrl): string|false
14{
15    // cURLセッションを初期化します。
16    $ch = curl_init();
17
18    if ($ch === false) {
19        // cURLの初期化に失敗した場合のエラーメッセージ
20        error_log("cURLセッションの初期化に失敗しました。");
21        return false;
22    }
23
24    // リクエスト先のRTSPサーバーURLを設定します。
25    curl_setopt($ch, CURLOPT_URL, $rtspUrl);
26
27    // RTSPプロトコルでRECORDリクエストを送信するように設定します。
28    // CURL_RTSPREQ_RECORD は、RTSPサーバーに対して録画開始を要求するための定数です。
29    curl_setopt($ch, CURLOPT_RTSP_REQUEST, CURL_RTSPREQ_RECORD);
30
31    // レスポンスを文字列として取得し、直接出力しないように設定します。
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33
34    // レスポンスヘッダーもレスポンス文字列に含めるように設定します。
35    curl_setopt($ch, CURLOPT_HEADER, true);
36
37    // 冗長な情報（デバッグ情報）を標準エラー出力に表示するように設定します。
38    // 開発時には役立ちますが、本番環境では無効にすることが多いです。
39    curl_setopt($ch, CURLOPT_VERBOSE, true);
40
41    // cURLリクエストを実行し、レスポンスを取得します。
42    $response = curl_exec($ch);
43
44    // cURLリクエストの実行中にエラーが発生したかを確認します。
45    if (curl_errno($ch)) {
46        // エラーが発生した場合、エラーメッセージをログに出力します。
47        error_log('cURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch));
48        $response = false;
49    } else {
50        // HTTPステータスコードを取得します。
51        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
52        echo "HTTPステータスコード: " . $httpCode . "\n";
53
54        // レスポンスの表示（VERBOSEがtrueの場合、デバッグ情報も標準エラー出力に出ます）
55        echo "--- レスポンス全体 ---\n";
56        echo $response . "\n";
57        echo "----------------------\n";
58    }
59
60    // cURLセッションを閉じ、リソースを解放します。
61    curl_close($ch);
62
63    return $response;
64}
65
66// --- サンプルコードの実行例 ---
67// 注意: 以下のRTSP URLは例です。このコードを実際に動作させるには、
68// ネットワーク上で到達可能な有効なRTSPサーバーのURLに置き換える必要があります。
69// 適切なRTSPサーバーがない場合、接続エラーやタイムアウトエラーなどが発生する可能性があります。
70$targetRTSPUrl = 'rtsp://example.com/live/stream/record';
71
72echo "RTSP RECORDリクエストを送信します...\n";
73$result = sendRTSPRecordRequest($targetRTSPUrl);
74
75if ($result !== false) {
76    echo "RTSP RECORDリクエストが完了しました。\n";
77} else {
78    echo "RTSP RECORDリクエストが失敗しました。\n";
79}
80
81?>

このサンプルコードは、PHPのcURL拡張機能とCURL_RTSPREQ_RECORD定数を用いて、RTSP（Real-Time Streaming Protocol）プロトコルにおける「RECORD」（録画開始）リクエストを送信する方法を示しています。CURL_RTSPREQ_RECORDは、RTSPサーバーに対し、指定されたメディアストリームの録画開始を要求するために使用される定数です。

sendRTSPRecordRequest関数は、引数としてターゲットとなるRTSPサーバーのURLを受け取ります。この関数内部では、まずcurl_init()でcURLセッションを初期化し、CURLOPT_URLオプションでリクエスト先のURLを設定します。そして、CURLOPT_RTSP_REQUESTオプションにCURL_RTSPREQ_RECORD定数を設定することで、RECORDリクエストのタイプを指定しています。CURLOPT_RETURNTRANSFERは、実行結果を文字列として返すように設定し、CURLOPT_HEADERはレスポンスヘッダーも取得するようにします。CURLOPT_VERBOSEは開発時に役立つ詳細なデバッグ情報を表示するための設定です。

curl_exec()で実際のリクエストが実行され、成功すればRTSPサーバーからのレスポンス全体（ヘッダーとボディを含む文字列）が返されます。リクエスト中にエラーが発生した場合は、curl_errno()でエラーを確認し、エラーメッセージをログに出力した後、関数はfalseを返します。最後にcurl_close()でセッションを閉じ、リソースを解放します。このコードを実際に動作させるためには、有効なRTSPサーバーのURLが必要となります。