Blame dnf/cli/progress.py

Packit Service 21c75c
# Copyright (C) 2013-2016 Red Hat, Inc.
Packit Service 21c75c
#
Packit Service 21c75c
# This copyrighted material is made available to anyone wishing to use,
Packit Service 21c75c
# modify, copy, or redistribute it subject to the terms and conditions of
Packit Service 21c75c
# the GNU General Public License v.2, or (at your option) any later version.
Packit Service 21c75c
# This program is distributed in the hope that it will be useful, but WITHOUT
Packit Service 21c75c
# ANY WARRANTY expressed or implied, including the implied warranties of
Packit Service 21c75c
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
Packit Service 21c75c
# Public License for more details.  You should have received a copy of the
Packit Service 21c75c
# GNU General Public License along with this program; if not, write to the
Packit Service 21c75c
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
Packit Service 21c75c
# 02110-1301, USA.  Any Red Hat trademarks that are incorporated in the
Packit Service 21c75c
# source code or documentation are not subject to the GNU General Public
Packit Service 21c75c
# License and may only be used or replicated with the express permission of
Packit Service 21c75c
# Red Hat, Inc.
Packit Service 21c75c
Packit Service 21c75c
from __future__ import unicode_literals
Packit Service 21c75c
from dnf.cli.format import format_number, format_time
Packit Service 21c75c
from dnf.cli.term import _term_width
Packit Service 21c75c
from dnf.pycomp import unicode
Packit Service 21c75c
from time import time
Packit Service 21c75c
Packit Service 21c75c
import sys
Packit Service 21c75c
import dnf.callback
Packit Service 21c75c
import dnf.util
Packit Service 21c75c
Packit Service 21c75c
Packit Service 21c75c
class MultiFileProgressMeter(dnf.callback.DownloadProgress):
Packit Service 21c75c
    """Multi-file download progress meter"""
Packit Service 21c75c
Packit Service 21c75c
    STATUS_2_STR = {
Packit Service 21c75c
        dnf.callback.STATUS_FAILED: 'FAILED',
Packit Service 21c75c
        dnf.callback.STATUS_ALREADY_EXISTS: 'SKIPPED',
Packit Service 21c75c
        dnf.callback.STATUS_MIRROR: 'MIRROR',
Packit Service 21c75c
        dnf.callback.STATUS_DRPM: 'DRPM',
Packit Service 21c75c
    }
Packit Service 21c75c
Packit Service 21c75c
    def __init__(self, fo=sys.stderr, update_period=0.3, tick_period=1.0, rate_average=5.0):
Packit Service 21c75c
        """Creates a new progress meter instance
Packit Service 21c75c
Packit Service 21c75c
        update_period -- how often to update the progress bar
Packit Service 21c75c
        tick_period -- how fast to cycle through concurrent downloads
Packit Service 21c75c
        rate_average -- time constant for average speed calculation
Packit Service 21c75c
        """
Packit Service 21c75c
        self.fo = fo
Packit Service 21c75c
        self.update_period = update_period
Packit Service 21c75c
        self.tick_period = tick_period
Packit Service 21c75c
        self.rate_average = rate_average
Packit Service 21c75c
        self.unknown_progres = 0
Packit Service 21c75c
        self.total_drpm = 0
Packit Service 21c75c
        self.isatty = sys.stdout.isatty()
Packit Service 21c75c
        self.done_drpm = 0
Packit Service 21c75c
        self.done_files = 0
Packit Service 21c75c
        self.done_size = 0
Packit Service 21c75c
        self.active = []
Packit Service 21c75c
        self.state = {}
Packit Service 21c75c
        self.last_time = 0
Packit Service 21c75c
        self.last_size = 0
Packit Service 21c75c
        self.rate = None
Packit Service 21c75c
        self.total_files = 0
Packit Service 21c75c
        self.total_size = 0
Packit Service 21c75c
Packit Service 21c75c
    def message(self, msg):
Packit Service 21c75c
        dnf.util._terminal_messenger('write_flush', msg, self.fo)
Packit Service 21c75c
Packit Service 21c75c
    def start(self, total_files, total_size, total_drpms=0):
Packit Service 21c75c
        self.total_files = total_files
Packit Service 21c75c
        self.total_size = total_size
Packit Service 21c75c
        self.total_drpm = total_drpms
Packit Service 21c75c
Packit Service 21c75c
        # download state
Packit Service 21c75c
        self.done_drpm = 0
Packit Service 21c75c
        self.done_files = 0
Packit Service 21c75c
        self.done_size = 0
Packit Service 21c75c
        self.active = []
Packit Service 21c75c
        self.state = {}
Packit Service 21c75c
Packit Service 21c75c
        # rate averaging
Packit Service 21c75c
        self.last_time = 0
Packit Service 21c75c
        self.last_size = 0
Packit Service 21c75c
        self.rate = None
Packit Service 21c75c
Packit Service 21c75c
    def progress(self, payload, done):
Packit Service 21c75c
        now = time()
Packit Service 21c75c
        text = unicode(payload)
Packit Service 21c75c
        total = int(payload.download_size)
Packit Service 21c75c
        done = int(done)
Packit Service 21c75c
Packit Service 21c75c
        # update done_size
Packit Service 21c75c
        if text not in self.state:
Packit Service 21c75c
            self.state[text] = now, 0
Packit Service 21c75c
            self.active.append(text)
Packit Service 21c75c
        start, old = self.state[text]
Packit Service 21c75c
        self.state[text] = start, done
Packit Service 21c75c
        self.done_size += done - old
Packit Service 21c75c
Packit Service 21c75c
        # update screen if enough time has elapsed
Packit Service 21c75c
        if now - self.last_time > self.update_period:
Packit Service 21c75c
            if total > self.total_size:
Packit Service 21c75c
                self.total_size = total
Packit Service 21c75c
            self._update(now)
Packit Service 21c75c
Packit Service 21c75c
    def _update(self, now):
Packit Service 21c75c
        if self.last_time:
Packit Service 21c75c
            delta_time = now - self.last_time
Packit Service 21c75c
            delta_size = self.done_size - self.last_size
Packit Service 21c75c
            if delta_time > 0 and delta_size > 0:
Packit Service 21c75c
                # update the average rate
Packit Service 21c75c
                rate = delta_size / delta_time
Packit Service 21c75c
                if self.rate is not None:
Packit Service 21c75c
                    weight = min(delta_time/self.rate_average, 1)
Packit Service 21c75c
                    rate = rate*weight + self.rate*(1 - weight)
Packit Service 21c75c
                self.rate = rate
Packit Service 21c75c
        self.last_time = now
Packit Service 21c75c
        self.last_size = self.done_size
Packit Service 21c75c
        if not self.isatty:
Packit Service 21c75c
            return
Packit Service 21c75c
        # pick one of the active downloads
Packit Service 21c75c
        text = self.active[int(now/self.tick_period) % len(self.active)]
Packit Service 21c75c
        if self.total_files > 1:
Packit Service 21c75c
            n = '%d' % (self.done_files + 1)
Packit Service 21c75c
            if len(self.active) > 1:
Packit Service 21c75c
                n += '-%d' % (self.done_files + len(self.active))
Packit Service 21c75c
            text = '(%s/%d): %s' % (n, self.total_files, text)
Packit Service 21c75c
Packit Service 21c75c
        # average rate, total done size, estimated remaining time
Packit Service 21c75c
        if self.rate and self.total_size:
Packit Service 21c75c
            time_eta = format_time((self.total_size - self.done_size) / self.rate)
Packit Service 21c75c
        else:
Packit Service 21c75c
            time_eta = '--:--'
Packit Service 21c75c
        msg = ' %5sB/s | %5sB %9s ETA\r' % (
Packit Service 21c75c
            format_number(self.rate) if self.rate else '---  ',
Packit Service 21c75c
            format_number(self.done_size),
Packit Service 21c75c
            time_eta)
Packit Service 21c75c
        left = _term_width() - len(msg)
Packit Service 21c75c
        bl = (left - 7)//2
Packit Service 21c75c
        if bl > 8:
Packit Service 21c75c
            # use part of the remaining space for progress bar
Packit Service 21c75c
            if self.total_size:
Packit Service 21c75c
                pct = self.done_size * 100 // self.total_size
Packit Service 21c75c
                n, p = divmod(self.done_size * bl * 2 // self.total_size, 2)
Packit Service 21c75c
                bar = '=' * n + '-' * p
Packit Service 21c75c
                msg = '%3d%% [%-*s]%s' % (pct, bl, bar, msg)
Packit Service 21c75c
                left -= bl + 7
Packit Service 21c75c
            else:
Packit Service 21c75c
                n = self.unknown_progres - 3
Packit Service 21c75c
                p = 3
Packit Service 21c75c
                n = 0 if n < 0 else n
Packit Service 21c75c
                bar = ' ' * n + '=' * p
Packit Service 21c75c
                msg = '     [%-*s]%s' % (bl, bar, msg)
Packit Service 21c75c
                left -= bl + 7
Packit Service 21c75c
                self.unknown_progres = self.unknown_progres + 3 if self.unknown_progres + 3 < bl \
Packit Service 21c75c
                    else 0
Packit Service 21c75c
        self.message('%-*.*s%s' % (left, left, text, msg))
Packit Service 21c75c
Packit Service 21c75c
    def end(self, payload, status, err_msg):
Packit Service 21c75c
        start = now = time()
Packit Service 21c75c
        text = unicode(payload)
Packit Service 21c75c
        size = int(payload.download_size)
Packit Service 21c75c
        done = 0
Packit Service 21c75c
Packit Service 21c75c
        # update state
Packit Service 21c75c
        if status == dnf.callback.STATUS_MIRROR:
Packit Service 21c75c
            pass
Packit Service 21c75c
        elif status == dnf.callback.STATUS_DRPM:
Packit Service 21c75c
            self.done_drpm += 1
Packit Service 21c75c
        elif text in self.state:
Packit Service 21c75c
            start, done = self.state.pop(text)
Packit Service 21c75c
            self.active.remove(text)
Packit Service 21c75c
            size -= done
Packit Service 21c75c
            self.done_files += 1
Packit Service 21c75c
            self.done_size += size
Packit Service 21c75c
        elif status == dnf.callback.STATUS_ALREADY_EXISTS:
Packit Service 21c75c
            self.done_files += 1
Packit Service 21c75c
            self.done_size += size
Packit Service 21c75c
Packit Service 21c75c
        if status:
Packit Service 21c75c
            # the error message, no trimming
Packit Service 21c75c
            if status is dnf.callback.STATUS_DRPM and self.total_drpm > 1:
Packit Service 21c75c
                msg = '[%s %d/%d] %s: ' % (self.STATUS_2_STR[status], self.done_drpm,
Packit Service 21c75c
                                           self.total_drpm, text)
Packit Service 21c75c
            else:
Packit Service 21c75c
                msg = '[%s] %s: ' % (self.STATUS_2_STR[status], text)
Packit Service 21c75c
            left = _term_width() - len(msg) - 1
Packit Service 21c75c
            msg = '%s%-*s\n' % (msg, left, err_msg)
Packit Service 21c75c
        else:
Packit Service 21c75c
            if self.total_files > 1:
Packit Service 21c75c
                text = '(%d/%d): %s' % (self.done_files, self.total_files, text)
Packit Service 21c75c
Packit Service 21c75c
            # average rate, file size, download time
Packit Service 21c75c
            tm = max(now - start, 0.001)
Packit Service 21c75c
            msg = ' %5sB/s | %5sB %9s    \n' % (
Packit Service 21c75c
                format_number(float(done) / tm),
Packit Service 21c75c
                format_number(done),
Packit Service 21c75c
                format_time(tm))
Packit Service 21c75c
            left = _term_width() - len(msg)
Packit Service 21c75c
            msg = '%-*.*s%s' % (left, left, text, msg)
Packit Service 21c75c
        self.message(msg)
Packit Service 21c75c
Packit Service 21c75c
        # now there's a blank line. fill it if possible.
Packit Service 21c75c
        if self.active:
Packit Service 21c75c
            self._update(now)