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

Copy
1<?php
2declare(strict_types=1);
3
4/**
5 * popen を使用してコマンドを実行し、その標準出力を取得します。
6 *
7 * @param string $command 実行するシェルコマンド文字列。
8 * @return string|false コマンドの標準出力文字列、またはプロセスのオープンに失敗した場合は false。
9 */
10function getCommandOutputUsingPopen(string $command): string|false
11{
12    // popen でコマンドを実行し、プロセスへのパイプを開きます。
13    // 'r' モードは、子プロセスの標準出力を読み込むことを意味します。
14    $handle = popen($command, 'r');
15
16    // popen が失敗した場合 (false を返した場合) のエラーハンドリング。
17    if ($handle === false) {
18        // エラーログへの記録など、適切なエラー処理を行うことを推奨します。
19        error_log("Failed to open process for command: {$command}");
20        return false;
21    }
22
23    $output = '';
24    // パイプからコマンドの出力を一行ずつ読み込みます。
25    // feof はファイルの終端 (またはパイプの終端) に達したかどうかを確認します。
26    while (!feof($handle)) {
27        // fgets で一行読み込み、文字列にキャストして連結します。
28        // fgets は読み込み失敗時に false を返す可能性があるため、安全のためキャストしています。
29        $output .= (string) fgets($handle);
30    }
31
32    // 開いたプロセスを閉じます。
33    // pclose は子プロセスの終了ステータスを返しますが、ここではその値は使用しません。
34    pclose($handle);
35
36    return $output;
37}
38
39// --- サンプル使用例 ---
40
41// 例1: シンプルな echo コマンドを実行し、出力を取得する
42$command1 = 'echo "Hello from PHP popen!"';
43echo "--- 実行コマンド 1: '{$command1}' ---\n";
44$output1 = getCommandOutputUsingPopen($command1);
45
46if ($output1 !== false) {
47    echo "出力:\n{$output1}\n";
48} else {
49    echo "エラー: コマンド1の実行に失敗しました。\n";
50}
51
52// 例2: システム情報を表示するコマンドを実行し、出力を取得する
53// (Linux/macOSの場合: 'ls -la /tmp', Windowsの場合: 'dir', 'ipconfig' など)
54$command2 = 'ls -la /tmp';
55echo "\n--- 実行コマンド 2: '{$command2}' ---\n";
56$output2 = getCommandOutputUsingPopen($command2);
57
58if ($output2 !== false) {
59    echo "出力:\n{$output2}\n";
60} else {
61    echo "エラー: コマンド2の実行に失敗しました。\n";
62}
63
64// 例3: 存在しないコマンドを実行し、エラーケースを確認する
65// (popen 自体は成功しても、内部のコマンドが失敗する可能性があります)
66$command3 = 'non_existent_command_12345';
67echo "\n--- 実行コマンド 3: '{$command3}' (エラーが期待されます) ---\n";
68$output3 = getCommandOutputUsingPopen($command3);
69
70if ($output3 !== false) {
71    // 存在しないコマンドの場合でも、エラーメッセージが出力として取得されることがあります。
72    echo "出力 (エラーメッセージ):\n{$output3}\n";
73} else {
74    echo "エラー: コマンド3の実行に失敗しました。(これは期待される動作です)\n";
75}

PHPのpopen関数は、PHPスクリプトから外部のシェルコマンドを実行し、そのコマンドの標準出力をPHPプログラム内で読み込むためのパイプを開く機能です。

第一引数$commandには、実行したいシェルコマンドの文字列を指定します。例えば'ls -la'や'echo "Hello!"'などです。第二引数$modeはパイプの開き方を指定し、サンプルコードでは'r'（読み込みモード）が使われており、これは子プロセスの標準出力をPHP側で読み込むことを意味します。

popenは成功すると、開いたパイプを表す「リソース」（ファイルポインタのようなもの）を返します。このリソースを通じてコマンドの出力にアクセスできます。一方、コマンドの実行やパイプのオープンに失敗した場合はfalseを返しますので、必ずエラーチェックを行うことが重要です。

サンプルコードのgetCommandOutputUsingPopen関数では、popenで取得したリソースを利用し、feofでパイプの終端を確認しながらfgetsでコマンドの出力を一行ずつ読み込み、結合しています。全ての出力を読み終えたら、pclose関数を呼び出して開いたプロセスを閉じることで、システムリソースを適切に解放します。これにより、外部コマンドの出力を安全かつ確実に取得することができます。

Copy
1<?php
2
3/**
4 * popen() 関数を使用してコマンドを実行し、その出力を読み取るサンプル。
5 *
6 * popen() は外部プログラムをプロセスとして実行し、パイプを通じてその入出力を制御します。
7 * この例では、`echo` コマンドを実行し、その標準出力を読み取ります。
8 *
9 * @param string $command 実行するシェルコマンド。
10 * @return void
11 */
12function runCommandWithPopen(string $command): void
13{
14    // popen() を使用してコマンドを実行し、その出力ストリームを読み取りモード ('r') で開く
15    // 成功するとファイルポインタリソースを返し、失敗すると false を返す
16    $process = popen($command, 'r');
17
18    if ($process === false) {
19        echo "エラー: コマンド '{$command}' の実行に失敗しました。\n";
20        return;
21    }
22
23    echo "--- コマンド出力開始 ---\n";
24
25    // ファイルポインタから行ごとにデータを読み取る
26    // feof() はファイルポインタが終端に達しているかチェックする
27    while (!feof($process)) {
28        $line = fgets($process); // 1行読み込む
29        if ($line !== false) {
30            echo $line; // 読み取った行を出力
31        }
32    }
33
34    echo "--- コマンド出力終了 ---\n";
35
36    // popen() で開いたプロセスを閉じる
37    // pclose() はプロセスの終了を待ち、その終了ステータスを返す
38    $returnCode = pclose($process);
39
40    if ($returnCode === -1) {
41        // エラーが発生した場合 (例: 子プロセスが終了しなかった、pcloseが失敗した)
42        echo "警告: プロセス '{$command}' のクローズ中にエラーが発生したか、終了ステータスが取得できませんでした。\n";
43    } else {
44        echo "プロセス '{$command}' はコード {$returnCode} で終了しました。\n";
45    }
46}
47
48// サンプルコマンドを実行
49// このコマンドは、PHPを実行している環境のシェルで解釈されます。
50// Windows環境では 'echo Hello from PHP popen!' のようにシンプルに、
51// Linux/macOS環境では `ls -l` や `echo "Hello from PHP popen!"` などが適切です。
52// より簡単なクロスプラットフォームな例として `echo` を使用します。
53runCommandWithPopen('echo "Hello from PHP popen!"');
54
55echo "\n";
56
57// 別のサンプルとして、存在しないコマンドを実行してエラーハンドリングを見る
58runCommandWithPopen('non_existent_command_123');

PHPのpopen関数は、外部のコマンドを新しいプロセスとして実行し、その入出力をプログラムから制御するための関数です。これにより、PHPスクリプトの中からシェルコマンドなどを実行し、その結果を受け取ることができます。

第一引数$commandには実行したいシェルコマンドを文字列で指定します。第二引数$modeは、開くパイプのモードを指定し、'r'はコマンドの標準出力を読み込むモードを意味します。

popen関数は、コマンドの実行に成功すると、ファイルポインタのようなリソースを返します。このリソースを通じて、実行されたコマンドの出力をfgetsなどの関数で一行ずつ読み取ることが可能です。もしコマンドの実行に失敗した場合はfalseを返しますので、戻り値の確認によるエラーハンドリングが重要です。

コマンドの出力処理が完了したら、必ずpclose関数を使って開いたプロセスを閉じる必要があります。pcloseはプロセスの終了を待ち、その終了ステータスを返します。このサンプルコードでは、popenで外部コマンドを実行し、その出力を読み取って表示する一連の流れと、エラー発生時の処理を確認できます。

Copy
1<?php
2
3/**
4 * Executes a shell command using popen in a non-blocking (asynchronous) manner.
5 *
6 * This function starts a command as a child process and reads its output
7 * without blocking the main script's execution, allowing other tasks to run concurrently.
8 *
9 * @param string $command The shell command to execute.
10 * @return string The collected output from the command, or an empty string if an error occurs.
11 */
12function runNonBlockingCommand(string $command): string
13{
14    // popen() を使用してコマンドを実行し、子プロセスとのパイプを開きます。
15    // 'r' モードは、子プロセスの標準出力を親プロセスが読み取ることを可能にします。
16    $pipe = popen($command, 'r');
17    if ($pipe === false) {
18        error_log("Failed to open pipe for command: " . $command);
19        return '';
20    }
21
22    // パイプを非ブロッキングモードに設定します。
23    // これにより、fgets() などの読み取り関数はデータが利用可能になるまで待機せず、
24    // すぐに制御を戻すようになります。
25    stream_set_blocking($pipe, false);
26
27    $output = '';
28    $startTime = microtime(true);
29    $timeout = 10; // コマンドの最大実行時間 (秒) を設定します。
30
31    // パイプがクローズされるまでループを続けます。
32    while (!feof($pipe)) {
33        $read = [$pipe]; // 読み取りを監視するストリームの配列。
34        $write = null;   // 書き込みを監視するストリーム (今回は使用しません)。
35        $except = null;  // 例外を監視するストリーム (今回は使用しません)。
36        $tv_sec = 1;     // stream_select の待機時間 (秒)。この間、メインスクリプトは他の処理を実行できます。
37
38        // stream_select() は、指定されたストリームが読み取り可能になるまで待機します。
39        // 非ブロッキングモードと組み合わせることで、メインスクリプトは他の処理を短い間隔で実行できます。
40        $numChangedStreams = stream_select($read, $write, $except, $tv_sec);
41
42        if ($numChangedStreams === false) {
43            // stream_select でエラーが発生した場合。
44            error_log("stream_select failed.");
45            break;
46        } elseif ($numChangedStreams > 0) {
47            // パイプが読み取り可能になった場合。
48            // fgets() で利用可能なデータをすべて読み取ります。
49            while (($buffer = fgets($pipe, 4096)) !== false) {
50                $output .= $buffer;
51            }
52        }
53
54        // コマンド実行のタイムアウトをチェックします。
55        if (microtime(true) - $startTime > $timeout) {
56            error_log("Command timed out after {$timeout} seconds: " . $command);
57            break;
58        }
59    }
60
61    // パイプを閉じ、子プロセスを終了させます。
62    pclose($pipe);
63
64    return $output;
65}
66
67// --- 使用例 ---
68echo "--- 非同期コマンド実行の開始 ---\n";
69
70// 例として、3秒間隔で3行を出力するPHPスクリプトをバックグラウンドで実行します。
71// flush() は、子プロセスの出力を即座にパイプに送るために重要です。
72$longRunningCommand = 'php -r "
73    for ($i = 0; $i < 3; $i++) {
74        echo \'Line \' . ($i + 1) . \' from child process\\n\';
75        sleep(1); // 1秒待機
76        flush();  // 出力を強制的にフラッシュ
77    }
78    echo \'Child process finished.\\n\';
79"';
80
81// 非同期関数を呼び出します。
82$result = runNonBlockingCommand($longRunningCommand);
83
84echo "メインスクリプトは続行しています...\n";
85// メインスクリプトは、子プロセスがバックグラウンドで実行されている間に、
86// ここで他の処理を実行できます。
87sleep(2); // 例として、メインスクリプトで2秒待機します。
88
89echo "--- コマンド出力の受信 ---\n";
90echo $result;
91echo "--- 非同期コマンド実行の終了 ---\n";
92
93?>

PHPのpopen関数は、指定されたシェルコマンド（$command）を子プロセスとして実行し、その子プロセスとの間でデータのやり取りを行うための「パイプ」を開きます。このパイプは、親プロセスが子プロセスの出力（標準出力）を読み取ったり、入力（標準入力）を子プロセスに書き込んだりするために使用されます。$mode引数には、パイプを読み取り用（'r'）または書き込み用（'w'）として開くかを指定します。関数が成功すると、パイプを表すresource型のリソースを返し、失敗した場合はfalseを返します。

提供されたサンプルコードでは、popenを利用してシェルコマンドを「非同期」で実行する仕組みを構築しています。通常、popenで開いたパイプからデータを読み込む際、データが利用可能になるまでスクリプトが停止（ブロック）することがありますが、stream_set_blocking($pipe, false)でパイプを非ブロッキングモードに設定することでこれを回避します。さらに、stream_select関数を用いることで、パイプにデータが来たときだけ読み込みを行い、データがない間はメインスクリプトが他の処理を進められるようになります。これにより、時間のかかるコマンドをバックグラウンドで実行しつつ、メインスクリプトはブロックされずに動作を継続できます。コマンドの実行が完了するか、タイムアウトすると、pclose関数でパイプを閉じ、関連するリソースを解放します。この非同期処理により、ユーザー体験の向上や複数のタスクの同時進行が可能になります。