【PHP8.x】POSIX_F_OK定数の使い方

Copy
1<?php
2
3/**
4 * POSIX_F_OK 定数を使用してファイルの存在を確認する関数。
5 *
6 * この関数は posix_access() と POSIX_F_OK 定数を組み合わせて、
7 * 指定されたファイルが存在するかどうかをチェックする方法を示します。
8 * POSIX_F_OK はファイルの存在チェックのみを行います。
9 *
10 * @param string $filePath 確認するファイルのパス。
11 * @return void
12 */
13function checkFileExistencePosix(string $filePath): void
14{
15    echo "ファイル '{$filePath}' の存在を確認中...\n";
16
17    // posix_access() 関数に POSIX_F_OK 定数を指定して、ファイルの存在をチェックします。
18    // ファイルが存在する場合に true を、存在しない場合やアクセスできない場合に false を返します。
19    if (posix_access($filePath, POSIX_F_OK)) {
20        echo "ファイル '{$filePath}' は存在します。\n";
21    } else {
22        echo "ファイル '{$filePath}' は存在しないか、アクセスできませんでした。\n";
23    }
24}
25
26// --- 使用例 ---
27
28// テスト用のダミーファイルを作成します
29$testFile = 'example_posix_file.txt';
30file_put_contents($testFile, 'これはテストファイルです。');
31
32// 1. 存在するファイルの存在を確認します
33checkFileExistencePosix($testFile);
34
35// 2. 存在しないファイルの存在を確認します
36checkFileExistencePosix('non_existent_file.txt');
37
38// テスト用に作成したダミーファイルを削除します
39unlink($testFile);
40
41?>

PHPのPOSIX_F_OK定数は、システムにおけるファイルの存在を確認するために使用される特別な値です。これはPHPのPOSIX拡張機能の一部として提供されており、主にposix_access()関数と組み合わせて利用されます。

posix_access()関数は、指定されたファイルパスに対し、特定のアクセス権があるか、またはファイルが存在するかをチェックする際に使われます。その際、第二引数にPOSIX_F_OKを指定することで、単純にファイルの存在のみを確認できます。この定数自体には引数も戻り値もありませんが、posix_access()関数は、ファイルが存在し、かつアクセスが可能であればtrueを、存在しないかアクセスできない場合にfalseを返します。

提供されたサンプルコードでは、checkFileExistencePosixという関数が定義されており、この関数がposix_access()とPOSIX_F_OKを利用して、与えられたファイルパスの存在を調べます。関数には確認したいファイルのパス（文字列）を引数として渡します。ファイルが存在が確認できた場合はその旨を、できなかった場合はその旨を画面に出力します。これにより、実際に存在するファイルと存在しないファイルの両方で、どのように結果が異なるかを確認できます。

Copy
1<?php
2
3/**
4 * プロセス管理とファイル存在チェックのデモンストレーション
5 *
6 * この関数は、PHPのPOSIX拡張機能を利用して、プロセスの状態管理と
7 * ファイルの存在チェックを初心者にも分かりやすく示すサンプルです。
8 *
9 * 具体的には、PIDファイル（プロセスIDを記録するファイル）の存在を
10 * POSIX_F_OK 定数と posix_access() 関数で確認し、
11 * そのPIDに対して posix_kill() 関数でシグナルを送信する例を示します。
12 */
13function demonstratePosixFeatures(): void
14{
15    // 現在のプロセスのPID (プロセスID) を取得
16    $currentPid = posix_getpid();
17    echo "現在のプロセスID: {$currentPid}\n\n";
18
19    // PIDファイルとして一時的なファイルパスを生成
20    // 実際のアプリケーションでは、より固定的な場所を指定します。
21    $pidFilePath = sys_get_temp_dir() . '/my_php_app_test.pid';
22
23    echo "=== ファイル存在チェック (POSIX_F_OK を使用) ===\n";
24    // POSIX_F_OK 定数:
25    // これはファイルアクセスチェックのためのフラグ定数です。
26    // posix_access() 関数に渡すことで、「ファイルが存在するかどうか」をチェックするよう指示します。
27    // この定数自体には引数や戻り値はなく、posix_access() のような他の関数の引数として使用されます。
28
29    // posix_access($path, $flags):
30    // 指定されたパスのファイルに対して、引数 $flags で指定されたアクセス権があるかを確認します。
31    // ここでは POSIX_F_OK を指定し、ファイルが存在するかどうかのみをチェックします。
32    if (posix_access($pidFilePath, POSIX_F_OK)) {
33        echo "PIDファイル '{$pidFilePath}' が見つかりました。\n";
34        $existingPid = (int) @file_get_contents($pidFilePath); // @ でエラー抑制
35
36        if ($existingPid > 0) {
37            echo "既存のプロセスID: {$existingPid}\n";
38            echo "このPID ({$existingPid}) に対して、シグナル 0 (プロセス存在チェック) を送信します。\n";
39
40            // posix_kill($pid, $signal):
41            // 指定されたプロセスID ($pid) にシグナル ($signal) を送信します。
42            // シグナル 0 は特別なシグナルで、実際には何も送信せず、
43            // そのプロセスが存在し、現在のユーザーがシグナルを送信する権限を持っているかをチェックします。
44            // プロセスが存在すれば true、存在しないか権限がなければ false を返します。
45            if (posix_kill($existingPid, 0)) {
46                echo "PID {$existingPid} のプロセスは現在も実行中です。\n";
47                // 実際のシナリオでは、ここで既存プロセスを終了させるシグナル
48                // (例: SIGTERM, 値は 15) を送ることも考えられます。
49                // 例: posix_kill($existingPid, SIGTERM);
50            } else {
51                echo "PID {$existingPid} のプロセスは既に終了しているか、シグナルを送信する権限がありません。\n";
52                // 無効なPIDファイルは削除
53                unlink($pidFilePath);
54                echo "無効なPIDファイル '{$pidFilePath}' を削除しました。\n";
55            }
56        } else {
57            echo "PIDファイル '{$pidFilePath}' は見つかりましたが、有効なPIDが読み取れませんでした。\n";
58            unlink($pidFilePath);
59            echo "無効なPIDファイル '{$pidFilePath}' を削除しました。\n";
60        }
61    } else {
62        echo "PIDファイル '{$pidFilePath}' は見つかりませんでした。新しいプロセスとして起動します。\n";
63    }
64
65    echo "\n=== 新しいPIDファイルの作成/更新 ===\n";
66    // 現在のプロセスのPIDをPIDファイルに書き込む
67    // これは、このスクリプトが「新しいプロセス」として実行されたと仮定するものです。
68    if (file_put_contents($pidFilePath, $currentPid) !== false) {
69        echo "現在のPID ({$currentPid}) を '{$pidFilePath}' に書き込みました。\n";
70    } else {
71        echo "エラー: PIDファイルを '{$pidFilePath}' に書き込めませんでした。権限を確認してください。\n";
72    }
73
74    // スクリプト終了時に作成した一時PIDファイルを削除するためのフック
75    // 実際のデーモンプロセスなどでは、プロセス終了時にこの処理を行います。
76    register_shutdown_function(function () use ($pidFilePath) {
77        if (file_exists($pidFilePath)) {
78            unlink($pidFilePath);
79            echo "\n一時PIDファイル '{$pidFilePath}' をクリーンアップしました。\n";
80        }
81    });
82
83    echo "\nデモンストレーションが完了しました。\n";
84}
85
86// 関数を実行してデモンストレーションを開始
87demonstratePosixFeatures();

このコードは、PHPのPOSIX拡張機能を利用し、プロセスの状態管理とファイルの存在チェックをデモンストレーションするものです。

POSIX_F_OKは、ファイルが存在するかどうかを確認する目的でposix_access()関数に渡されるフラグ定数です。この定数自体は引数や戻り値を持たず、関数の挙動を制御するために使われます。

サンプルではまず、一時的なPIDファイルを作成し、posix_access($filepath, POSIX_F_OK)を用いてそのファイルの存在をチェックします。この関数は、指定されたパスのファイルが存在すれば真を、そうでなければ偽を返します。

ファイルが存在し、そこから有効なプロセスIDが読み取れた場合、posix_kill($pid, 0)を使ってそのプロセスが現在も実行中かを確認します。posix_kill()は指定されたプロセスIDにシグナルを送信する関数で、第一引数にプロセスID、第二引数にシグナル番号を取ります。シグナル番号に0を指定すると、実際には何もシグナルを送らずに、プロセスが存在し、シグナル送信権限があるかをチェックし、結果を真偽値で返します。

プロセスが存在しない場合や無効なPIDの場合にはファイルを削除し、新しいプロセスとして現在のプロセスIDをファイルに書き込みます。スクリプト終了時には、作成した一時PIDファイルが適切に削除されるように設定されています。