【PHP8.x】RecursiveDirectoryIterator::OTHER_MODE_MASK定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたディレクトリツリー内のファイルやディレクトリについて、
5 * 「その他」グループ（ワールド）のパーミッションを分析します。
6 *
7 * RecursiveDirectoryIterator::OTHER_MODE_MASK を使用して、
8 * ファイルやディレクトリのパーミッションから「その他」グループの権限ビットを抽出します。
9 *
10 * @param string $directoryPath 走査するディレクトリのパス。
11 *                              スクリプトがアクセス可能な既存のディレクトリを指定してください。
12 * @param int|null $checkMask (オプション) 「その他」グループのパーミッションで検証したいマスク。
13 *                            このマスクがファイルやディレクトリの「その他」パーミッションに
14 *                            完全に含まれているかを確認します。
15 *                            例: `0o002` (その他グループの書き込み権限), `0o004` (その他グループの読み込み権限)。
16 */
17function analyzeOtherPermissions(string $directoryPath, ?int $checkMask = null): void
18{
19    // 指定されたパスが存在し、ディレクトリであることを確認します。
20    if (!is_dir($directoryPath)) {
21        echo "エラー: 指定されたパス '{$directoryPath}' は有効なディレクトリではありません。\n";
22        return;
23    }
24
25    echo "--- ディレクトリ: {$directoryPath} のパーミッション分析 ---\n";
26
27    try {
28        // RecursiveDirectoryIterator を使用してディレクトリを再帰的に走査します。
29        // SKIP_DOTS フラグは、特殊なディレクトリ「.」と「..」をスキップします。
30        $iterator = new RecursiveDirectoryIterator($directoryPath, RecursiveDirectoryIterator::SKIP_DOTS);
31        
32        // RecursiveIteratorIterator は、RecursiveDirectoryIterator をラップし、
33        // ディレクトリツリー全体を平坦なリストとして反復できるようにします。
34        // SELF_FIRST フラグは、ディレクトリ自身をその内容の前に返すように指定します。
35        $recursiveIterator = new RecursiveIteratorIterator(
36            $iterator,
37            RecursiveIteratorIterator::SELF_FIRST
38        );
39
40        foreach ($recursiveIterator as $fileInfo) {
41            $filePath = $fileInfo->getPathname();
42            // ファイルまたはディレクトリのパーミッションを取得します。
43            // getPerms() はファイルのモードを整数値として返します (例: 0100644)。
44            $perms = $fileInfo->getPerms();
45
46            // RecursiveDirectoryIterator::OTHER_MODE_MASK を使用して、
47            // 取得したパーミッションから「その他」グループ（ワールド）のビットを抽出します。
48            // OTHER_MODE_MASK は通常 0o007 (8進数) に相当し、
49            // その他グループの読み書き実行 (rwx) ビットを分離するために使われます。
50            $otherPermissions = $perms & RecursiveDirectoryIterator::OTHER_MODE_MASK;
51
52            // 抽出した「その他」グループのパーミッションを8進数形式で表示します。
53            // %03o は、8進数で3桁、ゼロ埋めして表示することを意味します。
54            echo sprintf(
55                "%s: その他パーミッション (8進数) = %03o",
56                $filePath,
57                $otherPermissions
58            );
59
60            // オプション引数 $checkMask が指定されている場合、追加の検証を行います。
61            // これがキーワード「php optional_param」に最も関連する部分です。
62            if ($checkMask !== null) {
63                // $checkMask がファイル/ディレクトリの「その他」パーミッションに
64                // 完全に含まれているかを確認します。
65                // 例えば、$checkMask が 0o002 (書き込み) で、$otherPermissions が 0o006 (rw-) なら条件は真となります。
66                if (($otherPermissions & $checkMask) === $checkMask) {
67                    echo sprintf(" [OK: 指定マスク '%03o' を含みます]", $checkMask);
68                } else {
69                    echo sprintf(" [NG: 指定マスク '%03o' を含みません]", $checkMask);
70                }
71            }
72            echo "\n";
73        }
74    } catch (UnexpectedValueException $e) {
75        // ディレクトリの読み込み中に問題が発生した場合の例外処理です。
76        // 例: 権限不足、存在しないパスが渡された場合など。
77        echo "エラー: ディレクトリの読み込み中に問題が発生しました。権限またはパスを確認してください。\n";
78        echo "詳細: " . $e->getMessage() . "\n";
79    }
80
81    echo "---------------------------------------------------\n\n";
82}
83
84// --- サンプルコードの実行例 ---
85// 以下の呼び出し例を、あなたの環境に合わせて調整して実行してください。
86// __DIR__ は、現在のスクリプトファイルが存在するディレクトリのパスを返します。
87
88// 1. オプション引数なしで呼び出し:
89// 指定されたディレクトリ内の全てのファイルとディレクトリの「その他」グループパーミッションを表示します。
90analyzeOtherPermissions(__DIR__);
91
92// 2. オプション引数ありで呼び出し:
93// 「その他」グループに書き込み権限 (0o002) があるかを確認します。
94// PHP 8以降では、8進数リテラルに `0o` プレフィックスを使用できます。
95analyzeOtherPermissions(__DIR__, 0o002);
96
97// 3. 別のオプション引数ありで呼び出し:
98// 「その他」グループに読み込み権限 (0o004) があるかを確認します。
99analyzeOtherPermissions(__DIR__, 0o004);
100
101?>

このPHPコードは、指定されたディレクトリツリー内のファイルやディレクトリについて、「その他」グループ（ワールド）のパーミッションを分析するものです。主な役割は、RecursiveDirectoryIterator::OTHER_MODE_MASK定数を利用して、ファイルやディレクトリのパーミッションから「その他」グループの権限ビットを正確に抽出することにあります。この定数は、通常0o007（8進数）に相当し、システム上の外部ユーザーに対する読み書き実行の権限を分離するために使われます。

analyzeOtherPermissions関数は、走査するディレクトリのパスを$directoryPath（string型）として受け取り、そのディレクトリの内容を再帰的に調べます。各ファイルやディレクトリについて、取得したパーミッションとOTHER_MODE_MASKをビット演算で組み合わせることで、「その他」グループのパーミッションを特定し、8進数形式で表示します。

さらに、この関数は$checkMask（int型またはnull）というオプション引数も受け付けます。これはPHPにおけるオプション引数の使用例であり、$checkMaskに特定のパーミッションマスク（例：0o002で書き込み権限）を指定すると、そのマスクが対象のファイルやディレクトリの「その他」グループのパーミッションに完全に含まれているかを検証し、その結果も出力します。関数の戻り値はvoidで、処理結果を直接コンソールに出力します。このコードは、ファイルシステムの権限を理解し、特にセキュリティ設定の確認に役立つ基本的な方法を提供します。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::OTHER_MODE_MASK と open_basedir の関連性を示すサンプルコード。
5 *
6 * この関数は、一時的なディレクトリ構造を作成し、それを再帰的に走査します。
7 * 走査中に各ファイルおよびディレクトリのパーミッション情報を取得し、
8 * RecursiveDirectoryIterator::OTHER_MODE_MASK を使用して、
9 * 「その他のユーザー」向けのパーミッション部分のみを抽出して表示します。
10 *
11 * また、PHPのセキュリティ設定である 'open_basedir' の現在の設定も表示し、
12 * RecursiveDirectoryIterator のファイルシステム操作が、この設定によって
13 * どのように制限される可能性があるかを理解する手助けとします。
14 * 'open_basedir' が有効な場合、PHPスクリプトがアクセスできるディレクトリが限定され、
15 * その範囲外へのアクセスはエラーとなります。
16 */
17function demonstrateRecursiveDirectoryPermissions(): void
18{
19    // 一時ディレクトリとファイルを生成するためのパスを設定します。
20    $tempBaseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_iter_demo_');
21    $tempSubDir = $tempBaseDir . DIRECTORY_SEPARATOR . 'sub_dir';
22    $tempFile = $tempBaseDir . DIRECTORY_SEPARATOR . 'file_a.txt';
23    $tempSubFile = $tempSubDir . DIRECTORY_SEPARATOR . 'file_b.txt';
24
25    // try-finally ブロックを使用し、確実に一時ファイルをクリーンアップします。
26    try {
27        // 一時ディレクトリとファイルを作成します。
28        // umask の影響を受けるため、ここで設定するパーミッションは推奨値であり、
29        // 実際のパーミッションはシステムの umask 設定によって変更される可能性があります。
30        if (!mkdir($tempBaseDir, 0755, true)) {
31            throw new RuntimeException("一時ディレクトリ '$tempBaseDir' の作成に失敗しました。");
32        }
33        if (!mkdir($tempSubDir, 0755, true)) {
34            throw new RuntimeException("一時サブディレクトリ '$tempSubDir' の作成に失敗しました。");
35        }
36        file_put_contents($tempFile, 'これは一時ファイル A の内容です。');
37        file_put_contents($tempSubFile, 'これは一時ファイル B の内容です。');
38
39        echo "一時ディレクトリが作成されました: " . realpath($tempBaseDir) . "\n";
40        echo "----------------------------------------\n";
41
42        // PHPの 'open_basedir' 設定の現在の値を取得し表示します。
43        // open_basedir は、PHPスクリプトがアクセスできるファイルシステムの範囲を制限する
44        // 重要なセキュリティ設定です。この設定が有効な場合、RecursiveDirectoryIterator
45        // は、指定されたディレクトリとそのサブディレクトリ以外のパスにアクセスできません。
46        $openBasedirValue = ini_get('open_basedir');
47        echo "現在の 'open_basedir' 設定: " . ($openBasedirValue ?: '設定なし (制限なし)') . "\n";
48        if ($openBasedirValue) {
49            echo "  注意: 'open_basedir' が設定されているため、RecursiveDirectoryIterator は、\n";
50            echo "        設定されたパスの範囲内でしか動作できません。範囲外へのアクセスはエラーになります。\n";
51        }
52        echo "----------------------------------------\n";
53
54        // RecursiveDirectoryIterator を使ってディレクトリを再帰的に走査します。
55        // RecursiveDirectoryIterator::SKIP_DOTS は、'.' (カレントディレクトリ) と '..' (親ディレクトリ) をスキップします。
56        $directoryIterator = new RecursiveDirectoryIterator($tempBaseDir, RecursiveDirectoryIterator::SKIP_DOTS);
57        // RecursiveIteratorIterator は、RecursiveDirectoryIterator のイテレータをフラットに扱い、
58        // サブディレクトリ内のファイルも簡単に走査できるようにします。
59        $recursiveIterator = new RecursiveIteratorIterator(
60            $directoryIterator,
61            RecursiveIteratorIterator::SELF_FIRST // 親ディレクトリ自身も走査に含めます
62        );
63
64        echo "ファイルおよびディレクトリのパーミッション情報:\n";
65        foreach ($recursiveIterator as $item) {
66            /** @var SplFileInfo $item */
67            $path = $item->getPathname();
68            $perms = $item->getPerms(); // ファイルまたはディレクトリのパーミッションを八進数形式で取得します。
69
70            // RecursiveDirectoryIterator::OTHER_MODE_MASK を使用して、
71            // パーミッションのうち「その他のユーザー」向けのビットのみを抽出します。
72            // この定数は、ファイルモードマスクで 'other' カテゴリの読み取り、書き込み、実行権限
73            // (通常は八進数の 0007) を表します。
74            $otherUserPerms = $perms & RecursiveDirectoryIterator::OTHER_MODE_MASK;
75
76            echo sprintf(
77                "- %s (%s): 全パーミッション: %s | その他ユーザーのパーミッション: %s\n",
78                $item->getBasename(),
79                $item->isDir() ? 'ディレクトリ' : 'ファイル',
80                sprintf('%04o', $perms), // 八進数形式で4桁表示 (例: 0755)
81                sprintf('%03o', $otherUserPerms) // 八進数形式で3桁表示 (例: 777 から 777 をマスクすると 007)
82            );
83        }
84
85    } catch (Exception $e) {
86        // エラーが発生した場合、メッセージを表示します。
87        echo "エラーが発生しました: " . $e->getMessage() . "\n";
88    } finally {
89        // 作成した一時ファイルをすべて削除し、クリーンアップします。
90        if (is_dir($tempBaseDir)) {
91            $filesToRemove = new RecursiveIteratorIterator(
92                new RecursiveDirectoryIterator($tempBaseDir, RecursiveDirectoryIterator::SKIP_DOTS),
93                RecursiveIteratorIterator::CHILD_FIRST // 子要素から先に削除します
94            );
95
96            foreach ($filesToRemove as $fileinfo) {
97                if ($fileinfo->isDir()) {
98                    rmdir($fileinfo->getRealPath());
99                } else {
100                    unlink($fileinfo->getRealPath());
101                }
102            }
103            rmdir($tempBaseDir); // 最後にルートディレクトリを削除します。
104            echo "一時ディレクトリ '$tempBaseDir' およびその内容を削除しました。\n";
105        }
106    }
107}
108
109// 関数を実行します。
110demonstrateRecursiveDirectoryPermissions();

このPHPサンプルコードは、ファイルシステムを再帰的に走査し、ファイルやディレクトリのパーミッション（権限）情報を確認する方法を示しています。特に、ファイルやディレクトリの権限管理に用いられるRecursiveDirectoryIterator::OTHER_MODE_MASK定数の使い方を解説しています。この定数は、パーミッション設定のうち、「その他のユーザー（Everyone）」に対する読み取り、書き込み、実行権限の部分だけを抽出するために使用される整数値（int）です。この定数自体は引数を取りません。

サンプルコードでは、まず一時的なディレクトリとファイルを作成します。次に、PHPの重要なセキュリティ設定であるopen_basedirの現在の設定値を確認し表示します。open_basedirは、PHPスクリプトがアクセスできるディレクトリの範囲を制限し、セキュリティを向上させる役割があります。この設定が有効な場合、ファイルシステムを操作するPHPスクリプトは、指定されたパスの範囲内でのみ動作が許可されます。

その後、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを用いて、作成した一時ディレクトリ内の全てのファイルやディレクトリを再帰的に走査します。走査中に取得した各アイテムのパーミッション情報から、OTHER_MODE_MASKを使って「その他のユーザー」に与えられた権限のみを抽出し、その結果を表示します。これにより、ファイルシステムの権限管理とPHPのセキュリティ設定の関連性を理解できます。