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

Copy
1<?php
2
3/**
4 * 指定されたURLのコンテンツをcURLで取得し、HTTPリダイレクトを自動で追跡します。
5 *
6 * PHP 8 環境における cURL の基本的な使用方法と、
7 * 特に CURLOPT_FOLLOWLOCATION オプションの利用方法を示します。
8 *
9 * @param string $url 取得するURL。リダイレクトが発生する可能性のあるURLを指定します。
10 * @return string|false 成功した場合はURLのコンテンツ、失敗した場合はfalseを返します。
11 */
12function getUrlContentWithFollowLocation(string $url): string|false
13{
14    // cURLセッションを初期化します。
15    // curl_init() は新しい cURL ハンドルを返します。失敗した場合は false です。
16    $ch = curl_init();
17
18    // 初期化に失敗した場合はエラーを記録し、false を返します。
19    if ($ch === false) {
20        error_log("cURLセッションの初期化に失敗しました。");
21        return false;
22    }
23
24    // cURLオプションを設定します。
25    // curl_setopt() は指定された cURL ハンドルにオプションを設定します。
26    //
27    // PHP リファレンス情報には CURLOPT_DIRLISTONLY が記載されていましたが、
28    // これはFTPサーバのディレクトリリスト取得に特化したオプションです。
29    // キーワードである CURLOPT_FOLLOWLOCATION はHTTPリクエストのリダイレクト追跡に関するものであり、
30    // 用途が異なるため、今回はキーワードに最も関連性の高い CURLOPT_FOLLOWLOCATION を中心にコードを構成します。
31    curl_setopt($ch, CURLOPT_URL, $url);                 // 取得するURLを設定
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);       // 転送結果を文字列で返すように設定
33    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);       // HTTPヘッダのLocation:に従ってリダイレクトを自動追跡
34    curl_setopt($ch, CURLOPT_MAXREDIRS, 10);              // 追跡するリダイレクトの最大数を10回に設定
35    curl_setopt($ch, CURLOPT_TIMEOUT, 30);                // 接続タイムアウトを30秒に設定
36    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);       // SSL証明書の検証を有効にする (セキュリティのため推奨)
37
38    // cURLリクエストを実行します。
39    // curl_exec() は、オプションで CURLOPT_RETURNTRANSFER が true に設定されている場合、転送結果を返します。
40    $response = curl_exec($ch);
41
42    // エラーが発生したかどうかを確認します。
43    // curl_errno() は直近の cURL 操作のエラー番号を返します。
44    if (curl_errno($ch)) {
45        // エラーメッセージを記録し、false を返します。
46        error_log("cURLエラーが発生しました: " . curl_error($ch));
47        $response = false;
48    }
49
50    // cURLセッションを閉じます。
51    // curl_close() は cURL ハンドルを閉じ、関連するリソースを解放します。
52    curl_close($ch);
53
54    return $response;
55}
56
57// --------------------------------------------------------
58// サンプルコードの実行例
59// --------------------------------------------------------
60
61// リダイレクトをテストするためのURL。
62// httpbin.org は、HTTPリクエストのテストに便利なサービスを提供しています。
63// このURLは、最終的に https://example.com/ へリダイレクトされます。
64$testUrlWithRedirect = "http://httpbin.org/redirect-to?url=https://example.com/";
65
66echo "--- cURL リダイレクト追跡テスト ---" . PHP_EOL;
67echo "対象URL (リダイレクト元): " . $testUrlWithRedirect . PHP_EOL;
68
69// 関数を呼び出し、リダイレクト先のコンテンツを取得します。
70$content = getUrlContentWithFollowLocation($testUrlWithRedirect);
71
72if ($content !== false) {
73    echo "コンテンツの取得に成功しました。" . PHP_EOL;
74    // 取得したコンテンツの最初の500文字を表示します。
75    echo "取得したコンテンツの一部（最初の500文字）:" . PHP_EOL;
76    echo mb_substr($content, 0, 500) . PHP_EOL;
77} else {
78    echo "コンテンツの取得に失敗しました。" . PHP_EOL;
79}
80
81echo PHP_EOL;
82
83// リダイレクトしない一般的なURLの例も示します。
84$testUrlNoRedirect = "https://www.php.net/";
85
86echo "--- cURL リダイレクトしないURLのテスト ---" . PHP_EOL;
87echo "対象URL: " . $testUrlNoRedirect . PHP_EOL;
88
89$contentNoRedirect = getUrlContentWithFollowLocation($testUrlNoRedirect);
90
91if ($contentNoRedirect !== false) {
92    echo "コンテンツの取得に成功しました。" . PHP_EOL;
93    echo "取得したコンテンツの一部（最初の500文字）:" . PHP_EOL;
94    echo mb_substr($contentNoRedirect, 0, 500) . PHP_EOL;
95} else {
96    echo "コンテンツの取得に失敗しました。" . PHP_EOL;
97}
98
99?>

このPHPサンプルコードは、cURLライブラリを用いて指定されたURLのコンテンツを取得する方法を示しており、特にHTTPリダイレクトを自動で追跡する機能に焦点を当てています。

コードでは、まずcurl_init()関数でcURLセッションを開始し、ウェブページへのアクセス準備を行います。次にcurl_setopt()関数で各種オプションを設定します。ここで重要なのは、CURLOPT_FOLLOWLOCATIONオプションにtrueを設定している点です。これにより、アクセスしたURLが別のアドレスへ転送（リダイレクト）を指示した場合でも、cURLが自動的に新しいURLへ追跡し、最終的なコンテンツを取得できるようになります。また、CURLOPT_RETURNTRANSFERをtrueに設定することで、取得したウェブページのコンテンツを文字列として受け取れるようにしています。CURLOPT_MAXREDIRSオプションは、リダイレクトを追跡する最大回数を設定し、無限ループを防ぐ役割を果たします。さらに、CURLOPT_SSL_VERIFYPEERをtrueに設定することで、SSL証明書の検証を有効にし、セキュリティを向上させています。

オプション設定が完了したら、curl_exec()関数で実際にHTTPリクエストを実行し、ウェブページのコンテンツを取得します。処理中にエラーが発生した場合は、curl_errno()関数でエラーを確認し、適切な対応を行います。最後に、curl_close()関数を呼び出してcURLセッションを閉じ、使用したリソースを解放します。

getUrlContentWithFollowLocation関数は、取得したいウェブページのURLを$url引数として受け取ります。処理が成功した場合はそのURLのコンテンツを文字列で返し、失敗した場合はfalseを返します。このコードは、システムエンジニアを目指す初心者の方々が、ウェブサイトから安全に情報を取得し、HTTPリダイレクトに対応した堅牢なアプリケーションを開発するための基礎として役立ちます。

Copy
1<?php
2
3/**
4 * FTPサーバーのディレクトリリストをファイルに取得するサンプル関数。
5 *
6 * この関数は、指定されたFTP URLのディレクトリ一覧のみを取得し、
7 * その内容を指定されたファイルに保存します。
8 * CURLOPT_DIRLISTONLY と CURLOPT_FILE オプションの使用方法を示します。
9 *
10 * @param string $ftpUrl FTPサーバーのディレクトリURL (例: "ftp://ftp.example.com/path/")
11 * @param string $outputFilePath ディレクトリリストを保存するファイルのパス
12 * @return bool 成功した場合はtrue、失敗した場合はfalse
13 */
14function getFtpDirectoryListToFile(string $ftpUrl, string $outputFilePath): bool
15{
16    // 出力ファイルを開く
17    // 'w+'モードで開くことで、ファイルが存在しない場合は作成し、既存の場合は内容を上書きします。
18    $fileHandle = fopen($outputFilePath, 'w+');
19    if (!$fileHandle) {
20        error_log("Error: Could not open file '{$outputFilePath}' for writing.");
21        return false;
22    }
23
24    // cURLセッションを初期化
25    $ch = curl_init();
26    if ($ch === false) {
27        fclose($fileHandle);
28        error_log("Error: Failed to initialize cURL session.");
29        return false;
30    }
31
32    // cURLオプションを設定
33    // 取得対象のURLを設定
34    curl_setopt($ch, CURLOPT_URL, $ftpUrl);
35
36    // ディレクトリリストのみを取得するよう設定 (CURLOPT_DIRLISTONLY)
37    // これにより、ファイルの内容をダウンロードするのではなく、指定されたFTPパスの
38    // ファイルやディレクトリのリスト（`ls -F`のような形式）を取得します。
39    curl_setopt($ch, CURLOPT_DIRLISTONLY, true);
40
41    // 転送されたデータを指定されたファイルポインタに書き込むよう設定 (CURLOPT_FILE)
42    // このオプションにより、取得したディレクトリリストは直接 `$fileHandle` が指すファイルに保存されます。
43    // 標準出力ではなく、特定のファイルに結果を保存したい場合に非常に便利です。
44    curl_setopt($ch, CURLOPT_FILE, $fileHandle);
45
46    // (オプション) FTPサーバーが認証を必要とする場合、ユーザー名とパスワードを設定
47    // curl_setopt($ch, CURLOPT_USERPWD, "username:password");
48
49    // (オプション) 詳細な転送情報を表示する場合（デバッグ用）
50    // curl_setopt($ch, CURLOPT_VERBOSE, true);
51
52    // cURLセッションを実行し、転送を開始
53    $success = curl_exec($ch);
54
55    // エラーチェック
56    if ($success === false) {
57        error_log("cURL Error: " . curl_error($ch));
58    }
59
60    // cURLセッションを閉じる
61    curl_close($ch);
62    // 出力ファイルを閉じる
63    fclose($fileHandle);
64
65    // 転送が成功したかどうかを返す
66    return (bool)$success;
67}
68
69// --- 使用例 ---
70
71// 公開FTPサーバーの例 (実際にアクセス可能なURLを使用)
72// このURLはテスト用のディレクトリリストを提供することが多いです。
73$ftpServerUrl = "ftp://speedtest.tele2.net/";
74// ディレクトリリストを保存するファイルのパス
75$outputFile = "ftp_directory_list.txt";
76
77echo "INFO: Attempting to get FTP directory list from '{$ftpServerUrl}' to '{$outputFile}'...\n";
78
79// 関数を実行し、結果に基づいてメッセージを表示
80if (getFtpDirectoryListToFile($ftpServerUrl, $outputFile)) {
81    echo "SUCCESS: FTP directory list successfully saved to '{$outputFile}'.\n";
82    echo "--- Content of '{$outputFile}' ---\n";
83    // 保存されたファイルの内容を表示して確認
84    echo file_get_contents($outputFile);
85    echo "-------------------------------\n";
86} else {
87    echo "ERROR: Failed to get FTP directory list.\n";
88}
89
90// (オプション) テスト後に生成されたファイルを削除する場合
91// if (file_exists($outputFile)) {
92//     unlink($outputFile);
93//     echo "INFO: Cleaned up '{$outputFile}'.\n";
94// }
95

このPHPサンプルコードは、FTPサーバーからディレクトリのリストのみを取得し、その内容を指定されたファイルに保存する方法を示しています。getFtpDirectoryListToFile関数は、取得対象のFTPサーバーのディレクトリURL（$ftpUrl）と、結果を保存するファイルのパス（$outputFilePath）の二つの文字列引数を受け取ります。

関数内では、まず出力ファイルを書き込みモードで開きます。次に、cURLセッションを初期化し、各種オプションを設定します。特に、CURLOPT_DIRLISTONLYオプションをtrueに設定することで、FTPサーバー上のファイルの実際のコンテンツをダウンロードするのではなく、指定されたパスにあるファイルやディレクトリの一覧だけを取得するように指示します。また、CURLOPT_FILEオプションには開いたファイルのポインタを設定しており、これによりcURLが取得したディレクトリリストのデータは、標準出力ではなく直接指定されたファイルに書き込まれます。

処理の実行後、関数はcURLセッションとファイルを閉じます。戻り値はブール値で、FTPディレクトリリストの取得とファイルへの保存が成功した場合はtrueを、失敗した場合はfalseを返します。これにより、呼び出し元は処理の成否を判断し、適切なエラーハンドリングを行うことができます。