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

Copy
1<?php
2
3/**
4 * 指定されたURLからファイルをダウンロードし、最大ファイルサイズを制限する関数。
5 *
6 * システムエンジニアを目指す初心者向けに、CURLOPT_MAXFILESIZE オプションの利用方法を示します。
7 * このオプションは、ダウンロードするファイルの最大サイズをバイト単位で指定し、
8 * これを超えるとダウンロードが停止しエラーとなります。
9 *
10 * @param string $url ダウンロード対象のファイルのURL。
11 * @param string $destinationPath ダウンロードしたファイルを保存するローカルパス。
12 * @param int $maxFileSize 許容する最大ファイルサイズ (バイト単位)。
13 * @return void
14 */
15function downloadFileWithMaxSize(string $url, string $destinationPath, int $maxFileSize): void
16{
17    // cURL セッションを初期化します。
18    $ch = curl_init();
19
20    // ダウンロードしたデータを書き込むファイルポインタを開きます。
21    // 'wb' モードはバイナリ書き込み用で、ファイルが存在すれば上書きされます。
22    $fp = fopen($destinationPath, 'wb');
23    if ($fp === false) {
24        echo "エラー: ファイル '{$destinationPath}' を開けませんでした。\n";
25        return;
26    }
27
28    // cURL オプションを設定します。
29    curl_setopt($ch, CURLOPT_URL, $url);                  // ダウンロードするファイルのURLを設定。
30    curl_setopt($ch, CURLOPT_FILE, $fp);                  // ダウンロードしたデータを直接ファイルポインタに書き込むよう指定 (CURLOPT_FILE)。
31    curl_setopt($ch, CURLOPT_MAXFILESIZE, $maxFileSize);  // ダウンロードするファイルの最大サイズをバイト単位で設定 (CURLOPT_MAXFILESIZE)。
32    curl_setopt($ch, CURLOPT_FAILONERROR, true);          // HTTPエラー (例: 404 Not Found, 500 Internal Server Error) が発生した場合にcURLを失敗とみなします。
33
34    // cURL セッションを実行し、ファイルのダウンロードを開始します。
35    $result = curl_exec($ch);
36
37    // ダウンロードの結果をチェックします。
38    if ($result === false) {
39        // エラーが発生した場合、エラー情報（エラー番号とメッセージ）を取得します。
40        $errorNo = curl_errno($ch);
41        $errorMsg = curl_error($ch);
42
43        // ファイルサイズ超過エラー (CURLE_FILESIZE_EXCEEDED) かどうかを確認します。
44        if ($errorNo === CURLE_FILESIZE_EXCEEDED) {
45            echo "ダウンロード失敗: ファイルサイズが上限 {$maxFileSize} バイトを超過しました。\n";
46        } else {
47            echo "ダウンロード失敗: cURLエラー ({$errorNo}): {$errorMsg}\n";
48        }
49
50        // ダウンロードが失敗した場合、部分的に書き込まれたファイルを削除します。
51        if (file_exists($destinationPath)) {
52            unlink($destinationPath);
53            echo "部分的にダウンロードされたファイル '{$destinationPath}' を削除しました。\n";
54        }
55    } else {
56        // ダウンロードが成功した場合。
57        echo "ダウンロード成功: ファイル '{$destinationPath}' に保存しました。\n";
58    }
59
60    // cURL セッションを閉じ、リソースを解放します。
61    curl_close($ch);
62
63    // ファイルポインタを閉じ、ファイルを保存します。
64    fclose($fp);
65}
66
67// --- 使用例 ---
68
69// 実際にダウンロードを試すURL。PHPロゴのSVGファイル（約8KB）を使用します。
70$targetUrl = 'https://www.php.net/images/logos/php-logo.svg';
71
72// 1. 正常ケース: ダウンロードするファイルサイズが上限内である場合
73echo "--- 正常ケースの試行 (ファイルサイズが上限内) ---\n";
74$destinationFile_success = 'downloaded_php_logo_small.svg';
75$maxDownloadSize_success = 20 * 1024; // 20KB を最大ダウンロードサイズとして設定
76// PHPロゴ(約8KB)は20KBの制限内に収まるため、正常にダウンロードされます。
77downloadFileWithMaxSize($targetUrl, $destinationFile_success, $maxDownloadSize_success);
78echo "\n";
79
80// 2. エラーケース: ダウンロードするファイルサイズが上限を超える場合
81echo "--- エラーケースの試行 (ファイルサイズが上限超過) ---\n";
82$destinationFile_error = 'downloaded_php_logo_large_fail.svg';
83$maxDownloadSize_error = 5 * 1024; // 5KB を最大ダウンロードサイズとして設定
84// PHPロゴ(約8KB)は5KBの制限を超えるため、ダウンロードが失敗します。
85downloadFileWithMaxSize($targetUrl, $destinationFile_error, $maxDownloadSize_error);
86
87?>

このサンプルコードは、PHPのcURLライブラリを使用して、指定されたURLからファイルをダウンロードする際に、その最大ファイルサイズを制限する方法を、システムエンジニアを目指す初心者向けに解説しています。

CURLOPT_MAXFILESIZEは、cURLセッションでダウンロードするファイルの最大サイズをバイト単位で設定するための定数です。このオプションを利用すると、指定したサイズを超えるファイルのダウンロードは自動的に停止され、エラーとして扱われます。これにより、予期せぬ大容量ファイルのダウンロードを抑制し、システムリソースの消費を効果的に管理できます。

コードではまず、curl_init()でcURLセッションを初期化し、fopen()でダウンロードしたデータを保存するファイルポインタを開きます。次に、curl_setopt()関数を用いて各種オプションを設定します。CURLOPT_URLでダウンロード元のURLを、CURLOPT_FILEでダウンロードデータを直接書き込むファイルポインタを指定し、そしてCURLOPT_MAXFILESIZEに最大許容ファイルサイズをバイト単位で設定します。設定が完了したら、curl_exec()を実行してダウンロードを開始します。

ダウンロード中にファイルサイズが上限を超過した場合、curl_exec()は失敗し、curl_errno()からCURLE_FILESIZE_EXCEEDEDという特定のエラーコードが取得できます。これにより、ファイルサイズ超過によるダウンロード失敗を明確に判別し、適切なエラー処理（例えば、部分的にダウンロードされたファイルの削除など）を行うことができます。最後に、curl_close()でcURLセッションを、fclose()でファイルポインタを閉じ、リソースを解放します。

サンプルコードの関数downloadFileWithMaxSizeは、ダウンロード対象のURL ($url)、ファイルを保存するローカルパス ($destinationPath)、許容する最大ファイルサイズ ($maxFileSize) の3つの引数を受け取ります。この関数は特定の戻り値を返さず (void)、ダウンロードの成否に関するメッセージを標準出力に表示します。使用例では、サイズ制限内で成功するケースと、制限を超過して失敗するケースが示されており、CURLOPT_MAXFILESIZEの動作を具体的に確認できます。

Copy
1<?php
2
3/**
4 * 指定されたURLにPOSTリクエストを送信します。
5 *
6 * この関数はCURLOPT_POSTFIELDSを使用してPOSTデータを設定し、
7 * HTTP POSTリクエストを実行する方法を示しています。
8 *
9 * @param string $url POSTリクエストの送信先URL。
10 * @param array $postData 送信するPOSTデータ（キーと値のペアの配列）。
11 * @return string|false 成功した場合はレスポンスボディ、失敗した場合はfalseを返します。
12 */
13function sendHttpPostRequest(string $url, array $postData): string|false
14{
15    // 1. cURLセッションを初期化
16    $ch = curl_init();
17
18    // cURL初期化に失敗した場合はエラーログを出力し、falseを返す
19    if ($ch === false) {
20        error_log('cURL初期化に失敗しました。');
21        return false;
22    }
23
24    // 2. POSTデータをクエリ文字列形式に変換
25    //    これは "key1=value1&key2=value2" のような形式になります。
26    //    CURLOPT_POSTFIELDSに配列を直接渡すと、multipart/form-data形式で送信されます。
27    //    ここではより一般的なapplication/x-www-form-urlencoded形式のために変換します。
28    $postFields = http_build_query($postData);
29
30    // 3. cURLオプションを設定
31    // リクエストを送信するURLを設定
32    curl_setopt($ch, CURLOPT_URL, $url);
33    // POSTリクエストとして設定
34    curl_setopt($ch, CURLOPT_POST, true);
35    // 送信するPOSTデータを設定
36    curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
37    // レスポンスを文字列として返すように設定（これによりcurl_execが結果を返します）
38    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
39
40    // 4. リクエストを実行し、レスポンスを取得
41    $response = curl_exec($ch);
42
43    // 5. エラーチェック
44    if (curl_errno($ch)) {
45        $errorMsg = curl_error($ch);
46        $errorNo = curl_errno($ch);
47        error_log("cURLエラー ({$errorNo}): {$errorMsg}");
48        // エラー発生時はセッションを閉じてからfalseを返す
49        curl_close($ch);
50        return false;
51    }
52
53    // 6. cURLセッションを閉じる
54    curl_close($ch);
55
56    return $response;
57}
58
59// サンプル使用例:
60// 実際の環境では、存在するPOSTリクエストを受け付けるURLに置き換えてください。
61// 例として、POSTリクエストを受け付けてその内容を返すダミーのエンドポイントを使用します。
62$targetUrl = 'https://postman-echo.com/post';
63$dataToSend = [
64    'user_id' => 123,
65    'username' => 'sample_user',
66    'email' => 'user@example.com'
67];
68
69echo "POSTリクエストを送信中: {$targetUrl}\n";
70echo "送信データ: " . json_encode($dataToSend, JSON_UNESCAPED_UNICODE) . "\n\n";
71
72$result = sendHttpPostRequest($targetUrl, $dataToSend);
73
74if ($result !== false) {
75    echo "POSTリクエスト成功！\n";
76    echo "レスポンス:\n";
77    echo $result; // サーバーからのレスポンスを表示
78} else {
79    echo "POSTリクエスト失敗。\n";
80}
81

このコードは、PHP 8のcURL拡張機能を用いてHTTP POSTリクエストを送信する方法を示すサンプルです。sendHttpPostRequest関数は、指定されたURLへ配列形式のPOSTデータを送信し、その応答を受け取ります。

まず、curl_init()でcURLセッションを初期化し、リクエストの準備を始めます。次に、送信するPOSTデータはhttp_build_query()を使ってURLエンコードされた文字列形式（例: key1=value1&key2=value2）に変換されます。これは、Webフォームで一般的なapplication/x-www-form-urlencoded形式でデータを送信するためです。

その後、curl_setopt()関数でリクエストの詳細を設定します。CURLOPT_URLでデータの送信先URLを指定し、CURLOPT_POSTをtrueに設定してPOSTリクエストであることを明示します。そして、最も重要なCURLOPT_POSTFIELDSには、事前に変換したPOSTデータを設定します。これにより、指定されたデータがHTTPリクエストのボディとしてサーバーへ送信されます。CURLOPT_RETURNTRANSFERをtrueにすることで、サーバーからのレスポンスが文字列として返されるようにします。

設定が完了すると、curl_exec()でリクエストを実行し、サーバーからの応答を取得します。もしエラーが発生した場合はcurl_errno()とcurl_error()で詳細を確認し、エラーメッセージを記録します。最後にcurl_close()でcURLセッションを閉じます。

引数について、$urlはリクエストの送信先URL（文字列）を、$postDataは送信するキーと値のペアのデータ（配列）を指定します。戻り値は、リクエストが成功した場合はサーバーからのレスポンスボディを文字列として返し、失敗した場合はfalseを返します。このサンプルは、外部のWebサービスと連携してデータを送信する際の基本的な手順を理解するのに役立ちます。