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

Copy
1<?php
2
3/**
4 * PharData::OTHER_MODE_MASK を使用して、Pharアーカイブ内のファイルの
5 * 「その他」ユーザーのパーミッションをオプションで調整するサンプルコード。
6 *
7 * キーワード "optional_param" は、特定の条件が満たされた場合に
8 * オプションでパーミッション調整処理を行うことを示唆しています。
9 */
10function managePharFilePermissions(): void
11{
12    $pharPath = __DIR__ . '/example.phar';
13    $filePath = __DIR__ . '/test_file.txt';
14
15    // 1. 一時ファイルを作成し、パーミッションを設定
16    // 例として0666 (rw-rw-rw-) を設定し、「その他」ユーザーに書き込み権限を含めます。
17    // これにより、後続のオプション処理が実行されることを示します。
18    file_put_contents($filePath, "This is a test file content.");
19    chmod($filePath, 0666); // rw-rw-rw-
20
21    echo "--- 初期設定 ---\n";
22    echo "作成したファイル: " . $filePath . "\n";
23    // fileperms() の結果からパーミッション部分 (下位9ビット) のみを抽出し、8進数で表示
24    echo "初期パーミッション: " . decoct(fileperms($filePath) & 0777) . "\n\n";
25
26    try {
27        // 2. PharDataアーカイブを作成 (存在すれば上書き)
28        if (file_exists($pharPath)) {
29            unlink($pharPath); // 既存のPharアーカイブを削除
30        }
31        $phar = new PharData($pharPath);
32        
33        // 3. ファイルをPharアーカイブに追加 (元のパーミッションが引き継がれます)
34        // addFileの第2引数 ($localName) はオプション引数です。
35        $phar->addFile($filePath, 'my_file_in_phar.txt');
36
37        // Pharアーカイブの変更を確定させるためにsetStubを呼び出します。
38        // これはPharアーカイブが実行可能になるための設定ですが、変更を永続化する目的でも有効です。
39        $phar->setStub($phar->createDefaultStub('my_file_in_phar.txt'));
40        
41        echo "--- Pharアーカイブ内のファイル確認 ---\n";
42        // 4. アーカイブ内のファイルのPharFileInfoオブジェクトを取得
43        $fileInPhar = $phar['my_file_in_phar.txt'];
44        $initialMode = $fileInPhar->getMode();
45        echo "Phar内のファイル名: " . $fileInPhar->getFilename() . "\n";
46        echo "Phar内の初期パーミッション: " . decoct($initialMode & 0777) . "\n\n";
47
48        // 5. PharData::OTHER_MODE_MASK を使用して「その他」ユーザーのパーミッションを抽出
49        // OTHER_MODE_MASK は 7 (0o007) に相当し、「その他」ユーザーのrwxビットを抽出します。
50        $otherPermissions = $initialMode & PharData::OTHER_MODE_MASK;
51        echo "「その他」ユーザーの初期パーミッション (数値): " . decoct($otherPermissions) . "\n";
52
53        // 6. オプションのパーミッション調整ロジック
54        // もし「その他」ユーザーに書き込み権限 (0o002) があれば、それを削除します。
55        $otherWriteBit = 0o002; // S_IWOTH (「その他」ユーザーの書き込み権限) に相当
56        $hasOtherWritePermission = ($otherPermissions & $otherWriteBit) === $otherWriteBit;
57
58        if ($hasOtherWritePermission) {
59            echo "--- オプションのパーミッション調整 ---\n";
60            echo "「その他」ユーザーに書き込み権限 (0o002) があるため、削除します。\n";
61
62            // 新しいパーミッションを計算: 元のパーミッションから書き込み権限ビットを取り除く
63            $newMode = $initialMode & (~$otherWriteBit);
64
65            // PharFileInfo::chmod() メソッドでパーミッションを更新
66            $fileInPhar->chmod($newMode);
67            
68            // 更新後のパーミッションを確認
69            $updatedMode = $fileInPhar->getMode();
70            echo "Phar内の更新後パーミッション: " . decoct($updatedMode & 0777) . "\n\n";
71        } else {
72            echo "--- オプションのパーミッション調整 ---\n";
73            echo "「その他」ユーザーに書き込み権限がないため、調整は行いません。\n\n";
74        }
75
76    } catch (Exception $e) {
77        echo "エラーが発生しました: " . $e->getMessage() . "\n";
78    } finally {
79        // 後処理: 一時ファイルとPharアーカイブの削除
80        if (file_exists($filePath)) {
81            unlink($filePath);
82        }
83        if (file_exists($pharPath)) {
84            unlink($pharPath);
85        }
86        // PharDataオブジェクトが圧縮されたアーカイブを作成した場合に備えて、関連ファイルも削除
87        if (file_exists($pharPath . '.gz')) {
88            unlink($pharPath . '.gz');
89        }
90        if (file_exists($pharPath . '.bz2')) {
91            unlink($pharPath . '.bz2');
92        }
93    }
94}
95
96// 関数を実行
97managePharFilePermissions();

PharData::OTHER_MODE_MASK は、PHPのPhar拡張機能で使用される定数です。これは、Pharアーカイブ内のファイルのパーミッション情報から、「その他」のユーザー（ファイルの所有者やそのグループに属さないユーザー）が持つアクセス権限（読み取り、書き込み、実行）の部分を正確に抽出するための数値マスクを提供します。この定数自体は引数を取りませんが、ファイルのパーミッション値を操作する際に、抽出された権限を表す整数値（int）として利用されます。

サンプルコードでは、Pharアーカイブ内にファイルを追加した後、そのファイルの初期パーミッションを取得しています。そして、PharData::OTHER_MODE_MASK を論理積演算子（&）と組み合わせて使用し、「その他」ユーザーのパーミッション部分だけを抽出しています。キーワード「optional_param」が示す通り、抽出したパーミッションに特定の条件（例：書き込み権限の有無）が合致した場合にのみ、オプションとしてそのパーミッションを調整する処理（この場合は書き込み権限の削除）を実行する様子が示されています。これにより、アーカイブ内のファイルに対する細やかな権限管理が可能になることを理解できます。

Copy
1<?php
2
3/**
4 * PharData アーカイブを作成し、その中のファイルにパーミッションを設定するサンプルコードです。
5 * open_basedir の設定も確認し、PharData::OTHER_MODE_MASK 定数の使用例を示します。
6 *
7 * open_basedir はPHPのセキュリティ設定の一つで、PHPスクリプトがアクセスできるファイルシステムのパスを制限します。
8 * Pharアーカイブの作成や操作時に、この制限に抵触しないよう注意が必要です。
9 * このサンプルコードは、システムの open_basedir 設定の影響を受ける可能性があるため、
10 * 環境によってはエラーが発生することがあります。
11 */
12function createPharArchiveWithSpecificPermissions(): void
13{
14    // open_basedir の現在の設定を表示します。
15    // Pharアーカイブの作成パスもこの制限の影響を受ける可能性があるため、確認することが重要です。
16    $openBasedir = ini_get('open_basedir');
17    echo "現在の open_basedir 設定: " . ($openBasedir ?: "設定なし (無効)") . PHP_EOL;
18    echo "---------------------------------------------------" . PHP_EOL;
19
20    $archiveName = 'my_sample_archive.tar';
21    $filePathInArchive = 'data/important_document.txt';
22    $fileContent = 'これはアーカイブ内の重要なドキュメントのコンテンツです。';
23    $archivePath = __DIR__ . '/' . $archiveName; // アーカイブを現在のスクリプトと同じディレクトリに作成
24
25    // テスト用に、もし既存のアーカイブがあれば削除します。
26    if (file_exists($archivePath)) {
27        unlink($archivePath);
28        echo "既存のアーカイブ '{$archiveName}' を削除しました。" . PHP_EOL;
29    }
30
31    $tempFilePath = __DIR__ . '/temp_source_file.txt'; // アーカイブに追加するための一時ファイル
32    
33    try {
34        // アーカイブに追加する一時ファイルを作成します。
35        // この一時ファイルの作成も open_basedir の制限の影響を受けます。
36        file_put_contents($tempFilePath, $fileContent);
37        echo "一時ファイル '{$tempFilePath}' を作成しました。" . PHP_EOL;
38
39        // PharData オブジェクトを作成します（ここではtar形式を使用）。
40        // アーカイブファイルは open_basedir の制限内で作成される必要があります。
41        $phar = new PharData($archivePath);
42
43        // ファイルをアーカイブに追加します。
44        // PharData::addFile() にはパーミッションを直接指定する引数がないため、
45        // まずファイルを追加し、後から setFilePermissions() で設定します。
46        $phar->addFile($tempFilePath, $filePathInArchive);
47        echo "ファイル '{$filePathInArchive}' をアーカイブに追加しました。" . PHP_EOL;
48
49        // アーカイブ内のファイルのパーミッションを設定します。
50        // PharData::OTHER_MODE_MASK 定数を使用して、「その他」のユーザーの権限を調整する例です。
51        // OTHER_MODE_MASK は 0007 (8進数) で、その他のユーザーの全ての権限ビットを表します。
52        // 例として、所有者(rw-)、グループ(rw-)、その他(r--) のパーミッション (0664) を設定します。
53        // (PharData::OTHER_MODE_MASK & 0004) は、0007 & 0004 = 0004 となり、
54        // 「その他」のユーザーに読み取り権限 (r) のみを与えるビットマスクを生成します。
55        $permissions = 0660 | (PharData::OTHER_MODE_MASK & 0004); // 結果は 0664 (rw-rw-r--)
56        $phar->setFilePermissions($filePathInArchive, $permissions);
57        echo "アーカイブ内のファイル '{$filePathInArchive}' のパーミッションを " . decoct($permissions) . " (8進数) に設定しました。" . PHP_EOL;
58
59        echo "PharData アーカイブ '{$archiveName}' が正常に作成されました。" . PHP_EOL;
60
61        // 作成されたアーカイブの内容とパーミッションを確認します。
62        echo PHP_EOL . "--- 作成されたアーカイブの内容 ---" . PHP_EOL;
63        foreach ($phar as $entryName => $fileInfo) {
64            /** @var PharFileInfo $fileInfo */
65            echo "  - " . $entryName . " (パーミッション: " . decoct($fileInfo->getPerms()) . ")" . PHP_EOL;
66        }
67
68    } catch (Exception $e) {
69        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
70        // open_basedir 関連のエラーの場合、その可能性を示唆します。
71        if (str_contains($e->getMessage(), 'open_basedir')) {
72            echo "ヒント: このエラーは open_basedir の制限によるものかもしれません。" . PHP_EOL;
73            echo "  アーカイブの作成パスや一時ファイルのパスが、PHPが許可するディレクトリ内にあることを確認してください。" . PHP_EOL;
74        }
75    } finally {
76        // クリーンアップ処理を行います。
77        // 一時ファイルを削除します。
78        if (file_exists($tempFilePath)) {
79            unlink($tempFilePath);
80            echo "一時ファイル '{$tempFilePath}' を削除しました。" . PHP_EOL;
81        }
82        // 作成されたアーカイブファイルは、動作確認のために残しておくことが多いですが、
83        // 完全にクリーンアップしたい場合は、以下のコメントを解除してください。
84        /*
85        if (isset($phar) && file_exists($archivePath)) {
86            // Pharオブジェクトがファイルにロックをかけることがあるため、
87            // アンリンクする前にオブジェクトを破棄することが推奨されます。
88            $phar = null; // オブジェクトを解放
89            unlink($archivePath);
90            echo "アーカイブ '{$archiveName}' を削除しました。" . PHP_EOL;
91        }
92        */
93    }
94}
95
96// サンプル関数を実行します。
97createPharArchiveWithSpecificPermissions();
98

このサンプルコードは、PHPのPharDataクラスを用いてアーカイブを作成し、その中のファイルのパーミッションを設定する方法を示します。特に、PharData::OTHER_MODE_MASK定数の使用例が中心です。この定数は、アーカイブ内のファイルに対する「その他」のユーザーのパーミッションビットマスクを表す整数（int）で、引数は取りません。コードでは、setFilePermissionsメソッドでこの定数を他のパーミッション値と組み合わせて、「その他」のユーザーに読み取り権限のみ（例えば0664のような形）を付与する方法を紹介しています。

また、php open_basedir設定の確認も行っています。open_basedirはPHPスクリプトがアクセスできるファイルパスを制限するセキュリティ設定であり、アーカイブや一時ファイルの作成パスがこの制限に抵触しないよう、その影響を考慮する重要性を示唆しています。アーカイブ作成からファイル追加、パーミッション設定、エラー時のopen_basedir関連のヒント表示、そして一時ファイルのクリーンアップまで、一連の処理を確認できます。