PHP中的命令行进度条

时间:2010-01-23 18:30:56

标签: php

我目前正在尝试向命令行脚本添加进度条,我尝试了各种解决方案(包括Zend和Console_ProgressBar)。他们两个共同的问题是进度条没有粘在窗口的底部,因为在脚本中,输出了新行和其他信息。

有没有办法让进度条保持在终端的底部,但仍然可以在脚本运行时输出其他信息?

[编辑]

我明白了:

我没有直接输出到STDOUT,而是实际抓取变量内的输出,用echo chr(27) . '[2J'擦除屏幕,然后输出到STDOUT变量的内容,然后追加我的进度条。

希望有道理:)

5 个答案:

答案 0 :(得分:73)

对于cli来说,这是一个很好的进度条:

http://snipplr.com/view/29548/

<?php

/*

Copyright (c) 2010, dealnews.com, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of dealnews.com, Inc. nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

 */

/**
 * show a status bar in the console
 * 
 * <code>
 * for($x=1;$x<=100;$x++){
 * 
 *     show_status($x, 100);
 * 
 *     usleep(100000);
 *                           
 * }
 * </code>
 *
 * @param   int     $done   how many items are completed
 * @param   int     $total  how many items are to be done total
 * @param   int     $size   optional size of the status bar
 * @return  void
 *
 */

function show_status($done, $total, $size=30) {

    static $start_time;

    // if we go over our bound, just ignore it
    if($done > $total) return;

    if(empty($start_time)) $start_time=time();
    $now = time();

    $perc=(double)($done/$total);

    $bar=floor($perc*$size);

    $status_bar="\r[";
    $status_bar.=str_repeat("=", $bar);
    if($bar<$size){
        $status_bar.=">";
        $status_bar.=str_repeat(" ", $size-$bar);
    } else {
        $status_bar.="=";
    }

    $disp=number_format($perc*100, 0);

    $status_bar.="] $disp%  $done/$total";

    $rate = ($now-$start_time)/$done;
    $left = $total - $done;
    $eta = round($rate * $left, 2);

    $elapsed = $now - $start_time;

    $status_bar.= " remaining: ".number_format($eta)." sec.  elapsed: ".number_format($elapsed)." sec.";

    echo "$status_bar  ";

    flush();

    // when done, send a newline
    if($done == $total) {
        echo "\n";
    }

}

?>

答案 1 :(得分:39)

其他答案似乎过于复杂。我的解决方案是在下次更新之前简单地回显\ 033 [0G转义序列,并将光标移回到开头。

function progressBar($done, $total) {
    $perc = floor(($done / $total) * 100);
    $left = 100 - $perc;
    $write = sprintf("\033[0G\033[2K[%'={$perc}s>%-{$left}s] - $perc%% - $done/$total", "", "");
    fwrite(STDERR, $write);
}

第一次调用该函数会输出进度条,每次后续调用都会用新的进度条覆盖最后一行。

编辑: 我已经将回复\ r \ n更改为转义序列\ 033 [0G,现在这应该适用于OSX以及Linux / Unix。

编辑2: 根据@tbjers建议修正了第3行可能出现的错误。

编辑3: 更新了新版本,打印到STDERR,现在也在GitHub上打印:https://github.com/MacroMan/PHPTerminalProgressBar

答案 2 :(得分:4)

这是前一个答案的改进,它处理终端调整大小并使用2行代替1.第一行是信息,如时间/百分比,第二行是进度条。

<?
/*

Copyright (c) 2010, dealnews.com, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of dealnews.com, Inc. nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

 */

/**
 * show a status bar in the console
 *
 * <code>
 * for($x=1;$x<=100;$x++){
 *
 *     show_status($x, 100);
 *
 *     usleep(100000);
 *
 * }
 * </code>
 *
 * @param   int     $done   how many items are completed
 * @param   int     $total  how many items are to be done total
 * @param   int     $size   optional size of the status bar
 * @return  void
 *
 */

function show_status($done, $total, $size=30, $lineWidth=-1) {
    if($lineWidth <= 0){
        $lineWidth = $_ENV['COLUMNS'];
    }

    static $start_time;

    // to take account for [ and ]
    $size -= 3;
    // if we go over our bound, just ignore it
    if($done > $total) return;

    if(empty($start_time)) $start_time=time();
    $now = time();

    $perc=(double)($done/$total);

    $bar=floor($perc*$size);

    // jump to the begining
    echo "\r";
    // jump a line up
    echo "\x1b[A";

    $status_bar="[";
    $status_bar.=str_repeat("=", $bar);
    if($bar<$size){
        $status_bar.=">";
        $status_bar.=str_repeat(" ", $size-$bar);
    } else {
        $status_bar.="=";
    }

    $disp=number_format($perc*100, 0);

    $status_bar.="]";
    $details = "$disp%  $done/$total";

    $rate = ($now-$start_time)/$done;
    $left = $total - $done;
    $eta = round($rate * $left, 2);

    $elapsed = $now - $start_time;


    $details .= " " . formatTime($eta)." ". formatTime($elapsed);

    $lineWidth--;
    if(strlen($details) >= $lineWidth){
        $details = substr($details, 0, $lineWidth-1);
    }
    echo "$details\n$status_bar";

    flush();

    // when done, send a newline
    if($done == $total) {
        echo "\n";
    }

}

我不知道为什么上面的代码有许可我只是为了安全而复制它。波纹管代码未经许可。可以用于任何目的。

function formatTime($sec){
    if($sec > 100){
        $sec /= 60;
        if($sec > 100){
            $sec /= 60;
            return number_format($sec) . " hr";
        }
        return number_format($sec) . " min";
    }
    return number_format($sec) . " sec";
}


class Timer {
    public $time;
    function __construct(){
        $this->start();
    }
    function start($offset=0){
        $this->time = microtime(true) + $offset;
    }
    function seconds(){
        return microtime(true) - $this->time;
    }
};


// We need this to limit the frequency of the progress bar. Or else it
// hugely slows down the app.
class FPSLimit {
    public $frequency;
    public $maxDt;
    public $timer;
    function __construct($freq){
        $this->setFrequency($freq);
        $this->timer = new Timer();
        $this->timer->start();
    }
    function setFrequency($freq){
        $this->frequency = $freq;
        $this->maxDt = 1.0/$freq;
    }
    function frame(){
        $dt = $this->timer->seconds();
        if($dt > $this->maxDt){
            $this->timer->start($dt - $this->maxDt);
            return true;
        }
        return false;
    }
};

class Progress {
    // generic progress class to update different things
    function update($units, $total){}
}

class SimpleProgress extends Progress {
    private $cols;
    private $limiter;
    private $units;
    private $total;

    function __construct(){
        // change the fps limit as needed
        $this->limiter = new FPSLimit(10);
        echo "\n";
    }

    function __destruct(){
        $this->draw();
    }

    function updateSize(){
        // get the number of columns
        $this->cols = exec("tput cols");
    }

    function draw(){
        $this->updateSize();
        show_status($this->units, $this->total, $this->cols, $this->cols);
    }

    function update($units, $total){
        $this->units = $units;
        $this->total = $total;
        if(!$this->limiter->frame())
            return;
        $this->draw();
    }
}


// example

$tasks = rand() % 700 + 600;
$done = 0;

$progress = new SimpleProgress();

for($done = 0; $done <= $tasks; $done++){
    usleep((rand() % 127)*100);
    $progress->update($done, $tasks);
}

答案 3 :(得分:2)

以下内容适用于 unix计算机

目标是检索当前终端总列数。 (使用tput

这是一个基础,随时可以扩展。

 #!/usr/bin/php
 <?php

 @ob_start();

 $shell = system("tput cols");

 @ob_end_clean();

 for( $i= 0 ; $i < $shell ; $i++ ){ echo "█"; usleep(100000); } 

enter image description here

此处ob操作可隐藏stdout的{​​{1}}。

我们假设您想要制作符合您任务进度的进度条。

只需除以剩余时间(以秒为单位)。

您可能会以微秒结束,因此最好使用tput

这样,进度条将始终与用户外壳宽度匹配,包括调整大小时。

在纯粹的bash中做同样的事情:

usleep

这显示了php for ((i=0; i<$(tput cols); i++)); do echo -e "█\c" ;done 的主要奇点:它不会追加新行,而bash echo会这样做。

使用循环时,比如检查间隔条件, 警告运行活动的另一个好方法是文本效果

以下使用echo和ansi代码反向视频

strtoupper

输出:

enter image description here

有些人可能喜欢通过ansi代码的迭代获得的派对版本。

#!/usr/bin/php
<?php
$iloop = "0"; /* Outside the loop */
while (true){  
  $warn = "Program running hold on!!\r";
  if (strlen($warn) === $iloop+1){
    $iloop = "0";
  }
  $warn = str_split($warn);
  $iloop++;
  $warn[$iloop] = "\033[35;2m\e[0m".strtoupper($warn[$iloop]);
  echo " \033[7m".implode($warn);
  usleep(90000);
}

enter image description here

详细了解 ANSI 代码:https://stackoverflow.com/a/48365998/2494754

答案 4 :(得分:0)

如果你想使用可以在不同终端使用的东西而不必担心兼容性,Ncurses 是你要走的路。

检查:https://www.whoishostingthis.com/resources/ncurses/

The ncurses library provides a robust framework which allows programmers to create visually appealing user interfaces in text mode

关于此的主要 PHP 文档点是:https://www.php.net/manual/en/book.ncurses.php

相关问题