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

Copy
1<?php
2
3/**
4 * PHPのPOSIX拡張機能の基本的な使用例を示す関数。
5 *
6 * この関数は、現在のプロセスのID (PID) を取得し、
7 * さらにスクリプトファイル自体が「通常のファイル」であるかをPOSIX_S_IFREG定数を使って確認します。
8 * システムエンジニアを目指す初心者の方にも、PHPでシステム情報の一部を扱う方法を理解しやすいように構成されています。
9 */
10function demonstratePosixFeatures(): void
11{
12    // 1. 現在のプロセスのID (PID) を取得し表示します。
13    //    posix_getpid() 関数は、現在のPHPスクリプトを実行しているプロセスの
14    //    一意な識別子（プロセスID）を整数として返します。
15    $currentPid = posix_getpid();
16    echo "現在のプロセスID (PID): " . $currentPid . PHP_EOL;
17
18    // 2. このスクリプトファイル自身のパスを取得します。
19    //    __FILE__ はPHPの特別な定数（マジック定数）で、現在のスクリプトファイルの
20    //    フルパスを返します。
21    $scriptFilePath = __FILE__;
22
23    // 3. スクリプトファイルの統計情報を取得します。
24    //    stat() 関数は、指定されたファイルに関する詳細な情報（サイズ、パーミッション、
25    //    最終更新日時など）を配列で返します。
26    //    特に 'mode' 要素には、ファイルタイプとパーミッションのビットマスク値が含まれます。
27    $statInfo = stat($scriptFilePath);
28
29    // stat() が失敗した場合はエラーメッセージを表示して終了します。
30    if ($statInfo === false) {
31        echo "エラー: スクリプトファイル '" . basename($scriptFilePath) . "' の情報を取得できませんでした。" . PHP_EOL;
32        return;
33    }
34
35    // 4. ファイルタイプが「通常のファイル (regular file)」であるかをチェックします。
36    //    stat() が返す 'mode' 値は、複数の情報がビットで結合されたものです。
37    //    ファイルタイプのみを抽出するには、ファイルタイプマスク（POSIX_S_IFMTに相当する値）で
38    //    ビットAND演算を行う必要があります。
39    //    `0170000` (オクタル表記) は、ファイルタイプを表すビットのみを抽出するためのマスクです。
40    $fileTypeMask = 0170000; // POSIXのS_IFMTに相当するファイルタイプマスク
41    $extractedFileType = $statInfo['mode'] & $fileTypeMask;
42
43    echo "スクリプトファイル '" . basename($scriptFilePath) . "' のファイルタイプ: ";
44
45    // POSIX_S_IFREG 定数は、ファイルタイプが「通常のファイル」であることを示すビットマスク値です。
46    // 抽出したファイルタイプがこの定数と一致するかを比較することで、通常のファイルかを判断できます。
47    if ($extractedFileType === POSIX_S_IFREG) {
48        echo "通常のファイル (regular file) です。" . PHP_EOL;
49    } else {
50        // 通常のファイルではない場合、どのようなタイプであるかを表示します。
51        echo "通常のファイルではありません (タイプ値: " . sprintf("0%o", $extractedFileType) . "、POSIX_S_IFREGの値: " . sprintf("0%o", POSIX_S_IFREG) . ")。" . PHP_EOL;
52    }
53}
54
55// 関数を実行して結果を表示します。
56demonstratePosixFeatures();

このサンプルコードは、PHPのPOSIX拡張機能を用いて、現在のプロセスの情報取得やファイルのタイプ判別を行う基本的な方法を示しています。まず、posix_getpid()関数を使って、PHPスクリプトが実行されている現在のプロセスの一意なIDを整数値として取得し表示します。この関数は引数を必要とせず、現在のプロセスのIDを返します。

次に、__FILE__マジック定数でこのスクリプト自身のパスを取得し、stat()関数でそのファイルの統計情報を取得します。stat()関数は、ファイルのサイズ、パーミッション、最終更新日時などの詳細な情報を含む配列を返します。特に、戻り値の配列に含まれるmode要素は、ファイルの種類とアクセス権を示すビットマスク値を含んでいます。

POSIX_S_IFREG定数は、引数を取らず、戻り値として整数値を持つ、ファイルが「通常のファイル（regular file）」であることを示すビットマスク値です。stat()から得られたmode値からファイルタイプを抽出するビット演算を行い、その結果とPOSIX_S_IFREGを比較することで、スクリプトファイルが実行ファイルやディレクトリなどではなく、一般的なデータファイルであるかを正確に判断できます。この一連の処理を通じて、PHPでシステム情報を扱い、ファイルの性質をプログラムで確認する方法を理解することができます。

Copy
1<?php
2
3/**
4 * Retrieves details of the owner of a regular file.
5 *
6 * This function first checks if the given path points to an existing regular file
7 * using `stat()` and the `POSIX_S_IFREG` constant. If it is a regular file,
8 * it then retrieves the file's owner UID and uses `posix_getpwuid()`
9 * to fetch detailed information about that user from the system's password database.
10 *
11 * @param string $filePath The path to the file.
12 * @return array|null An associative array containing the owner's details
13 *                    (e.g., 'name', 'uid', 'gid', 'dir', 'shell', etc.)
14 *                    or null if the file does not exist, is not a regular file,
15 *                    `stat()` fails, or owner information cannot be retrieved.
16 */
17function getRegularFileOwnerDetails(string $filePath): ?array
18{
19    // Check if the file exists at the given path.
20    if (!file_exists($filePath)) {
21        return null; // File does not exist.
22    }
23
24    // Get detailed file status information.
25    $fileStats = stat($filePath);
26
27    // If stat() fails (e.g., due to permissions), return null.
28    if ($fileStats === false) {
29        return null;
30    }
31
32    // Check if the file is a regular file using the POSIX_S_IFREG constant.
33    // The `mode` field from stat() contains both file type and permissions.
34    // We use the octal mask `0o170000` (equivalent to `S_IFMT` in C/POSIX)
35    // to isolate the file type bits before comparing with POSIX_S_IFREG.
36    if (($fileStats['mode'] & 0o170000) !== POSIX_S_IFREG) {
37        return null; // It's not a regular file (e.g., it's a directory, symbolic link, etc.).
38    }
39
40    // Extract the User ID (UID) of the file owner from the stat information.
41    $ownerUid = $fileStats['uid'];
42
43    // Retrieve user information (name, home directory, shell, etc.) based on the UID.
44    $ownerInfo = posix_getpwuid($ownerUid);
45
46    // Return the owner details array or null if posix_getpwuid() fails.
47    return $ownerInfo ?: null;
48}
49
50// --- Example Usage ---
51
52// 1. Create a temporary regular file for demonstration purposes.
53$tempFilePath = 'example_regular_file.txt';
54if (file_put_contents($tempFilePath, 'This is a test file for owner details.') === false) {
55    echo "Error: Could not create the temporary file.\n";
56    exit(1);
57}
58
59// 2. Call the function to get the owner details of the temporary file.
60$fileOwnerDetails = getRegularFileOwnerDetails($tempFilePath);
61
62// 3. Display the retrieved owner information.
63if ($fileOwnerDetails) {
64    echo "--- File Owner Information ---\n";
65    echo "File Path: $tempFilePath\n";
66    echo "Owner Name: " . ($fileOwnerDetails['name'] ?? 'N/A') . "\n";
67    echo "Owner UID: " . ($fileOwnerDetails['uid'] ?? 'N/A') . "\n";
68    echo "Group GID: " . ($fileOwnerDetails['gid'] ?? 'N/A') . "\n";
69    echo "Home Directory: " . ($fileOwnerDetails['dir'] ?? 'N/A') . "\n";
70    echo "Shell: " . ($fileOwnerDetails['shell'] ?? 'N/A') . "\n";
71    echo "----------------------------\n\n";
72} else {
73    echo "Could not retrieve owner details for '$tempFilePath'. " .
74         "It might not exist, not be a regular file, or owner info is unavailable.\n\n";
75}
76
77// 4. Test with a directory (which is not a regular file) to show the filtering.
78$tempDirPath = 'example_directory';
79if (!is_dir($tempDirPath)) {
80    mkdir($tempDirPath);
81}
82$dirOwnerDetails = getRegularFileOwnerDetails($tempDirPath);
83if ($dirOwnerDetails === null) {
84    echo "Correctly identified '$tempDirPath' as not a regular file.\n\n";
85} else {
86    echo "Error: '$tempDirPath' was incorrectly identified as a regular file.\n\n";
87}
88
89// 5. Clean up the created temporary file and directory.
90if (file_exists($tempFilePath)) {
91    unlink($tempFilePath);
92}
93if (is_dir($tempDirPath)) {
94    rmdir($tempDirPath);
95}
96
97?>

このPHPサンプルコードは、指定されたパスが「通常のファイル」である場合に、そのファイルの所有者情報を取得する方法を示しています。getRegularFileOwnerDetails関数は、ファイルパス（文字列）を引数として受け取ります。

まず、stat()関数を使用してファイルの存在確認と詳細な状態情報を取得します。取得した情報の中から、ファイルのモード値をPOSIX_S_IFREG定数と比較することで、そのファイルが通常のファイルであるかを判別しています。POSIX_S_IFREGは、PHPのPOSIX拡張機能で提供される定数であり、ファイルの種類が「通常のファイル」であることを示す整数値を持ちます。

ファイルが通常のファイルであると確認できた場合、stat()から得られるファイルの所有者UID（ユーザーID）を抽出します。このUIDを引数としてposix_getpwuid()関数を呼び出します。posix_getpwuid()は、指定されたUID（整数）に基づき、システム上のパスワードデータベースからユーザー名、ホームディレクトリ、シェルなどの詳細なユーザー情報を連想配列として返します。

関数は、所有者情報が正常に取得できた場合はその連想配列を、ファイルが存在しない、通常のファイルではない、または情報が取得できなかった場合はnullを戻り値として返します。このコードは、ファイルの種類を正確に識別し、その所有者情報をプログラムから安全に取得する基本的な手法を学ぶのに役立ちます。