-
Notifications
You must be signed in to change notification settings - Fork 277
/
transmission.py
393 lines (314 loc) · 12.9 KB
/
transmission.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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# coding=utf-8
"""Transmission Client."""
from __future__ import unicode_literals
import json
import logging
import os
import re
from base64 import b64encode
from builtins import str
from datetime import datetime, timedelta
from medusa import app
from medusa.clients.torrent.generic import GenericClient
from medusa.helpers import (
get_extension,
is_already_processed_media,
is_info_hash_in_history,
is_info_hash_processed,
is_media_file,
)
from medusa.logger.adapters.style import BraceAdapter
import requests.exceptions
from requests.compat import urljoin
log = BraceAdapter(logging.getLogger(__name__))
log.logger.addHandler(logging.NullHandler())
class TransmissionAPI(GenericClient):
"""Transmission API class."""
def __init__(self, host=None, username=None, password=None):
"""Constructor.
:param host:
:type host: string
:param username:
:type username: string
:param password:
:type password: string
"""
super(TransmissionAPI, self).__init__('Transmission', host, username, password)
self.rpcurl = self.rpcurl.strip('/')
self.url = urljoin(self.host, self.rpcurl + '/rpc')
def check_response(self):
"""Check if response is a valid json and its a success one."""
try:
return self.response.json()['result'] == 'success'
except ValueError:
return False
def _get_auth(self):
post_data = json.dumps({
'method': 'session-get',
})
try:
self.response = self.session.post(self.url, data=post_data.encode('utf-8'), timeout=120,
verify=app.TORRENT_VERIFY_CERT)
except requests.exceptions.ConnectionError as error:
log.warning('{name}: Unable to connect. {error}',
{'name': self.name, 'error': error})
return False
except requests.exceptions.Timeout as error:
log.warning('{name}: Connection timed out. {error}',
{'name': self.name, 'error': error})
return False
self.auth = re.search(r'X-Transmission-Session-Id:\s*(\w+)', self.response.text).group(1)
self.session.headers.update({'x-transmission-session-id': self.auth})
# Validating Transmission authorization
post_data = json.dumps({
'arguments': {},
'method': 'session-get',
})
self._request(method='post', data=post_data)
return self.auth
def _add_torrent_uri(self, result):
arguments = {
'filename': result.url,
'paused': 1 if app.TORRENT_PAUSED else 0
}
if os.path.isabs(app.TORRENT_PATH):
arguments['download-dir'] = app.TORRENT_PATH
post_data = json.dumps({
'arguments': arguments,
'method': 'torrent-add',
})
self._request(method='post', data=post_data)
return self.check_response()
def _add_torrent_file(self, result):
arguments = {
'metainfo': b64encode(result.content).decode('utf-8'),
'paused': 1 if app.TORRENT_PAUSED else 0
}
if os.path.isabs(app.TORRENT_PATH):
arguments['download-dir'] = app.TORRENT_PATH
post_data = json.dumps({
'arguments': arguments,
'method': 'torrent-add',
})
self._request(method='post', data=post_data)
return self.check_response()
def _set_torrent_ratio(self, result):
ratio = None
if result.ratio:
ratio = result.ratio
mode = 0
if ratio:
if float(ratio) == -1:
ratio = 0
mode = 2
elif float(ratio) >= 0:
ratio = float(ratio)
mode = 1 # Stop seeding at seedRatioLimit
arguments = {
'ids': [result.hash],
'seedRatioLimit': ratio,
'seedRatioMode': mode,
}
post_data = json.dumps({
'arguments': arguments,
'method': 'torrent-set',
})
self._request(method='post', data=post_data)
return self.check_response()
def _set_torrent_seed_time(self, result):
if app.TORRENT_SEED_TIME and app.TORRENT_SEED_TIME != -1:
time = int(60 * float(app.TORRENT_SEED_TIME))
arguments = {
'ids': [result.hash],
'seedIdleLimit': time,
'seedIdleMode': 1,
}
post_data = json.dumps({
'arguments': arguments,
'method': 'torrent-set',
})
self._request(method='post', data=post_data)
return self.check_response()
else:
return True
def _set_torrent_priority(self, result):
arguments = {'ids': [result.hash]}
if result.priority == -1:
arguments['priority-low'] = []
elif result.priority == 1:
# set high priority for all files in torrent
arguments['priority-high'] = []
# move torrent to the top if the queue
arguments['queuePosition'] = 0
if app.TORRENT_HIGH_BANDWIDTH:
arguments['bandwidthPriority'] = 1
else:
arguments['priority-normal'] = []
post_data = json.dumps({
'arguments': arguments,
'method': 'torrent-set',
})
self._request(method='post', data=post_data)
return self.check_response()
def remove_torrent(self, info_hash):
"""Remove torrent from client using given info_hash.
:param info_hash:
:type info_hash: string
:return
:rtype: bool
"""
arguments = {
'ids': [info_hash],
'delete-local-data': 1,
}
post_data = json.dumps({
'arguments': arguments,
'method': 'torrent-remove',
})
self._request(method='post', data=post_data)
return self.check_response()
def move_torrent(self, info_hash):
"""Set new torrent location given info_hash.
:param info_hash:
:type info_hash: string
:return
:rtype: bool
"""
if not app.TORRENT_SEED_LOCATION or not info_hash:
return
arguments = {
'ids': [info_hash],
'location': app.TORRENT_SEED_LOCATION,
'move': 'true'
}
post_data = json.dumps({
'arguments': arguments,
'method': 'torrent-set-location',
})
self._request(method='post', data=post_data)
return self.check_response()
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
0 = Torrent is stopped
1 = Queued to check files
2 = Checking files
3 = Queued to download
4 = Downloading
5 = Queued to seed
6 = Seeding
isFinished = whether seeding finished (based on seed ratio)
IsStalled = Based on Tranmission setting "Transfer is stalled when inactive for"
"""
log.info('Checking Transmission torrent status.')
return_params = {
'fields': ['name', 'hashString', 'percentDone', 'status',
'isStalled', 'errorString', 'seedRatioLimit',
'isFinished', 'uploadRatio', 'seedIdleLimit', 'files', 'activityDate']
}
post_data = json.dumps({'arguments': return_params, 'method': 'torrent-get'})
if not self._request(method='post', data=post_data):
log.warning('Error while fetching torrents status')
return
try:
returned_data = json.loads(self.response.text)
except ValueError:
log.warning('Unexpected data received from Transmission: {resp}',
{'resp': self.response.content})
return
if not returned_data['result'] == 'success':
log.debug('Nothing in queue or error')
return
found_torrents = False
for torrent in returned_data['arguments']['torrents']:
# Check if that hash was sent by Medusa
if not is_info_hash_in_history(str(torrent['hashString'])):
continue
found_torrents = True
to_remove = False
for i in torrent['files']:
# Need to check only the media file or the .rar file to avoid checking all .r0* files in history
if not (is_media_file(i['name']) or get_extension(i['name']) == 'rar'):
continue
# Check if media was processed
# OR check hash in case of RARed torrents
if is_already_processed_media(i['name']) or is_info_hash_processed(str(torrent['hashString'])):
to_remove = True
# Don't need to check status if we are not going to remove it.
if not to_remove:
log.info('Torrent not yet post-processed. Skipping: {torrent}',
{'torrent': torrent['name']})
continue
status = 'busy'
error_string = torrent.get('errorString')
if torrent.get('isStalled') and not torrent['percentDone'] == 1:
status = 'stalled'
elif error_string and 'unregistered torrent' in error_string.lower():
status = 'unregistered'
elif torrent['status'] == 0:
status = 'stopped'
if torrent['percentDone'] == 1:
# Check if torrent is stopped because of idle timeout
seed_timed_out = False
if torrent['activityDate'] > 0 and torrent['seedIdleLimit'] > 0:
last_activity_date = datetime.fromtimestamp(torrent['activityDate'])
seed_timed_out = (datetime.now() - timedelta(
minutes=torrent['seedIdleLimit'])) > last_activity_date
if torrent.get('isFinished') or seed_timed_out:
status = 'completed'
elif torrent['status'] == 6:
status = 'seeding'
if status == 'completed':
log.info(
'Torrent completed and reached minimum'
' ratio: [{ratio:.3f}/{ratio_limit:.3f}] or'
' seed idle limit: [{seed_limit} min].'
' Removing it: [{name}]',
ratio=torrent['uploadRatio'],
ratio_limit=torrent['seedRatioLimit'],
seed_limit=torrent['seedIdleLimit'],
name=torrent['name']
)
self.remove_torrent(torrent['hashString'])
elif status == 'stalled':
log.warning('Torrent is stalled. Check it: [{name}]',
name=torrent['name'])
elif status == 'unregistered':
log.warning('Torrent was unregistered from tracker.'
' Check it: [{name}]', name=torrent['name'])
elif status == 'seeding':
if float(torrent['uploadRatio']) < float(torrent['seedRatioLimit']):
log.info(
'Torrent did not reach minimum'
' ratio: [{ratio:.3f}/{ratio_limit:.3f}].'
' Keeping it: [{name}]',
ratio=torrent['uploadRatio'],
ratio_limit=torrent['seedRatioLimit'],
name=torrent['name']
)
else:
log.info(
'Torrent completed and reached minimum ratio but it'
' was force started again. Current'
' ratio: [{ratio:.3f}/{ratio_limit:.3f}].'
' Keeping it: [{name}]',
ratio=torrent['uploadRatio'],
ratio_limit=torrent['seedRatioLimit'],
name=torrent['name']
)
elif status in ('stopped', 'busy'):
log.info('Torrent is {status}. Keeping it: [{name}]',
status=status, name=torrent['name'])
else:
log.warning(
'Torrent has an unmapped status. Keeping it: [{name}].'
' Report torrent info: {info}',
name=torrent['name'],
info=torrent
)
if not found_torrents:
log.info('No torrents found that were snatched by Medusa')
api = TransmissionAPI