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

Copy
1<?php
2
3/**
4 * 指定されたURLのコンテンツをダウンロードし、そのサイズ（バイト単位）をcURLで取得する関数。
5 * CURLINFO_CONTENT_LENGTH_DOWNLOAD_T を使用することで、非常に大きなファイルサイズにも対応します。
6 * この関数は実際にコンテンツをメモリに読み込むため、非常に大きなファイルを扱う際はメモリ使用量に注意が必要です。
7 *
8 * @param string $url 取得対象のURL
9 * @return int|false コンテンツ長（バイト単位）を整数で返します。エラー時は false を返します。
10 */
11function getDownloadedContentLength(string $url): int|false
12{
13    // cURLセッションを初期化します。
14    $ch = curl_init();
15
16    // cURLの初期化に失敗した場合のハンドリング
17    if ($ch === false) {
18        error_log("cURL の初期化に失敗しました。");
19        return false;
20    }
21
22    // 取得するURLを設定します。
23    curl_setopt($ch, CURLOPT_URL, $url);
24
25    // 転送結果を文字列として直接出力せず、関数の戻り値として取得するよう設定します。
26    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
27
28    // レスポンスヘッダーを結果に含めないよう設定します。
29    curl_setopt($ch, CURLOPT_HEADER, false);
30
31    // 接続および転送の最大時間を設定します (秒単位)。
32    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
33
34    // リダイレクトがあった場合に自動的に追跡するよう設定します。
35    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
36
37    // cURLセッションを実行し、コンテンツを実際にダウンロードします。
38    // ダウンロードされたコンテンツは $downloadedContent 変数に格納されます。
39    $downloadedContent = curl_exec($ch);
40
41    // cURLの実行中にエラーが発生した場合のハンドリング
42    if ($downloadedContent === false) {
43        error_log("cURL エラー: " . curl_error($ch));
44        curl_close($ch);
45        return false;
46    }
47
48    // ダウンロードが完了した後、CURLINFO_CONTENT_LENGTH_DOWNLOAD_T を使用して
49    // 実際に転送されたコンテンツのサイズ（バイト単位）を取得します。
50    // PHP 8では、この値は64ビット整数をサポートする int 型で返されます。
51    $contentLength = curl_getinfo($ch, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T);
52
53    // cURLセッションを閉じ、リソースを解放します。
54    curl_close($ch);
55
56    // 取得したコンテンツ長が有効な値（0以上）であればそれを返し、
57    // そうでなければ取得失敗として false を返します。
58    return ($contentLength >= 0) ? (int)$contentLength : false;
59}
60
61// サンプルコードの使用例
62$targetUrl = "https://www.php.net/images/logos/php-logo.svg"; // 例としてPHPロゴのURLを使用
63
64echo "--- リモートコンテンツのダウンロードサイズ取得 --- \n";
65
66$length = getDownloadedContentLength($targetUrl);
67
68if ($length !== false) {
69    echo "ターゲットURL: " . $targetUrl . "\n";
70    echo "ダウンロードされたコンテンツ長: \n";
71    echo "  - " . $length . " バイト\n";
72    echo "  - " . number_format($length / 1024, 2) . " KB\n";
73    echo "  - " . number_format($length / (1024 * 1024), 2) . " MB\n";
74} else {
75    echo "ターゲットURL: " . $targetUrl . "\n";
76    echo "コンテンツ長の取得に失敗しました。\n";
77}
78
79echo "-------------------------------------------------- \n";
80
81// 存在しないURLやエラーが発生する可能性のあるURLの例
82$errorUrl = "http://example.com/nonexistent-file.txt";
83echo "\n--- エラーケースの例 --- \n";
84$errorLength = getDownloadedContentLength($errorUrl);
85if ($errorLength !== false) {
86    echo "ターゲットURL: " . $errorUrl . "\n";
87    echo "ダウンロードされたコンテンツ長: " . $errorLength . " バイト\n";
88} else {
89    echo "ターゲットURL: " . $errorUrl . "\n";
90    echo "コンテンツ長の取得に失敗しました。(想定通り)\n";
91}
92echo "------------------------- \n";
93
94?>

CURLINFO_CONTENT_LENGTH_DOWNLOAD_Tは、PHPのcURL拡張機能において、リモートサーバーから実際にダウンロードされたコンテンツのサイズ（バイト単位）を取得するための定数です。PHP 8からは、この定数を使用することで64ビット整数を扱うことができ、非常に大きなファイルサイズにも対応できるようになりました。

提供されたサンプルコードのgetDownloadedContentLength関数は、指定されたURL（引数$url）からコンテンツをダウンロードし、そのサイズを計測するものです。関数内では、まずcurl_initでcURLセッションを開始し、curl_setoptで取得対象のURLや、コンテンツを直接出力せず戻り値として取得する設定、リダイレクトを追跡する設定など、転送に関する様々なオプションを設定します。

その後、curl_execを実行して実際にコンテンツをダウンロードし、その結果を変数に格納します。ダウンロードが完了したら、curl_getinfo関数にCURLINFO_CONTENT_LENGTH_DOWNLOAD_T定数を指定することで、実際に転送されたコンテンツの正確なバイトサイズを取得できます。この値は成功時にはint型で返され、エラーが発生した場合はfalseが返されます。最後にcurl_closeでcURLリソースを適切に解放します。これにより、ウェブコンテンツのダウンロードサイズを正確に把握し、アプリケーションの処理に活用できます。ただし、ダウンロードされたコンテンツはメモリ上に展開されるため、非常に大きなファイルを扱う際はメモリ使用量にご注意ください。

Copy
1<?php
2
3/**
4 * 指定されたURLからダウンロードされるコンテンツの長さを取得します。
5 * CURLINFO_CONTENT_LENGTH_DOWNLOAD_T 定数を使用して、
6 * ダウンロードが開始された、または完了したコンテンツのバイト長を取得します。
7 * この定数は、Content-Length ヘッダーの値や、実際に転送されたデータの長さを反映します。
8 * 特に大きなサイズのコンテンツでも正確に扱うことを意図しています。
9 *
10 * @param string $url 取得対象のURL。
11 * @return float|false ダウンロードされるコンテンツの長さ (バイト単位)。
12 *                     Content-Length ヘッダーがない場合や不明な場合は -1.0。
13 *                     cURL操作に失敗した場合は false を返します。
14 */
15function getRemoteContentLength(string $url): float|false
16{
17    // cURL セッションを初期化します。
18    // cURL は様々なプロトコルでネットワーク通信を行うためのライブラリです。
19    $ch = curl_init();
20
21    // cURL 初期化が失敗したかを確認します。
22    if ($ch === false) {
23        echo "エラー: cURL 初期化に失敗しました。\n";
24        return false;
25    }
26
27    // cURL オプションを設定します。
28    // CURLOPT_URL: リクエストを送信する URL を設定します。
29    curl_setopt($ch, CURLOPT_URL, $url);
30
31    // CURLOPT_RETURNTRANSFER: curl_exec() が結果を文字列として返すように設定します。
32    // これを true にしない場合、curl_exec() は直接結果を出力します。
33    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
34
35    // CURLOPT_HEADER: レスポンスヘッダーを含めるかどうかを設定します。
36    // ここではボディのみを取得したいので false に設定します。
37    curl_setopt($ch, CURLOPT_HEADER, false);
38
39    // cURL セッションを実行し、レスポンスを取得します。
40    // この時点で、指定されたURLのコンテンツがダウンロードされます。
41    $response = curl_exec($ch);
42
43    // cURL 実行が失敗したかを確認します。
44    if ($response === false) {
45        echo "エラー: cURL 実行エラー - " . curl_error($ch) . "\n";
46        curl_close($ch);
47        return false;
48    }
49
50    // CURLINFO_CONTENT_LENGTH_DOWNLOAD_T 定数を使用して、
51    // ダウンロードされたコンテンツの長さを取得します。
52    // この値は Content-Length ヘッダーから取得されるか、
53    // 実際にダウンロードされたバイト数に基づいて計算されます。
54    // -1.0 は Content-Length ヘッダーがないことを示します。
55    $contentLength = curl_getinfo($ch, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T);
56
57    // cURL セッションを終了し、リソースを解放します。
58    curl_close($ch);
59
60    return $contentLength;
61}
62
63// サンプルとして、PHPのfaviconのURLを使用します。
64// これはContent-Lengthヘッダーを持つ静的なファイルであることが期待されます。
65$sampleUrl = "https://www.php.net/favicon.ico";
66
67echo "対象URL: " . $sampleUrl . "\n";
68
69// 関数を呼び出してコンテンツ長を取得します。
70$length = getRemoteContentLength($sampleUrl);
71
72// 取得結果に応じてメッセージを表示します。
73if ($length !== false) {
74    if ($length >= 0) {
75        echo "ダウンロードされるコンテンツの長さ: " . $length . " バイト\n";
76    } else {
77        echo "Content-Length ヘッダーが見つからないか、不明です (-1.0)。\n";
78    }
79} else {
80    echo "コンテンツ長の取得に失敗しました。\n";
81}

このサンプルコードは、PHPのcURL拡張機能とCURLINFO_CONTENT_LENGTH_DOWNLOAD_T定数を利用して、指定されたURLからダウンロードされるコンテンツの長さを取得する方法を示しています。

getRemoteContentLength関数は、対象となるURLを文字列型の引数$urlとして受け取ります。関数内では、まずcURLセッションを初期化し、失敗した場合はエラーメッセージを表示してfalseを返します。次に、curl_setopt()関数で、リクエスト先のURL（CURLOPT_URL）を設定し、curl_exec()が結果を文字列として返すようにCURLOPT_RETURNTRANSFERをtrueに設定します。レスポンスヘッダーは不要なため、CURLOPT_HEADERはfalseにします。

curl_exec()を実行することで実際のネットワーク通信が行われ、指定されたURLのコンテンツがダウンロードされます。通信に失敗した場合もエラーを処理します。

最も重要な部分は、curl_getinfo($ch, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T)です。ここでCURLINFO_CONTENT_LENGTH_DOWNLOAD_T定数を使用し、ダウンロードされたコンテンツのバイト長を取得しています。この定数は、サーバーが返すContent-Lengthヘッダーの値、または実際に転送されたデータの長さを反映し、大きなファイルでも正確に扱うことを目的としています。コンテンツ長が不明な場合は-1.0が返されます。

最後にcurl_close()でcURLセッションを終了し、リソースを解放します。この関数は、コンテンツ長を浮動小数点数（float）で返すか、cURL操作が失敗した場合にはfalseを返します。サンプルコードではPHP公式サイトのfaviconを例に、関数を呼び出し、取得したコンテンツ長を表示する一連の流れを確認できます。