-
Notifications
You must be signed in to change notification settings - Fork 277
/
generic.py
320 lines (259 loc) · 10.8 KB
/
generic.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# coding=utf-8
"""Base module for all torrent clients."""
from __future__ import unicode_literals
import logging
import re
import traceback
from base64 import b16encode, b32decode
from builtins import object
from hashlib import sha1
from bencodepy import BencodeDecodeError, DEFAULT as BENCODE
import certifi
from medusa import app, db
from medusa.helper.common import http_code_description
from medusa.logger.adapters.style import BraceAdapter
from medusa.session.core import ClientSession
import requests
log = BraceAdapter(logging.getLogger(__name__))
log.logger.addHandler(logging.NullHandler())
class GenericClient(object):
"""Base class for all torrent clients."""
def __init__(self, name, host=None, username=None, password=None, torrent_path=None):
"""Genericclient Constructor.
:param name:
:type name: string
:param host:
:type host: string
:param username:
:type username: string
:param password:
:type password: string
"""
self.name = name
self.username = app.TORRENT_USERNAME if username is None else username
self.password = app.TORRENT_PASSWORD if password is None else password
self.host = app.TORRENT_HOST if host is None else host
self.torrent_path = app.TORRENT_PATH if torrent_path is None else torrent_path
self.rpcurl = app.TORRENT_RPCURL
self.url = None
self.response = None
self.auth = None
self.message = None
self.session = ClientSession()
self.session.auth = (self.username, self.password)
self.verify = certifi.where()
def _request(self, method='get', params=None, data=None, files=None, cookies=None):
try:
self.response = self.session.request(
method, self.url, params=params, data=data, files=files, timeout=60, cookies=cookies,
verify=self.verify if app.TORRENT_VERIFY_CERT else False
)
except (requests.exceptions.MissingSchema, requests.exceptions.InvalidURL) as error:
log.warning('{name}: Invalid Host: {error}', {'name': self.name, 'error': error})
return False
except requests.exceptions.RequestException as error:
log.warning('{name}: Error occurred during request: {error}',
{'name': self.name, 'error': error})
# We want to raise connection errors for the download_handler. As we need to know
# explicitely if there was a connection error when untracking tracked torrents/nzb.
raise
except Exception as error:
log.error('{name}: Unknown exception raised when sending torrent to'
' {name}: {error}', {'name': self.name, 'error': error})
return False
if self.response.status_code == 401:
log.error('{name}: Invalid Username or Password,'
' check your config', {'name': self.name})
return False
code_description = http_code_description(self.response.status_code)
if code_description is not None:
log.info('{name}: {code}',
{'name': self.name, 'code': code_description})
return False
log.debug('{name}: Response to {method} request is {response}', {
'name': self.name,
'method': method.upper(),
'response': self.response.text[0:1024] + '...' if len(self.response.text) > 1027 else self.response.text
})
return True
def _get_auth(self):
"""Return the auth_id needed for the client."""
raise NotImplementedError
def _add_torrent_uri(self, result):
"""Return the True/False from the client when a torrent is added via url (magnet or .torrent link).
:param result:
:type result: medusa.classes.SearchResult
"""
raise NotImplementedError
def _add_torrent_file(self, result):
"""Return the True/False from the client when a torrent is added via result.content (only .torrent file).
:param result:
:type result: medusa.classes.SearchResult
"""
raise NotImplementedError
def _check_path(self):
"""Check if the destination path is correct."""
return True
def _set_torrent_label(self, result):
"""Return the True/False from the client when a torrent is set with label.
:param result:
:type result: medusa.classes.SearchResult
:return:
:rtype: bool
"""
return True
def _set_torrent_ratio(self, result):
"""Return the True/False from the client when a torrent is set with ratio.
:param result:
:type result: medusa.classes.SearchResult
:return:
:rtype: bool
"""
return True
def _set_torrent_seed_time(self, result):
"""Return the True/False from the client when a torrent is set with a seed time.
:param result:
:type result: medusa.classes.SearchResult
:return:
:rtype: bool
"""
return True
def _set_torrent_priority(self, result):
"""Return the True/False from the client when a torrent is set with result.priority (-1 = low, 0 = normal, 1 = high).
:param result:
:type result: medusa.classes.SearchResult
:return:
:rtype: bool
"""
return True
def _set_torrent_path(self, torrent_path):
"""Return the True/False from the client when a torrent is set with path.
:param torrent_path:
:type torrent_path: string
:return:
:rtype: bool
"""
return True
def _set_torrent_pause(self, result):
"""Return the True/False from the client when a torrent is set with pause.
:param result:
:type result: medusa.classes.SearchResult
:return:
:rtype: bool
"""
return True
@staticmethod
def _get_info_hash(result):
if result.url.startswith('magnet:'):
result.hash = re.findall(r'urn:btih:([\w]{32,40})', result.url)[0]
if len(result.hash) == 32:
hash_b16 = b16encode(b32decode(result.hash)).lower()
result.hash = hash_b16.decode('utf-8')
else:
try:
# `bencodepy` is monkeypatched in `medusa.init`
torrent_bdecode = BENCODE.decode(result.content, allow_extra_data=True)
info = torrent_bdecode['info']
result.hash = sha1(BENCODE.encode(info)).hexdigest()
except (BencodeDecodeError, KeyError):
log.warning(
'Unable to bdecode torrent. Invalid torrent: {name}. '
'Deleting cached result if exists', {'name': result.name}
)
cache_db_con = db.DBConnection('cache.db')
cache_db_con.action(
'DELETE FROM [{provider}] '
'WHERE name = ? '.format(provider=result.provider.get_id()),
[result.name]
)
return False
except Exception:
log.error(traceback.format_exc())
return False
return True
def send_torrent(self, result):
"""Add torrent to the client.
:param result:
:type result: medusa.classes.SearchResult
:return:
:rtype: str or bool
"""
# Sets per provider seed ratio
result.ratio = result.provider.seed_ratio()
# check for the hash and add it if not there
if not result.hash and not self._get_info_hash(result):
return False
if result.url.startswith('magnet:'):
log.info('Adding "{url}" to {name}', {'url': result.url, 'name': self.name})
r_code = self._add_torrent_uri(result)
else:
log.info('Adding "{result_name}" torrent to {name}', {
'result_name': result.name, 'name': self.name
})
r_code = self._add_torrent_file(result)
if not r_code:
log.warning('{name}: Unable to send Torrent', {'name': self.name})
return False
if not self._set_torrent_pause(result):
log.error('{name}: Unable to set the pause for Torrent', {'name': self.name})
if not self._set_torrent_label(result):
log.error('{name}: Unable to set the label for Torrent', {'name': self.name})
if not self._set_torrent_ratio(result):
log.error('{name}: Unable to set the ratio for Torrent', {'name': self.name})
if not self._set_torrent_seed_time(result):
log.error('{name}: Unable to set the seed time for Torrent', {'name': self.name})
if not self._set_torrent_path(result):
log.error('{name}: Unable to set the path for Torrent', {'name': self.name})
if result.priority != 0 and not self._set_torrent_priority(result):
log.error('{name}: Unable to set priority for Torrent', {'name': self.name})
return r_code
def test_authentication(self):
"""Test authentication.
:return:
:rtype: tuple(bool, str)
"""
r_code = self._get_auth()
if self.message:
return bool(r_code), self.message
elif not self._check_path():
return False, self.message
if r_code:
return True, 'Success: Connected and Authenticated'
else:
return False, f'Error: Unable to get {self.name} authentication, check your input!'
def remove_torrent(self, info_hash):
"""Remove torrent from client using given info_hash.
:param info_hash:
:type info_hash: string
:return
:rtype: bool
"""
raise NotImplementedError
def remove_torrent_data(self, info_hash):
"""Remove torrent from client and from disk.
:param info_hash:
:type info_hash: string
:return
:rtype: bool
"""
raise NotImplementedError
def pause_torrent(self, info_hash):
"""Pause torrent.
:param info_hash:
:type info_hash: string
:return
:rtype: bool
"""
raise NotImplementedError
def remove_ratio_reached(self):
"""Remove all Medusa torrents that ratio was reached.
It loops in all hashes returned from client and check if it is in the snatch history
if its then it checks if we already processed media from the torrent (episode status `Downloaded`)
If is a RARed
torrent then we don't have a media file so we check if that hash is from an
episode that has a `Downloaded` status
"""
raise NotImplementedError
def torrent_completed(self, info_hash):
"""Check if a specific torrent has finished seeding."""
raise NotImplementedError