path: root/deluge/ui/gtk3/torrentview_data_funcs.py

# -*- coding: utf-8 -*-
#
# Copyright (C) 2007, 2008 Andrew Resch <andrewresch@gmail.com>
#
# This file is part of Deluge and is licensed under GNU General Public License 3.0, or later, with
# the additional special exception to link portions of this program with the OpenSSL library.
# See LICENSE for more details.
#

from __future__ import print_function, unicode_literals

import warnings
from functools import partial

import deluge.common as common
import deluge.component as component

from .common import (
    create_blank_pixbuf,
    get_pixbuf_at_size,
    icon_alert,
    icon_checking,
    icon_downloading,
    icon_inactive,
    icon_queued,
    icon_seeding,
)

# Holds the info for which status icon to display based on TORRENT_STATE
ICON_STATE = {
    'Allocating': icon_checking,
    'Checking': icon_checking,
    'Downloading': icon_downloading,
    'Seeding': icon_seeding,
    'Paused': icon_inactive,
    'Error': icon_alert,
    'Queued': icon_queued,
    'Moving': icon_checking,
}

# Cache the key used to calculate the current value set for the specific cell
# renderer. This is much cheaper than fetch the current value and test if
# it's equal.
func_last_value = {
    'cell_data_time': None,
    'cell_data_ratio_seeds_peers': None,
    'cell_data_ratio_ratio': None,
    'cell_data_ratio_avail': None,
    'cell_data_date_added': None,
    'cell_data_date_completed': None,
    'cell_data_date_or_never': None,
    'cell_data_speed_limit_down': None,
    'cell_data_speed_limit_up': None,
    'cell_data_trackericon': None,
    'cell_data_statusicon': None,
    'cell_data_queue': None,
    'cell_data_progress': [None, None],
    'cell_data_peer_progress': None,
}


def cell_data_statusicon(column, cell, model, row, data):
    """Display text with an icon"""
    try:
        state = model.get_value(row, data)

        if func_last_value['cell_data_statusicon'] == state:
            return
        func_last_value['cell_data_statusicon'] = state

        icon = ICON_STATE[state]

        # Supress Warning: g_object_set_qdata: assertion `G_IS_OBJECT (object)' failed
        original_filters = warnings.filters[:]
        warnings.simplefilter('ignore')
        try:
            cell.set_property('pixbuf', icon)
        finally:
            warnings.filters = original_filters

    except KeyError:
        pass


def set_tracker_icon(tracker_icon, cell):
    if tracker_icon:
        pixbuf = tracker_icon.get_cached_icon()
        if pixbuf is None:
            pixbuf = get_pixbuf_at_size(tracker_icon.get_filename(), 16)
            tracker_icon.set_cached_icon(pixbuf)
    else:
        pixbuf = create_blank_pixbuf()

    # Suppress Warning: g_object_set_qdata: assertion `G_IS_OBJECT (object)' failed
    with warnings.catch_warnings():
        warnings.simplefilter('ignore')
        cell.set_property('pixbuf', pixbuf)


def cell_data_trackericon(column, cell, model, row, data):
    host = model[row][data]

    if func_last_value['cell_data_trackericon'] == host:
        return
    if host:
        if not component.get('TrackerIcons').has(host):
            # Set blank icon while waiting for the icon to be loaded
            set_tracker_icon(None, cell)
            component.get('TrackerIcons').fetch(host)
            func_last_value['cell_data_trackericon'] = None
        else:
            set_tracker_icon(component.get('TrackerIcons').get(host), cell)
            # Only set the last value when we have found the icon
            func_last_value['cell_data_trackericon'] = host
    else:
        set_tracker_icon(None, cell)
        func_last_value['cell_data_trackericon'] = None


def cell_data_progress(column, cell, model, row, data):
    """Display progress bar with text"""
    (value, state_str) = model.get(row, *data)
    if func_last_value['cell_data_progress'][0] != value:
        func_last_value['cell_data_progress'][0] = value
        cell.set_property('value', value)

    # Marked for translate states text are in filtertreeview
    textstr = _(state_str)
    if state_str not in ('Error', 'Seeding') and value < 100:
        textstr = '%s %i%%' % (textstr, value)

    if func_last_value['cell_data_progress'][1] != textstr:
        func_last_value['cell_data_progress'][1] = textstr
        cell.set_property('text', textstr)


def cell_data_peer_progress(column, cell, model, row, data):
    value = model.get_value(row, data) * 100
    if func_last_value['cell_data_peer_progress'] != value:
        func_last_value['cell_data_peer_progress'] = value
        cell.set_property('value', value)
        cell.set_property('text', '%i%%' % value)


def cell_data_queue(column, cell, model, row, data):
    value = model.get_value(row, data)

    if func_last_value['cell_data_queue'] == value:
        return
    func_last_value['cell_data_queue'] = value

    if value < 0:
        cell.set_property('text', '')
    else:
        cell.set_property('text', str(value + 1))


def cell_data_speed(cell, model, row, data):
    """Display value as a speed, eg. 2 KiB/s"""
    speed = model.get_value(row, data)

    if speed > 0:
        speed_str = common.fspeed(speed, shortform=True)
        cell.set_property(
            'markup', '{0} <small>{1}</small>'.format(*tuple(speed_str.split()))
        )
    else:
        cell.set_property('text', '')


def cell_data_speed_down(column, cell, model, row, data):
    """Display value as a speed, eg. 2 KiB/s"""
    cell_data_speed(cell, model, row, data)


def cell_data_speed_up(column, cell, model, row, data):
    """Display value as a speed, eg. 2 KiB/s"""
    cell_data_speed(cell, model, row, data)


def cell_data_speed_limit(cell, model, row, data, cache_key):
    """Display value as a speed, eg. 2 KiB/s"""
    speed = model.get_value(row, data)

    if func_last_value[cache_key] == speed:
        return
    func_last_value[cache_key] = speed

    if speed > 0:
        speed_str = common.fspeed(speed * 1024, shortform=True)
        cell.set_property(
            'markup', '{0} <small>{1}</small>'.format(*tuple(speed_str.split()))
        )
    else:
        cell.set_property('text', '')


def cell_data_speed_limit_down(column, cell, model, row, data):
    cell_data_speed_limit(cell, model, row, data, 'cell_data_speed_limit_down')


def cell_data_speed_limit_up(column, cell, model, row, data):
    cell_data_speed_limit(cell, model, row, data, 'cell_data_speed_limit_up')


def cell_data_size(column, cell, model, row, data):
    """Display value in terms of size, eg. 2 MB"""
    size = model.get_value(row, data)
    cell.set_property('text', common.fsize(size, shortform=True))


def cell_data_peer(column, cell, model, row, data):
    """Display values as 'value1 (value2)'"""
    (first, second) = model.get(row, *data)
    # Only display a (total) if second is greater than -1
    if second > -1:
        cell.set_property('text', '%d (%d)' % (first, second))
    else:
        cell.set_property('text', '%d' % first)


def cell_data_time(column, cell, model, row, data):
    """Display value as time, eg 1m10s"""
    time = model.get_value(row, data)
    if func_last_value['cell_data_time'] == time:
        return
    func_last_value['cell_data_time'] = time

    if time <= 0:
        time_str = ''
    else:
        time_str = common.ftime(time)
    cell.set_property('text', time_str)


def cell_data_ratio(cell, model, row, data, cache_key):
    """Display value as a ratio with a precision of 2."""
    ratio = model.get_value(row, data)
    # Previous value in cell is the same as for this value, so ignore
    if func_last_value[cache_key] == ratio:
        return
    func_last_value[cache_key] = ratio
    cell.set_property(
        'text', '∞' if ratio < 0 else ('%.1f' % ratio).rstrip('0').rstrip('.')
    )


def cell_data_ratio_seeds_peers(column, cell, model, row, data):
    cell_data_ratio(cell, model, row, data, 'cell_data_ratio_seeds_peers')


def cell_data_ratio_ratio(column, cell, model, row, data):
    cell_data_ratio(cell, model, row, data, 'cell_data_ratio_ratio')


def cell_data_ratio_avail(column, cell, model, row, data):
    cell_data_ratio(cell, model, row, data, 'cell_data_ratio_avail')


def cell_data_date(column, cell, model, row, data, key):
    """Display value as date, eg 05/05/08"""
    date = model.get_value(row, data)

    if func_last_value[key] == date:
        return
    func_last_value[key] = date

    date_str = common.fdate(date, date_only=True) if date > 0 else ''
    cell.set_property('text', date_str)


cell_data_date_added = partial(cell_data_date, key='cell_data_date_added')
cell_data_date_completed = partial(cell_data_date, key='cell_data_date_completed')


def cell_data_date_or_never(column, cell, model, row, data):
    """Display value as date, eg 05/05/08 or Never"""
    value = model.get_value(row, data)

    if func_last_value['cell_data_date_or_never'] == value:
        return
    func_last_value['cell_data_date_or_never'] = value

    date_str = common.fdate(value, date_only=True) if value > 0 else _('Never')
    cell.set_property('text', date_str)