-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbase.py
More file actions
1252 lines (1092 loc) · 50.2 KB
/
base.py
File metadata and controls
1252 lines (1092 loc) · 50.2 KB
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
#!/usr/bin/env python
"""Main script that uses Click to parse command-line arguments"""
import datetime
import getpass
import itertools
import json
import logging
import os
import subprocess
import sys
import time
import typing
import urllib
from functools import partial, singledispatch
from logging import Logger
from multiprocessing import freeze_support
from threading import Thread
from typing import (
Any,
Callable,
Dict,
Iterable,
List,
Mapping,
Sequence,
Tuple,
)
from requests.exceptions import (
ChunkedEncodingError,
ContentDecodingError,
StreamConsumedError,
UnrewindableBodyError,
)
from tqdm import tqdm
from tqdm.contrib.logging import logging_redirect_tqdm
from tzlocal import get_localzone
from foundation.core import compose, identity, map_, partial_1_1
from icloudpd import download, exif_datetime
from icloudpd.authentication import authenticator
from icloudpd.autodelete import autodelete_photos
from icloudpd.config import GlobalConfig, UserConfig
from icloudpd.counter import Counter
from icloudpd.email_notifications import send_2sa_notification
from icloudpd.filename_policies import build_filename_with_policies, create_filename_builder
from icloudpd.log_level import LogLevel
from icloudpd.mfa_provider import MFAProvider
from icloudpd.password_provider import PasswordProvider
from icloudpd.paths import local_download_path, remove_unicode_chars
from icloudpd.server import serve_app
from icloudpd.status import Status, StatusExchange
from icloudpd.string_helpers import parse_timestamp_or_timedelta, truncate_middle
from icloudpd.xmp_sidecar import generate_xmp_file
from pyicloud_ipd.asset_version import add_suffix_to_filename, calculate_version_filename
from pyicloud_ipd.base import PyiCloudService
from pyicloud_ipd.exceptions import (
PyiCloudAPIResponseException,
PyiCloudConnectionErrorException,
PyiCloudFailedLoginException,
PyiCloudFailedMFAException,
PyiCloudServiceNotActivatedException,
PyiCloudServiceUnavailableException,
)
from pyicloud_ipd.file_match import FileMatchPolicy
from pyicloud_ipd.item_type import AssetItemType # fmt: skip
from pyicloud_ipd.live_photo_mov_filename_policy import LivePhotoMovFilenamePolicy
from pyicloud_ipd.raw_policy import RawTreatmentPolicy
from pyicloud_ipd.services.photos import (
PhotoAlbum,
PhotoAsset,
PhotoLibrary,
)
from pyicloud_ipd.utils import (
disambiguate_filenames,
get_password_from_keyring,
size_to_suffix,
store_password_in_keyring,
)
from pyicloud_ipd.version_size import AssetVersionSize, LivePhotoVersionSize
freeze_support() # fmt: skip # fixing tqdm on macos
def build_filename_cleaner(keep_unicode: bool) -> Callable[[str], str]:
"""Build filename cleaner based on unicode preference.
Args:
keep_unicode: If True, preserve Unicode characters. If False, remove non-ASCII characters.
Returns:
Function that processes filenames according to unicode preference.
Note: Basic filesystem character cleaning (clean_filename) is always applied in calculate_filename.
"""
if keep_unicode:
# Only basic cleaning is needed (already applied in calculate_filename)
return identity
else:
# Apply unicode removal in addition to basic cleaning
return remove_unicode_chars
def lp_filename_concatinator(filename: str) -> str:
"""Generate concatenator-style live photo filename, adding HEVC suffix for HEIC files"""
import os
from foundation.core import compose
from foundation.string_utils import endswith, lower
name, ext = os.path.splitext(filename)
if not ext:
return filename
is_heic = compose(endswith(".heic"), lower)(ext)
return name + ("_HEVC.MOV" if is_heic else ".MOV")
def lp_filename_original(filename: str) -> str:
"""Generate original-style live photo filename by replacing extension with .MOV"""
from foundation.string_utils import replace_extension
replace_with_mov = replace_extension(".MOV")
return replace_with_mov(filename)
def ask_password_in_console(_user: str) -> str | None:
return getpass.getpass(f"iCloud Password for {_user}:")
def get_password_from_webui(
logger: Logger, status_exchange: StatusExchange, _user: str
) -> str | None:
"""Request two-factor authentication through Webui."""
if not status_exchange.replace_status(Status.NO_INPUT_NEEDED, Status.NEED_PASSWORD):
logger.error("Expected NO_INPUT_NEEDED, but got something else")
return None
# wait for input
while True:
status = status_exchange.get_status()
if status == Status.NEED_PASSWORD:
time.sleep(1)
else:
break
if status_exchange.replace_status(Status.SUPPLIED_PASSWORD, Status.CHECKING_PASSWORD):
password = status_exchange.get_payload()
if not password:
logger.error("Internal error: did not get password for SUPPLIED_PASSWORD status")
status_exchange.replace_status(
Status.CHECKING_PASSWORD, Status.NO_INPUT_NEEDED
) # TODO Error
return None
return password
return None # TODO
def update_password_status_in_webui(status_exchange: StatusExchange, _u: str, _p: str) -> None:
status_exchange.replace_status(Status.CHECKING_PASSWORD, Status.NO_INPUT_NEEDED)
def update_auth_error_in_webui(status_exchange: StatusExchange, error: str) -> bool:
return status_exchange.set_error(error)
# def get_click_param_by_name(_name: str, _params: List[Parameter]) -> Optional[Parameter]:
# _with_password = [_p for _p in _params if _name in _p.name]
# if len(_with_password) == 0:
# return None
# return _with_password[0]
def dummy_password_writter(_u: str, _p: str) -> None:
pass
def keyring_password_writter(logger: Logger) -> Callable[[str, str], None]:
def _intern(username: str, password: str) -> None:
try:
store_password_in_keyring(username, password)
except Exception:
logger.warning("Password was not saved to keyring")
return _intern
def skip_created_generator(
name: str, formatted: str | None
) -> datetime.datetime | datetime.timedelta | None:
"""Converts ISO dates to datetime and interval in days to timeinterval using supplied name as part of raised exception in case of the error"""
if formatted is None:
return None
result = parse_timestamp_or_timedelta(formatted)
if result is None:
raise ValueError(f"{name} parameter did not parse ISO timestamp or interval successfully")
if isinstance(result, datetime.datetime):
return ensure_tzinfo(get_localzone(), result)
return result
def ensure_tzinfo(tz: datetime.tzinfo, input: datetime.datetime) -> datetime.datetime:
if input.tzinfo is None:
return input.astimezone(tz)
return input
# Must import the constants object so that we can mock values in tests.
def create_logger(config: GlobalConfig) -> logging.Logger:
logging.basicConfig(
format="%(asctime)s %(levelname)-8s %(message)s",
datefmt="%Y-%m-%d %H:%M:%S",
stream=sys.stdout,
)
logger = logging.getLogger("icloudpd")
if config.only_print_filenames:
logger.disabled = True
else:
# Need to make sure disabled is reset to the correct value,
# because the logger instance is shared between tests.
logger.disabled = False
if config.log_level == LogLevel.DEBUG:
logger.setLevel(logging.DEBUG)
elif config.log_level == LogLevel.INFO:
logger.setLevel(logging.INFO)
elif config.log_level == LogLevel.ERROR:
logger.setLevel(logging.ERROR)
else:
# Developer's error - not an exhaustive match
raise ValueError(f"Unsupported logging level {config.log_level}")
return logger
def run_with_configs(global_config: GlobalConfig, user_configs: Sequence[UserConfig]) -> int:
"""Run the application with the new configuration system"""
# Create shared logger
logger = create_logger(global_config)
# Create shared status exchange for web server and progress tracking
shared_status_exchange = StatusExchange()
# Check if any user needs web server (webui for MFA or passwords)
needs_web_server = global_config.mfa_provider == MFAProvider.WEBUI or any(
provider == PasswordProvider.WEBUI for provider in global_config.password_providers
)
# Start web server ONCE if needed, outside all loops
if needs_web_server:
logger.info("Starting web server for WebUI authentication...")
server_thread = Thread(target=serve_app, daemon=True, args=[logger, shared_status_exchange])
server_thread.start()
# Check if we're in watch mode
watch_interval = global_config.watch_with_interval
if not watch_interval:
# No watch mode - process each user once and exit
return _process_all_users_once(global_config, user_configs, logger, shared_status_exchange)
else:
# Watch mode - infinite loop processing all users, then wait
skip_bar = not os.environ.get("FORCE_TQDM") and (
global_config.only_print_filenames
or global_config.no_progress_bar
or not sys.stdout.isatty()
)
while True:
# Process all user configs in this iteration
result = _process_all_users_once(
global_config, user_configs, logger, shared_status_exchange
)
# If any critical operation (auth-only, list commands) succeeded, exit
if result == 0:
first_user = user_configs[0] if user_configs else None
if first_user and (
first_user.auth_only or first_user.list_albums or first_user.list_libraries
):
return 0
# Wait for the watch interval before next iteration
# Clear current user during wait period to avoid misleading UI
shared_status_exchange.clear_current_user()
logger.info(f"Waiting for {watch_interval} sec...")
interval: Sequence[int] = range(1, watch_interval)
iterable: Sequence[int] = (
interval
if skip_bar
else typing.cast(
Sequence[int],
tqdm(
iterable=interval,
desc="Waiting...",
ascii=True,
leave=False,
dynamic_ncols=True,
),
)
)
for counter in iterable:
# Update shared status exchange with wait progress
shared_status_exchange.get_progress().waiting = watch_interval - counter
if shared_status_exchange.get_progress().resume:
shared_status_exchange.get_progress().reset()
break
time.sleep(1)
def _process_all_users_once(
global_config: GlobalConfig,
user_configs: Sequence[UserConfig],
logger: logging.Logger,
shared_status_exchange: StatusExchange,
) -> int:
"""Process all user configs once (used by both single run and watch mode)"""
# Set global config and all user configs to status exchange once, before processing
shared_status_exchange.set_global_config(global_config)
shared_status_exchange.set_user_configs(user_configs)
for user_config in user_configs:
with logging_redirect_tqdm():
# Use shared status exchange instead of creating new ones per user
status_exchange = shared_status_exchange
# Set up password providers with proper function replacements
password_providers_dict: Dict[
PasswordProvider, Tuple[Callable[[str], str | None], Callable[[str, str], None]]
] = {}
for provider in global_config.password_providers:
if provider == PasswordProvider.WEBUI:
password_providers_dict[provider] = (
partial(get_password_from_webui, logger, status_exchange),
partial(update_password_status_in_webui, status_exchange),
)
elif provider == PasswordProvider.CONSOLE:
password_providers_dict[provider] = (
ask_password_in_console,
dummy_password_writter,
)
elif provider == PasswordProvider.KEYRING:
password_providers_dict[provider] = (
get_password_from_keyring,
keyring_password_writter(logger),
)
elif provider == PasswordProvider.PARAMETER:
def create_constant_password_provider(
password: str | None,
) -> Callable[[str], str | None]:
def password_provider(_username: str) -> str | None:
return password
return password_provider
password_providers_dict[provider] = (
create_constant_password_provider(user_config.password),
dummy_password_writter,
)
# Only set current user - global config and user configs are already set
status_exchange.set_current_user(user_config.username)
# Web server is now started once outside the user loop - no need to start it here
# Set up filename processors directly since we don't have click context
# filename_cleaner was removed from services and should be passed explicitly to functions that need it
# Set up live photo filename generator directly
lp_filename_generator = (
lp_filename_original
if user_config.live_photo_mov_filename_policy == LivePhotoMovFilenamePolicy.ORIGINAL
else lp_filename_concatinator
)
# Set up filename cleaner based on user preference
filename_cleaner = build_filename_cleaner(user_config.keep_unicode_in_filenames)
# Create filename builder with pre-configured policy and cleaner
filename_builder = create_filename_builder(
user_config.file_match_policy, filename_cleaner
)
# Set up function builders
passer = partial(
where_builder,
logger,
user_config.skip_videos,
user_config.skip_created_before,
user_config.skip_created_after,
user_config.skip_photos,
filename_builder,
)
downloader = (
partial(
download_builder,
logger,
user_config.folder_structure,
user_config.directory,
user_config.sizes,
user_config.force_size,
global_config.only_print_filenames,
user_config.set_exif_datetime,
user_config.skip_live_photos,
user_config.live_photo_size,
user_config.dry_run,
user_config.file_match_policy,
user_config.xmp_sidecar,
lp_filename_generator,
filename_builder,
user_config.align_raw,
)
if user_config.directory is not None
else (lambda _s, _c, _p: False)
)
notificator = partial(
notificator_builder,
logger,
user_config.username,
user_config.smtp_username,
user_config.smtp_password,
user_config.smtp_host,
user_config.smtp_port,
user_config.smtp_no_tls,
user_config.notification_email,
user_config.notification_email_from,
str(user_config.notification_script) if user_config.notification_script else None,
)
# Use core_single_run since we've disabled watch at this level
logger.info(f"Processing user: {user_config.username}")
result = core_single_run(
logger,
status_exchange,
global_config,
user_config,
password_providers_dict,
passer,
downloader,
notificator,
lp_filename_generator,
)
# If any user config fails and we're not in watch mode, return the error code
if result != 0:
if not global_config.watch_with_interval:
return result
else:
# In watch mode, log error and continue with next user
logger.error(
f"Error processing user {user_config.username}, continuing with next user..."
)
return 0
def notificator_builder(
logger: logging.Logger,
username: str,
smtp_username: str | None,
smtp_password: str | None,
smtp_host: str,
smtp_port: int,
smtp_no_tls: bool,
notification_email: str | None,
notification_email_from: str | None,
notification_script: str | None,
) -> None:
try:
if notification_script is not None:
logger.debug("Executing notification script...")
subprocess.call([notification_script])
else:
pass
if smtp_username is not None or notification_email is not None:
send_2sa_notification(
logger,
username,
smtp_username,
smtp_password,
smtp_host,
smtp_port,
smtp_no_tls,
notification_email,
notification_email_from,
)
else:
pass
except Exception as error:
logger.error("Notification of the required MFA failed")
logger.debug(error)
@singledispatch
def offset_to_datetime(offset: Any) -> datetime.datetime:
raise NotImplementedError()
@offset_to_datetime.register(datetime.datetime)
def _(offset: datetime.datetime) -> datetime.datetime:
return offset
@offset_to_datetime.register(datetime.timedelta)
def _(offset: datetime.timedelta) -> datetime.datetime:
return datetime.datetime.now(get_localzone()) - offset
def where_builder(
logger: logging.Logger,
skip_videos: bool,
skip_created_before: datetime.datetime | datetime.timedelta | None,
skip_created_after: datetime.datetime | datetime.timedelta | None,
skip_photos: bool,
filename_builder: Callable[[PhotoAsset], str],
photo: PhotoAsset,
) -> bool:
if skip_videos and photo.item_type == AssetItemType.MOVIE:
logger.debug(asset_type_skip_message(AssetItemType.IMAGE, filename_builder, photo))
return False
if skip_photos and photo.item_type == AssetItemType.IMAGE:
logger.debug(asset_type_skip_message(AssetItemType.MOVIE, filename_builder, photo))
return False
if skip_created_before is not None:
temp_created_before = offset_to_datetime(skip_created_before)
if photo.created < temp_created_before:
logger.debug(skip_created_before_message(temp_created_before, photo, filename_builder))
return False
if skip_created_after is not None:
temp_created_after = offset_to_datetime(skip_created_after)
if photo.created > temp_created_after:
logger.debug(skip_created_after_message(temp_created_after, photo, filename_builder))
return False
return True
def skip_created_before_message(
target_created_date: datetime.datetime,
photo: PhotoAsset,
filename_builder: Callable[[PhotoAsset], str],
) -> str:
filename = filename_builder(photo)
return f"Skipping {filename}, as it was created {photo.created}, before {target_created_date}."
def skip_created_after_message(
target_created_date: datetime.datetime,
photo: PhotoAsset,
filename_builder: Callable[[PhotoAsset], str],
) -> str:
filename = filename_builder(photo)
return f"Skipping {filename}, as it was created {photo.created}, after {target_created_date}."
def download_builder(
logger: logging.Logger,
folder_structure: str,
directory: str,
primary_sizes: Sequence[AssetVersionSize],
force_size: bool,
only_print_filenames: bool,
set_exif_datetime: bool,
skip_live_photos: bool,
live_photo_size: LivePhotoVersionSize,
dry_run: bool,
file_match_policy: FileMatchPolicy,
xmp_sidecar: bool,
lp_filename_generator: Callable[[str], str],
filename_builder: Callable[[PhotoAsset], str],
raw_policy: RawTreatmentPolicy,
icloud: PyiCloudService,
counter: Counter,
photo: PhotoAsset,
) -> bool:
"""function for actually downloading the photos"""
try:
created_date = photo.created.astimezone(get_localzone())
except (ValueError, OSError):
logger.error("Could not convert photo created date to local timezone (%s)", photo.created)
created_date = photo.created
from foundation.core import compose
from foundation.string_utils import eq, lower
is_none_folder = compose(eq("none"), lower)
if is_none_folder(folder_structure):
date_path = ""
else:
try:
date_path = folder_structure.format(created_date)
except ValueError: # pragma: no cover
# This error only seems to happen in Python 2
logger.error("Photo created date was not valid (%s)", photo.created)
# e.g. ValueError: year=5 is before 1900
# (https://github.com/icloud-photos-downloader/icloud_photos_downloader/issues/122)
# Just use the Unix epoch
created_date = datetime.datetime.fromtimestamp(0)
date_path = folder_structure.format(created_date)
try:
versions, filename_overrides = disambiguate_filenames(
photo.versions_with_raw_policy(raw_policy), primary_sizes, photo, lp_filename_generator
)
except KeyError as ex:
print(f"KeyError: {ex} attribute was not found in the photo fields.")
with open(file="icloudpd-photo-error.json", mode="w", encoding="utf8") as outfile:
json.dump(
{
"master_record": photo._master_record,
"asset_record": photo._asset_record,
},
outfile,
)
print("icloudpd has saved the photo record to: ./icloudpd-photo-error.json")
print("Please create a Gist with the contents of this file: https://gist.github.com")
print(
"Then create an issue on GitHub: "
"https://github.com/icloud-photos-downloader/icloud_photos_downloader/issues"
)
print("Include a link to the Gist in your issue, so that we can see what went wrong.\n")
return False
download_dir = os.path.normpath(os.path.join(directory, date_path))
success = False
for download_size in primary_sizes:
if download_size not in versions and download_size != AssetVersionSize.ORIGINAL:
if force_size:
error_filename = filename_builder(photo)
logger.error(
"%s size does not exist for %s. Skipping...",
download_size.value,
error_filename,
)
continue
if AssetVersionSize.ORIGINAL in primary_sizes:
continue # that should avoid double download for original
download_size = AssetVersionSize.ORIGINAL
version = versions[download_size]
photo_filename = filename_builder(photo)
filename = calculate_version_filename(
photo_filename,
version,
download_size,
lp_filename_generator,
photo.item_type,
filename_overrides.get(download_size),
)
download_path = local_download_path(filename, download_dir)
original_download_path = None
file_exists = os.path.isfile(download_path)
if not file_exists and download_size == AssetVersionSize.ORIGINAL:
# Deprecation - We used to download files like IMG_1234-original.jpg,
# so we need to check for these.
# Now we match the behavior of iCloud for Windows: IMG_1234.jpg
original_download_path = add_suffix_to_filename("-original", download_path)
file_exists = os.path.isfile(original_download_path)
if file_exists:
if file_match_policy == FileMatchPolicy.NAME_SIZE_DEDUP_WITH_SUFFIX:
# for later: this crashes if download-size medium is specified
file_size = os.stat(original_download_path or download_path).st_size
photo_size = version.size
if file_size != photo_size:
download_path = (f"-{photo_size}.").join(download_path.rsplit(".", 1))
logger.debug("%s deduplicated", truncate_middle(download_path, 96))
file_exists = os.path.isfile(download_path)
if file_exists:
counter.increment()
logger.debug("%s already exists", truncate_middle(download_path, 96))
if not file_exists:
counter.reset()
if only_print_filenames:
print(download_path)
else:
truncated_path = truncate_middle(download_path, 96)
logger.debug("Downloading %s...", truncated_path)
download_result = download.download_media(
logger,
dry_run,
icloud,
photo,
download_path,
version,
download_size,
filename_builder,
)
success = download_result
if download_result:
from foundation.core import compose
from foundation.string_utils import endswith, lower
is_jpeg = compose(endswith((".jpg", ".jpeg")), lower)
if (
not dry_run
and set_exif_datetime
and is_jpeg(filename)
and not exif_datetime.get_photo_exif(logger, download_path)
):
# %Y:%m:%d looks wrong, but it's the correct format
date_str = created_date.strftime("%Y-%m-%d %H:%M:%S%z")
logger.debug("Setting EXIF timestamp for %s: %s", download_path, date_str)
exif_datetime.set_photo_exif(
logger,
download_path,
created_date.strftime("%Y:%m:%d %H:%M:%S"),
)
if not dry_run:
download.set_utime(download_path, created_date)
logger.info("Downloaded %s", truncated_path)
if xmp_sidecar:
generate_xmp_file(logger, download_path, photo._asset_record, dry_run)
# Also download the live photo if present
if not skip_live_photos:
lp_size = live_photo_size
photo_versions_with_policy = photo.versions_with_raw_policy(raw_policy)
if lp_size in photo_versions_with_policy:
version = photo_versions_with_policy[lp_size]
lp_photo_filename = filename_builder(photo)
lp_filename = calculate_version_filename(
lp_photo_filename,
version,
lp_size,
lp_filename_generator,
photo.item_type,
)
if live_photo_size != LivePhotoVersionSize.ORIGINAL:
# Add size to filename if not original
lp_filename = add_suffix_to_filename(
size_to_suffix(live_photo_size),
lp_filename,
)
else:
pass
lp_download_path = os.path.join(download_dir, lp_filename)
lp_file_exists = os.path.isfile(lp_download_path)
if only_print_filenames:
if not lp_file_exists:
print(lp_download_path)
# Handle deduplication case for only_print_filenames
if (
lp_file_exists
and file_match_policy == FileMatchPolicy.NAME_SIZE_DEDUP_WITH_SUFFIX
):
lp_file_size = os.stat(lp_download_path).st_size
lp_photo_size = version.size
if lp_file_size != lp_photo_size:
lp_download_path = (f"-{lp_photo_size}.").join(
lp_download_path.rsplit(".", 1)
)
logger.debug("%s deduplicated", truncate_middle(lp_download_path, 96))
# Print the deduplicated filename but don't download
print(lp_download_path)
else:
if lp_file_exists:
if file_match_policy == FileMatchPolicy.NAME_SIZE_DEDUP_WITH_SUFFIX:
lp_file_size = os.stat(lp_download_path).st_size
lp_photo_size = version.size
if lp_file_size != lp_photo_size:
lp_download_path = (f"-{lp_photo_size}.").join(
lp_download_path.rsplit(".", 1)
)
logger.debug("%s deduplicated", truncate_middle(lp_download_path, 96))
lp_file_exists = os.path.isfile(lp_download_path)
if lp_file_exists:
logger.debug("%s already exists", truncate_middle(lp_download_path, 96))
if not lp_file_exists:
truncated_path = truncate_middle(lp_download_path, 96)
logger.debug("Downloading %s...", truncated_path)
download_result = download.download_media(
logger,
dry_run,
icloud,
photo,
lp_download_path,
version,
lp_size,
filename_builder,
)
success = download_result and success
if download_result:
logger.info("Downloaded %s", truncated_path)
return success
def delete_photo(
logger: logging.Logger,
library_object: PhotoLibrary,
photo: PhotoAsset,
filename_builder: Callable[[PhotoAsset], str],
) -> None:
"""Delete a photo from the iCloud account."""
clean_filename_local = filename_builder(photo)
logger.debug("Deleting %s in iCloud...", clean_filename_local)
url = (
f"{library_object.service_endpoint}/records/modify?"
f"{urllib.parse.urlencode(library_object.params)}"
)
post_data = json.dumps(
{
"atomic": True,
"desiredKeys": ["isDeleted"],
"operations": [
{
"operationType": "update",
"record": {
"fields": {"isDeleted": {"value": 1}},
"recordChangeTag": photo._asset_record["recordChangeTag"],
"recordName": photo._asset_record["recordName"],
"recordType": "CPLAsset",
},
}
],
"zoneID": library_object.zone_id,
}
)
library_object.session.post(url, data=post_data, headers={"Content-type": "application/json"})
logger.info("Deleted %s in iCloud", clean_filename_local)
def delete_photo_dry_run(
logger: logging.Logger,
library_object: PhotoLibrary,
photo: PhotoAsset,
filename_builder: Callable[[PhotoAsset], str],
) -> None:
"""Dry run for deleting a photo from the iCloud"""
filename = filename_builder(photo)
logger.info(
"[DRY RUN] Would delete %s in iCloud library %s",
filename,
library_object.zone_id["zoneName"],
)
def dump_responses(dumper: Callable[[Any], None], responses: List[Mapping[str, Any]]) -> None:
# dump captured responses
for entry in responses:
# compose(logger.debug, compose(json.dumps, response_to_har))(response)
dumper(json.dumps(entry, indent=2))
def asset_type_skip_message(
desired_item_type: AssetItemType,
filename_builder: Callable[[PhotoAsset], str],
photo: PhotoAsset,
) -> str:
photo_video_phrase = "photos" if desired_item_type == AssetItemType.IMAGE else "videos"
filename = filename_builder(photo)
return f"Skipping {filename}, only downloading {photo_video_phrase}. (Item type was: {photo.item_type})"
def core_single_run(
logger: logging.Logger,
status_exchange: StatusExchange,
global_config: GlobalConfig,
user_config: UserConfig,
password_providers_dict: Dict[
PasswordProvider, Tuple[Callable[[str], str | None], Callable[[str, str], None]]
],
passer: Callable[[PhotoAsset], bool],
downloader: Callable[[PyiCloudService, Counter, PhotoAsset], bool],
notificator: Callable[[], None],
lp_filename_generator: Callable[[str], str],
) -> int:
"""Download all iCloud photos to a local directory for a single execution (no watch loop)"""
skip_bar = not os.environ.get("FORCE_TQDM") and (
global_config.only_print_filenames
or global_config.no_progress_bar
or not sys.stdout.isatty()
)
while True: # retry loop (not watch - only for immediate retries)
captured_responses: List[Mapping[str, Any]] = []
def append_response(captured: List[Mapping[str, Any]], response: Mapping[str, Any]) -> None:
captured.append(response)
try:
icloud = authenticator(
logger,
global_config.domain,
{
provider.value: functions
for provider, functions in password_providers_dict.items()
},
global_config.mfa_provider,
status_exchange,
user_config.username,
notificator,
partial(append_response, captured_responses),
user_config.cookie_directory,
os.environ.get("CLIENT_ID"),
)
# dump captured responses for debugging
# dump_responses(logger.debug, captured_responses)
# turn off response capture
icloud.response_observer = None
if user_config.auth_only:
logger.info("Authentication completed successfully")
return 0
elif user_config.list_libraries:
library_names = (
icloud.photos.private_libraries.keys() | icloud.photos.shared_libraries.keys()
)
print(*library_names, sep="\n")
return 0
else:
# Access to the selected library. Defaults to the primary photos object.
if user_config.library:
if user_config.library in icloud.photos.private_libraries:
library_object: PhotoLibrary = icloud.photos.private_libraries[
user_config.library
]
elif user_config.library in icloud.photos.shared_libraries:
library_object = icloud.photos.shared_libraries[user_config.library]
else:
logger.error("Unknown library: %s", user_config.library)
return 1
else:
library_object = icloud.photos
if user_config.list_albums:
print("Albums:")
album_titles = [str(a) for a in library_object.albums.values()]
print(*album_titles, sep="\n")
return 0
else:
if not user_config.directory:
# should be checked upstream
raise NotImplementedError()
else:
pass
directory = os.path.normpath(user_config.directory)
if user_config.skip_photos or user_config.skip_videos:
photo_video_phrase = "photos" if user_config.skip_videos else "videos"
else:
photo_video_phrase = "photos and videos"
if len(user_config.albums) == 0:
album_phrase = ""
elif len(user_config.albums) == 1:
album_phrase = f" from album {','.join(user_config.albums)}"
else:
album_phrase = f" from albums {','.join(user_config.albums)}"
logger.debug(f"Looking up all {photo_video_phrase}{album_phrase}...")
albums: Iterable[PhotoAlbum] = (
list(map_(library_object.albums.__getitem__, user_config.albums))
if len(user_config.albums) > 0
else [library_object.all]
)
album_lengths: Callable[[Iterable[PhotoAlbum]], Iterable[int]] = partial_1_1(
map_, len
)
def sum_(inp: Iterable[int]) -> int:
return sum(inp)
photos_count: int | None = compose(sum_, album_lengths)(albums)
for photo_album in albums:
photos_enumerator: Iterable[PhotoAsset] = photo_album
# Optional: Only download the x most recent photos.
if user_config.recent is not None:
photos_count = user_config.recent
photos_top: Iterable[PhotoAsset] = itertools.islice(
photos_enumerator, user_config.recent
)
else:
photos_top = photos_enumerator