【PHP8.x】RecursiveDirectoryIterator::isExecutable()メソッドの使い方

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとそのサブディレクトリ内の各要素（ファイル/ディレクトリ）の
5 * 実行可能性をチェックし、結果を表示します。
6 *
7 * この関数は、テスト用に一時的なディレクトリとファイルを作成し、
8 * その後 RecursiveDirectoryIterator::isExecutable() メソッドを使用して
9 * 各要素の実行可能性を確認します。
10 * 実行後、作成した一時ファイルとディレクトリは削除されます。
11 *
12 * システムエンジニアを目指す初心者向けに、PHPのファイルシステム操作と
13 * イテレータの使用方法を示す簡潔な例です。
14 */
15function checkDirectoryExecutionStatus(): void
16{
17    // 1. テスト用のディレクトリとファイルを作成
18    $testDir = 'temp_executable_check_dir';
19    if (!file_exists($testDir)) {
20        mkdir($testDir, 0755, true); // ディレクトリが存在しない場合は作成
21    }
22
23    // 実行可能なシェルスクリプトファイルを作成
24    $executableScript = $testDir . '/my_script.sh';
25    file_put_contents($executableScript, '#!/bin/bash' . PHP_EOL . 'echo "This is an executable script."');
26    // ファイルを実行可能にするパーミッションを設定 (Unix系OS向け)
27    // Windows環境では、isExecutable() メソッドはファイルの拡張子や関連付けに基づいて判断するため、
28    // このchmod設定に関わらず常にfalseを返すなど、異なる挙動を示すことがあります。
29    chmod($executableScript, 0755); // rwxr-xr-x (所有者は読み書き実行、グループとその他は読み書き実行)
30
31    // 実行不可なテキストファイルを作成
32    $textFile = $testDir . '/document.txt';
33    file_put_contents($textFile, 'This is a regular text document.');
34    chmod($textFile, 0644); // rw-r--r-- (所有者は読み書き、グループとその他は読み取りのみ)
35
36    // サブディレクトリを作成
37    $subDir = $testDir . '/sub_folder';
38    if (!file_exists($subDir)) {
39        mkdir($subDir, 0755); // ディレクトリが存在しない場合は作成
40    }
41    // サブディレクトリ内の実行不可なPHPファイル
42    $phpFile = $subDir . '/app.php';
43    file_put_contents($phpFile, '<?php echo "Hello from PHP!";');
44    chmod($phpFile, 0644);
45
46    echo "--- ディレクトリ構造と実行可能性の確認 ({$testDir}) ---\n";
47
48    try {
49        // 2. RecursiveDirectoryIterator を使用してディレクトリを再帰的に走査
50        // RecursiveDirectoryIterator::SKIP_DOTS: . と .. ディレクトリをスキップします。
51        // RecursiveIteratorIterator::SELF_FIRST: 親ディレクトリ自身を処理し、次にその子要素を処理する順序です。
52        $iterator = new RecursiveIteratorIterator(
53            new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
54            RecursiveIteratorIterator::SELF_FIRST
55        );
56
57        foreach ($iterator as $path => $fileInfo) {
58            // 現在の要素がディレクトリかファイルかを判断
59            $type = $fileInfo->isDir() ? 'ディレクトリ' : 'ファイル';
60            // 絶対パスから基準ディレクトリを削除して相対パスを取得
61            // realpath() を使用してシンボリックリンクなどを解決し、安全にパスを比較します。
62            $relativePath = str_replace(realpath($testDir) . DIRECTORY_SEPARATOR, '', $fileInfo->getRealPath());
63
64            // RecursiveDirectoryIterator の要素 (SplFileInfoオブジェクト) の isExecutable() メソッドを呼び出し
65            // このメソッドは、ファイルが存在し、かつ実行可能である場合に true を返します。
66            $isExecutable = $fileInfo->isExecutable();
67
68            // 結果を表示
69            echo sprintf(
70                "- %s: %s (ファイル名: %s) - 実行可能: %s\n",
71                $type,
72                $relativePath,
73                $fileInfo->getFilename(), // 現在のファイルまたはディレクトリの名前
74                $isExecutable ? 'はい' : 'いいえ'
75            );
76        }
77    } catch (RuntimeException $e) {
78        // ディレクトリが見つからない、またはアクセス権がない場合の例外処理
79        echo "エラー: ディレクトリ処理中に問題が発生しました: " . $e->getMessage() . "\n";
80    } finally {
81        // 3. テスト用のディレクトリとファイルをクリーンアップ
82        echo "\n--- テストディレクトリ ({$testDir}) のクリーンアップを開始 ---\n";
83        if (file_exists($testDir)) {
84            // RecursiveIteratorIterator::CHILD_FIRST を使用して、子要素から削除することで安全にクリーンアップします。
85            $files = new RecursiveIteratorIterator(
86                new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
87                RecursiveIteratorIterator::CHILD_FIRST
88            );
89            foreach ($files as $fileinfo) {
90                $filePath = $fileinfo->getRealPath();
91                if ($fileinfo->isDir()) {
92                    // ディレクトリは中身が空になってから削除
93                    if (!rmdir($filePath)) {
94                        error_log("警告: ディレクトリ {$filePath} の削除に失敗しました。\n");
95                    }
96                } else {
97                    // ファイルは直接削除
98                    if (!unlink($filePath)) {
99                        error_log("警告: ファイル {$filePath} の削除に失敗しました。\n");
100                    }
101                }
102            }
103            // 最後にルートディレクトリを削除
104            if (!rmdir($testDir)) {
105                error_log("警告: ルートディレクトリ {$testDir} の削除に失敗しました。\n");
106            }
107        }
108        echo "--- テストディレクトリのクリーンアップ完了 ---\n";
109    }
110}
111
112// 関数を実行
113checkDirectoryExecutionStatus();

このPHPのサンプルコードは、ファイルやディレクトリが実行可能であるかを調べるRecursiveDirectoryIterator::isExecutable()メソッドの使い方を、システムエンジニアを目指す初心者向けに示しています。RecursiveDirectoryIteratorクラスは、指定されたディレクトリとその中のサブディレクトリやファイルを一つずつ走査する際に利用され、走査される各要素はSplFileInfoオブジェクトとして扱われます。

isExecutable()メソッドは、このSplFileInfoオブジェクトが持つメソッドの一つで、引数は不要です。対象のファイルまたはディレクトリが存在し、かつ実行権限が設定されている場合にtrueを、それ以外の場合はfalseをブール値で返します。

サンプルコードでは、まずテスト用の一時ディレクトリと、実行可能なシェルスクリプトや実行不可なテキストファイルなどを作成し、それぞれのパーミッションを設定します。次に、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせて、作成したディレクトリ構造を再帰的に走査します。走査中に各要素に対してisExecutable()メソッドを呼び出し、その結果（実行可能か否か）を表示しています。なお、chmodによる実行権限の設定はUnix系OSで直接的な効果がありますが、Windows環境ではファイルの拡張子や関連付けによって挙動が異なる点に留意してください。処理の最後には、作成したテストファイルを確実に削除し、クリーンアップを行っています。このコードは、PHPでのファイルシステム操作とイテレータの基本を理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリを再帰的に走査し、各ファイルやディレクトリの実行可能性をチェックします。
5 * RecursiveDirectoryIterator の isExecutable メソッドを利用します。
6 *
7 * @param string $directoryPath チェックするディレクトリのパス
8 * @return void
9 */
10function checkDirectoryExecutabilityRecursive(string $directoryPath): void
11{
12    echo "--- Checking executability in '{$directoryPath}' recursively ---\n";
13
14    try {
15        // RecursiveDirectoryIterator をインスタンス化します。
16        // これにより、指定されたディレクトリ内のファイルやサブディレクトリを反復処理できるようになります。
17        // RecursiveDirectoryIterator は SplFileInfo クラスを継承しており、
18        // そのため isExecutable() メソッドを直接呼び出すことができます。
19        $directoryIterator = new RecursiveDirectoryIterator($directoryPath, RecursiveDirectoryIterator::SKIP_DOTS);
20
21        // RecursiveIteratorIterator を使用して、ディレクトリとそのサブディレクトリ内の
22        // すべての要素を再帰的に走査します。
23        // foreach ループで取得される $item は RecursiveDirectoryIterator のインスタンスです。
24        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
25
26        foreach ($recursiveIterator as $item) {
27            // $item は RecursiveDirectoryIterator のインスタンスなので、
28            // その isExecutable() メソッドを直接呼び出すことができます。
29            // このメソッドは、現在の要素（ファイルまたはディレクトリ）が
30            // 実行可能パーミッションを持っている場合に true を返します。
31            // 例: シェルスクリプト (.sh)、実行パーミッションを持つPHPスクリプトなど。
32            if ($item->isExecutable()) {
33                echo "[X] Executable: " . $item->getPathname() . "\n";
34            } else {
35                echo "[ ] Not Executable: " . $item->getPathname() . "\n";
36            }
37        }
38    } catch (UnexpectedValueException $e) {
39        // 指定されたパスが存在しない、またはディレクトリでない場合にエラーを捕捉します。
40        echo "Error: Could not access directory '{$directoryPath}'. " . $e->getMessage() . "\n";
41    } catch (RuntimeException $e) {
42        // その他のランタイムエラーを捕捉します。
43        echo "Runtime Error: " . $e->getMessage() . "\n";
44    }
45
46    echo "------------------------------------------------------\n";
47}
48
49// サンプルとして、スクリプトが実行されている現在のディレクトリをチェックします。
50// テストのために、このディレクトリ内に実行パーミッションを持つファイル
51// (例: 'myscript.sh' を 'touch myscript.sh && chmod +x myscript.sh' で作成) や、
52// 実行パーミッションを持たないファイルを作成して試してみてください。
53checkDirectoryExecutabilityRecursive('.');
54
55?>

このPHPサンプルコードは、指定されたディレクトリとその中のすべてのサブディレクトリにあるファイルやフォルダが「実行可能」であるかどうかを再帰的に確認する方法を示しています。

まず、RecursiveDirectoryIteratorクラスを使用して、対象のディレクトリを反復処理できるオブジェクトを作成します。このオブジェクトは、さらにRecursiveIteratorIteratorと組み合わせることで、ディレクトリ構造全体を深く探索できます。

それぞれのファイルやフォルダについて、RecursiveDirectoryIteratorオブジェクトが持つisExecutable()メソッドを呼び出します。このメソッドは引数を一切取らず、そのファイルやフォルダに実行パーミッションが設定されているかどうかをtrue（実行可能）またはfalse（実行不可）という真偽値で返します。例えば、Linux環境でのシェルスクリプトや、特定のパーミッションが与えられたPHPスクリプトなどが実行可能と判定されます。

コードでは、このisExecutable()メソッドの結果に基づいて、「[X] Executable」または「[ ] Not Executable」というメッセージと共に、そのファイルやフォルダのパスを表示しています。これにより、どの要素が実行可能権限を持っているか一目で確認できます。また、ディレクトリが存在しない場合などのエラーを適切に処理するために、try-catchブロックも使用されています。この機能は、システムのセキュリティ監査やパーミッション設定の確認に役立ちます。