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

Copy
1<?php
2
3// このサンプルコードは、GlobIterator のオプション引数と、
4// GlobIterator::OTHER_MODE_MASK 定数の使用法を示します。
5// 単体で動作するように、一時的なファイルとディレクトリを作成・削除します。
6
7// 一時ディレクトリとテストファイルを作成します。
8$tempDirPath = __DIR__ . DIRECTORY_SEPARATOR . 'temp_glob_test';
9if (!is_dir($tempDirPath)) {
10    mkdir($tempDirPath, 0755, true);
11}
12
13// テストファイルとそのパーミッションを設定します。
14// chmod() の第2引数は八進数で指定します。
15file_put_contents($tempDirPath . DIRECTORY_SEPARATOR . 'file1.txt', 'Content 1');
16chmod($tempDirPath . DIRECTORY_SEPARATOR . 'file1.txt', 0644); // rw-r--r-- (other: r--)
17
18file_put_contents($tempDirPath . DIRECTORY_SEPARATOR . 'file2.txt', 'Content 2');
19chmod($tempDirPath . DIRECTORY_SEPARATOR . 'file2.txt', 0600); // rw------- (other: ---)
20
21file_put_contents($tempDirPath . DIRECTORY_SEPARATOR . 'file3.txt', 'Content 3');
22chmod($tempDirPath . DIRECTORY_SEPARATOR . 'file3.txt', 0666); // rw-rw-rw- (other: rw-)
23
24
25/**
26 * 指定されたディレクトリ内のファイルを走査し、
27 * 各ファイルの「その他のユーザー」に対するパーミッションを表示します。
28 *
29 * この関数は、GlobIterator のコンストラクタにおけるオプション引数の使用例と、
30 * GlobIterator::OTHER_MODE_MASK 定数の具体的な利用方法を示します。
31 *
32 * @param string $directoryPath 走査するディレクトリのパス。
33 */
34function analyzeFilePermissions(string $directoryPath): void
35{
36    echo "--- ファイルパーミッション分析 ---" . PHP_EOL;
37
38    try {
39        // GlobIterator のコンストラクタは、第2引数としてオプションのフラグを取ります。
40        // これは「optional_param」（オプション引数）の一例です。
41        // ここでは FilesystemIterator::SKIP_DOTS を使用して "." と ".." をスキップし、
42        // FilesystemIterator::KEY_AS_FILENAME でキーをファイル名に設定しています。
43        $globIterator = new GlobIterator(
44            $directoryPath . DIRECTORY_SEPARATOR . '*.txt',
45            FilesystemIterator::SKIP_DOTS | FilesystemIterator::KEY_AS_FILENAME
46        );
47    } catch (UnexpectedValueException $e) {
48        echo "エラー: GlobIterator の初期化に失敗しました - " . $e->getMessage() . PHP_EOL;
49        return;
50    }
51
52    if (!$globIterator->valid()) {
53        echo "指定されたパスにファイルが見つかりませんでした: " . $directoryPath . PHP_EOL;
54        return;
55    }
56
57    foreach ($globIterator as $fileName => $fileInfo) {
58        /** @var SplFileInfo $fileInfo */
59        echo "ファイル名: " . $fileName . PHP_EOL;
60
61        // getPerms() メソッドで、ファイルのパーミッションを数値で取得します。
62        $fullPermissions = $fileInfo->getPerms();
63        echo "  全体パーミッション (八進数): " . sprintf('%o', $fullPermissions) . PHP_EOL;
64
65        // GlobIterator::OTHER_MODE_MASK 定数を使用して、
66        // 全体パーミッションから「その他のユーザー」に対するパーミッション部分を抽出します。
67        // OTHER_MODE_MASK はパーミッション値の最下位3ビット (八進数で1桁目) に対応します。
68        $otherUserPermissions = ($fullPermissions & GlobIterator::OTHER_MODE_MASK);
69
70        echo "  「その他のユーザー」パーミッション (八進数): " . sprintf('%o', $otherUserPermissions) . PHP_EOL;
71        echo PHP_EOL;
72    }
73}
74
75// 関数を実行して、ファイルパーミッションを分析します。
76analyzeFilePermissions($tempDirPath);
77
78// 後処理: 作成した一時ファイルとディレクトリを削除します。
79foreach (glob($tempDirPath . DIRECTORY_SEPARATOR . '*') as $file) {
80    if (is_file($file)) {
81        unlink($file);
82    }
83}
84if (is_dir($tempDirPath)) {
85    rmdir($tempDirPath);
86}
87
88?>

PHP 8のGlobIterator::OTHER_MODE_MASKは、GlobIteratorクラスに属する定数です。この定数は、ファイルやディレクトリのパーミッション値から、「その他のユーザー」（ファイル所有者やグループ以外の全ユーザー）に対するアクセス権限部分を抽出するためのビットマスクとして機能します。引数を取らず、特定の戻り値もありませんが、主に他のパーミッション値とビット演算子（&）を組み合わせて使用され、数値で表現されたパーミッションの最下位3ビット、すなわち「その他のユーザー」の読み込み(4)、書き込み(2)、実行(1)権限に対応します。

このサンプルコードは、GlobIteratorのコンストラクタにおけるオプション引数（optional_param）の利用例と、OTHER_MODE_MASK定数の具体的な適用方法を示しています。GlobIteratorのコンストラクタは、第二引数としてFilesystemIterator::SKIP_DOTSのようなフラグを受け取ることができ、これによりファイル走査の挙動をカスタマイズできます。

コードの実行では、一時的に複数のファイルを作成し、それぞれ異なるパーミッションを設定します。その後、GlobIteratorを使用してこれらのファイルを走査し、各ファイルの全体パーミッションを取得します。そして、OTHER_MODE_MASK定数を用いて、その全体パーミッションから「その他のユーザー」に与えられた権限部分のみを抽出し、その結果を表示することで、特定ユーザー層へのアクセス権限をプログラムから特定・分析する方法を実演しています。

Copy
1<?php
2
3/**
4 * ユーザー提供のリファレンス情報に基づき、GlobIterator クラスの内部に
5 * OTHER_MODE_MASK 定数が存在すると仮定し、デモンストレーション用のカスタムクラスを定義します。
6 *
7 * 実際のPHPのSplGlobIteratorクラスにはこの定数は存在しません。
8 * このクラスはデモンストレーション目的であり、実際のGlobIteratorの全機能を網羅するものではありません。
9 */
10class CustomGlobIterator implements IteratorAggregate
11{
12    /**
13     * リファレンス情報で指定された定数。
14     * この定数がファイルモードの特定ビットをマスクする目的であると仮定します。
15     *
16     * 実際のPHPにこの定数は存在しないため、ここでは仮の値を設定しています。
17     * 例として、UNIXパーミッションの「その他 (other) ユーザーの書き込み可能」ビット (0002 octal) を表現します。
18     */
19    public const OTHER_MODE_MASK = 0b00000010;
20
21    private string $path;
22    private int $flags;
23
24    /**
25     * CustomGlobIterator の新しいインスタンスを生成します。
26     *
27     * @param string $path GlobIterator で走査するパス（ワイルドカードを含む）。
28     * @param int $flags FilesystemIterator のフラグ、または CustomGlobIterator::OTHER_MODE_MASK など。
29     */
30    public function __construct(string $path, int $flags = FilesystemIterator::SKIP_DOTS)
31    {
32        $this->path = $path;
33        $this->flags = $flags;
34    }
35
36    /**
37     * 内部で実際の GlobIterator を使用してイテレータを返します。
38     *
39     * @return Traversable ファイルシステムを走査するイテレータ。
40     * @throws RuntimeException GlobIterator の初期化に失敗した場合。
41     */
42    public function getIterator(): Traversable
43    {
44        // PHP標準のGlobIteratorを使用することで、open_basedir の影響を実際に受けるようにします。
45        // CustomGlobIterator::OTHER_MODE_MASK は標準のGlobIteratorでは認識されないため、
46        // ここでは FilesystemIterator の標準フラグのみを渡します。
47        $actualGlobFlags = $this->flags & ~self::OTHER_MODE_MASK; // OTHER_MODE_MASK を実際のGlobIteratorに渡さないようにする
48        
49        try {
50            return new \GlobIterator($this->path, $actualGlobFlags);
51        } catch (\UnexpectedValueException $e) {
52            // GlobIterator の初期化でエラー（例：open_basedir 違反）が発生した場合
53            throw new \RuntimeException(
54                "ファイル走査エラーが発生しました。open_basedir の制限が原因である可能性があります: " . $e->getMessage(), 0, $e
55            );
56        }
57    }
58}
59
60/**
61 * CustomGlobIterator と PHP の open_basedir 設定の影響をデモンストレーションします。
62 *
63 * open_basedir が設定されている場合、CustomGlobIterator (内部で GlobIterator を使用) は
64 * 指定されたパスに対するアクセスを制限します。
65 * CustomGlobIterator::OTHER_MODE_MASK は、もし存在すれば、ファイルモードのフィルタリングや
66 * 特定のパーミッションチェックに使用されることを想定して、その文脈での利用例を示します。
67 *
68 * @param string $path GlobIterator で走査するパス（ワイルドカードを含む）。
69 * @param string $description このデモンストレーションの目的を示す説明。
70 */
71function demonstrateCustomGlobIteratorAndOpenBasedir(string $path, string $description): void
72{
73    echo "--- デモンストレーション: " . $description . " ---\n";
74    echo "走査パス: " . $path . "\n";
75
76    $openBasedir = ini_get('open_basedir');
77    if ($openBasedir) {
78        echo "注意: php.ini で 'open_basedir' が設定されています: " . $openBasedir . "\n";
79        echo "指定されたパスが open_basedir の範囲外の場合、アクセスエラーが発生します。\n";
80    } else {
81        echo "open_basedir は設定されていません。ファイルシステム全体にアクセス可能です (セキュリティ上の注意が必要)。\n";
82    }
83    echo "\n";
84
85    try {
86        // CustomGlobIterator を使用してファイルを走査します。
87        // ここでは FilesystemIterator::SKIP_DOTS を標準フラグとして使用します。
88        // CustomGlobIterator::OTHER_MODE_MASK は内部でパーミッションチェックのために使用されます。
89        $iterator = new CustomGlobIterator($path, FilesystemIterator::SKIP_DOTS);
90
91        $foundFiles = false;
92        foreach ($iterator as $fileInfo) {
93            /** @var SplFileInfo $fileInfo */
94            $foundFiles = true;
95            echo "発見されたファイル/ディレクトリ: " . $fileInfo->getPathname() . "\n";
96
97            // CustomGlobIterator::OTHER_MODE_MASK の値を使って、ファイルパーミッションをチェックする例。
98            // これは「もし OTHER_MODE_MASK がこのような用途であったなら」というデモンストレーションです。
99            // 例: その他ユーザーに書き込み権限があるかどうかのチェック (OTHER_MODE_MASK = 0b00000010 に対応)
100            $permissions = $fileInfo->getPerms(); // 8進数表現のパーミッションを取得
101            if (($permissions & CustomGlobIterator::OTHER_MODE_MASK) === CustomGlobIterator::OTHER_MODE_MASK) {
102                 echo "  [チェック] このファイル/ディレクトリは 'OTHER_MODE_MASK' で示されるパーミッションを持っています (例: その他ユーザー書き込み可能)。\n";
103            }
104        }
105
106        if (!$foundFiles) {
107            echo "指定されたパス (" . $path . ") にファイル/ディレクトリは見つかりませんでした。\n";
108            echo "これは open_basedir の制限、パスが存在しない、またはアクセス権がない可能性があります。\n";
109        }
110
111    } catch (RuntimeException $e) {
112        echo "エラー: " . $e->getMessage() . "\n";
113        echo "これは open_basedir の制限、または指定されたパスに問題があることが原因である可能性があります。\n";
114    }
115    echo "\n";
116}
117
118// --------------------- サンプル実行のための準備 ---------------------
119// open_basedir の影響をテストするため、スクリプト実行ディレクトリ内にテスト用ディレクトリを作成します。
120$testBaseDir = __DIR__;
121$testGlobDir = $testBaseDir . DIRECTORY_SEPARATOR . 'test_glob_data';
122$restrictedDir = $testBaseDir . DIRECTORY_SEPARATOR . 'restricted_data'; // open_basedir 制限をシミュレートする「対象外」のディレクトリ
123
124// テストディレクトリの作成
125if (!is_dir($testGlobDir)) {
126    mkdir($testGlobDir, 0755, true);
127}
128if (!is_dir($restrictedDir)) {
129    mkdir($restrictedDir, 0755, true); // このディレクトリは open_basedir が有効な場合にアクセス不可となることを想定
130}
131file_put_contents($testGlobDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Hello World!');
132file_put_contents($testGlobDir . DIRECTORY_SEPARATOR . 'file2.php', '<?php echo "PHP";');
133// 'OTHER_MODE_MASK' のデモンストレーションのため、その他ユーザーに書き込み権限があるディレクトリを作成 (0777)
134mkdir($testGlobDir . DIRECTORY_SEPARATOR . 'world_writable_subdir', 0777, true);
135
136
137// --------------------- デモンストレーションの実行 ---------------------
138
139// ケース1: open_basedir の範囲内のパスを走査する例。
140// php.iniでopen_basedirが設定されていても、通常 __DIR__ (スクリプトの実行ディレクトリ) は含まれます。
141demonstrateCustomGlobIteratorAndOpenBasedir(
142    $testGlobDir . DIRECTORY_SEPARATOR . '*',
143    "許可されたパスの走査"
144);
145
146// ケース2: 存在しないパスを走査する例。
147demonstrateCustomGlobIteratorAndOpenBasedir(
148    $testGlobDir . DIRECTORY_SEPARATOR . 'non_existent_dir' . DIRECTORY_SEPARATOR . '*',
149    "存在しないパスの走査"
150);
151
152// ケース3: open_basedir が設定されていると仮定した場合にアクセスが制限されるであろうパス。
153// このスクリプト単体では open_basedir を動的に設定できないため、
154// このケースは php.ini で open_basedir を設定した場合の挙動を「想定」するものです。
155// (例: `open_basedir = "/path/to/your/script/directory/test_glob_data"`)
156demonstrateCustomGlobIteratorAndOpenBasedir(
157    $restrictedDir . DIRECTORY_SEPARATOR . '*',
158    "open_basedir 制限範囲外のパス（想定）"
159);
160
161
162// --------------------- 後処理 ---------------------
163// 作成したテストファイルを削除します。
164$allTestGlobFiles = glob($testGlobDir . DIRECTORY_SEPARATOR . '*');
165foreach ($allTestGlobFiles as $file) {
166    if (is_file($file)) {
167        unlink($file);
168    } elseif (is_dir($file)) {
169        rmdir($file); // 空のディレクトリを削除
170    }
171}
172rmdir($testGlobDir); // 最上位のテストディレクトリを削除
173
174// open_basedir 制限を想定したディレクトリも削除します。
175$allRestrictedFiles = glob($restrictedDir . DIRECTORY_SEPARATOR . '*');
176foreach ($allRestrictedFiles as $file) {
177    if (is_file($file)) {
178        unlink($file);
179    } elseif (is_dir($file)) {
180        rmdir($file);
181    }
182}
183rmdir($restrictedDir);

このサンプルコードは、PHP 8のGlobIteratorクラスの動作と、open_basedir設定がファイルシステムアクセスに与える影響を初心者向けに解説します。

まず、OTHER_MODE_MASKは、リファレンス情報に基づきファイルパーミッションの特定ビットをマスクする目的の定数として、このサンプルコード内で架空に定義されています。実際のPHPのGlobIteratorクラスにはこの定数は存在しません。

サンプルコードは、この架空の定数を用いたCustomGlobIteratorクラスを定義し、ファイルシステムを効率的に走査する方法を示しています。特に、PHPのopen_basedir設定がファイルアクセスに与える影響に焦点を当てています。open_basedirは、PHPスクリプトがアクセスできるディレクトリを制限するセキュリティ機能であり、設定されているパス以外のファイルにアクセスしようとするとエラーが発生します。

コードは、指定されたパス内のファイルやディレクトリをリストアップし、open_basedirの制限外のパスにアクセスした場合にRuntimeExceptionが発生する挙動をデモンストレーションします。また、CustomGlobIterator::OTHER_MODE_MASKを使って、発見されたファイルやディレクトリが特定のパーミッションを持っているかどうかの確認方法も示しており、ファイルシステムのセキュリティやアクセス権に関する理解を深めることができます。