【PHP8.x】posix_isatty()関数の使い方

Copy
1<?php
2
3/**
4 * 現在のシステムユーザー情報を表示します。
5 * この関数は、スクリプトがターミナルから直接実行されている場合にのみ、
6 * 現在のユーザーのPOSIX情報（ユーザー名、UID、ホームディレクトリなど）を取得し表示します。
7 *
8 * @return void
9 */
10function displayCurrentUserPosixInfo(): void
11{
12    // 標準出力 (STDOUT) がターミナルデバイスに接続されているかを確認します。
13    // posix_isatty は、ファイルディスクリプタがターミナルに関連付けられている場合に true を返します。
14    if (posix_isatty(STDOUT)) {
15        echo "スクリプトはターミナル環境で実行されています。\n";
16
17        // 現在のプロセスを実行しているユーザーのユーザーID (UID) を取得します。
18        $uid = posix_getuid();
19
20        // 取得したUIDに基づいて、パスワードエントリ情報を取得します。
21        // ここでキーワードである posix_getpwuid 関数を使用しています。
22        // この関数は、ユーザー名、ホームディレクトリ、シェルなどの詳細情報を含む配列を返します。
23        $userInfo = posix_getpwuid($uid);
24
25        if ($userInfo !== false) {
26            echo "--- 現在のユーザー情報 ---\n";
27            echo "  ユーザー名: " . ($userInfo['name'] ?? '不明') . "\n";
28            echo "  UID: " . ($userInfo['uid'] ?? '不明') . "\n";
29            echo "  GID: " . ($userInfo['gid'] ?? '不明') . "\n";
30            echo "  ホームディレクトリ: " . ($userInfo['dir'] ?? '不明') . "\n";
31            echo "  シェル: " . ($userInfo['shell'] ?? '不明') . "\n";
32            echo "--------------------------\n";
33        } else {
34            echo "エラー: UID '{$uid}' のユーザー情報を取得できませんでした。\n";
35        }
36    } else {
37        echo "スクリプトはターミナル以外の環境（例: パイプ、リダイレクト）で実行されています。\n";
38        echo "ユーザー情報の表示はスキップされました。\n";
39    }
40}
41
42// 関数を実行します。
43displayCurrentUserPosixInfo();

PHPのposix_isatty関数は、スクリプトが現在、コマンドライン（ターミナル）から直接実行されているのか、それともデータがパイプやファイルにリダイレクトされているのかを判断するために使用されます。この関数は、引数としてファイルディスクリプタ（ファイルへの接続を表す番号、例えば標準出力を意味するSTDOUTなど）を受け取ります。そして、それがターミナルデバイスに接続されていればtrueを、そうでなければfalseを戻り値として返します。

このサンプルコードでは、posix_isatty(STDOUT)を使用して、スクリプトの標準出力がターミナルに接続されているかを最初に確認しています。もしターミナルからの実行であれば、「スクリプトはターミナル環境で実行されています」と表示し、posix_getuid関数で現在のユーザーIDを取得します。さらに、そのIDを基にposix_getpwuid関数を使ってユーザー名やホームディレクトリといった詳細なPOSIXユーザー情報を取得し、表示します。これにより、誰がスクリプトを実行しているかを判別できます。反対に、ターミナル以外の環境で実行されている場合は、ユーザー情報の表示をスキップし、適切なメッセージを表示することで、実行環境に応じた柔軟な処理を実現しています。

Copy
1<?php
2
3/**
4 * PHPのposix_isattyとposix_getpid関数の使用例を示します。
5 *
6 * このスクリプトは、現在のプロセスのIDを表示し、
7 * その標準出力がターミナルに接続されているかどうかを判定します。
8 * システムエンジニアを目指す初心者向けに、これらのPOSIX関数が
9 * コマンドラインインターフェース(CLI)環境でどのように動作するかを簡潔に示します。
10 *
11 * 注意: このスクリプトはPOSIX互換システムでPHP CLIとして実行されることを想定しています。
12 *       posix拡張が有効になっていない場合、エラーメッセージが表示されます。
13 */
14function demonstratePosixIsatty(): void
15{
16    // posix_isatty関数が利用可能かチェックします。
17    // POSIX関数は、すべてのシステムやPHPのビルドで利用できるわけではありません。
18    if (!function_exists('posix_isatty')) {
19        echo "エラー: 'posix_isatty' 関数が利用できません。PHPのPOSIX拡張が有効になっているか確認してください。\n";
20        return;
21    }
22    // posix_getpid関数が利用可能かチェックします。（キーワード関連）
23    if (!function_exists('posix_getpid')) {
24        echo "エラー: 'posix_getpid' 関数が利用できません。PHPのPOSIX拡張が有効になっているか確認してください。\n";
25        return;
26    }
27
28    // 1. 現在のプロセスID (PID) を取得し表示します。
29    // PIDは、オペレーティングシステムが実行中のプログラムを識別するために割り当てるユニークな番号です。
30    $pid = posix_getpid();
31    echo "現在のプロセスID (PID): " . $pid . "\n";
32
33    // 2. 標準出力 (STDOUT) のファイルディスクリプタを取得します。
34    // STDOUTは、プログラムが通常結果を出力する先（例: ターミナル画面）を指します。
35    // PHPでは、STDOUT定数は既に開かれたファイルリソースとして提供されます。
36    $stdoutFileDescriptor = STDOUT;
37
38    // 3. posix_isatty() 関数を使用して、標準出力がターミナルに接続されているかを判定します。
39    // この関数は、指定されたファイルディスクリプタが対話型ターミナルデバイスに接続されている場合にtrueを返します。
40    // trueの場合、プログラムは対話的なターミナルから実行されており、
41    // falseの場合、出力がファイルにリダイレクトされているか、パイプで他のプログラムに渡されています。
42    $isStdOutATty = posix_isatty($stdoutFileDescriptor);
43
44    echo "標準出力はターミナルに接続されていますか？ ";
45    echo ($isStdOutATty ? "はい (True)\n" : "いいえ (False)\n");
46
47    // ヒント: このスクリプトを次のいずれかの方法で実行して、結果の違いを確認してください。
48    //   - ターミナルで直接実行: `php your_script_name.php`  (通常「はい」と表示)
49    //   - 出力をファイルにリダイレクトして実行: `php your_script_name.php > output.txt` (通常「いいえ」と表示)
50    //     (output.txtにはプロセスIDと「いいえ」が書き込まれます)
51}
52
53// 上記で定義した関数を実行し、posix_isattyの動作を確認します。
54demonstratePosixIsatty();
55
56?>

PHPのposix_isatty関数は、指定されたファイルディスクリプタが対話型ターミナルデバイスに接続されているかを判断するために使用されます。この関数は、引数としてファイルリソースを受け取り、ターミナルに接続されていればtrue、そうでなければfalseの真偽値（bool）を返します。例えば、プログラムの出力が直接画面に表示されるのか、それともファイルに保存されるのか、パイプで別のプログラムに渡されるのかを区別する際に役立ちます。

サンプルコードでは、まずposix_getpid関数を使って現在のPHPスクリプトのプロセスID（PID）を取得し表示しています。PIDはオペレーティングシステムがプロセスを識別するための番号です。次に、PHPで標準出力を表すSTDOUTリソースをposix_isatty関数に渡しています。これにより、このスクリプトの標準出力がターミナルに接続されているかどうかを判定し、その結果を表示しています。この機能は主にPOSIX互換システムでのコマンドラインインターフェース（CLI）環境で利用され、PHPのPOSIX拡張が有効になっている必要があります。スクリプトをターミナルで直接実行した場合と、出力をファイルにリダイレクトした場合とで、posix_isatty関数の戻り値が異なることが確認できます。