[PHP] Linux Command Line 進度Bar (多行版本)－長島冰茶的工程師筆記

最近經常在寫 Command Line 命令來做資料庫資料的轉換
所以想要弄個進度Bar 來做簡單的時間預估，但沒特殊處理就是一直 echo 很醜
稍微 Google 了一下發現不難處理，以下簡單筆記一下

要做進度 Bar ，就是要把訊息畫在畫面上相同的地方
所以要使用 ANSI escape code: https://en.wikipedia.org/wiki/ANSI_escape_code
然後先決定你要輸出的行數，每次輸出完後，再把游標跳回最一開始的地方就可以了

註：
1. \r = 把游標跳到最開始，所以如果要寫單行的進度Bar 用 \r 就夠了
2. \033[6A = 往上跳六行, \033 代表 ESC 鍵, A 代表往上跳行，6A 就是往上跳六行的意思

程式碼：

<?php

echo "\n\n\n\n\n\n";

$i = 0;
$start = time();
while ($i <= 100) {
    $i++;
    showTotalInfo(100, $i, $start);
    sleep(1);
}

function showTotalInfo($total, $finish, $start)
{
    $total = 100;
    $percent = number_format(($finish / $total) * 100, 2);
    $time = sec2time(time() - $start);

    echo "\033[6A\r";
    echo "------------------------------------------------\n";
    echo "總筆數: {$total}\n";
    echo "完成度: {$finish} / {$total} ({$percent}%)\n";
    echo "花費時間: $time\n";
    echo "------------------------------------------------\n\n";
}

/**
 * 把秒轉成時間
 * @param  integer $sec 秒
 * @return stirng       時間("h:m:s")
 */
function sec2time($sec)
{
    $s = $sec % 60;
    $m = intval($sec / 60) % 60;
    $h = intval($sec / 3600);

    return sprintf("%02d:%02d:%02d", $h, $m, $s);
}

網路上的進度Bar 1 ：

<?php
echo "Progress :      ";  // 5 characters of padding at the end
for ($i=0 ; $i<=100 ; $i++) {
    echo "\033[5D";      // Move 5 characters backward
    echo str_pad($i, 3, ' ', STR_PAD_LEFT) . " %";    // Output is always 5 characters long
    sleep(1);           // wait for a while, so we see the animation
}

網路上的進度Bar 2 ：

<?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";
    }

}

參考文章：
http://stackoverflow.com/questions/2124195/command-line-progress-bar-in-php
http://stackoverflow.com/questions/5265288/update-command-line-output-i-e-for-progress