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

Copy
1<?php
2
3/**
4 * posix_eaccess 関数の基本的な使用例を示す関数。
5 * 指定されたファイルパスに対して、現在の実効ユーザーID (effective user ID) に基づく
6 * アクセス権限のチェックを行います。
7 *
8 * システムエンジニアを目指す初心者向けに、ファイルの存在チェックや
9 * 読み取り・書き込み権限の確認方法を理解するのに役立ちます。
10 */
11function demonstratePosixEaccess(): void
12{
13    // テスト用のファイルパスを定義します。現在のスクリプトと同じディレクトリに作成します。
14    $testFilePath = __DIR__ . '/posix_eaccess_test_file.txt';
15
16    // 1. テストファイルを作成または上書きします。
17    // このファイルに対して posix_eaccess でアクセス権をチェックします。
18    if (file_put_contents($testFilePath, 'このファイルはposix_eaccessのテスト用です。') === false) {
19        echo "エラー: テストファイル '{$testFilePath}' の作成に失敗しました。\n";
20        return;
21    }
22    echo "テストファイル '{$testFilePath}' を作成しました。\n\n";
23
24    // 2. posix_eaccess を使ってファイルのアクセス権をチェックします。
25    // 各フラグは論理和 (|) で複数指定することも可能です。
26
27    echo "--- ファイルアクセス権チェック ---\n";
28
29    // POSIX_F_OK: ファイルが存在するかどうかをチェックします。
30    if (posix_eaccess($testFilePath, POSIX_F_OK)) {
31        echo "{$testFilePath}: ファイルが存在します。\n";
32    } else {
33        echo "{$testFilePath}: ファイルが存在しないか、アクセスできません。\n";
34    }
35
36    // POSIX_R_OK: ファイルが読み取り可能かどうかをチェックします。
37    if (posix_eaccess($testFilePath, POSIX_R_OK)) {
38        echo "{$testFilePath}: 読み取り可能です。\n";
39    } else {
40        echo "{$testFilePath}: 読み取り可能ではありません。\n";
41    }
42
43    // POSIX_W_OK: ファイルが書き込み可能かどうかをチェックします。
44    if (posix_eaccess($testFilePath, POSIX_W_OK)) {
45        echo "{$testFilePath}: 書き込み可能です。\n";
46    } else {
47        echo "{$testFilePath}: 書き込み可能ではありません。\n";
48    }
49
50    // POSIX_X_OK: ファイルが実行可能かどうかをチェックします。
51    // 通常、テキストファイルは実行可能ではないため、falseが返されることが多いです。
52    if (posix_eaccess($testFilePath, POSIX_X_OK)) {
53        echo "{$testFilePath}: 実行可能です。\n";
54    } else {
55        echo "{$testFilePath}: 実行可能ではありません。\n";
56    }
57
58    // POSIX_R_OK | POSIX_W_OK: ファイルが読み取りと書き込みの両方可能かどうかをチェックします。
59    if (posix_eaccess($testFilePath, POSIX_R_OK | POSIX_W_OK)) {
60        echo "{$testFilePath}: 読み取りおよび書き込みの両方が可能です。\n";
61    } else {
62        echo "{$testFilePath}: 読み取りまたは書き込みが不可能か、その両方が不可能です。\n";
63    }
64
65    echo "---------------------------------\n\n";
66
67    // 3. テストファイルをクリーンアップ（削除）します。
68    if (unlink($testFilePath)) {
69        echo "テストファイル '{$testFilePath}' を削除しました。\n";
70    } else {
71        echo "エラー: テストファイル '{$testFilePath}' の削除に失敗しました。\n";
72    }
73}
74
75// 関数を実行し、posix_eaccess の動作を確認します。
76demonstratePosixEaccess();

PHPのposix_eaccess関数は、指定したファイルやディレクトリに対し、現在のスクリプトが動作している「実効ユーザーID」に基づいてアクセス権限をチェックします。これは、システムエンジニアがプログラムが特定のファイルにアクセス可能か、書き込み可能かなどを事前に確認する際に重要な機能です。

第一引数$filenameには、権限をチェックしたいファイルやディレクトリのパスを文字列で指定します。第二引数$flagsには、チェックする権限の種類を整数値で指定します。利用できる定数として、ファイルの存在を確認するPOSIX_F_OK、読み取り権限を確認するPOSIX_R_OK、書き込み権限を確認するPOSIX_W_OK、実行権限を確認するPOSIX_X_OKがあります。これらのフラグは|演算子を使って複数組み合わせて指定することも可能です。関数は、指定された全ての権限がある場合にtrueを、そうでない場合にfalseをブール値で返します。

サンプルコードでは、一時ファイルを作成し、posix_eaccess関数を使ってそのファイルの存在、読み取り、書き込み、実行といった様々な権限を個別に、また組み合わせて確認する具体的な方法を示しています。これにより、PHPスクリプトがファイル操作を行う前に、安全かつ適切にアクセス権限を検証する手法を習得できます。

Copy
1<?php
2
3/**
4 * posix_eaccess 関数の使用例を示します。
5 *
6 * この関数は、指定されたファイルへのアクセス権限を、実効ユーザーID/グループIDに基づいてチェックします。
7 * POSIXシステム（Linux, macOSなど）でのみ利用可能です。
8 */
9function demonstratePosixEaccess(): void
10{
11    // POSIX拡張がロードされているかを確認します
12    if (!extension_loaded('posix')) {
13        echo "エラー: POSIX拡張がロードされていません。この関数はPOSIXシステムでのみ利用可能です。\n";
14        return;
15    }
16
17    // 一時的なテストファイルを作成します
18    $tempFile = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_posix_eaccess_test_file.txt';
19    echo "テストファイル: " . $tempFile . "\n\n";
20
21    // --- ステップ1: ファイルが存在しない場合のアクセスチェック ---
22    echo "--- ステップ1: ファイルが存在しない場合 ---\n";
23    if (posix_eaccess($tempFile, POSIX_F_OK)) {
24        echo "[結果] {$tempFile} は存在します。\n";
25    } else {
26        echo "[結果] {$tempFile} は存在しません。（期待通り）\n";
27    }
28    echo "\n";
29
30    // --- ステップ2: ファイルを作成し、パーミッションを設定 ---
31    // ファイルを作成し、内容を書き込みます
32    if (file_put_contents($tempFile, "Hello from posix_eaccess example!\n") === false) {
33        echo "エラー: テストファイルの作成に失敗しました。\n";
34        return;
35    }
36    // パーミッションを 0644 (所有者:読み書き可, グループ・その他:読み取り可) に設定します
37    chmod($tempFile, 0644);
38    echo "テストファイルを作成し、パーミッションを '0644' に設定しました。\n";
39    echo "（所有者は読み書き可能、グループとその他は読み取り可能）\n\n";
40
41    // --- ステップ3: 作成したファイルに対してアクセスチェック ---
42    echo "--- ステップ3: 作成したファイル (パーミッション 0644) ---\n";
43    echo "{$tempFile} のアクセス権限をチェック:\n";
44
45    // ファイルの存在チェック
46    echo "  - 存在 (POSIX_F_OK): ";
47    echo posix_eaccess($tempFile, POSIX_F_OK) ? "OK（期待通り）\n" : "NG\n";
48
49    // 読み取りアクセスチェック
50    echo "  - 読み取り (POSIX_R_OK): ";
51    echo posix_eaccess($tempFile, POSIX_R_OK) ? "OK（期待通り）\n" : "NG\n";
52
53    // 書き込みアクセスチェック
54    echo "  - 書き込み (POSIX_W_OK): ";
55    echo posix_eaccess($tempFile, POSIX_W_OK) ? "OK（期待通り）\n" : "NG\n";
56
57    // 実行アクセスチェック (テキストファイルなので通常は不可)
58    echo "  - 実行 (POSIX_X_OK): ";
59    echo posix_eaccess($tempFile, POSIX_X_OK) ? "OK\n" : "NG（期待通り）\n";
60    echo "\n";
61
62    // --- ステップ4: パーミッションを変更してアクセスチェック ---
63    // パーミッションを 0444 (読み取り専用) に変更します
64    chmod($tempFile, 0444);
65    echo "テストファイルのパーミッションを '0444' (読み取り専用) に変更しました。\n";
66    echo "（所有者・グループ・その他すべて読み取り可能、書き込み不可）\n\n";
67
68    echo "--- ステップ4: パーミッション変更後のファイル (パーミッション 0444) ---\n";
69    echo "{$tempFile} のアクセス権限を再チェック:\n";
70
71    // 読み取りアクセスチェック
72    echo "  - 読み取り (POSIX_R_OK): ";
73    echo posix_eaccess($tempFile, POSIX_R_OK) ? "OK（期待通り）\n" : "NG\n";
74
75    // 書き込みアクセスチェック
76    echo "  - 書き込み (POSIX_W_OK): ";
77    echo posix_eaccess($tempFile, POSIX_W_OK) ? "OK\n" : "NG（期待通り）\n";
78    echo "\n";
79
80    // --- クリーンアップ ---
81    // 作成したテストファイルを削除します
82    if (unlink($tempFile)) {
83        echo "テストファイル {$tempFile} を削除しました。\n";
84    } else {
85        echo "エラー: テストファイル {$tempFile} の削除に失敗しました。\n";
86    }
87}
88
89// 関数を実行してサンプルコードの動作を確認します
90demonstratePosixEaccess();

posix_eaccess関数は、指定されたファイルやディレクトリに対して、現在のスクリプトを実行している実効ユーザーIDとグループIDに基づいてアクセス権限があるかをチェックする機能を提供します。この関数は、LinuxやmacOSなどのPOSIX互換システムでのみ利用可能です。

最初の引数$filenameには、アクセス権限をチェックしたいファイルやディレクトリのパスを指定します。2番目の引数$flagsには、どのようなアクセス権限をチェックするかを示す定数を渡します。例えば、POSIX_F_OKはファイルが存在するかどうかを、POSIX_R_OKは読み取り権限があるかを、POSIX_W_OKは書き込み権限があるかを、POSIX_X_OKは実行権限があるかをそれぞれチェックします。複数の権限を同時にチェックしたい場合は、これらの定数を組み合わせることが可能です。

関数は、要求されたアクセス権限がある場合にtrueを、権限がない場合やファイルが存在しないなどの理由でチェックに失敗した場合にfalseを返します。

サンプルコードでは、まず一時ファイルを作成し、posix_eaccess関数を使ってそのファイルが存在するかどうかを確認しています。次に、ファイルのパーミッションを0644（所有者は読み書き可能、その他は読み取り可能）に設定した上で、読み取り、書き込み、実行の各権限をチェックし、期待される結果が得られることを示しています。さらに、パーミッションを0444（読み取り専用）に変更し、再び権限チェックを行うことで、パーミッション変更に伴うアクセス権限の変化を具体的に確認しています。これにより、プログラムが実際にファイルにアクセスする前に、安全に操作できるかを判断するのに役立つことが理解できます。