summaryrefslogtreecommitdiff
path: root/rapid/downloadtracker.py
diff options
context:
space:
mode:
authorJulien Valroff <julien@kirya.net>2014-03-08 09:07:11 +0100
committerJulien Valroff <julien@kirya.net>2014-03-08 09:07:11 +0100
commit88da93d2f69f0a3dbf5b5f9bdaa11b3cb90ddb53 (patch)
treeb2d1a530df46001fb15cf7b9f07b9ac544838102 /rapid/downloadtracker.py
parentfe8148d00d6503bdc3d4b7856a1535131bee73b6 (diff)
parente57608218ea2d7fa960b20f2aedf78094eeb79a5 (diff)
Merge tag 'upstream/0.4.10'
Upstream version 0.4.10
Diffstat (limited to 'rapid/downloadtracker.py')
-rw-r--r--rapid/downloadtracker.py136
1 files changed, 68 insertions, 68 deletions
diff --git a/rapid/downloadtracker.py b/rapid/downloadtracker.py
index 5a9e452..e489903 100644
--- a/rapid/downloadtracker.py
+++ b/rapid/downloadtracker.py
@@ -1,7 +1,7 @@
#!/usr/bin/python
# -*- coding: latin1 -*-
-### Copyright (C) 2011-2012 Damon Lynch <damonlynch@gmail.com>
+### Copyright (C) 2011-2014 Damon Lynch <damonlynch@gmail.com>
### This program is free software; you can redistribute it and/or modify
### it under the terms of the GNU General Public License as published by
@@ -37,7 +37,7 @@ class DownloadTracker:
def __init__(self):
self.file_types_present_by_scan_pid = dict()
self._refresh_values()
-
+
def _refresh_values(self):
""" these values are reset when a download is completed"""
self.size_of_download_in_bytes_by_scan_pid = dict()
@@ -50,8 +50,8 @@ class DownloadTracker:
self.no_files_in_download_by_scan_pid = dict()
self.no_photos_in_download_by_scan_pid = dict()
self.no_videos_in_download_by_scan_pid = dict()
-
-
+
+
# 'Download count' tracks the index of the file being downloaded
# into the list of files that need to be downloaded -- much like
# a counter in a for loop, e.g. 'for i in list', where i is the counter
@@ -72,19 +72,19 @@ class DownloadTracker:
self.total_bytes_to_download = 0
self.backups_performed_by_unique_id = dict()
self.auto_delete = dict()
-
+
def set_no_backup_devices(self, no_photo_backup_devices, no_video_backup_devices):
self.no_photo_backup_devices = no_photo_backup_devices
self.no_video_backup_devices = no_video_backup_devices
- self.no_backup_devices = no_photo_backup_devices + no_video_backup_devices
-
- def get_no_backup_devices(self):
- """
- Returns how many devices are being used to backup files of each type
- Return value is an integer tuple: photo and video
- """
- return (self.no_photo_backup_devices, self.no_video_backup_devices)
-
+ #~ self.no_backup_devices = no_photo_backup_devices + no_video_backup_devices
+#~
+ #~ def get_no_backup_devices(self):
+ #~ """
+ #~ Returns how many devices are being used to backup files of each type
+ #~ Return value is an integer tuple: photo and video
+ #~ """
+ #~ return (self.no_photo_backup_devices, self.no_video_backup_devices)
+
def init_stats(self, scan_pid, photo_size_in_bytes, video_size_in_bytes, no_photos_to_download, no_videos_to_download):
no_files = no_photos_to_download + no_videos_to_download
self.no_files_in_download_by_scan_pid[scan_pid] = no_files
@@ -95,7 +95,7 @@ class DownloadTracker:
bytes = photo_size_in_bytes + video_size_in_bytes
# rename_chunk is used to account for the time it takes to rename a file
# it is arbitrarily set to 10% of the time it takes to copy it
- # this makes a difference to the user when they're downloading from a
+ # this makes a difference to the user when they're downloading from a
# a high speed source
self.rename_chunk[scan_pid] = bytes / 10 / no_files
self.size_of_download_in_bytes_by_scan_pid[scan_pid] = bytes + self.rename_chunk[scan_pid] * no_files
@@ -108,34 +108,34 @@ class DownloadTracker:
self.video_failures[scan_pid] = 0
self.warnings[scan_pid] = 0
self.total_bytes_backed_up_by_scan_pid[scan_pid] = 0
-
+
def get_no_files_in_download(self, scan_pid):
return self.no_files_in_download_by_scan_pid[scan_pid]
-
+
def get_no_files_downloaded(self, scan_pid, file_type):
if file_type == FILE_TYPE_PHOTO:
return self.photos_downloaded.get(scan_pid, 0)
else:
return self.videos_downloaded.get(scan_pid, 0)
-
+
def get_no_files_failed(self, scan_pid, file_type):
if file_type == FILE_TYPE_PHOTO:
return self.photo_failures.get(scan_pid, 0)
else:
return self.video_failures.get(scan_pid, 0)
-
+
def get_no_warnings(self, scan_pid):
return self.warnings.get(scan_pid, 0)
-
+
def add_to_auto_delete(self, rpd_file):
if rpd_file.scan_pid in self.auto_delete:
self.auto_delete[rpd_file.scan_pid].append(rpd_file.full_file_name)
else:
self.auto_delete[rpd_file.scan_pid] = [rpd_file.full_file_name,]
-
+
def get_files_to_auto_delete(self, scan_pid):
return self.auto_delete[scan_pid]
-
+
def clear_auto_delete(self, scan_pid):
if scan_pid in self.auto_delete:
del self.auto_delete[scan_pid]
@@ -143,7 +143,7 @@ class DownloadTracker:
def file_backed_up(self, unique_id):
self.backups_performed_by_unique_id[unique_id] = \
self.backups_performed_by_unique_id.get(unique_id, 0) + 1
-
+
def all_files_backed_up(self, unique_id, file_type):
if unique_id in self.backups_performed_by_unique_id:
if file_type == FILE_TYPE_PHOTO:
@@ -154,10 +154,10 @@ class DownloadTracker:
logger.critical("Unexpected unique_id in self.backups_performed_by_unique_id")
return True
-
+
def file_downloaded_increment(self, scan_pid, file_type, status):
self.files_downloaded[scan_pid] += 1
-
+
if status <> STATUS_DOWNLOAD_FAILED and status <> STATUS_DOWNLOAD_AND_BACKUP_FAILED:
if file_type == FILE_TYPE_PHOTO:
self.photos_downloaded[scan_pid] += 1
@@ -165,7 +165,7 @@ class DownloadTracker:
else:
self.videos_downloaded[scan_pid] += 1
self.total_videos_downloaded += 1
-
+
if status == STATUS_DOWNLOADED_WITH_WARNING or status == STATUS_BACKUP_PROBLEM:
self.warnings[scan_pid] += 1
self.total_warnings += 1
@@ -176,66 +176,66 @@ class DownloadTracker:
else:
self.video_failures[scan_pid] += 1
self.total_video_failures += 1
-
+
def get_percent_complete(self, scan_pid):
"""
Returns a float representing how much of the download
- has been completed
+ has been completed
"""
-
- # when calculating the percentage, there are three components:
+
+ # when calculating the percentage, there are three components:
# copy (download), rename ('rename_chunk'), and backup
percent_complete = (((float(
- self.total_bytes_copied_by_scan_pid[scan_pid])
+ self.total_bytes_copied_by_scan_pid[scan_pid])
+ self.rename_chunk[scan_pid] * self.files_downloaded[scan_pid])
+ self.total_bytes_backed_up_by_scan_pid[scan_pid])
- / (self.size_of_download_in_bytes_by_scan_pid[scan_pid] +
+ / (self.size_of_download_in_bytes_by_scan_pid[scan_pid] +
self.size_of_photo_backup_in_bytes_by_scan_pid[scan_pid] +
self.size_of_video_backup_in_bytes_by_scan_pid[scan_pid]
)) * 100
-
+
return percent_complete
-
+
def get_overall_percent_complete(self):
total = 0
for scan_pid in self.total_bytes_copied_by_scan_pid:
total += (self.total_bytes_copied_by_scan_pid[scan_pid] +
- (self.rename_chunk[scan_pid] *
+ (self.rename_chunk[scan_pid] *
self.files_downloaded[scan_pid]))
-
+
percent_complete = float(total) / self.total_bytes_to_download
return percent_complete
-
+
def set_total_bytes_copied(self, scan_pid, total_bytes):
self.total_bytes_copied_by_scan_pid[scan_pid] = total_bytes
-
+
def increment_bytes_backed_up(self, scan_pid, chunk_downloaded):
self.total_bytes_backed_up_by_scan_pid[scan_pid] += chunk_downloaded
-
+
def set_download_count_for_file(self, unique_id, download_count):
self.download_count_for_file_by_unique_id[unique_id] = download_count
-
+
def get_download_count_for_file(self, unique_id):
return self.download_count_for_file_by_unique_id[unique_id]
-
+
def set_download_count(self, scan_pid, download_count):
self.download_count_by_scan_pid[scan_pid] = download_count
-
+
def get_file_types_present(self, scan_pid):
return self.file_types_present_by_scan_pid[scan_pid]
-
+
def set_file_types_present(self, scan_pid, file_types_present):
self.file_types_present_by_scan_pid[scan_pid] = file_types_present
-
+
def no_errors_or_warnings(self):
"""
Return True if there were no errors or warnings in the download
else return False
"""
return (self.total_warnings == 0 and
- self.total_photo_failures == 0 and
+ self.total_photo_failures == 0 and
self.total_video_failures == 0)
-
+
def purge(self, scan_pid):
del self.no_files_in_download_by_scan_pid[scan_pid]
del self.size_of_download_in_bytes_by_scan_pid[scan_pid]
@@ -246,7 +246,7 @@ class DownloadTracker:
del self.photo_failures[scan_pid]
del self.video_failures[scan_pid]
del self.warnings[scan_pid]
-
+
def purge_all(self):
self._refresh_values()
@@ -255,42 +255,42 @@ class DownloadTracker:
class TimeCheck:
"""
Record times downloads commmence and pause - used in calculating time
- remaining.
-
+ remaining.
+
Also tracks and reports download speed.
-
+
Note: This is completely independent of the file / subfolder naming
preference "download start time"
"""
-
+
def __init__(self):
- # set the number of seconds gap with which to measure download time remaing
+ # set the number of seconds gap with which to measure download time remaing
self.download_time_gap = 3
-
+
self.reset()
-
+
def reset(self):
self.mark_set = False
self.total_downloaded_so_far = 0
self.total_download_size = 0
self.size_mark = 0
-
+
def increment(self, bytes_downloaded):
self.total_downloaded_so_far += bytes_downloaded
-
+
def set_download_mark(self):
if not self.mark_set:
self.mark_set = True
- self.time_mark = time.time()
-
+ self.time_mark = time.time()
+
def pause(self):
self.mark_set = False
def check_for_update(self):
now = time.time()
update = now > (self.download_time_gap + self.time_mark)
-
+
if update:
amt_time = now - self.time_mark
self.time_mark = now
@@ -299,9 +299,9 @@ class TimeCheck:
download_speed = "%1.1f" % (amt_downloaded / 1048576 / amt_time) +_("MB/s")
else:
download_speed = None
-
+
return (update, download_speed)
-
+
class TimeForDownload:
# used to store variables, see below
pass
@@ -313,7 +313,7 @@ class TimeRemaining:
gap = 3
def __init__(self):
self.clear()
-
+
def set(self, scan_pid, size):
t = TimeForDownload()
t.time_remaining = None
@@ -322,7 +322,7 @@ class TimeRemaining:
t.size_mark = 0
t.time_mark = time.time()
self.times[scan_pid] = t
-
+
def update(self, scan_pid, bytes_downloaded):
if scan_pid in self.times:
self.times[scan_pid].downloaded += bytes_downloaded
@@ -337,21 +337,21 @@ class TimeRemaining:
amt_to_download = float(self.times[scan_pid].size) - self.times[scan_pid].downloaded
if timefraction:
self.times[scan_pid].time_remaining = amt_to_download / timefraction
-
+
def _time_estimates(self):
for t in self.times:
yield self.times[t].time_remaining
-
+
def time_remaining(self):
return max(self._time_estimates())
def set_time_mark(self, scan_pid):
if scan_pid in self.times:
self.times[scan_pid].time_mark = time.time()
-
+
def clear(self):
- self.times = {}
-
+ self.times = {}
+
def remove(self, scan_pid):
if scan_pid in self.times:
del self.times[scan_pid]