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

Copy
1<?php
2
3/**
4 * FTPサーバーへファイルをセキュアにアップロードし、新しいディレクトリのパーミッションを設定する関数。
5 *
6 * この関数は、CURLOP_USERPWD を使用した認証と、
7 * 新しいディレクトリが作成される際のパーミッションを CURLOPT_NEW_DIRECTORY_PERMS で設定する方法を示します。
8 * システムエンジニアを目指す初心者向けに、簡潔かつ分かりやすいようにコメントを追加しています。
9 *
10 * @param string $ftpHost FTPサーバーのホスト名またはIPアドレス (例: "ftp.example.com")
11 * @param string $ftpUser FTPサーバーの認証に使用するユーザー名
12 * @param string $ftpPass FTPサーバーの認証に使用するパスワード
13 * @param string $remoteFilePath リモートFTPサーバー上のファイルを配置する完全なパス (例: "/path/to/new_dir/test_file.txt")
14 * @return bool ファイルのアップロードが成功した場合は true、失敗した場合は false を返します。
15 */
16function uploadFileToFtpWithAuthAndPerms(
17    string $ftpHost,
18    string $ftpUser,
19    string $ftpPass,
20    string $remoteFilePath
21): bool {
22    // 1. アップロードするダミーのローカルファイルを作成
23    // 実際のアプリケーションでは、ここに既存のファイルへのパスを指定します。
24    $localTempFileName = "temp_upload_file.txt";
25    $tempFileContent = "このファイルはCURLOPT_NEW_DIRECTORY_PERMSとCURLOPT_USERPWDのサンプルです。\n";
26    if (file_put_contents($localTempFileName, $tempFileContent) === false) {
27        echo "エラー: 一時的なローカルファイルの作成に失敗しました。\n";
28        return false;
29    }
30
31    // 2. cURLセッションを初期化
32    $ch = curl_init();
33    if (!$ch) {
34        echo "エラー: cURLの初期化に失敗しました。\n";
35        unlink($localTempFileName); // 作成した一時ファイルを削除
36        return false;
37    }
38
39    // 3. cURLオプションの設定
40
41    // ターゲットのFTP URLを設定します
42    // 例: ftp://your.ftp.server.com/path/to/remote/test_file.txt
43    curl_setopt($ch, CURLOPT_URL, "ftp://" . $ftpHost . $remoteFilePath);
44
45    // FTPサーバーへの認証情報 (ユーザー名とパスワード) を設定します。
46    // キーワード: CURLOPT_USERPWD
47    // このオプションにより、FTPサーバーへの接続が認証されます。
48    curl_setopt($ch, CURLOPT_USERPWD, $ftpUser . ":" . $ftpPass);
49
50    // cURLをアップロードモードに設定します。
51    curl_setopt($ch, CURLOPT_UPLOAD, true);
52
53    // リモートパスに存在しないディレクトリがあれば、自動的に作成するように設定します。
54    // 例: /uploads/new_dir/file.txt をアップロードする際、/uploads/new_dir がなければ作成されます。
55    curl_setopt($ch, CURLOPT_FTP_CREATE_MISSING_DIRS, true);
56
57    // 新しく作成されるディレクトリのパーミッションを設定します。
58    // リファレンス情報: CURLOPT_NEW_DIRECTORY_PERMS
59    // 値は10進数で指定しますが、FTPサーバーはこれを通常8進数 (例: 0755) として解釈します。
60    // 0755 は、所有者に読み書き実行 (rwx)、グループとその他に読み取り実行 (rx) の権限を与えます。
61    curl_setopt($ch, CURLOPT_NEW_DIRECTORY_PERMS, 0755); // 10進数の 493 に相当
62
63    // アップロードするローカルファイルを開きます (読み込みバイナリモード)
64    $fp = fopen($localTempFileName, 'rb');
65    if (!$fp) {
66        echo "エラー: アップロードするローカルファイルを開けませんでした。\n";
67        curl_close($ch);
68        unlink($localTempFileName);
69        return false;
70    }
71    // アップロードするファイルのファイルポインタを設定します
72    curl_setopt($ch, CURLOPT_INFILE, $fp);
73    // アップロードするファイルのサイズを設定します
74    curl_setopt($ch, CURLOPT_INFILESIZE, filesize($localTempFileName));
75
76    // cURLの詳細な実行ログを表示したい場合は、以下のコメントを解除してください。
77    // curl_setopt($ch, CURLOPT_VERBOSE, true);
78
79    // 4. cURLリクエストを実行
80    echo "FTPサーバーへのファイルアップロードを開始します: " . $ftpHost . $remoteFilePath . "\n";
81    $response = curl_exec($ch);
82
83    // 5. 実行結果の確認とエラーハンドリング
84    if ($response === false) {
85        echo "cURLエラー: " . curl_error($ch) . "\n";
86        $success = false;
87    } else {
88        echo "ファイルが正常にアップロードされました: " . $ftpHost . $remoteFilePath . "\n";
89        $success = true;
90    }
91
92    // 6. cURLセッションとファイルポインタを閉じる
93    fclose($fp);
94    curl_close($ch);
95    unlink($localTempFileName); // 作成した一時ファイルを削除
96
97    return $success;
98}
99
100// --- 使用例 ---
101// 以下のプレースホルダーを**実際のFTPサーバーの情報**に置き換えてください。
102// このコードは、実際に指定されたFTPサーバーに接続を試みます。
103// テスト用のFTPサーバーを用意するか、動作検証には十分注意してください。
104$ftpHost = "your_ftp_server.com"; // 例: "ftp.example.jp"
105$ftpUser = "your_username";       // 例: "webuser"
106$ftpPass = "your_password";       // 例: "myStrongPassword123"
107
108// リモートFTPサーバー上のディレクトリとファイル名
109// 例: /uploads/reports/2023/monthly_report.txt
110$remoteDirectory = "/uploads/new_project_data/";
111$remoteFileName = "config_settings.txt";
112$fullRemotePath = $remoteDirectory . $remoteFileName;
113
114echo "FTPアップロード処理を開始...\n";
115$isUploadSuccessful = uploadFileToFtpWithAuthAndPerms(
116    $ftpHost,
117    $ftpUser,
118    $ftpPass,
119    $fullRemotePath
120);
121
122if ($isUploadSuccessful) {
123    echo "アップロード処理が成功しました。\n";
124} else {
125    echo "アップロード処理が失敗しました。\n";
126}
127
128?>

このサンプルコードは、PHPのcURLライブラリを使用してFTPサーバーへファイルを安全にアップロードする手順を、システムエンジニアを目指す初心者向けに解説しています。主な目的は、FTP認証を行うCURLOPT_USERPWDオプションと、アップロード時に新しく作成されるディレクトリのパーミッションを設定するCURLOPT_NEW_DIRECTORY_PERMS定数の具体的な利用方法を示すことです。

uploadFileToFtpWithAuthAndPerms関数は、FTPホスト名、ユーザー名、パスワード、およびリモートのファイルパスを引数として受け取ります。この関数は、ファイルのアップロード処理が成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。

関数内部では、まずアップロードするための一時的なローカルファイルを作成し、cURLセッションを初期化します。その後、CURLOPT_USERPWDオプションを使ってユーザー名:パスワードの形式で認証情報を設定し、FTPサーバーへのセキュアな接続を確立します。アップロード先のパスにまだ存在しないディレクトリがある場合、CURLOPT_FTP_CREATE_MISSING_DIRSオプションによって自動的に作成されますが、その際に作成される新しいディレクトリの権限をCURLOPT_NEW_DIRECTORY_PERMS定数で指定できます。この値は通常、0755のような8進数で表されるパーミッション（所有者に読み書き実行、グループとその他に読み取り実行）を10進数で指定します。これらのオプションを設定後、cURLリクエストを実行し、ファイルのアップロードを完了させます。この機能は、自動化されたデプロイやバックアップ処理において、安全かつ適切なファイル権限管理を行う際に非常に有用です。

Copy
1<?php
2
3/**
4 * 指定されたFTPサーバーへファイルをアップロードし、
5 * 必要に応じて新規作成されるディレクトリにパーミッションを設定します。
6 *
7 * この関数は、システムエンジニアを目指す初心者向けに、
8 * PHPのcURL拡張機能とCURLOPT_NEW_DIRECTORY_PERMSオプションの使用方法を示します。
9 * 
10 * 注意: このコードを実行するには、実際にアクセス可能なFTPサーバーが必要です。
11 * ダミーのFTP接続情報を、ご自身の環境に合わせて置き換えてください。
12 *
13 * @param string $ftpHost FTPサーバーのホスト名またはIPアドレス
14 * @param string $ftpUser FTPユーザー名
15 * @param string $ftpPass FTPパスワード
16 * @param string $remotePath アップロード先のリモートパス (例: 'new_dir/sub_dir/file.txt')
17 * @param string $localFilePath アップロードするローカルファイルのパス
18 * @param int $newDirectoryPerms 新規作成されるディレクトリに設定するパーミッション (八進数、例: 0755)
19 * @return void
20 */
21function uploadFileToFtpWithNewDirPerms(
22    string $ftpHost,
23    string $ftpUser,
24    string $ftpPass,
25    string $remotePath,
26    string $localFilePath,
27    int $newDirectoryPerms = 0755
28): void {
29    // FTP接続情報がダミーのままであれば警告を表示して終了
30    if (
31        $ftpHost === 'your_ftp_host.com' ||
32        $ftpUser === 'your_ftp_username' ||
33        $ftpPass === 'your_ftp_password'
34    ) {
35        echo "エラー: ダミーのFTP接続情報を実際の情報に置き換えてください。\n";
36        return;
37    }
38
39    // アップロードするローカルファイルが存在するか確認
40    if (!file_exists($localFilePath)) {
41        echo "エラー: ローカルファイル '{$localFilePath}' が見つかりません。\n";
42        return;
43    }
44
45    // FTPアップロード先の完全なURLを構築
46    $remoteUrl = "ftp://{$ftpUser}:{$ftpPass}@{$ftpHost}/{$remotePath}";
47
48    // cURLセッションを初期化
49    $ch = curl_init();
50    if ($ch === false) {
51        echo "エラー: cURLセッションの初期化に失敗しました。\n";
52        return;
53    }
54
55    // アップロードするローカルファイルをバイナリ読み取りモードでオープン
56    $fp = fopen($localFilePath, 'rb');
57    if ($fp === false) {
58        echo "エラー: ローカルファイル '{$localFilePath}' を開けませんでした。\n";
59        curl_close($ch);
60        return;
61    }
62
63    // cURLオプションを設定
64    curl_setopt_array($ch, [
65        CURLOPT_URL                     => $remoteUrl,                 // アップロード先のFTP URL
66        CURLOPT_UPLOAD                  => true,                       // アップロードモードを有効にする
67        CURLOPT_INFILE                  => $fp,                        // アップロードするファイルハンドル
68        CURLOPT_INFILESIZE              => filesize($localFilePath),   // アップロードするファイルのサイズ
69        CURLOPT_FTP_CREATE_MISSING_DIRS => true,                       // 存在しない中間ディレクトリを自動作成
70        CURLOPT_NEW_DIRECTORY_PERMS     => $newDirectoryPerms,         // 新規作成されるディレクトリのパーミッション (例: 0755 は rwxr-xr-x)
71        CURLOPT_RETURNTRANSFER          => true,                       // 実行結果を文字列として取得
72        // CURLOPT_VERBOSE                 => true,                       // 詳細なデバッグ情報を表示する場合 (コメントアウトを解除)
73    ]);
74
75    // cURLセッションを実行
76    $response = curl_exec($ch);
77
78    // エラーチェック
79    if (curl_errno($ch)) {
80        echo "cURLエラー (" . curl_errno($ch) . "): " . curl_error($ch) . "\n";
81    } else {
82        echo "ファイル '{$localFilePath}' を '{$remoteUrl}' へ正常にアップロードしました。\n";
83        // FTPサーバーからの応答があれば表示 (一部のサーバーは詳細な応答を返します)
84        if ($response) {
85            echo "FTPサーバーからの応答: " . $response . "\n";
86        }
87    }
88
89    // ファイルハンドルとcURLセッションをクローズ
90    fclose($fp);
91    curl_close($ch);
92}
93
94// --- サンプルコード実行部分 ---
95
96// 1. アップロードする一時ファイルを作成
97$tempFileName = 'temp_file_for_upload.txt';
98$tempFileContent = "これはFTPアップロードテスト用の一時ファイルです。\n";
99file_put_contents($tempFileName, $tempFileContent);
100
101// 2. FTP接続情報 (実際の環境に合わせて以下の値を変更してください)
102$ftpHost = 'your_ftp_host.com';       // FTPサーバーのホスト名またはIPアドレス
103$ftpUser = 'your_ftp_username';      // FTPユーザー名
104$ftpPass = 'your_ftp_password';      // FTPパスワード
105
106// 3. アップロード先のリモートパス
107//    新しいディレクトリが自動的に作成されるように、存在しないディレクトリ名を含めます。
108$remotePath = 'my_new_ftp_dir/sub_folder/uploaded_document.txt';
109
110// 4. 新規作成されるディレクトリのパーミッション (例: 0755 は所有者に読み書き実行、グループと他者に読み書き実行)
111$dirPerms = 0755; // 8進数で指定
112
113echo "--- FTPファイルアップロード開始 ---\n";
114echo "ローカルファイル: {$tempFileName}\n";
115echo "リモートパス: {$remotePath}\n";
116echo "新規ディレクトリパーミッション: " . sprintf('%o', $dirPerms) . "\n\n";
117
118// 5. 関数を呼び出してファイルアップロードを実行
119uploadFileToFtpWithNewDirPerms(
120    $ftpHost,
121    $ftpUser,
122    $ftpPass,
123    $remotePath,
124    $tempFileName,
125    $dirPerms
126);
127
128echo "\n--- FTPファイルアップロード終了 ---\n";
129
130// 6. 作成した一時ファイルを削除
131if (file_exists($tempFileName)) {
132    unlink($tempFileName);
133    echo "一時ファイル '{$tempFileName}' を削除しました。\n";
134}
135
136?>

このPHPコードは、PHPのcURL拡張機能を利用して、ローカルファイルをFTPサーバーへアップロードする方法を示しています。特に、アップロード先のパスにまだ存在しないディレクトリが含まれる場合に、それらの新規作成されるディレクトリに特定のパーミッション（アクセス権限）を設定するCURLOPT_NEW_DIRECTORY_PERMSオプションの使い方を学ぶことができます。

uploadFileToFtpWithNewDirPerms関数は、FTPサーバーの接続情報（ホスト名、ユーザー名、パスワード）、アップロード先のリモートパス、アップロードするローカルファイルのパス、そして新規作成されるディレクトリに適用するパーミッション（8進数形式）を引数として受け取ります。関数内では、cURLセッションを初期化し、アップロードモードを有効にするCURLOPT_UPLOADや、存在しない中間ディレクトリを自動作成するCURLOPT_FTP_CREATE_MISSING_DIRSなどのオプションと共に、CURLOPT_NEW_DIRECTORY_PERMSを設定します。これにより、自動作成されたディレクトリには指定されたパーミッションが適用されます。cURLセッションを実行してファイルアップロードが完了すると、成功またはエラーのメッセージがコンソールに表示されます。この関数は処理結果を直接返さず、void型で定義されているため、外部からの呼び出し元へは値を返しません。コードを実行する際には、サンプルに記載されているダミーのFTP接続情報を、ご自身の実際の環境情報に置き換える必要があります。