-
Notifications
You must be signed in to change notification settings - Fork 1
/
PieceDownloader.py
697 lines (511 loc) · 23 KB
/
PieceDownloader.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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
#!/usr/bin/python
# Helper module to download pieces of torrents and assemble them into the result files
import subprocess, requests, random, xmlrpclib, time, urllib, socket, math
import os, errno, weakref, hashlib, traceback
import threading, Queue
from collections import deque
from dpqueue import DPQueue
from random import randint, random
from bencode import *
from log import *
from tools import *
import requests
from requests.adapters import HTTPAdapter
from requests.packages.urllib3.util.retry import Retry
import platform
if platform.system != "Windows":
WindowsError=IOError
# Disable urllib3 warnings. Unverified is fine for us. From http://stackoverflow.com/questions/27981545/surpress-insecurerequestwarning-unverified-https-request-is-being-made-in-pytho
requests.packages.urllib3.disable_warnings()
# Monkey Patch to set TCPNODELAY flag on HTTP connections
# From http://stackoverflow.com/questions/13699973/how-to-set-tcp-nodelay-flag-when-loading-url-with-urllib2
#from requests.packages.urllib3 import connectionpool
#_HTTPConnection = connectionpool.HTTPConnection
#_HTTPSConnection = connectionpool.HTTPSConnection
#class HTTPConnection(_HTTPConnection):
# def connect(self):
# _HTTPConnection.connect(self)
# self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
#class HTTPSConnection(_HTTPSConnection):
# def connect(self):
# _HTTPSConnection.connect(self)
# self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
#connectionpool.HTTPConnection = HTTPConnection
#connectionpool.HTTPSConnection = HTTPSConnection
###
maxFailures = 3
failureResetTime = 3900
failureResetSpread = 60
maxQueueSize = 500
retrySleep = 120.
retrySleepSpread = 40
startSpread = 2.
apiStats = {}
apiStatsLock = RWLock()
# Download set handler class
class Download(object):
def __init__(self, pdl, jtorrent, basedir = u".", startPaused = False, downloadedPieces = None, downloadedBytes = 0,
basePriority = 0):
self._pdl = weakref.ref(pdl)
self._jtorrent = weakref.ref(jtorrent)
self._basedir = basedir
self._paused = startPaused
log(DEBUG)
self._files = jtorrent.files
self._size = jtorrent.size
self._piece_size = jtorrent.piece_size
self._npieces = jtorrent.npieces
if downloadedPieces == None:
downloadedPieces = "0" * self._npieces
self._nPendingPieces = 0
self._downloadedPieces = self._finishedPieces = downloadedPieces
self._nDownloadedPieces = downloadedPieces.count('1')
self.downloadedBytes = downloadedBytes
log(DEBUG2, "self.downloadedPieces=%s self.downloadedBytes=%d self._nDownloadedPieces=%d" % (self._downloadedPieces, self.downloadedBytes, self._nDownloadedPieces))
# Public attributes
self.downloadSpeed = 0.
self.etc = 0
self.priority = basePriority
# Helper attribus for speed calc
self._speedQ = deque( maxlen = 5 ) # Keep 5 records for averaging
self._lastUpdate = 0.
self._lastDownloaded = 0
self._nFailures = 0
self._lastFailure = 0
# Build piece->file map
self._piecefiles = []
for p in xrange(self._npieces):
self._piecefiles.append([])
for f in self._files:
log(DEBUG2, "File=%s required=%d start=%d:%d end=%d:%d"% (f, f.required, f.start_piece, f.start_piece_offset, f.end_piece, f.end_piece_offset))
if f.required:
for p in xrange(f.start_piece, f.end_piece + 1):
self._piecefiles[p].append(f)
self._nPiecesToDownload = 0
for p in xrange(self._npieces):
if len(self._piecefiles[p]) > 0:
self._nPiecesToDownload += 1
log(DEBUG2, "PF=%s nPTD=%d"% (self._piecefiles, self._nPiecesToDownload))
def __repr__(self):
return "PDL:Download(%r (0x%x))"% (self._basedir, id(self))
def update(self):
log(DEBUG2)
if self._paused or self.hasFinished or self.hasFailed:
self.downloadSpeed = 0.
self.etc = 0
return
# Has our server failed?
if self._pdl().hasServerFailed(self._jtorrent().pieces[0].url):
return
# Find newly finished pieces
lp = self._finishedPieces
nadd = 0
log(DEBUG3, "LP=%s" % lp)
for i,e in enumerate(zip(self._finishedPieces, self._jtorrent().bitfield)):
if self._pdl().stalled() or self._nPendingPieces >= maxQueueSize * 0.1:
break
if e[0] == '0' and e[1] == '1':
# Mark piece as handled
lp = self._finishedPieces
self._finishedPieces = lp[:i] + "1" + lp[i+1:]
# Send piece off to downloader/writer
self._pdl().pieceFinished(self, self._jtorrent().pieces[i])
self._nPendingPieces += 1
# Update download speed
now = int(time.time())
log(DEBUG3, "%s: _lastUpdate=%s now=%s speedQ=%s" % (self._jtorrent().name, self._lastUpdate, now, self._speedQ))
if self._lastUpdate != 0. and self._lastUpdate != now:
sp = (self.downloadedBytes - self._lastDownloaded) / (now - self._lastUpdate)
self._speedQ.append( sp )
self.downloadSpeed = sum(self._speedQ) / float(len(self._speedQ))
##self.downloadSpeed = sp
# Derived values
try:
self.etc = time.time() + (self._size - self.downloadedBytes) / self.downloadSpeed
except Exception,e :
self.etc = 0
self._lastUpdate = now
self._lastDownloaded = self.downloadedBytes
# How important is this piece?
def piecePriority(self, p):
prio = self.priority + 100000. / math.log10(max(self._size - self.downloadedBytes, 0))
if self._pdl().hasServerFailed(p.url):
prio -= 10000000
log(DEBUG2, "%s (%s) self._size=%d self.downloadedBytes=%d prio=%f" % (self._jtorrent().name, p, self._size, self.downloadedBytes, prio))
return prio
# Piece finished, download it
def pieceFinished(self, p):
if self.hasFailed:
log(DEBUG, "has failed, ignoring")
return
if self._jtorrent().status in ["expired", "deleted"]:
log(DEBUG, "is %s, ignoring" % self._jtorrent().status)
return
if self._pdl().hasServerFailed(p.url):
log(DEBUG3, "Server %s in fail state, ignoring piece. Let post-check pick it up..." % p.url)
##self._pdl().pieceFinished(self, p, abort_on_wait = False)
return
log(DEBUG, "Piece %d finished (size=%d)." % (p.number, p.size))
try:
log(DEBUG3, "url=%s" % p.url)
time.sleep(random() * startSpread)
start = time.time()
r = self._pdl()._session.get(p.url, params = {"api_key":self._jtorrent()._jsit()._api_key}, verify=False, timeout=30, headers={'Connection':'close'})
end = time.time()
log(DEBUG3, "Got %r" % r.content)
# Keep stats
with apiStatsLock.write_access:
try:
s = apiStats["/piece.csp"]
ns = (s[0] + 1, s[1] + (end-start))
apiStats["/piece.csp"] = ns
except KeyError:
apiStats["/piece.csp"] = (1, end-start)
if r.status_code == 404:
log(WARNING, "Piece %d of %s doesn't exist (probably expired...)!" % (p.number, self._jtorrent().name))
if self._jtorrent() != "stopped":
self._jtorrent().stop()
# Just return, accept piece as finished, but don't write any data
# Post-check will pick it up...
return
r.raise_for_status()
# Reset failures after successful download
self._nFailures = 1
except Exception,e :
# Put piece back into queue for retry, unless queue full
time.sleep(retrySleep) # Don't put it right back in case there is permanent failures
self._pdl().pieceFinished(self, p, abort_on_wait = True)
# Failed already? Don't bother waiting...
if self._pdl().hasServerFailed(p.url):
log(WARNING, u"Caught exception %s downloading piece %d from failed %s!" % (e, p.number, p.url))
if "actively refused it" in str(e):
# Abort on 404s or get banned quickly...
self.stop()
return
self._pdl().serverFailed(p.url, str(e))
if "timeout" in str(e) or "timed out" in str(e) or "EOF occurred" in str(e) or \
"period of time" in str(e) or "Max retries exceeded" in str(e) or \
"Connection aborted" in str(e) or "Unexpected EOF" in str(e) or \
"reset by peer" in str(e):
log(DEBUG, "Timeout downloading piece %d of %s (%s)!" % (p.number, self._jtorrent().name, e))
time.sleep(retrySleep + randint(0,retrySleepSpread)) # Don't put it right back in case there is permanent failures
else:
log(WARNING, u"Caught exception %s downloading piece %d from %s!" % (e, p.number, p.url))
log(WARNING, traceback.format_exc())
time.sleep(retrySleep + randint(0,retrySleepSpread)) # Don't put it right back in case there is permanent failures
if time.time() > self._lastFailure + failureResetTime:
self._nFailures = 1 # reset when time since last failure long enough
else:
self._nFailures += 1 # this is not guaranteed to be accurate in MT, but we only need approximate counts
self._lastFailure = time.time()
if self._nFailures == maxFailures:
log(ERROR, "Stopping torrent %s because of failures!" % self._jtorrent().name)
self.stop()
if "actively refused it" in str(e):
# Abort on 404s or get banned quickly...
self.stop()
return
if len(r.content) != p.size:
log(DEBUG, "Piece %d of %s: only got %d instead of %d bytes!" % (p.number, self._jtorrent().name, len(r.content), p.size))
self._pdl().pieceFinished(self, p, abort_on_wait = True)
return
self._pdl().writePiece(self, p, r.content)
# Write piece to file(s)
def writePiece(self, p, content):
for f in self._piecefiles[p.number]:
try:
fn = unicode_cleanup(f.path)
if fn[0] == '/':
fn = fn[1:]
fn = clean_pathname(os.path.abspath(os.path.join(self._basedir, fn)))
#fn = clean_pathname(os.path.join(self._basedir, f.path)).encode(sys.getfilesystemencoding())
try:
mkdir_p(fn.rsplit(os.path.sep,1)[0])
except (IOError,WindowsError),e:
# Filename error? Try XML-encoded ASCII...
if "invalid mode" in str(e) or "syntax is incorrect" in str(e):
fn = clean_pathname(os.path.join(self._basedir, f.path)).encode("ascii", "xmlcharrefreplace")
mkdir_p(fn.rsplit(os.path.sep,1)[0])
if p.number == f.end_piece and p.number == f.start_piece:
l = f.end_piece_offset - f.start_piece_offset
elif p.number == f.end_piece:
l = f.end_piece_offset
else:
l = self._piece_size
try:
f.write(fn, p, content, l)
except (IOError,WindowsError),e:
# Filename error? Try XML-encoded ASCII...
if "invalid mode" in str(e) or "syntax is incorrect" in str(e):
fn = clean_pathname(os.path.join(self._basedir, f.path)).encode("ascii", "xmlcharrefreplace")
f.write(fn, p, content, l)
elif "Permission denied" in str(e):
free = get_free_space(fn)
if free <= size:
log(WARNING, "Not enough space to write piece %d for %s, stopping!" % (p.number, fn))
self.stop()
else:
raise
else:
raise
except Exception,e:
log(ERROR, "Caught %s trying to write piece %d for file %s!" % (e, p.number, fn))
return
self.downloadedBytes += p.size
dp = self._downloadedPieces
self._downloadedPieces = dp[:p.number] + "1" + dp[p.number+1:]
self._nDownloadedPieces += 1
self._nPendingPieces -= 1
def stop(self):
self._paused = True
self._pdl()._pieceQ.filter(lambda p: p[0] != self)
self._nPendingPieces = 0
def start(self, basedir = None, downloadedPieces = None, downloadedBytes = None, basePriority = None):
if not basedir is None:
self._basedir = basedir
if not downloadedPieces is None:
self.downloadedPieces = self._finishedPieces = downloadedPieces
if not downloadedBytes is None:
self.downloadedBytes = downloadedBytes
if not basePriority is None:
self.priority = basePriority
self._paused = False
self._nFailures = 0
def delete(self):
self._pdl().deleteTorrent(self)
@property
def hasFinished(self):
#return self.downloadedBytes == self._size
return self._nDownloadedPieces >= self._nPiecesToDownload
@property
def hasFailed(self):
return self._nFailures >= maxFailures
@property
def percentage(self):
#return self.downloadedBytes / float(self._size) * 100.
return min(100., self._nDownloadedPieces / float(self._nPiecesToDownload) * 100.)
@property
def status(self):
s = ""
if self._paused:
s += "paused "
else:
s += "dl "
if self.hasFinished:
s += "done "
if self.hasFailed:
s += "failed "
return s
# Main class providing piece downloader management
class PieceDownloader(object):
def __init__(self, jsit, nthreads = 0):
log(DEBUG)
self._jsit = jsit
# Our session
self._session = requests.Session()
retries = Retry(total=2, backoff_factor=2)
self._session.mount('http://', HTTPAdapter(max_retries=retries))
self._session.mount('https://', HTTPAdapter(max_retries=retries))
# Currently running downloads
self._downloads = []
# Keep track of server failures and give them some time to recover
self._serverfails = {}
# Parallel? Create queues, start threads
self._nthreads = nthreads
if nthreads:
self._pieceQ = DPQueue(maxsize = maxQueueSize, prio = lambda e: e[0] == None or -e[0].piecePriority(e[1]))
self._writeQ = Queue.PriorityQueue(maxsize = maxQueueSize)
self._quitting = False
self._writeThread = threading.Thread(target=self.writePieceThread, name="PieceWriter")
self._writeThread.start()
self._pieceThreads = []
for t in xrange(0, nthreads):
t = threading.Thread(target=self.pieceFinishedThread, name="PieceDown-%d" % t)
##t.daemon = True
t.start()
self._pieceThreads.append(t)
def __repr__(self):
return "PieceDownloader(0x%x)"% id(self)
# Cleanup methods...
def __del__(self):
self.release()
def __enter__(self):
return self
def __exit__(self, type, value, traceback):
self.release()
def release(self):
if self._nthreads:
log(DEBUG, "Send suicide signals...")
self._quitting = True
self._writeQ.put((0, None, -1, ""))
for t in xrange(0, self._nthreads):
self._pieceQ.put((None, -1))
log(DEBUG, "Wait for threads to finish...")
self._writeThread.join()
log(DEBUG, "WriteThread done.")
for t in xrange(0, self._nthreads):
self._pieceThreads[t].join(5)
if self._pieceThreads[t].isAlive():
log(DEBUG, "PieceThread %d not responding!" % t)
else:
log(DEBUG, "PieceThread %d done." % t)
log(DEBUG, "All threads done!")
self._nthreads = 0
# Analyze stats
l = []
nc = 0
tc = 0
for k,v in apiStats.iteritems():
l.append([k, v[0], v[1]])
nc += v[0]
tc += v[1]
log(DEBUG, "API stats: called API %d times, taking %.02f secs" % (nc,tc))
log(DEBUG, "Most used:")
l.sort(key = lambda e: -e[1])
for i in xrange(0, min(len(l), 20)):
c = l[i]
log(DEBUG, " %s:\t%d calls" % (c[0], c[1]))
log(DEBUG, "Most time:")
l.sort(key = lambda e: -e[2])
for i in xrange(0, min(len(l), 20)):
c = l[i]
log(DEBUG, " %s:\t%.02f s in %d calls" % (c[0], c[2], c[1]))
log(DEBUG, "Most expensive:")
l.sort(key = lambda e: -e[2]/e[1])
for i in xrange(0, min(len(l), 20)):
c = l[i]
log(DEBUG, " %s:\t%.02f s/c in %d calls" % (c[0], c[2]/c[1], c[1]))
# (Parallel) Piece handling
def pieceFinished(self, tor, piece, abort_on_wait = False):
log(DEBUG)
if self._nthreads:
if abort_on_wait and self._pieceQ.full():
log(ERROR, "Put piece %s:%s: queue full and abort_on_wait set. Failing torrent to prevent deadlock!" % (tor, piece))
tor._nFailures = maxFailures
else:
log(DEBUG, "Put piece %s:%s (prio=%d)" % (tor, piece, tor.piecePriority(piece)))
self._pieceQ.put((tor, piece))
cont = None
else:
cont = tor.pieceFinished(piece)
return cont
def writePiece(self, tor, piece, cont):
log(DEBUG)
if self._nthreads:
prio = tor.piecePriority(piece)
log(DEBUG, "Put piece %s:%s (prio=%d)" % (tor, piece, prio))
self._writeQ.put((-prio, tor, piece, cont))
else:
tor.writePiece(piece, cont)
def pieceFinishedThread(self):
log(DEBUG)
try:
while not self._quitting:
piece = -2
while piece == -2:
try:
tor,piece = self._pieceQ.get(True, 300)
except Queue.Empty:
log(DEBUG3, "Heartbeat...")
log(DEBUG, "Got piece %s:%s" % (tor, piece))
if piece == -1 or not self._jsit.connected():
log(DEBUG, "Got suicide signal, returning.")
return
tor.pieceFinished(piece)
self._pieceQ.task_done()
except Exception, e:
log(ERROR, "Caught %s" % e)
log(ERROR, traceback.format_exc())
log(DEBUG, "Ending (%s)" % self._quitting)
def writePieceThread(self):
log(DEBUG)
try:
while not self._quitting:
piece = -2
while piece == -2:
try:
prio,tor,piece,cont = self._writeQ .get(True, 30)
except Queue.Empty:
log(DEBUG3, "Heartbeat...")
log(DEBUG, "Got piece %s:%s (%d bytes content, prio=%d)" % (tor,piece, len(cont), prio))
if piece == -1:
log(DEBUG, "Got suicide signal, returning.")
return
tor.writePiece(piece, cont)
self._writeQ.task_done()
except Exception, e:
log(WARNING, "Caught %s" % e)
log(WARNING, traceback.format_exc())
log(DEBUG, "Ending (%s)" % self._quitting)
def stalled(self):
if not self._nthreads:
return False
return self._pieceQ.qsize() >= maxQueueSize - self._nthreads - 1 or self._writeQ.full()
# Iterator access to downloads list
def __iter__(self):
return iter(self._downloads)
# Status
@property
def hasFinished(self):
flag = True
for t in self:
flag &= t.hasFinished
return flag
# Server failure handling
def hasServerFailed(self, url):
try:
server = url.split('/')[2]
if not server in self._serverfails.keys():
return False
except Exception, e:
return False
now = time.time()
if now > self._serverfails[server] + failureResetTime:
try:
del self._serverfails[server]
except KeyError:
pass
log(WARNING, "Server %s passed failureResetTime %f." % (server, failureResetTime))
return False
return True
def serverFailed(self, url, reason = None):
server = url.split('/')[2]
now = time.time()
if not server in self._serverfails.keys():
if reason is None:
log(WARNING, "Server %s has failed." % server)
else:
log(WARNING, "Server %s has failed (%s)." % (server, reason))
self._serverfails[server] = now + randint(0, failureResetSpread)
# Control
def download(self, torrent, basedir = u".", startPaused = True, downloadedPieces = "", downloadedBytes = 0, basePriority = 0):
d = Download(self, torrent, basedir=basedir, startPaused=startPaused, downloadedPieces = downloadedPieces,
downloadedBytes = downloadedBytes, basePriority = basePriority)
self._downloads.append(d)
return d
def pauseAll(self):
pass
def unpauseAll(self):
pass
def deleteTorrent(self, tor):
tor.stop()
self._downloads.remove(tor)
def update(self):
if self._nthreads:
log(DEBUG, "Got %d downloads (%d pieces pending, %d writes pending)." % (len(self._downloads), self._pieceQ.qsize(), self._writeQ.qsize()))
else:
log(DEBUG, "Got %d downloads." % len(self._downloads))
if self._nthreads > 0:
self._pieceQ.reprioritize()
for t in sorted(self._downloads, key=lambda t: -t.priority):
t.update()
def getDebug(self):
out = ""
out += "<h3>Downloads</h3><p><ul>\n"
for d in self._downloads:
out += "<li>%s</li>\n" % (d)
out += "</ul></p>"
out += "<h3>Piece Queue</h3><p><ul>"
out += self._pieceQ.getDebug()
out += "</ul></p>"
return out