-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
Copy pathrapid.py
executable file
·7585 lines (6570 loc) · 292 KB
/
rapid.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# Copyright (C) 2011-2021 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/>.
"""
Primary logic for Rapid Photo Downloader.
Qt related class method and variable names use CamelCase.
Everything else should follow PEP 8.
Project line length: 88 characters (i.e. word wrap at 88)
"Hamburger" Menu Icon by Daniel Bruce -- www.entypo.com
"""
__author__ = "Damon Lynch"
__copyright__ = "Copyright 2011-2021, Damon Lynch"
import sys
import logging
import shutil
import datetime
import locale
try:
# Use the default locale as defined by the LANG variable
locale.setlocale(locale.LC_ALL, "")
except locale.Error:
pass
from collections import defaultdict
import platform
import argparse
from typing import Dict, Set, Any, DefaultDict
import faulthandler
import pkg_resources as pkgr
import webbrowser
import time
import shlex
import subprocess
from urllib.request import pathname2url
import inspect
try:
import importlib.metadata as importlib_metadata
except ImportError:
import importlib_metadata
import dateutil
import gi
gi.require_version("Notify", "0.7")
from gi.repository import Notify
try:
gi.require_version("Unity", "7.0")
from gi.repository import Unity
launcher = "net.damonlynch.rapid_photo_downloader.desktop"
Unity.LauncherEntry.get_for_desktop_id(launcher)
have_unity = True
except (ImportError, ValueError, gi.repository.GLib.GError):
have_unity = False
import zmq
import psutil
import arrow
import gphoto2 as gp
from PyQt5 import QtCore
from PyQt5.QtCore import (
QThread,
Qt,
QStorageInfo,
QSettings,
QPoint,
QSize,
QTimer,
QTextStream,
QModelIndex,
pyqtSlot,
QRect,
pyqtSignal,
QLocale,
)
from PyQt5.QtGui import (
QIcon,
QPixmap,
QFontMetrics,
QFont,
QPainter,
QMoveEvent,
QBrush,
QPen,
QColor,
QScreen,
QDesktopServices,
)
from PyQt5.QtWidgets import (
QAction,
QApplication,
QMainWindow,
QMenu,
QWidget,
QProgressBar,
QSplitter,
QHBoxLayout,
QVBoxLayout,
QLabel,
QCheckBox,
QSizePolicy,
QMessageBox,
QSplashScreen,
QStackedWidget,
)
from PyQt5.QtNetwork import QLocalSocket, QLocalServer
# PyQt 5.11 introduces from PyQt5 import sip i.e. from a 'private' sip, unique
# to PyQt5. However we cannot assume that distros will follow this mechanism.
# So as a defensive measure, merely import sip, doing this only after Qt has
# already been imported. See:
# http://pyqt.sourceforge.net/Docs/PyQt5/incompatibilities.html#importing-the-sip-module
import sip
from showinfm import (
valid_file_manager,
linux_desktop,
linux_desktop_humanize,
LinuxDesktop,
)
from raphodo.folderpreviewmanager import FolderPreviewManager
from raphodo.storage import (
ValidMounts,
CameraHotplug,
UDisks2Monitor,
GVolumeMonitor,
have_gio,
has_one_or_more_folders,
mountPaths,
get_desktop_environment,
validate_download_folder,
validate_source_folder,
get_fdo_cache_thumb_base_directory,
WatchDownloadDirs,
get_media_dir,
StorageSpace,
gvfs_gphoto2_path,
)
from raphodo.wsl import (
WslWindowsRemovableDriveMonitor,
WslDrives,
WindowsDriveMount,
WindowsDriveType,
)
from raphodo.interprocess import (
ScanArguments,
CopyFilesArguments,
RenameAndMoveFileData,
BackupArguments,
BackupFileData,
OffloadData,
ProcessLoggingManager,
ThumbnailDaemonData,
ThreadNames,
OffloadManager,
CopyFilesManager,
ThumbnailDaemonManager,
ScanManager,
BackupManager,
stop_process_logging_manager,
RenameMoveFileManager,
create_inproc_msg,
)
from raphodo.devices import (
Device,
DeviceCollection,
BackupDevice,
BackupDeviceCollection,
FSMetadataErrors,
)
from raphodo.preferences import Preferences
from raphodo.constants import (
BackupLocationType,
DeviceType,
FileType,
RenameAndMoveStatus,
ApplicationState,
CameraErrorCode,
TemporalProximityState,
ThumbnailBackgroundName,
BackupFailureType,
DeviceState,
Sort,
Show,
DestinationDisplayType,
DisplayingFilesOfType,
DownloadingFileTypes,
RememberThisMessage,
RightSideButton,
CheckNewVersionDialogState,
CheckNewVersionDialogResult,
RememberThisButtons,
BackupStatus,
CompletedDownloads,
disable_version_check,
ScalingAction,
ScalingDetected,
PostCameraUnmountAction,
)
from raphodo.thumbnaildisplay import (
ThumbnailView,
ThumbnailListModel,
ThumbnailDelegate,
DownloadStats,
MarkedSummary,
)
from raphodo.devicedisplay import DeviceModel, DeviceView, DeviceDelegate
from raphodo.proximity import TemporalProximityGroups, TemporalProximity
from raphodo.utilities import (
same_device,
make_internationalized_list,
thousands,
addPushButtonLabelSpacer,
make_html_path_non_breaking,
prefs_list_from_gconftool2_string,
pref_bool_from_gconftool2_string,
extract_file_from_tar,
format_size_for_user,
is_snap,
version_check_disabled,
installed_using_pip,
getQtSystemTranslation,
process_running,
)
from raphodo.rememberthisdialog import RememberThisDialog
import raphodo.utilities
from raphodo.rpdfile import (
RPDFile,
file_types_by_number,
FileTypeCounter,
Video,
Photo,
FileSizeSum,
)
import raphodo.fileformats as fileformats
import raphodo.downloadtracker as downloadtracker
from raphodo.cache import ThumbnailCacheSql
from raphodo.programversions import gexiv2_version, exiv2_version, EXIFTOOL_VERSION
from raphodo.metadatavideo import pymedia_version_info, libmediainfo_missing
from raphodo.camera import (
gphoto2_version,
python_gphoto2_version,
dump_camera_details,
gphoto2_python_logging,
autodetect_cameras,
)
from raphodo.rpdsql import DownloadedSQL
from raphodo.generatenameconfig import *
from raphodo.rotatedpushbutton import RotatedButton
from raphodo.primarybutton import TopPushButton, DownloadButton
from raphodo.filebrowse import (
FileSystemView,
FileSystemModel,
FileSystemFilter,
FileSystemDelegate,
)
from raphodo.toggleview import QToggleView
import raphodo.__about__ as __about__
import raphodo.iplogging as iplogging
import raphodo.excepthook as excepthook
from raphodo.panelview import QPanelView
from raphodo.computerview import ComputerWidget
from raphodo.destinationdisplay import DestinationDisplay
from raphodo.aboutdialog import AboutDialog
import raphodo.constants as constants
from raphodo.menubutton import MenuButton
from raphodo.renamepanel import RenamePanel
from raphodo.jobcodepanel import JobCodePanel
from raphodo.backuppanel import BackupPanel
import raphodo
import raphodo.exiftool as exiftool
from raphodo.newversion import (
NewVersion,
NewVersionCheckDialog,
version_details,
DownloadNewVersionDialog,
)
from raphodo.chevroncombo import ChevronCombo
from raphodo.preferencedialog import PreferencesDialog
from raphodo.errorlog import ErrorReport, SpeechBubble
from raphodo.problemnotification import Problems, CopyingProblems, BackingUpProblems
from raphodo.viewutils import (
qt5_screen_scale_environment_variable,
validateWindowSizeLimit,
validateWindowPosition,
scaledIcon,
any_screen_scaled,
standardMessageBox,
)
from raphodo import viewutils
import raphodo.didyouknow as didyouknow
from raphodo.thumbnailextractor import gst_version, libraw_version, rawkit_version
from raphodo.heif import have_heif_module, pyheif_version, libheif_version
from raphodo.filesystemurl import FileSystemUrlHandler
import raphodo.storageidevice as storageidevice
# Avoid segfaults at exit:
# http://pyqt.sourceforge.net/Docs/PyQt5/gotchas.html#crashes-on-exit
app = None # type: 'QtSingleApplication'
faulthandler.enable()
logger = None
sys.excepthook = excepthook.excepthook
class RapidWindow(QMainWindow):
"""
Main application window, and primary controller of program logic
Such attributes unfortunately make it very complex.
For better or worse, Qt's state machine technology is not used.
State indicating whether a download or scan is occurring is
thus kept in the device collection, self.devices
"""
checkForNewVersionRequest = pyqtSignal()
downloadNewVersionRequest = pyqtSignal(str, str)
reverifyDownloadedTar = pyqtSignal(str)
udisks2Unmount = pyqtSignal(str)
def __init__(
self,
splash: "SplashScreen",
fractional_scaling: str,
scaling_set: str,
scaling_action: ScalingAction,
scaling_detected: ScalingDetected,
xsetting_running: bool,
force_wayland: bool,
platform_selected: Optional[str],
photo_rename: Optional[bool] = None,
video_rename: Optional[bool] = None,
auto_detect: Optional[bool] = None,
this_computer_source: Optional[str] = None,
this_computer_location: Optional[str] = None,
photo_download_folder: Optional[str] = None,
video_download_folder: Optional[str] = None,
backup: Optional[bool] = None,
backup_auto_detect: Optional[bool] = None,
photo_backup_identifier: Optional[str] = None,
video_backup_identifier: Optional[str] = None,
photo_backup_location: Optional[str] = None,
video_backup_location: Optional[str] = None,
ignore_other_photo_types: Optional[bool] = None,
thumb_cache: Optional[bool] = None,
auto_download_startup: Optional[bool] = None,
auto_download_insertion: Optional[bool] = None,
log_gphoto2: Optional[bool] = None,
) -> None:
super().__init__()
# Indicate not to show any dialogs to the user until the program has finished
# starting
self.on_startup = True
self.splash = splash
if splash.isVisible():
self.screen = splash.windowHandle().screen() # type: QScreen
else:
self.screen = None
self.fractional_scaling_message = fractional_scaling
self.scaling_set_message = scaling_set
# Process Qt events - in this case, possible closing of splash screen
app.processEvents()
# Three values to handle window position quirks under X11:
self.window_show_requested_time = None # type: Optional[datetime.datetime]
self.window_move_triggered_count = 0
self.windowPositionDelta = QPoint(0, 0)
self.setFocusPolicy(Qt.StrongFocus)
self.ignore_other_photo_types = ignore_other_photo_types
self.application_state = ApplicationState.normal
self.prompting_for_user_action = {} # type: Dict[Device, QMessageBox]
self.close_event_run = False
self.file_manager = valid_file_manager()
if platform.system() == "Linux":
self.linux_desktop = linux_desktop()
else:
self.linux_desktop = None
self.fileSystemUrlHandler = FileSystemUrlHandler()
QDesktopServices.setUrlHandler(
"file", self.fileSystemUrlHandler, "openFileBrowser"
)
for version in get_versions(
file_manager=self.file_manager,
scaling_action=scaling_action,
scaling_detected=scaling_detected,
xsetting_running=xsetting_running,
force_wayland=force_wayland,
platform_selected=platform_selected,
):
logging.info("%s", version)
if disable_version_check:
logging.debug("Version checking disabled via code")
if is_snap():
logging.debug("Version checking disabled because running in a snap")
if EXIFTOOL_VERSION is None:
logging.error("ExifTool is either missing or has a problem")
if pymedia_version_info() is None:
if libmediainfo_missing:
logging.error(
"pymediainfo is installed, but the library libmediainfo appears to "
"be missing"
)
self.log_gphoto2 = log_gphoto2 == True
self.setWindowTitle(_("Rapid Photo Downloader"))
# app is a module level global
self.readWindowSettings(app)
self.prefs = Preferences()
self.checkPrefsUpgrade()
self.prefs.program_version = __about__.__version__
if self.linux_desktop and self.linux_desktop == LinuxDesktop.wsl2:
self.wslDrives = WslDrives(rapidApp=self)
self.wslDrives.driveMounted.connect(self.wslWindowsDriveMounted)
self.wslDrives.driveUnmounted.connect(self.wslWindowsDriveUnmounted)
self.is_wsl2 = True
else:
self.is_wsl2 = False
self.iOSInitErrorMessaging()
if self.prefs.force_exiftool:
logging.debug("ExifTool and not Exiv2 will be used to read photo metadata")
# track devices on which there was an error setting a file's filesystem metadata
self.copy_metadata_errors = FSMetadataErrors()
self.backup_metadata_errors = FSMetadataErrors()
if thumb_cache is not None:
logging.debug("Use thumbnail cache: %s", thumb_cache)
self.prefs.use_thumbnail_cache = thumb_cache
self.setupWindow()
splash.setProgress(10)
if photo_rename is not None:
if photo_rename:
self.prefs.photo_rename = PHOTO_RENAME_SIMPLE
else:
self.prefs.photo_rename = self.prefs.rename_defaults["photo_rename"]
if video_rename is not None:
if video_rename:
self.prefs.video_rename = VIDEO_RENAME_SIMPLE
else:
self.prefs.video_rename = self.prefs.rename_defaults["video_rename"]
if auto_detect is not None:
self.prefs.device_autodetection = auto_detect
else:
logging.info("Device autodetection: %s", self.prefs.device_autodetection)
if self.prefs.device_autodetection:
if not self.prefs.scan_specific_folders:
logging.info("Devices do not need specific folders to be scanned")
else:
logging.info(
"For automatically detected devices, only the contents the "
"following folders will be scanned: %s",
", ".join(self.prefs.folders_to_scan),
)
if this_computer_source is not None:
self.prefs.this_computer_source = this_computer_source
if this_computer_location is not None:
self.prefs.this_computer_path = this_computer_location
if self.prefs.this_computer_source:
if self.prefs.this_computer_path:
logging.info(
"This Computer is set to be used as a download source, using: %s",
self.prefs.this_computer_path,
)
else:
logging.info(
"This Computer is set to be used as a download source, but the "
"location is not yet set"
)
else:
logging.info("This Computer is not used as a download source")
if photo_download_folder is not None:
self.prefs.photo_download_folder = photo_download_folder
logging.info("Photo download location: %s", self.prefs.photo_download_folder)
if video_download_folder is not None:
self.prefs.video_download_folder = video_download_folder
logging.info("Video download location: %s", self.prefs.video_download_folder)
if backup is not None:
self.prefs.backup_files = backup
else:
logging.info("Backing up files: %s", self.prefs.backup_files)
if backup_auto_detect is not None:
self.prefs.backup_device_autodetection = backup_auto_detect
elif self.prefs.backup_files:
logging.info(
"Backup device auto detection: %s",
self.prefs.backup_device_autodetection,
)
if photo_backup_identifier is not None:
self.prefs.photo_backup_identifier = photo_backup_identifier
elif self.prefs.backup_files and self.prefs.backup_device_autodetection:
logging.info(
"Photo backup identifier: %s", self.prefs.photo_backup_identifier
)
if video_backup_identifier is not None:
self.prefs.video_backup_identifier = video_backup_identifier
elif self.prefs.backup_files and self.prefs.backup_device_autodetection:
logging.info(
"video backup identifier: %s", self.prefs.video_backup_identifier
)
if photo_backup_location is not None:
self.prefs.backup_photo_location = photo_backup_location
elif self.prefs.backup_files and not self.prefs.backup_device_autodetection:
logging.info("Photo backup location: %s", self.prefs.backup_photo_location)
if video_backup_location is not None:
self.prefs.backup_video_location = video_backup_location
elif self.prefs.backup_files and not self.prefs.backup_device_autodetection:
logging.info("video backup location: %s", self.prefs.backup_video_location)
if auto_download_startup is not None:
self.prefs.auto_download_at_startup = auto_download_startup
elif self.prefs.auto_download_at_startup:
logging.info("Auto download at startup is on")
if auto_download_insertion is not None:
self.prefs.auto_download_upon_device_insertion = auto_download_insertion
elif self.prefs.auto_download_upon_device_insertion:
logging.info("Auto download upon device insertion is on")
if self.prefs.list_not_empty("volume_whitelist"):
logging.info(
"Whitelisted devices: %s", " ; ".join(self.prefs.volume_whitelist)
)
if self.prefs.list_not_empty("volume_blacklist"):
logging.info(
"Blacklisted devices: %s", " ; ".join(self.prefs.volume_blacklist)
)
if self.prefs.list_not_empty("camera_blacklist"):
logging.info(
"Blacklisted cameras: %s", " ; ".join(self.prefs.camera_blacklist)
)
self.prefs.verify_file = False
logging.debug("Starting main ExifTool process")
self.exiftool_process = exiftool.ExifTool()
self.exiftool_process.start()
self.prefs.validate_max_CPU_cores()
self.prefs.validate_ignore_unhandled_file_exts()
# Don't call processEvents() after initiating 0MQ, as it can
# cause "Interrupted system call" errors
app.processEvents()
self.download_paused = False
self.startThreadControlSockets()
self.startProcessLogger()
def checkPrefsUpgrade(self) -> None:
if self.prefs.program_version != __about__.__version__:
previous_version = self.prefs.program_version
if not len(previous_version):
logging.debug("Initial program run detected")
else:
pv = pkgr.parse_version(previous_version)
rv = pkgr.parse_version(__about__.__version__)
if pv < rv:
logging.info(
"Version upgrade detected, from %s to %s",
previous_version,
__about__.__version__,
)
self.prefs.upgrade_prefs(pv)
elif pv > rv:
logging.info(
"Version downgrade detected, from %s to %s",
previous_version,
__about__.__version__,
)
if pv < pkgr.parse_version("0.9.7b1"):
# Remove any duplicate subfolder generation or file renaming custom
# presets
self.prefs.filter_duplicate_generation_prefs()
def startThreadControlSockets(self) -> None:
"""
Create and bind inproc sockets to communicate with threads that
handle inter process communication via zmq.
See 'Signaling Between Threads (PAIR Sockets)' in 'ØMQ - The Guide'
http://zguide.zeromq.org/page:all#toc46
"""
context = zmq.Context.instance()
inproc = "inproc://{}"
self.logger_controller = context.socket(zmq.PAIR)
self.logger_controller.bind(inproc.format(ThreadNames.logger))
self.rename_controller = context.socket(zmq.PAIR)
self.rename_controller.bind(inproc.format(ThreadNames.rename))
self.scan_controller = context.socket(zmq.PAIR)
self.scan_controller.bind(inproc.format(ThreadNames.scan))
self.copy_controller = context.socket(zmq.PAIR)
self.copy_controller.bind(inproc.format(ThreadNames.copy))
self.backup_controller = context.socket(zmq.PAIR)
self.backup_controller.bind(inproc.format(ThreadNames.backup))
self.thumbnail_deamon_controller = context.socket(zmq.PAIR)
self.thumbnail_deamon_controller.bind(
inproc.format(ThreadNames.thumbnail_daemon)
)
self.offload_controller = context.socket(zmq.PAIR)
self.offload_controller.bind(inproc.format(ThreadNames.offload))
self.new_version_controller = context.socket(zmq.PAIR)
self.new_version_controller.bind(inproc.format(ThreadNames.new_version))
def sendStopToThread(self, socket: zmq.Socket) -> None:
socket.send_multipart(create_inproc_msg(b"STOP"))
def sendTerminateToThread(self, socket: zmq.Socket) -> None:
socket.send_multipart(create_inproc_msg(b"TERMINATE"))
def sendStopWorkerToThread(self, socket: zmq.Socket, worker_id: int) -> None:
socket.send_multipart(create_inproc_msg(b"STOP_WORKER", worker_id=worker_id))
def sendStartToThread(self, socket: zmq.Socket) -> None:
socket.send_multipart(create_inproc_msg(b"START"))
def sendStartWorkerToThread(
self, socket: zmq.Socket, worker_id: int, data: Any
) -> None:
socket.send_multipart(
create_inproc_msg(b"START_WORKER", worker_id=worker_id, data=data)
)
def sendResumeToThread(
self, socket: zmq.Socket, worker_id: Optional[int] = None
) -> None:
socket.send_multipart(create_inproc_msg(b"RESUME", worker_id=worker_id))
def sendPauseToThread(self, socket: zmq.Socket) -> None:
socket.send_multipart(create_inproc_msg(b"PAUSE"))
def sendDataMessageToThread(
self, socket: zmq.Socket, data: Any, worker_id: Optional[int] = None
) -> None:
socket.send_multipart(
create_inproc_msg(b"SEND_TO_WORKER", worker_id=worker_id, data=data)
)
def sendToOffload(self, data: Any) -> None:
self.offload_controller.send_multipart(
create_inproc_msg(b"SEND_TO_WORKER", worker_id=None, data=data)
)
def startProcessLogger(self) -> None:
self.loggermq = ProcessLoggingManager()
self.loggermqThread = QThread()
self.loggermq.moveToThread(self.loggermqThread)
self.loggermqThread.started.connect(self.loggermq.startReceiver)
self.loggermq.ready.connect(self.initStage2)
logging.debug("Starting logging subscription manager...")
QTimer.singleShot(0, self.loggermqThread.start)
@pyqtSlot(int)
def initStage2(self, logging_port: int) -> None:
logging.debug("...logging subscription manager started")
self.logging_port = logging_port
self.splash.setProgress(20)
logging.debug("Stage 2 initialization")
if self.prefs.purge_thumbnails:
cache = ThumbnailCacheSql(create_table_if_not_exists=False)
logging.info("Purging thumbnail cache...")
cache.purge_cache()
logging.info("...thumbnail Cache has been purged")
self.prefs.purge_thumbnails = False
# Recreate the cache on the file system
ThumbnailCacheSql(create_table_if_not_exists=True)
elif self.prefs.optimize_thumbnail_db:
cache = ThumbnailCacheSql(create_table_if_not_exists=True)
logging.info("Optimizing thumbnail cache...")
db, fs, size = cache.optimize()
logging.info("...thumbnail cache has been optimized.")
if db:
logging.info("Removed %s files from thumbnail database", db)
if fs:
logging.info("Removed %s thumbnails from file system", fs)
if size:
logging.info(
"Thumbnail database size reduction: %s", format_size_for_user(size)
)
self.prefs.optimize_thumbnail_db = False
else:
# Recreate the cache on the file system
t = ThumbnailCacheSql(create_table_if_not_exists=True)
# For meaning of 'Devices', see devices.py
self.devices = DeviceCollection(self.exiftool_process, self)
self.backup_devices = BackupDeviceCollection(rapidApp=self)
logging.debug("Starting thumbnail daemon model")
self.thumbnaildaemonmqThread = QThread()
self.thumbnaildaemonmq = ThumbnailDaemonManager(logging_port=logging_port)
self.thumbnaildaemonmq.moveToThread(self.thumbnaildaemonmqThread)
self.thumbnaildaemonmqThread.started.connect(self.thumbnaildaemonmq.run_sink)
self.thumbnaildaemonmq.message.connect(self.thumbnailReceivedFromDaemon)
self.thumbnaildaemonmq.sinkStarted.connect(self.initStage3)
QTimer.singleShot(0, self.thumbnaildaemonmqThread.start)
@pyqtSlot()
def initStage3(self) -> None:
logging.debug("Stage 3 initialization")
self.splash.setProgress(30)
self.sendStartToThread(self.thumbnail_deamon_controller)
logging.debug("...thumbnail daemon model started")
self.thumbnailView = ThumbnailView(self)
self.thumbnailModel = ThumbnailListModel(
parent=self, logging_port=self.logging_port, log_gphoto2=self.log_gphoto2
)
self.thumbnailView.setModel(self.thumbnailModel)
self.thumbnailView.setItemDelegate(ThumbnailDelegate(rapidApp=self))
@pyqtSlot(int)
def initStage4(self, frontend_port: int) -> None:
logging.debug("Stage 4 initialization")
self.splash.setProgress(40)
self.sendDataMessageToThread(
self.thumbnail_deamon_controller,
worker_id=None,
data=ThumbnailDaemonData(frontend_port=frontend_port),
)
centralWidget = QWidget()
self.setCentralWidget(centralWidget)
self.temporalProximity = TemporalProximity(rapidApp=self, prefs=self.prefs)
# Respond to the user selecting / deslecting temporal proximity (timeline)
# cells:
self.temporalProximity.proximitySelectionHasChanged.connect(
self.updateThumbnailModelAfterProximityChange
)
self.temporalProximity.temporalProximityView.proximitySelectionHasChanged.connect(
self.updateThumbnailModelAfterProximityChange
)
# Setup notification system
if self.is_wsl2:
self.have_libnotify = False
else:
try:
self.have_libnotify = Notify.init(_("Rapid Photo Downloader"))
except:
logging.error("Notification intialization problem")
self.have_libnotify = False
logging.debug("Locale directory: %s", raphodo.localedir)
# Initialise use of libgphoto2
logging.debug("Getting gphoto2 context")
try:
self.gp_context = gp.Context()
except:
logging.critical("Error getting gphoto2 context")
self.gp_context = None
logging.debug("Probing for valid mounts")
self.validMounts = ValidMounts(
only_external_mounts=self.prefs.only_external_mounts
)
logging.debug(
"Freedesktop.org thumbnails location: %s",
get_fdo_cache_thumb_base_directory(),
)
self.unity_progress = False
self.desktop_launchers = []
if have_unity:
logging.info("Unity LauncherEntry API installed")
launchers = ("net.damonlynch.rapid_photo_downloader.desktop",)
for launcher in launchers:
desktop_launcher = Unity.LauncherEntry.get_for_desktop_id(launcher)
if desktop_launcher is not None:
self.desktop_launchers.append(desktop_launcher)
self.unity_progress = True
if not self.desktop_launchers:
logging.warning(
"Desktop environment is Unity Launcher API compatible, but could "
"not find program's .desktop file"
)
else:
logging.debug(
"Unity progress indicator found, using %s launcher(s)",
len(self.desktop_launchers),
)
self.createPathViews()
self.createActions()
logging.debug("Laying out main window")
self.createMenus()
self.createLayoutAndButtons(centralWidget)
self.startMountMonitor()
if version_check_disabled():
logging.debug("Version check disabled")
else:
logging.debug("Starting version check")
self.newVersion = NewVersion(self)
self.newVersionThread = QThread()
self.newVersionThread.started.connect(self.newVersion.start)
self.newVersion.checkMade.connect(self.newVersionCheckMade)
self.newVersion.bytesDownloaded.connect(self.newVersionBytesDownloaded)
self.newVersion.fileDownloaded.connect(self.newVersionDownloaded)
self.reverifyDownloadedTar.connect(self.newVersion.reVerifyDownload)
self.newVersion.downloadSize.connect(self.newVersionDownloadSize)
self.newVersion.reverified.connect(self.installNewVersion)
self.newVersion.moveToThread(self.newVersionThread)
QTimer.singleShot(0, self.newVersionThread.start)
self.newVersionCheckDialog = NewVersionCheckDialog(self)
self.newVersionCheckDialog.finished.connect(
self.newVersionCheckDialogFinished
)
# if values set, indicates the latest version of the program, and the main
# download page on the Rapid Photo Downloader website
self.latest_version = None # type: version_details
self.latest_version_download_page = None # type: str
# Track the creation of temporary directories
self.temp_dirs_by_scan_id = {}
# Track the time a download commences - used in file renaming
self.download_start_datetime = None # type: Optional[datetime.datetime]
# The timestamp for when a download started / resumed after a pause
self.download_start_time = None # type: Optional[float]
logging.debug("Starting download tracker")
self.download_tracker = downloadtracker.DownloadTracker()
# Values used to display how much longer a download will take
self.time_remaining = downloadtracker.TimeRemaining()
self.time_check = downloadtracker.TimeCheck()
logging.debug("Setting up download update timer")
self.dl_update_timer = QTimer(self)
self.dl_update_timer.setInterval(constants.DownloadUpdateMilliseconds)
self.dl_update_timer.timeout.connect(self.displayDownloadRunningInStatusBar)
# Offload process is used to offload work that could otherwise
# cause this process and thus the GUI to become unresponsive
logging.debug("Starting offload manager...")
self.offloadThread = QThread()
self.offloadmq = OffloadManager(logging_port=self.logging_port)
self.offloadThread.started.connect(self.offloadmq.run_sink)
self.offloadmq.sinkStarted.connect(self.initStage5)
self.offloadmq.message.connect(self.proximityGroupsGenerated)
self.offloadmq.moveToThread(self.offloadThread)
QTimer.singleShot(0, self.offloadThread.start)
@pyqtSlot()
def initStage5(self) -> None:
logging.debug("...offload manager started")
self.sendStartToThread(self.offload_controller)
self.splash.setProgress(50)
self.folder_preview_manager = FolderPreviewManager(
fsmodel=self.fileSystemModel,
prefs=self.prefs,
photoDestinationFSView=self.photoDestinationFSView,
videoDestinationFSView=self.videoDestinationFSView,
devices=self.devices,
rapidApp=self,
)
self.offloadmq.downloadFolders.connect(
self.folder_preview_manager.folders_generated
)
self.renameThread = QThread()
self.renamemq = RenameMoveFileManager(logging_port=self.logging_port)
self.renameThread.started.connect(self.renamemq.run_sink)
self.renamemq.sinkStarted.connect(self.initStage6)
self.renamemq.message.connect(self.fileRenamedAndMoved)
self.renamemq.sequencesUpdate.connect(self.updateSequences)
self.renamemq.renameProblems.connect(self.addErrorLogMessage)
self.renamemq.moveToThread(self.renameThread)
logging.debug("Starting rename manager...")
QTimer.singleShot(0, self.renameThread.start)
@pyqtSlot()
def initStage6(self) -> None:
logging.debug("...rename manager started")
self.splash.setProgress(60)
self.sendStartToThread(self.rename_controller)
# Setup the scan processes
self.scanThread = QThread()
self.scanmq = ScanManager(logging_port=self.logging_port)
self.scanThread.started.connect(self.scanmq.run_sink)
self.scanmq.sinkStarted.connect(self.initStage7)
self.scanmq.scannedFiles.connect(self.scanFilesReceived)
self.scanmq.deviceError.connect(self.scanErrorReceived)
self.scanmq.deviceDetails.connect(self.scanDeviceDetailsReceived)
self.scanmq.scanProblems.connect(self.scanProblemsReceived)
self.scanmq.workerFinished.connect(self.scanFinished)
self.scanmq.fatalError.connect(self.scanFatalError)
self.scanmq.cameraRemovedDuringScan.connect(self.cameraRemovedDuringScan)
self.scanmq.moveToThread(self.scanThread)