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

Copy
1<?php
2
3/**
4 * Phar::hasMetadata() メソッドの使用例を示します。
5 * このメソッドは、Pharアーカイブ全体にメタデータが設定されているかを確認します。
6 *
7 * @return void
8 */
9function demonstratePharHasMetadata(): void
10{
11    // 一時的なPharアーカイブのファイルパスを定義します。
12    // スクリプトが実行されるディレクトリに一時ファイルを作成します。
13    $pharFilePath = __DIR__ . '/my_example.phar';
14    $pharFilePathNoMeta = __DIR__ . '/my_example_no_meta.phar';
15
16    // ----------------------------------------------------
17    // メタデータを持つPharアーカイブの作成とhasMetadata()の確認
18    // ----------------------------------------------------
19    echo "--- メタデータを持つPharの確認 ---\n";
20    try {
21        // 既存のPharファイルがあれば削除し、新しいファイルを作成する準備をします。
22        // 注意: Pharファイルの書き込みには、php.iniで 'phar.readonly = 0' が設定されている必要があります。
23        if (file_exists($pharFilePath)) {
24            unlink($pharFilePath);
25        }
26
27        // Pharオブジェクトをインスタンス化し、書き込みモードで開きます。
28        // 第1引数: Pharアーカイブのパス
29        // 第2引数: フラグ (0はデフォルト)
30        // 第3引数: アーカイブの内部名（通常はファイル名と同じ）
31        $phar = new Phar($pharFilePath, 0, 'my_example.phar');
32
33        // デフォルトのスタブ（Pharのブートローダー）を設定します。
34        $phar->setStub($phar->createDefaultStub('index.php', 'index.php'));
35
36        // アーカイブにダミーファイルを追加します。
37        $phar->addFromString('index.php', '<?php echo "Hello, Phar!";');
38
39        // Pharアーカイブ全体にメタデータを設定します。
40        // メタデータは、Pharアーカイブに関する追加情報（例: バージョン、作者など）を格納するために使用できます。
41        $metadata = ['version' => '1.0.0', 'author' => 'PHPDemonstrator'];
42        $phar->setMetadata($metadata);
43
44        echo "Pharアーカイブ '{$pharFilePath}' を作成し、メタデータを設定しました。\n";
45
46        // Pharオブジェクトを破棄することで、ディスクへの書き込みを確定させます。
47        // これにより、Pharファイルが完全に作成され、読み込みモードで開けるようになります。
48        unset($phar);
49
50        // 作成したPharアーカイブを読み込みモードで開きます。
51        $pharReadOnly = new Phar($pharFilePath);
52
53        // Pharアーカイブ全体にメタデータが設定されているかを確認します。
54        // hasMetadata() は引数を取らず、bool値を返します。
55        if ($pharReadOnly->hasMetadata()) {
56            echo "結果: '{$pharFilePath}' には全体メタデータがあります。\n";
57            // メタデータの内容を確認したい場合は、getMetadata()メソッドを使用します。
58            // echo "メタデータ内容: ";
59            // var_dump($pharReadOnly->getMetadata());
60        } else {
61            echo "結果: '{$pharFilePath}' には全体メタデータがありません。\n";
62        }
63
64        unset($pharReadOnly); // Pharオブジェクトを解放します。
65
66    } catch (PharException $e) {
67        // Phar関連のエラーが発生した場合の処理。
68        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
69        // エラー発生時は、作成途中の一時ファイルを削除して終了します。
70        if (file_exists($pharFilePath)) {
71            unlink($pharFilePath);
72        }
73        return; // 関数の実行を中断
74    }
75
76    echo "\n";
77
78    // ----------------------------------------------------
79    // メタデータを持たないPharアーカイブの作成とhasMetadata()の確認
80    // ----------------------------------------------------
81    echo "--- メタデータを持たないPharの確認 ---\n";
82    try {
83        if (file_exists($pharFilePathNoMeta)) {
84            unlink($pharFilePathNoMeta);
85        }
86
87        $pharNoMeta = new Phar($pharFilePathNoMeta, 0, 'my_example_no_meta.phar');
88        $pharNoMeta->setStub($pharNoMeta->createDefaultStub('index.php', 'index.php'));
89        $pharNoMeta->addFromString('index.php', '<?php echo "Hello, Phar without metadata!";');
90
91        // このPharアーカイブにはメタデータを設定しません。
92
93        echo "Pharアーカイブ '{$pharFilePathNoMeta}' を作成しました（メタデータなし）。\n";
94
95        unset($pharNoMeta);
96
97        $pharNoMetaReadOnly = new Phar($pharFilePathNoMeta);
98
99        if ($pharNoMetaReadOnly->hasMetadata()) {
100            echo "結果: '{$pharFilePathNoMeta}' には全体メタデータがあります。\n";
101        } else {
102            echo "結果: '{$pharFilePathNoMeta}' には全体メタデータがありません。\n";
103        }
104
105        unset($pharNoMetaReadOnly);
106
107    } catch (PharException $e) {
108        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
109        if (file_exists($pharFilePathNoMeta)) {
110            unlink($pharFilePathNoMeta);
111        }
112    }
113
114
115    // ----------------------------------------------------
116    // クリーンアップ: 作成した一時ファイルを削除
117    // ----------------------------------------------------
118    echo "\n--- クリーンアップ ---\n";
119    if (file_exists($pharFilePath)) {
120        unlink($pharFilePath);
121        echo "一時ファイル '{$pharFilePath}' を削除しました。\n";
122    }
123    if (file_exists($pharFilePathNoMeta)) {
124        unlink($pharFilePathNoMeta);
125        echo "一時ファイル '{$pharFilePathNoMeta}' を削除しました。\n";
126    }
127}
128
129// 上記で定義したPhar::hasMetadata()の使用例を実行します。
130demonstratePharHasMetadata();

このサンプルコードは、PHPのPharクラスに属するhasMetadata()メソッドの利用方法を実演しています。Pharは、複数のPHPファイルや関連ファイルを一つのアーカイブファイルにまとめる機能を提供し、アプリケーションの配布などに利用されます。

Phar::hasMetadata()メソッドは、現在開いているPharアーカイブ全体に対して、追加情報である「メタデータ」が設定されているかどうかを確認するために使用されます。このメソッドは引数を一切取らず、戻り値として真偽値（bool）を返します。メタデータが設定されていればtrue、設定されていなければfalseが返されます。

コードでは、まず二種類のPharアーカイブを作成します。一つ目のmy_example.pharでは、setMetadata()メソッドを用いて意図的にバージョン情報などのメタデータを設定しています。このアーカイブに対してhasMetadata()を実行すると、メタデータが存在するためtrueが返されることを確認できます。

一方、二つ目のmy_example_no_meta.pharはメタデータを設定せずに作成します。このアーカイブに対してhasMetadata()を実行すると、メタデータが存在しないためfalseが返されます。

このように、hasMetadata()メソッドを使うことで、Pharアーカイブに付加情報が含まれているかをプログラム的に簡単に判定できることを示しています。コードの最後では、作成した一時的なPharファイルを削除し、環境をクリーンアップしています。

Copy
1<?php
2
3/**
4 * Pharアーカイブのメタデータ確認とハッシュ値検証のサンプル。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * Phar::hasMetadata() メソッドの基本的な使い方と、
8 * hash_update() 関数を使ったデータの整合性検証の考え方を示します。
9 *
10 * Pharアーカイブに格納されたメタデータに特定のデータのハッシュ値を含めることで、
11 * そのデータの改ざんがないかを確認する一例です。
12 */
13function demonstratePharMetadataAndHashVerification(): void
14{
15    // 対象となるPharアーカイブのファイル名
16    $pharFileName = 'my_application.phar';
17    // ハッシュ計算の対象となる重要なデータ（例：設定情報、コードの一部など）
18    $importantData = "This is some crucial configuration data for my application.";
19
20    // --- 1. Pharアーカイブの作成とハッシュ化されたメタデータの設定 ---
21    // このセクションは、サンプルを単体で動作させるためにPharアーカイブを準備するものです。
22    // 通常は開発プロセスで一度だけ作成されるか、ビルドスクリプトによって生成されます。
23    try {
24        // 既存のPharアーカイブとその署名ファイルを削除し、クリーンな状態から始めます。
25        if (file_exists($pharFileName)) {
26            unlink($pharFileName);
27        }
28        if (file_exists($pharFileName . '.sig')) {
29            unlink($pharFileName . '.sig');
30        }
31
32        // Pharクラスのインスタンスを作成し、新しいアーカイブを生成します。
33        // 引数: ファイル名, フラグ (0 = デフォルト), エイリアス
34        $phar = new Phar($pharFileName);
35        // アーカイブにファイルを追加します。
36        $phar->addFromString('main.php', '<?php echo "Hello from Phar application!";');
37        // デフォルトのスタブ（Pharを実行するためのコード）を設定します。
38        $phar->setStub($phar->createDefaultStub('main.php'));
39
40        // メタデータに含めるハッシュ値を計算します。
41        // hash_init(): 新しいハッシュ計算コンテキストをSHA256アルゴリズムで初期化します。
42        $hashContext = hash_init('sha256');
43        // hash_update(): 指定されたデータを既存のハッシュコンテキストに追加します。
44        // これにより、大きなデータや複数回に分けてデータをハッシュ計算に含めることができます。
45        hash_update($hashContext, $importantData); // ここでキーワード 'hash_update' を使用します。
46        // hash_final(): 現在のハッシュコンテキストの最終的なハッシュ値を計算し、取得します。
47        $dataHash = hash_final($hashContext);
48
49        // ハッシュ値を含むメタデータを連想配列として定義します。
50        $metadata = [
51            'version' => '1.0.0',
52            'data_integrity_hash' => $dataHash, // 計算したハッシュ値をメタデータに保存
53            'description' => 'A simple application with data integrity check.'
54        ];
55        // Pharアーカイブにメタデータを設定します。
56        $phar->setMetadata($metadata);
57        // Pharアーカイブへの書き込みを確定し、閉じます。
58        $phar->stopBuffering();
59        echo "Pharアーカイブ '{$pharFileName}' を作成し、ハッシュ値を含むメタデータを設定しました。\n\n";
60
61    } catch (PharException $e) {
62        // Phar関連のエラーが発生した場合の処理
63        echo "エラー: Pharアーカイブの作成中に問題が発生しました: " . $e->getMessage() . "\n";
64        return; // エラーが発生した場合は以降の処理を中断します。
65    }
66
67    // --- 2. 既存のPharアーカイブからメタデータを読み込み、ハッシュ値を検証 ---
68    try {
69        // 既存のPharアーカイブを読み込むためのPharインスタンスを作成します。
70        $phar = new Phar($pharFileName);
71
72        // Phar::hasMetadata() の利用例
73        // このメソッドは、Pharアーカイブにメタデータが設定されているかどうかを真偽値 (bool) で返します。
74        // 引数はなく、アーカイブのメタデータの有無を単純にチェックします。
75        if ($phar->hasMetadata()) {
76            echo "Pharアーカイブにはメタデータが含まれています。\n";
77            // メタデータが存在する場合、Phar::getMetadata() を使ってその内容を取得します。
78            $metadata = $phar->getMetadata();
79
80            echo "取得したメタデータ:\n";
81            print_r($metadata);
82
83            // メタデータ内に事前に保存したハッシュ値が存在するか確認します。
84            if (isset($metadata['data_integrity_hash'])) {
85                echo "\nメタデータ内に 'data_integrity_hash' が見つかりました。\n";
86                $storedHash = $metadata['data_integrity_hash'];
87
88                // データの整合性を確認するため、元のデータを使って再度ハッシュを計算します。
89                // ここでも hash_update() を使ってハッシュ計算のプロセスを示します。
90                $verificationContext = hash_init('sha256');
91                hash_update($verificationContext, $importantData); // 元のデータと同じものを使用
92                $calculatedHash = hash_final($verificationContext);
93
94                echo "メタデータに保存されていたハッシュ値: {$storedHash}\n";
95                echo "再計算されたハッシュ値: {$calculatedHash}\n";
96
97                // 保存されていたハッシュ値と再計算したハッシュ値を比較し、一致するか確認します。
98                // 一致すれば、データは改ざんされていないと判断できます。
99                if ($storedHash === $calculatedHash) {
100                    echo "-> データ整合性ハッシュは一致しました。データは安全です。\n";
101                } else {
102                    echo "-> データ整合性ハッシュが一致しません！データが改ざんされた可能性があります。\n";
103                }
104            } else {
105                echo "\nメタデータに 'data_integrity_hash' が含まれていません。\n";
106            }
107        } else {
108            echo "Pharアーカイブにはメタデータが含まれていません。\n";
109        }
110
111    } catch (PharException $e) {
112        // 既存のPharアーカイブの読み込み中にエラーが発生した場合の処理
113        echo "エラー: 既存のPharアーカイブの読み込み中に問題が発生しました: " . $e->getMessage() . "\n";
114    } finally {
115        // --- 3. クリーンアップ ---
116        // サンプルコード実行後に、テストのために作成したPharファイルとその署名ファイルを削除します。
117        if (file_exists($pharFileName)) {
118            unlink($pharFileName);
119        }
120        if (file_exists($pharFileName . '.sig')) {
121            unlink($pharFileName . '.sig');
122        }
123        echo "\nPharアーカイブと関連ファイルをクリーンアップしました。\n";
124    }
125}
126
127// サンプル関数を実行します。
128demonstratePharMetadataAndHashVerification();
129
130?>

このPHPサンプルコードは、Pharアーカイブにメタデータが含まれているかを確認するPhar::hasMetadata()メソッドと、データの整合性を検証するためのハッシュ計算に用いるhash_update()関数の基本的な使い方を示しています。

Phar::hasMetadata()メソッドは引数を取らず、対象のPharアーカイブにメタデータが設定されていればtrueを、なければfalseを真偽値（bool）として返します。これにより、アーカイブの内容を解析する前にメタデータの有無を簡単に判別できます。

hash_update()関数は、指定されたデータをハッシュ計算のコンテキストに逐次追加するために使用されます。これにより、大きなデータ全体を一度に処理するのではなく、段階的にハッシュ値を計算できます。

サンプルでは、まずPharアーカイブを作成し、重要なデータのSHA256ハッシュ値をhash_init()、hash_update()、hash_final()の流れで計算し、そのハッシュ値をアーカイブのメタデータとして保存しています。その後、既存のPharアーカイブを読み込み、Phar::hasMetadata()でメタデータの有無を確認します。メタデータが存在すれば、保存されたハッシュ値を取り出し、元のデータから再度ハッシュ値を計算し直して比較することで、データの改ざんがないかを検証する仕組みを実演しています。これは、ソフトウェアの配布においてデータの信頼性を保証する際に役立つ手法です。