forked from deluge-torrent/deluge
-
Notifications
You must be signed in to change notification settings - Fork 5
/
torrent.py
1384 lines (1147 loc) · 53.8 KB
/
torrent.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
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
#
# Copyright (C) 2007-2009 Andrew Resch <andrewresch@gmail.com>
#
# This file is part of Deluge and is licensed under GNU General Public License 3.0, or later, with
# the additional special exception to link portions of this program with the OpenSSL library.
# See LICENSE for more details.
#
"""Internal Torrent class
Attributes:
LT_TORRENT_STATE_MAP (dict): Maps the torrent state from libtorrent to Deluge state.
"""
from __future__ import division
import logging
import os
import socket
from itertools import izip
from urlparse import urlparse
from twisted.internet.defer import Deferred, DeferredList
import deluge.component as component
from deluge._libtorrent import lt
from deluge.common import decode_string, utf8_encoded
from deluge.configmanager import ConfigManager, get_config_dir
from deluge.core.authmanager import AUTH_LEVEL_ADMIN
from deluge.event import TorrentFolderRenamedEvent, TorrentStateChangedEvent, TorrentTrackerStatusEvent
log = logging.getLogger(__name__)
LT_TORRENT_STATE_MAP = {
"queued_for_checking": "Checking",
"checking_files": "Checking",
"downloading_metadata": "Downloading",
"downloading": "Downloading",
"finished": "Seeding",
"seeding": "Seeding",
"allocating": "Allocating",
"checking_resume_data": "Checking"
}
def sanitize_filepath(filepath, folder=False):
"""Returns a sanitized filepath to pass to libtorrent rename_file().
The filepath will have backslashes substituted along with whitespace
padding and duplicate slashes stripped.
Args:
folder (bool): A trailing slash is appended to the returned filepath.
"""
def clean_filename(filename):
"""Strips whitespace and discards dotted filenames"""
filename = filename.strip()
if filename.replace(".", "") == "":
return ""
return filename
if "\\" in filepath or "/" in filepath:
folderpath = filepath.replace("\\", "/").split("/")
folderpath = [clean_filename(x) for x in folderpath]
newfilepath = "/".join([path for path in folderpath if path])
else:
newfilepath = clean_filename(filepath)
if folder is True:
newfilepath += "/"
return newfilepath
def convert_lt_files(files):
"""Indexes and decodes files from libtorrent get_files().
Args:
files (list): The libtorrent torrent files.
Returns:
list of dict: The files.
The format for the file dict::
{
"index": int,
"path": str,
"size": int,
"offset": int
}
"""
filelist = []
for index, _file in enumerate(files):
filelist.append({
"index": index,
"path": _file.path.decode("utf8").replace("\\", "/"),
"size": _file.size,
"offset": _file.offset
})
return filelist
class TorrentOptions(dict):
"""TorrentOptions create a dict of the torrent options.
Attributes:
max_connections (int): Sets maximum number of connections this torrent will open.
This must be at least 2. The default is unlimited (-1).
max_upload_slots (int): Sets the maximum number of peers that are
unchoked at the same time on this torrent. This defaults to infinite (-1).
max_upload_speed (float): Will limit the upload bandwidth used by this torrent to the limit
you set. The default is unlimited (-1) but will not exceed global limit.
max_download_speed (float): Will limit the download bandwidth used by this torrent to the
limit you set.The default is unlimited (-1) but will not exceed global limit.
prioritize_first_last_pieces (bool): Prioritize the first and last pieces in the torrent.
sequential_download (bool): Download the pieces of the torrent in order.
pre_allocate_storage (bool): When adding the torrent should all files be pre-allocated.
download_location (str): The path for the torrent data to be stored while downloading.
auto_managed (bool): Set torrent to auto managed mode, i.e. will be started or queued automatically.
stop_at_ratio (bool): Stop the torrent when it has reached stop_ratio.
stop_ratio (float): The seeding ratio to stop (or remove) the torrent at.
remove_at_ratio (bool): Remove the torrent when it has reached the stop_ratio.
move_completed (bool): Move the torrent when downloading has finished.
move_completed_path (str): The path to move torrent to when downloading has finished.
add_paused (bool): Add the torrrent in a paused state.
shared (bool): Enable the torrent to be seen by other Deluge users.
super_seeding (bool): Enable super seeding/initial seeding.
priority (int): Torrent bandwidth priority with a range [0..255], 0 is lowest and default priority.
file_priorities (list of int): The priority for files in torrent, range is [0..7] however
only [0, 1, 5, 7] are normally used and correspond to [Do Not Download, Normal, High, Highest]
mapped_files (dict): A mapping of the renamed filenames in 'index:filename' pairs.
owner (str): The user this torrent belongs to.
name (str): The display name of the torrent.
seed_mode (bool): Assume that all files are present for this torrent (Only used when adding a torent).
"""
def __init__(self):
super(TorrentOptions, self).__init__()
config = ConfigManager("core.conf").config
options_conf_map = {
"max_connections": "max_connections_per_torrent",
"max_upload_slots": "max_upload_slots_per_torrent",
"max_upload_speed": "max_upload_speed_per_torrent",
"max_download_speed": "max_download_speed_per_torrent",
"prioritize_first_last_pieces": "prioritize_first_last_pieces",
"sequential_download": "sequential_download",
"pre_allocate_storage": "pre_allocate_storage",
"download_location": "download_location",
"auto_managed": "auto_managed",
"stop_at_ratio": "stop_seed_at_ratio",
"stop_ratio": "stop_seed_ratio",
"remove_at_ratio": "remove_seed_at_ratio",
"move_completed": "move_completed",
"move_completed_path": "move_completed_path",
"add_paused": "add_paused",
"shared": "shared",
"super_seeding": "super_seeding",
"priority": "priority",
}
for opt_k, conf_k in options_conf_map.iteritems():
self[opt_k] = config[conf_k]
self["file_priorities"] = []
self["mapped_files"] = {}
self["owner"] = ""
self["name"] = ""
self["seed_mode"] = False
class TorrentError(object):
def __init__(self, error_message, was_paused=False, restart_to_resume=False):
self.error_message = error_message
self.was_paused = was_paused
self.restart_to_resume = restart_to_resume
class Torrent(object):
"""Torrent holds information about torrents added to the libtorrent session.
Args:
handle: The libtorrent torrent handle.
options (dict): The torrent options.
state (TorrentState): The torrent state.
filename (str): The filename of the torrent file.
magnet (str): The magnet uri.
Attributes:
torrent_id (str): The torrent_id for this torrent
handle: Holds the libtorrent torrent handle
magnet (str): The magnet uri used to add this torrent (if available).
status: Holds status info so that we don"t need to keep getting it from libtorrent.
torrent_info: store the torrent info.
has_metadata (bool): True if the metadata for the torrent is available, False otherwise.
status_funcs (dict): The function mappings to get torrent status
prev_status (dict): Previous status dicts returned for this torrent. We use this to return
dicts that only contain changes from the previous.
{session_id: status_dict, ...}
waiting_on_folder_rename (list of dict): A list of Deferreds for file indexes we're waiting for file_rename
alerts on. This is so we can send one folder_renamed signal instead of multiple file_renamed signals.
[{index: Deferred, ...}, ...]
options (dict): The torrent options.
filename (str): The filename of the torrent file in case it is required.
is_finished (bool): Keep track if torrent is finished to prevent some weird things on state load.
statusmsg (str): Status message holds error/extra info about the torrent.
state (str): The torrent's state
trackers (list of dict): The torrent's trackers
tracker_status (str): Status message of currently connected tracker
tracker_host (str): Hostname of the currently connected tracker
forcing_recheck (bool): Keep track if we're forcing a recheck of the torrent
forcing_recheck_paused (bool): Keep track if we're forcing a recheck of the torrent so that
we can re-pause it after its done if necessary
forced_error (TorrentError): Keep track if we have forced this torrent to be in Error state.
"""
def __init__(self, handle, options, state=None, filename=None, magnet=None):
self.torrent_id = str(handle.info_hash())
if log.isEnabledFor(logging.DEBUG):
log.debug("Creating torrent object %s", self.torrent_id)
# Get the core config
self.config = ConfigManager("core.conf")
self.rpcserver = component.get("RPCServer")
self.handle = handle
self.handle.resolve_countries(True)
self.magnet = magnet
self.status = self.handle.status()
try:
self.torrent_info = self.handle.get_torrent_info()
except RuntimeError:
self.torrent_info = None
self.has_metadata = self.status.has_metadata
self.options = TorrentOptions()
self.options.update(options)
# Load values from state if we have it
if state:
self.set_trackers(state.trackers)
self.is_finished = state.is_finished
self.filename = state.filename
else:
self.set_trackers()
self.is_finished = False
self.filename = filename
self.forced_error = None
self.statusmsg = None
self.state = None
self.moving_storage = False
self.moving_storage_dest_path = None
self.tracker_status = ""
self.tracker_host = None
self.forcing_recheck = False
self.forcing_recheck_paused = False
self.status_funcs = None
self.prev_status = {}
self.waiting_on_folder_rename = []
self.update_status(self.handle.status())
self._create_status_funcs()
self.set_options(self.options)
self.update_state()
if log.isEnabledFor(logging.DEBUG):
log.debug("Torrent object created.")
def on_metadata_received(self):
"""Process the metadata received alert for this torrent"""
self.has_metadata = True
self.torrent_info = self.handle.get_torrent_info()
if self.options["prioritize_first_last_pieces"]:
self.set_prioritize_first_last_pieces(True)
self.write_torrentfile()
# --- Options methods ---
def set_options(self, options):
"""Set the torrent options.
Args:
options (dict): Torrent options, see TorrentOptions class for valid keys.
"""
# set_prioritize_first_last is called by set_file_priorities so only run if not in options
skip_func = []
if "file_priorities" in options:
self.options["prioritize_first_last_pieces"] = options["prioritize_first_last_pieces"]
skip_func.append("prioritize_first_last_pieces")
for key, value in options.items():
if key in self.options:
options_set_func = getattr(self, "set_" + key, None)
if options_set_func and key not in skip_func:
options_set_func(value)
else:
# Update config options that do not have funcs
self.options[key] = value
def get_options(self):
"""Get the torrent options.
Returns:
dict: the torrent options.
"""
return self.options
def set_max_connections(self, max_connections):
"""Sets maximum number of connections this torrent will open.
Args:
max_connections (int): Maximum number of connections
Note:
The minimum value for handle.max_connections is 2 (or -1 for unlimited connections).
This is enforced by libtorrent and values 0 or 1 raise an assert with lt debug builds.
"""
if max_connections == 0:
max_connections = -1
elif max_connections == 1:
max_connections = 2
self.options["max_connections"] = max_connections
self.handle.set_max_connections(max_connections)
def set_max_upload_slots(self, max_slots):
"""Sets maximum number of upload slots for this torrent.
Args:
max_slots (int): Maximum upload slots
"""
self.options["max_upload_slots"] = max_slots
self.handle.set_max_uploads(max_slots)
def set_max_upload_speed(self, m_up_speed):
"""Sets maximum upload speed for this torrent.
Args:
m_up_speed (float): Maximum upload speed in KiB/s.
"""
self.options["max_upload_speed"] = m_up_speed
if m_up_speed < 0:
value = -1
else:
value = int(m_up_speed * 1024)
self.handle.set_upload_limit(value)
def set_max_download_speed(self, m_down_speed):
"""Sets maximum download speed for this torrent.
Args:
m_up_speed (float): Maximum download speed in KiB/s.
"""
self.options["max_download_speed"] = m_down_speed
if m_down_speed < 0:
value = -1
else:
value = int(m_down_speed * 1024)
self.handle.set_download_limit(value)
def set_prioritize_first_last(self, prioritize):
"""Deprecated due to mismatch between option and func name."""
self.set_prioritize_first_last_pieces(prioritize)
def set_prioritize_first_last_pieces(self, prioritize):
"""Prioritize the first and last pieces in the torrent.
Args:
prioritize (bool): Prioritize the first and last pieces.
Returns:
tuple of lists: The prioritized pieces and the torrent piece priorities.
"""
self.options["prioritize_first_last_pieces"] = prioritize
if not prioritize:
# If we are turning off this option, call set_file_priorities to
# reset all the piece priorities
self.set_file_priorities(self.options["file_priorities"])
return None, None
if not self.has_metadata:
return None, None
if self.get_status(["storage_mode"])["storage_mode"] == "compact":
log.debug("Setting first/last priority with compact allocation does not work!")
return None, None
# A list of priorities for each piece in the torrent
priorities = self.handle.piece_priorities()
prioritized_pieces = []
t_info = self.torrent_info
for i in range(t_info.num_files()):
_file = t_info.file_at(i)
two_percent_bytes = int(0.02 * _file.size)
# Get the pieces for the byte offsets
first_start = t_info.map_file(i, 0, 0).piece
first_end = t_info.map_file(i, two_percent_bytes, 0).piece
last_start = t_info.map_file(i, _file.size - two_percent_bytes, 0).piece
last_end = t_info.map_file(i, max(_file.size - 1, 0), 0).piece
first_end += 1
last_end += 1
prioritized_pieces.append((first_start, first_end))
prioritized_pieces.append((last_start, last_end))
# Set the pieces in our first and last ranges to priority 7
# if they are not marked as do not download
priorities[first_start:first_end] = [p and 7 for p in priorities[first_start:first_end]]
priorities[last_start:last_end] = [p and 7 for p in priorities[last_start:last_end]]
# Setting the priorites for all the pieces of this torrent
self.handle.prioritize_pieces(priorities)
return prioritized_pieces, priorities
def set_sequential_download(self, set_sequencial):
"""Sets whether to download the pieces of the torrent in order.
Args:
set_sequencial (bool): Enable sequencial downloading.
"""
if self.get_status(["storage_mode"])["storage_mode"] != "compact":
self.options["sequential_download"] = set_sequencial
self.handle.set_sequential_download(set_sequencial)
else:
self.options["sequential_download"] = False
def set_auto_managed(self, auto_managed):
"""Set auto managed mode, i.e. will be started or queued automatically.
Args:
auto_managed (bool): Enable auto managed.
"""
self.options["auto_managed"] = auto_managed
if not (self.status.paused and not self.status.auto_managed):
self.handle.auto_managed(auto_managed)
self.update_state()
def set_super_seeding(self, super_seeding):
"""Set super seeding/initial seeding.
Args:
super_seeding (bool): Enable super seeding.
"""
if self.status.is_seeding:
self.options["super_seeding"] = super_seeding
self.handle.super_seeding(super_seeding)
else:
self.options["super_seeding"] = False
def set_stop_ratio(self, stop_ratio):
"""The seeding ratio to stop (or remove) the torrent at.
Args:
stop_ratio (float): The seeding ratio.
"""
self.options["stop_ratio"] = stop_ratio
def set_stop_at_ratio(self, stop_at_ratio):
"""Stop the torrent when it has reached stop_ratio.
Args:
stop_at_ratio (bool): Stop the torrent.
"""
self.options["stop_at_ratio"] = stop_at_ratio
def set_remove_at_ratio(self, remove_at_ratio):
"""Remove the torrent when it has reached the stop_ratio.
Args:
remove_at_ratio (bool): Remove the torrent.
"""
self.options["remove_at_ratio"] = remove_at_ratio
def set_move_completed(self, move_completed):
"""Set whether to move the torrent when downloading has finished.
Args:
move_completed (bool): Move the torrent.
"""
self.options["move_completed"] = move_completed
def set_move_completed_path(self, move_completed_path):
"""Set the path to move torrent to when downloading has finished.
Args:
move_completed_path (str): The move path.
"""
self.options["move_completed_path"] = move_completed_path
def set_file_priorities(self, file_priorities):
"""Sets the file priotities.
Args:
file_priorities (list of int): List of file priorities
"""
if not self.has_metadata:
return
if len(file_priorities) != self.torrent_info.num_files():
log.debug("file_priorities len != num_files")
self.options["file_priorities"] = self.handle.file_priorities()
return
if self.get_status(["storage_mode"])["storage_mode"] == "compact":
log.warning("Setting file priority with compact allocation does not work!")
self.options["file_priorities"] = self.handle.file_priorities()
return
if log.isEnabledFor(logging.DEBUG):
log.debug("Setting %s's file priorities: %s", self.torrent_id, file_priorities)
self.handle.prioritize_files(file_priorities)
if 0 in self.options["file_priorities"]:
# We have previously marked a file 'Do Not Download'
# Check to see if we have changed any 0's to >0 and change state accordingly
for index, priority in enumerate(self.options["file_priorities"]):
if priority == 0 and file_priorities[index] > 0:
# We have a changed 'Do Not Download' to a download priority
self.is_finished = False
self.update_state()
break
# In case values in file_priorities were faulty (old state?)
# we make sure the stored options are in sync
self.options["file_priorities"] = self.handle.file_priorities()
# Set the first/last priorities if needed
if self.options["prioritize_first_last_pieces"]:
self.set_prioritize_first_last_pieces(self.options["prioritize_first_last_pieces"])
def set_save_path(self, download_location):
"""Deprecated, use set_download_location."""
self.set_download_location(download_location)
def set_download_location(self, download_location):
"""The location for downloading torrent data."""
self.options["download_location"] = download_location
def set_priority(self, priority):
"""Sets the bandwidth priority of this torrent.
Bandwidth is not distributed strictly in order of priority, but the priority is used as a weight.
Accepted priority range is [0..255] where 0 is lowest (and default) priority.
priority (int): the torrent priority
Raises:
ValueError: If value of priority is not in range [0..255]
"""
if 0 <= priority <= 255:
self.options["priority"] = priority
return self.handle.set_priority(priority)
else:
raise ValueError("Torrent priority, %s, is invalid, should be [0..255]", priority)
def set_owner(self, account):
"""Sets the owner of this torrent.
Only a user with admin level auth can change this value.
"""
if self.rpcserver.get_session_auth_level() == AUTH_LEVEL_ADMIN:
self.options["owner"] = account
# End Options methods #
def set_trackers(self, trackers=None):
"""Sets the trackers for this torrent.
Args:
trackers (list of dicts): A list of trackers.
"""
if trackers is None:
self.trackers = [tracker for tracker in self.handle.trackers()]
self.tracker_host = None
return
if log.isEnabledFor(logging.DEBUG):
log.debug("Setting trackers for %s: %s", self.torrent_id, trackers)
tracker_list = []
for tracker in trackers:
new_entry = lt.announce_entry(str(tracker["url"]))
new_entry.tier = tracker["tier"]
tracker_list.append(new_entry)
self.handle.replace_trackers(tracker_list)
# Print out the trackers
if log.isEnabledFor(logging.DEBUG):
log.debug("Trackers set for %s:", self.torrent_id)
for tracker in self.handle.trackers():
log.debug(" [tier %s]: %s", tracker["tier"], tracker["url"])
# Set the tracker list in the torrent object
self.trackers = trackers
if len(trackers) > 0:
# Force a re-announce if there is at least 1 tracker
self.force_reannounce()
self.tracker_host = None
def set_tracker_status(self, status):
"""Sets the tracker status.
Args:
status (str): The tracker status.
Emits:
TorrentTrackerStatusEvent upon tracker status change.
"""
self.tracker_host = None
if self.tracker_status != status:
self.tracker_status = status
component.get("EventManager").emit(TorrentTrackerStatusEvent(self.torrent_id, self.tracker_status))
def merge_trackers(self, torrent_info):
"""Merges new trackers in torrent_info into torrent"""
log.info("Adding any new trackers to torrent (%s) already in session...", self.torrent_id)
if not torrent_info:
return
# Don't merge trackers if either torrent has private flag set.
if torrent_info.priv() or self.get_status(["private"])["private"]:
log.info("Adding trackers aborted: Torrent has private flag set.")
else:
for tracker in torrent_info.trackers():
self.handle.add_tracker({"url": tracker.url, "tier": tracker.tier})
# Update torrent.trackers from libtorrent handle.
self.set_trackers()
def update_state(self):
"""Updates the state, based on libtorrent's torrent state"""
status = self.handle.status()
session_paused = component.get("Core").session.is_paused()
old_state = self.state
self.set_status_message()
if self.forced_error:
self.state = "Error"
self.set_status_message(self.forced_error.error_message)
elif status.error:
self.state = "Error"
# auto-manage status will be reverted upon resuming.
self.handle.auto_managed(False)
self.set_status_message(decode_string(status.error))
elif self.moving_storage:
self.state = "Moving"
elif not session_paused and status.paused and status.auto_managed:
self.state = "Queued"
elif session_paused or status.paused:
self.state = "Paused"
else:
self.state = LT_TORRENT_STATE_MAP.get(str(status.state), str(status.state))
if self.state != old_state:
component.get("EventManager").emit(TorrentStateChangedEvent(self.torrent_id, self.state))
if log.isEnabledFor(logging.DEBUG):
log.debug("State from lt was: %s | Session is paused: %s\nTorrent state set from '%s' to '%s' (%s)",
"error" if status.error else status.state, session_paused, old_state, self.state, self.torrent_id)
if self.forced_error:
log.debug("Torrent Error state message: %s", self.forced_error.error_message)
def set_status_message(self, message=None):
"""Sets the torrent status message.
Calling method without a message will reset the message to 'OK'.
Args:
message (str, optional): The status message.
"""
if not message:
message = "OK"
self.statusmsg = message
def force_error_state(self, message, restart_to_resume=True):
"""Forces the torrent into an error state.
For setting an error state not covered by libtorrent.
Args:
message (str): The error status message.
restart_to_resume (bool, optional): Prevent resuming clearing the error, only restarting
session can resume.
"""
status = self.handle.status()
self.handle.auto_managed(False)
self.forced_error = TorrentError(message, status.paused, restart_to_resume)
if not status.paused:
self.handle.pause()
self.update_state()
def clear_forced_error_state(self, update_state=True):
if not self.forced_error:
return
if self.forced_error.restart_to_resume:
log.error("Restart deluge to clear this torrent error")
if not self.forced_error.was_paused and self.options["auto_managed"]:
self.handle.auto_managed(True)
self.forced_error = None
self.set_status_message("OK")
if update_state:
self.update_state()
def get_eta(self):
"""Get the ETA for this torrent.
Returns:
int: The ETA in seconds.
"""
status = self.status
eta = 0
if self.is_finished and self.options["stop_at_ratio"] and status.upload_payload_rate:
# We're a seed, so calculate the time to the 'stop_share_ratio'
eta = ((status.all_time_download * self.options["stop_ratio"]) -
status.all_time_upload) // status.upload_payload_rate
elif status.download_payload_rate:
left = status.total_wanted - status.total_wanted_done
if left > 0:
eta = left // status.download_payload_rate
return eta
def get_ratio(self):
"""Get the ratio of upload/download for this torrent.
Returns:
float: The ratio or -1.0 (for infinity).
"""
if self.status.total_done > 0:
return self.status.all_time_upload / self.status.total_done
else:
return -1.0
def get_files(self):
"""Get the files this torrent contains.
Returns:
list of dict: The files.
"""
if not self.has_metadata:
return []
files = self.torrent_info.files()
return convert_lt_files(files)
def get_orig_files(self):
"""Get the original filenames of files in this torrent.
Returns:
list of dict: The files with original filenames.
"""
if not self.has_metadata:
return []
files = self.torrent_info.orig_files()
return convert_lt_files(files)
def get_peers(self):
"""Get the peers for this torrent.
A list of peers and various information about them.
Returns:
list of dict: The peers.
The format for the peer dict::
{
"client": str,
"country": str,
"down_speed": int,
"ip": str,
"progress": float,
"seed": bool,
"up_speed": int
}
"""
ret = []
peers = self.handle.get_peer_info()
for peer in peers:
# We do not want to report peers that are half-connected
if peer.flags & peer.connecting or peer.flags & peer.handshake:
continue
client = decode_string(str(peer.client))
# Make country a proper string
country = str()
for char in peer.country:
if not char.isalpha():
country += " "
else:
country += char
ret.append({
"client": client,
"country": country,
"down_speed": peer.payload_down_speed,
"ip": "%s:%s" % (peer.ip[0], peer.ip[1]),
"progress": peer.progress,
"seed": peer.flags & peer.seed,
"up_speed": peer.payload_up_speed,
})
return ret
def get_queue_position(self):
"""Get the torrents queue position
Returns:
int: queue position
"""
return self.handle.queue_position()
def get_file_progress(self):
"""Calculates the file progress as a percentage.
Returns:
list of floats: The file progress (0.0 -> 1.0)
"""
if not self.has_metadata:
return 0.0
return [progress / _file.size if _file.size else 0.0 for progress, _file in
izip(self.handle.file_progress(), self.torrent_info.files())]
def get_tracker_host(self):
"""Get the hostname of the currently connected tracker.
If no tracker is connected, it uses the 1st tracker.
Returns:
str: The tracker host
"""
if self.tracker_host:
return self.tracker_host
tracker = self.status.current_tracker
if not tracker and self.trackers:
tracker = self.trackers[0]["url"]
if tracker:
url = urlparse(tracker.replace("udp://", "http://"))
if hasattr(url, "hostname"):
host = (url.hostname or "DHT")
# Check if hostname is an IP address and just return it if that's the case
try:
socket.inet_aton(host)
except socket.error:
pass
else:
# This is an IP address because an exception wasn't raised
return url.hostname
parts = host.split(".")
if len(parts) > 2:
if parts[-2] in ("co", "com", "net", "org") or parts[-1] == "uk":
host = ".".join(parts[-3:])
else:
host = ".".join(parts[-2:])
self.tracker_host = host
return host
return ""
def get_magnet_uri(self):
"""Returns a magnet uri for this torrent"""
return lt.make_magnet_uri(self.handle)
def get_name(self):
"""The name of the torrent (distinct from the filenames).
Note:
Can be manually set in options through `name` key. If the key is
reset to empty string "" it will return the original torrent name.
Returns:
str: the name of the torrent.
"""
if not self.options["name"]:
handle_name = self.handle.name()
if handle_name:
name = decode_string(handle_name)
else:
name = self.torrent_id
else:
name = self.options["name"]
return name
def get_progress(self):
"""The progress of this torrent's current task.
Returns:
float: The progress percentage (0 to 100).
"""
def get_size(files, path):
"""Returns total size of 'files' currently located in 'path'"""
files = [os.path.join(path, f) for f in files]
return sum(os.stat(f).st_size for f in files if os.path.exists(f))
if self.state == "Error":
progress = 100.0
elif self.moving_storage:
# Check if torrent has downloaded any data yet.
if self.status.total_done:
torrent_files = [f["path"] for f in self.get_files()]
dest_path_size = get_size(torrent_files, self.moving_storage_dest_path)
progress = dest_path_size / self.status.total_done * 100
else:
progress = 100.0
else:
progress = self.status.progress * 100
return progress
def get_status(self, keys, diff=False, update=False, all_keys=False):
"""Returns the status of the torrent based on the keys provided
Args:
keys (list of str): the keys to get the status on
diff (bool): Will return a diff of the changes since the last
call to get_status based on the session_id
update (bool): If True the status will be updated from libtorrent
if False, the cached values will be returned
Returns:
dict: a dictionary of the status keys and their values
"""
if update:
self.update_status(self.handle.status())
if all_keys:
keys = self.status_funcs.keys()
status_dict = {}
for key in keys:
status_dict[key] = self.status_funcs[key]()
if diff:
session_id = self.rpcserver.get_session_id()
if session_id in self.prev_status:
# We have a previous status dict, so lets make a diff
status_diff = {}
for key, value in status_dict.items():
if key in self.prev_status[session_id]:
if value != self.prev_status[session_id][key]:
status_diff[key] = value
else:
status_diff[key] = value
self.prev_status[session_id] = status_dict
return status_diff
self.prev_status[session_id] = status_dict
return status_dict
return status_dict
def update_status(self, status):
"""Updates the cached status.
Args:
status (libtorrent.torrent_status): a libtorrent torrent status
"""
self.status = status
def _create_status_funcs(self):
"""Creates the functions for getting torrent status"""
self.status_funcs = {
"active_time": lambda: self.status.active_time,
"all_time_download": lambda: self.status.all_time_download,
"storage_mode": lambda: self.status.storage_mode.name.split("_")[2], # sparse, allocate or compact
"distributed_copies": lambda: max(0.0, self.status.distributed_copies),
"download_payload_rate": lambda: self.status.download_payload_rate,
"file_priorities": lambda: self.options["file_priorities"],
"hash": lambda: self.torrent_id,
"is_auto_managed": lambda: self.options["auto_managed"],
"is_finished": lambda: self.is_finished,
"max_connections": lambda: self.options["max_connections"],
"max_download_speed": lambda: self.options["max_download_speed"],
"max_upload_slots": lambda: self.options["max_upload_slots"],
"max_upload_speed": lambda: self.options["max_upload_speed"],
"message": lambda: self.statusmsg,
"move_on_completed_path": lambda: self.options["move_completed_path"], # Depr, use move_completed_path
"move_on_completed": lambda: self.options["move_completed"], # Deprecated, use move_completed
"move_completed_path": lambda: self.options["move_completed_path"],
"move_completed": lambda: self.options["move_completed"],
"next_announce": lambda: self.status.next_announce.seconds,
"num_peers": lambda: self.status.num_peers - self.status.num_seeds,