platypush/platypush/plugins/torrent.py

294 lines
9.4 KiB
Python
Raw Normal View History

2018-10-22 16:52:32 +02:00
import json
import os
import random
import time
import urllib.request
import urllib.parse
from platypush.context import get_bus
from platypush.plugins import Plugin, action
from platypush.message.event.torrent import \
TorrentDownloadStartEvent, TorrentSeedingStartEvent, \
TorrentStateChangeEvent, TorrentDownloadProgressEvent, \
TorrentDownloadCompletedEvent, TorrentDownloadStopEvent
2018-10-22 16:52:32 +02:00
class TorrentPlugin(Plugin):
"""
Plugin to search and download torrents.
2018-10-22 16:52:32 +02:00
Requires:
* **python-libtorrent** (``pip install git+https://github.com/arvidn/libtorrent``)
2018-10-22 16:52:32 +02:00
* **requests** (``pip install requests``) [optional] for torrent info URL download
"""
default_torrent_ports = [6881, 6891]
torrent_state = {}
2018-10-22 18:51:00 +02:00
transfers = {}
2018-10-22 16:52:32 +02:00
def __init__(self, download_dir=None, torrent_ports=[], *argv, **kwargs):
"""
:param download_dir: Directory where the videos/torrents will be downloaded (default: none)
:type download_dir: str
:param torrent_ports: Torrent ports to listen on (default: 6881 and 6891)
:type torrent_ports: list[int]
"""
super().__init__(*argv, **kwargs)
self.torrent_ports = torrent_ports if torrent_ports else self.default_torrent_ports
self.download_dir = None
if download_dir:
self.download_dir = os.path.abspath(os.path.expanduser(download_dir))
@action
2018-10-28 23:48:26 +01:00
def search(self, query):
2018-10-22 16:52:32 +02:00
"""
Perform a search of video torrents.
2018-10-22 16:52:32 +02:00
:param query: Query string, video name or partial name
:type query: str
"""
self.logger.info('Searching matching torrents for "{}"'.format(query))
request = urllib.request.urlopen(urllib.request.Request(
'https://api.apidomain.info/list?' + urllib.parse.urlencode({
'sort': 'relevance',
'quality': '720p,1080p,3d',
'page': 1,
'keywords': query,
}),
headers = {
'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 ' +
'(KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36'
})
)
response = request.read()
if isinstance(response, bytes):
response = response.decode('utf-8')
results = []
for result in json.loads(response).get('MovieList', []):
torrent = sorted(result['items'], key=lambda _:
_['torrent_seeds'] + _['torrent_peers'])[-1]
results.append({
'title': result['title'],
'url': torrent['torrent_magnet'],
'file': torrent['file'],
'size': torrent['size_bytes'],
'language': torrent.get('language'),
'quality': torrent.get('quality'),
'torrent_url': torrent['torrent_url'],
'torrent_seeds': torrent['torrent_seeds'],
'torrent_peers': torrent['torrent_peers'],
})
return results
2018-10-22 16:52:32 +02:00
@action
def download(self, torrent, download_dir=None):
"""
Download a torrent.
:param torrent: Torrent to download. Supported formats:
* Magnet URLs
* Torrent URLs
* Local torrent file
:type resource: str
:param download_dir: Directory to download, overrides the default download_dir attribute (default: None)
:type download_dir: str
"""
import libtorrent as lt
if not download_dir:
if self.download_dir:
download_dir = self.download_dir
else:
raise RuntimeError('download_dir not specified')
2018-10-22 18:51:00 +02:00
download_dir = os.path.abspath(os.path.expanduser(download_dir))
2018-10-22 16:52:32 +02:00
os.makedirs(download_dir, exist_ok=True)
info = {}
torrent_file = None
magnet = None
bus = get_bus()
if torrent.startswith('magnet:?'):
magnet = torrent
info = lt.parse_magnet_uri(magnet)
elif torrent.startswith('http://') or torrent.startswith('https://'):
import requests
response = requests.get(torrent, allow_redirects=True)
2018-10-22 18:51:00 +02:00
torrent_file = os.path.join(download_dir,
2018-10-22 16:52:32 +02:00
self._generate_rand_filename())
with open(torrent_file, 'wb') as f:
f.write(response.content)
else:
2018-10-22 18:51:00 +02:00
torrent_file = os.path.abspath(os.path.expanduser(torrent))
if not os.path.isfile(torrent_file):
raise RuntimeError('{} is not a valid torrent file'.format(torrent_file))
2018-10-22 16:52:32 +02:00
if torrent_file:
file_info = lt.torrent_info(torrent_file)
info = {
'name': file_info.name(),
'url': torrent,
'trackers': [t.url for t in list(file_info.trackers())],
'save_path': download_dir,
}
ses = lt.session()
ses.listen_on(*self.torrent_ports)
self.logger.info('Downloading "{}" to "{}" from [{}]'
.format(info['name'], self.download_dir, torrent))
params = {
'save_path': download_dir,
'storage_mode': lt.storage_mode_t.storage_mode_sparse,
}
if magnet:
transfer = lt.add_magnet_uri(ses, magnet, params)
elif torrent_file:
params['ti'] = file_info
transfer = ses.add_torrent(params)
status = transfer.status()
files = []
2018-10-22 18:51:00 +02:00
self.transfers[torrent] = transfer
self.torrent_state[torrent] = {
'url': torrent,
2018-10-22 16:52:32 +02:00
'title': info['name'],
'trackers': info['trackers'],
2018-10-22 18:51:00 +02:00
'save_path': download_dir,
2018-10-22 16:52:32 +02:00
}
bus.post(TorrentDownloadStartEvent(**self.torrent_state[torrent]))
2018-10-22 16:52:32 +02:00
last_status = None
while not status.is_seeding:
if not torrent in self.transfers:
self.logger.info('Torrent {} has been stopped and removed')
bus.post(TorrentDownloadStopEvent(url=torrent))
return
2018-10-22 16:52:32 +02:00
if not last_status:
bus.post(TorrentSeedingStartEvent(**self.torrent_state[torrent]))
2018-10-22 16:52:32 +02:00
status = transfer.status()
torrent_file = transfer.torrent_file()
if torrent_file:
files = [os.path.join(
self.download_dir,
torrent_file.files().file_path(i))
for i in range(0, torrent_file.files().num_files())
]
self.torrent_state[torrent]['progress'] = round(100 * status.progress, 2)
self.torrent_state[torrent]['download_rate'] = status.download_rate
self.torrent_state[torrent]['upload_rate'] = status.upload_rate
self.torrent_state[torrent]['num_peers'] = status.num_peers
self.torrent_state[torrent]['state'] = status.state
2018-10-22 16:52:32 +02:00
if last_status and status.progress != last_status.progress:
bus.post(TorrentDownloadProgressEvent(**self.torrent_state[torrent]))
2018-10-22 16:52:32 +02:00
if not last_status or status.state != last_status.state:
bus.post(TorrentStateChangeEvent(**self.torrent_state[torrent]))
2018-10-22 16:52:32 +02:00
self.logger.info(('Torrent download: {:.2f}% complete (down: {:.1f} kb/s ' +
'up: {:.1f} kB/s peers: {} state: {})')
.format(status.progress * 100,
status.download_rate / 1000,
status.upload_rate / 1000,
status.num_peers, status.state))
last_status = status
time.sleep(5)
if torrent_file:
try: os.unlink(torrent_file)
except: pass
bus.post(TorrentDownloadCompletedEvent(**self.torrent_state[torrent], files=files))
del self.torrent_state[torrent]
2018-10-22 18:51:00 +02:00
del self.transfers[torrent]
2018-10-22 16:52:32 +02:00
return files
@action
def get_status(self):
2018-10-22 18:51:00 +02:00
"""
Get the status of the current transfers.
:returns: A dictionary in the format torrent_url -> status
"""
2018-10-22 16:52:32 +02:00
return self.torrent_state
2018-10-22 18:51:00 +02:00
@action
def pause(self, torrent):
2018-10-22 18:51:00 +02:00
"""
Pause a torrent transfer.
:param torrent: Torrent URL as returned from `get_status()`
:type torrent: str
2018-10-22 18:51:00 +02:00
"""
if torrent not in self.transfers:
return (None, "No transfer in progress for {}".format(torrent))
2018-10-22 18:51:00 +02:00
self.transfers[torrent].pause()
2018-10-22 18:51:00 +02:00
@action
def resume(self, torrent):
2018-10-22 18:51:00 +02:00
"""
Resume a torrent transfer.
:param torrent: Torrent URL as returned from `get_status()`
:type torrent: str
"""
if torrent not in self.transfers:
return (None, "No transfer in progress for {}".format(torrent))
self.transfers[torrent].resume()
@action
def remove(self, torrent):
"""
Stops and removes a torrent transfer.
:param torrent: Torrent URL as returned from `get_status()`
:type torrent: str
2018-10-22 18:51:00 +02:00
"""
if torrent not in self.transfers:
return (None, "No transfer in progress for {}".format(torrent))
2018-10-22 18:51:00 +02:00
self.transfers[torrent].pause()
del self.torrent_state[torrent]
del self.transfers[torrent]
2018-10-22 18:51:00 +02:00
2018-10-22 16:52:32 +02:00
def _generate_rand_filename(self, length=16):
name = ''
for i in range(0, length):
name += hex(random.randint(0, 15))[2:].upper()
return name + '.torrent'
# vim:sw=4:ts=4:et: