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

Copy
1<?php
2
3/**
4 * POSIX_W_OK 定数を使用してファイルの書き込みアクセス権限をチェックするサンプル。
5 *
6 * この関数は、POSIX_W_OK 定数の値を確認し、一時ファイルを作成して
7 * そのファイルに対する書き込みアクセス権限があるかどうかを posix_access() 関数でチェックします。
8 * POSIX 拡張が有効なシステム (Linux, macOSなど) でのみ動作します。
9 */
10function demonstratePosixWOkConstant(): void
11{
12    // POSIX 拡張がロードされているか確認
13    // Windows環境などでは利用できない場合があります。
14    if (!extension_loaded('posix')) {
15        echo "エラー: POSIX 拡張がロードされていません。\n";
16        echo "このサンプルコードは POSIX 準拠のシステムで実行してください。\n";
17        return;
18    }
19
20    // POSIX_W_OK 定数の値を出力
21    // この定数は、posix_access() 関数で使用され、ファイルが書き込み可能かテストするモードを指定します。
22    echo "POSIX_W_OK 定数の値: " . POSIX_W_OK . " (int)\n\n";
23
24    // 一時ファイルを作成
25    // tempnam() は、ユニークなファイル名でファイルを作成し、そのフルパスを返します。
26    $tempFilePath = tempnam(sys_get_temp_dir(), 'posix_test_');
27    if ($tempFilePath === false) {
28        echo "エラー: 一時ファイルの作成に失敗しました。\n";
29        return;
30    }
31    echo "一時ファイルを作成しました: " . $tempFilePath . "\n";
32
33    // --- ケース1: 書き込み権限がある場合 ---
34    // chmod() でファイルパーミッションを設定 (0600: 所有者のみ読み書き)
35    if (!chmod($tempFilePath, 0600)) {
36        echo "エラー: パーミッション設定(0600)に失敗しました。\n";
37        unlink($tempFilePath); // 後処理
38        return;
39    }
40    echo "  パーミッションを 0600 (所有者のみ読み書き) に設定しました。\n";
41
42    // posix_access() で書き込み権限をチェック
43    if (posix_access($tempFilePath, POSIX_W_OK)) {
44        echo "  → ファイルは書き込み可能です。\n\n";
45    } else {
46        echo "  → ファイルは書き込み可能ではありません。\n\n";
47    }
48
49    // --- ケース2: 書き込み権限がない場合 ---
50    // chmod() でファイルパーミッションを設定 (0400: 所有者のみ読み取り)
51    if (!chmod($tempFilePath, 0400)) {
52        echo "エラー: パーミッション設定(0400)に失敗しました。\n";
53        unlink($tempFilePath); // 後処理
54        return;
55    }
56    echo "  パーミッションを 0400 (所有者のみ読み取り) に設定しました。\n";
57
58    // posix_access() で書き込み権限をチェック
59    if (posix_access($tempFilePath, POSIX_W_OK)) {
60        echo "  → ファイルは書き込み可能です。\n\n";
61    } else {
62        echo "  → ファイルは書き込み可能ではありません。\n\n";
63    }
64
65    // 後処理: 作成した一時ファイルを削除
66    if (unlink($tempFilePath)) {
67        echo "一時ファイル '" . $tempFilePath . "' を削除しました。\n";
68    } else {
69        echo "エラー: 一時ファイル '" . $tempFilePath . "' の削除に失敗しました。\n";
70    }
71}
72
73// 関数を実行してサンプルコードの動作を確認
74demonstratePosixWOkConstant();

PHPのPOSIX_W_OK定数は、ファイルやディレクトリへのアクセス権限をプログラムで確認する際に使用される特別な値です。この定数は引数を取らず、整数（int）を返します。主にposix_access()関数に渡して、指定したファイルが書き込み可能であるかどうかをテストするモードを指定するために利用されます。

このサンプルコードは、まずPOSIX_W_OK定数の値を確認し、その具体的な使い方を示しています。最初にPOSIX拡張が利用可能かを確認し、次にシステムの一時ディレクトリに一時ファイルを作成します。作成したファイルに対し、chmod()関数でパーミッションを0600（所有者のみ読み書き可能）に設定した場合と、0400（所有者のみ読み取り可能）に設定した場合の二つのケースでposix_access()関数とPOSIX_W_OK定数を用いて書き込み権限をチェックし、その結果を出力します。これにより、権限の有無によってposix_access()関数の挙動がどのように変わるかを確認できます。この機能は、LinuxやmacOSなどのPOSIX準拠システムでPHPのPOSIX拡張がロードされている場合にのみ利用可能です。最後に、作成した一時ファイルは適切に削除されます。システムエンジニアを目指す方にとって、プログラムでファイルシステムの権限を安全に確認する基本的な方法を理解する上で役立ちます。

Copy
1<?php
2
3/**
4 * 現在のシステムユーザーの情報を取得し、指定されたファイルへの書き込み権限をチェックする関数。
5 * システムエンジニアを目指す初心者が、POSIX関連の関数と定数の基本的な使い方を理解するのに役立ちます。
6 *
7 * @param string $filePath アクセス権限をチェックするファイルのパス。
8 * @return void
9 */
10function checkCurrentUserAndFileWriteAccess(string $filePath): void
11{
12    // 現在のユーザーID (UID) を取得します。
13    // このUIDは、スクリプトを実行しているユーザーの識別子です。
14    $currentUid = posix_getuid();
15    echo "現在のユーザーID (UID): " . $currentUid . PHP_EOL;
16
17    // ユーザーIDから、パスワードファイルのエントリ（ユーザー情報）を取得します。
18    // 戻り値は配列で、'name', 'uid', 'gid', 'dir' (ホームディレクトリ), 'shell' などが含まれます。
19    $userInfo = posix_getpwuid($currentUid);
20
21    if ($userInfo) {
22        echo "現在のユーザー情報:" . PHP_EOL;
23        echo "  名前: " . $userInfo['name'] . PHP_EOL;
24        echo "  UID: " . $userInfo['uid'] . PHP_EOL;
25        echo "  GID: " . $userInfo['gid'] . PHP_EOL;
26        echo "  ホームディレクトリ: " . $userInfo['dir'] . PHP_EOL;
27        echo "  シェル: " . $userInfo['shell'] . PHP_EOL;
28    } else {
29        echo "エラー: ユーザーID " . $currentUid . " の情報を取得できませんでした。" . PHP_EOL;
30        return;
31    }
32
33    echo PHP_EOL;
34    echo "ファイル '" . $filePath . "' への書き込み権限をチェックします..." . PHP_EOL;
35
36    // posix_access() 関数と POSIX_W_OK 定数を使用して、指定されたファイルへの書き込み権限があるかを確認します。
37    // POSIX_W_OK は、書き込み権限をチェックするためのビットマスク定数です。
38    if (posix_access($filePath, POSIX_W_OK)) {
39        echo "-> アクセス権限あり: ユーザー '" . $userInfo['name'] . "' はこのファイルに書き込むことができます。" . PHP_EOL;
40    } else {
41        echo "-> アクセス権限なし: ユーザー '" . $userInfo['name'] . "' はこのファイルに書き込むことができません。" . PHP_EOL;
42        echo "   (ファイルが存在しない、権限がない、または他の理由でアクセスできません。)" . PHP_EOL;
43    }
44}
45
46// 例として、このスクリプトファイル自身への書き込み権限をチェックします。
47// 実際には、一時ファイルや設定ファイルなど、異なるパスを試すことができます。
48$targetFile = __FILE__; // 現在実行中のスクリプトファイル
49// $targetFile = '/tmp/test_file.txt'; // 例: 一時ファイルを作成して試す場合
50
51// 関数を実行して結果を表示します。
52checkCurrentUserAndFileWriteAccess($targetFile);
53
54?>

このPHPコードは、現在のシステムユーザーの情報を取得し、指定されたファイルへの書き込み権限があるかを確認するものです。

まず、posix_getuid()関数でスクリプトを実行しているユーザーのID（UID）を取得します。次に、このUIDを引数としてposix_getpwuid()関数を呼び出すことで、ユーザーの名前、ホームディレクトリ、シェルといった詳細な情報を配列として取得します。posix_getpwuid()関数は、引数にユーザーIDを取り、成功すればユーザー情報の連想配列を、失敗すればfalseを返します。

続いて、posix_access()関数とPOSIX_W_OK定数を使用し、引数$filePathで指定されたファイルへの書き込み権限があるかをチェックします。POSIX_W_OKは、ファイルへの書き込み権限を判定するための特別な定数で、戻り値は整数型です。posix_access()関数は、引数にファイルパスとチェックしたいアクセスタイプ（例: POSIX_W_OK）を取り、権限があればtrueを、なければfalseを戻り値として返します。

サンプルコード内のcheckCurrentUserAndFileWriteAccess関数は、これらの処理をまとめ、現在のユーザー情報とファイルへのアクセス権限チェックの結果を画面に表示します。この関数自体は戻り値を持たない（void）ため、結果は出力で確認できます。システムエンジニア初心者が、ユーザー情報の取得やファイルアクセス権限の確認方法を理解する上で役立ちます。