Expect 関数

導入

この拡張モジュールは、PTY を経由したプロセス同士の対話機能を提供します。ファイルシステム関数で expect:// ラッパを利用すれば、シンプルでより直感的なインターフェースが利用できるでしょう。

要件

このモジュールは » expect ライブラリの関数を使用します。libexpect バージョン >= 5.43.0 が必要です。

インストール手順

この » PECL 拡張モジュールは PHP にバンドルされていません。この PECL 拡張モジュールをインストールする方法は、マニュアルの PECL 拡張モジュールのインストールという章にあります。新規リリース・ダウンロード・ソースファイル・管理者情報・CHANGELOG といった関連する情報については、次の場所にあります。 » http://pecl.php.net/package/expect.

PHP 4 の場合、この PECL 拡張モジュールのソースは、PHP のソースの ext/ ディレクトリ、または上の PECL リンクで入手可能です。これらの関数を使用するには、--with-expect[=DIR] オプションを使用して expect サポートつきで PHP をコンパイルする必要があります。

Windows ユーザは、これらの関数を使用するためには php.ini の中で php_expect.dll を有効にします。 PHP 4 の場合、この DLL は PHP の Windows ダウンロードバイナリの extensions/ ディレクトリにあります。この PECL 拡張モジュール用の DLL は、» PHP のダウンロードページあるいは » http://pecl4win.php.net/ からダウンロードできます。

実行時設定

php.ini の設定により動作が変化します。

expect 拡張モジュールを設定するために、設定ファイル php.ini に設定項目が用意されています。

**Expect 設定オプション**
名前	デフォルト	変更可能
expect.timeout	"10"	PHP_INI_ALL
expect.loguser	"1"	PHP_INI_ALL
expect.logfile	""	PHP_INI_ALL

PHP_INI_* 定数の詳細および定義については php.ini ディレクティブを参照してください。

以下に設定ディレクティブに関する簡単な説明を示します。

expect.timeout integer

データを待ち受ける際のタイムアウト時間です。 expect_expectl() 関数で使用されます。

"-1" を指定すると、タイムアウトを発生させないようにします。

注意: "0" を指定すると、expect_expectl() 関数は結果を直ちに返します。

expect.loguser boolean

expect が、子プロセスの出力を標準出力に送るかどうかを指定します。典型的な対話型プログラムは入力した内容を表示するので、これを使用すれば対話の両方の側を表示することができます。

expect.logfile string

子プロセスの出力内容が書き込まれるファイルの名前。もしファイルが存在しない場合は新しく作成されます。

注意: この設置が空欄でなかった場合、 expect.loguser の設定内容にかかわらず出力が書き込まれます。

リソース型

expect_popen() は、オープンした PTY ストリームを返します。これを expect_expectl() で使用します。

定義済み定数

以下の定数が定義されています。この関数の拡張モジュールが PHP 組み込みでコンパイルされているか、実行時に動的にロードされている場合のみ使用可能です。

EXP_GLOB (integer): パターンが、glob 形式の文字列パターンであることを示します。
EXP_EXACT (integer): パターンが、単なる文字列であることを示します。
EXP_REGEXP (integer): パターンが、正規表現形式の文字列パターンであることを示します。
EXP_EOF (integer): EOF に到達した際に expect_expectl() が返す値です。
EXP_TIMEOUT (integer): expect.timeout で指定した秒数をこえた際に expect_expectl() が返す値です。
EXP_FULLBUFFER (integer): 一致するパターンがなかった際に expect_expectl() が返す値です。

例

この例ではリモートホストに SSH 経由で接続し、接続先の稼働時間を表示します。

Example#1 Expect の使用例


<?php
ini_set ("expect.loguser", "Off");

$stream = fopen ("expect://ssh root@remotehost uptime", "r");

$cases = array (
  array (0 => "password:", 1 => PASSWORD)
);

switch (expect_expectl ($stream, $cases)) {
 case PASSWORD:
  fwrite ($stream, "password\n");
  break;
 
 default:
  die ("リモートホストへの接続時にエラーが発生しました!\n");
}

while ($line = fgets ($stream)) {
  print $line;
}
fclose ($stream);
?>

次の例は、リモートホストに接続してインストールされている OS が 32 ビットか 64 ビットかを確認し、それぞれのパッケージのアップデートを実行します。

Example#2 もうひとつの Expect の使用例


<?php
ini_set ("expect.timeout", -1);
ini_set ("expect.loguser", "Off");

$stream = expect_popen ("ssh root@remotehost");

while (true) {
    switch (expect_expectl ($stream, array (
            array ("password:", PASSWORD), // SSH がパスワードを問い合わせます
            array ("yes/no)?", YESNO), // SSH がホストエントリを保存するかどうかを問い合わせます
            array ("~$ ", SHELL, EXP_EXACT), // シェルにたどり着きました!
    ))) {
        case PASSWORD:
            fwrite ($stream, "secret\n");
            break;

        case YESNO:
            fwrite ($stream, "yes\n");
            break;

        case SHELL:
            fwrite ($stream, "uname -a\n");
            while (true) {
                    switch (expect_expectl ($stream, array (
                            array ("~$ ", SHELL, EXP_EXACT), // シェルにたどり着きました!
                            array ("^Linux.*$", UNAME, EXP_REGEXP), // uname -a の出力
                    ), $match)) {
                        case UNAME:
                            $uname .= $match[0];
                            break;
                            
                        case SHELL:
                            // アップデートの実行
                            if (strstr ($uname, "x86_64")) {
                                    fwrite ($stream, "rpm -Uhv http://mirrorsite/somepath/some_64bit.rpm\n");
                            } else {
                                    fwrite ($stream, "rpm -Uhv http://mirrorsite/somepath/some_32bit.rpm\n");
                            }
                            fwrite ($stream, "exit\n");
                            break 2;
                        
                        case EXP_TIMEOUT:
                        case EXP_EOF:
                            break 2;

                        default:
                            die ("エラーが発生しました!\n");
                    }   
            }
            break 2;

        case EXP_TIMEOUT:
        case EXP_EOF:
            break 2;

        default:
            die ("エラーが発生しました!\n");
    }
}

fclose ($stream);
?>

expect_expectl — プロセスの出力がパターンに一致する・指定した時間が経過する・あるいは EOF に達するのいずれかにあてはまるまで待ち続ける
expect_popen — Bourne シェル経由でコマンドを実行し、プロセスへの PTY ストリームをオープンする

Expect 関数

導入

要件

インストール手順

実行時設定

リソース型

定義済み定数

例

目次

PHPマニュアル検索

ナビゲーション

関数リスト

同一レベル項目