class TestLibtorrentMgr(AbstractServer): FILE_DIR = os.path.abspath(os.path.dirname(os.path.realpath(__file__))) LIBTORRENT_FILES_DIR = os.path.abspath(os.path.join(FILE_DIR, u"../data/libtorrent/")) @inlineCallbacks def setUp(self): yield super(TestLibtorrentMgr, self).setUp() self.tribler_session = MockObject() self.tribler_session.lm = MockObject() self.tribler_session.notifier = Notifier() self.tribler_session.state_dir = self.session_base_dir self.tribler_session.trustchain_keypair = MockObject() self.tribler_session.trustchain_keypair.key_to_hash = lambda: 'a' * 20 self.tribler_session.notify_shutdown_state = lambda _: None self.tribler_session.config = MockObject() self.tribler_session.config.get_libtorrent_utp = lambda: True self.tribler_session.config.get_libtorrent_proxy_settings = lambda: (0, None, None) self.tribler_session.config.get_anon_proxy_settings = lambda: (2, ('127.0.0.1', [1338]), None) self.tribler_session.config.get_libtorrent_port = lambda: 1337 self.tribler_session.config.get_anon_listen_port = lambda: 1338 self.tribler_session.config.get_state_dir = lambda: self.session_base_dir self.tribler_session.config.set_listen_port_runtime = lambda: None self.tribler_session.config.get_libtorrent_max_upload_rate = lambda: 100 self.tribler_session.config.get_libtorrent_max_download_rate = lambda: 120 self.tribler_session.config.get_libtorrent_dht_enabled = lambda: False self.tribler_session.config.set_libtorrent_port_runtime = lambda _: None self.ltmgr = LibtorrentMgr(self.tribler_session) @inlineCallbacks def tearDown(self): self.ltmgr.shutdown(timeout=0) self.assertTrue(os.path.exists(os.path.join(self.session_base_dir, 'lt.state'))) yield super(TestLibtorrentMgr, self).tearDown() def test_get_session_zero_hops(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_one_hop(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(1) self.assertTrue(ltsession) def test_get_session_zero_hops_corrupt_lt_state(self): file = open(os.path.join(self.session_base_dir, 'lt.state'), "w") file.write("Lorem ipsum") file.close() self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_zero_hops_working_lt_state(self): shutil.copy(os.path.join(self.LIBTORRENT_FILES_DIR, 'lt.state'), os.path.join(self.session_base_dir, 'lt.state')) self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_metainfo_not_ready(self): """ Testing the metainfo fetching method when the DHT is not ready """ self.ltmgr.initialize() self.assertFalse(self.ltmgr.get_metainfo("a" * 20, None)) @trial_timeout(20) def test_get_metainfo(self): """ Testing the metainfo fetching method """ test_deferred = Deferred() def metainfo_cb(metainfo): self.assertEqual(metainfo, {'info': {'pieces': ['a']}, 'leechers': 0, 'nodes': [], 'seeders': 0, 'initial peers': []}) test_deferred.callback(None) infohash = "a" * 20 self.ltmgr.initialize() torrent_info = MockObject() torrent_info.metadata = lambda: bencode({'pieces': ['a']}) torrent_info.trackers = lambda: [] fake_handle = MockObject() fake_handle.is_valid = lambda: True fake_handle.has_metadata = lambda: True fake_handle.get_peer_info = lambda: [] fake_handle.torrent_file = lambda: torrent_info self.ltmgr.ltsession_metainfo.add_torrent = lambda *_: fake_handle self.ltmgr.ltsession_metainfo.remove_torrent = lambda *_: None fake_alert = type('lt.metadata_received_alert', (object,), dict(handle=fake_handle)) self.ltmgr.ltsession_metainfo.pop_alerts = lambda: [fake_alert] self.ltmgr.get_metainfo(unhexlify(infohash), metainfo_cb) return test_deferred @trial_timeout(20) def test_get_metainfo_cache(self): """ Testing metainfo caching """ test_deferred = Deferred() def metainfo_cb(metainfo): self.assertEqual(metainfo, "test") test_deferred.callback(None) self.ltmgr.initialize() self.ltmgr.metainfo_cache[hexlify("a" * 20)] = {'meta_info': 'test'} self.ltmgr.get_metainfo("a" * 20, metainfo_cb) return test_deferred @trial_timeout(20) def test_got_metainfo(self): """ Testing whether the callback is correctly invoked when we received metainfo """ test_deferred = Deferred() self.ltmgr.initialize() def metainfo_cb(metainfo): self.assertDictEqual(metainfo, {'info': {'pieces': ['a']}, 'leechers': 0, 'nodes': [], 'seeders': 0, 'initial peers': []}) test_deferred.callback(None) fake_handle = MockObject() torrent_info = MockObject() torrent_info.metadata = lambda: bencode({'pieces': ['a']}) torrent_info.trackers = lambda: [] fake_handle.get_peer_info = lambda: [] fake_handle.torrent_file = lambda: torrent_info self.ltmgr.ltsession_metainfo.remove_torrent = lambda *_: None self.ltmgr.metainfo_requests['a' * 20] = { 'handle': fake_handle, 'timeout_callbacks': [], 'callbacks': [metainfo_cb], 'notify': False } self.ltmgr.got_metainfo("a" * 20) return test_deferred @trial_timeout(20) def test_got_metainfo_timeout(self): """ Testing whether the callback is correctly invoked when we received metainfo after timeout """ test_deferred = Deferred() def metainfo_timeout_cb(metainfo): self.assertEqual(metainfo, 'a' * 20) test_deferred.callback(None) fake_handle = MockObject() self.ltmgr.initialize() self.ltmgr.metainfo_requests[hexlify('a' * 20)] = {'handle': fake_handle, 'timeout_callbacks': [metainfo_timeout_cb], 'callbacks': [], 'notify': True} self.ltmgr.ltsession_metainfo.remove_torrent = lambda _dummy1, _dummy2: None self.ltmgr.got_metainfo(hexlify('a' * 20), timeout=True) return test_deferred @trial_timeout(20) def test_get_metainfo_with_already_added_torrent(self): """ Testing metainfo fetching for a torrent which is already in session. got_metainfo() should be called with timeout=False. """ magnet_link = "magnet:?xt=urn:btih:f72636475a375653083e49d501601675ce3e6619&dn=ubuntu-16.04.3-server-i386.iso" test_deferred = Deferred() def fake_got_metainfo(_, timeout): self.assertFalse(timeout, "Timeout should not be True") test_deferred.callback(None) mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: True mock_handle.has_metadata = lambda: True mock_ltsession = MockObject() mock_ltsession.add_torrent = lambda _: mock_handle mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [] mock_ltsession.start_upnp = lambda: None mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.ltsession_metainfo = mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') self.ltmgr.got_metainfo = fake_got_metainfo self.ltmgr.get_metainfo(magnet_link, lambda _: None) return test_deferred @trial_timeout(20) def test_add_torrent(self): """ Testing the addition of a torrent to the libtorrent manager """ test_deferred = Deferred() mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: False mock_error = MockObject() mock_error.value = lambda: None mock_alert = type('add_torrent_alert', (object,), dict(handle=mock_handle, error=mock_error))() mock_ltsession = MockObject() mock_ltsession.async_add_torrent = lambda _: reactor.callLater(0.1, self.ltmgr.process_alert, mock_alert) mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [] mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.get_session = lambda *_: mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') infohash = MockObject() infohash.info_hash = lambda: 'a' * 20 mock_download = MockObject() mock_download.deferred_added = Deferred() def cb_torrent_added(handle): self.assertEqual(handle, mock_handle) test_deferred.callback(None) self.ltmgr.add_torrent(mock_download, {'ti': infohash}).addCallback(cb_torrent_added) return test_deferred @trial_timeout(20) def test_add_torrent_desync(self): """ Testing the addition of a torrent to the libtorrent manager, if it already exists in the session. """ mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: True mock_alert = type('add_torrent_alert', (object,), dict(handle=mock_handle)) mock_ltsession = MockObject() mock_ltsession.async_add_torrent = lambda _: self.ltmgr.process_alert(mock_alert) mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [mock_handle] mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.get_session = lambda *_: mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') infohash = MockObject() infohash.info_hash = lambda: 'a' * 20 mock_download = MockObject() mock_download.deferred_added = Deferred() return self.ltmgr.add_torrent(mock_download, {'ti': infohash}).addCallback( lambda handle: self.assertEqual(handle, mock_handle) ) def test_remove_invalid_torrent(self): """ Tests a successful removal status of torrents without a handle """ self.ltmgr.initialize() mock_dl = MockObject() mock_dl.handle = None self.assertTrue(self.ltmgr.remove_torrent(mock_dl).called) def test_remove_invalid_handle_torrent(self): """ Tests a successful removal status of torrents with an invalid handle """ self.ltmgr.initialize() mock_handle = MockObject() mock_handle.is_valid = lambda: False mock_dl = MockObject() mock_dl.handle = mock_handle self.assertTrue(self.ltmgr.remove_torrent(mock_dl).called) def test_remove_unregistered_torrent(self): """ Tests a successful removal status of torrents which aren't known """ self.ltmgr.initialize() mock_handle = MockObject() mock_handle.is_valid = lambda: False alert = type('torrent_removed_alert', (object, ), dict(handle=mock_handle, info_hash='0'*20)) self.ltmgr.process_alert(alert()) self.assertNotIn('0'*20, self.ltmgr.torrents) def test_start_download_corrupt(self): """ Testing whether starting the download of a corrupt torrent file raises an exception """ self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') corrupt_file = os.path.join(self.LIBTORRENT_FILES_DIR, 'corrupt_torrent.torrent') self.assertRaises(TorrentFileException, self.ltmgr.start_download, torrentfilename=corrupt_file) def test_start_download_duplicate(self): """ Test the starting of a download when there are no new trackers """ mock_tdef = MockObject() mock_tdef.get_infohash = lambda: 'a' * 20 mock_tdef.get_trackers_as_single_tuple = lambda: tuple() mock_download = MockObject() mock_download.get_def = lambda: mock_tdef mock_download.get_credit_mining = lambda: False self.tribler_session.get_download = lambda _: mock_download self.tribler_session.start_download_from_tdef = lambda tdef, _: MockObject() self.ltmgr.tribler_session = self.tribler_session self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') self.ltmgr.start_download(infohash='a' * 20, tdef=mock_tdef) def test_set_proxy_settings(self): """ Test setting the proxy settings """ def on_proxy_set(settings): self.assertTrue(settings) self.assertEqual(settings.hostname, 'a') self.assertEqual(settings.port, 1234) self.assertEqual(settings.username, 'abc') self.assertEqual(settings.password, 'def') def on_set_settings(settings): self.assertTrue(settings) self.assertEqual(settings['proxy_hostname'], 'a') self.assertEqual(settings['proxy_port'], 1234) self.assertEqual(settings['proxy_username'], 'abc') self.assertEqual(settings['proxy_password'], 'def') self.assertEqual(settings['proxy_peer_connections'], True) self.assertEqual(settings['proxy_hostnames'], True) mock_lt_session = MockObject() mock_lt_session.get_settings = lambda: {} mock_lt_session.set_settings = on_set_settings mock_lt_session.set_proxy = on_proxy_set # Libtorrent < 1.1.0 uses set_proxy to set proxy settings self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') self.ltmgr.set_proxy_settings(mock_lt_session, 0, ('a', "1234"), ('abc', 'def')) def test_save_resume_preresolved_magnet(self): """ Test whether a magnet link correctly writes save-resume data before it is resolved. This can happen when a magnet link is added when the user does not have internet. """ self.ltmgr.initialize() self.ltmgr.trsession = self.tribler_session self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') mock_tdef = MockObject() mock_tdef.get_infohash = lambda: 'a' * 20 self.tribler_session.get_download = lambda _: None self.tribler_session.get_downloads_pstate_dir = lambda: self.ltmgr.metadata_tmpdir mock_lm = MockObject() mock_lm.ltmgr = self.ltmgr mock_lm.tunnel_community = None self.tribler_session.lm = mock_lm def dl_from_tdef(tdef, _): dl = LibtorrentDownloadImpl(self.tribler_session, tdef) dl.setup() dl.cancel_all_pending_tasks() return dl self.tribler_session.start_download_from_tdef = dl_from_tdef download = self.ltmgr.start_download_from_magnet("magnet:?xt=urn:btih:" + ('1'*40)) basename = hexlify(download.get_def().get_infohash()) + '.state' filename = os.path.join(download.session.get_downloads_pstate_dir(), basename) self.assertTrue(os.path.isfile(filename)) @trial_timeout(5) def test_callback_on_alert(self): """ Test whether the alert callback is called when a libtorrent alert is posted """ self.ltmgr.default_alert_mask = 0xffffffff test_deferred = Deferred() def callback(*args): self.ltmgr.alert_callback = None test_deferred.callback(None) callback.called = False self.ltmgr.alert_callback = callback self.ltmgr.initialize() self.ltmgr._task_process_alerts() return test_deferred def test_payout_on_disconnect(self): """ Test whether a payout is initialized when a peer disconnects """ class peer_disconnected_alert(object): def __init__(self): self.pid = MockObject() self.pid.to_string = lambda: 'a' * 20 def mocked_do_payout(mid): self.assertEqual(mid, 'a' * 20) mocked_do_payout.called = True mocked_do_payout.called = False disconnect_alert = peer_disconnected_alert() self.ltmgr.tribler_session.lm.payout_manager = MockObject() self.ltmgr.tribler_session.lm.payout_manager.do_payout = mocked_do_payout self.ltmgr.initialize() self.ltmgr.get_session(0).pop_alerts = lambda: [disconnect_alert] self.ltmgr._task_process_alerts() self.assertTrue(mocked_do_payout.called) def test_post_session_stats(self): """ Test whether post_session_stats actually updates the state of libtorrent readiness for clean shutdown. """ def check_if_session_shutdown_is_ready(): self.ltmgr._task_process_alerts() self.assertTrue(self.ltmgr.lt_session_shutdown_ready[0]) self.ltmgr.default_alert_mask = 0xffffffff self.ltmgr.initialize() # Zero hop session should be initialized self.assertFalse(self.ltmgr.lt_session_shutdown_ready[0]) # Check for status with session stats alert self.ltmgr.post_session_stats(hops=0) # Wait sometime to get the alert and check the status return deferLater(reactor, 0.01, check_if_session_shutdown_is_ready)
class TestLibtorrentMgr(TriblerCoreTest): FILE_DIR = os.path.abspath(os.path.dirname(os.path.realpath(__file__))) LIBTORRENT_FILES_DIR = os.path.abspath( os.path.join(FILE_DIR, u"../data/libtorrent/")) @blocking_call_on_reactor_thread @inlineCallbacks def setUp(self, annotate=True): yield super(TestLibtorrentMgr, self).setUp(annotate) self.tribler_session = FakeTriblerSession(self.session_base_dir) self.ltmgr = LibtorrentMgr(self.tribler_session) @blocking_call_on_reactor_thread @inlineCallbacks def tearDown(self, annotate=True): self.ltmgr.shutdown() self.assertTrue( os.path.exists(os.path.join(self.session_base_dir, 'lt.state'))) yield super(TestLibtorrentMgr, self).tearDown(annotate) def test_get_session_zero_hops(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_one_hop(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(1) self.assertTrue(ltsession) def test_get_session_zero_hops_corrupt_lt_state(self): file = open(os.path.join(self.session_base_dir, 'lt.state'), "w") file.write("Lorem ipsum") file.close() self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_zero_hops_working_lt_state(self): shutil.copy(os.path.join(self.LIBTORRENT_FILES_DIR, 'lt.state'), os.path.join(self.session_base_dir, 'lt.state')) self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_metainfo_not_ready(self): """ Testing the metainfo fetching method when the DHT is not ready """ self.ltmgr.initialize() self.assertFalse(self.ltmgr.get_metainfo("a" * 20, None)) @deferred(timeout=20) def test_get_metainfo(self): """ Testing the metainfo fetching method """ test_deferred = Deferred() def metainfo_cb(metainfo): self.assertEqual( metainfo, { 'info': { 'pieces': ['a'] }, 'leechers': 0, 'nodes': [], 'seeders': 0, 'initial peers': [] }) test_deferred.callback(None) infohash = "a" * 20 self.ltmgr.initialize() torrent_info = MockObject() torrent_info.metadata = lambda: bencode({'pieces': ['a']}) torrent_info.trackers = lambda: [] fake_handle = MockObject() fake_handle.is_valid = lambda: True fake_handle.has_metadata = lambda: True fake_handle.get_peer_info = lambda: [] fake_handle.torrent_file = lambda: torrent_info self.ltmgr.ltsession_metainfo.add_torrent = lambda *_: fake_handle self.ltmgr.ltsession_metainfo.remove_torrent = lambda *_: None fake_alert = type('lt.metadata_received_alert', (object, ), dict(handle=fake_handle)) self.ltmgr.ltsession_metainfo.pop_alerts = lambda: [fake_alert] self.ltmgr.is_dht_ready = lambda: True self.ltmgr.get_metainfo(infohash.decode('hex'), metainfo_cb) return test_deferred @deferred(timeout=20) def test_get_metainfo_cache(self): """ Testing metainfo caching """ test_deferred = Deferred() def metainfo_cb(metainfo): self.assertEqual(metainfo, "test") test_deferred.callback(None) self.ltmgr.initialize() self.ltmgr.is_dht_ready = lambda: True self.ltmgr.metainfo_cache[("a" * 20).encode('hex')] = { 'meta_info': 'test' } self.ltmgr.get_metainfo("a" * 20, metainfo_cb) return test_deferred @deferred(timeout=20) def test_got_metainfo(self): """ Testing whether the callback is correctly invoked when we received metainfo """ test_deferred = Deferred() self.ltmgr.initialize() def metainfo_cb(metainfo): self.assertDictEqual( metainfo, { 'info': { 'pieces': ['a'] }, 'leechers': 0, 'nodes': [], 'seeders': 0, 'initial peers': [] }) test_deferred.callback(None) fake_handle = MockObject() torrent_info = MockObject() torrent_info.metadata = lambda: bencode({'pieces': ['a']}) torrent_info.trackers = lambda: [] fake_handle.get_peer_info = lambda: [] fake_handle.torrent_file = lambda: torrent_info self.ltmgr.ltsession_metainfo.remove_torrent = lambda *_: None self.ltmgr.metainfo_requests['a' * 20] = { 'handle': fake_handle, 'timeout_callbacks': [], 'callbacks': [metainfo_cb], 'notify': False } self.ltmgr.got_metainfo("a" * 20) return test_deferred @deferred(timeout=20) def test_got_metainfo_timeout(self): """ Testing whether the callback is correctly invoked when we received metainfo after timeout """ test_deferred = Deferred() def metainfo_timeout_cb(metainfo): self.assertEqual(metainfo, 'a' * 20) test_deferred.callback(None) fake_handle = MockObject() self.ltmgr.initialize() self.ltmgr.metainfo_requests[('a' * 20).encode('hex')] = { 'handle': fake_handle, 'timeout_callbacks': [metainfo_timeout_cb], 'callbacks': [], 'notify': True } self.ltmgr.ltsession_metainfo.remove_torrent = lambda _dummy1, _dummy2: None self.ltmgr.got_metainfo(('a' * 20).encode('hex'), timeout=True) return test_deferred @deferred(timeout=20) def test_get_metainfo_with_already_added_torrent(self): """ Testing metainfo fetching for a torrent which is already in session. got_metainfo() should be called with timeout=False. """ magnet_link = "magnet:?xt=urn:btih:f72636475a375653083e49d501601675ce3e6619&dn=ubuntu-16.04.3-server-i386.iso" test_deferred = Deferred() def fake_got_metainfo(_, timeout): self.assertFalse(timeout, "Timeout should not be True") test_deferred.callback(None) mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: True mock_handle.has_metadata = lambda: True mock_ltsession = MockObject() mock_ltsession.add_torrent = lambda _: mock_handle mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [] mock_ltsession.start_upnp = lambda: None mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.ltsession_metainfo = mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') self.ltmgr.is_dht_ready = lambda: True self.ltmgr.got_metainfo = fake_got_metainfo self.ltmgr.get_metainfo(magnet_link, lambda _: None) return test_deferred def test_add_torrent(self): """ Testing the addition of a torrent to the libtorrent manager """ mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: False mock_ltsession = MockObject() mock_ltsession.add_torrent = lambda _: mock_handle mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [] mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.get_session = lambda *_: mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') infohash = MockObject() infohash.info_hash = lambda: 'a' * 20 self.assertEqual(self.ltmgr.add_torrent(None, {'ti': infohash}), mock_handle) self.assertRaises(DuplicateDownloadException, self.ltmgr.add_torrent, None, {'ti': infohash}) def test_add_torrent_desync(self): """ Testing the addition of a torrent to the libtorrent manager, if it already exists in the session. """ mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: True mock_ltsession = MockObject() mock_ltsession.add_torrent = lambda _: mock_handle mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [mock_handle] mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.get_session = lambda *_: mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') infohash = MockObject() infohash.info_hash = lambda: 'a' * 20 self.assertEqual(self.ltmgr.add_torrent(None, {'ti': infohash}), mock_handle) def test_remove_invalid_torrent(self): """ Tests a successful removal status of torrents without a handle """ self.ltmgr.initialize() mock_dl = MockObject() mock_dl.handle = None self.assertTrue(self.ltmgr.remove_torrent(mock_dl).called) def test_remove_invalid_handle_torrent(self): """ Tests a successful removal status of torrents with an invalid handle """ self.ltmgr.initialize() mock_handle = MockObject() mock_handle.is_valid = lambda: False mock_dl = MockObject() mock_dl.handle = mock_handle self.assertTrue(self.ltmgr.remove_torrent(mock_dl).called) def test_remove_unregistered_torrent(self): """ Tests a successful removal status of torrents which aren't known """ self.ltmgr.initialize() mock_handle = MockObject() mock_handle.is_valid = lambda: False alert = type('torrent_removed_alert', (object, ), dict(handle=mock_handle, info_hash='0' * 20)) self.ltmgr.process_alert(alert()) self.assertNotIn('0' * 20, self.ltmgr.torrents) def test_start_download_corrupt(self): """ Testing whether starting the download of a corrupt torrent file raises an exception """ self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') corrupt_file = os.path.join(self.LIBTORRENT_FILES_DIR, 'corrupt_torrent.torrent') self.assertRaises(TorrentFileException, self.ltmgr.start_download, torrentfilename=corrupt_file) def test_start_download_duplicate(self): """ Test the starting of a download when there are no new trackers """ mock_tdef = MockObject() mock_tdef.get_infohash = lambda: 'a' * 20 mock_tdef.get_trackers_as_single_tuple = lambda: tuple() mock_download = MockObject() mock_download.get_def = lambda: mock_tdef self.tribler_session.get_download = lambda _: mock_download self.ltmgr.trsession = self.tribler_session self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') self.assertRaises(DuplicateDownloadException, self.ltmgr.start_download, infohash='a' * 20, tdef=mock_tdef) def test_set_proxy_settings(self): """ Test setting the proxy settings """ def on_proxy_set(settings): self.assertTrue(settings) self.assertEqual(settings.hostname, 'a') self.assertEqual(settings.port, 1234) self.assertEqual(settings.username, 'abc') self.assertEqual(settings.password, 'def') def on_set_settings(settings): self.assertTrue(settings) self.assertEqual(settings['proxy_hostname'], 'a') self.assertEqual(settings['proxy_port'], 1234) self.assertEqual(settings['proxy_username'], 'abc') self.assertEqual(settings['proxy_password'], 'def') self.assertEqual(settings['proxy_peer_connections'], True) self.assertEqual(settings['proxy_hostnames'], True) mock_lt_session = MockObject() mock_lt_session.get_settings = lambda: {} mock_lt_session.set_settings = on_set_settings mock_lt_session.set_proxy = on_proxy_set # Libtorrent < 1.1.0 uses set_proxy to set proxy settings self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') self.ltmgr.set_proxy_settings(mock_lt_session, 0, ('a', "1234"), ('abc', 'def')) def test_save_resume_preresolved_magnet(self): """ Test whether a magnet link correctly writes save-resume data before it is resolved. This can happen when a magnet link is added when the user does not have internet. """ self.ltmgr.initialize() self.ltmgr.trsession = self.tribler_session self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') mock_tdef = MockObject() mock_tdef.get_infohash = lambda: 'a' * 20 self.tribler_session.get_download = lambda _: None self.tribler_session.get_downloads_pstate_dir = lambda: self.ltmgr.metadata_tmpdir mock_lm = MockObject() mock_lm.ltmgr = self.ltmgr mock_lm.tunnel_community = None self.tribler_session.lm = mock_lm def dl_from_tdef(tdef, _): dl = LibtorrentDownloadImpl(self.tribler_session, tdef) dl.setup() dl.cancel_all_pending_tasks() return dl self.tribler_session.start_download_from_tdef = dl_from_tdef download = self.ltmgr.start_download_from_magnet( "magnet:?xt=urn:btih:" + ('1' * 40)) basename = binascii.hexlify( download.get_def().get_infohash()) + '.state' filename = os.path.join(download.session.get_downloads_pstate_dir(), basename) self.assertTrue(os.path.isfile(filename))
class TestLibtorrentMgr(AbstractServer): FILE_DIR = os.path.abspath(os.path.dirname(os.path.realpath(__file__))) LIBTORRENT_FILES_DIR = os.path.abspath(os.path.join(FILE_DIR, u"../data/libtorrent/")) @blocking_call_on_reactor_thread @inlineCallbacks def setUp(self, annotate=True): yield super(TestLibtorrentMgr, self).setUp(annotate) self.tribler_session = MockObject() self.tribler_session.notifier = Notifier() self.tribler_session.state_dir = self.session_base_dir self.tribler_session.config = MockObject() self.tribler_session.config.get_libtorrent_utp = lambda: True self.tribler_session.config.get_libtorrent_proxy_settings = lambda: (0, None, None) self.tribler_session.config.get_anon_proxy_settings = lambda: (2, ('127.0.0.1', [1338]), None) self.tribler_session.config.get_libtorrent_port = lambda: 1337 self.tribler_session.config.get_anon_listen_port = lambda: 1338 self.tribler_session.config.get_state_dir = lambda: self.session_base_dir self.tribler_session.config.set_listen_port_runtime = lambda: None self.tribler_session.config.get_libtorrent_max_upload_rate = lambda: 100 self.tribler_session.config.get_libtorrent_max_download_rate = lambda: 120 self.ltmgr = LibtorrentMgr(self.tribler_session) @blocking_call_on_reactor_thread @inlineCallbacks def tearDown(self, annotate=True): self.ltmgr.shutdown() self.assertTrue(os.path.exists(os.path.join(self.session_base_dir, 'lt.state'))) yield super(TestLibtorrentMgr, self).tearDown(annotate) def test_get_session_zero_hops(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_one_hop(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(1) self.assertTrue(ltsession) def test_get_session_zero_hops_corrupt_lt_state(self): file = open(os.path.join(self.session_base_dir, 'lt.state'), "w") file.write("Lorem ipsum") file.close() self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_zero_hops_working_lt_state(self): shutil.copy(os.path.join(self.LIBTORRENT_FILES_DIR, 'lt.state'), os.path.join(self.session_base_dir, 'lt.state')) self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_metainfo_not_ready(self): """ Testing the metainfo fetching method when the DHT is not ready """ self.ltmgr.initialize() self.assertFalse(self.ltmgr.get_metainfo("a" * 20, None)) @deferred(timeout=20) def test_get_metainfo(self): """ Testing the metainfo fetching method """ test_deferred = Deferred() def metainfo_cb(metainfo): self.assertEqual(metainfo, "test") test_deferred.callback(None) self.ltmgr.initialize() self.ltmgr.is_dht_ready = lambda: True self.ltmgr.metainfo_cache[("a" * 20).encode('hex')] = {'meta_info': 'test'} self.ltmgr.get_metainfo("a" * 20, metainfo_cb) return test_deferred @deferred(timeout=20) def test_got_metainfo(self): """ Testing whether the callback is correctly invoked when we received metainfo """ test_deferred = Deferred() self.ltmgr.initialize() def metainfo_cb(metainfo): self.assertDictEqual(metainfo, {'info': {'pieces': ['a']}, 'leechers': 0, 'nodes': [], 'seeders': 0, 'initial peers': []}) test_deferred.callback(None) fake_handle = MockObject() torrent_info = MockObject() torrent_info.metadata = lambda: bencode({'pieces': ['a']}) torrent_info.trackers = lambda: [] fake_handle.get_peer_info = lambda: [] fake_handle.torrent_file = lambda: torrent_info self.ltmgr.get_session().remove_torrent = lambda *_: None self.ltmgr.metainfo_requests['a' * 20] = { 'handle': fake_handle, 'timeout_callbacks': [], 'callbacks': [metainfo_cb], 'notify': False } self.ltmgr.got_metainfo("a" * 20) return test_deferred @deferred(timeout=20) def test_got_metainfo_timeout(self): """ Testing whether the callback is correctly invoked when we received metainfo after timeout """ test_deferred = Deferred() def metainfo_timeout_cb(metainfo): self.assertEqual(metainfo, 'a' * 20) test_deferred.callback(None) fake_handle = MockObject() self.ltmgr.initialize() self.ltmgr.metainfo_requests[('a' * 20).encode('hex')] = {'handle': fake_handle, 'timeout_callbacks': [metainfo_timeout_cb], 'callbacks': [], 'notify': True} self.ltmgr.get_session().remove_torrent = lambda _dummy1, _dummy2: None self.ltmgr.got_metainfo(('a' * 20).encode('hex'), timeout=True) return test_deferred def test_add_torrent(self): """ Testing the addition of a torrent to the libtorrent manager """ mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_ltsession = MockObject() mock_ltsession.add_torrent = lambda _: mock_handle mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.get_session = lambda *_: mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') infohash = MockObject() infohash.info_hash = lambda: 'a' * 20 self.assertEqual(self.ltmgr.add_torrent(None, {'ti': infohash}), mock_handle) self.assertRaises(DuplicateDownloadException, self.ltmgr.add_torrent, None, {'ti': infohash}) def test_start_download_corrupt(self): """ Testing whether starting the download of a corrupt torrent file raises an exception """ self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') corrupt_file = os.path.join(self.LIBTORRENT_FILES_DIR, 'corrupt_torrent.torrent') self.assertRaises(TorrentFileException, self.ltmgr.start_download, torrentfilename=corrupt_file) def test_start_download_duplicate(self): """ Test the starting of a download when there are no new trackers """ mock_tdef = MockObject() mock_tdef.get_infohash = lambda: 'a' * 20 mock_tdef.get_trackers_as_single_tuple = lambda: tuple() mock_download = MockObject() mock_download.get_def = lambda: mock_tdef self.tribler_session.get_download = lambda _: mock_download self.ltmgr.tribler_session = self.tribler_session self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') self.assertRaises(DuplicateDownloadException, self.ltmgr.start_download, infohash='a' * 20, tdef=mock_tdef) def test_set_proxy_settings(self): """ Test setting the proxy settings """ def on_proxy_set(settings): self.assertTrue(settings) self.assertEqual(settings.hostname, 'a') self.assertEqual(settings.port, 1234) self.assertEqual(settings.username, 'abc') self.assertEqual(settings.password, 'def') mock_lt_session = MockObject() mock_lt_session.set_proxy = on_proxy_set self.ltmgr.metadata_tmpdir = tempfile.mkdtemp(suffix=u'tribler_metainfo_tmpdir') self.ltmgr.set_proxy_settings(mock_lt_session, 0, ('a', "1234"), ('abc', 'def'))
class TestLibtorrentMgr(AbstractServer): FILE_DIR = os.path.abspath(os.path.dirname(os.path.realpath(__file__))) LIBTORRENT_FILES_DIR = os.path.abspath( os.path.join(FILE_DIR, u"../data/libtorrent/")) @inlineCallbacks def setUp(self): yield super(TestLibtorrentMgr, self).setUp() self.tribler_session = MockObject() self.tribler_session.lm = MockObject() self.tribler_session.notifier = Notifier() self.tribler_session.state_dir = self.session_base_dir self.tribler_session.trustchain_keypair = MockObject() self.tribler_session.trustchain_keypair.key_to_hash = lambda: 'a' * 20 self.tribler_session.notify_shutdown_state = lambda _: None self.tribler_session.config = MockObject() self.tribler_session.config.get_libtorrent_utp = lambda: True self.tribler_session.config.get_libtorrent_proxy_settings = lambda: ( 0, None, None) self.tribler_session.config.get_anon_proxy_settings = lambda: (2, ( '127.0.0.1', [1338]), None) self.tribler_session.config.get_libtorrent_port = lambda: 1337 self.tribler_session.config.get_anon_listen_port = lambda: 1338 self.tribler_session.config.get_state_dir = lambda: self.session_base_dir self.tribler_session.config.set_listen_port_runtime = lambda: None self.tribler_session.config.get_libtorrent_max_upload_rate = lambda: 100 self.tribler_session.config.get_libtorrent_max_download_rate = lambda: 120 self.tribler_session.config.get_libtorrent_dht_enabled = lambda: False self.tribler_session.config.set_libtorrent_port_runtime = lambda _: None self.ltmgr = LibtorrentMgr(self.tribler_session) @inlineCallbacks def tearDown(self): self.ltmgr.shutdown(timeout=0) self.assertTrue( os.path.exists(os.path.join(self.session_base_dir, 'lt.state'))) yield super(TestLibtorrentMgr, self).tearDown() def test_get_session_zero_hops(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_one_hop(self): self.ltmgr.initialize() ltsession = self.ltmgr.get_session(1) self.assertTrue(ltsession) def test_get_session_zero_hops_corrupt_lt_state(self): file = open(os.path.join(self.session_base_dir, 'lt.state'), "w") file.write("Lorem ipsum") file.close() self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_session_zero_hops_working_lt_state(self): shutil.copy(os.path.join(self.LIBTORRENT_FILES_DIR, 'lt.state'), os.path.join(self.session_base_dir, 'lt.state')) self.ltmgr.initialize() ltsession = self.ltmgr.get_session(0) self.assertTrue(ltsession) def test_get_metainfo_not_ready(self): """ Testing the metainfo fetching method when the DHT is not ready """ self.ltmgr.initialize() self.assertFalse(self.ltmgr.get_metainfo("a" * 20, None)) @trial_timeout(20) def test_get_metainfo(self): """ Testing the metainfo fetching method """ test_deferred = Deferred() def metainfo_cb(metainfo): self.assertEqual( metainfo, { 'info': { 'pieces': ['a'] }, 'leechers': 0, 'nodes': [], 'seeders': 0, 'initial peers': [] }) test_deferred.callback(None) infohash = "a" * 20 self.ltmgr.initialize() torrent_info = MockObject() torrent_info.metadata = lambda: bencode({'pieces': ['a']}) torrent_info.trackers = lambda: [] fake_handle = MockObject() fake_handle.is_valid = lambda: True fake_handle.has_metadata = lambda: True fake_handle.get_peer_info = lambda: [] fake_handle.torrent_file = lambda: torrent_info self.ltmgr.ltsession_metainfo.add_torrent = lambda *_: fake_handle self.ltmgr.ltsession_metainfo.remove_torrent = lambda *_: None fake_alert = type('lt.metadata_received_alert', (object, ), dict(handle=fake_handle)) self.ltmgr.ltsession_metainfo.pop_alerts = lambda: [fake_alert] self.ltmgr.get_metainfo(unhexlify(infohash), metainfo_cb) return test_deferred @trial_timeout(20) def test_get_metainfo_cache(self): """ Testing metainfo caching """ test_deferred = Deferred() def metainfo_cb(metainfo): self.assertEqual(metainfo, "test") test_deferred.callback(None) self.ltmgr.initialize() self.ltmgr.metainfo_cache[hexlify("a" * 20)] = {'meta_info': 'test'} self.ltmgr.get_metainfo("a" * 20, metainfo_cb) return test_deferred @trial_timeout(20) def test_got_metainfo(self): """ Testing whether the callback is correctly invoked when we received metainfo """ test_deferred = Deferred() self.ltmgr.initialize() def metainfo_cb(metainfo): self.assertDictEqual( metainfo, { 'info': { 'pieces': ['a'] }, 'leechers': 0, 'nodes': [], 'seeders': 0, 'initial peers': [] }) test_deferred.callback(None) fake_handle = MockObject() torrent_info = MockObject() torrent_info.metadata = lambda: bencode({'pieces': ['a']}) torrent_info.trackers = lambda: [] fake_handle.get_peer_info = lambda: [] fake_handle.torrent_file = lambda: torrent_info self.ltmgr.ltsession_metainfo.remove_torrent = lambda *_: None self.ltmgr.metainfo_requests['a' * 20] = { 'handle': fake_handle, 'timeout_callbacks': [], 'callbacks': [metainfo_cb], 'notify': False } self.ltmgr.got_metainfo("a" * 20) return test_deferred @trial_timeout(20) def test_got_metainfo_timeout(self): """ Testing whether the callback is correctly invoked when we received metainfo after timeout """ test_deferred = Deferred() def metainfo_timeout_cb(metainfo): self.assertEqual(metainfo, 'a' * 20) test_deferred.callback(None) fake_handle = MockObject() self.ltmgr.initialize() self.ltmgr.metainfo_requests[hexlify('a' * 20)] = { 'handle': fake_handle, 'timeout_callbacks': [metainfo_timeout_cb], 'callbacks': [], 'notify': True } self.ltmgr.ltsession_metainfo.remove_torrent = lambda _dummy1, _dummy2: None self.ltmgr.got_metainfo(hexlify('a' * 20), timeout=True) return test_deferred @trial_timeout(20) def test_get_metainfo_with_already_added_torrent(self): """ Testing metainfo fetching for a torrent which is already in session. got_metainfo() should be called with timeout=False. """ magnet_link = "magnet:?xt=urn:btih:f72636475a375653083e49d501601675ce3e6619&dn=ubuntu-16.04.3-server-i386.iso" test_deferred = Deferred() def fake_got_metainfo(_, timeout): self.assertFalse(timeout, "Timeout should not be True") test_deferred.callback(None) mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: True mock_handle.has_metadata = lambda: True mock_ltsession = MockObject() mock_ltsession.add_torrent = lambda _: mock_handle mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [] mock_ltsession.start_upnp = lambda: None mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.ltsession_metainfo = mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') self.ltmgr.got_metainfo = fake_got_metainfo self.ltmgr.get_metainfo(magnet_link, lambda _: None) return test_deferred @trial_timeout(20) def test_add_torrent(self): """ Testing the addition of a torrent to the libtorrent manager """ test_deferred = Deferred() mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: False mock_error = MockObject() mock_error.value = lambda: None mock_alert = type('add_torrent_alert', (object, ), dict(handle=mock_handle, error=mock_error))() mock_ltsession = MockObject() mock_ltsession.async_add_torrent = lambda _: reactor.callLater( 0.1, self.ltmgr.process_alert, mock_alert) mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [] mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.get_session = lambda *_: mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') infohash = MockObject() infohash.info_hash = lambda: 'a' * 20 mock_download = MockObject() mock_download.deferred_added = Deferred() def cb_torrent_added(handle): self.assertEqual(handle, mock_handle) test_deferred.callback(None) self.ltmgr.add_torrent(mock_download, { 'ti': infohash }).addCallback(cb_torrent_added) return test_deferred @trial_timeout(20) def test_add_torrent_desync(self): """ Testing the addition of a torrent to the libtorrent manager, if it already exists in the session. """ mock_handle = MockObject() mock_handle.info_hash = lambda: 'a' * 20 mock_handle.is_valid = lambda: True mock_alert = type('add_torrent_alert', (object, ), dict(handle=mock_handle)) mock_ltsession = MockObject() mock_ltsession.async_add_torrent = lambda _: self.ltmgr.process_alert( mock_alert) mock_ltsession.find_torrent = lambda _: mock_handle mock_ltsession.get_torrents = lambda: [mock_handle] mock_ltsession.stop_upnp = lambda: None mock_ltsession.save_state = lambda: None self.ltmgr.get_session = lambda *_: mock_ltsession self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') infohash = MockObject() infohash.info_hash = lambda: 'a' * 20 mock_download = MockObject() mock_download.deferred_added = Deferred() return self.ltmgr.add_torrent(mock_download, { 'ti': infohash }).addCallback(lambda handle: self.assertEqual(handle, mock_handle)) def test_remove_invalid_torrent(self): """ Tests a successful removal status of torrents without a handle """ self.ltmgr.initialize() mock_dl = MockObject() mock_dl.handle = None self.assertTrue(self.ltmgr.remove_torrent(mock_dl).called) def test_remove_invalid_handle_torrent(self): """ Tests a successful removal status of torrents with an invalid handle """ self.ltmgr.initialize() mock_handle = MockObject() mock_handle.is_valid = lambda: False mock_dl = MockObject() mock_dl.handle = mock_handle self.assertTrue(self.ltmgr.remove_torrent(mock_dl).called) def test_remove_unregistered_torrent(self): """ Tests a successful removal status of torrents which aren't known """ self.ltmgr.initialize() mock_handle = MockObject() mock_handle.is_valid = lambda: False alert = type('torrent_removed_alert', (object, ), dict(handle=mock_handle, info_hash='0' * 20)) self.ltmgr.process_alert(alert()) self.assertNotIn('0' * 20, self.ltmgr.torrents) def test_start_download_corrupt(self): """ Testing whether starting the download of a corrupt torrent file raises an exception """ self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') corrupt_file = os.path.join(self.LIBTORRENT_FILES_DIR, 'corrupt_torrent.torrent') self.assertRaises(TorrentFileException, self.ltmgr.start_download, torrentfilename=corrupt_file) def test_start_download_duplicate(self): """ Test the starting of a download when there are no new trackers """ mock_tdef = MockObject() mock_tdef.get_infohash = lambda: 'a' * 20 mock_tdef.get_trackers_as_single_tuple = lambda: tuple() mock_download = MockObject() mock_download.get_def = lambda: mock_tdef mock_download.get_credit_mining = lambda: False self.tribler_session.get_download = lambda _: mock_download self.tribler_session.start_download_from_tdef = lambda tdef, _: MockObject( ) self.ltmgr.tribler_session = self.tribler_session self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') self.ltmgr.start_download(infohash='a' * 20, tdef=mock_tdef) def test_set_proxy_settings(self): """ Test setting the proxy settings """ def on_proxy_set(settings): self.assertTrue(settings) self.assertEqual(settings.hostname, 'a') self.assertEqual(settings.port, 1234) self.assertEqual(settings.username, 'abc') self.assertEqual(settings.password, 'def') def on_set_settings(settings): self.assertTrue(settings) self.assertEqual(settings['proxy_hostname'], 'a') self.assertEqual(settings['proxy_port'], 1234) self.assertEqual(settings['proxy_username'], 'abc') self.assertEqual(settings['proxy_password'], 'def') self.assertEqual(settings['proxy_peer_connections'], True) self.assertEqual(settings['proxy_hostnames'], True) mock_lt_session = MockObject() mock_lt_session.get_settings = lambda: {} mock_lt_session.set_settings = on_set_settings mock_lt_session.set_proxy = on_proxy_set # Libtorrent < 1.1.0 uses set_proxy to set proxy settings self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') self.ltmgr.set_proxy_settings(mock_lt_session, 0, ('a', "1234"), ('abc', 'def')) def test_save_resume_preresolved_magnet(self): """ Test whether a magnet link correctly writes save-resume data before it is resolved. This can happen when a magnet link is added when the user does not have internet. """ self.ltmgr.initialize() self.ltmgr.trsession = self.tribler_session self.ltmgr.metadata_tmpdir = tempfile.mkdtemp( suffix=u'tribler_metainfo_tmpdir') mock_tdef = MockObject() mock_tdef.get_infohash = lambda: 'a' * 20 self.tribler_session.get_download = lambda _: None self.tribler_session.get_downloads_pstate_dir = lambda: self.ltmgr.metadata_tmpdir mock_lm = MockObject() mock_lm.ltmgr = self.ltmgr mock_lm.tunnel_community = None self.tribler_session.lm = mock_lm def dl_from_tdef(tdef, _): dl = LibtorrentDownloadImpl(self.tribler_session, tdef) dl.setup() dl.cancel_all_pending_tasks() return dl self.tribler_session.start_download_from_tdef = dl_from_tdef download = self.ltmgr.start_download_from_magnet( "magnet:?xt=urn:btih:" + ('1' * 40)) basename = hexlify(download.get_def().get_infohash()) + '.state' filename = os.path.join(download.session.get_downloads_pstate_dir(), basename) self.assertTrue(os.path.isfile(filename)) @trial_timeout(5) def test_callback_on_alert(self): """ Test whether the alert callback is called when a libtorrent alert is posted """ self.ltmgr.default_alert_mask = 0xffffffff test_deferred = Deferred() def callback(*args): self.ltmgr.alert_callback = None test_deferred.callback(None) callback.called = False self.ltmgr.alert_callback = callback self.ltmgr.initialize() self.ltmgr._task_process_alerts() return test_deferred def test_payout_on_disconnect(self): """ Test whether a payout is initialized when a peer disconnects """ class peer_disconnected_alert(object): def __init__(self): self.pid = MockObject() self.pid.to_string = lambda: 'a' * 20 def mocked_do_payout(mid): self.assertEqual(mid, 'a' * 20) mocked_do_payout.called = True mocked_do_payout.called = False disconnect_alert = peer_disconnected_alert() self.ltmgr.tribler_session.lm.payout_manager = MockObject() self.ltmgr.tribler_session.lm.payout_manager.do_payout = mocked_do_payout self.ltmgr.initialize() self.ltmgr.get_session(0).pop_alerts = lambda: [disconnect_alert] self.ltmgr._task_process_alerts() self.assertTrue(mocked_do_payout.called) def test_post_session_stats(self): """ Test whether post_session_stats actually updates the state of libtorrent readiness for clean shutdown. """ def check_if_session_shutdown_is_ready(): self.ltmgr._task_process_alerts() self.assertTrue(self.ltmgr.lt_session_shutdown_ready[0]) self.ltmgr.default_alert_mask = 0xffffffff self.ltmgr.initialize() # Zero hop session should be initialized self.assertFalse(self.ltmgr.lt_session_shutdown_ready[0]) # Check for status with session stats alert self.ltmgr.post_session_stats(hops=0) # Wait sometime to get the alert and check the status return deferLater(reactor, 0.01, check_if_session_shutdown_is_ready)
class TriblerLaunchMany(TaskManager): def __init__(self): """ Called only once (unless we have multiple Sessions) by MainThread """ super(TriblerLaunchMany, self).__init__() self.initComplete = False self.registered = False self.dispersy = None self.state_cb_count = 0 self.previous_active_downloads = [] self.download_states_lc = None self.get_peer_list = [] self._logger = logging.getLogger(self.__class__.__name__) self.downloads = {} self.upnp_ports = [] self.session = None self.sesslock = None self.sessdoneflag = Event() self.shutdownstarttime = None # modules self.torrent_store = None self.metadata_store = None self.rtorrent_handler = None self.tftp_handler = None self.api_manager = None self.watch_folder = None self.version_check_manager = None self.resource_monitor = None self.category = None self.peer_db = None self.torrent_db = None self.mypref_db = None self.votecast_db = None self.channelcast_db = None self.search_manager = None self.channel_manager = None self.video_server = None self.mainline_dht = None self.ltmgr = None self.tracker_manager = None self.torrent_checker = None self.tunnel_community = None self.startup_deferred = Deferred() self.boosting_manager = None def register(self, session, sesslock): assert isInIOThread() if not self.registered: self.registered = True self.session = session self.sesslock = sesslock # On Mac, we bundle the root certificate for the SSL validation since Twisted is not using the root # certificates provided by the system trust store. if sys.platform == 'darwin': os.environ['SSL_CERT_FILE'] = os.path.join( get_lib_path(), 'root_certs_mac.pem') if self.session.get_torrent_store(): from Tribler.Core.leveldbstore import LevelDbStore self.torrent_store = LevelDbStore( self.session.get_torrent_store_dir()) if not self.torrent_store.get_db(): raise RuntimeError( "Torrent store (leveldb) is None which should not normally happen" ) if self.session.get_enable_metadata(): from Tribler.Core.leveldbstore import LevelDbStore self.metadata_store = LevelDbStore( self.session.get_metadata_store_dir()) if not self.metadata_store.get_db(): raise RuntimeError( "Metadata store (leveldb) is None which should not normally happen" ) # torrent collecting: RemoteTorrentHandler if self.session.get_torrent_collecting(): from Tribler.Core.RemoteTorrentHandler import RemoteTorrentHandler self.rtorrent_handler = RemoteTorrentHandler(self.session) # TODO(emilon): move this to a megacache component or smth if self.session.get_megacache(): from Tribler.Core.CacheDB.SqliteCacheDBHandler import ( PeerDBHandler, TorrentDBHandler, MyPreferenceDBHandler, VoteCastDBHandler, ChannelCastDBHandler) from Tribler.Core.Category.Category import Category self._logger.debug('tlm: Reading Session state from %s', self.session.get_state_dir()) self.category = Category() # create DBHandlers self.peer_db = PeerDBHandler(self.session) self.torrent_db = TorrentDBHandler(self.session) self.mypref_db = MyPreferenceDBHandler(self.session) self.votecast_db = VoteCastDBHandler(self.session) self.channelcast_db = ChannelCastDBHandler(self.session) # initializes DBHandlers self.peer_db.initialize() self.torrent_db.initialize() self.mypref_db.initialize() self.votecast_db.initialize() self.channelcast_db.initialize() from Tribler.Core.Modules.tracker_manager import TrackerManager self.tracker_manager = TrackerManager(self.session) if self.session.get_videoserver_enabled(): self.video_server = VideoServer( self.session.get_videoserver_port(), self.session) self.video_server.start() # Dispersy self.tftp_handler = None if self.session.get_dispersy(): from Tribler.dispersy.dispersy import Dispersy from Tribler.dispersy.endpoint import StandaloneEndpoint # set communication endpoint endpoint = StandaloneEndpoint(self.session.get_dispersy_port(), ip=self.session.get_ip()) working_directory = unicode(self.session.get_state_dir()) self.dispersy = Dispersy(endpoint, working_directory) # register TFTP service from Tribler.Core.TFTP.handler import TftpHandler self.tftp_handler = TftpHandler(self.session, endpoint, "fffffffd".decode('hex'), block_size=1024) self.tftp_handler.initialize() if self.session.get_enable_torrent_search( ) or self.session.get_enable_channel_search(): self.search_manager = SearchManager(self.session) self.search_manager.initialize() if not self.initComplete: self.init() self.session.add_observer(self.on_tribler_started, NTFY_TRIBLER, [NTFY_STARTED]) self.session.notifier.notify(NTFY_TRIBLER, NTFY_STARTED, None) return self.startup_deferred def on_tribler_started(self, subject, changetype, objectID, *args): reactor.callFromThread(self.startup_deferred.callback, None) @blocking_call_on_reactor_thread def load_communities(self): self._logger.info("tribler: Preparing communities...") now_time = timemod.time() default_kwargs = {'tribler_session': self.session} # Search Community if self.session.get_enable_torrent_search(): from Tribler.community.search.community import SearchCommunity self.dispersy.define_auto_load(SearchCommunity, self.session.dispersy_member, load=True, kargs=default_kwargs) # AllChannel Community if self.session.get_enable_channel_search(): from Tribler.community.allchannel.community import AllChannelCommunity self.dispersy.define_auto_load(AllChannelCommunity, self.session.dispersy_member, load=True, kargs=default_kwargs) # Channel Community if self.session.get_channel_community_enabled(): from Tribler.community.channel.community import ChannelCommunity self.dispersy.define_auto_load(ChannelCommunity, self.session.dispersy_member, load=True, kargs=default_kwargs) # PreviewChannel Community if self.session.get_preview_channel_community_enabled(): from Tribler.community.channel.preview import PreviewChannelCommunity self.dispersy.define_auto_load(PreviewChannelCommunity, self.session.dispersy_member, kargs=default_kwargs) # MultiChain Community if self.session.get_enable_multichain(): multichain_kwargs = {'tribler_session': self.session} # If the multichain is enabled, we use the permanent multichain keypair # for both the multichain and the tunnel community keypair = self.session.multichain_keypair dispersy_member = self.dispersy.get_member( private_key=keypair.key_to_bin()) from Tribler.community.multichain.community import MultiChainCommunity self.dispersy.define_auto_load(MultiChainCommunity, dispersy_member, load=True, kargs=multichain_kwargs) else: keypair = self.dispersy.crypto.generate_key(u"curve25519") dispersy_member = self.dispersy.get_member( private_key=self.dispersy.crypto.key_to_bin(keypair)) # Tunnel Community if self.session.get_tunnel_community_enabled(): tunnel_settings = TunnelSettings(tribler_session=self.session) tunnel_kwargs = { 'tribler_session': self.session, 'settings': tunnel_settings } from Tribler.community.tunnel.hidden_community import HiddenTunnelCommunity self.tunnel_community = self.dispersy.define_auto_load( HiddenTunnelCommunity, dispersy_member, load=True, kargs=tunnel_kwargs)[0] # We don't want to automatically load other instances of this community with other master members. self.dispersy.undefine_auto_load(HiddenTunnelCommunity) self._logger.info("tribler: communities are ready in %.2f seconds", timemod.time() - now_time) def init(self): if self.dispersy: from Tribler.dispersy.community import HardKilledCommunity self._logger.info("lmc: Starting Dispersy...") self.session.readable_status = STATE_STARTING_DISPERSY now = timemod.time() success = self.dispersy.start(self.session.autoload_discovery) diff = timemod.time() - now if success: self._logger.info( "lmc: Dispersy started successfully in %.2f seconds [port: %d]", diff, self.dispersy.wan_address[1]) else: self._logger.info( "lmc: Dispersy failed to start in %.2f seconds", diff) self.upnp_ports.append((self.dispersy.wan_address[1], 'UDP')) from Tribler.dispersy.crypto import M2CryptoSK self.session.dispersy_member = blockingCallFromThread( reactor, self.dispersy.get_member, private_key=self.dispersy.crypto.key_to_bin( M2CryptoSK( filename=self.session.get_permid_keypair_filename()))) blockingCallFromThread(reactor, self.dispersy.define_auto_load, HardKilledCommunity, self.session.dispersy_member, load=True) if self.session.get_megacache(): self.dispersy.database.attach_commit_callback( self.session.sqlite_db.commit_now) # notify dispersy finished loading self.session.notifier.notify(NTFY_DISPERSY, NTFY_STARTED, None) self.session.readable_status = STATE_LOADING_COMMUNITIES self.load_communities() self.session.set_anon_proxy_settings( 2, ("127.0.0.1", self.session.get_tunnel_community_socks5_listen_ports())) if self.session.get_enable_channel_search(): self.session.readable_status = STATE_INITIALIZE_CHANNEL_MGR from Tribler.Core.Modules.channel.channel_manager import ChannelManager self.channel_manager = ChannelManager(self.session) self.channel_manager.initialize() if self.session.get_mainline_dht(): self.session.readable_status = STATE_START_MAINLINE_DHT from Tribler.Core.DecentralizedTracking import mainlineDHT self.mainline_dht = mainlineDHT.init( ('127.0.0.1', self.session.get_mainline_dht_listen_port()), self.session.get_state_dir()) self.upnp_ports.append( (self.session.get_mainline_dht_listen_port(), 'UDP')) if self.session.get_libtorrent(): self.session.readable_status = STATE_START_LIBTORRENT from Tribler.Core.Libtorrent.LibtorrentMgr import LibtorrentMgr self.ltmgr = LibtorrentMgr(self.session) self.ltmgr.initialize() for port, protocol in self.upnp_ports: self.ltmgr.add_upnp_mapping(port, protocol) # add task for tracker checking if self.session.get_torrent_checking(): self.session.readable_status = STATE_START_TORRENT_CHECKER self.torrent_checker = TorrentChecker(self.session) self.torrent_checker.initialize() if self.rtorrent_handler: self.session.readable_status = STATE_START_REMOTE_TORRENT_HANDLER self.rtorrent_handler.initialize() if self.api_manager: self.session.readable_status = STATE_START_API_ENDPOINTS self.api_manager.root_endpoint.start_endpoints() if self.session.get_watch_folder_enabled(): self.session.readable_status = STATE_START_WATCH_FOLDER self.watch_folder = WatchFolder(self.session) self.watch_folder.start() if self.session.get_creditmining_enable(): self.session.readable_status = STATE_START_CREDIT_MINING from Tribler.Core.CreditMining.BoostingManager import BoostingManager self.boosting_manager = BoostingManager(self.session) if self.session.get_resource_monitor_enabled(): self.session.readable_status = STATE_START_RESOURCE_MONITOR self.resource_monitor = ResourceMonitor(self.session) self.resource_monitor.start() self.version_check_manager = VersionCheckManager(self.session) self.session.set_download_states_callback(self.sesscb_states_callback) self.initComplete = True def add(self, tdef, dscfg, pstate=None, setupDelay=0, hidden=False, share_mode=False, checkpoint_disabled=False): """ Called by any thread """ d = None with self.sesslock: if not isinstance( tdef, TorrentDefNoMetainfo) and not tdef.is_finalized(): raise ValueError("TorrentDef not finalized") infohash = tdef.get_infohash() # Create the destination directory if it does not exist yet try: if not os.path.isdir(dscfg.get_dest_dir()): os.makedirs(dscfg.get_dest_dir()) except OSError: self._logger.error( "Unable to create the download destination directory.") if dscfg.get_time_added() == 0: dscfg.set_time_added(int(timemod.time())) # Check if running or saved on disk if infohash in self.downloads: raise DuplicateDownloadException( "This download already exists.") from Tribler.Core.Libtorrent.LibtorrentDownloadImpl import LibtorrentDownloadImpl d = LibtorrentDownloadImpl(self.session, tdef) if pstate is None: # not already resuming pstate = self.load_download_pstate_noexc(infohash) if pstate is not None: self._logger.debug("tlm: add: pstate is %s %s", pstate.get('dlstate', 'status'), pstate.get('dlstate', 'progress')) # Store in list of Downloads, always. self.downloads[infohash] = d setup_deferred = d.setup(dscfg, pstate, wrapperDelay=setupDelay, share_mode=share_mode, checkpoint_disabled=checkpoint_disabled) setup_deferred.addCallback(self.on_download_handle_created) if d and not hidden and self.session.get_megacache(): @forceDBThread def write_my_pref(): torrent_id = self.torrent_db.getTorrentID(infohash) data = {'destination_path': d.get_dest_dir()} self.mypref_db.addMyPreference(torrent_id, data) if isinstance(tdef, TorrentDefNoMetainfo): self.torrent_db.addOrGetTorrentID(tdef.get_infohash()) self.torrent_db.updateTorrent(tdef.get_infohash(), name=tdef.get_name_as_unicode()) write_my_pref() elif self.rtorrent_handler: self.rtorrent_handler.save_torrent(tdef, write_my_pref) else: self.torrent_db.addExternalTorrent( tdef, extra_info={'status': 'good'}) write_my_pref() return d def on_download_handle_created(self, download): """ This method is called when the download handle has been created. Immediately checkpoint the download and write the resume data. """ return download.checkpoint() def remove(self, d, removecontent=False, removestate=True, hidden=False): """ Called by any thread """ out = None with self.sesslock: out = d.stop_remove(removestate=removestate, removecontent=removecontent) infohash = d.get_def().get_infohash() if infohash in self.downloads: del self.downloads[infohash] if not hidden: self.remove_id(infohash) if self.tunnel_community: self.tunnel_community.on_download_removed(d) return out or succeed(None) def remove_id(self, infohash): @forceDBThread def do_db(): torrent_id = self.torrent_db.getTorrentID(infohash) if torrent_id: self.mypref_db.deletePreference(torrent_id) if self.session.get_megacache(): do_db() def get_downloads(self): """ Called by any thread """ with self.sesslock: return self.downloads.values() # copy, is mutable def get_download(self, infohash): """ Called by any thread """ with self.sesslock: return self.downloads.get(infohash, None) def download_exists(self, infohash): with self.sesslock: return infohash in self.downloads @blocking_call_on_reactor_thread @inlineCallbacks def update_download_hops(self, download, new_hops): """ Update the amount of hops for a specified download. This can be done on runtime. """ infohash = binascii.hexlify(download.tdef.get_infohash()) self._logger.info("Updating the amount of hops of download %s", infohash) yield self.session.remove_download(download) # copy the old download_config and change the hop count dscfg = download.copy() dscfg.set_hops(new_hops) self.session.start_download_from_tdef(download.tdef, dscfg) def update_trackers(self, infohash, trackers): """ Update the trackers for a download. :param infohash: infohash of the torrent that needs to be updated :param trackers: A list of tracker urls. """ dl = self.get_download(infohash) old_def = dl.get_def() if dl else None if old_def: old_trackers = old_def.get_trackers_as_single_tuple() new_trackers = list(set(trackers) - set(old_trackers)) all_trackers = list(old_trackers) + new_trackers if new_trackers: # Add new trackers to the download dl.add_trackers(new_trackers) # Create a new TorrentDef if isinstance(old_def, TorrentDefNoMetainfo): new_def = TorrentDefNoMetainfo(old_def.get_infohash(), old_def.get_name(), dl.get_magnet_link()) else: metainfo = old_def.get_metainfo() if len(all_trackers) > 1: metainfo["announce-list"] = [all_trackers] else: metainfo["announce"] = all_trackers[0] new_def = TorrentDef.load_from_dict(metainfo) # Set TorrentDef + checkpoint dl.set_def(new_def) dl.checkpoint() if isinstance(old_def, TorrentDefNoMetainfo): @forceDBThread def update_trackers_db(infohash, new_trackers): torrent_id = self.torrent_db.getTorrentID(infohash) if torrent_id is not None: self.torrent_db.addTorrentTrackerMappingInBatch( torrent_id, new_trackers) self.session.notifier.notify( NTFY_TORRENTS, NTFY_UPDATE, infohash) if self.session.get_megacache(): update_trackers_db(infohash, new_trackers) elif not isinstance( old_def, TorrentDefNoMetainfo) and self.rtorrent_handler: # Update collected torrents self.rtorrent_handler.save_torrent(new_def) # # State retrieval # def stop_download_states_callback(self): """ Stop any download states callback if present. """ if self.is_pending_task_active("download_states_lc"): self.cancel_pending_task("download_states_lc") def set_download_states_callback(self, usercallback, interval=1.0): """ Set the download state callback. Remove any old callback if it's present. """ self.stop_download_states_callback() self._logger.debug( "Starting the download state callback with interval %f", interval) self.download_states_lc = self.register_task( "download_states_lc", LoopingCall(self._invoke_states_cb, usercallback)) self.download_states_lc.start(interval) def _invoke_states_cb(self, callback): """ Invoke the download states callback with a list of the download states. """ dslist = [] for d in self.downloads.values(): d.set_moreinfo_stats( True in self.get_peer_list or d.get_def().get_infohash() in self.get_peer_list) ds = d.network_get_state(None, False) dslist.append(ds) def on_cb_done(new_get_peer_list): self.get_peer_list = new_get_peer_list return deferToThread(callback, dslist).addCallback(on_cb_done) def sesscb_states_callback(self, states_list): """ This method is periodically (every second) called with a list of the download states of the active downloads. """ self.state_cb_count += 1 # Check to see if a download has finished new_active_downloads = [] do_checkpoint = False seeding_download_list = [] for ds in states_list: state = ds.get_status() download = ds.get_download() tdef = download.get_def() safename = tdef.get_name_as_unicode() if state == DLSTATUS_DOWNLOADING: new_active_downloads.append(safename) elif state == DLSTATUS_STOPPED_ON_ERROR: self._logger.error("Error during download: %s", repr(ds.get_error())) if self.download_exists(tdef.get_infohash()): self.get_download(tdef.get_infohash()).stop() self.session.notifier.notify(NTFY_TORRENT, NTFY_ERROR, tdef.get_infohash(), repr(ds.get_error())) elif state == DLSTATUS_SEEDING: seeding_download_list.append({ u'infohash': tdef.get_infohash(), u'download': download }) if safename in self.previous_active_downloads: self.session.notifier.notify(NTFY_TORRENT, NTFY_FINISHED, tdef.get_infohash(), safename) do_checkpoint = True self.previous_active_downloads = new_active_downloads if do_checkpoint: self.session.checkpoint_downloads() if self.state_cb_count % 4 == 0 and self.tunnel_community: self.tunnel_community.monitor_downloads(states_list) return [] # # Persistence methods # def load_checkpoint(self): """ Called by any thread """ def do_load_checkpoint(): with self.sesslock: for i, filename in enumerate( iglob( os.path.join( self.session.get_downloads_pstate_dir(), '*.state'))): self.resume_download(filename, setupDelay=i * 0.1) if self.initComplete: do_load_checkpoint() else: self.register_task("load_checkpoint", reactor.callLater(1, do_load_checkpoint)) def load_download_pstate_noexc(self, infohash): """ Called by any thread, assume sesslock already held """ try: basename = binascii.hexlify(infohash) + '.state' filename = os.path.join(self.session.get_downloads_pstate_dir(), basename) if os.path.exists(filename): return self.load_download_pstate(filename) else: self._logger.info("%s not found", basename) except Exception: self._logger.exception("Exception while loading pstate: %s", infohash) def resume_download(self, filename, setupDelay=0): tdef = dscfg = pstate = None try: pstate = self.load_download_pstate(filename) # SWIFTPROC metainfo = pstate.get('state', 'metainfo') if 'infohash' in metainfo: tdef = TorrentDefNoMetainfo(metainfo['infohash'], metainfo['name'], metainfo.get('url', None)) else: tdef = TorrentDef.load_from_dict(metainfo) if pstate.has_option('downloadconfig', 'saveas') and \ isinstance(pstate.get('downloadconfig', 'saveas'), tuple): pstate.set('downloadconfig', 'saveas', pstate.get('downloadconfig', 'saveas')[-1]) dscfg = DownloadStartupConfig(pstate) except: # pstate is invalid or non-existing _, file = os.path.split(filename) infohash = binascii.unhexlify(file[:-6]) torrent_data = self.torrent_store.get(infohash) if torrent_data: try: tdef = TorrentDef.load_from_memory(torrent_data) defaultDLConfig = DefaultDownloadStartupConfig.getInstance( ) dscfg = defaultDLConfig.copy() if self.mypref_db is not None: dest_dir = self.mypref_db.getMyPrefStatsInfohash( infohash) if dest_dir and os.path.isdir(dest_dir): dscfg.set_dest_dir(dest_dir) except ValueError: self._logger.warning("tlm: torrent data invalid") if pstate is not None: has_resume_data = pstate.get('state', 'engineresumedata') is not None self._logger.debug( "tlm: load_checkpoint: resumedata %s", 'len %s ' % len(pstate.get('state', 'engineresumedata')) if has_resume_data else 'None') if tdef and dscfg: if dscfg.get_dest_dir() != '': # removed torrent ignoring try: if not self.download_exists(tdef.get_infohash()): self.add(tdef, dscfg, pstate, setupDelay=setupDelay) else: self._logger.info( "tlm: not resuming checkpoint because download has already been added" ) except Exception as e: self._logger.exception( "tlm: load check_point: exception while adding download %s", tdef) else: self._logger.info("tlm: removing checkpoint %s destdir is %s", filename, dscfg.get_dest_dir()) os.remove(filename) else: self._logger.info("tlm: could not resume checkpoint %s %s %s", filename, tdef, dscfg) def checkpoint_downloads(self): """ Checkpoints all running downloads in Tribler. Even if the list of Downloads changes in the mean time this is no problem. For removals, dllist will still hold a pointer to the download, and additions are no problem (just won't be included in list of states returned via callback). """ downloads = self.downloads.values() deferred_list = [] self._logger.debug("tlm: checkpointing %s downloads", len(downloads)) for download in downloads: deferred_list.append(download.checkpoint()) return DeferredList(deferred_list) def shutdown_downloads(self): """ Shutdown all downloads in Tribler. """ for download in self.downloads.values(): download.stop() def remove_pstate(self, infohash): def do_remove(): if not self.download_exists(infohash): dlpstatedir = self.session.get_downloads_pstate_dir() # Remove checkpoint hexinfohash = binascii.hexlify(infohash) try: basename = hexinfohash + '.state' filename = os.path.join(dlpstatedir, basename) self._logger.debug( "remove pstate: removing dlcheckpoint entry %s", filename) if os.access(filename, os.F_OK): os.remove(filename) except: # Show must go on self._logger.exception("Could not remove state") else: self._logger.warning( "remove pstate: download is back, restarted? Canceling removal! %s", repr(infohash)) reactor.callFromThread(do_remove) @inlineCallbacks def early_shutdown(self): """ Called as soon as Session shutdown is initiated. Used to start shutdown tasks that takes some time and that can run in parallel to checkpointing, etc. :returns a Deferred that will fire once all dependencies acknowledge they have shutdown. """ self._logger.info("tlm: early_shutdown") self.cancel_all_pending_tasks() # Note: sesslock not held self.shutdownstarttime = timemod.time() if self.boosting_manager: yield self.boosting_manager.shutdown() self.boosting_manager = None if self.torrent_checker: yield self.torrent_checker.shutdown() self.torrent_checker = None if self.channel_manager: yield self.channel_manager.shutdown() self.channel_manager = None if self.search_manager: yield self.search_manager.shutdown() self.search_manager = None if self.rtorrent_handler: yield self.rtorrent_handler.shutdown() self.rtorrent_handler = None if self.video_server: yield self.video_server.shutdown_server() self.video_server = None if self.version_check_manager: self.version_check_manager.stop() self.version_check_manager = None if self.resource_monitor: self.resource_monitor.stop() self.resource_monitor = None self.tracker_manager = None if self.dispersy: self._logger.info("lmc: Shutting down Dispersy...") now = timemod.time() try: success = yield self.dispersy.stop() except: print_exc() success = False diff = timemod.time() - now if success: self._logger.info( "lmc: Dispersy successfully shutdown in %.2f seconds", diff) else: self._logger.info( "lmc: Dispersy failed to shutdown in %.2f seconds", diff) if self.metadata_store is not None: yield self.metadata_store.close() self.metadata_store = None if self.tftp_handler is not None: yield self.tftp_handler.shutdown() self.tftp_handler = None if self.channelcast_db is not None: yield self.channelcast_db.close() self.channelcast_db = None if self.votecast_db is not None: yield self.votecast_db.close() self.votecast_db = None if self.mypref_db is not None: yield self.mypref_db.close() self.mypref_db = None if self.torrent_db is not None: yield self.torrent_db.close() self.torrent_db = None if self.peer_db is not None: yield self.peer_db.close() self.peer_db = None if self.mainline_dht is not None: from Tribler.Core.DecentralizedTracking import mainlineDHT yield mainlineDHT.deinit(self.mainline_dht) self.mainline_dht = None if self.torrent_store is not None: yield self.torrent_store.close() self.torrent_store = None if self.watch_folder is not None: yield self.watch_folder.stop() self.watch_folder = None # We close the API manager as late as possible during shutdown. if self.api_manager is not None: yield self.api_manager.stop() self.api_manager = None def network_shutdown(self): try: self._logger.info("tlm: network_shutdown") ts = enumerate_threads() self._logger.info("tlm: Number of threads still running %d", len(ts)) for t in ts: self._logger.info( "tlm: Thread still running=%s, daemon=%s, instance=%s", t.getName(), t.isDaemon(), t) except: print_exc() # Stop network thread self.sessdoneflag.set() # Shutdown libtorrent session after checkpoints have been made if self.ltmgr is not None: self.ltmgr.shutdown() self.ltmgr = None def save_download_pstate(self, infohash, pstate): """ Called by network thread """ self.downloads[infohash].pstate_for_restart = pstate self.register_task("save_pstate %f" % timemod.clock(), self.downloads[infohash].save_resume_data()) def load_download_pstate(self, filename): """ Called by any thread """ pstate = CallbackConfigParser() pstate.read_file(filename) return pstate # Events from core meant for API user # def sessconfig_changed_callback(self, section, name, new_value, old_value): value_changed = new_value != old_value if section == 'libtorrent' and name == 'utp': if self.ltmgr and value_changed: self.ltmgr.set_utp(new_value) elif section == 'libtorrent' and name == 'lt_proxyauth': if self.ltmgr: self.ltmgr.set_proxy_settings( None, *self.session.get_libtorrent_proxy_settings()) # Return True/False, depending on whether or not the config value can be changed at runtime. elif (section == 'general' and name in ['nickname', 'mugshot', 'videoanalyserpath']) or \ (section == 'libtorrent' and name in ['lt_proxytype', 'lt_proxyserver', 'anon_proxyserver', 'anon_proxytype', 'anon_proxyauth', 'anon_listen_port']) or \ (section == 'torrent_collecting' and name in ['stop_collecting_threshold']) or \ (section == 'watch_folder') or \ (section == 'tunnel_community' and name in ['socks5_listen_port']) or \ (section == 'credit_mining' and name in ['max_torrents_per_source', 'max_torrents_active', 'source_interval', 'swarm_interval', 'boosting_sources', 'boosting_enabled', 'boosting_disabled', 'archive_sources']): return True else: return False return True
class TriblerLaunchMany(TaskManager): def __init__(self): """ Called only once (unless we have multiple Sessions) by MainThread """ super(TriblerLaunchMany, self).__init__() self.initComplete = False self.registered = False self.dispersy = None self._logger = logging.getLogger(self.__class__.__name__) self.downloads = {} self.upnp_ports = [] self.session = None self.sesslock = None self.sessdoneflag = Event() self.shutdownstarttime = None # modules self.threadpool = ThreadPoolManager() self.torrent_store = None self.metadata_store = None self.rtorrent_handler = None self.tftp_handler = None self.cat = None self.peer_db = None self.torrent_db = None self.mypref_db = None self.votecast_db = None self.channelcast_db = None self.search_manager = None self.channel_manager = None self.videoplayer = None self.mainline_dht = None self.ltmgr = None self.tracker_manager = None self.torrent_checker = None self.tunnel_community = None def register(self, session, sesslock, autoload_discovery=True): if not self.registered: self.registered = True self.session = session self.sesslock = sesslock if self.session.get_torrent_store(): from Tribler.Core.leveldbstore import LevelDbStore self.torrent_store = LevelDbStore( self.session.get_torrent_store_dir()) if self.session.get_enable_metadata(): from Tribler.Core.leveldbstore import LevelDbStore self.metadata_store = LevelDbStore( self.session.get_metadata_store_dir()) # torrent collecting: RemoteTorrentHandler if self.session.get_torrent_collecting(): from Tribler.Core.RemoteTorrentHandler import RemoteTorrentHandler self.rtorrent_handler = RemoteTorrentHandler(self.session) # TODO(emilon): move this to a megacache component or smth if self.session.get_megacache(): from Tribler.Core.CacheDB.SqliteCacheDBHandler import ( PeerDBHandler, TorrentDBHandler, MyPreferenceDBHandler, VoteCastDBHandler, ChannelCastDBHandler) from Tribler.Category.Category import Category self._logger.debug('tlm: Reading Session state from %s', self.session.get_state_dir()) self.cat = Category.getInstance(self.session) # create DBHandlers self.peer_db = PeerDBHandler(self.session) self.torrent_db = TorrentDBHandler(self.session) self.mypref_db = MyPreferenceDBHandler(self.session) self.votecast_db = VoteCastDBHandler(self.session) self.channelcast_db = ChannelCastDBHandler(self.session) # initializes DBHandlers self.peer_db.initialize() self.torrent_db.initialize() self.mypref_db.initialize() self.votecast_db.initialize() self.channelcast_db.initialize() from Tribler.Core.Modules.tracker_manager import TrackerManager self.tracker_manager = TrackerManager(self.session) self.tracker_manager.initialize() if self.session.get_videoplayer(): self.videoplayer = VideoPlayer(self.session) # Dispersy self.session.dispersy_member = None self.tftp_handler = None if self.session.get_dispersy(): from Tribler.dispersy.dispersy import Dispersy from Tribler.dispersy.endpoint import StandaloneEndpoint # set communication endpoint endpoint = StandaloneEndpoint(self.session.get_dispersy_port(), ip=self.session.get_ip()) working_directory = unicode(self.session.get_state_dir()) self.dispersy = Dispersy(endpoint, working_directory) # register TFTP service from Tribler.Core.TFTP.handler import TftpHandler self.tftp_handler = TftpHandler(self.session, endpoint, "fffffffd".decode('hex'), block_size=1024) self.tftp_handler.initialize() if self.session.get_enable_torrent_search( ) or self.session.get_enable_channel_search(): self.search_manager = SearchManager(self.session) self.search_manager.initialize() if self.session.get_enable_channel_search(): from Tribler.Core.Modules.channel_manager import ChannelManager self.channel_manager = ChannelManager(self.session) self.channel_manager.initialize() if not self.initComplete: self.init(autoload_discovery) def init(self, autoload_discovery): if self.dispersy: from Tribler.dispersy.community import HardKilledCommunity self._logger.info("lmc: Starting Dispersy...") now = timemod.time() success = self.dispersy.start(autoload_discovery) diff = timemod.time() - now if success: self._logger.info( "lmc: Dispersy started successfully in %.2f seconds [port: %d]", diff, self.dispersy.wan_address[1]) else: self._logger.info( "lmc: Dispersy failed to start in %.2f seconds", diff) self.upnp_ports.append((self.dispersy.wan_address[1], 'UDP')) from Tribler.dispersy.crypto import M2CryptoSK self.session.dispersy_member = blockingCallFromThread( reactor, self.dispersy.get_member, private_key=self.dispersy.crypto.key_to_bin( M2CryptoSK( filename=self.session.get_permid_keypair_filename()))) blockingCallFromThread(reactor, self.dispersy.define_auto_load, HardKilledCommunity, self.session.dispersy_member, load=True) if self.session.get_megacache(): self.dispersy.database.attach_commit_callback( self.session.sqlite_db.commit_now) # notify dispersy finished loading self.session.notifier.notify(NTFY_DISPERSY, NTFY_STARTED, None) @blocking_call_on_reactor_thread def load_communities(): # load communities # Search Community if self.session.get_enable_torrent_search(): from Tribler.community.search.community import SearchCommunity self.dispersy.define_auto_load( SearchCommunity, self.session.dispersy_member, load=True, kargs={'tribler_session': self.session}) # AllChannel Community if self.session.get_enable_channel_search(): from Tribler.community.allchannel.community import AllChannelCommunity self.dispersy.define_auto_load( AllChannelCommunity, self.session.dispersy_member, load=True, kargs={'tribler_session': self.session}) load_communities() from Tribler.Core.DecentralizedTracking import mainlineDHT try: self.mainline_dht = mainlineDHT.init( ('127.0.0.1', self.session.get_mainline_dht_listen_port()), self.session.get_state_dir()) self.upnp_ports.append( (self.session.get_mainline_dht_listen_port(), 'UDP')) except: print_exc() if self.session.get_libtorrent(): from Tribler.Core.Libtorrent.LibtorrentMgr import LibtorrentMgr self.ltmgr = LibtorrentMgr(self.session) self.ltmgr.initialize() # FIXME(lipu): upnp APIs are not exported in libtorrent python-binding. #for port, protocol in self.upnp_ports: # self.ltmgr.add_upnp_mapping(port, protocol) # add task for tracker checking if self.session.get_torrent_checking(): try: from Tribler.Core.TorrentChecker.torrent_checker import TorrentChecker self.torrent_checker = TorrentChecker(self.session) self.torrent_checker.initialize() except: print_exc() if self.rtorrent_handler: self.rtorrent_handler.initialize() self.initComplete = True def add(self, tdef, dscfg, pstate=None, initialdlstatus=None, setupDelay=0, hidden=False): """ Called by any thread """ d = None self.sesslock.acquire() try: if not isinstance( tdef, TorrentDefNoMetainfo) and not tdef.is_finalized(): raise ValueError("TorrentDef not finalized") infohash = tdef.get_infohash() # Check if running or saved on disk if infohash in self.downloads: raise DuplicateDownloadException() from Tribler.Core.Libtorrent.LibtorrentDownloadImpl import LibtorrentDownloadImpl d = LibtorrentDownloadImpl(self.session, tdef) if pstate is None: # not already resuming pstate = self.load_download_pstate_noexc(infohash) if pstate is not None: self._logger.debug("tlm: add: pstate is %s %s", pstate.get('dlstate', 'status'), pstate.get('dlstate', 'progress')) # Store in list of Downloads, always. self.downloads[infohash] = d d.setup(dscfg, pstate, initialdlstatus, self.network_engine_wrapper_created_callback, wrapperDelay=setupDelay) finally: self.sesslock.release() if d and not hidden and self.session.get_megacache(): @forceDBThread def write_my_pref(): torrent_id = self.torrent_db.getTorrentID(infohash) data = {'destination_path': d.get_dest_dir()} self.mypref_db.addMyPreference(torrent_id, data) if isinstance(tdef, TorrentDefNoMetainfo): self.torrent_db.addOrGetTorrentID(tdef.get_infohash()) self.torrent_db.updateTorrent(tdef.get_infohash(), name=tdef.get_name_as_unicode()) write_my_pref() elif self.rtorrent_handler: self.rtorrent_handler.save_torrent(tdef, write_my_pref) else: self.torrent_db.addExternalTorrent( tdef, extra_info={'status': 'good'}) write_my_pref() return d def network_engine_wrapper_created_callback(self, d, pstate): """ Called by network thread """ try: if pstate is None: # Checkpoint at startup (infohash, pstate) = d.network_checkpoint() self.save_download_pstate(infohash, pstate) except: print_exc() def remove(self, d, removecontent=False, removestate=True, hidden=False): """ Called by any thread """ with self.sesslock: d.stop_remove(removestate=removestate, removecontent=removecontent) infohash = d.get_def().get_infohash() if infohash in self.downloads: del self.downloads[infohash] if not hidden: self.remove_id(infohash) def remove_id(self, infohash): @forceDBThread def do_db(infohash): torrent_id = self.torrent_db.getTorrentID(infohash) if torrent_id: self.mypref_db.deletePreference(torrent_id) if self.session.get_megacache(): do_db(infohash) def get_downloads(self): """ Called by any thread """ with self.sesslock: return self.downloads.values() # copy, is mutable def get_download(self, infohash): """ Called by any thread """ with self.sesslock: return self.downloads.get(infohash, None) def download_exists(self, infohash): with self.sesslock: return infohash in self.downloads def update_trackers(self, infohash, trackers): """ Update the trackers for a download. :param infohash: infohash of the torrent that needs to be updated :param trackers: A list of tracker urls. """ dl = self.get_download(infohash) old_def = dl.get_def() if dl else None if old_def: old_trackers = old_def.get_trackers_as_single_tuple() new_trackers = list(set(trackers) - set(old_trackers)) all_trackers = list(old_trackers) + new_trackers if new_trackers: # Add new trackers to the download dl.add_trackers(new_trackers) # Create a new TorrentDef if isinstance(old_def, TorrentDefNoMetainfo): new_def = TorrentDefNoMetainfo(old_def.get_infohash(), old_def.get_name(), dl.get_magnet_link()) else: metainfo = old_def.get_metainfo() if len(all_trackers) > 1: metainfo["announce-list"] = [all_trackers] else: metainfo["announce"] = all_trackers[0] new_def = TorrentDef.load_from_dict(metainfo) # Set TorrentDef + checkpoint dl.set_def(new_def) dl.checkpoint() if isinstance(old_def, TorrentDefNoMetainfo): @forceDBThread def update_trackers_db(infohash, new_trackers): torrent_id = self.torrent_db.getTorrentID(infohash) if torrent_id is not None: self.torrent_db.addTorrentTrackerMappingInBatch( torrent_id, new_trackers) self.session.notifier.notify( NTFY_TORRENTS, NTFY_UPDATE, infohash) if self.session.get_megacache(): update_trackers_db(infohash, new_trackers) elif not isinstance( old_def, TorrentDefNoMetainfo) and self.rtorrent_handler: # Update collected torrents self.rtorrent_handler.save_torrent(new_def) # # State retrieval # def set_download_states_callback(self, usercallback, getpeerlist, when=0.0): """ Called by any thread """ for d in self.downloads.values(): # Arno, 2012-05-23: At Niels' request to get total transferred # stats. Causes MOREINFO message to be sent from swift proc # for every initiated dl. # 2012-07-31: Turn MOREINFO on/off on demand for efficiency. # 2013-04-17: Libtorrent now uses set_moreinfo_stats as well. d.set_moreinfo_stats(True in getpeerlist or d.get_def().get_infohash() in getpeerlist) network_set_download_states_callback_lambda = lambda: self.network_set_download_states_callback( usercallback) self.threadpool.add_task(network_set_download_states_callback_lambda, when) def network_set_download_states_callback(self, usercallback): """ Called by network thread """ dslist = [] for d in self.downloads.values(): try: ds = d.network_get_state(None, False) dslist.append(ds) except: # Niels, 2012-10-18: If Swift connection is crashing, it will raise an exception # We're catching it here to continue building the downloadstates print_exc() # Invoke the usercallback function on a separate thread. # After the callback is invoked, the return values will be passed to the # returncallback for post-callback processing. def session_getstate_usercallback_target(): when, newgetpeerlist = usercallback(dslist) if when > 0.0: # reschedule self.set_download_states_callback(usercallback, newgetpeerlist, when=when) self.threadpool.add_task(session_getstate_usercallback_target) # # Persistence methods # def load_checkpoint(self, initialdlstatus=None, initialdlstatus_dict={}): """ Called by any thread """ def do_load_checkpoint(initialdlstatus, initialdlstatus_dict): with self.sesslock: for i, filename in enumerate( iglob( os.path.join( self.session.get_downloads_pstate_dir(), '*.state'))): self.resume_download(filename, initialdlstatus, initialdlstatus_dict, setupDelay=i * 0.1) if self.initComplete: do_load_checkpoint(initialdlstatus, initialdlstatus_dict) else: self.register_task("load_checkpoint", reactor.callLater(1, do_load_checkpoint)) def load_download_pstate_noexc(self, infohash): """ Called by any thread, assume sesslock already held """ try: basename = binascii.hexlify(infohash) + '.state' filename = os.path.join(self.session.get_downloads_pstate_dir(), basename) if os.path.exists(filename): return self.load_download_pstate(filename) else: self._logger.info("%s not found", basename) except Exception: self._logger.exception("Exception while loading pstate: %s", infohash) def resume_download(self, filename, initialdlstatus=None, initialdlstatus_dict={}, setupDelay=0): tdef = dscfg = pstate = None try: pstate = self.load_download_pstate(filename) # SWIFTPROC metainfo = pstate.get('state', 'metainfo') if 'infohash' in metainfo: tdef = TorrentDefNoMetainfo(metainfo['infohash'], metainfo['name'], metainfo.get('url', None)) else: tdef = TorrentDef.load_from_dict(metainfo) if pstate.has_option('downloadconfig', 'saveas') and \ isinstance(pstate.get('downloadconfig', 'saveas'), tuple): pstate.set('downloadconfig', 'saveas', pstate.get('downloadconfig', 'saveas')[-1]) dscfg = DownloadStartupConfig(pstate) except: # pstate is invalid or non-existing _, file = os.path.split(filename) infohash = binascii.unhexlify(file[:-6]) torrent_data = self.torrent_store.get(infohash) if torrent_data: tdef = TorrentDef.load_from_memory(torrent_data) defaultDLConfig = DefaultDownloadStartupConfig.getInstance() dscfg = defaultDLConfig.copy() if self.mypref_db is not None: dest_dir = self.mypref_db.getMyPrefStatsInfohash(infohash) if dest_dir: if os.path.isdir(dest_dir) or dest_dir == '': dscfg.set_dest_dir(dest_dir) self._logger.debug("tlm: load_checkpoint: pstate is %s %s", pstate.get('dlstate', 'status'), pstate.get('dlstate', 'progress')) if pstate is None or pstate.get('state', 'engineresumedata') is None: self._logger.debug("tlm: load_checkpoint: resumedata None") else: self._logger.debug("tlm: load_checkpoint: resumedata len %d", len(pstate.get('state', 'engineresumedata'))) if tdef and dscfg: if dscfg.get_dest_dir() != '': # removed torrent ignoring try: if not self.download_exists(tdef.get_infohash()): initialdlstatus = initialdlstatus_dict.get( tdef.get_infohash(), initialdlstatus) self.add(tdef, dscfg, pstate, initialdlstatus, setupDelay=setupDelay) else: self._logger.info( "tlm: not resuming checkpoint because download has already been added" ) except Exception as e: self._logger.exception( "tlm: load check_point: exception while adding download %s", tdef) else: self._logger.info("tlm: removing checkpoint %s destdir is %s", filename, dscfg.get_dest_dir()) os.remove(filename) else: self._logger.info("tlm: could not resume checkpoint %s %s %s", filename, tdef, dscfg) def checkpoint(self, stop=False, checkpoint=True, gracetime=2.0): """ Called by any thread, assume sesslock already held """ # Even if the list of Downloads changes in the mean time this is # no problem. For removals, dllist will still hold a pointer to the # Download, and additions are no problem (just won't be included # in list of states returned via callback. # dllist = self.downloads.values() self._logger.debug("tlm: checkpointing %s stopping %s", len(dllist), stop) network_checkpoint_callback_lambda = lambda: self.network_checkpoint_callback( dllist, stop, checkpoint, gracetime) self.threadpool.add_task(network_checkpoint_callback_lambda, 0.0) def network_checkpoint_callback(self, dllist, stop, checkpoint, gracetime): """ Called by network thread """ if checkpoint: for d in dllist: try: # Tell all downloads to stop, and save their persistent state # in a infohash -> pstate dict which is then passed to the user # for storage. # if stop: (infohash, pstate) = d.network_stop(False, False) else: (infohash, pstate) = d.network_checkpoint() self._logger.debug("tlm: network checkpointing: %s %s", d.get_def().get_name(), pstate) self.save_download_pstate(infohash, pstate) except Exception as e: self._logger.exception("Exception while checkpointing: %s", d.get_def().get_name()) if stop: # Some grace time for early shutdown tasks if self.shutdownstarttime is not None: now = timemod.time() diff = now - self.shutdownstarttime if diff < gracetime: self._logger.info( "tlm: shutdown: delaying for early shutdown tasks %s", gracetime - diff) delay = gracetime - diff network_shutdown_callback_lambda = lambda: self.network_shutdown( ) self.threadpool.add_task(network_shutdown_callback_lambda, delay) return self.network_shutdown() def remove_pstate(self, infohash): network_remove_pstate_callback_lambda = lambda: self.network_remove_pstate_callback( infohash) self.threadpool.add_task(network_remove_pstate_callback_lambda, 0.0) def network_remove_pstate_callback(self, infohash): if not self.download_exists(infohash): dlpstatedir = self.session.get_downloads_pstate_dir() # Remove checkpoint hexinfohash = binascii.hexlify(infohash) try: basename = hexinfohash + '.state' filename = os.path.join(dlpstatedir, basename) self._logger.debug( "remove pstate: removing dlcheckpoint entry %s", filename) if os.access(filename, os.F_OK): os.remove(filename) except: # Show must go on self._logger.exception("Could not remove state") else: self._logger.warning( "remove pstate: download is back, restarted? Canceling removal! %s", repr(infohash)) def early_shutdown(self): """ Called as soon as Session shutdown is initiated. Used to start shutdown tasks that takes some time and that can run in parallel to checkpointing, etc. """ self._logger.info("tlm: early_shutdown") self.cancel_all_pending_tasks() # Note: sesslock not held self.shutdownstarttime = timemod.time() if self.torrent_checker: self.torrent_checker.shutdown() self.torrent_checker = None if self.channel_manager: self.channel_manager.shutdown() self.channel_manager = None if self.search_manager: self.search_manager.shutdown() self.search_manager = None if self.rtorrent_handler: self.rtorrent_handler.shutdown() self.rtorrent_handler = None if self.videoplayer: self.videoplayer.shutdown() self.videoplayer = None if self.tracker_manager: self.tracker_manager.shutdown() self.tracker_manager = None if self.dispersy: self._logger.info("lmc: Shutting down Dispersy...") now = timemod.time() try: success = self.dispersy.stop() except: print_exc() success = False diff = timemod.time() - now if success: self._logger.info( "lmc: Dispersy successfully shutdown in %.2f seconds", diff) else: self._logger.info( "lmc: Dispersy failed to shutdown in %.2f seconds", diff) if self.metadata_store is not None: self.metadata_store.close() self.metadata_store = None if self.tftp_handler: self.tftp_handler.shutdown() self.tftp_handler = None if self.session.get_megacache(): self.channelcast_db.close() self.votecast_db.close() self.mypref_db.close() self.torrent_db.close() self.peer_db.close() self.channelcast_db = None self.votecast_db = None self.mypref_db = None self.torrent_db = None self.peer_db = None if self.mainline_dht: from Tribler.Core.DecentralizedTracking import mainlineDHT mainlineDHT.deinit(self.mainline_dht) self.mainline_dht = None if self.torrent_store is not None: self.torrent_store.close() self.torrent_store = None def network_shutdown(self): try: self._logger.info("tlm: network_shutdown") ts = enumerate_threads() self._logger.info("tlm: Number of threads still running %d", len(ts)) for t in ts: self._logger.info( "tlm: Thread still running=%s, daemon=%s, instance=%s", t.getName(), t.isDaemon(), t) except: print_exc() # Stop network thread self.sessdoneflag.set() # Shutdown libtorrent session after checkpoints have been made if self.ltmgr: self.ltmgr.shutdown() self.ltmgr = None if self.threadpool: self.threadpool.cancel_all_pending_tasks() self.threadpool = None def save_download_pstate(self, infohash, pstate): """ Called by network thread """ basename = binascii.hexlify(infohash) + '.state' filename = os.path.join(self.session.get_downloads_pstate_dir(), basename) self._logger.debug("tlm: network checkpointing: to file %s", filename) pstate.write_file(filename) def load_download_pstate(self, filename): """ Called by any thread """ pstate = CallbackConfigParser() pstate.read_file(filename) return pstate # Events from core meant for API user # def sessconfig_changed_callback(self, section, name, new_value, old_value): value_changed = new_value != old_value if section == 'libtorrent' and name == 'utp': if self.ltmgr and value_changed: self.ltmgr.set_utp(new_value) elif section == 'libtorrent' and name == 'lt_proxyauth': if self.ltmgr: self.ltmgr.set_proxy_settings( None, *self.session.get_libtorrent_proxy_settings()) # Return True/False, depending on whether or not the config value can be changed at runtime. elif (section == 'general' and name in ['nickname', 'mugshot', 'videoanalyserpath']) or \ (section == 'libtorrent' and name in ['lt_proxytype', 'lt_proxyserver', 'anon_proxyserver', 'anon_proxytype', 'anon_proxyauth', 'anon_listen_port']) or \ (section == 'torrent_collecting' and name in ['stop_collecting_threshold']) or \ (section == 'tunnel_community' and name in ['socks5_listen_port']): return True else: return False return True
class TriblerLaunchMany(TaskManager): def __init__(self): """ Called only once (unless we have multiple Sessions) by MainThread """ super(TriblerLaunchMany, self).__init__() self.initComplete = False self.registered = False self.dispersy = None self._logger = logging.getLogger(self.__class__.__name__) self.downloads = {} self.upnp_ports = [] self.session = None self.sesslock = None self.sessdoneflag = Event() self.shutdownstarttime = None # modules self.threadpool = ThreadPoolManager() self.torrent_store = None self.metadata_store = None self.rtorrent_handler = None self.tftp_handler = None self.cat = None self.peer_db = None self.torrent_db = None self.mypref_db = None self.votecast_db = None self.channelcast_db = None self.search_manager = None self.channel_manager = None self.videoplayer = None self.mainline_dht = None self.ltmgr = None self.tracker_manager = None self.torrent_checker = None self.tunnel_community = None def register(self, session, sesslock, autoload_discovery=True): if not self.registered: self.registered = True self.session = session self.sesslock = sesslock if self.session.get_torrent_store(): from Tribler.Core.leveldbstore import LevelDbStore self.torrent_store = LevelDbStore(self.session.get_torrent_store_dir()) if self.session.get_enable_metadata(): from Tribler.Core.leveldbstore import LevelDbStore self.metadata_store = LevelDbStore(self.session.get_metadata_store_dir()) # torrent collecting: RemoteTorrentHandler if self.session.get_torrent_collecting(): from Tribler.Core.RemoteTorrentHandler import RemoteTorrentHandler self.rtorrent_handler = RemoteTorrentHandler(self.session) # TODO(emilon): move this to a megacache component or smth if self.session.get_megacache(): from Tribler.Core.CacheDB.SqliteCacheDBHandler import (PeerDBHandler, TorrentDBHandler, MyPreferenceDBHandler, VoteCastDBHandler, ChannelCastDBHandler) from Tribler.Category.Category import Category self._logger.debug('tlm: Reading Session state from %s', self.session.get_state_dir()) self.cat = Category.getInstance(self.session) # create DBHandlers self.peer_db = PeerDBHandler(self.session) self.torrent_db = TorrentDBHandler(self.session) self.mypref_db = MyPreferenceDBHandler(self.session) self.votecast_db = VoteCastDBHandler(self.session) self.channelcast_db = ChannelCastDBHandler(self.session) # initializes DBHandlers self.peer_db.initialize() self.torrent_db.initialize() self.mypref_db.initialize() self.votecast_db.initialize() self.channelcast_db.initialize() from Tribler.Core.Modules.tracker_manager import TrackerManager self.tracker_manager = TrackerManager(self.session) self.tracker_manager.initialize() if self.session.get_videoplayer(): self.videoplayer = VideoPlayer(self.session) # Dispersy self.session.dispersy_member = None self.tftp_handler = None if self.session.get_dispersy(): from Tribler.dispersy.dispersy import Dispersy from Tribler.dispersy.endpoint import StandaloneEndpoint # set communication endpoint endpoint = StandaloneEndpoint(self.session.get_dispersy_port(), ip=self.session.get_ip()) working_directory = unicode(self.session.get_state_dir()) self.dispersy = Dispersy(endpoint, working_directory) # register TFTP service from Tribler.Core.TFTP.handler import TftpHandler self.tftp_handler = TftpHandler(self.session, endpoint, "fffffffd".decode('hex'), block_size=1024) self.tftp_handler.initialize() if self.session.get_enable_torrent_search() or self.session.get_enable_channel_search(): self.search_manager = SearchManager(self.session) self.search_manager.initialize() if self.session.get_enable_channel_search(): from Tribler.Core.Modules.channel_manager import ChannelManager self.channel_manager = ChannelManager(self.session) self.channel_manager.initialize() if not self.initComplete: self.init(autoload_discovery) def init(self, autoload_discovery): if self.dispersy: from Tribler.dispersy.community import HardKilledCommunity self._logger.info("lmc: Starting Dispersy...") now = timemod.time() success = self.dispersy.start(autoload_discovery) diff = timemod.time() - now if success: self._logger.info("lmc: Dispersy started successfully in %.2f seconds [port: %d]", diff, self.dispersy.wan_address[1]) else: self._logger.info("lmc: Dispersy failed to start in %.2f seconds", diff) self.upnp_ports.append((self.dispersy.wan_address[1], 'UDP')) from Tribler.dispersy.crypto import M2CryptoSK self.session.dispersy_member = blockingCallFromThread(reactor, self.dispersy.get_member, private_key=self.dispersy.crypto.key_to_bin(M2CryptoSK(filename=self.session.get_permid_keypair_filename()))) blockingCallFromThread(reactor, self.dispersy.define_auto_load, HardKilledCommunity, self.session.dispersy_member, load=True) if self.session.get_megacache(): self.dispersy.database.attach_commit_callback(self.session.sqlite_db.commit_now) # notify dispersy finished loading self.session.notifier.notify(NTFY_DISPERSY, NTFY_STARTED, None) @blocking_call_on_reactor_thread def load_communities(): # load communities # Search Community if self.session.get_enable_torrent_search(): from Tribler.community.search.community import SearchCommunity self.dispersy.define_auto_load(SearchCommunity, self.session.dispersy_member, load=True, kargs={'tribler_session': self.session}) # AllChannel Community if self.session.get_enable_channel_search(): from Tribler.community.allchannel.community import AllChannelCommunity self.dispersy.define_auto_load(AllChannelCommunity, self.session.dispersy_member, load=True, kargs={'tribler_session': self.session}) load_communities() from Tribler.Core.DecentralizedTracking import mainlineDHT try: self.mainline_dht = mainlineDHT.init(('127.0.0.1', self.session.get_mainline_dht_listen_port()), self.session.get_state_dir()) self.upnp_ports.append((self.session.get_mainline_dht_listen_port(), 'UDP')) except: print_exc() if self.session.get_libtorrent(): from Tribler.Core.Libtorrent.LibtorrentMgr import LibtorrentMgr self.ltmgr = LibtorrentMgr(self.session) self.ltmgr.initialize() # FIXME(lipu): upnp APIs are not exported in libtorrent python-binding. #for port, protocol in self.upnp_ports: # self.ltmgr.add_upnp_mapping(port, protocol) # add task for tracker checking if self.session.get_torrent_checking(): try: from Tribler.Core.TorrentChecker.torrent_checker import TorrentChecker self.torrent_checker = TorrentChecker(self.session) self.torrent_checker.initialize() except: print_exc() if self.rtorrent_handler: self.rtorrent_handler.initialize() self.initComplete = True def add(self, tdef, dscfg, pstate=None, initialdlstatus=None, setupDelay=0, hidden=False): """ Called by any thread """ d = None self.sesslock.acquire() try: if not isinstance(tdef, TorrentDefNoMetainfo) and not tdef.is_finalized(): raise ValueError("TorrentDef not finalized") infohash = tdef.get_infohash() # Check if running or saved on disk if infohash in self.downloads: raise DuplicateDownloadException() from Tribler.Core.Libtorrent.LibtorrentDownloadImpl import LibtorrentDownloadImpl d = LibtorrentDownloadImpl(self.session, tdef) if pstate is None: # not already resuming pstate = self.load_download_pstate_noexc(infohash) if pstate is not None: self._logger.debug("tlm: add: pstate is %s %s", pstate.get('dlstate', 'status'), pstate.get('dlstate', 'progress')) # Store in list of Downloads, always. self.downloads[infohash] = d d.setup(dscfg, pstate, initialdlstatus, self.network_engine_wrapper_created_callback, wrapperDelay=setupDelay) finally: self.sesslock.release() if d and not hidden and self.session.get_megacache(): @forceDBThread def write_my_pref(): torrent_id = self.torrent_db.getTorrentID(infohash) data = {'destination_path': d.get_dest_dir()} self.mypref_db.addMyPreference(torrent_id, data) if isinstance(tdef, TorrentDefNoMetainfo): self.torrent_db.addOrGetTorrentID(tdef.get_infohash()) self.torrent_db.updateTorrent(tdef.get_infohash(), name=tdef.get_name_as_unicode()) write_my_pref() elif self.rtorrent_handler: self.rtorrent_handler.save_torrent(tdef, write_my_pref) else: self.torrent_db.addExternalTorrent(tdef, extra_info={'status': 'good'}) write_my_pref() return d def network_engine_wrapper_created_callback(self, d, pstate): """ Called by network thread """ try: if pstate is None: # Checkpoint at startup (infohash, pstate) = d.network_checkpoint() self.save_download_pstate(infohash, pstate) except: print_exc() def remove(self, d, removecontent=False, removestate=True, hidden=False): """ Called by any thread """ with self.sesslock: d.stop_remove(removestate=removestate, removecontent=removecontent) infohash = d.get_def().get_infohash() if infohash in self.downloads: del self.downloads[infohash] if not hidden: self.remove_id(infohash) def remove_id(self, infohash): @forceDBThread def do_db(infohash): torrent_id = self.torrent_db.getTorrentID(infohash) if torrent_id: self.mypref_db.deletePreference(torrent_id) if self.session.get_megacache(): do_db(infohash) def get_downloads(self): """ Called by any thread """ with self.sesslock: return self.downloads.values() # copy, is mutable def get_download(self, infohash): """ Called by any thread """ with self.sesslock: return self.downloads.get(infohash, None) def download_exists(self, infohash): with self.sesslock: return infohash in self.downloads def update_trackers(self, infohash, trackers): """ Update the trackers for a download. :param infohash: infohash of the torrent that needs to be updated :param trackers: A list of tracker urls. """ dl = self.get_download(infohash) old_def = dl.get_def() if dl else None if old_def: old_trackers = old_def.get_trackers_as_single_tuple() new_trackers = list(set(trackers) - set(old_trackers)) all_trackers = list(old_trackers) + new_trackers if new_trackers: # Add new trackers to the download dl.add_trackers(new_trackers) # Create a new TorrentDef if isinstance(old_def, TorrentDefNoMetainfo): new_def = TorrentDefNoMetainfo(old_def.get_infohash(), old_def.get_name(), dl.get_magnet_link()) else: metainfo = old_def.get_metainfo() if len(all_trackers) > 1: metainfo["announce-list"] = [all_trackers] else: metainfo["announce"] = all_trackers[0] new_def = TorrentDef.load_from_dict(metainfo) # Set TorrentDef + checkpoint dl.set_def(new_def) dl.checkpoint() if isinstance(old_def, TorrentDefNoMetainfo): @forceDBThread def update_trackers_db(infohash, new_trackers): torrent_id = self.torrent_db.getTorrentID(infohash) if torrent_id is not None: self.torrent_db.addTorrentTrackerMappingInBatch(torrent_id, new_trackers) self.session.notifier.notify(NTFY_TORRENTS, NTFY_UPDATE, infohash) if self.session.get_megacache(): update_trackers_db(infohash, new_trackers) elif not isinstance(old_def, TorrentDefNoMetainfo) and self.rtorrent_handler: # Update collected torrents self.rtorrent_handler.save_torrent(new_def) # # State retrieval # def set_download_states_callback(self, usercallback, getpeerlist, when=0.0): """ Called by any thread """ for d in self.downloads.values(): # Arno, 2012-05-23: At Niels' request to get total transferred # stats. Causes MOREINFO message to be sent from swift proc # for every initiated dl. # 2012-07-31: Turn MOREINFO on/off on demand for efficiency. # 2013-04-17: Libtorrent now uses set_moreinfo_stats as well. d.set_moreinfo_stats(True in getpeerlist or d.get_def().get_infohash() in getpeerlist) network_set_download_states_callback_lambda = lambda: self.network_set_download_states_callback(usercallback) self.threadpool.add_task(network_set_download_states_callback_lambda, when) def network_set_download_states_callback(self, usercallback): """ Called by network thread """ dslist = [] for d in self.downloads.values(): try: ds = d.network_get_state(None, False) dslist.append(ds) except: # Niels, 2012-10-18: If Swift connection is crashing, it will raise an exception # We're catching it here to continue building the downloadstates print_exc() # Invoke the usercallback function on a separate thread. # After the callback is invoked, the return values will be passed to the # returncallback for post-callback processing. def session_getstate_usercallback_target(): when, newgetpeerlist = usercallback(dslist) if when > 0.0: # reschedule self.set_download_states_callback(usercallback, newgetpeerlist, when=when) self.threadpool.add_task(session_getstate_usercallback_target) # # Persistence methods # def load_checkpoint(self, initialdlstatus=None, initialdlstatus_dict={}): """ Called by any thread """ def do_load_checkpoint(initialdlstatus, initialdlstatus_dict): with self.sesslock: for i, filename in enumerate(iglob(os.path.join(self.session.get_downloads_pstate_dir(), '*.state'))): self.resume_download(filename, initialdlstatus, initialdlstatus_dict, setupDelay=i * 0.1) if self.initComplete: do_load_checkpoint(initialdlstatus, initialdlstatus_dict) else: self.register_task("load_checkpoint", reactor.callLater(1, do_load_checkpoint)) def load_download_pstate_noexc(self, infohash): """ Called by any thread, assume sesslock already held """ try: basename = binascii.hexlify(infohash) + '.state' filename = os.path.join(self.session.get_downloads_pstate_dir(), basename) if os.path.exists(filename): return self.load_download_pstate(filename) else: self._logger.info("%s not found", basename) except Exception: self._logger.exception("Exception while loading pstate: %s", infohash) def resume_download(self, filename, initialdlstatus=None, initialdlstatus_dict={}, setupDelay=0): tdef = dscfg = pstate = None try: pstate = self.load_download_pstate(filename) # SWIFTPROC metainfo = pstate.get('state', 'metainfo') if 'infohash' in metainfo: tdef = TorrentDefNoMetainfo(metainfo['infohash'], metainfo['name'], metainfo.get('url', None)) else: tdef = TorrentDef.load_from_dict(metainfo) if pstate.has_option('downloadconfig', 'saveas') and \ isinstance(pstate.get('downloadconfig', 'saveas'), tuple): pstate.set('downloadconfig', 'saveas', pstate.get('downloadconfig', 'saveas')[-1]) dscfg = DownloadStartupConfig(pstate) except: # pstate is invalid or non-existing _, file = os.path.split(filename) infohash = binascii.unhexlify(file[:-6]) torrent_data = self.torrent_store.get(infohash) if torrent_data: tdef = TorrentDef.load_from_memory(torrent_data) defaultDLConfig = DefaultDownloadStartupConfig.getInstance() dscfg = defaultDLConfig.copy() if self.mypref_db is not None: dest_dir = self.mypref_db.getMyPrefStatsInfohash(infohash) if dest_dir: if os.path.isdir(dest_dir) or dest_dir == '': dscfg.set_dest_dir(dest_dir) self._logger.debug("tlm: load_checkpoint: pstate is %s %s", pstate.get('dlstate', 'status'), pstate.get('dlstate', 'progress')) if pstate is None or pstate.get('state', 'engineresumedata') is None: self._logger.debug("tlm: load_checkpoint: resumedata None") else: self._logger.debug("tlm: load_checkpoint: resumedata len %d", len(pstate.get('state', 'engineresumedata'))) if tdef and dscfg: if dscfg.get_dest_dir() != '': # removed torrent ignoring try: if not self.download_exists(tdef.get_infohash()): initialdlstatus = initialdlstatus_dict.get(tdef.get_infohash(), initialdlstatus) self.add(tdef, dscfg, pstate, initialdlstatus, setupDelay=setupDelay) else: self._logger.info("tlm: not resuming checkpoint because download has already been added") except Exception as e: self._logger.exception("tlm: load check_point: exception while adding download %s", tdef) else: self._logger.info("tlm: removing checkpoint %s destdir is %s", filename, dscfg.get_dest_dir()) os.remove(filename) else: self._logger.info("tlm: could not resume checkpoint %s %s %s", filename, tdef, dscfg) def checkpoint(self, stop=False, checkpoint=True, gracetime=2.0): """ Called by any thread, assume sesslock already held """ # Even if the list of Downloads changes in the mean time this is # no problem. For removals, dllist will still hold a pointer to the # Download, and additions are no problem (just won't be included # in list of states returned via callback. # dllist = self.downloads.values() self._logger.debug("tlm: checkpointing %s stopping %s", len(dllist), stop) network_checkpoint_callback_lambda = lambda: self.network_checkpoint_callback(dllist, stop, checkpoint, gracetime) self.threadpool.add_task(network_checkpoint_callback_lambda, 0.0) def network_checkpoint_callback(self, dllist, stop, checkpoint, gracetime): """ Called by network thread """ if checkpoint: for d in dllist: try: # Tell all downloads to stop, and save their persistent state # in a infohash -> pstate dict which is then passed to the user # for storage. # if stop: (infohash, pstate) = d.network_stop(False, False) else: (infohash, pstate) = d.network_checkpoint() self._logger.debug("tlm: network checkpointing: %s %s", d.get_def().get_name(), pstate) self.save_download_pstate(infohash, pstate) except Exception as e: self._logger.exception("Exception while checkpointing: %s", d.get_def().get_name()) if stop: # Some grace time for early shutdown tasks if self.shutdownstarttime is not None: now = timemod.time() diff = now - self.shutdownstarttime if diff < gracetime: self._logger.info("tlm: shutdown: delaying for early shutdown tasks %s", gracetime - diff) delay = gracetime - diff network_shutdown_callback_lambda = lambda: self.network_shutdown() self.threadpool.add_task(network_shutdown_callback_lambda, delay) return self.network_shutdown() def remove_pstate(self, infohash): network_remove_pstate_callback_lambda = lambda: self.network_remove_pstate_callback(infohash) self.threadpool.add_task(network_remove_pstate_callback_lambda, 0.0) def network_remove_pstate_callback(self, infohash): if not self.download_exists(infohash): dlpstatedir = self.session.get_downloads_pstate_dir() # Remove checkpoint hexinfohash = binascii.hexlify(infohash) try: basename = hexinfohash + '.state' filename = os.path.join(dlpstatedir, basename) self._logger.debug("remove pstate: removing dlcheckpoint entry %s", filename) if os.access(filename, os.F_OK): os.remove(filename) except: # Show must go on self._logger.exception("Could not remove state") else: self._logger.warning("remove pstate: download is back, restarted? Canceling removal! %s", repr(infohash)) def early_shutdown(self): """ Called as soon as Session shutdown is initiated. Used to start shutdown tasks that takes some time and that can run in parallel to checkpointing, etc. """ self._logger.info("tlm: early_shutdown") self.cancel_all_pending_tasks() # Note: sesslock not held self.shutdownstarttime = timemod.time() if self.torrent_checker: self.torrent_checker.shutdown() self.torrent_checker = None if self.channel_manager: self.channel_manager.shutdown() self.channel_manager = None if self.search_manager: self.search_manager.shutdown() self.search_manager = None if self.rtorrent_handler: self.rtorrent_handler.shutdown() self.rtorrent_handler = None if self.videoplayer: self.videoplayer.shutdown() self.videoplayer = None if self.tracker_manager: self.tracker_manager.shutdown() self.tracker_manager = None if self.dispersy: self._logger.info("lmc: Shutting down Dispersy...") now = timemod.time() try: success = self.dispersy.stop() except: print_exc() success = False diff = timemod.time() - now if success: self._logger.info("lmc: Dispersy successfully shutdown in %.2f seconds", diff) else: self._logger.info("lmc: Dispersy failed to shutdown in %.2f seconds", diff) if self.metadata_store is not None: self.metadata_store.close() self.metadata_store = None if self.tftp_handler: self.tftp_handler.shutdown() self.tftp_handler = None if self.session.get_megacache(): self.channelcast_db.close() self.votecast_db.close() self.mypref_db.close() self.torrent_db.close() self.peer_db.close() self.channelcast_db = None self.votecast_db = None self.mypref_db = None self.torrent_db = None self.peer_db = None if self.mainline_dht: from Tribler.Core.DecentralizedTracking import mainlineDHT mainlineDHT.deinit(self.mainline_dht) self.mainline_dht = None if self.torrent_store is not None: self.torrent_store.close() self.torrent_store = None def network_shutdown(self): try: self._logger.info("tlm: network_shutdown") ts = enumerate_threads() self._logger.info("tlm: Number of threads still running %d", len(ts)) for t in ts: self._logger.info("tlm: Thread still running=%s, daemon=%s, instance=%s", t.getName(), t.isDaemon(), t) except: print_exc() # Stop network thread self.sessdoneflag.set() # Shutdown libtorrent session after checkpoints have been made if self.ltmgr: self.ltmgr.shutdown() self.ltmgr = None if self.threadpool: self.threadpool.cancel_all_pending_tasks() self.threadpool = None def save_download_pstate(self, infohash, pstate): """ Called by network thread """ basename = binascii.hexlify(infohash) + '.state' filename = os.path.join(self.session.get_downloads_pstate_dir(), basename) self._logger.debug("tlm: network checkpointing: to file %s", filename) pstate.write_file(filename) def load_download_pstate(self, filename): """ Called by any thread """ pstate = CallbackConfigParser() pstate.read_file(filename) return pstate # Events from core meant for API user # def sessconfig_changed_callback(self, section, name, new_value, old_value): value_changed = new_value != old_value if section == 'libtorrent' and name == 'utp': if self.ltmgr and value_changed: self.ltmgr.set_utp(new_value) elif section == 'libtorrent' and name == 'lt_proxyauth': if self.ltmgr: self.ltmgr.set_proxy_settings(None, *self.session.get_libtorrent_proxy_settings()) # Return True/False, depending on whether or not the config value can be changed at runtime. elif (section == 'general' and name in ['nickname', 'mugshot', 'videoanalyserpath']) or \ (section == 'libtorrent' and name in ['lt_proxytype', 'lt_proxyserver', 'anon_proxyserver', 'anon_proxytype', 'anon_proxyauth', 'anon_listen_port']) or \ (section == 'torrent_collecting' and name in ['stop_collecting_threshold']) or \ (section == 'tunnel_community' and name in ['socks5_listen_port']): return True else: return False return True