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

Copy
1<?php
2
3// ストリーム操作中に発生するイベントを処理するためのコールバック関数です。
4// STREAM_NOTIFY_REDIRECTED は、HTTPストリームがリダイレクトされた際に通知されるイベントコードです。
5// PHPの stream_context_create 関数で 'notification' オプションとして設定されます。
6function handleStreamNotification(
7    int $notification_code,
8    int $severity,
9    string $message,
10    int $message_code,
11    int $bytes_transferred,
12    int $bytes_max
13): void {
14    echo "--- ストリーム通知 --- (" . date('H:i:s') . ")\n";
15    echo "  通知コード: " . $notification_code;
16    // STREAM_NOTIFY_REDIRECTED 定数の値は整数です。
17    // PHP 8では、この定数は int 型の値を持ちます。
18    echo " (STREAM_NOTIFY_REDIRECTED=" . STREAM_NOTIFY_REDIRECTED . ")\n";
19    echo "  重大度: " . $severity . "\n";
20    echo "  メッセージ: " . $message . "\n";
21    echo "  メッセージコード: " . $message_code . "\n";
22    echo "  転送済みバイト数: " . $bytes_transferred . "\n";
23    echo "  予想される最大バイト数: " . $bytes_max . "\n";
24    
25    // STREAM_NOTIFY_REDIRECTED は、HTTPリクエストが別のURLへリダイレクトされたときに発生します。
26    // このイベントをキャッチすることで、リダイレクトの検出や、新しいURLの取得などが可能になります。
27    if ($notification_code === STREAM_NOTIFY_REDIRECTED) {
28        echo "  *** HTTPリダイレクトが検出されました！ ***\n";
29        // リダイレクト先のURLなど、詳細な情報は $message 変数に含まれることがあります。
30        echo "  リダイレクト先URLの可能性: " . $message . "\n";
31    }
32    echo "----------------------\n";
33}
34
35/**
36 * 指定されたURLからコンテンツをノンブロッキングモードで取得し、
37 * ストリーム通知を処理する例です。
38 *
39 * @param string $url 取得するURL。HTTP/HTTPSプロトコルをサポートします。
40 */
41function fetchUrlNonBlockingWithNotifications(string $url): void
42{
43    // ストリームコンテキストを作成し、通知コールバックを設定します。
44    // ここでは、HTTPプロトコルのストリームオプションも設定できます。
45    $context = stream_context_create([
46        'http' => [
47            'timeout' => 10, // 接続および読み込みのタイムアウトを10秒に設定
48            'user_agent' => 'PHP Stream Notifier/1.0', // ユーザーエージェントを設定
49            'follow_location' => true, // リダイレクトを自動で追跡するかどうか
50        ],
51    ], [
52        'notification' => 'handleStreamNotification', // 上で定義したコールバック関数を設定
53    ]);
54
55    echo ">>> URLに接続を試行中: {$url}\n";
56
57    // fopen関数で指定されたURLを開きます。
58    // 'r' は読み込みモード、false は include_path を使用しないことを意味します。
59    // $context を渡すことで、上記のストリームコンテキストが適用されます。
60    $stream = @fopen($url, 'r', false, $context);
61
62    if (!$stream) {
63        echo "!!! エラー: URL '{$url}' を開けませんでした。ネットワーク接続やURLを確認してください。\n";
64        return;
65    }
66
67    // ストリームをノンブロッキングモードに設定します。
68    // stream_set_blocking(リソース, ブロッキングモード);
69    // 第二引数に false を指定するとノンブロッキングモードになります。
70    // このモードでは、データの読み込みや書き込み時に、データが利用可能になるまで待機せず、
71    // 即座に関数が戻り、利用可能なデータがあればそれを返します。データがなければ空を返します。
72    echo ">>> ストリームをノンブロッキングモードに設定中...\n";
73    stream_set_blocking($stream, false);
74
75    echo ">>> ストリームからデータをノンブロッキングで読み込み中 ('.' はデータ受信を示します)...\n";
76    $content = '';
77    $startTime = microtime(true);
78    
79    // feof($stream) はファイルの終端に達したかどうかをチェックします。
80    // ノンブロッキングモードでは、データがない場合に `fread` が空文字列を返すことがあるため、
81    // `stream_select` を使って読み込み可能な状態になるまで待機するのが一般的です。
82    while (!feof($stream)) {
83        $read_streams = [$stream]; // 読み込みを監視するストリームの配列
84        $write_streams = [];       // 書き込みを監視するストリームの配列 (この例では使用しない)
85        $except_streams = [];      // 例外を監視するストリームの配列 (この例では使用しない)
86        
87        // stream_select() は、監視対象のストリームの中で準備ができたものが現れるまで待機します。
88        // 第4引数に0を指定すると、タイムアウトなしでポーリング（即座にチェックして戻る）します。
89        // 第5引数はマイクロ秒単位のタイムアウトですが、第4引数が0の場合は無視されます。
90        $num_changed_streams = stream_select($read_streams, $write_streams, $except_streams, 0);
91
92        if ($num_changed_streams === false) {
93            echo "!!! エラー: stream_select が失敗しました。\n";
94            break;
95        } elseif ($num_changed_streams > 0) {
96            // 読み込み可能なストリームがある場合、fread() でデータを読み込みます。
97            $buffer = fread($stream, 8192); // 8KBずつ読み込む
98            if ($buffer === false || $buffer === '') {
99                // 読み込みエラー、またはノンブロッキングでデータがない場合の空文字列
100                // feof()がまだfalseでも、これ以上データがない可能性があるのでループを抜ける
101                break; 
102            }
103            $content .= $buffer;
104            echo "."; // データ受信のインジケータ
105        } else {
106            // 読み込み可能なデータがない場合、CPUを占有しないよう少し待機します。
107            usleep(50000); // 50ミリ秒 (0.05秒) 待機
108        }
109
110        // タイムアウトを設けることで、無限ループを防ぎます。
111        if ((microtime(true) - $startTime) > 20) { // 20秒以上経過したらタイムアウト
112            echo "\n!!! 処理がタイムアウトしました。\n";
113            break;
114        }
115    }
116    echo "\n";
117
118    // ストリームを閉じます。
119    fclose($stream);
120
121    echo "\n--- 取得したコンテンツの最初の200バイト ---\n";
122    // 取得したコンテンツが長い場合、最初の部分のみ表示します。
123    echo mb_substr($content, 0, 200) . (mb_strlen($content) > 200 ? '...' : '') . "\n";
124    echo "--- 処理完了 ---\n";
125}
126
127// -----------------------------------------------------------
128// 使用例:
129// -----------------------------------------------------------
130
131// 一般的なURLにアクセスする例です。接続や読み込みの通知は発生しますが、
132// リダイレクトが発生しない限り STREAM_NOTIFY_REDIRECTED は通知されません。
133fetchUrlNonBlockingWithNotifications("http://www.php.net");
134
135// 実際にリダイレクトが発生するURLの例です。
136// このURLを使用すると、handleStreamNotification 関数内で
137// STREAM_NOTIFY_REDIRECTED の通知を確認できます。
138// ただし、httpbin.org は外部サービスであり、常に安定稼働しているとは限りません。
139// fetchUrlNonBlockingWithNotifications("http://httpbin.org/redirect-to?url=http://httpbin.org/get");
140
141?>

このPHPサンプルコードは、ストリーム操作におけるイベント通知とノンブロッキングモードでのデータ取得方法を、システムエンジニアを目指す初心者にも理解しやすいように示しています。STREAM_NOTIFY_REDIRECTEDは、HTTPストリームが別のURLへリダイレクトされた際に通知されるint型の定数です。コールバック関数handleStreamNotificationは、この定数を含む様々なイベントコードをint型の引数で受け取り、それぞれに応じた処理を行います。特に、STREAM_NOTIFY_REDIRECTEDが検出された際には、HTTPリダイレクトの発生を知らせるメッセージを表示し、リダイレクト先の情報が含まれる可能性のあるメッセージも出力します。このコールバック関数は、stream_context_createで作成するストリームコンテキストに設定され、fopenで開かれるURLに適用されます。

fetchUrlNonBlockingWithNotifications関数内では、stream_set_blocking関数を用いて開かれたストリームをノンブロッキングモードに設定しています。この関数は、第一引数に操作対象のストリームリソースを、第二引数にfalse（ノンブロッキング）またはtrue（ブロッキング）を指定します。ノンブロッキングモードでは、freadなどの読み込み関数がデータが利用可能になるまで待機せず、即座に戻り、データがない場合は空の文字列を返します。サンプルコードでは、stream_selectを利用してデータが読み込み可能になるまで効率的に監視しながらデータを取得し、同時にイベント通知も処理することで、応答性の高いネットワーク通信を実現しています。

Copy
1<?php
2
3/**
4 * 指定されたURLからデータをタイムアウト付きでダウンロードします。
5 *
6 * この関数は、PHPのストリーム機能とstream_set_timeout関数を使用して、
7 * ネットワーク通信時の待機時間（タイムアウト）を制御する方法を示します。
8 *
9 * @param string $url ダウンロードするURL
10 * @param int $timeout タイムアウト秒数。この時間内にデータが受信されない場合、接続は中断されます。
11 * @return string|false ダウンロードされたデータ。タイムアウトまたはエラーが発生した場合はfalseを返します。
12 */
13function downloadWithTimeout(string $url, int $timeout): string|false
14{
15    // 1. ストリームを開く
16    // 'r' モードで読み込み専用のストリームを開きます。
17    // @ を付けてfopen関数のエラーメッセージを抑制し、後でエラーチェックを行います。
18    $stream = @fopen($url, 'r');
19
20    if ($stream === false) {
21        echo "エラー: URL '{$url}' を開けませんでした。URLが正しいか、ネットワーク接続を確認してください。\n";
22        return false;
23    }
24
25    // 2. stream_set_timeout関数でタイムアウトを設定
26    // この関数は、ストリームからのデータ読み込みが指定された時間以上ブロックされた場合に、
27    // 操作を中断するための制限を設定します。
28    // 最初の引数: ストリームリソース
29    // 第二引数: タイムアウトの秒数
30    if (!stream_set_timeout($stream, $timeout)) {
31        echo "警告: ストリームのタイムアウト設定に失敗しました。続行しますが、タイムアウトは機能しない可能性があります。\n";
32        // 失敗した場合でも処理を続行するが、ここではエラーとして扱う
33        fclose($stream);
34        return false;
35    }
36
37    // 3. ストリームからすべての内容を読み込む
38    // stream_get_contents関数は、ストリームの最後まで読み込みを試みます。
39    // タイムアウトが設定されている場合、指定時間内にデータが来なければ中断されます。
40    $contents = stream_get_contents($stream);
41
42    // 4. ストリームのメタデータを取得し、タイムアウトしたかチェック
43    // stream_get_meta_data関数は、ストリームの状態に関する情報を提供します。
44    // その中の 'timed_out' キーは、ストリーム操作がタイムアウトしたかどうかを示します。
45    $metaData = stream_get_meta_data($stream);
46
47    // 5. ストリームを閉じる
48    // 開いたストリームは必ず閉じることが重要です。
49    fclose($stream);
50
51    // 6. タイムアウトまたは読み込みエラーの処理
52    if ($metaData['timed_out']) {
53        echo "エラー: URL '{$url}' へのアクセスがタイムアウトしました ({$timeout}秒)。\n";
54        return false;
55    }
56
57    if ($contents === false) {
58        echo "エラー: URL '{$url}' から内容を読み込めませんでした。ストリームに問題があった可能性があります。\n";
59        return false;
60    }
61
62    // 正常にデータを取得できた場合
63    return $contents;
64}
65
66// --- 使用例 ---
67// 実際に存在する、一般的に高速に応答するURL
68$targetUrl = 'http://example.com/';
69$fastResponseTimeout = 5; // 5秒のタイムアウトを設定
70
71echo "--- 正常ケース: URLアクセス試行 (タイムアウト: {$fastResponseTimeout}秒) ---\n";
72$data = downloadWithTimeout($targetUrl, $fastResponseTimeout);
73
74if ($data !== false) {
75    echo "URL '{$targetUrl}' からデータを正常に取得しました。\n";
76    echo "取得データの最初の100文字:\n";
77    // マルチバイト文字対応のためmb_substrを使用
78    echo mb_substr($data, 0, 100) . "...\n\n";
79} else {
80    echo "URL '{$targetUrl}' からデータの取得に失敗しました。\n\n";
81}
82
83echo "--- タイムアウトする可能性のあるケース: 短いタイムアウトでURLアクセス試行 ---\n";
84$shortTimeout = 1; // 1秒の短いタイムアウトを設定
85
86// 通常、example.comは1秒以内に応答するため、この例で確実にタイムアウトを発生させるには
87// 非常に遅いサーバーや存在しないURLを使用する必要があります。
88// しかし、stream_set_timeoutがどのように機能するかを示すには有効です。
89echo "URL '{$targetUrl}' へのアクセス (タイムアウト: {$shortTimeout}秒) を試行します。\n";
90$dataShortTimeout = downloadWithTimeout($targetUrl, $shortTimeout);
91
92if ($dataShortTimeout !== false) {
93    echo "URL '{$targetUrl}' からデータを正常に取得しました (短いタイムアウトにもかかわらず)。\n";
94    echo "(これは、サーバーが指定した時間内に応答したことを意味します。)\n";
95} else {
96    echo "URL '{$targetUrl}' からデータの取得に失敗しました (短いタイムアウト)。\n";
97    echo "(この場合、タイムアウトした可能性が高いです。)\n";
98}
99
100// 参考情報: STREAM_NOTIFY_REDIRECTED はストリームがリダイレクトされた際に
101// stream_notification_callbackに渡される定数で、stream_set_timeoutとは直接関連しませんが、
102// どちらもPHPのストリーム操作に関連する機能です。

このサンプルコードは、PHPで指定されたURLからデータをダウンロードする際に、タイムアウトを設定する方法を示しています。downloadWithTimeout関数は、fopenでURLストリームを開き、stream_set_timeout関数を使用してネットワーク通信時の待機時間を制御します。stream_set_timeoutは、最初の引数にストリームリソース、二番目の引数にタイムアウト秒数を受け取り、ストリームからのデータ読み込みが指定時間以上ブロックされた場合に操作を中断する設定を行います。関数が正常に設定された場合はtrue、失敗した場合はfalseを返します。設定後、stream_get_contentsでストリームの内容を読み込み、stream_get_meta_dataでストリームの情報を取得し、timed_outキーで実際にタイムアウトが発生したかを確認します。これにより、ネットワークの応答が遅い場合でも、アプリケーションが無限に待ち続けることを防ぎ、安定した動作を保つことが可能です。最終的に、データ取得の成否やタイムアウトの有無に応じて、ダウンロードされたデータまたはfalseを返します。なお、リファレンス情報にあるSTREAM_NOTIFY_REDIRECTEDは、ストリームがリダイレクトされた際に通知される定数で、このサンプルコードのstream_set_timeoutとは直接関連しませんが、共にPHPのストリーム操作に関連する機能の一つです。