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

Copy
1<?php
2
3/**
4 * 指定されたURLにHTTP GETリクエストを送信し、リダイレクトを自動的に追跡してコンテンツを取得します。
5 * システムエンジニアを目指す初心者向けに、cURLを使った基本的なWebアクセスと
6 * CURLOPT_FOLLOWLOCATIONの使用方法を示します。
7 *
8 * @param string $url 取得するURL。リダイレクトが発生する可能性のあるURLを想定しています。
9 * @return string|false 取得したWebページのコンテンツ、またはエラー時にfalse。
10 */
11function fetchUrlContentWithFollowLocation(string $url): string|false
12{
13    // cURLセッションを初期化します。
14    $ch = curl_init();
15
16    // cURLセッションの初期化に失敗した場合の処理。
17    if ($ch === false) {
18        // エラーログに出力し、falseを返します。
19        error_log("cURLセッションの初期化に失敗しました。");
20        return false;
21    }
22
23    // アクセスするURLを設定します。
24    curl_setopt($ch, CURLOPT_URL, $url);
25
26    // リダイレクトを自動的に追跡するように設定します。
27    // これにより、HTTP 3xx レスポンス（リダイレクト）が返された場合に、
28    // cURLが自動的に新しい場所へリクエストを再送信します。
29    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
30
31    // 取得したデータを文字列として返却するように設定します。
32    // これを設定しない場合、curl_exec()はデータを直接標準出力に出力します。
33    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
34
35    // 最大リダイレクト数を設定します。無限ループを防ぐため、適切な値を設定することが推奨されます。
36    curl_setopt($ch, CURLOPT_MAXREDIRS, 10);
37
38    // 接続確立までのタイムアウト時間（秒）を設定します。
39    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
40
41    // 実行全体のタイムアウト時間（秒）を設定します。
42    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
43
44    // cURLセッションを実行し、結果を取得します。
45    $response = curl_exec($ch);
46
47    // cURLの実行中にエラーが発生したかを確認します。
48    if (curl_errno($ch)) {
49        // エラーログにエラーメッセージを出力します。
50        error_log('cURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch));
51        $response = false; // エラー時にはfalseを返します。
52    }
53
54    // cURLセッションを閉じ、リソースを解放します。
55    curl_close($ch);
56
57    return $response;
58}
59
60// サンプル使用例:
61// HTTPリダイレクトが発生する可能性のあるURLを設定します。
62// 例として、httpbin.org のリダイレクトエンドポイントを使用します。
63// このURLは一度リダイレクトを行った後、最終的なレスポンスを返します。
64$targetUrl = 'http://httpbin.org/redirect/1';
65
66echo "指定されたURL: " . $targetUrl . PHP_EOL;
67
68// 関数を呼び出してコンテンツを取得します。
69$content = fetchUrlContentWithFollowLocation($targetUrl);
70
71// 取得結果を確認します。
72if ($content !== false) {
73    echo "--- 取得したコンテンツの最初の200文字 ---" . PHP_EOL;
74    // マルチバイト文字列を安全に扱うために mb_substr を使用します。
75    echo mb_substr($content, 0, 200) . "..." . PHP_EOL;
76} else {
77    echo "URLコンテンツの取得に失敗しました。" . PHP_EOL;
78}
79
80?>

PHPのcURL拡張機能は、Webサーバーと通信するための強力な機能です。このサンプルコードでは、cURLを使用して指定されたURLからWebページのコンテンツを取得する方法、特にHTTPリダイレクト（Webページが別のURLに転送されること）を自動的に追跡するCURLOPT_FOLLOWLOCATIONオプションの使い方を初心者向けに解説しています。

CURLOPT_FOLLOWLOCATIONオプションをtrueに設定すると、HTTP 3xxステータスコード（リダイレクト）を受け取った際に、cURLが自動的にリダイレクト先のURLへ再度アクセスし、最終的なコンテンツを取得してくれます。これにより、開発者はリダイレクトの処理を自前で実装する手間が省け、コードが簡潔になります。

サンプルコードのfetchUrlContentWithFollowLocation関数は、取得したいURL（文字列）を引数として受け取ります。関数内部では、cURLセッションを初期化し、CURLOPT_URLでアクセス先を設定、そしてCURLOPT_FOLLOWLOCATIONをtrueに設定しています。また、CURLOPT_RETURNTRANSFERをtrueに設定することで、取得したコンテンツを関数の戻り値として文字列で受け取れるようにしています。その他、無限リダイレクトを防ぐための最大リダイレクト数や、接続・実行時のタイムアウト時間も設定し、安全にWebアクセスを行うための配慮がなされています。

cURLの実行中にエラーが発生した場合は、エラーログに詳細が出力され、この関数はfalseを返します。正常に処理が完了した場合は、取得したWebページのコンテンツが文字列として返されます。サンプルコードの最後では、リダイレクトが発生するURLを使ってこの関数の動作例を示しており、取得したコンテンツの冒頭部分が表示されます。このように、CURLOPT_FOLLOWLOCATIONを使うことで、リダイレクトを意識せずに目的のWebコンテンツを取得できるため、WebスクレイピングやAPI連携などで非常に役立ちます。

Copy
1<?php
2
3// このファイルは単体で実行可能です。
4// cURL 拡張機能が有効になっていることを確認してください（例: `php -m | grep curl`）。
5
6/**
7 * cURL リクエストを実行し、CURLOPT_WRITEFUNCTION を使用してレスポンスボディを捕捉する関数。
8 *
9 * cURL がサーバーからデータを受信するたびに呼び出されるコールバック関数を設定することで、
10 * レスポンスボディをカスタム処理（例: 変数への蓄積、ファイルへの書き込み）できます。
11 *
12 * @param string $url リクエストを送信するURL。
13 * @return string 受信したレスポンスボディ、またはエラーが発生した場合はエラーメッセージ。
14 */
15function fetchUrlWithWriteFunction(string $url): string
16{
17    // レスポンスボディを蓄積するための変数。
18    // コールバック関数内でこの変数にデータを追記します。
19    $responseBody = '';
20
21    // cURL セッションを初期化
22    $ch = curl_init();
23
24    if ($ch === false) {
25        return 'cURL初期化エラー: cURLハンドルの取得に失敗しました。';
26    }
27
28    // cURL オプションを設定
29    // ----------------------------------------------------
30    // 1. リクエスト先のURLを設定
31    curl_setopt($ch, CURLOPT_URL, $url);
32
33    // 2. HTTPSサイトにアクセスする場合、証明書検証エラーを避けるために
34    //    以下の2行を含めることがあります（本番環境では検証を推奨します）。
35    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
36    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
37
38    // 3. CURLOPT_WRITEFUNCTION を設定:
39    //    cURL がデータを受信するたびに呼び出されるコールバック関数を登録します。
40    //    このコールバック関数は、通常2つの引数（cURLハンドル、受信データ）を受け取ります。
41    //    関数は、処理したデータのバイト数（通常は strlen($data)）を返す必要があります。
42    $writeCallback = function ($curl, string $data) use (&$responseBody): int {
43        // 受信したデータを、外部で定義された $responseBody 変数に追記します。
44        // `use (&$responseBody)` により、クロージャが外部の変数 $responseBody を
45        // 参照し、変更できるようになります。
46        $responseBody .= $data;
47
48        // cURL に、このデータブロックを全て処理したことを伝えます。
49        return strlen($data);
50    };
51    curl_setopt($ch, CURLOPT_WRITEFUNCTION, $writeCallback);
52
53    // 4. CURLOPT_RETURNTRANSFER を false に設定:
54    //    これにより、curl_exec() は取得したデータを直接返さず、
55    //    代わりに CURLOPT_WRITEFUNCTION で指定したコールバック関数にデータを渡します。
56    //    コールバック関数を使用しない場合は true に設定し、curl_exec() の戻り値としてデータを取得します。
57    curl_setopt($ch, CURLOPT_RETURNTRANSFER, false);
58    // ----------------------------------------------------
59
60    // cURL セッションを実行
61    // CURLOPT_RETURNTRANSFER が false なので、$result は通常 true または false (エラー時) になります。
62    $result = curl_exec($ch);
63
64    // エラーチェック
65    if ($result === false) {
66        $errorMessage = curl_error($ch);
67        $errorNumber = curl_errno($ch);
68        curl_close($ch); // エラーが発生しても cURL ハンドルはクローズ
69        return "cURLエラー ({$errorNumber}): {$errorMessage}";
70    }
71
72    // cURL セッションを終了し、リソースを解放
73    curl_close($ch);
74
75    // コールバック関数で蓄積されたレスポンスボディを返す
76    return $responseBody;
77}
78
79// 使用例: 'https://example.com' からコンテンツを取得し、表示します。
80$targetUrl = 'https://example.com';
81echo "ターゲットURLからコンテンツを取得中: {$targetUrl}\n";
82
83$content = fetchUrlWithWriteFunction($targetUrl);
84
85// 受信したコンテンツの最初の500文字、またはエラーメッセージを表示
86if (strpos($content, 'cURLエラー') === 0) {
87    // エラーメッセージの場合
88    echo "エラーが発生しました:\n{$content}\n";
89} elseif (strlen($content) > 0) {
90    // コンテンツが正常に取得できた場合
91    echo "--- 受信コンテンツ (最初の500文字) ---\n";
92    echo substr($content, 0, 500) . (strlen($content) > 500 ? "...\n" : "\n");
93    echo "合計コンテンツ長: " . strlen($content) . " バイト\n";
94} else {
95    // コンテンツが空の場合（ただしエラーではない）
96    echo "コンテンツは受信されませんでした。\n";
97}
98
99?>

PHPのcURL拡張機能は、ウェブサイトへのリクエスト送信やレスポンスの受信を柔軟に制御するための機能です。その中でもCURLOPT_WRITEFUNCTIONは、cURLがサーバーからデータを受信するたびに、ユーザーが定義したコールバック関数を呼び出すための重要なオプションです。この機能を使うことで、受信したレスポンスボディを、cURLのデフォルトの処理方法とは異なる形でカスタム処理できます。

例えば、通常はcurl_exec()の戻り値として一度に全てのレスポンスボディを受け取りますが、CURLOPT_WRITEFUNCTIONを設定すると、データがネットワークから届くたびに段階的にコールバック関数で処理できます。これは、大量のデータをダウンロードする際にメモリ消費を抑えたり、受信データを直接ファイルに書き込んだりする場合などに非常に有効です。

CURLOPT_WRITEFUNCTIONには、処理を行うコールバック関数を指定します。このコールバック関数は、cURLセッションのハンドルと、サーバーから受信したデータのブロックという二つの引数を受け取ります。関数内では受け取ったデータを処理し、処理が完了したバイト数（通常はstrlen($data)）を整数型で返す必要があります。cURLはこの戻り値を確認し、データブロックが適切に処理されたと判断します。

このオプションを利用する際には、curl_setopt()でCURLOPT_RETURNTRANSFERをfalseに設定することが肝心です。CURLOPT_RETURNTRANSFERがfalseの場合、curl_exec()は取得したデータを直接返さず、CURLOPT_WRITEFUNCTIONで指定されたコールバック関数にデータを渡すようになります。サンプルコードでは、このコールバック関数を利用して受信データを$responseBody変数に逐次追記し、最終的に完全なレスポンスボディを構築しています。これにより、受信したコンテンツをメモリ上で安全かつ効率的に収集できます。