/usr/lib/python3/dist-packages/raphodo/devices.py is in rapid-photo-downloader 0.9.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 | # Copyright (C) 2015-2017 Damon Lynch <damonlynch@gmail.com>
# This file is part of Rapid Photo Downloader.
#
# Rapid Photo Downloader is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Rapid Photo Downloader is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Rapid Photo Downloader. If not,
# see <http://www.gnu.org/licenses/>.
"""
Handle Devices and Device Collections.
In Rapid Photo Downloader, "Device" has two meanings, depending on the
context:
1. In the GUI, a Device is a camera or a volume (external drive)
2. In code, a Device is one of a camera, volume, or path
"""
__author__ = 'Damon Lynch'
__copyright__ = "Copyright 2015-2017, Damon Lynch"
import sys
import shutil
import os
import logging
import itertools
from collections import namedtuple, Counter, defaultdict
from typing import Tuple, List, Optional, Set, Dict, Union, DefaultDict
from gettext import gettext as _
from PyQt5.QtCore import QStorageInfo, QSize
from PyQt5.QtWidgets import QFileIconProvider
from PyQt5.QtGui import QIcon, QPixmap
import raphodo.qrc_resources as qrc_resources
from raphodo.constants import (
DeviceType, BackupLocationType, FileType, DeviceState, DownloadStatus, ExifSource,
DownloadingFileTypes, BackupFailureType
)
from raphodo.rpdfile import FileTypeCounter, FileSizeSum
from raphodo.storage import (
StorageSpace, udev_attributes, UdevAttr, get_path_display_name, validate_download_folder,
ValidatedFolder, CameraDetails, get_uri, fs_device_details
)
from raphodo.camera import generate_devname
from raphodo.utilities import (
number, make_internationalized_list, stdchannel_redirected, same_device
)
import raphodo.metadataphoto as metadataphoto
from raphodo.rpdfile import Photo, Video
import raphodo.exiftool as exiftool
from raphodo.problemnotification import FsMetadataWriteProblem
display_devices = (DeviceType.volume, DeviceType.camera)
class Device:
r"""
Representation of a camera, or a device, or a path.
Files will be downloaded from it.
To run the doctests, ensure at least one camera is plugged in
but not mounted!
>>> d = Device()
>>> d.set_download_from_volume('/media/damon/EOS_DIGITAL', 'EOS_DIGITAL')
>>> d
'EOS_DIGITAL':'/media/damon/EOS_DIGITAL'
>>> str(d)
'/media/damon/EOS_DIGITAL (EOS_DIGITAL)'
>>> d.display_name
'EOS_DIGITAL'
>>> d.camera_model
>>> d.camera_port
>>> import gphoto2 as gp
>>> gp_context = gp.Context()
>>> cameras = gp_context.camera_autodetect()
>>> c = Device()
>>> for model, port in cameras:
... c.set_download_from_camera(model, port)
... isinstance(c.display_name, str)
True
>>> e = Device()
>>> e.set_download_from_volume('/media/damon/EOS_DIGITAL', 'EOS_DIGITAL')
>>> e == d
True
>>> e != c
True
>>> c == d
False
>>> c != d
True
"""
def __init__(self):
self.clear()
def clear(self):
self.camera_model = None # type: str
self.camera_port = None # type: str
# Assume an MTP device is likely a smart phone or tablet
self.is_mtp_device = False
self.udev_name = None # type: str
self.storage_space = [] # type: List[StorageSpace]
# Name of storage on a camera
self.storage_descriptions = [] # type: List[str]
self.path = None # type: str
self.display_name = None # type: str
self.have_optimal_display_name = False
self.device_type = None # type: DeviceType
self.icon_name = None # type: str
self.can_eject = None # type: bool
self.photo_cache_dir = None # type: str
self.video_cache_dir = None # type: str
self.file_size_sum = FileSizeSum()
self.file_type_counter = FileTypeCounter()
self.download_statuses = set() # type: Set[DownloadStatus]
self._uri = ''
# If the entire video is required to extract metadata
# (which affects thumbnail generation too).
# Set only if downloading from a camera / phone.
self.entire_video_required = None # type: bool
def __repr__(self):
if self.device_type == DeviceType.camera:
return "%r:%r" % (self.camera_model, self.camera_port)
elif self.device_type == DeviceType.volume:
return "%r:%r" % (self.display_name, self.path)
else:
return "%r" % self.path
def __str__(self):
if self.device_type == DeviceType.camera:
return '{} on port {}. Udev: {}; Display name: {} (optimal: {}); MTP: {}'.format(
self.camera_model, self.camera_port, self.udev_name,
self.display_name, self.have_optimal_display_name, self.is_mtp_device)
elif self.device_type == DeviceType.volume:
if self.path != self.display_name:
return "%s (%s)" % (self.path, self.display_name)
else:
return "%s" % (self.path)
else:
return "%s" % (self.path)
def __eq__(self, other):
for attr in ('device_type', 'camera_model', 'camera_port', 'path'):
if getattr(self, attr) != getattr(other, attr):
return False
return True
def __hash__(self):
return hash((self.device_type, self.camera_model, self.camera_port, self.path))
def __ne__(self, other):
return not self.__eq__(other)
def _get_valid_icon_name(self, possible_names):
if possible_names is not None:
for icon_name in possible_names:
if QIcon.hasThemeIcon(icon_name):
return icon_name
return None
@property
def uri(self) -> str:
if self._uri:
return self._uri
if self.device_type == DeviceType.camera:
if self.storage_descriptions:
storage_desc = self.storage_descriptions[0]
else:
storage_desc = ''
camera_details = CameraDetails(
model=self.camera_model, port=self.camera_port, display_name=self.display_name,
is_mtp=self.is_mtp_device, storage_desc=storage_desc
)
self._uri = get_uri(camera_details=camera_details)
else:
self._uri = get_uri(path=self.path)
return self._uri
def set_download_from_camera(self, camera_model: str, camera_port: str) -> None:
self.clear()
self.device_type = DeviceType.camera
self.camera_model = camera_model
# Set default display name, for when all else fails.
# Try to override this value below
self.display_name = camera_model
self.camera_port = camera_port
self.icon_name = self._get_valid_icon_name(('camera-photo', 'camera'))
# Assign default udev name if cannot determine from udev itself
self.udev_name = camera_model
devname = generate_devname(camera_port)
if devname is not None:
udev_attr = udev_attributes(devname)
if udev_attr is not None:
self.is_mtp_device = udev_attr.is_mtp_device
self.udev_name = udev_attr.model
self.display_name = udev_attr.model
else:
logging.error("Could not determine udev values for %s %s",
self.camera_model, camera_port)
def update_camera_attributes(self, display_name: str,
storage_space: List[StorageSpace],
storage_descriptions: List[str]) -> None:
self.display_name = display_name
self.have_optimal_display_name = True
self.storage_space = storage_space
self.storage_descriptions = storage_descriptions
def set_download_from_volume(self, path: str, display_name: str,
icon_names=None, can_eject=None,
mount: QStorageInfo=None) -> None:
self.clear()
self.device_type = DeviceType.volume
self.path = path
self.icon_name = self._get_valid_icon_name(icon_names)
if not display_name.find(os.sep) >= 0:
self.display_name = display_name
else:
self.display_name = os.path.basename(display_name)
self.have_optimal_display_name = True
self.can_eject = can_eject
if not mount:
mount = QStorageInfo(path)
self.storage_space.append(StorageSpace(
bytes_free=mount.bytesAvailable(),
bytes_total=mount.bytesTotal(),
path=path))
def set_download_from_path(self, path: str) -> None:
self.clear()
self.device_type = DeviceType.path
self.path = path
if path.endswith(os.sep):
path = path[:-1]
display_name = os.path.basename(path)
if display_name:
self.display_name = display_name
self.have_optimal_display_name = True
else:
self.display_name = path
# the next value is almost certainly ("folder",), but I guess it's
# better to generate it from code
self.icon_name = ('{}'.format(QFileIconProvider().icon(
QFileIconProvider.Folder).name()))
mount = QStorageInfo(path)
self.storage_space.append(StorageSpace(
bytes_free=mount.bytesAvailable(),
bytes_total=mount.bytesTotal(),
path=path))
def get_storage_space(self, index: int=0) -> StorageSpace:
"""
Convenience function to retrieve information about bytes
free and bytes total (capacity of the media). Almost all
devices have only one storage media, but some cameras have
more than one
:param index: the storage media to get the values from
:return: tuple of bytes free and bytes total
"""
return self.storage_space[index]
def name(self) -> str:
"""
Get the name of the device, suitable to be displayed to the
user. If the device is a path, return the path name
:return str containg the name
"""
if self.device_type == DeviceType.camera:
return self.display_name
elif self.device_type == DeviceType.volume:
return self.display_name
else:
return self.path
def get_icon(self) -> QIcon:
"""Return icon for the device."""
if self.device_type == DeviceType.volume:
return QIcon(':icons/drive-removable-media.svg')
elif self.device_type == DeviceType.path:
return QIcon(':/icons/folder.svg')
else:
assert self.device_type == DeviceType.camera
if self.is_mtp_device:
if self.camera_model.lower().find('tablet') >= 0:
#TODO use tablet icon
pass
return QIcon(':icons/smartphone.svg')
return QIcon(':/icons/camera.svg')
def get_pixmap(self, size: QSize=QSize(30, 30)) -> QPixmap:
icon = self.get_icon()
return icon.pixmap(size)
def _delete_cache_dir(self, cache_dir) -> None:
if cache_dir:
if os.path.isdir(cache_dir):
assert cache_dir != os.path.expanduser('~')
try:
shutil.rmtree(cache_dir, ignore_errors=True)
except:
logging.error("Unknown error deleting cache directory %s", cache_dir)
def delete_cache_dirs(self) -> None:
self._delete_cache_dir(self.photo_cache_dir)
self._delete_cache_dir(self.video_cache_dir)
class DeviceCollection:
"""
Maintain collection of devices that are being scanned, where a
device is of type Device.
When a device is added, a scan_id is generated and returned.
>>> d = Device()
>>> d.set_download_from_volume('/media/damon/EOS_DIGITAL', 'EOS_DIGITAL')
>>> c = Device()
>>> c.set_download_from_camera('Canon EOS 1D X', 'usb:001,002')
>>> e = Device()
>>> e.set_download_from_volume('/media/damon/EOS_DIGITAL', 'EOS_DIGITAL')
>>> dc = DeviceCollection()
>>> d_scan_id = dc.add_device(d)
>>> d_scan_id
0
>>> d_scan_id in dc
True
>>> dc.known_path(d.path, DeviceType.volume)
True
>>> dc.known_path(d.path)
True
>>> dc[d_scan_id] == d
True
>>> len(dc.volumes_and_cameras)
1
>>> len(dc.this_computer)
0
>>> dc.known_path('/root', DeviceType.path)
False
>>> dc.known_path('/root')
False
>>> c_scan_id = dc.add_device(c)
>>> c_scan_id
1
>>> len(dc)
2
>>> len(dc.volumes_and_cameras)
2
>>> len(dc.this_computer)
0
>>> dc[d_scan_id] == dc[c_scan_id]
False
>>> dc.known_camera('Canon EOS 1D X', 'usb:001,002')
True
>>> dc.known_camera('Canon EOS 1D X', 'usb:001,003')
False
>>> dc.delete_device(c)
True
>>> len(dc.cameras)
0
>>> len(dc.volumes_and_cameras)
1
>>> len(dc.this_computer)
0
>>> dc.known_camera('Canon EOS 1D X', 'usb:001,002')
False
>>> len(dc)
1
>>> dc.known_device(e)
True
>>> del dc[d_scan_id]
>>> len(dc)
0
>>> len(dc.volumes_and_cameras)
0
>>> len(dc.this_computer)
0
>>> dc.delete_device(e)
False
"""
def __init__(self, exiftool_process: Optional[exiftool.ExifTool]=None,
rapidApp=None) -> None:
self.rapidApp = rapidApp
self.devices = {} # type: Dict[int, Device]
# port: model
self.cameras = {} # type: Dict[str, str]
# Used to assign scan ids
self.scan_counter = 0 # type: int
# scan_id: DeviceState
self.device_state = {} # type: Dict[int, DeviceState]
# Track which devices are being scanned, by scan_id
self.scanning = set() # type: Set[int]
# Track which downloads are running, by scan_id
self.downloading = set() # type: Set[int]
# Track which devices have been downloaded from during one
# download, by display name. Must do it by display name
# because some devices could be removed before all devices
# have been downloaded from.
self.have_downloaded_from = set() # type: Set[str]
# Track which devices are thumbnailing, by scan_id
self.thumbnailing = set() # type: Set[int]
# Track the unmounting of unscanned cameras by port and model
# port: model
self.cameras_to_gvfs_unmount_for_scan = {} # type: Dict[str, str]
# Which scanned cameras need to be unmounted for a download to start, by scan_id
self.cameras_to_gvfs_unmount_for_download = set() # type: Set[int]
self.cameras_to_stop_thumbnailing = set()
# Automatically detected devices where the user has explicitly said to ignore it
# port: model
self.ignored_cameras = {} # type: Dict[str, str]
# List[path]
self.ignored_volumes = [] # type: List[str]
# Devices that were set to autodownload while the program
# is in a paused state
self.queued_to_download = set() # type: Set[int]
self.volumes_and_cameras = set() # type: Set[int]
self.this_computer = set() # type: Set[int]
# List of devices that were detected at program startup
# scan_id
self.startup_devices = [] # type: List[int]
# Sample exif bytes of photo on most recent device scanned
self._sample_photo = None # type: Optional[Photo]
self._sample_video = None # type: Optional[Video]
self._sample_videos_complete_files = [] # type: List[str]
self.exiftool_process = exiftool_process
self._map_set = {DeviceType.path: self.this_computer,
DeviceType.camera: self.volumes_and_cameras,
DeviceType.volume: self.volumes_and_cameras}
self._map_plural_types = {DeviceType.camera: _('Cameras'),
DeviceType.volume: _('Devices')}
def download_start_blocked(self) -> bool:
"""
Determine if a camera needs to be unmounted or thumbnailing needs to be
terminated for a camera in order for a download to proceed
:return: True if so, else False
"""
if len(self.cameras_to_gvfs_unmount_for_download) > 0 and len(
self.cameras_to_stop_thumbnailing):
logging.debug("Download is blocked because %s camera(s) are being unmounted from GVFS "
"and %s camera(s) are having their thumbnailing terminated",
len(self.cameras_to_gvfs_unmount_for_download),
len(self.cameras_to_stop_thumbnailing))
elif len(self.cameras_to_gvfs_unmount_for_download) > 0:
logging.debug("Download is blocked because %s camera(s) are being unmounted from GVFS",
len(self.cameras_to_gvfs_unmount_for_download))
elif len(self.cameras_to_stop_thumbnailing) > 0:
logging.debug("Download is blocked because %s camera(s) are having their thumbnailing "
"terminated", len(self.cameras_to_stop_thumbnailing))
return len(self.cameras_to_gvfs_unmount_for_download) > 0 or len(
self.cameras_to_stop_thumbnailing) > 0
def logState(self) -> None:
logging.debug("-- Device Collection --")
logging.debug('%s devices: %s volumes/cameras (%s cameras), %s this computer',
len(self.devices), len(self.volumes_and_cameras), len(self.cameras),
len(self.this_computer))
logging.debug("Device states: %s", ', '.join(
'%s: %s' % (self[scan_id].display_name, self.device_state[scan_id].name)
for scan_id in self.device_state))
if len(self.scanning):
scanning = ('%s' % ', '.join(self[scan_id].display_name for scan_id in self.scanning))
logging.debug("Scanning: %s", scanning)
else:
logging.debug("No devices scanning")
if len(self.downloading):
downloading = ('%s' % ', '.join(self[scan_id].display_name
for scan_id in self.downloading))
logging.debug("Downloading: %s", downloading)
else:
logging.debug("No devices downloading")
if len(self.thumbnailing):
thumbnailing = ('%s' % ', '.join(self[scan_id].display_name
for scan_id in self.thumbnailing))
logging.debug("Thumbnailing: %s", thumbnailing)
else:
logging.debug("No devices thumbnailing")
def add_device(self, device: Device, on_startup: bool=False) -> int:
"""
Add a new device to the device collection
:param device: device to add
:param on_startup: if True, the device is being added during
the program's startup phase
:return: the scan id assigned to the device
"""
scan_id = self.scan_counter
self.scan_counter += 1
self.devices[scan_id] = device
self.device_state[scan_id] = DeviceState.pre_scan
if on_startup:
self.startup_devices.append(scan_id)
if device.camera_port:
port = device.camera_port
assert port not in self.cameras
self.cameras[port] = device.camera_model
if device.device_type in display_devices:
self.volumes_and_cameras.add(scan_id)
else:
self.this_computer.add(scan_id)
return scan_id
def set_device_state(self, scan_id: int, state: DeviceState) -> None:
logging.debug("Setting device state for %s to %s",
self.devices[scan_id].display_name, state.name)
self.device_state[scan_id] = state
if state == DeviceState.scanning:
self.scanning.add(scan_id)
elif state == DeviceState.downloading:
self.downloading.add(scan_id)
self.have_downloaded_from.add(self.devices[scan_id].display_name)
elif state == DeviceState.thumbnailing:
self.thumbnailing.add(scan_id)
if state != DeviceState.scanning and scan_id in self.scanning:
self.scanning.remove(scan_id)
if state != DeviceState.downloading and scan_id in self.downloading:
self.downloading.remove(scan_id)
if state != DeviceState.thumbnailing and scan_id in self.thumbnailing:
self.thumbnailing.remove(scan_id)
def ignore_device(self, scan_id: int) -> None:
"""
For the remainder of this program's instantiation, don't
automatically detect this device.
A limitation of this is that when a camera is physically removed
and plugged in again, it gets a new port. In which casae it's a
"different" device.
:param scan_id: scan id of the device to ignore
"""
device = self.devices[scan_id]
if device.device_type == DeviceType.camera:
logging.debug("Marking camera %s on port %s as explicitly removed. Will ignore it "
"until program exit.", device.camera_model, device.camera_port)
self.ignored_cameras[device.camera_port] = device.camera_model
elif device.device_type == DeviceType.volume:
logging.debug("Marking volume %s as explicitly removed. Will ignore it "
"until program exit.", device.path)
self.ignored_volumes.append(device.path)
else:
logging.error("Device collection unexpectedly received path to ignore: ignoring")
def user_marked_camera_as_ignored(self, model: str, port: str) -> bool:
"""
Check if camera is in set of devices to ignore because they were explicitly
removed by the user
:param model: camera model
:param port: camera port
:return: return True if camera is in set of devices to ignore
"""
if port in self.ignored_cameras:
return self.ignored_cameras[port] == model
return False
def user_marked_volume_as_ignored(self, path: str) -> bool:
"""
Check if volume's path is in list of devices to ignore because they were explicitly
removed by the user
:param: path: the device's path
:return: return True if camera is in set of devices to ignore
"""
return path in self.ignored_volumes
def known_camera(self, model: str, port: str) -> bool:
"""
Check if the camera is already in the list of devices
:param model: camera model as specified by libgohoto2
:param port: camera port as specified by libgohoto2
:return: True if this camera is already being processed, else False
"""
if port in self.cameras:
assert self.cameras[port] == model
return True
return False
def known_path(self, path: str, device_type: Optional[DeviceType]=None) -> bool:
"""
Check if the path is already in the list of devices
:param path: path to check
:return: True if the path is already being processed, else False
"""
for scan_id in self.devices:
device = self.devices[scan_id] # type: Device
if device.path == path:
if device_type is None or device.device_type == device_type:
return True
return False
def known_device(self, device: Device) -> bool:
return device in list(self.devices.values())
def scan_id_from_path(self, path: str, device_type: Optional[DeviceType]=None) -> Optional[int]:
for scan_id, device in self.devices.items():
if device.path == path:
if device_type is None or device.device_type == device_type:
return scan_id
return None
def scan_id_from_camera_model_port(self, model: str, port: str) -> Optional[int]:
"""
:param model: model name of camera being searched for
:param port: port of camera being searched for
:return: scan id of camera if known, else None
"""
for scan_id, device in self.devices.items():
if (device.device_type == DeviceType.camera and device.camera_model == model and
device.camera_port == port):
return scan_id
return None
def delete_device(self, device: Device) -> bool:
"""
Delete the device from the collection.
:param device: the device to delete
:return: True if device was deleted, else return False
"""
for scan_id in self.devices:
if self.devices[scan_id] == device:
del self[scan_id]
return True
return False
def delete_cache_dirs_and_sample_video(self) -> None:
"""
Delete all Download Caches and their contents any devices might
have, as well as any sample video.
"""
for device in self.devices.values():
device.delete_cache_dirs()
self._delete_sample_video(at_program_close=True)
def _delete_sample_video(self, at_program_close: bool) -> None:
"""
Delete sample video that is used for metadata extraction
to provide example for file renaming.
Does not delete
:param at_program_close: if True, the program is exiting
"""
if (self._sample_video is not None and
self._sample_video.temp_sample_full_file_name is not None and
self._sample_video.from_camera):
try:
assert self._sample_video.temp_sample_full_file_name
except:
logging.error("Expected sample file name in sample video")
else:
if os.path.isfile(self._sample_video.temp_sample_full_file_name):
logging.info("Removing temporary sample video %s",
self._sample_video.temp_sample_full_file_name)
try:
os.remove(self._sample_video.temp_sample_full_file_name)
except Exception:
logging.exception("Error removing temporary sample video file %s",
self._sample_video.temp_sample_full_file_name)
if at_program_close and self._sample_videos_complete_files:
remaining_videos = (video for video in self._sample_videos_complete_files
if os.path.isfile(video))
for video in remaining_videos:
logging.info("Removing temporary sample video %s", video)
try:
os.remove(video)
except Exception:
logging.exception("Error removing temporary sample video file %s", video)
def map_set(self, device: Device) -> Set:
return self._map_set[device.device_type]
def downloading_from(self) -> str:
"""
:return: string showing which devices are being downloaded from
"""
display_names = [self.devices[scan_id].display_name for scan_id in self.downloading]
return _('Downloading from %(device_names)s') % dict(
device_names=make_internationalized_list(display_names))
def reset_and_return_have_downloaded_from(self) -> str:
"""
Reset the set of devices that have been downloaded from,
and return the string that
:return: string showing which devices have been downloaded from
during this download
"""
display_names = make_internationalized_list(list(self.have_downloaded_from))
self.have_downloaded_from = set() # type: Set[str]
return display_names
def __delitem__(self, scan_id: int):
d = self.devices[scan_id] # type: Device
if d.device_type == DeviceType.camera:
del self.cameras[d.camera_port]
if d.camera_port in self.cameras_to_gvfs_unmount_for_scan:
del self.cameras_to_gvfs_unmount_for_scan[d.camera_port]
self.map_set(d).remove(scan_id)
d.delete_cache_dirs()
del self.devices[scan_id]
if scan_id in self.scanning:
self.scanning.remove(scan_id)
if scan_id in self.downloading:
self.downloading.remove(scan_id)
if scan_id in self.queued_to_download:
self.queued_to_download.remove(scan_id)
if scan_id in self.thumbnailing:
self.thumbnailing.remove(scan_id)
if scan_id in self.cameras_to_gvfs_unmount_for_download:
self.cameras_to_gvfs_unmount_for_download.remove(scan_id)
if scan_id in self.cameras_to_stop_thumbnailing:
self.cameras_to_stop_thumbnailing.remove(scan_id)
if scan_id in self.this_computer:
self.this_computer.remove(scan_id)
if scan_id in self.volumes_and_cameras:
self.volumes_and_cameras.remove(scan_id)
del self.device_state[scan_id]
def __getitem__(self, scan_id: int) -> Device:
return self.devices[scan_id]
def __len__(self) -> int:
return len(self.devices)
def __contains__(self, scan_id: int) -> bool:
return scan_id in self.devices
def __iter__(self):
return iter(self.devices)
def _mixed_devices(self, device_type_text: str) -> str:
try:
text_number = number(len(self.volumes_and_cameras)).number.capitalize()
except KeyError:
text_number = len(self.volumes_and_cameras)
# Translators: e.g. Three Devices
return _('%(no_devices)s %(device_type)s') % dict(
no_devices=text_number, device_type=device_type_text)
def _update_sample_file(self, file_type: FileType) -> None:
if file_type == FileType.photo:
assert self._sample_photo.file_type == FileType.photo
full_file_name = self._sample_photo.full_file_name
rpd_file = self._sample_photo
else:
assert self._sample_video.file_type == FileType.video
full_file_name = self._sample_video_full_file_name()
rpd_file = self._sample_video
if not os.path.isfile(full_file_name):
# file no longer exists - it may have been downloaded or deleted
# attempt to find an appropriate file from the in memory sql database of displayed
# files
scan_id = rpd_file.scan_id
if not scan_id in self.devices:
logging.debug('Failed to set a new sample because the device no longer exists')
return
rpd_file = self.rapidApp.thumbnailModel.getSampleFile(scan_id=scan_id,
device_type=self[scan_id].device_type, file_type=file_type)
if rpd_file is None:
logging.debug('Failed to set new sample %s because suitable sample does not'
'exist', file_type.name)
else:
sample_full_file_name = rpd_file.get_current_full_file_name()
if file_type == FileType.photo:
logging.debug('Updated sample photo with %s', sample_full_file_name)
self.sample_photo = rpd_file
else:
logging.debug('Updated sample video with %s', sample_full_file_name)
self.sample_video = rpd_file
@property
def sample_photo(self) -> Optional[Photo]:
if self._sample_photo is None:
return None
# does the photo still exist?
if self._sample_photo.exif_source == ExifSource.actual_file:
self._update_sample_file(file_type=FileType.photo)
if self._sample_photo.metadata is None and not self._sample_photo.metadata_failure:
with stdchannel_redirected(sys.stderr, os.devnull):
if self._sample_photo.exif_source == ExifSource.raw_bytes:
self._sample_photo.load_metadata(
raw_bytes=bytearray(self._sample_photo.raw_exif_bytes))
elif self._sample_photo.exif_source == ExifSource.app1_segment:
self._sample_photo.load_metadata(
app1_segment=bytearray(self._sample_photo.raw_exif_bytes))
else:
assert self._sample_photo.exif_source == ExifSource.actual_file
full_file_name = self._sample_photo.get_current_full_file_name()
self._sample_photo.load_metadata(full_file_name=full_file_name,
et_process=self.exiftool_process)
return self._sample_photo
@sample_photo.setter
def sample_photo(self, photo: Photo) -> None:
self._sample_photo = photo
def _sample_video_full_file_name(self) -> str:
"""
Sample videos can be either excerpts of a video from a camera or
actual videos already on the file system.
:return: the full path and filename of the sample video regardless
of which type it is
"""
if (self._sample_video is not None and
self._sample_video.temp_sample_full_file_name is not None):
full_file_name = self._sample_video.temp_sample_full_file_name
else:
full_file_name = self._sample_video.get_current_full_file_name()
return full_file_name
@property
def sample_video(self) -> Optional[Video]:
if self._sample_video is None:
return None
self._update_sample_file(file_type=FileType.video)
if self._sample_video.metadata is None and not self._sample_video.metadata_failure:
try:
assert self._sample_video.temp_sample_full_file_name or os.path.isfile(
self._sample_video.full_file_name)
full_file_name = self._sample_video_full_file_name()
self._sample_video.load_metadata(
full_file_name=full_file_name,
et_process=self.exiftool_process)
if self._sample_video.metadata_failure:
logging.error("Failed to load sample video metadata")
except AssertionError:
logging.error("Expected sample file name in sample video")
except:
logging.error("Exception while attempting to load sample video metadata")
return self._sample_video
@sample_video.setter
def sample_video(self, video: Video) -> None:
if self._sample_video is not None and self._sample_video.temp_sample_is_complete_file:
# Don't delete this fully downloaded file, as it might be downloaded by the user,
# in which case it's already been recorded as a RPDFile.cache_full_file_name
# Instead add it to a list of files to possibly expunge at program exit
logging.debug("Adding %s to list of complete sample video files to potentially delete "
"at program exit", self._sample_video.temp_sample_full_file_name)
self._sample_videos_complete_files.append(self._sample_video.temp_sample_full_file_name)
else:
self._delete_sample_video(at_program_close=False)
self._sample_video = video
def get_main_window_display_name_and_icon(self) -> Tuple[str, QIcon]:
"""
Generate the name to display at the top left of the main
window, indicating the source of the files.
:return: string to display and associated icon
"""
if not len(self):
return _('Select Source'), QIcon(':/icons/computer.svg')
elif len(self) == 1:
# includes case where path is the only device
device = list(self.devices.values())[0]
return device.display_name, device.get_icon()
else:
non_pc_devices = [device for device in self.devices.values()
if device.device_type != DeviceType.path] # type: List[Device]
assert len(non_pc_devices) == len(self.volumes_and_cameras)
device_types = Counter(d.device_type for d in non_pc_devices)
if len(device_types) == 1:
device_type = list(device_types)[0]
device_type_text = self._map_plural_types[device_type]
else:
device_type = None
device_type_text = _('Devices')
if len(self.this_computer) == 1:
assert len(self.this_computer) < 2
assert len(self.this_computer) > 0
icon = QIcon(':/icons/computer.svg')
devices = list(self.volumes_and_cameras)
computer_display_name=self.devices[list(self.this_computer)[0]].display_name
if len(self.volumes_and_cameras) == 1:
device_display_name = self.devices[devices[0]].display_name
else:
assert len(self.volumes_and_cameras) > 1
device_display_name = self._mixed_devices(device_type_text)
text = _('%(device1)s + %(device2)s') % {'device1': device_display_name,
'device2': computer_display_name}
return text, icon
else:
assert len(self.this_computer) == 0
mtp_devices = [d for d in non_pc_devices if d.is_mtp_device]
if len(device_types) == 1:
if len(self) == 2:
devices = non_pc_devices
text = _('%(device1)s + %(device2)s') % {'device1': devices[0].display_name,
'device2': devices[1].display_name}
if device_type == DeviceType.camera and len(mtp_devices) != 2:
return text, QIcon(':/icons/camera.svg')
return text, devices[0].get_icon()
try:
text_number = number(len(self.volumes_and_cameras)).number.capitalize()
except KeyError:
text_number = len(self.volumes_and_cameras)
if device_type == DeviceType.camera:
# Number of cameras e.g. 3 Cameras
text = _('%(no_cameras)s Cameras') % {'no_cameras': text_number}
if len(mtp_devices) == len(self.volumes_and_cameras):
return text, non_pc_devices[0].get_icon()
return text, QIcon(':/icons/camera.svg')
elif device_type == DeviceType.volume:
text = _('%(no_devices)s Devices') % dict(no_devices=text_number)
return text, QIcon(':/icons/drive-removable-media.svg')
else:
device_display_name = self._mixed_devices(device_type_text)
icon = QIcon(':/icons/computer.svg')
return device_display_name, icon
# QStorageInfo, BackupLocationType
BackupDevice = namedtuple('BackupDevice', 'mount, backup_type')
# QStorageInfo, str, str, BackupLocationType
BackupVolumeDetails = namedtuple('BackupVolumeDetails', 'mount name path backup_type '
'os_stat_device')
def nth(iterable, n, default=None):
"Returns the nth item or a default value"
return next(itertools.islice(iterable, n, None), default)
class BackupDeviceCollection:
r"""
Track and manage devices (and manual paths) used for backing up.
Photos can be backed up to one location, and videos to another; or
they can be backed up to the same location.
If a BackupDevice's mount is None, then it is assumed to be
a manually specified path.
Backup devices are indexed by path, not id
>>> b = BackupDeviceCollection()
>>> len(b)
0
>>> p = BackupDevice(mount=None, backup_type=BackupLocationType.photos)
>>> p2 = BackupDevice(mount=None, backup_type=BackupLocationType.photos)
>>> v = BackupDevice(mount=None, backup_type=BackupLocationType.videos)
>>> pv = BackupDevice(mount=None,
... backup_type=BackupLocationType.photos_and_videos)
>>> pv2 = BackupDevice(mount=None,
... backup_type=BackupLocationType.photos_and_videos)
>>> b['/some/photo/path'] = p
>>> b
{'/some/photo/path':None <BackupLocationType.photos: 1> 0}
>>> b.device_id('/some/photo/path')
0
>>> b['/some/other/photo/path'] = p2
>>> del b['/some/other/photo/path']
>>> b['/some/video/path'] = v
>>> len(b)
2
>>> b.device_id('/some/video/path')
2
>>> b.device_id('/unknown/path')
>>>
>>> '/some/photo/path' in b
True
>>> b['/some/photo/path']
BackupDevice(mount=None, backup_type=<BackupLocationType.photos: 1>)
>>> len(b.photo_backup_devices)
1
>>> len(b.video_backup_devices)
1
>>> b['/some/photo/video/path'] = pv
>>> len(b.photo_backup_devices)
2
>>> len(b.video_backup_devices)
2
>>> del b['/some/photo/path']
>>> len(b.photo_backup_devices)
1
>>> len(b.video_backup_devices)
2
>>> b['/some/video/path'] = pv2
>>> len(b.photo_backup_devices)
2
>>> len(b.video_backup_devices)
2
>>> del b['/some/video/path']
>>> del b['/some/photo/video/path']
>>> len(b)
0
>>> len(b.photo_backup_devices)
0
>>> len(b.video_backup_devices)
0
"""
def __init__(self, rapidApp=None):
self.rapidApp = rapidApp
self.devices = dict() # type: Dict[str, BackupDevice]
# Set[path]
self.photo_backup_devices = set() # type: Set[str]
self.video_backup_devices = set() # type: Set[str]
self._device_ids = {}
self._device_id = 0
def __setitem__(self, path: str, device: BackupDevice):
if path in self.devices:
del self[path]
self.devices[path] = device
backup_type = device.backup_type
if backup_type in [BackupLocationType.photos,
BackupLocationType.photos_and_videos]:
self.photo_backup_devices.add(path)
if backup_type in [BackupLocationType.videos,
BackupLocationType.photos_and_videos]:
self.video_backup_devices.add(path)
self._device_ids[path] = self._device_id
self._device_id += 1
def __delitem__(self, path):
backup_type = self.devices[path].backup_type
if backup_type in (BackupLocationType.photos, BackupLocationType.photos_and_videos):
self.photo_backup_devices.remove(path)
if backup_type in (BackupLocationType.videos, BackupLocationType.photos_and_videos):
self.video_backup_devices.remove(path)
del self.devices[path]
del self._device_ids[path]
def __repr__(self):
s = '{'
for key, value in self.devices.items():
s += r'%r:%r %r %s, ' % (key, value.mount, value.backup_type,
self._device_ids[key])
s = s[:-2] + '}'
return s
def __contains__(self, key):
return key in self.devices
def __len__(self):
return len(self.devices)
def __getitem__(self, path):
return self.devices[path]
def __iter__(self):
return iter(self.devices)
def all_paths(self) -> List[str]:
return list(self.devices.keys())
def device_id(self, path: str) -> Optional[int]:
if path in self:
return self._device_ids[path]
return None
def name(self, path: str, shorten: bool=False) -> str:
"""
:param path:
:param shorten: if True, and backup type is not an
automatically detected device, return the path basename
:return: device mount name, or path / path basename
"""
if self.devices[path].mount is None:
if shorten:
return get_path_display_name(path)[0]
else:
return path
else:
mount = self.devices[path].mount # type: QStorageInfo
if not shorten:
return mount.displayName()
else:
name = mount.name()
if name:
return name
else:
return get_path_display_name(mount.rootPath())[0]
def backup_type(self, path) -> BackupLocationType:
return self.devices[path].backup_type
def multiple_backup_devices(self, file_type: FileType) -> bool:
"""
:param file_type: whether the file is a photo or video
:return: True if more than one backup device is being used for
the file type
"""
return ((file_type == FileType.photo and len(self.photo_backup_devices) > 1) or
(file_type == FileType.video and len(self.video_backup_devices) > 1))
def get_download_backup_device_overlap(self,
photo_download_folder: str,
video_download_folder: str) -> DefaultDict[int, Set[FileType]]:
"""
Determine if the photo/video download locations and the backup locations
are going to the same partitions.
:param photo_download_folder: where photos are downloaded
:param video_download_folder: where videos are downloaded
:return: partitions that are downloaded and backed up to,
referred to by os.stat.st_dev
"""
try:
photo_device = os.stat(photo_download_folder).st_dev
except FileNotFoundError:
photo_device = 0
try:
video_device = os.stat(video_download_folder).st_dev
except:
video_device = 0
downloading_to = defaultdict(set) # type: DefaultDict[int, Set[FileType]]
if photo_device != video_device:
download_dests = (photo_device, video_device)
else:
download_dests = (photo_device, )
for path in self.devices:
try:
backup_device = os.stat(path).st_dev
except:
backup_device = 0
if backup_device != 0:
d = self.devices[path]
backup_type = d.backup_type
for download_device in download_dests:
if backup_device == download_device:
if backup_type in (BackupLocationType.photos,
BackupLocationType.photos_and_videos):
downloading_to[backup_device].add(FileType.photo)
if backup_type in (BackupLocationType.videos,
BackupLocationType.photos_and_videos):
downloading_to[backup_device].add(FileType.video)
return downloading_to
def get_manual_mounts(self) -> Optional[Tuple[BackupVolumeDetails, ...]]:
"""
Get QStorageInfo, display name, and path for each backup
destination for manually specified backup destinations.
Display name is the path basename.
Lists photo backup destination before video backup destination.
Exceptions are not caught, however invalid destinations are accounted
for.
:return: Tuple of one or two Tuples containing QStorageInfo, display name,
and path. If no valid backup destinations are found, returns None.
"""
assert len(self.devices)
paths = tuple(self.devices.keys())
if len(paths) == 1:
if not os.path.isdir(paths[0]):
return None
same_path = True
path = paths[0]
backup_type = BackupLocationType.photos_and_videos
else:
assert len(paths) == 2
photo_path = tuple(self.photo_backup_devices)[0]
video_path = tuple(self.video_backup_devices)[0]
photo_path_valid = os.path.isdir(photo_path)
video_path_valid = os.path.isdir(video_path)
if photo_path_valid and video_path_valid:
same_path = False
elif photo_path_valid:
same_path = True
path = photo_path
backup_type = BackupLocationType.photos
elif video_path_valid:
same_path = True
path = video_path
backup_type = BackupLocationType.videos
else:
return None
if same_path:
name = self.name(path, shorten=True)
mount = QStorageInfo(path)
os_stat_device = os.stat(path).st_dev
return (BackupVolumeDetails(mount, name, path, backup_type, os_stat_device), )
else:
photo_name = self.name(photo_path, shorten=True)
video_name = self.name(video_path, shorten=True)
photo_mount = QStorageInfo(photo_path)
photo_os_stat_device = os.stat(photo_path).st_dev
if same_device(photo_path, video_path):
# Translators: two folder names, separated by a plus sign
names = _('%s + %s') % (photo_name, video_name)
paths = '%s\n%s' % (photo_path, video_path)
return (BackupVolumeDetails(photo_mount, names, paths,
BackupLocationType.photos_and_videos,
photo_os_stat_device),)
else:
video_mount = QStorageInfo(video_path)
video_os_stat_device = os.stat(video_path).st_dev
return (BackupVolumeDetails(photo_mount, photo_name, photo_path,
BackupLocationType.photos,
photo_os_stat_device),
BackupVolumeDetails(video_mount, video_name, video_path,
BackupLocationType.videos,
video_os_stat_device))
def get_backup_volume_details(self, path: str) -> BackupVolumeDetails:
"""
For now only used in case of external mounts i.e. not auto-detected.
:param path: backup path
:return: named tuple of details of the backup volume
"""
name = self.name(path, shorten=True)
device = self.devices[path]
if device.mount is not None:
mount = device.mount
else:
mount = QStorageInfo(path)
backup_type = device.backup_type
os_stat_device = os.stat(path).st_dev
return BackupVolumeDetails(mount, name, path, backup_type, os_stat_device)
def backup_possible(self, file_type: FileType) -> bool:
"""
:param file_type: whether the file is a photo or video
:return: True if more a backup device is being used for
the file type
"""
if file_type == FileType.photo:
return len(self.photo_backup_devices) > 0
elif file_type == FileType.video:
return len(self.video_backup_devices) > 0
else:
logging.critical("Unrecognized file type when determining if backup is possible")
def _add_identifier(self, path: Optional[str], file_type: FileType) -> Optional[str]:
if path is None:
return None
if file_type == FileType.photo:
return os.path.join(path, self.rapidApp.prefs.photo_backup_identifier)
else:
return os.path.join(path, self.rapidApp.prefs.video_backup_identifier)
def sample_device_paths(self) -> List[str]:
"""
Return a sample of up to three paths on detected backup devices.
Includes the folder identifier (specified in the user prefs)
used to identify the backup drive.
Illustrates backup destinations for each of photo, video, such
that:
- If photos are being backed up to a device, show it.
- If videos are being backed up to a device, show it.
- If photos and videos are being backed up to the same device,
show that they are.
:return: sorted list of the paths
"""
# Prioritize display of drives that are backing up only one type
both_types = self.photo_backup_devices & self.video_backup_devices
photo_only = self.photo_backup_devices - both_types
video_only = self.video_backup_devices - both_types
photo0 = nth(iter(photo_only), 0)
video0 = nth(iter(video_only), 0)
both0, both1 = tuple(itertools.chain(itertools.islice(both_types, 2),
itertools.repeat(None, 2)))[:2]
# Add the identifier specified in the user's prefs
photo0id, photo1id, photo2id = (self._add_identifier(path, FileType.photo)
for path in (photo0, both0, both1))
video0id, video1id, video2id = (self._add_identifier(path, FileType.video)
for path in (video0, both0, both1))
paths = [path for path in (photo0id, video0id, photo1id, video1id, photo2id, video2id)
if path is not None][:3]
if len(paths) < 3:
unused_photo = self.photo_backup_devices - {path for path in (photo0, both0, both1)
if path is not None}
unused_video = self.video_backup_devices - {path for path in (video0, both0, both1)
if path is not None}
photo1, photo2 = tuple(itertools.chain(itertools.islice(unused_photo, 2),
itertools.repeat(None, 2)))[:2]
video1, video2 = tuple(itertools.chain(itertools.islice(unused_video, 2),
itertools.repeat(None, 2)))[:2]
photo3id, photo4id = (self._add_identifier(path, FileType.photo)
for path in (photo1, photo2))
video3id, video4id = (self._add_identifier(path, FileType.video)
for path in (video1, video2))
paths += [path for path in (photo3id, video3id, photo4id, video4id)
if path is not None][:3 - len(paths)]
return sorted(paths)
def backup_destinations_missing(self,
downloading: DownloadingFileTypes) -> Optional[BackupFailureType]:
"""
Checks if there are backup destinations matching the files
going to be downloaded
:param downloading: the types of file that will be downloaded
:return: None if no problems, or BackupFailureType
"""
prefs = self.rapidApp.prefs
if prefs.backup_files:
photos = downloading in (DownloadingFileTypes.photos,
DownloadingFileTypes.photos_and_videos)
videos = downloading in (DownloadingFileTypes.videos,
DownloadingFileTypes.photos_and_videos)
if prefs.backup_device_autodetection:
photo_backup_problem = photos and not self.backup_possible(FileType.photo)
video_backup_problem = videos and not self.backup_possible(FileType.video)
else:
photo_backup_problem = photos and not validate_download_folder(
path=prefs.backup_photo_location,
write_on_waccesss_failure=True
).valid
video_backup_problem = videos and not validate_download_folder(
path=prefs.backup_video_location,
write_on_waccesss_failure=True
).valid
if photo_backup_problem:
if video_backup_problem:
return BackupFailureType.photos_and_videos
else:
return BackupFailureType.photos
elif video_backup_problem:
return BackupFailureType.videos
else:
return None
return None
class FSMetadataErrors:
"""
When downloading and backing up, filesystem metadata needs to be copied.
Sometimes it's not possible. Track which devices (computer devices,
according to the OS, that is, not the same as above) have problems.
"""
def __init__(self) -> None:
# A 'device' in this class is the st_dev value returned by os.stat
self.devices = set() # type: Set[int]
self.archived_devices = set() # type: Set[int]
# device: FsMetadataWriteProblem
self.metadata_errors = dict() # type: Dict[int, FsMetadataWriteProblem]
# scan_id / device_id: Set[device]
self.worker_id_devices = defaultdict(set) # type: DefaultDict[int, Set[int]]
def add_problem(self, worker_id: int,
path: str,
mdata_exceptions: Tuple[Exception]) -> None:
dev = os.stat(path).st_dev
if dev not in self.devices:
self.devices.add(dev)
name, uri, root_path, fstype = fs_device_details(path)
problem = FsMetadataWriteProblem(
name=name, uri=uri, mdata_exceptions=mdata_exceptions
)
self.metadata_errors[dev] = problem
if worker_id is not None:
self.worker_id_devices[worker_id].add(dev)
def problems(self, worker_id: int) -> List[FsMetadataWriteProblem]:
problems = []
for dev in self.worker_id_devices[worker_id]:
if dev not in self.archived_devices:
problems.append(self.metadata_errors[dev])
self.archived_devices.add(dev)
return problems
|