class TestTriblerConfig(TriblerCoreTest):
"""
This class contains tests for the tribler configuration file.
"""
def setUp(self, annotate=True):
super(TestTriblerConfig, self).setUp(annotate=annotate)
self.mock_session = MockObject()
self.mock_session.get_state_dir = lambda: self.session_base_dir
self.tribler_conf = TriblerConfig(self.mock_session)
self.assertIsNotNone(self.tribler_conf)
self.assertEqual(self.tribler_conf.config['user_download_states'], {})
def test_get_download_state(self):
self.assertIsNone(self.tribler_conf.get_download_state("abc"))
self.tribler_conf.set_download_state("abc", "test")
self.assertEqual(self.tribler_conf.get_download_state("abc"), "test")
def test_remove_download_state(self):
self.tribler_conf.set_download_state("abc", "test")
self.assertIsNotNone(self.tribler_conf.get_download_state("abc"))
self.tribler_conf.remove_download_state("abc")
self.assertIsNone(self.tribler_conf.get_download_state("abc"))
def test_set_download_state(self):
self.tribler_conf.set_download_state("abc", "test")
self.assertEqual(self.tribler_conf.get_download_state("abc"), "test")
def test_get_download_states(self):
self.tribler_conf.set_download_state("abc", "test1")
self.tribler_conf.set_download_state("def", "test2")
self.assertDictEqual(self.tribler_conf.get_download_states(), {"abc": "test1", "def": "test2"})
def test_set_family_filter(self):
self.tribler_conf.set_family_filter_enabled(False)
self.assertFalse(self.tribler_conf.get_family_filter_enabled())
class Session(SessionConfigInterface):
"""
A Session is a running instance of the Tribler Core and the Core's central
class. It implements the SessionConfigInterface which can be used to change
session parameters at runtime (for selected parameters).
cf. libtorrent session
"""
__single = None
def __init__(self,
scfg=None,
ignore_singleton=False,
autoload_discovery=True):
"""
A Session object is created which is configured following a copy of the
SessionStartupConfig scfg. (copy constructor used internally)
@param scfg SessionStartupConfig object or None, in which case we
look for a saved session in the default location (state dir). If
we can't find it, we create a new SessionStartupConfig() object to
serve as startup config. Next, the config is saved in the directory
indicated by its 'state_dir' attribute.
In the current implementation only a single session instance can exist
at a time in a process. The ignore_singleton flag is used for testing.
"""
addObserver(self.unhandled_error_observer)
patch_crypto_be_discovery()
if not ignore_singleton:
if Session.__single:
raise RuntimeError("Session is singleton")
Session.__single = self
self._logger = logging.getLogger(self.__class__.__name__)
self.ignore_singleton = ignore_singleton
self.sesslock = NoDispersyRLock()
# Determine startup config to use
if scfg is None: # If no override
scfg = SessionStartupConfig.load()
else: # overrides any saved config
# Work from copy
scfg = SessionStartupConfig(copy.copy(scfg.sessconfig))
def create_dir(fullpath):
if not os.path.isdir(fullpath):
os.makedirs(fullpath)
def set_and_create_dir(dirname, setter, default_dir):
if dirname is None:
setter(default_dir)
create_dir(dirname or default_dir)
state_dir = scfg.get_state_dir()
set_and_create_dir(state_dir, scfg.set_state_dir, state_dir)
set_and_create_dir(
scfg.get_torrent_store_dir(), scfg.set_torrent_store_dir,
os.path.join(scfg.get_state_dir(), STATEDIR_TORRENT_STORE_DIR))
# metadata store
set_and_create_dir(
scfg.get_metadata_store_dir(), scfg.set_metadata_store_dir,
os.path.join(scfg.get_state_dir(), STATEDIR_METADATA_STORE_DIR))
set_and_create_dir(
scfg.get_peer_icon_path(), scfg.set_peer_icon_path,
os.path.join(scfg.get_state_dir(), STATEDIR_PEERICON_DIR))
create_dir(os.path.join(scfg.get_state_dir(), u"sqlite"))
create_dir(os.path.join(scfg.get_state_dir(), STATEDIR_DLPSTATE_DIR))
# Reset the nickname to something not related to the host name, it was
# really silly to have this default on the first place.
# TODO: Maybe move this to the upgrader?
if socket.gethostname().decode('utf-8',
'replace') in scfg.get_nickname():
scfg.set_nickname("Tribler user")
if GOTM2CRYPTO:
permidmod.init()
# Set params that depend on state_dir
#
# 1. keypair
#
pairfilename = scfg.get_permid_keypair_filename()
if os.path.exists(pairfilename):
self.keypair = permidmod.read_keypair(pairfilename)
else:
self.keypair = permidmod.generate_keypair()
# Save keypair
pubfilename = os.path.join(scfg.get_state_dir(), 'ecpub.pem')
permidmod.save_keypair(self.keypair, pairfilename)
permidmod.save_pub_key(self.keypair, pubfilename)
multichain_pairfilename = scfg.get_multichain_permid_keypair_filename(
)
if os.path.exists(multichain_pairfilename):
self.multichain_keypair = permidmod.read_keypair_multichain(
multichain_pairfilename)
else:
self.multichain_keypair = permidmod.generate_keypair_multichain(
)
# Save keypair
multichain_pubfilename = os.path.join(scfg.get_state_dir(),
'ecpub_multichain.pem')
permidmod.save_keypair_multichain(self.multichain_keypair,
multichain_pairfilename)
permidmod.save_pub_key_multichain(self.multichain_keypair,
multichain_pubfilename)
if not scfg.get_megacache():
scfg.set_torrent_checking(0)
self.sessconfig = scfg.sessconfig
self.sessconfig.lock = self.sesslock
self.selected_ports = scfg.selected_ports
# Claim all random ports
self.get_listen_port()
self.get_dispersy_port()
self.get_mainline_dht_listen_port()
self.get_videoserver_port()
self.get_anon_listen_port()
self.get_tunnel_community_socks5_listen_ports()
# Create handler for calling back the user via separate threads
self.lm = TriblerLaunchMany()
self.notifier = Notifier()
# Checkpoint startup config
self.save_session_config()
self.sqlite_db = None
self.upgrader = None
self.dispersy_member = None
self.autoload_discovery = autoload_discovery
self.tribler_config = TriblerConfig(self)
self.setup_tribler_gui_config()
#
# Class methods
#
@staticmethod
def get_instance(*args, **kw):
""" Returns the Session singleton if it exists or otherwise
creates it first, in which case you need to pass the constructor
params.
@return Session."""
if Session.__single is None:
Session(*args, **kw)
return Session.__single
@staticmethod
def has_instance():
return Session.__single is not None
@staticmethod
def del_instance():
Session.__single = None
def unhandled_error_observer(self, event):
"""
This method is called when an unhandled error in Tribler is observed. Broadcasts the tribler_exception event.
"""
if event['isError']:
text = ""
if 'log_legacy' in event and 'log_text' in event:
text = event['log_text']
elif 'log_failure' in event:
text = str(event['log_failure'])
if self.lm.api_manager and len(text) > 0:
self.lm.api_manager.root_endpoint.events_endpoint.on_tribler_exception(
text)
self.lm.api_manager.root_endpoint.state_endpoint.on_tribler_exception(
text)
#
# Public methods
#
def setup_tribler_gui_config(self):
"""
Initialize the TriblerGUI configuration file and make sure that we have all required values.
"""
configfilepath = os.path.join(self.get_state_dir(), STATEDIR_GUICONFIG)
gui_config = CallbackConfigParser()
DefaultDownloadStartupConfig.getInstance().set_dest_dir(
get_default_dest_dir())
# Load the config file.
if os.path.exists(configfilepath):
gui_config.read_file(configfilepath, 'utf-8-sig')
if not gui_config.has_section('Tribler'):
gui_config.add_section('Tribler')
for k, v in tribler_defaults['Tribler'].iteritems():
if not gui_config.has_option(k, v):
gui_config.set('Tribler', k, v)
if not gui_config.has_section('downloadconfig'):
gui_config.add_section('downloadconfig')
for k, v in DefaultDownloadStartupConfig.getInstance(
).dlconfig._sections['downloadconfig'].iteritems():
if not gui_config.has_option(k, v):
gui_config.set('downloadconfig', k, v)
# Make sure we use the same ConfigParser instance for both Utility and DefaultDownloadStartupConfig.
DefaultDownloadStartupConfig.getInstance().dlconfig = gui_config
gui_config.write_file(configfilepath)
def start_download_from_uri(self, uri, dconfig=None):
"""
Start a download from an argument. This argument can be of the following type:
-http: Start a download from a torrent file at the given url.
-magnet: Start a download from a torrent file by using a magnet link.
-file: Start a download from a torrent file at given location.
:param uri: The argument that specifies the location of the torrent to be downloaded.
:param dconfig: An optional configuration for the download.
:return: A deferred that fires when a download has been added to the Tribler core.
"""
if self.get_libtorrent():
return self.lm.ltmgr.start_download_from_uri(uri, dconfig=dconfig)
raise OperationNotEnabledByConfigurationException()
def start_download_from_tdef(self,
tdef,
dcfg=None,
initialdlstatus=None,
hidden=False):
"""
Creates a Download object and adds it to the session. The passed
ContentDef and DownloadStartupConfig are copied into the new Download
object. The Download is then started and checkpointed.
If a checkpointed version of the Download is found, that is restarted
overriding the saved DownloadStartupConfig if "dcfg" is not None.
@param tdef A finalized TorrentDef
@param dcfg DownloadStartupConfig or None, in which case
a new DownloadStartupConfig() is created with its default settings
and the result becomes the runtime config of this Download.
@param initialdlstatus The initial download status of this Download
or None. This enables the caller to create a Download in e.g.
DLSTATUS_STOPPED state instead.
@param hidden Whether this torrent should be added to the mypreference table
@return Download
"""
# locking by lm
if self.get_libtorrent():
return self.lm.add(tdef,
dcfg,
initialdlstatus=initialdlstatus,
hidden=hidden)
raise OperationNotEnabledByConfigurationException()
def resume_download_from_file(self, filename):
"""
Recreates Download from resume file
@return a Download object.
Note: this cannot be made into a method of Download, as the Download
needs to be bound to a session, it cannot exist independently.
"""
raise NotYetImplementedException()
def get_downloads(self):
"""
Returns a copy of the list of Downloads.
@return A list of Download objects.
"""
# locking by lm
return self.lm.get_downloads()
def get_download(self, infohash):
"""
Returns the Download object for this hash.
@return A Donwload Object.
"""
# locking by lm
return self.lm.get_download(infohash)
def has_download(self, infohash):
"""
Checks if the torrent download already exists.
:param infohash: The torrent infohash.
:return: True or False indicating if the torrent download already exists.
"""
return self.lm.download_exists(infohash)
def remove_download(self,
d,
removecontent=False,
removestate=True,
hidden=False):
"""
Stops the download and removes it from the session.
@param d The Download to remove
@param removecontent Whether to delete the already downloaded content
from disk.
@param removestate Whether to delete the metadata files of the downloaded
content from disk.
@param hidden Whether this torrent is added to the mypreference table and this entry should be
removed
"""
# locking by lm
self.lm.remove(d,
removecontent=removecontent,
removestate=removestate,
hidden=hidden)
def remove_download_by_id(self,
infohash,
removecontent=False,
removestate=True):
"""
@param infohash The Download to remove
@param removecontent Whether to delete the already downloaded content
from disk.
!We can only remove content when the download object is found, otherwise only
the state is removed.
"""
downloadList = self.get_downloads()
for download in downloadList:
if download.get_def().get_infohash() == infohash:
self.remove_download(download, removecontent, removestate)
self.tribler_config.remove_download_state(infohash)
return
self.lm.remove_id(infohash)
def set_download_states_callback(self, usercallback, interval=1.0):
"""
See Download.set_state_callback. Calls usercallback with a list of
DownloadStates, one for each Download in the Session as first argument.
The usercallback must return a tuple (when,getpeerlist) that indicates
when to reinvoke the callback again (as a number of seconds from now,
or < 0.0 if not at all) and whether to also include the details of
the connected peers in the DownloadStates on that next call.
The callback will be called by a popup thread which can be used
indefinitely (within reason) by the higher level code.
@param usercallback A function adhering to the above spec.
"""
self.lm.set_download_states_callback(usercallback, interval)
#
# Config parameters that only exist at runtime
#
def get_permid(self):
""" Returns the PermID of the Session, as determined by the
SessionConfig.set_permid() parameter. A PermID is a public key
@return The PermID encoded in a string in DER format. """
return str(self.keypair.pub().get_der())
def get_current_startup_config_copy(self):
""" Returns a SessionStartupConfig that is a copy of the current runtime
SessionConfig.
@return SessionStartupConfig
"""
# Called by any thread
with self.sesslock:
sessconfig = copy.copy(self.sessconfig)
sessconfig.set_callback(None)
return SessionStartupConfig(sessconfig=sessconfig)
#
# Notification of events in the Session
#
def add_observer(self,
func,
subject,
changeTypes=[NTFY_UPDATE, NTFY_INSERT, NTFY_DELETE],
objectID=None,
cache=0):
""" Add an observer function function to the Session. The observer
function will be called when one of the specified events (changeTypes)
occurs on the specified subject.
The function will be called by a popup thread which can be used
indefinitely (within reason) by the higher level code.
@param func The observer function. It should accept as its first argument
the subject, as second argument the changeType, as third argument an
objectID (e.g. the primary key in the observed database) and an
optional list of arguments.
@param subject The subject to observe, one of NTFY_* subjects (see
simpledefs).
@param changeTypes The list of events to be notified of one of NTFY_*
events.
@param objectID The specific object in the subject to monitor (e.g. a
specific primary key in a database to monitor for updates.)
@param cache The time to bundle/cache events matching this function
TODO: Jelle will add per-subject/event description here ;o)
"""
# Called by any thread
self.notifier.add_observer(func,
subject,
changeTypes,
objectID,
cache=cache) # already threadsafe
def remove_observer(self, func):
""" Remove observer function. No more callbacks will be made.
@param func The observer function to remove. """
# Called by any thread
self.notifier.remove_observer(func) # already threadsafe
def open_dbhandler(self, subject):
""" Opens a connection to the specified database. Only the thread
calling this method may use this connection. The connection must be
closed with close_dbhandler() when this thread exits.
@param subject The database to open. Must be one of the subjects
specified here.
@return A reference to a DBHandler class for the specified subject or
None when the Session was not started with megacaches enabled.
<pre> NTFY_PEERS -> PeerDBHandler
NTFY_TORRENTS -> TorrentDBHandler
NTFY_MYPREFERENCES -> MyPreferenceDBHandler
NTFY_VOTECAST -> VotecastDBHandler
NTFY_CHANNELCAST -> ChannelCastDBHandler
</pre>
"""
if not self.get_megacache():
raise OperationNotEnabledByConfigurationException()
# Called by any thread
if subject == NTFY_METADATA:
return self.lm.metadata_db
elif subject == NTFY_PEERS:
return self.lm.peer_db
elif subject == NTFY_TORRENTS:
return self.lm.torrent_db
elif subject == NTFY_MYPREFERENCES:
return self.lm.mypref_db
elif subject == NTFY_VOTECAST:
return self.lm.votecast_db
elif subject == NTFY_CHANNELCAST:
return self.lm.channelcast_db
else:
raise ValueError(u"Cannot open DB subject: %s" % subject)
def close_dbhandler(self, dbhandler):
""" Closes the given database connection """
dbhandler.close()
def get_statistics(self):
return TriblerStatistics(self).dump_statistics()
def get_tribler_statistics(self):
"""
Return a dictionary with general Tribler statistics.
"""
return TriblerStatistics(self).get_tribler_statistics()
def get_dispersy_statistics(self):
"""
Return a dictionary with general Dispersy statistics.
"""
return TriblerStatistics(self).get_dispersy_statistics()
def get_community_statistics(self):
"""
Return a dictionary with general communities statistics.
"""
return TriblerStatistics(self).get_community_statistics()
#
# Persistence and shutdown
#
def load_checkpoint(self):
"""
Restart Downloads from a saved checkpoint, if any. Note that we fetch information from the user download
choices since it might be that a user has stopped a download. In that case, the download should not be
resumed immediately when being loaded by libtorrent.
"""
initialdlstatus_dict = {}
for infohash, state in self.tribler_config.get_download_states(
).iteritems():
if state == 'stop':
initialdlstatus_dict[infohash] = DLSTATUS_STOPPED
self.lm.load_checkpoint(initialdlstatus_dict=initialdlstatus_dict)
@blocking_call_on_reactor_thread
def start_database(self):
"""
Start the SQLite database.
"""
db_path = os.path.join(self.get_state_dir(), DB_FILE_RELATIVE_PATH)
db_script_path = os.path.join(get_lib_path(), DB_SCRIPT_NAME)
self.sqlite_db = SQLiteCacheDB(db_path, db_script_path)
self.sqlite_db.initialize()
self.sqlite_db.initial_begin()
@blocking_call_on_reactor_thread
def start(self):
"""
Start a Tribler session by initializing the LaunchManyCore class, opening the database and running the upgrader.
Returns a deferred that fires when the Tribler session is ready for use.
"""
# Start the REST API before the upgrader since we want to send interesting upgrader events over the socket
if self.get_http_api_enabled():
self.lm.api_manager = RESTManager(self)
self.lm.api_manager.start()
self.start_database()
if self.get_upgrader_enabled():
self.upgrader = TriblerUpgrader(self, self.sqlite_db)
self.upgrader.run()
startup_deferred = self.lm.register(self, self.sesslock)
def load_checkpoint(_):
if self.get_libtorrent():
self.load_checkpoint()
self.sessconfig.set_callback(self.lm.sessconfig_changed_callback)
return startup_deferred.addCallback(load_checkpoint)
@blocking_call_on_reactor_thread
def shutdown(self):
"""
Checkpoints the session and closes it, stopping the download engine.
This method has to be called from the reactor thread.
"""
assert isInIOThread()
@inlineCallbacks
def on_early_shutdown_complete(_):
"""
Callback that gets called when the early shutdown has been completed.
Continues the shutdown procedure that is dependant on the early shutdown.
:param _: ignored parameter of the Deferred
"""
self.save_session_config()
yield self.checkpoint_downloads()
self.lm.shutdown_downloads()
self.lm.network_shutdown()
if self.sqlite_db:
self.sqlite_db.close()
self.sqlite_db = None
return self.lm.early_shutdown().addCallback(on_early_shutdown_complete)
def has_shutdown(self):
""" Whether the Session has completely shutdown, i.e., its internal
threads are finished and it is safe to quit the process the Session
is running in.
@return A Boolean.
"""
return self.lm.sessdoneflag.isSet()
def get_downloads_pstate_dir(self):
""" Returns the directory in which to checkpoint the Downloads in this
Session. """
# Called by network thread
return os.path.join(self.get_state_dir(), STATEDIR_DLPSTATE_DIR)
def download_torrentfile(self, infohash=None, usercallback=None, prio=0):
""" Try to download the torrentfile without a known source.
A possible source could be the DHT.
If the torrent is succesfully
received, the usercallback method is called with the infohash as first
and the contents of the torrentfile (bencoded dict) as second parameter.
If the torrent could not be obtained, the callback is not called.
The torrent will have been added to the TorrentDBHandler (if enabled)
at the time of the call.
@param infohash The infohash of the torrent.
@param usercallback A function adhering to the above spec.
"""
if not self.lm.rtorrent_handler:
raise OperationNotEnabledByConfigurationException()
self.lm.rtorrent_handler.download_torrent(None,
infohash,
user_callback=usercallback,
priority=prio)
def download_torrentfile_from_peer(self,
candidate,
infohash=None,
usercallback=None,
prio=0):
""" Ask the designated peer to send us the torrentfile for the torrent
identified by the passed infohash. If the torrent is succesfully
received, the usercallback method is called with the infohash as first
and the contents of the torrentfile (bencoded dict) as second parameter.
If the torrent could not be obtained, the callback is not called.
The torrent will have been added to the TorrentDBHandler (if enabled)
at the time of the call.
@param permid The PermID of the peer to query.
@param infohash The infohash of the torrent.
@param usercallback A function adhering to the above spec.
"""
if not self.lm.rtorrent_handler:
raise OperationNotEnabledByConfigurationException()
self.lm.rtorrent_handler.download_torrent(candidate,
infohash,
user_callback=usercallback,
priority=prio)
def download_torrentmessage_from_peer(self,
candidate,
infohash,
usercallback,
prio=0):
""" Ask the designated peer to send us the torrentmessage for the torrent
identified by the passed infohash. If the torrentmessage is succesfully
received, the usercallback method is called with the infohash as first
and the contents of the torrentfile (bencoded dict) as second parameter.
If the torrent could not be obtained, the callback is not called.
The torrent will have been added to the TorrentDBHandler (if enabled)
at the time of the call.
@param permid The PermID of the peer to query.
@param infohash The infohash of the torrent.
@param usercallback A function adhering to the above spec.
"""
if not self.lm.rtorrent_handler:
raise OperationNotEnabledByConfigurationException()
self.lm.rtorrent_handler.download_torrentmessage(
candidate, infohash, usercallback, prio)
def get_dispersy_instance(self):
if not self.get_dispersy():
raise OperationNotEnabledByConfigurationException()
return self.lm.dispersy
def get_libtorrent_process(self):
if not self.get_libtorrent():
raise OperationNotEnabledByConfigurationException()
return self.lm.ltmgr
#
# Internal persistence methods
#
def checkpoint_downloads(self):
"""
Checkpoints the downloads in Tribler.
"""
return self.lm.checkpoint_downloads()
def save_session_config(self):
""" Save the runtime SessionConfig to disk """
# Called by any thread
sscfg = self.get_current_startup_config_copy()
cfgfilename = Session.get_default_config_filename(
sscfg.get_state_dir())
sscfg.save(cfgfilename)
def update_trackers(self, infohash, trackers):
""" Updates the trackers of a torrent.
:param infohash: infohash of the torrent that needs to be updated
:param trackers: A list of tracker urls.
"""
return self.lm.update_trackers(infohash, trackers)
# New APIs
def has_collected_torrent(self, infohash):
"""
Checks if the given torrent infohash exists in the torrent_store database.
:param infohash: The given infohash binary.
:return: True or False indicating if we have the torrent.
"""
if not self.get_torrent_store():
raise OperationNotEnabledByConfigurationException(
"torrent_store is not enabled")
return hexlify(infohash) in self.lm.torrent_store
def get_collected_torrent(self, infohash):
"""
Gets the given torrent from the torrent_store database.
:param infohash: The given infohash binary.
:return: The torrent data if exists, None otherwise.
"""
if not self.get_torrent_store():
raise OperationNotEnabledByConfigurationException(
"torrent_store is not enabled")
return self.lm.torrent_store.get(hexlify(infohash))
def save_collected_torrent(self, infohash, data):
"""
Saves the given torrent into the torrent_store database.
:param infohash: The given infohash binary.
:param data: The torrent file data.
"""
if not self.get_torrent_store():
raise OperationNotEnabledByConfigurationException(
"torrent_store is not enabled")
self.lm.torrent_store.put(hexlify(infohash), data)
def delete_collected_torrent(self, infohash):
"""
Deletes the given torrent from the torrent_store database.
:param infohash: The given infohash binary.
"""
if not self.get_torrent_store():
raise OperationNotEnabledByConfigurationException(
"torrent_store is not enabled")
del self.lm.torrent_store[hexlify(infohash)]
def search_remote_torrents(self, keywords):
"""
Searches for remote torrents through SearchCommunity with the given keywords.
:param keywords: The given keywords.
:return: The number of requests made.
"""
if not self.get_enable_torrent_search():
raise OperationNotEnabledByConfigurationException(
"torrent_search is not enabled")
return self.lm.search_manager.search_for_torrents(keywords)
def search_remote_channels(self, keywords):
"""
Searches for remote channels through AllChannelCommunity with the given keywords.
:param keywords: The given keywords.
"""
if not self.get_enable_channel_search():
raise OperationNotEnabledByConfigurationException(
"channel_search is not enabled")
self.lm.search_manager.search_for_channels(keywords)
def create_torrent_file(self, file_path_list, params={}):
"""
:param file_path_list: files to add in torrent file
:param params: optional parameters for torrent file
:return: Deferred
"""
return threads.deferToThread(torrent_utils.create_torrent_file,
file_path_list, params)
def create_channel(self, name, description, mode=u'closed'):
"""
Creates a new Channel.
:param name: Name of the Channel.
:param description: Description of the Channel.
:param mode: Mode of the Channel ('open', 'semi-open', or 'closed').
:return: Channel ID
:raises DuplicateChannelNameError if name already exists
"""
return self.lm.channel_manager.create_channel(name, description, mode)
def add_torrent_def_to_channel(self,
channel_id,
torrent_def,
extra_info={},
forward=True):
"""
Adds a TorrentDef to a Channel.
:param channel_id: Id of the Channel to add the Torrent to.
:param torrent_def: Definition of the Torrent to add.
:param extra_info: Description of the Torrent to add.
:param forward: When True the messages are forwarded (as defined by their message
destination policy) to other nodes in the community. This parameter should (almost always)
be True, its inclusion is mostly to allow certain debugging scenarios.
"""
# Make sure that this new torrent_def is also in collected torrents
self.lm.rtorrent_handler.save_torrent(torrent_def)
channelcast_db = self.open_dbhandler(NTFY_CHANNELCAST)
if channelcast_db.hasTorrent(channel_id, torrent_def.infohash):
raise DuplicateTorrentFileError()
dispersy_cid = str(
channelcast_db.getDispersyCIDFromChannelId(channel_id))
community = self.get_dispersy_instance().get_community(dispersy_cid)
community._disp_create_torrent(
torrent_def.infohash,
long(time.time()),
torrent_def.get_name_as_unicode(),
tuple(torrent_def.get_files_as_unicode_with_length()),
torrent_def.get_trackers_as_single_tuple(),
forward=forward)
if 'description' in extra_info:
desc = extra_info['description'].strip()
if desc != '':
data = channelcast_db.getTorrentFromChannelId(
channel_id, torrent_def.infohash, ['ChannelTorrents.id'])
community.modifyTorrent(data, {'description': desc},
forward=forward)
def check_torrent_health(self, infohash, timeout=20, scrape_now=False):
"""
Checks the given torrent's health on its trackers.
:param infohash: The given torrent infohash.
"""
if self.lm.torrent_checker:
return self.lm.torrent_checker.add_gui_request(
infohash, timeout=timeout, scrape_now=scrape_now)
return fail(Failure(RuntimeError("Torrent checker not available")))
def set_max_upload_speed(self, rate):
"""
Sets the maximum upload rate (kB/s).
:param rate: The upload rate (kB/s).
"""
if not self.get_libtorrent():
raise OperationNotEnabledByConfigurationException(
"libtorrent is not enabled")
self.lm.ltmgr.set_upload_rate_limit(rate)
def set_max_download_speed(self, rate):
"""
Sets the maximum download rate (kB/s).
:param rate: The download rate (kB/s).
"""
if not self.lm.ltmgr:
raise OperationNotEnabledByConfigurationException(
"libtorrent is not enabled")
self.lm.ltmgr.set_download_rate_limit(rate)
def get_thumbnail_data(self, thumb_hash):
"""
Gets the thumbnail data.
:param thumb_hash: The thumbnail SHA1 hash.
:return: The thumbnail data.
"""
if not self.lm.metadata_store:
raise OperationNotEnabledByConfigurationException(
"libtorrent is not enabled")
return self.lm.rtorrent_handler.get_metadata(thumb_hash)
