monkee.ch/SickGear
1
0
Fork 0
mirror of https://github.com/SickGear/SickGear.git synced 2024-11-25 14:25:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
SickGear/lib/rtorrent/torrent.py
SickGear e56303798c Change bump to major version 3.xx to signal that this branch supports Python3+ only. 
Initial SickGear for Python 3.
2023-02-09 13:41:15 +00:00

640 lines
22 KiB
Python
Raw Blame History

# Copyright (c) 2013 Chris Lucas, <chris@chrisjlucas.com>
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
from . import rpc
from .common import safe_repr
from .file import File, methods as file_methods
from .peer import Peer, methods as peer_methods
from .rpc import Method
from .tracker import Tracker, methods as tracker_methods
from _23 import filter_iter, filter_list
class Torrent(object):
"""Represents an individual torrent within a L{RTorrent} instance."""
def __init__(self, _rt_obj, info_hash, **kwargs):
self._rt_obj = _rt_obj
self.info_hash = info_hash # : info hash for the torrent
self.hash_checking = None
self.multicall_add = None
self.name = None
self.rpc_id = self.info_hash # : unique id to pass to rTorrent
for k in kwargs:
setattr(self, k, kwargs.get(k, None))
self.peers = []
self.trackers = []
self.files = []
self.hashing = None
self.state = None
self.directory = None
self.active = None
self._call_custom_methods()
def __repr__(self):
return safe_repr('Torrent(info_hash="{0}" name="{1}")',
self.info_hash, self.name or '')
def _call_custom_methods(self):
"""only calls methods that check instance variables."""
self._is_hash_checking_queued()
self._is_started()
self._is_paused()
def get_peers(self):
"""Get list of Peer instances for given torrent.
@return: L{Peer} instances
@rtype: list
@note: also assigns return value to self.peers
"""
self.peers = []
retriever_methods = filter_list(lambda m: m.is_retriever() and m.is_available(self._rt_obj), peer_methods)
mc = rpc.Multicall(self)
# need to leave 2nd arg empty (dunno why)
mc.add('p.multicall', self.info_hash, '', *[method.rpc_call + '=' for method in retriever_methods])
results = mc.call()[0] # only sent one call, only need first result
for result in results:
results_dict = {}
# build results_dict
for mc, r in zip(retriever_methods, result):
results_dict[mc.varname] = rpc.process_result(mc, r)
self.peers.append(Peer(self._rt_obj, self.info_hash, **results_dict))
return self.peers
def get_trackers(self):
"""Get list of Tracker instances for given torrent.
@return: L{Tracker} instances
@rtype: list
@note: also assigns return value to self.trackers
"""
self.trackers = []
retriever_methods = filter_list(lambda m: m.is_retriever() and m.is_available(self._rt_obj), tracker_methods)
mc = rpc.Multicall(self)
# need to leave 2nd arg empty (dunno why)
mc.add('t.multicall', self.info_hash, '', *[method.rpc_call + '=' for method in retriever_methods])
results = mc.call()[0] # only sent one call, only need first result
for result in results:
results_dict = {}
# build results_dict
for mc, r in zip(retriever_methods, result):
results_dict[mc.varname] = rpc.process_result(mc, r)
self.trackers.append(Tracker(self._rt_obj, self.info_hash, **results_dict))
return self.trackers
def get_files(self):
"""Get list of File instances for given torrent.
@return: L{File} instances
@rtype: list
@note: also assigns return value to self.files
"""
self.files = []
retriever_methods = filter_list(lambda m: m.is_retriever() and m.is_available(self._rt_obj), file_methods)
mc = rpc.Multicall(self)
# 2nd arg can be anything, but it'll return all files in torrent
mc.add('f.multicall', self.info_hash, '', *[method.rpc_call + '=' for method in retriever_methods])
results = mc.call()[0] # only sent one call, only need first result
offset_method_index = retriever_methods.index(rpc.find_method('f.get_offset'))
# make a list of the offsets of all the files, sort appropriately
offset_list = sorted([r[offset_method_index] for r in results])
for result in results:
results_dict = {}
# build results_dict
for mc, r in zip(retriever_methods, result):
results_dict[mc.varname] = rpc.process_result(mc, r)
# get proper index positions for each file (based on the file
# offset)
f_index = offset_list.index(results_dict['offset'])
self.files.append(File(self._rt_obj, self.info_hash, f_index, **results_dict))
return self.files
def _get_method(self, *choices):
try:
return next(filter_iter(lambda method: self._rt_obj.method_exists(method), choices))
except (BaseException, Exception):
pass
def get_state(self):
method = self._get_method(*('d.get_state', 'd.state'))
if method:
mc = rpc.Multicall(self)
self.multicall_add(mc, method)
return mc.call()[-1]
def set_directory(self, d):
"""Modify download directory
@note: Needs to stop torrent in order to change the directory.
Also doesn't restart after directory is set, that must be called
separately.
"""
method = self._get_method(*('d.set_directory', 'd.directory.set'))
if method:
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.try_stop')
self.multicall_add(mc, method, d)
self.directory = mc.call()[-1]
def set_directory_base(self, d):
"""Modify base download directory
@note: Needs to stop torrent in order to change the directory.
Also doesn't restart after directory is set, that must be called
separately.
"""
method = self._get_method(*('d.set_directory_base', 'd.directory_base.set'))
if method:
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.try_stop')
self.multicall_add(mc, method, d)
def start(self):
"""Start the torrent"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.try_start')
self.multicall_add(mc, 'd.is_active')
self.active = mc.call()[-1]
return self.active
def stop(self):
""""Stop the torrent"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.try_stop')
self.multicall_add(mc, 'd.is_active')
self.active = mc.call()[-1]
return self.active
def pause(self):
"""Pause the torrent"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.pause')
return mc.call()[-1]
def resume(self):
"""Resume the torrent"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.resume')
return mc.call()[-1]
def close(self):
"""Close the torrent and it's files"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.close')
return mc.call()[-1]
def erase(self):
"""Delete the torrent
@note: doesn't delete the downloaded files"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.erase')
return mc.call()[-1]
def check_hash(self):
"""(Re)hash check the torrent"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.check_hash')
return mc.call()[-1]
def poll(self):
"""poll rTorrent to get latest peer/tracker/file information"""
self.get_peers()
self.get_trackers()
self.get_files()
def update(self):
"""Refresh torrent data
@note: All fields are stored as attributes to self.
@return: None
"""
mc = rpc.Multicall(self)
for method in filter_iter(lambda m: m.is_retriever() and m.is_available(self._rt_obj), methods):
mc.add(method, self.rpc_id)
mc.call()
# custom functions (only call private methods, since they only check
# local variables and are therefore faster)
self._call_custom_methods()
def accept_seeders(self, accept_seeds):
"""Enable/disable whether the torrent connects to seeders
@param accept_seeds: enable/disable accepting seeders
@type accept_seeds: bool"""
mc = rpc.Multicall(self)
self.multicall_add(mc, ('d.accepting_seeders.disable', 'd.accepting_seeders.enable')[accept_seeds])
return mc.call()[-1]
def announce(self):
"""Announce torrent info to tracker(s)"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.tracker_announce')
return mc.call()[-1]
@staticmethod
def _assert_custom_key_valid(key):
assert type(key) == int and 0 < key < 6, 'key must be an integer between 1-5'
def get_custom(self, key):
"""
Get custom value
@param key: the index for the custom field (between 1-5)
@type key: int
@rtype: str
"""
self._assert_custom_key_valid(key)
field = 'custom%s' % key
method = self._get_method(*('d.get_%s' % field, 'd.%s' % field))
if method:
mc = rpc.Multicall(self)
self.multicall_add(mc, method)
setattr(self, field, mc.call()[-1])
return getattr(self, field)
def set_custom(self, key, value):
"""
Set custom value
@param key: the index for the custom field (between 1-5)
@type key: int
@param value: the value to be stored
@type value: str
@return: if successful, value will be returned
@rtype: str
"""
self._assert_custom_key_valid(key)
field = 'custom%s' % key
method = self._get_method(*('d.set_%s' % field, 'd.%s.set' % field))
if method:
mc = rpc.Multicall(self)
self.multicall_add(mc, method, value)
return mc.call()[-1]
def set_visible(self, view, visible=True):
p = self._rt_obj.get_connection()
if visible:
return p.view.set_visible(self.info_hash, view)
return p.view.set_not_visible(self.info_hash, view)
def add_tracker(self, group, tracker):
"""
Add tracker to torrent
@param group: The group to add the tracker to
@type group: int
@param tracker: The tracker url
@type tracker: str
@return: if successful, 0
@rtype: int
"""
mc = rpc.Multicall(self)
self.multicall_add(mc, 'd.tracker.insert', group, tracker)
return mc.call()[-1]
############################################################################
# CUSTOM METHODS (Not part of the official rTorrent API)
##########################################################################
def _is_hash_checking_queued(self):
"""Only checks instance variables, shouldn't be called directly"""
# if hashing == 3, then torrent is marked for hash checking
# if hash_checking == False, then torrent is waiting to be checked
self.hash_checking_queued = (self.hashing == 3 and
self.hash_checking is False)
return self.hash_checking_queued
def is_hash_checking_queued(self):
"""Check if torrent is waiting to be hash checked
@note: Variable where the result for this method is stored Torrent.hash_checking_queued"""
method = self._get_method(*('d.get_hashing', 'd.hashing'))
if method:
mc = rpc.Multicall(self)
self.multicall_add(mc, method)
self.multicall_add(mc, 'd.is_hash_checking')
results = mc.call()
setattr(self, 'hashing', results[0])
setattr(self, 'hash_checking', results[1])
return self._is_hash_checking_queued()
def _is_paused(self):
"""Only checks instance variables, shouldn't be called directly"""
self.paused = (self.state == 0)
return self.paused
def is_paused(self):
"""Check if torrent is paused
@note: Variable where the result for this method is stored: Torrent.paused"""
self.get_state()
return self._is_paused()
def _is_started(self):
"""Only checks instance variables, shouldn't be called directly"""
self.started = (self.state == 1)
return self.started
def is_started(self):
"""Check if torrent is started
@note: Variable where the result for this method is stored: Torrent.started"""
self.get_state()
return self._is_started()
methods = [
# RETRIEVERS
Method(Torrent, 'is_hash_checked', 'd.is_hash_checked',
boolean=True,
),
Method(Torrent, 'is_hash_checking', 'd.is_hash_checking',
boolean=True,
),
Method(Torrent, 'get_peers_max', 'd.get_peers_max',
aliases=('d.peers_max',)),
Method(Torrent, 'get_tracker_focus', 'd.get_tracker_focus',
aliases=('d.tracker_focus',)),
Method(Torrent, 'get_skip_total', 'd.get_skip_total',
aliases=('d.skip.total',)),
Method(Torrent, 'get_state', 'd.get_state',
aliases=('d.state',)),
Method(Torrent, 'get_peer_exchange', 'd.get_peer_exchange',
aliases=('d.peer_exchange',)),
Method(Torrent, 'get_down_rate', 'd.get_down_rate',
aliases=('d.down.rate',)),
Method(Torrent, 'get_connection_seed', 'd.get_connection_seed',
aliases=('d.connection_seed',)),
Method(Torrent, 'get_uploads_max', 'd.get_uploads_max',
aliases=('d.uploads_max',)),
Method(Torrent, 'get_priority_str', 'd.get_priority_str',
aliases=('d.priority_str',)),
Method(Torrent, 'is_open', 'd.is_open',
boolean=True,
),
Method(Torrent, 'get_peers_min', 'd.get_peers_min',
aliases=('d.peers_min',)),
Method(Torrent, 'get_peers_complete', 'd.get_peers_complete',
aliases=('d.peers_complete',)),
Method(Torrent, 'get_tracker_numwant', 'd.get_tracker_numwant',
aliases=('d.tracker_numwant',)),
Method(Torrent, 'get_connection_current', 'd.get_connection_current',
aliases=('d.connection_current',)),
Method(Torrent, 'is_complete', 'd.get_complete',
boolean=True,
aliases=('d.complete',)
),
Method(Torrent, 'get_peers_connected', 'd.get_peers_connected',
aliases=('d.peers_connected',)),
Method(Torrent, 'get_chunk_size', 'd.get_chunk_size',
aliases=('d.chunk_size',)),
Method(Torrent, 'get_state_counter', 'd.get_state_counter',
aliases=('d.state_counter',)),
Method(Torrent, 'get_base_filename', 'd.get_base_filename',
aliases=('d.base_filename',)),
Method(Torrent, 'get_state_changed', 'd.get_state_changed',
aliases=('d.state_changed',)),
Method(Torrent, 'get_peers_not_connected', 'd.get_peers_not_connected',
aliases=('d.peers_not_connected',)),
Method(Torrent, 'get_directory', 'd.get_directory',
aliases=('d.directory',)),
Method(Torrent, 'is_incomplete', 'd.incomplete',
boolean=True,
),
Method(Torrent, 'get_tracker_size', 'd.get_tracker_size',
aliases=('d.tracker_size',)),
Method(Torrent, 'is_multi_file', 'd.is_multi_file',
boolean=True,
),
Method(Torrent, 'get_local_id', 'd.get_local_id',
aliases=('d.local_id',)),
Method(Torrent, 'get_ratio', 'd.get_ratio',
post_process_func=lambda x: x / 1000.0,
aliases=('d.ratio',)
),
Method(Torrent, 'get_loaded_file', 'd.get_loaded_file',
aliases=('d.loaded_file',)),
Method(Torrent, 'get_max_file_size', 'd.get_max_file_size',
aliases=('d.max_file_size',)),
Method(Torrent, 'get_size_chunks', 'd.get_size_chunks',
aliases=('d.size_chunks',)),
Method(Torrent, 'is_pex_active', 'd.is_pex_active',
boolean=True,
),
Method(Torrent, 'get_hashing', 'd.get_hashing',
aliases=('d.hashing',)),
Method(Torrent, 'get_bitfield', 'd.get_bitfield',
aliases=('d.bitfield',)),
Method(Torrent, 'get_local_id_html', 'd.get_local_id_html',
aliases=('d.local_id_html',)),
Method(Torrent, 'get_connection_leech', 'd.get_connection_leech',
aliases=('d.connection_leech',)),
Method(Torrent, 'get_peers_accounted', 'd.get_peers_accounted',
aliases=('d.peers_accounted',)),
Method(Torrent, 'get_message', 'd.get_message',
aliases=('d.message',)),
Method(Torrent, 'is_active', 'd.is_active',
boolean=True,
),
Method(Torrent, 'get_size_bytes', 'd.get_size_bytes',
aliases=('d.size_bytes',)),
Method(Torrent, 'get_ignore_commands', 'd.get_ignore_commands',
aliases=('d.ignore_commands',)),
Method(Torrent, 'get_creation_date', 'd.get_creation_date',
aliases=('d.creation_date',)),
Method(Torrent, 'get_base_path', 'd.get_base_path',
aliases=('d.base_path',)),
Method(Torrent, 'get_left_bytes', 'd.get_left_bytes',
aliases=('d.left_bytes',)),
Method(Torrent, 'get_size_files', 'd.get_size_files',
aliases=('d.size_files',)),
Method(Torrent, 'get_size_pex', 'd.get_size_pex',
aliases=('d.size_pex',)),
Method(Torrent, 'is_private', 'd.is_private',
boolean=True,
),
Method(Torrent, 'get_max_size_pex', 'd.get_max_size_pex'),
Method(Torrent, 'get_num_chunks_hashed', 'd.get_chunks_hashed',
aliases=('get_chunks_hashed', 'd.chunks_hashed')),
Method(Torrent, 'get_num_chunks_wanted', 'd.wanted_chunks'),
Method(Torrent, 'get_priority', 'd.get_priority',
aliases=('d.priority',)),
Method(Torrent, 'get_skip_rate', 'd.get_skip_rate',
aliases=('d.skip.rate',)),
Method(Torrent, 'get_completed_bytes', 'd.get_completed_bytes',
aliases=('d.completed_bytes',)),
Method(Torrent, 'get_name', 'd.get_name',
aliases=('d.name',)),
Method(Torrent, 'get_completed_chunks', 'd.get_completed_chunks',
aliases=('d.completed_chunks',)),
Method(Torrent, 'get_throttle_name', 'd.get_throttle_name',
aliases=('d.throttle_name',)),
Method(Torrent, 'get_free_diskspace', 'd.get_free_diskspace',
aliases=('d.free_diskspace',)),
Method(Torrent, 'get_directory_base', 'd.get_directory_base',
aliases=('d.directory_base',)),
Method(Torrent, 'get_hashing_failed', 'd.get_hashing_failed',
aliases=('d.hashing_failed',)),
Method(Torrent, 'get_tied_to_file', 'd.get_tied_to_file',
aliases=('d.tied_to_file',)),
Method(Torrent, 'get_down_total', 'd.get_down_total',
aliases=('d.down.total',)),
Method(Torrent, 'get_bytes_done', 'd.get_bytes_done',
aliases=('d.bytes_done',)),
Method(Torrent, 'get_up_rate', 'd.get_up_rate',
aliases=('d.up.rate',)),
Method(Torrent, 'get_up_total', 'd.get_up_total',
aliases=('d.up.total',)),
Method(Torrent, 'is_accepting_seeders', 'd.accepting_seeders',
boolean=True,
),
Method(Torrent, 'get_chunks_seen', 'd.chunks_seen',
min_version=(0, 9, 1),
),
Method(Torrent, 'is_partially_done', 'd.is_partially_done',
boolean=True,
),
Method(Torrent, 'is_not_partially_done', 'd.is_not_partially_done',
boolean=True,
),
Method(Torrent, 'get_time_started', 'd.timestamp.started'),
Method(Torrent, 'get_custom1', 'd.get_custom1',
aliases=('d.custom1',)),
Method(Torrent, 'get_custom2', 'd.get_custom2',
aliases=('d.custom2',)),
Method(Torrent, 'get_custom3', 'd.get_custom3',
aliases=('d.custom3',)),
Method(Torrent, 'get_custom4', 'd.get_custom4',
aliases=('d.custom4',)),
Method(Torrent, 'get_custom5', 'd.get_custom5',
aliases=('d.custom5',)),
# MODIFIERS
Method(Torrent, 'set_uploads_max', 'd.set_uploads_max',
aliases=('d.uploads_max.set',)),
Method(Torrent, 'set_tied_to_file', 'd.set_tied_to_file',
aliases=('d.tied_to_file.set',)),
Method(Torrent, 'set_tracker_numwant', 'd.set_tracker_numwant',
aliases=('d.tracker_numwant.set',)),
Method(Torrent, 'set_priority', 'd.set_priority',
aliases=('d.priority.set',)),
Method(Torrent, 'set_peers_max', 'd.set_peers_max',
aliases=('d.peers_max.set',)),
Method(Torrent, 'set_hashing_failed', 'd.set_hashing_failed',
aliases=('d.hashing_failed.set',)),
Method(Torrent, 'set_message', 'd.set_message',
aliases=('d.message.set',)),
Method(Torrent, 'set_throttle_name', 'd.set_throttle_name',
aliases=('d.throttle_name.set',)),
Method(Torrent, 'set_peers_min', 'd.set_peers_min',
aliases=('d.peers_min.set',)),
Method(Torrent, 'set_ignore_commands', 'd.set_ignore_commands',
aliases=('d.ignore_commands.set',)),
Method(Torrent, 'set_max_file_size', 'd.set_max_file_size',
aliases=('d.max_file_size.set',)),
Method(Torrent, 'set_custom5', 'd.set_custom5',
aliases=('d.custom5.set',)),
Method(Torrent, 'set_custom4', 'd.set_custom4',
aliases=('d.custom4.set',)),
Method(Torrent, 'set_custom2', 'd.set_custom2',
aliases=('d.custom2.set',)),
Method(Torrent, 'set_custom1', 'd.set_custom1',
aliases=('d.custom1.set',)),
Method(Torrent, 'set_custom3', 'd.set_custom3',
aliases=('d.custom3.set',)),
Method(Torrent, 'set_connection_current', 'd.set_connection_current',
aliases=('d.connection_current.set',)),
]
Reference in a new issue View git blame Copy permalink