PHP CLIでのシステムユーティリティの記述

ほとんどの専門家にとって、PHPはコンソールユーティリティの作成に真剣に使用される言語ではなく、これには多くの理由があります。 PHPは元々、Webサイトを作成するための言語として開発されましたが、PHP 4.3以降、2002年にCLIモードが公式にサポートされたため、そのようなものは長くなくなりました。 数年の間に、Badoo開発者はPHPで多くのインタラクティブなCLIユーティリティを正常に使用しています。

この記事では、PHPのCLIモードでの経験を共有し、* nixシステムで実行されるという条件で、PHPでスクリプトを作成する人にいくつかの推奨事項を示します（ただし、ほとんどすべてがWindowsにも当てはまります） ）

推奨事項

作業速度

PHPは遅い言語であると広く信じられていますが、実際にはそうです。 PHP CLIの場合、次の2つの理由から、重いフレームワークを使用せず、大きなPHPライブラリーだけを使用することをお勧めします。

1. CLIモードでのinclude / requireの実行には、常に解析と実行が含まれます。 このモードのバイトコードはキャッシュされません（少なくともデフォルトでは）。これは、すべてがWebサーバーの下で非常に高速に動作する場合でも、初期化に多くの時間がかかることを意味します。
2. Webサイトのユーザーは、ページを読み込むために一定の時間待機することに慣れています（約1秒、場合によってはもう少し、ユーザーはそれを非常に普通に認識します）が、CLIについても同じことが言えません：100ミリ秒の遅延でさえも顕著であり、 1秒以上で迷惑になることがあります。

画面出力

CLIモードとWebモードでは、画面への出力は大きく異なります。 Webモードでは、出力は通常バッファリングされます;スクリプトの実行中はユーザーに何も質問できません。 クラスとして欠落しているのは、エラーストリームへの出力の概念です。 CLIモードでは、当然、HTML出力は受け入れられず、長い行の出力は非常に望ましくありません。 CLIでは、デフォルトでechoはflush（）を呼び出します（詳細はここにあります ）-これは、たとえば出力がファイルにリダイレクトされる場合に、手動でflush（）を呼び出すことを心配する必要がないため便利です。

また、CLIスクリプトの場合、STDOUTではなく（エコーを使用して）エラーを出力するのが理にかなっています。このように、プログラム出力が他の場所（たとえば、/ dev / nullまたはgrep）にリダイレクトされても、ユーザーはテキストを見逃しません発生した場合のエラー。 これはほとんどのネイティブ* nixコンソールユーティリティの標準的な動作であり、STDERRは上記の理由から存在します。 PHPでは、STDERRに書き込むために、たとえば、fwrite（STDERR、$メッセージ）またはerror_log（$メッセージ）を使用できます。

リターンコードの使用

戻りコードは、コマンドが成功した場合は0であり、それ以外の場合は0ではない数値です。 致命的でないエラーの場合（たとえば、誤ったコマンドライン引数が指定された場合）に1の戻りコードがよく使用され、2-重大なシステムエラーの場合（たとえば、ネットワークまたはディスクエラーの場合）に戻りコードが使用されます。 通常、127または255などの値は、ドキュメントに個別に示されている特別な場合に使用されます。

デフォルトでは、PHPスクリプトを単純に終了すると、すべてのコマンドが正常に機能し、0を返すと想定されます。特定の戻りコードで終了するには、exit（NUM）を明示的に呼び出す必要があります。NUMは戻りコードです（成功し、エラーの場合は異なる意味を持ちます）。

exec（）またはsystem（）で実行された外部コマンドが成功しなかったことを理解するには、対応する関数のパラメーターとして変数$ return_varを渡し、ゼロに等しいかどうかの値を確認する必要があります。

注意！ exec（ 'some_cmd ... 2>＆1'、$ output）を記述してエラーも$ outputに分類する場合は、STDOUTとSTDERRを分離する理由を理解し、エラーストリームのSTDOUT（2>＆1）への明示的なリダイレクトを削除することをお勧めします。 このようなリダイレクトは、見かけよりもはるかに少ない頻度で必要です。 （PHPスクリプトで）その使用が少し正当化される唯一のケースは、コマンドの実行結果をWebページ（CLIではない！）に印刷する必要があることです。発生したエラーを含めます（そうしないと、Webサーバーのログに記録されるか、 / dev / null）。

システムの組み込みコマンドの下の「変装」

優れたコンソールユーティリティは標準的な方法で動作する必要があり、ユーザーはそれがPHPであることさえ知らないかもしれません。 このため、* nix-systemsは、Perl / Python / Rubyでスクリプトを実行することについて多くの人が知っているメカニズムを提供しますが、PHPにも同様に適用できます。

たとえば、PHPファイルの先頭に＃！/ Usr / bin / env phpを追加して改行する場合、実行権限（chmod 755 myscript.php）を付与し、.php拡張子を削除します（後者は不要です）。他の実行可能ファイル（./myscript）と同様に実行されます。 PATH内のスクリプトを使用してディレクトリを追加するか、標準のPATHディレクトリの1つ（たとえば、/ usr / local / bin）に移動すると、他のシステムユーティリティと同様に、「myscript」の単純なセットでスクリプトを呼び出すことができます。

コマンドライン引数の処理

ほとんどの組み込みシステムユーティリティが従うコマンドライン引数の形式には合意があり、スクリプトとスクリプトに従うことをお勧めします。

間違った数の引数を受け取った場合は、スクリプトの簡単なヘルプを書いてください。

呼び出されたスクリプトの名前を調べるには、$ argv [0]を使用します。

if($argc != 2) { //   \n   echo "Usage: ".$argv[0]." <filename>\n"; //    ,     exit(1); } 

フラグの処理を容易にするために、getopt（）を使用できます。 Getopt（）は、コマンドライン引数を処理するための組み込み関数の1つです。 一方、引数の一部を手動で処理することは難しくありません。 PHPでは、これは難しくありません。 このメソッドは、sshまたはsudoのスタイルで引数を処理する必要がある場合に必要になることがあります（sudo -u nobody echo Hello worldは、コマンドの前の-uフラグの後に指定されたユーザーnobodyからecho Hello worldを実行します）。

より難しいレベルの推奨事項

CLIの「正しい」システム（）の呼び出し

system（）の実装は、すでにここに記述されています 。 ポイントは、PHPの標準システム（）はCのsystem（）の呼び出しではなく、それぞれpopen（）のラッパーであり、呼び出されたスクリプトのSTDINとSTDOUTを「台無しにする」ことです。 これを防ぐには、次の機能を使用する必要があります。

 //      system()   function cSystem($cmd) { $pp = proc_open($cmd, array(STDIN,STDOUT,STDERR), $pipes); if(!$pp) return 127; return proc_close($pp); } 

ファイルシステムを操作する

驚いたことに、ファイルの再帰的な削除（コピー、移動）を独自に実装するのではなく、組み込みのmv、rm、cpコマンド（Windowsの場合、対応する類似物）を使用することをお勧めします。 これはWindows / * nix間では移植できませんが、以下で説明する問題の一部を回避できます。

PHPで再帰的なディレクトリ削除を実装する簡単な例を見てみましょう。

 //  !  rm -r function recursiveDelete($path) { if(is_file($path)) return unlink($path); $dh = opendir($path); while(false !== ($file = readdir($dh))) { if($file != '.' && $file != '..') recursiveDelete($path.'/'.$file); } closedir($dh); return rmdir($path); } 

一見、そうですね。 さらに、PHPの有名なファイルマネージャー（eXtplorerやドキュメントへのコメントなど）でも、フォルダーの削除はこの方法で実装されます。 次に、存在しないファイルへのシンボリックリンクを作成し（ln -s some_test other_test）、削除を試みます。 または、フォルダーに自分自身またはFSのルートへのシンボリックリンクを作成します（このオプションをテストしないことをお勧めします）...特にrecursiveDelete（）の場合、修正はもちろん簡単です。パフォーマンスで。

エラークリーニング

スクリプトがファイル（データベース、ソケットなど）で何らかの操作を行う場合、予期しないエラーが発生した場合にプログラムを正しくシャットダウンする必要があります。ログへの書き込み、一時ファイルのクリア、ファイルロックの削除などです。 .d。

PHP Webモードでは、これはregister_shutdown_function（）を使用して実装されます。これは、スクリプトが致命的なエラーで終了した場合でもトリガーされます（この方法は、ちなみに、メモリ不足エラーを含むほとんどすべてのエラーをキャッチするのに適しています）。 CLIモードでは、たとえば、ユーザーがスクリプトCtrl + Cを送信でき、register_shutdown_function（）が機能しないため、すべてが少し複雑になります。

しかし、説明は簡単です。PHPはデフォルトでUNIXシグナルをまったく処理しないため、シグナルを受信するとすぐにスクリプトが終了します。 これは、<？Phpの後にファイルの先頭にdeclare（ticks = 1）を追加し、関心のあるシグナルのハンドラーを登録することで修正できます（詳細はこちら ）。

 pcntl_signal(SIGINT, function() { exit(1); }); // Ctrl+C pcntl_signal(SIGTERM, function() { exit(1); }); // killall myscript / kill <PID> pcntl_signal(SIGHUP, function() { exit(1); }); //   

信号処理の機能は、すべての人で同じである必要はありません。 シグナルハンドラー内でexit（）を呼び出すことはできません-シグナルが処理された後、スクリプトは実行を続けます。

複数のプロセスでデータベースを操作する（fork（）の後）

推奨事項は非常に簡単です。fork（）を実行する前にデータベースへのすべての接続を閉じる必要があります（理想的には、fopen（）で開いているファイルも存在しないはずです）。 これらの場合にfork（）を実行すると、非常に奇妙な結果が生じる可能性があり、データベースに接続する場合、フォークされたプロセスのいずれかの完了後に接続を閉じるだけです。 同じSQLiteマニュアルでは、fork（）の前に開かれたリソースは、このようにマルチスレッドアクセスをサポートしていないため、fork（）プロセスで使用できないことを明示しています。 いずれにしても、PHPのpcntl_fork（）はfork（）を作成し、エラーをログに記録するだけなので、Cと同様に慎重に処理する必要があります。

複雑なレンダリングにncursesを使用する

ncursesライブラリは、端末内のカーソルの位置を制御するためのescシーケンスを心配する必要がなく、たとえば色を使用するプログラムがシステムと端末間で移植可能であるように特別に作成されました。 一方、カラー出力などの単純なものであっても、STDOUTは常にカラーをサポートするとは限らないことに留意する必要があります。 ターミナルがカラーをサポートしているかどうかをncursesなしで調べる-STDOUTターミナルが（posix_isatty（1））であるかどうかを確認する1つのプリミティブですが、信頼できない方法を知っています。

画面に表示される数

ほとんどの標準プログラムは、-vスイッチ（冗長、おしゃべり）を指定して特に要求されない限り、画面にほとんど何も表示しません。 実際、理由もなく画面を詰まらせないでください。 バランスを見つけるのは難しい場合がありますが、いくつかの簡単な推奨事項があります。

1. 操作に時間がかからない場合（10秒未満）、何も印刷しないでください。
2. 自明ではないこと（たとえば、sudoを使用して一時的なデバイスをマウントする）を実行している場合は、逆に、エラーが発生した場合の対処方法をユーザーに知らせるために、このことをユーザーに通知します。
3. 操作が長く、その進行状況を表示できる場合は、この進行状況を表示することをお勧めします（このため、上記のcSystem関数が役立ちます）。
4. プログラムがフィルターとして機能する場合（たとえば、cat、grep、gzip ...）、データのみがSTDOUTにあり、エラー、入力のプロンプトなどがSTDERRに移動して、チェーン内の次のプログラムが受信しないようにします。不要なゴミ。

進行状況を表示するには、gitと同じようにします。すべての端末の幅が少なくとも80文字であるという仮定を使用し、固定幅の行を印刷します。 キャリッジリターン文字（\ r）がカーソルを行の先頭に戻す（そして次の出力が前の行にあったものを上書きする）ことを考えると、たとえば、0から100までの操作の割合を表示するコードを書くのは非常に簡単です。同時に、ユーザーの画面で1行のみを取得します。

 for($i = 0; $i <= 100; $i++) { printf("\r%3d%%", $i); sleep(1); } echo "\n"; 

スクリプトを呼び出したユーザーの名前を定義する

ユーザー名はUSER環境変数（$ _ENV ['USER']）に含まれていますが、キャッチが1つあります-このメソッドは、誤ったデータを報告できる環境変数を使用します（ユーザーは、USER = root myscriptなどのスクリプトを実行でき、スクリプトはユーザー名がルートであると仮定します）。

したがって、posix関数を使用する必要があります。

 // getuid()  ,   ,    uid –        $info = posix_getpwuid(posix_getuid()); $login = $info['name']; 

おわりに

この記事では、一般的なコンソールユーティリティを作成するすべてのプログラマよりも、PHP開発者に直接明らかではない推奨事項を提供しようとしました。 上記の多くは他のプログラミング言語にも適用できますが、おそらくPHPで書かない人にとってはいくつかの点が役立つでしょう。

Yuri youROCK Nasretdinov、Badoo開発者