exec
PHP's program-execution commands fail miserably when it comes to STDERR, and the proc_open() command doesn't work all that consistently in non-blocking mode under Windows.
This command, although useful, is no different. To form a mechanism that will see/capture both STDOUT and STDERR output, pipe the command to the 'tee' command (which can be found for Windows), and wrap the whole thing in output buffering.
Dustin Oprea
passthru
(PHP 4, PHP 5)
passthru — 外部プログラムを実行し、未整形の出力を表示する
説明
void passthru
( string
$command
[, int &$return_var
] )
passthru()関数はexec()関数と同様、
commandを実行します。
引数 return_var を指定した場合、
Unix コマンドのステータスで置換されます。
この関数は Unix コマンドからの出力がバイナリデータであり、
ブラウザーへ直接返す必要がある場合、exec()
もしくはsystem()の代わりに使用する必要があります。
よく使うのは、直接画像ストリームを出力することができる pbmplus
ユーティリティの様なものを実行する場合です。content-type を
image/gif に設定して、gifを出力するpbmplus
プログラムを呼び出すことにより、直接画像を出力する PHP スクリプトを作成
することができます。
パラメータ
-
command -
実行するコマンド
-
return_var -
引数
return_varが存在する場合、 Unix コマンドのステータスがこの変数に書かれます。
返り値
値を返しません。
注意
警告
ユーザーが入力したデータをこの関数に 渡すことを許可する場合、ユーザーが任意のコマンドを実行できるようシステムを欺くことが できないように escapeshellarg() または escapeshellcmd() を適用する必要があります。
注意:
プログラムがこの関数で始まる場合、 バックグラウンドで処理を続けさせるには、 プログラムの出力をファイルや別の出力ストリームにリダイレクトする必要があります。 そうしないと、プログラムが実行を終えるまで PHP はハングしてしまいます。
注意: セーフモード が有効な場合、 safe_mode_exec_dirの中にある実行プログラムのみ実行可能です。 実際的な理由により、現在、実行プログラムへのパスに ..を 含めることはできません。
警告
セーフモードが有効な場合、コマンド文字列は escapeshellcmd() でエスケープされます。 つまり、echo y | echo x は、echo y \| echo x となります。
参考
- exec() - 外部プログラムを実行する
- system() - 外部プログラムを実行し、出力を表示する
- popen() - プロセスへのファイルポインタをオープンする
- escapeshellcmd() - シェルのメタ文字をエスケープする
- バックティック演算子
add a note
User Contributed Notes
passthru
myselfasunder at gmail dot com dot dfvuks
29-Nov-2010 02:00
ignacio paz posse
06-Apr-2010 09:15
I'd like to refer about the use of use of passthru as a substitute to include or require which I didn't see before. It helped me to workaround a problem with a script which fatally failed only when included or required. I presume that it had to be with recursive includes because there where memory exhaustion messages that didn't get fixed even when increasing the memory limit with ini_set(). As I had no time to re-code it, the fix of the problem was to get the output of the script via a passthru call.
Something like this:
<?php
# ...
# (function stuff)
ob_start();
passthru("php myscript.php, $result");
$content_grabbed=ob_get_contents();
ob_end_clean();
if($result=0){
echo '<div>',$content_grabbed,'</div>';
}_
# (more function stuff)
# ...
?>
I don't know about drawbacks that this method might have. Maybe and increased overhead? Anyway I was happy to circumvent the problem with it.
Chroot
29-Jul-2008 11:48
If you have chrooted apache and php, you will also want to put /bin/sh into the chrooted environment. Otherwise, the exec() or passthru() will not function properly, and will produce error code 127, file not found.
jo at durchholz dot org
22-Nov-2007 01:17
Note to Paul Giblock: the command *is* run through the shell.
You can verify this on any Linux system with
<?php
passthru ('echo $PATH');
?>
You'll get the content of the PATH environment variable, not the string $PATH.
Paul Giblock
18-May-2007 01:30
Stuart:
The pasthru function does not execute the program through the shell. What this mean, among other things, is that your PATH variable is never set. Therefore, you have to use full paths on everything.
I believe system() will run your program underneith a shell. This allow the program to run in a 'normal' environment.
-Paul
nuker at list dot ru
03-Jan-2006 06:51
I wrote function, that gets proxy server value from the Internet Explorer (from
registry). It was tested in Windows XP Pro
(Sorry for my English)
<?php
function getProxyFromIE()
{
exec("reg query \"HKEY_CURRENT_USER\Software\Microsoft".
"\Windows\CurrentVersion\Internet Settings\" /v ProxyEnable",
$proxyenable,$proxyenable_status);
exec("reg query \"HKEY_CURRENT_USER\Software\Microsoft".
"\Windows\CurrentVersion\Internet Settings\" /v ProxyServer",
$proxyserver);
if($proxyenable_status!=0)
return false; #Can't access the registry! Very very bad...
else
{
$enabled=substr($proxyenable[4],-1,1);
if($enabled==0)
return false;
else
{
$proxy=ereg_replace("^[ \t]{1,10}ProxyServer\tREG_SZ[ \t]{1,20}","",
$proxyserver[4]);
if(ereg("[\=\;]",$proxy))
{
$proxy=explode(";",$proxy);
foreach($proxy as $i => $v)
{
if(ereg("http",$v))
{
$proxy=str_replace("http=","",$v);
break;
}
}
if(@!ereg("^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\:".
"[0-9]{1,5}$",$proxy))
return false;
else
return $proxy;
}
else
return $proxy;
}
}
}
?>
Note, that this function returns FALSE if proxy is disabled in Internet
Explorer. This function returns ONLY HTTP proxy server.
Usage:
<?php
$proxy=getProxyFromIE();
if(!$proxy)
echo "Can't get proxy!";
else
echo $proxy;
?>
Stuart Eve
08-Dec-2005 12:24
I dunno if anyone else might find this useful, but when I was trying to use the passthru() command on Suse9.3 I was having no success with the command:
$command = 'gdal_translate blahahahaha';
passthru($command);
It only worked once I put:
$command = '/usr/bin/local/gdal_translate blalalala';
passthru($command);
vijayramanan at rediffmail dot com
13-Oct-2005 05:09
I had an issue when i used exec
I think we were echoing information on the test.php script.
for eg: when we tried
exec(php test.php,$array,$error);
the return was 127 and the code was failing.
checking the note on this page gave us a hint to use passthru instead.
The only thing to note is that you need to provide the fuull path.
now our command became
passthru(/bin/php /pathtotest/test.php,$array,$error);
this works.
yipeee!!!!!
waldow at NOSPAM dot chem dot plu dot edu
22-Sep-2005 09:59
When upgrading my redhat server to enterprise 4, selinux was turned on. This caused one of my php scripts (that uses passthru) to fail. After some nice help from redhat, I was able to get the script running again. Here is what helped me.
If you get permission errors (in /var/log/httpd/error_log) which seem to be from selinux (and not standard chmod or chown issues), make sure that the folder you are using is not in /tmp and has the selinux context of httpd_sys_script_rw_t as can be set as follows:
chcon -t httpd_sys_script_rw_t folder_name
Hope this helps someone...
stuartc1 at NOSPAM dot hotmail dot com
09-Aug-2005 09:52
Thought it might beuseful to note the passthru seems to supress error messages whilst being run in Dos on Windows (test on NT).
To show FULL raw output including errors, use system().
igor at bboy dot ru
23-Jun-2005 03:33
If you are using passthru() to download files (for dynamically generated content or something outside webserver root) using similar code:
header("Content-Type: application/octet-stream");
header("Content-Disposition: attachment; filename=\"myfile.zip\"");
header("Content-Length: 11111");
passthru("cat myfile.zip",$err);
and your download goes fine, but subsequent downloads / link clicks are screwed up, with headers and binary data being all over the website, try putting
exit();
after the passthrough. This will exit the script after the download is done and will not interfere with any future actions.
sarel dot w at envent dot co dot za
09-Mar-2005 12:33
Zak Estrada
14-Dec-2004 11:21
Remember to use the full path (IE '/usr/local/bin/foo' instead of 'foo') when using passthru, otherwise you'll get an exit code of 127 (command not found).
Remember, you'll also get this error if your file does not have executable permission.
puppy at cyberpuppy dot org
02-Mar-2005 03:50
Regarding swbrown's comment...you need to use an output buffer if you don't want the data displayed.
For example:
ob_start();
passthru("<i>command</i>");
$var = ob_get_contents();
ob_end_clean(); //Use this instead of ob_flush()
This gets all the output from the command, and exits without sending any data to stdout.
Zak Estrada
14-Dec-2004 09:21
Remember to use the full path (IE '/usr/local/bin/foo' instead of 'foo') when using passthru, otherwise you'll get an exit code of 127 (command not found).
php @ richud dot com
27-May-2004 10:30
Regarding kpierre's post, be mindful that if you shell script errors, you will find the error output from it in the base error_log file (not virtualhost error_log) in apache.
jcr at marvel-databadge dot com
04-Sep-2003 01:23
With apache 2.x on RH9 passthru() writes 1 byte at a time. Apache 2.x buffers and chunk encodes the output for you - but the chunked encoding devides the output in chunks of 1 byte each...thus several bytes of overhead per byte. I guess that buffering behaviour is by design - but caused problems for me with IE adobe acrobot 5 plugin. The plugin doesn't like like it if you send it a stream of 1 byte chunks - it tells you your file is not a pdf or gives a blank screen. Using output buffering (ob_start / ob_endflush) gives reasonable size chunks and the plugin works OK.
swbrown at ucsd dot edu
03-Jun-2003 10:41
passthru() seems absolutely determined to buffer output no matter what you do, even with ob_implicit_flush(). The solution seems to be to use popen() instead.
kpierre at fit dot edu
30-Jan-2002 08:35
The documention does not mention that passthru() will only display standard output and not standard error.
If you are running a script you can pipe the STDERR to STDOUT by doing
exec 2>&1
Eg. the script below will actually print something with the passthru() function...
#!/bin/sh
exec 2>&1
ulimit -t 60
cat nosuchfile.txt
andreas dot hochsteger at oeamtc dot at
03-Oct-2001 09:51
If you sometimes get no output from passthru() use system() instead. This solved this problem for me (php 4.0.5 on Tru64 Unix compiled with gcc).
sidney at jigsaw dot nl
20-Jun-2001 07:25
PJ's ulimit example is nice; however, if you include multiple commands in the script after the ulimit command, each gets its own, seperate 60 second time slot!<br>
Furthermore, these sixty seconds are *CPU* time. Most programs hang for other reasons than CPU hogging (for example, waiting for a database connection) so for most purposes the number 60 is rather too high.<br>
Try "ulimit -t 1" first, which will give you about 10^9 cycles on modern hardware -- quite enough to get a lot of work done!
PJ at piggei dot com
14-Feb-2001 06:06
About the problem of zombies, you may call a bash script like this:
--------------------------
#! /bin/bash
ulimit -t 60
<your command here>
--------------------------