【PHP8.x】posix_access()関数の使い方

Copy
1<?php
2
3/**
4 * 指定されたファイルのアクセス権限を現在のユーザーの視点から確認し、
5 * そのユーザー情報を表示する関数です。
6 *
7 * システムエンジニアを目指す初心者向けに、POSIX関数の基本的な利用例として
8 * posix_access と posix_getpwuid の組み合わせを示します。
9 *
10 * @param string $filePath アクセス権限を確認する対象のファイルのパス。
11 * @return void
12 */
13function checkFileAccessAndCurrentUser(string $filePath): void
14{
15    echo "--- ファイルアクセス権限チェック ---\n";
16    echo "対象ファイル: " . $filePath . "\n\n";
17
18    // 現在の実効ユーザーID (EUID) を取得します。
19    // posix_access は、このEUIDを持つユーザーの権限に基づいてチェックを行います。
20    $effectiveUserId = posix_geteuid();
21
22    // 取得したEUIDに基づいて、ユーザー情報を取得します。
23    // これにより、どのユーザーの権限でアクセスチェックが行われているかを明確にします。
24    $userInfo = posix_getpwuid($effectiveUserId);
25
26    if ($userInfo) {
27        echo "現在の実効ユーザー名: " . $userInfo['name'] . " (UID: " . $effectiveUserId . ")\n";
28        echo "所属グループ: " . $userInfo['gecos'] . " (GID: " . $userInfo['gid'] . ")\n\n";
29    } else {
30        echo "警告: ユーザー情報を取得できませんでした (UID: " . $effectiveUserId . ")\n\n";
31    }
32
33    echo "--- アクセス権限判定 ---\n";
34
35    // ファイルが存在するかどうかをチェックします (F_OK)。
36    if (posix_access($filePath, POSIX_F_OK)) {
37        echo "ファイル存在チェック: " . "はい、ファイルが存在します。\n";
38    } else {
39        echo "ファイル存在チェック: " . "いいえ、ファイルは存在しません。\n";
40        // ファイルが存在しない場合は、これ以上のチェックは意味がないため終了します。
41        return;
42    }
43
44    // 読み取り権限をチェックします (R_OK)。
45    if (posix_access($filePath, POSIX_R_OK)) {
46        echo "読み取り権限: " . "はい、読み取ることができます。\n";
47    } else {
48        echo "読み取り権限: " . "いいえ、読み取ることができません。\n";
49    }
50
51    // 書き込み権限をチェックします (W_OK)。
52    if (posix_access($filePath, POSIX_W_OK)) {
53        echo "書き込み権限: " . "はい、書き込むことができます。\n";
54    } else {
55        echo "書き込み権限: " . "いいえ、書き込むことができません。\n";
56    }
57
58    // 実行権限 (ファイルの場合) または検索権限 (ディレクトリの場合) をチェックします (X_OK)。
59    if (posix_access($filePath, POSIX_X_OK)) {
60        echo "実行/検索権限: " . "はい、実行または検索できます。\n";
61    } else {
62        echo "実行/検索権限: " . "いいえ、実行または検索できません。\n";
63    }
64    echo "-----------------------------------\n";
65}
66
67// --- サンプルコードの実行部分 ---
68
69// 1. テスト用の一時ファイルを作成します。
70$tempFileName = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'posix_access_test_' . uniqid() . '.txt';
71file_put_contents($tempFileName, "これはposix_access関数のテストファイルです。\n");
72
73// 2. 一時ファイルのパーミッションを設定します。
74// 例として、所有者のみ読み書き可能 (0600) に設定します。
75// これにより、checkFileAccessAndCurrentUserが現在のユーザーに対して読み書き権限を報告するはずです。
76// 他のユーザーからのアクセスは拒否されます。
77chmod($tempFileName, 0600);
78
79// 3. 作成したファイルに対してアクセス権限とユーザー情報を確認する関数を呼び出します。
80checkFileAccessAndCurrentUser($tempFileName);
81
82// 4. 後処理として、作成した一時ファイルを削除します。
83unlink($tempFileName);
84
85?>

PHPのposix_access関数は、指定されたファイルやディレクトリに対し、現在の実効ユーザーが特定の操作を行えるかどうかをチェックする機能を提供します。第一引数にはアクセス権限を確認したいファイルのパスを、第二引数にはチェックする権限の種類を定数（例えばファイル存在チェックのPOSIX_F_OK、読み取り権限のPOSIX_R_OKなど）で指定します。この関数は、アクセス可能であればtrue、不可能であればfalseをブール値で返します。

このサンプルコードでは、posix_accessを利用して、与えられたファイルパスに対し、ファイルが存在するか、読み書き実行が可能かをそれぞれ詳しく確認しています。また、posix_geteuid関数で現在の実効ユーザーIDを取得し、そのIDを使ってposix_getpwuid関数でユーザー情報を取得することで、どのユーザーの権限でアクセスチェックが行われているかを明確に示しています。これにより、PHPスクリプトが特定のファイルに対してどのような操作権限を持っているかを把握でき、システムのセキュリティ確認や、ファイル操作を行う前の条件判断など、システムエンジニアの業務において基本的ながら重要な情報確認に役立ちます。コードの最後では、一時ファイルを生成し、そのファイルのアクセス権限を実際にチェックする一連の流れが示されています。

Copy
1<?php
2
3/**
4 * PHP posix_access 関数の使用例です。
5 *
6 * posix_access 関数は、現在のPHPスクリプトが動作しているユーザー（呼び出し元プロセス）が、
7 * 指定されたファイルやディレクトリに対してどのようなアクセス権を持っているかをチェックします。
8 * システムエンジニアを目指す方にとって、ファイルパーミッションの確認は基本的なスキルです。
9 */
10
11// POSIX 拡張機能が有効になっているかを確認します。
12// posix_access 関数は、この拡張機能がなければ利用できません。
13if (!extension_loaded('posix')) {
14    echo "エラー: POSIX 拡張がロードされていません。php.ini で有効にしてください。\n";
15    exit(1);
16}
17
18// 1. テスト用の仮ファイルを準備します。
19// このスクリプトが単体で動作するように、一時的なファイルを作成します。
20$testFilename = 'temp_posix_access_test.txt';
21
22// ファイルを作成し、内容を書き込みます。作成に失敗した場合はスクリプトを終了します。
23if (file_put_contents($testFilename, "これは posix_access 関数のテストファイルです。\n") === false) {
24    echo "エラー: テストファイルの作成に失敗しました: $testFilename\n";
25    exit(1);
26}
27echo "テストファイルを作成しました: $testFilename\n";
28
29// 2. 初期パーミッションでのアクセス権を確認します。
30// ファイル作成直後のパーミッション（通常はシステム設定に依存、例: 0644 (rw-r--r--)）でチェックします。
31echo "\n--- 初期パーミッションでの確認 ---\n";
32checkFilePermissions($testFilename);
33
34// 3. ファイルのパーミッションを変更し、再度アクセス権を確認します。
35// 例として、書き込みパーミッションを削除し、読み取り専用にします (0444 (r--r--r--))。
36if (chmod($testFilename, 0444)) {
37    echo "\nテストファイルのパーミッションを 0444 (読み取り専用) に変更しました。\n";
38    echo "--- パーミッション変更後の確認 (0444) ---\n";
39    checkFilePermissions($testFilename);
40} else {
41    echo "\nエラー: ファイルのパーミッション変更に失敗しました。\n";
42}
43
44// 4. 全ての処理が終わったら、作成した仮ファイルを削除してクリーンアップします。
45if (unlink($testFilename)) {
46    echo "\nクリーンアップ: テストファイル '$testFilename' を削除しました。\n";
47} else {
48    echo "\nエラー: テストファイル '$testFilename' の削除に失敗しました。手動で削除してください。\n";
49}
50
51/**
52 * 指定されたファイルのパーミッションを posix_access を使用して確認し、結果を表示するヘルパー関数です。
53 *
54 * @param string $filename 確認するファイルのパス。
55 * @return void
56 */
57function checkFilePermissions(string $filename): void
58{
59    // POSIX_F_OK: ファイルまたはディレクトリが存在するかどうかをチェックします。
60    if (posix_access($filename, POSIX_F_OK)) {
61        echo "- ファイルは存在します (POSIX_F_OK): YES\n";
62    } else {
63        echo "- ファイルは存在しません (POSIX_F_OK): NO\n";
64    }
65
66    // POSIX_R_OK: 読み取りパーミッションがあるかどうかをチェックします。
67    if (posix_access($filename, POSIX_R_OK)) {
68        echo "- 読み取りパーミッション (POSIX_R_OK): YES\n";
69    } else {
70        echo "- 読み取りパーミッション (POSIX_R_OK): NO\n";
71    }
72
73    // POSIX_W_OK: 書き込みパーミッションがあるかどうかをチェックします。
74    if (posix_access($filename, POSIX_W_OK)) {
75        echo "- 書き込みパーミッション (POSIX_W_OK): YES\n";
76    } else {
77        echo "- 書き込みパーミッション (POSIX_W_OK): NO\n";
78    }
79
80    // POSIX_X_OK: 実行パーミッションがあるかどうかをチェックします。
81    // 通常、テキストファイルには実行パーミッションはありません。
82    if (posix_access($filename, POSIX_X_OK)) {
83        echo "- 実行パーミッション (POSIX_X_OK): YES\n";
84    } else {
85        echo "- 実行パーミッション (POSIX_X_OK): NO\n";
86    }
87
88    // 複数のパーミッションを同時にチェックすることも可能です（ビット演算子 `|` を使用）。
89    // 例: 読み取りと書き込みの両方のパーミッションをチェックします。
90    if (posix_access($filename, POSIX_R_OK | POSIX_W_OK)) {
91        echo "- 読み取りと書き込みの両方 (POSIX_R_OK | POSIX_W_OK): YES\n";
92    } else {
93        echo "- 読み取りと書き込みの両方 (POSIX_R_OK | POSIX_W_OK): NO\n";
94    }
95}

posix_access関数は、PHPスクリプトが動作しているユーザー（プロセス）が、指定されたファイルやディレクトリに対してどのようなアクセス権限を持っているかを確認するために使用されます。この関数はPOSIX拡張機能が有効になっている環境でのみ利用でき、システムエンジニアにとってファイルパーミッションの確認は基本的なスキルです。

最初の引数$filenameには、アクセス権限をチェックしたいファイルまたはディレクトリのパスを文字列で指定します。二番目の引数$flagsには、確認したいアクセスタイプを整数値で渡します。この$flagsには、ファイルが存在するかを確認するPOSIX_F_OK、読み取り権限をチェックするPOSIX_R_OK、書き込み権限をチェックするPOSIX_W_OK、実行権限をチェックするPOSIX_X_OKといったPHPの組み込み定数を使用します。複数のアクセス権を同時に確認したい場合は、これらの定数をビット演算子の|で結合して渡すことができます。

関数は、指定されたアクセス権が利用可能であればtrueを、そうでなければfalseをブール値として返します。サンプルコードでは、一時的なテストファイルを作成し、その初期パーミッションと、chmod関数でパーミッションを変更した後の両方で、posix_accessを用いて各種アクセス権限が正しく判定される様子を具体的に示しています。これにより、PHPスクリプトがファイル操作を行う前に、その操作が可能かどうかを安全に確認することが可能となります。