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

Copy
1<?php
2
3/**
4 * cURLリクエストを実行し、全体タイムアウトと低速タイムアウトの設定例を示します。
5 *
6 * @param string $url リクエストを送信するURL。
7 * @param int $timeout 転送全体の最大実行時間（秒）。0に設定すると無限（非推奨）。
8 * @param int $lowSpeedLimit 低速とみなす最小転送速度（バイト/秒）。
9 * @param int $lowSpeedTime $lowSpeedLimitを下回る速度がこの秒数続いた場合に転送を中止する時間（秒）。
10 * @return string|false 成功した場合はレスポンスボディ、失敗した場合はfalse。
11 */
12function fetchUrlWithTimeoutSettings(
13    string $url,
14    int $timeout = 10,
15    int $lowSpeedLimit = 1,
16    int $lowSpeedTime = 5
17): string|false {
18    // cURLハンドルの初期化
19    $ch = curl_init();
20
21    if ($ch === false) {
22        echo "エラー: cURLの初期化に失敗しました。\n";
23        return false;
24    }
25
26    // 取得するURLを設定
27    curl_setopt($ch, CURLOPT_URL, $url);
28
29    // 転送結果を文字列として返すように設定
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
31
32    // === タイムアウト設定 ===
33
34    // 1. 全体タイムアウト (CURLOPT_TIMEOUT)
35    // 転送処理全体の最大実行時間を秒単位で設定します。
36    // この時間内に転送が完了しない場合、cURLはエラーを返します。
37    // この設定は、サーバーが無応答であったり、非常に遅い応答しか返さない場合に役立ちます。
38    curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
39
40    // 2. 低速タイムアウト (CURLOPT_LOW_SPEED_LIMIT および CURLOPT_LOW_SPEED_TIME)
41    // 転送速度が遅すぎる場合に、転送を中止するための設定です。
42    // データ転送が始まっているものの、その速度が期待を下回る場合に有用です。
43
44    // CURLOPT_LOW_SPEED_LIMIT: 低速とみなす転送速度のしきい値をバイト/秒で設定します。
45    // 例: 1バイト/秒を下回る速度を低速とみなします。
46    curl_setopt($ch, CURLOPT_LOW_SPEED_LIMIT, $lowSpeedLimit);
47
48    // CURLOPT_LOW_SPEED_TIME: CURLOPT_LOW_SPEED_LIMITで設定した速度を下回る状態が
49    // この秒数継続した場合に、転送を中止します。
50    // 例: 5秒間、1バイト/秒を下回る速度が続けばタイムアウトします。
51    curl_setopt($ch, CURLOPT_LOW_SPEED_TIME, $lowSpeedTime);
52
53    // cURLリクエストを実行
54    $response = curl_exec($ch);
55
56    // エラーチェック
57    if (curl_errno($ch)) {
58        $errorMessage = curl_error($ch);
59        $errorCode = curl_errno($ch);
60        echo "cURLエラー (コード: {$errorCode}): {$errorMessage}\n";
61
62        // タイムアウトが原因のエラーの場合、より詳細なメッセージを表示
63        if ($errorCode === CURLE_OPERATION_TIMEDOUT) {
64            echo "リクエストが設定された時間内に完了しませんでした（タイムアウト）。\n";
65        }
66        curl_close($ch);
67        return false;
68    }
69
70    // cURLハンドルのクローズ
71    curl_close($ch);
72
73    return $response;
74}
75
76// === 使用例 ===
77// この例では 'https://example.com' を使用しますが、
78// 実際の低速タイムアウトをテストするには、非常に遅い応答をするサーバや、
79// 大きなファイルをダウンロードする際に低い CURLOPT_LOW_SPEED_LIMIT を設定して試す必要があります。
80$targetUrl = 'https://example.com';
81
82echo "URL: {$targetUrl} からデータを取得します。\n";
83
84// デフォルト設定で実行
85// (全体タイムアウト10秒, 低速制限1バイト/秒, 低速時間5秒)
86$result = fetchUrlWithTimeoutSettings($targetUrl);
87
88if ($result !== false) {
89    echo "成功: レスポンスボディの最初の200文字:\n";
90    echo substr($result, 0, 200) . "...\n";
91} else {
92    echo "失敗しました。\n";
93}
94
95echo "\n--- 異なるタイムアウト設定の例 (より厳しい低速タイムアウト条件) ---\n";
96// 全体タイムアウトを5秒、低速制限を100バイト/秒、低速時間を2秒に設定
97// この設定では、より早く低速タイムアウトが発生する可能性があります。
98$resultStrict = fetchUrlWithTimeoutSettings(
99    $targetUrl,
100    timeout: 5,            // 全体タイムアウト: 5秒
101    lowSpeedLimit: 100,    // 低速とみなす転送速度: 100バイト/秒
102    lowSpeedTime: 2        // 2秒間低速が続けば中止
103);
104
105if ($resultStrict !== false) {
106    echo "成功 (厳格な低速タイムアウト設定): レスポンスボディの最初の200文字:\n";
107    echo substr($resultStrict, 0, 200) . "...\n";
108} else {
109    echo "失敗しました (厳格な低速タイムアウト設定)。\n";
110}
111

このPHPサンプルコードは、cURL拡張機能を利用してウェブサイトからデータを取得する際に、リクエストのタイムアウト設定を行う方法を示しています。特に、通信が遅い場合にリクエストを中断するための「低速タイムアウト」について詳細に解説しています。

fetchUrlWithTimeoutSettings関数は、指定されたURLに対してHTTPリクエストを実行し、応答を返します。この関数には、以下の引数があります。$urlはリクエストを送信する対象のURLです。$timeoutは、リクエスト全体の最大実行時間を秒単位で設定し、この時間内に処理が完了しない場合にタイムアウトエラーが発生します。$lowSpeedLimitは、低速とみなす転送速度のしきい値をバイト/秒で指定します。そして、今回の焦点であるCURLOPT_LOW_SPEED_TIMEに対応する$lowSpeedTimeは、$lowSpeedLimitで設定した転送速度を下回る状態がこの秒数継続した場合に、転送を中止する設定を行います。これにより、応答が極端に遅くてもデータが少しずつ流れてくるような状況で、無駄な待機時間を短縮できます。

関数内では、curl_init()でcURLセッションを初期化し、CURLOPT_URLで対象URLを設定します。CURLOPT_RETURNTRANSFERは、レスポンスを文字列として取得するための設定です。主要なタイムアウト設定として、CURLOPT_TIMEOUTで全体のタイムアウトを設定し、さらにCURLOPT_LOW_SPEED_LIMITとCURLOPT_LOW_SPEED_TIMEを組み合わせて低速時のタイムアウト条件を定義します。その後、curl_exec()でリクエストを実行し、エラーが発生した場合はその詳細を出力してfalseを返します。成功時には、取得したレスポンスボディの文字列を返します。最後にcurl_close()でセッションを閉じます。

Copy
1<?php
2
3/**
4 * cURLを使用して指定されたURLからコンテンツを取得します。
5 * この関数は、低速な通信を検出してタイムアウトさせる設定と、HTTPリダイレクトに従う設定を含みます。
6 *
7 * @param string $url 取得対象のURL。
8 * @param int $low_speed_time 低速と判断する秒数。この秒数の間、データ転送速度が$low_speed_limitを下回るとcURL操作を中止します。
9 * @param int $low_speed_limit 低速と判断する最低転送速度 (バイト/秒)。
10 * @return string|false 成功した場合は取得したコンテンツの文字列、失敗した場合はfalse。
11 */
12function fetch_url_with_low_speed_timeout(string $url, int $low_speed_time = 30, int $low_speed_limit = 1)
13{
14    // cURLセッションを初期化します。
15    $ch = curl_init();
16
17    // cURLセッションの初期化に失敗した場合の処理
18    if ($ch === false) {
19        // エラーメッセージをログに出力し、falseを返します。
20        error_log('CURL ERROR: cURLセッションの初期化に失敗しました。');
21        return false;
22    }
23
24    // cURLオプションを設定します。
25    // ----------------------------------------------------
26    // 1. 取得するURLを設定します。
27    curl_setopt($ch, CURLOPT_URL, $url);
28
29    // 2. HTTPリダイレクトに従うように設定します。(キーワードに関連)
30    // サーバーがHTTPリダイレクト(例: 301 Moved Permanently, 302 Found)を返した場合、
31    // cURLは自動的にリダイレクト先の新しいURLにリクエストを送信します。
32    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
33
34    // 3. 低速なデータ転送時のタイムアウト設定 (リファレンス情報: CURLOPT_LOW_SPEED_TIME)
35    // CURLOPT_LOW_SPEED_TIME:
36    // このオプションで指定された秒数 ($low_speed_time) の間、
37    // データ転送速度がCURLOPT_LOW_SPEED_LIMITで指定された値 ($low_speed_limit) を下回った場合、
38    // cURL操作を中止（タイムアウト）させます。
39    curl_setopt($ch, CURLOPT_LOW_SPEED_TIME, $low_speed_time);
40    
41    // CURLOPT_LOW_SPEED_LIMIT:
42    // cURL操作を中止させる最低転送速度 (バイト/秒) を設定します。
43    // 例えば、$low_speed_time が30秒で $low_speed_limit が1の場合、
44    // 30秒間ずっと転送速度が1バイト/秒を下回ると、cURL操作がタイムアウトします。
45    curl_setopt($ch, CURLOPT_LOW_SPEED_LIMIT, $low_speed_limit);
46
47    // 4. curl_exec() の戻り値としてデータを文字列で取得するように設定します。
48    // このオプションをtrueにすることで、`curl_exec()` が取得したコンテンツを直接出力せず、
49    // 文字列として関数が返すようになります。
50    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
51
52    // 5. SSL証明書の検証を無効化 (開発/テスト用途では便利ですが、本番環境では非推奨です)
53    // 本番環境ではセキュリティのため、適切なSSL証明書の検証を設定してください。
54    // 例: CURLOPT_CAINFO を使用して信頼できるCA証明書バンドルを指定するなど。
55    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
56    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
57    // ----------------------------------------------------
58
59    // cURLセッションを実行し、サーバーからのレスポンスを取得します。
60    $response = curl_exec($ch);
61
62    // cURL操作中にエラーが発生したか確認します。
63    if (curl_errno($ch)) {
64        $error_msg = curl_error($ch);
65        // エラーの種類を特定してログに出力します。
66        if (curl_errno($ch) === CURLE_OPERATION_TIMEDOUT) {
67            error_log("CURL ERROR: cURL操作がタイムアウトしました (低速タイムアウトまたは接続タイムアウト)。詳細: " . $error_msg);
68        } else {
69            error_log("CURL ERROR: cURL操作中にエラーが発生しました。詳細: " . $error_msg);
70        }
71        // cURLリソースを解放します。
72        curl_close($ch);
73        return false;
74    }
75
76    // cURLセッションを閉じ、使用したリソースを解放します。
77    curl_close($ch);
78
79    return $response;
80}
81
82// === この関数がどのように動作するかを示す例 ===
83
84// 実際のウェブサイトのURLを指定してください。
85// 例1: 通常のウェブページ
86// $target_url = 'https://example.com'; 
87// 例2: リダイレクトをテストできるURL (リダイレクト後にexample.comに遷移)
88$target_url = 'https://httpbin.org/redirect-to?url=https://example.com';
89// 例3: 低速回線での動作をシミュレートするには、特定のネットワーク環境やサーバー設定が必要です。
90// この例では、単純なURLで設定の効果を示します。
91
92echo "--- cURL操作の開始 ---\n";
93echo "対象URL: " . $target_url . "\n";
94echo "低速タイムアウト設定: " . "30秒間1バイト/秒を下回るとcURL操作を中止します。\n";
95echo "リダイレクトには自動的に従います。\n";
96
97// fetch_url_with_low_speed_timeout 関数を呼び出してコンテンツを取得します。
98$content = fetch_url_with_low_speed_timeout(
99    $target_url,
100    30, // 30秒
101    1   // 1バイト/秒
102);
103
104if ($content !== false) {
105    echo "\n--- コンテンツの取得に成功しました ---\n";
106    // 取得したコンテンツの最初の200文字を表示します。
107    // 長いコンテンツの場合でも表示が簡潔になるように、mb_substrで切り詰めています。
108    echo "取得したコンテンツの最初の200文字:\n";
109    echo mb_substr($content, 0, 200) . "...\n";
110} else {
111    echo "\n--- コンテンツの取得に失敗しました ---\n";
112    echo "詳細については、PHPのエラーログ (通常はウェブサーバーのエラーログ) を確認してください。\n";
113}
114
115echo "--- cURL操作の終了 ---\n";
116

このPHPサンプルコードは、cURLライブラリを用いて指定されたURLからウェブコンテンツを取得するfetch_url_with_low_speed_timeout関数を定義しています。この関数は、特に通信速度が遅い場合に処理が止まってしまうのを防ぐためのタイムアウト設定と、ウェブサイトのリダイレクトに自動で追従する機能を含んでいます。

関数は$url（取得対象のURL）、$low_speed_time（低速と判断する秒数）、$low_speed_limit（低速と判断する最低転送速度、バイト/秒）の3つの引数を受け取ります。

CURLOPT_FOLLOWLOCATIONオプションは、ウェブサーバーがHTTPリダイレクト（例: 301や302）を指示した場合に、cURLが自動的に新しいURLにアクセスし直すように設定しています。これにより、ユーザーはリダイレクト処理を意識せずに最終的なコンテンツを取得できます。

CURLOPT_LOW_SPEED_TIMEはCURLOPT_LOW_SPEED_LIMITと連携して動作します。CURLOPT_LOW_SPEED_TIMEで指定された秒数の間、データ転送速度がCURLOPT_LOW_SPEED_LIMITで設定された値（バイト/秒）を下回り続けた場合、cURL操作は自動的にタイムアウトして中止されます。これにより、非常に遅い通信環境で延々と待機してしまう事態を防ぎ、処理の応答性を高めます。

また、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec関数が取得したコンテンツを直接出力せず、文字列として関数の戻り値として返却するようにしています。SSL証明書の検証については、開発・テスト環境向けに無効化していますが、本番環境ではセキュリティのため有効にすることが推奨されます。

関数は、コンテンツの取得に成功した場合はその文字列を返し、cURLエラーやタイムアウトなど、何らかの理由で取得に失敗した場合はfalseを返します。このエラーハンドリングにより、問題発生時に原因を特定しやすくなっています。