-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlibrary_sync_review.py
More file actions
1269 lines (1129 loc) · 52.3 KB
/
library_sync_review.py
File metadata and controls
1269 lines (1129 loc) · 52.3 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
"""Review-first Library Sync entry point and session models."""
from __future__ import annotations
import json
import os
import threading
import webbrowser
from dataclasses import dataclass, field
from datetime import datetime
from enum import Enum
from typing import Any, Callable, Dict, Iterable, List, Sequence, Tuple
import tkinter as tk
from tkinter import filedialog, messagebox, ttk
from config import DEFAULT_FP_THRESHOLDS, FORMAT_PRIORITY, load_config, save_config
import library_sync
from indexer_control import IndexCancelled
from library_sync_types import MatchResult, MatchStatus, TrackRecord
from library_sync_review_report import DEFAULT_REPORT_VERSION
from library_sync_review_state import ReviewStateStore
REVIEW_CONFIG_KEY = "library_sync_review"
REVIEW_FLAG_KEY = "use_library_sync_review"
class ScanState(str, Enum):
"""States tracked during a review scan lifecycle."""
IDLE = "idle"
READY = "ready"
SCANNING_LIBRARY = "scanning_library"
SCANNING_INCOMING = "scanning_incoming"
COMPLETE = "complete"
CANCELLED = "cancelled"
@dataclass
class ScanConfig:
"""Global and per-format fingerprint thresholds for a scan."""
global_threshold: float = DEFAULT_FP_THRESHOLDS.get("default", 0.3)
per_format_overrides: Dict[str, float] = field(default_factory=dict)
preset_name: str | None = None
def to_dict(self) -> Dict[str, Any]:
return {
"global_threshold": float(self.global_threshold),
"per_format_overrides": dict(self.per_format_overrides),
"preset_name": self.preset_name,
}
@classmethod
def from_dict(cls, data: Dict[str, Any] | None) -> "ScanConfig":
data = data or {}
overrides = data.get("per_format_overrides") or {}
return cls(
global_threshold=float(data.get("global_threshold", DEFAULT_FP_THRESHOLDS.get("default", 0.3))),
per_format_overrides={str(k): float(v) for k, v in overrides.items()},
preset_name=data.get("preset_name"),
)
@dataclass
class ScanSession:
"""Persisted state for the review-first Library Sync experience."""
library_root: str = ""
incoming_root: str = ""
scan_config: ScanConfig = field(default_factory=ScanConfig)
scan_state: ScanState = ScanState.IDLE
exported_report_version: int = DEFAULT_REPORT_VERSION
transfer_mode: str = "copy"
output_playlist: bool = False
def to_dict(self) -> Dict[str, Any]:
return {
"library_root": self.library_root,
"incoming_root": self.incoming_root,
"scan_config": self.scan_config.to_dict(),
"scan_state": self.scan_state.value,
"exported_report_version": int(self.exported_report_version),
"transfer_mode": self.transfer_mode,
"output_playlist": bool(self.output_playlist),
}
@classmethod
def from_dict(cls, data: Dict[str, Any] | None) -> "ScanSession":
data = data or {}
state_value = data.get("scan_state") or ScanState.IDLE.value
try:
scan_state = ScanState(state_value)
except ValueError:
scan_state = ScanState.IDLE
return cls(
library_root=data.get("library_root", "") or "",
incoming_root=data.get("incoming_root", "") or "",
scan_config=ScanConfig.from_dict(data.get("scan_config")),
scan_state=scan_state,
exported_report_version=int(data.get("exported_report_version", DEFAULT_REPORT_VERSION)),
transfer_mode=str(data.get("transfer_mode", "copy") or "copy").lower(),
output_playlist=bool(data.get("output_playlist", False)),
)
def load_scan_session() -> ScanSession:
"""Load the persisted review scan session from config."""
cfg = load_config()
session = ScanSession.from_dict(cfg.get(REVIEW_CONFIG_KEY))
cfg[REVIEW_CONFIG_KEY] = session.to_dict()
save_config(cfg)
return session
def save_scan_session(session: ScanSession) -> None:
"""Persist the review scan session to config."""
cfg = load_config()
cfg[REVIEW_CONFIG_KEY] = session.to_dict()
save_config(cfg)
def is_review_enabled() -> bool:
"""Return whether the review-first entry point is enabled."""
cfg = load_config()
return bool(cfg.get(REVIEW_FLAG_KEY, False))
def set_review_enabled(enabled: bool) -> None:
"""Toggle the review-first entry point flag."""
cfg = load_config()
cfg[REVIEW_FLAG_KEY] = bool(enabled)
save_config(cfg)
class ReportPreviewDialog(tk.Toplevel):
"""Simple dialog that summarizes report counts before export."""
LABELS = {
"new": "New",
"collisions": "Collisions / Exact Matches",
"low_confidence": "Low Confidence",
"flagged_copy": "Flagged Copy",
"flagged_replace": "Flagged Replace",
}
def __init__(self, master: tk.Misc | None, summary: dict[str, int]):
super().__init__(master)
self.title("Report Preview")
self.resizable(False, False)
self.result = False
self.transient(master)
self.grab_set()
ttk.Label(self, text="Review counts before saving the export report:").pack(
anchor="w", padx=10, pady=(10, 5)
)
for key, label in self.LABELS.items():
row = ttk.Frame(self)
row.pack(fill="x", padx=10, pady=2)
ttk.Label(row, text=f"{label}:").pack(side="left")
ttk.Label(row, text=str(summary.get(key, 0)), font=("TkDefaultFont", 10, "bold")).pack(
side="right"
)
btn_row = ttk.Frame(self)
btn_row.pack(fill="x", padx=10, pady=(10, 10))
ttk.Button(btn_row, text="Save Report", command=self._confirm).pack(side="left")
ttk.Button(btn_row, text="Cancel", command=self._cancel).pack(side="right")
self.protocol("WM_DELETE_WINDOW", self._cancel)
@classmethod
def prompt(cls, master: tk.Misc | None, summary: dict[str, int]) -> bool:
dialog = cls(master, summary)
if master is not None:
master.wait_window(dialog)
else:
dialog.wait_window()
return bool(getattr(dialog, "result", False))
def _confirm(self) -> None:
self.result = True
self.destroy()
def _cancel(self) -> None:
self.result = False
self.destroy()
class LibrarySyncReviewPanel(ttk.Frame):
"""Embeddable preview-first Library Sync UI."""
def __init__(
self,
master: tk.Widget | None = None,
*,
library_root: str | None = None,
incoming_root: str | None = None,
on_close: Callable[[], None] | None = None,
):
super().__init__(master)
self.session = load_scan_session()
if library_root:
self.session.library_root = library_root
if incoming_root:
self.session.incoming_root = incoming_root
self.library_var = tk.StringVar(value=self.session.library_root)
self.incoming_var = tk.StringVar(value=self.session.incoming_root)
self.global_threshold_var = tk.StringVar(value=str(self.session.scan_config.global_threshold))
self.preset_var = tk.StringVar(value=self.session.scan_config.preset_name or "")
self.report_version_var = tk.StringVar(value=str(self.session.exported_report_version))
self.scan_state_var = tk.StringVar(value=self._describe_state(self.session.scan_state))
transfer_mode = (self.session.transfer_mode or "copy").lower()
self.transfer_mode_var = tk.StringVar(value="copy" if transfer_mode == "copy" else "move")
self.output_playlist_var = tk.BooleanVar(value=bool(getattr(self.session, "output_playlist", False)))
self._on_close_callback = on_close
self.library_var.trace_add("write", lambda *_: self._invalidate_plan("Library folder changed"))
self.incoming_var.trace_add("write", lambda *_: self._invalidate_plan("Incoming folder changed"))
# Scan + progress state
self.library_cancel = threading.Event()
self.incoming_cancel = threading.Event()
self.progress_vars: dict[str, tk.DoubleVar] = {
"library": tk.DoubleVar(value=0),
"incoming": tk.DoubleVar(value=0),
}
self.progress_totals: dict[str, int] = {"library": 0, "incoming": 0}
self.progress_labels: dict[str, tk.StringVar] = {
"library": tk.StringVar(value="Idle"),
"incoming": tk.StringVar(value="Idle"),
}
self.partial_labels: dict[str, tk.StringVar] = {
"library": tk.StringVar(value=""),
"incoming": tk.StringVar(value=""),
}
self.phase_labels: dict[str, tk.StringVar] = {
"library": tk.StringVar(value=""),
"incoming": tk.StringVar(value=""),
}
self.partial_flags: dict[str, bool] = {"library": False, "incoming": False}
# Review + matching state
self.state_store = ReviewStateStore()
self.library_records: list[TrackRecord] = []
self.incoming_records: list[TrackRecord] = []
self.match_results: list[MatchResult] = []
self.match_by_incoming: dict[str, MatchResult] = {}
self.match_by_existing: dict[str, list[MatchResult]] = {}
self.library_index: dict[str, TrackRecord] = {}
self.incoming_index: dict[str, TrackRecord] = {}
# Logs
self.log_entries: list[dict[str, object]] = []
self.LOG_LIMIT = 400
# Plan + execution state
self.plan_progress_var = tk.DoubleVar(value=0)
self.plan_progress_label = tk.StringVar(value="Idle")
self.plan_status_var = tk.StringVar(value="No plan built.")
self.plan_cancel = threading.Event()
self.plan_running = False
self.plan_preview_path: str | None = None
self.active_plan: library_sync.LibrarySyncPlan | None = None
self._plan_sources: Tuple[str, str] | None = None
self._plan_version = 0
self._preview_version = -1
self._build_ui()
def _build_ui(self) -> None:
padding = {"padx": 10, "pady": 5}
root = ttk.Frame(self)
root.pack(fill="both", expand=True)
folder_frame = ttk.LabelFrame(root, text="Folders")
folder_frame.pack(fill="x", **padding)
self._add_browse_row(
folder_frame, "Existing Library:", self.library_var, self._browse_library
)
self._add_browse_row(
folder_frame, "Incoming Folder:", self.incoming_var, self._browse_incoming
)
config_frame = ttk.LabelFrame(root, text="Scan Configuration")
config_frame.pack(fill="x", **padding)
config_row = ttk.Frame(config_frame)
config_row.pack(fill="x", padx=5, pady=(5, 0))
ttk.Label(config_row, text="Global Threshold:").pack(side="left")
ttk.Entry(config_row, textvariable=self.global_threshold_var, width=8).pack(
side="left", padx=(5, 12)
)
ttk.Label(config_row, text="Preset Name:").pack(side="left")
ttk.Entry(config_row, textvariable=self.preset_var, width=18).pack(
side="left", padx=(5, 12)
)
ttk.Label(config_row, text="Report Version:").pack(side="left")
ttk.Entry(config_row, textvariable=self.report_version_var, width=6).pack(
side="left", padx=(5, 12)
)
ttk.Label(config_row, text="Scan State:").pack(side="left")
ttk.Label(config_row, textvariable=self.scan_state_var).pack(side="left", padx=(5, 0))
overrides_row = ttk.Frame(config_frame)
overrides_row.pack(fill="x", padx=5, pady=(6, 0))
ttk.Label(overrides_row, text="Per-format overrides (ext=threshold):").pack(
anchor="w"
)
overrides_body = ttk.Frame(config_frame)
overrides_body.pack(fill="x", padx=5, pady=(2, 5))
self.overrides_text = tk.Text(overrides_body, height=4, wrap="none")
overrides_scroll = ttk.Scrollbar(
overrides_body, orient="vertical", command=self.overrides_text.yview
)
self.overrides_text.configure(yscrollcommand=overrides_scroll.set)
self.overrides_text.pack(side="left", fill="both", expand=True)
overrides_scroll.pack(side="right", fill="y")
initial_overrides = self._format_overrides()
if initial_overrides:
self.overrides_text.insert("1.0", initial_overrides)
config_actions = ttk.Frame(config_frame)
config_actions.pack(fill="x", padx=5, pady=(0, 6))
ttk.Button(config_actions, text="Save Session", command=self._persist_session).pack(
side="right"
)
ttk.Button(
config_actions,
text="Recompute Matches",
command=self._refresh_matches,
).pack(side="right", padx=(0, 6))
scan_frame = ttk.LabelFrame(root, text="Scan Progress")
scan_frame.pack(fill="x", **padding)
scan_frame.columnconfigure(0, weight=1)
scan_frame.columnconfigure(1, weight=1)
self._build_scan_column(scan_frame, "Existing Library", "library", 0)
self._build_scan_column(scan_frame, "Incoming Folder", "incoming", 1)
review_frame = ttk.LabelFrame(root, text="Review Results")
review_frame.pack(fill="both", expand=True, **padding)
lists_frame = ttk.Frame(review_frame)
lists_frame.pack(fill="both", expand=True)
lists_frame.columnconfigure(0, weight=1)
lists_frame.columnconfigure(1, weight=1)
incoming_frame = ttk.LabelFrame(lists_frame, text="Incoming Tracks")
incoming_frame.grid(row=0, column=0, sticky="nsew", padx=(5, 5), pady=5)
existing_frame = ttk.LabelFrame(lists_frame, text="Existing Tracks")
existing_frame.grid(row=0, column=1, sticky="nsew", padx=(5, 5), pady=5)
self._build_incoming_tree(incoming_frame)
self._build_existing_tree(existing_frame)
self.match_summary_var = tk.StringVar(value="No matches yet.")
ttk.Label(review_frame, textvariable=self.match_summary_var).pack(
anchor="w", padx=5, pady=(0, 4)
)
inspector_frame = ttk.LabelFrame(review_frame, text="Inspector")
inspector_frame.pack(fill="x", padx=5, pady=(0, 5))
inspector_body = ttk.Frame(inspector_frame)
inspector_body.pack(fill="both", expand=True)
self.inspector_text = tk.Text(inspector_body, height=8, wrap="word", state="disabled")
inspector_scroll = ttk.Scrollbar(
inspector_body, orient="vertical", command=self.inspector_text.yview
)
self.inspector_text.configure(yscrollcommand=inspector_scroll.set)
self.inspector_text.pack(side="left", fill="both", expand=True)
inspector_scroll.pack(side="right", fill="y")
plan_frame = ttk.LabelFrame(root, text="Plan & Execution")
plan_frame.pack(fill="x", **padding)
self._build_plan_controls(plan_frame)
logs_frame = ttk.LabelFrame(root, text="Logs")
logs_frame.pack(fill="both", expand=True, **padding)
logs_actions = ttk.Frame(logs_frame)
logs_actions.pack(fill="x", padx=5, pady=(5, 0))
ttk.Button(logs_actions, text="Export Logs…", command=self._export_logs).pack(
side="right"
)
logs_body = ttk.Frame(logs_frame)
logs_body.pack(fill="both", expand=True, padx=5, pady=(2, 5))
self.log_widget = tk.Text(logs_body, height=10, wrap="word", state="disabled")
log_scroll = ttk.Scrollbar(logs_body, orient="vertical", command=self.log_widget.yview)
self.log_widget.configure(yscrollcommand=log_scroll.set)
self.log_widget.pack(side="left", fill="both", expand=True)
log_scroll.pack(side="right", fill="y")
def _add_browse_row(
self,
parent: ttk.Frame,
label: str,
variable: tk.StringVar,
command,
) -> None:
row = ttk.Frame(parent)
row.pack(fill="x", padx=5, pady=2)
ttk.Label(row, text=label).pack(side="left")
ttk.Entry(row, textvariable=variable).pack(side="left", fill="x", expand=True, padx=(5, 5))
ttk.Button(row, text="Browse…", command=command).pack(side="left")
def _build_scan_column(self, parent: ttk.Frame, title: str, kind: str, column: int) -> None:
col = ttk.Frame(parent)
col.grid(row=0, column=column, sticky="nsew", padx=5, pady=5)
ttk.Label(col, text=title).pack(anchor="w")
ttk.Label(col, textvariable=self.progress_labels[kind]).pack(anchor="w")
ttk.Progressbar(col, variable=self.progress_vars[kind], maximum=1).pack(
fill="x", pady=2
)
ttk.Label(col, textvariable=self.phase_labels[kind], foreground="#555").pack(anchor="w")
ttk.Label(col, textvariable=self.partial_labels[kind], foreground="#a64e00").pack(anchor="w")
btns = ttk.Frame(col)
btns.pack(fill="x", pady=(4, 0))
ttk.Button(btns, text="Scan", command=lambda k=kind: self._start_scan(k)).pack(
side="left"
)
ttk.Button(
btns,
text="Cancel",
command=lambda k=kind: self._cancel_scan(k),
).pack(side="left", padx=(5, 0))
def _build_plan_controls(self, parent: ttk.Frame) -> None:
ttk.Label(parent, textvariable=self.plan_status_var).pack(anchor="w", padx=5, pady=(5, 2))
ttk.Progressbar(parent, variable=self.plan_progress_var, maximum=1).pack(fill="x", padx=5)
ttk.Label(parent, textvariable=self.plan_progress_label, foreground="#555").pack(
anchor="w", padx=5, pady=(0, 5)
)
btns = ttk.Frame(parent)
btns.pack(fill="x", padx=5, pady=(0, 6))
self.build_plan_btn = ttk.Button(btns, text="Build Plan", command=self._build_plan)
self.build_plan_btn.pack(side="left")
self.preview_plan_btn = ttk.Button(btns, text="Preview", command=self._preview_plan)
self.preview_plan_btn.pack(side="left", padx=(5, 0))
self.transfer_mode_btn = ttk.Button(btns, command=self._toggle_transfer_mode)
self.transfer_mode_btn.pack(side="left", padx=(5, 0))
self.execute_plan_btn = ttk.Button(btns, text="Execute", command=self._execute_plan)
self.execute_plan_btn.pack(side="left", padx=(5, 0))
self.playlist_check = ttk.Checkbutton(
btns,
text="Output playlist",
variable=self.output_playlist_var,
command=self._on_output_playlist_toggle,
)
self.playlist_check.pack(side="left", padx=(10, 0))
self.open_preview_btn = ttk.Button(
btns, text="Open Preview", command=self._open_preview_file, state="disabled"
)
self.open_preview_btn.pack(side="right")
self.cancel_plan_btn = ttk.Button(btns, text="Cancel", command=self._cancel_plan_task, state="disabled")
self.cancel_plan_btn.pack(side="right", padx=(5, 0))
self._update_transfer_mode_label()
self._refresh_plan_actions()
def _build_incoming_tree(self, parent: ttk.Frame) -> None:
columns = ("name", "chips", "distance")
tree = ttk.Treeview(parent, columns=columns, show="headings", selectmode="browse")
tree.heading("name", text="Track")
tree.heading("chips", text="Chips")
tree.heading("distance", text="Distance")
tree.column("name", width=200, anchor="w")
tree.column("chips", width=200, anchor="w")
tree.column("distance", width=80, anchor="center")
tree.pack(fill="both", expand=True, padx=5, pady=5)
tree.bind("<<TreeviewSelect>>", self._on_incoming_select)
self.incoming_tree = tree
def _build_existing_tree(self, parent: ttk.Frame) -> None:
columns = ("name", "chips", "incoming_count")
tree = ttk.Treeview(parent, columns=columns, show="headings", selectmode="browse")
tree.heading("name", text="Track")
tree.heading("chips", text="Chips")
tree.heading("incoming_count", text="Best Matches")
tree.column("name", width=200, anchor="w")
tree.column("chips", width=200, anchor="w")
tree.column("incoming_count", width=100, anchor="center")
tree.pack(fill="both", expand=True, padx=5, pady=5)
tree.bind("<<TreeviewSelect>>", self._on_existing_select)
self.existing_tree = tree
def _browse_library(self) -> None:
folder = filedialog.askdirectory(title="Select Library Root", initialdir=self.library_var.get() or None)
if folder:
self.library_var.set(folder)
def _browse_incoming(self) -> None:
folder = filedialog.askdirectory(title="Select Incoming Folder", initialdir=self.incoming_var.get() or None)
if folder:
self.incoming_var.set(folder)
def _format_overrides(self) -> str:
lines = []
for ext, thr in self.session.scan_config.per_format_overrides.items():
lines.append(f"{ext}={thr}")
return "\n".join(lines)
def _parse_overrides(self) -> Dict[str, float] | None:
overrides: Dict[str, float] = {}
raw = self.overrides_text.get("1.0", "end").strip()
if not raw:
return overrides
for line in raw.splitlines():
if "=" not in line:
messagebox.showerror("Invalid Override", f"Expected 'ext=threshold' format, got: {line}")
return None
ext, value = line.split("=", 1)
try:
overrides[ext.strip()] = float(value.strip())
except ValueError:
messagebox.showerror("Invalid Threshold", f"Could not parse threshold for {ext.strip()}: {value}")
return None
return overrides
def _persist_session(self) -> bool:
overrides = self._parse_overrides()
if overrides is None:
return False
try:
global_thr = float(self.global_threshold_var.get())
except ValueError:
messagebox.showerror("Invalid Threshold", "Global threshold must be a number.")
return False
try:
report_ver = int(self.report_version_var.get())
except ValueError:
messagebox.showerror("Invalid Report Version", "Exported report version must be an integer.")
return False
self.session = ScanSession(
library_root=self.library_var.get().strip(),
incoming_root=self.incoming_var.get().strip(),
scan_config=ScanConfig(
global_threshold=global_thr,
per_format_overrides=overrides,
preset_name=self.preset_var.get().strip() or None,
),
scan_state=self.session.scan_state,
exported_report_version=report_ver,
transfer_mode=self._current_transfer_mode(),
output_playlist=bool(self.output_playlist_var.get()),
)
save_scan_session(self.session)
self.scan_state_var.set(self._describe_state(self.session.scan_state))
self._log_event(
"config_change",
"Updated scan configuration",
{
"global_threshold": global_thr,
"overrides": overrides,
"preset": self.preset_var.get().strip() or None,
"report_version": report_ver,
"transfer_mode": self._current_transfer_mode(),
"output_playlist": bool(self.output_playlist_var.get()),
},
)
return True
def _invalidate_plan(self, reason: str | None = None) -> None:
"""Clear any cached plan/preview when inputs change."""
self.active_plan = None
self._plan_sources = None
self.plan_preview_path = None
self._plan_version = 0
self._preview_version = -1
self.plan_progress_var.set(0)
self.plan_progress_label.set("Idle")
if reason:
self.plan_status_var.set(reason)
self._refresh_plan_actions()
def _refresh_matches(self) -> None:
if not self._persist_session():
return
if not self.library_records or not self.incoming_records:
messagebox.showinfo(
"Library Sync",
"Scan both the Existing Library and Incoming Folder before recomputing matches.",
)
return
self._maybe_match()
def _current_transfer_mode(self) -> str:
return "copy" if self.transfer_mode_var.get().lower() == "copy" else "move"
def _update_transfer_mode_label(self) -> None:
label = "Copy Originals" if self._current_transfer_mode() == "copy" else "Move Originals"
self.transfer_mode_btn.config(text=label)
def _toggle_transfer_mode(self) -> None:
new_mode = "move" if self._current_transfer_mode() == "copy" else "copy"
self.transfer_mode_var.set(new_mode)
self._update_transfer_mode_label()
self._invalidate_plan("Transfer mode changed")
self._persist_session()
def _on_output_playlist_toggle(self) -> None:
self._persist_session()
def _refresh_plan_actions(self) -> None:
"""Enable/disable plan controls based on current state."""
running = self.plan_running
library_root = self.library_var.get().strip()
incoming_root = self.incoming_var.get().strip()
sources_match = self._plan_sources == (library_root, incoming_root)
execute_ready = (
not running
and self.active_plan is not None
and self._preview_version == self._plan_version
and sources_match
)
self._update_transfer_mode_label()
for btn in (self.build_plan_btn, self.preview_plan_btn):
btn_state = "disabled" if running else "normal"
btn.config(state=btn_state)
mode_state = "disabled" if running else "normal"
self.transfer_mode_btn.config(state=mode_state)
self.playlist_check.config(state="disabled" if running else "normal")
self.cancel_plan_btn.config(state="normal" if running else "disabled")
self.execute_plan_btn.config(state="normal" if execute_ready else "disabled")
self.open_preview_btn.config(state="normal" if self.plan_preview_path else "disabled")
def _plan_inputs(self) -> Tuple[str, str] | None:
"""Validate folder selections for planning/execution."""
library_root = self.library_var.get().strip()
incoming_root = self.incoming_var.get().strip()
if not library_root or not incoming_root:
messagebox.showerror("Missing Folder", "Select both the Existing Library and Incoming Folder first.")
return None
return library_root, incoming_root
def _update_plan_progress(self, current: int, total: int, path: str, phase: str) -> None:
if total:
self.plan_progress_var.set(current / total)
label = f"{phase.title()}: {os.path.basename(path) if path else ''}".strip()
self.plan_progress_label.set(label or "Working…")
def _start_plan_task(self, render_preview: bool) -> None:
inputs = self._plan_inputs()
if not inputs or self.plan_running:
return
library_root, incoming_root = inputs
self.plan_cancel.clear()
self.plan_running = True
self.plan_progress_var.set(0)
self.plan_progress_label.set("Starting…")
self.plan_status_var.set("Building preview…" if render_preview else "Building plan…")
self._refresh_plan_actions()
transfer_mode = self._current_transfer_mode()
thread = threading.Thread(
target=self._plan_worker,
args=(library_root, incoming_root, transfer_mode, render_preview),
daemon=True,
)
thread.start()
def _plan_worker(self, library_root: str, incoming_root: str, transfer_mode: str, render_preview: bool) -> None:
docs_dir = os.path.join(library_root, "Docs")
os.makedirs(docs_dir, exist_ok=True)
output_html = os.path.join(docs_dir, "LibrarySyncPreview.html")
def log(msg: str) -> None:
self._log_event("plan_log", msg)
def progress(current: int, total: int, path: str, phase: str) -> None:
self.after(0, lambda c=current, t=total, p=path, ph=phase: self._update_plan_progress(c, t, p, ph))
try:
if render_preview:
plan = library_sync.build_library_sync_preview(
library_root,
incoming_root,
output_html,
log_callback=log,
progress_callback=progress,
cancel_event=self.plan_cancel,
transfer_mode=transfer_mode,
)
preview_path = output_html
else:
plan = library_sync.compute_library_sync_plan(
library_root,
incoming_root,
log_callback=log,
progress_callback=progress,
cancel_event=self.plan_cancel,
transfer_mode=transfer_mode,
)
preview_path = None
except IndexCancelled:
self.after(0, self._on_plan_cancelled)
return
except Exception as exc: # pragma: no cover - UI behavior
self.after(0, lambda e=exc: self._handle_plan_error(e))
return
self.after(
0,
lambda p=plan, preview=preview_path, sources=(library_root, incoming_root), render=render_preview: self._on_plan_ready(
p, preview, sources, render
),
)
def _on_plan_ready(
self,
plan: library_sync.LibrarySyncPlan,
preview_path: str | None,
sources: Tuple[str, str],
render_preview: bool,
) -> None:
self.plan_running = False
self.plan_cancel.clear()
self.active_plan = plan
self._plan_sources = sources
self._plan_version += 1
if render_preview:
self._preview_version = self._plan_version
self.plan_preview_path = preview_path
self.plan_status_var.set(f"Preview ready: {preview_path}")
self._log_event(
"plan_preview",
"Preview ready",
{"path": preview_path, "moves": len(plan.moves), "transfer_mode": plan.transfer_mode},
)
if preview_path:
try:
webbrowser.open(preview_path)
except Exception:
pass
else:
self.plan_preview_path = None
self._preview_version = -1
self.plan_status_var.set("Plan built. Run Preview to inspect before execution.")
self._log_event(
"plan_built",
"Plan ready",
{"moves": len(plan.moves), "transfer_mode": plan.transfer_mode},
)
self.plan_progress_var.set(1)
self.plan_progress_label.set("Complete")
self.session.library_root, self.session.incoming_root = sources
save_scan_session(self.session)
self._refresh_plan_actions()
def _handle_plan_error(self, exc: Exception) -> None:
self.plan_running = False
self.plan_cancel.clear()
self.plan_progress_var.set(0)
self.plan_progress_label.set("Error")
self.plan_status_var.set(f"Plan failed: {exc}")
self._log_event("plan_error", str(exc))
messagebox.showerror("Library Sync", str(exc))
self._refresh_plan_actions()
def _on_plan_cancelled(self) -> None:
self.plan_running = False
self.plan_cancel.clear()
self.plan_progress_var.set(0)
self.plan_progress_label.set("Cancelled")
self.plan_status_var.set("Plan cancelled.")
self._log_event("plan_cancelled", "Plan or preview cancelled")
self._refresh_plan_actions()
def _cancel_plan_task(self) -> None:
if self.plan_running:
self.plan_cancel.set()
self.plan_progress_label.set("Cancelling…")
self.plan_status_var.set("Cancellation requested…")
self._log_event("plan_cancel_requested", "Cancellation requested")
else:
self.plan_cancel.clear()
def _build_plan(self) -> None:
self._start_plan_task(render_preview=False)
def _preview_plan(self) -> None:
self._start_plan_task(render_preview=True)
def _open_preview_file(self) -> None:
if not self.plan_preview_path:
messagebox.showinfo("Preview", "No preview has been generated yet.")
return
if not os.path.exists(self.plan_preview_path):
messagebox.showerror("Preview Missing", "The preview file could not be found. Build a new preview.")
return
try:
webbrowser.open(self.plan_preview_path)
except Exception as exc: # pragma: no cover - OS interaction
messagebox.showerror("Preview", str(exc))
def _execute_plan(self) -> None:
if self.plan_running:
return
inputs = self._plan_inputs()
if not inputs:
return
if not self.active_plan:
messagebox.showerror("Library Sync", "Build and preview a plan before executing.")
return
if self._plan_sources != inputs:
messagebox.showerror("Library Sync", "Plan inputs changed. Rebuild and preview the plan before executing.")
return
if self._preview_version != self._plan_version:
messagebox.showerror("Library Sync", "Generate a preview to lock the current plan before execution.")
return
self.plan_cancel.clear()
self.plan_running = True
self.plan_progress_var.set(0)
self.plan_progress_label.set("Executing…")
self.plan_status_var.set("Executing plan…")
self._refresh_plan_actions()
create_playlist = bool(self.output_playlist_var.get())
thread = threading.Thread(
target=self._execute_plan_worker,
args=(self.active_plan, create_playlist),
daemon=True,
)
thread.start()
def _execute_plan_worker(self, plan: library_sync.LibrarySyncPlan, create_playlist: bool) -> None:
def log(msg: str) -> None:
self._log_event("execute_log", msg)
def progress(current: int, total: int, path: str, phase: str) -> None:
self.after(0, lambda c=current, t=total, p=path, ph=phase: self._update_plan_progress(c, t, p, ph))
try:
summary = library_sync.execute_library_sync_plan(
plan,
log_callback=log,
progress_callback=progress,
cancel_event=self.plan_cancel,
create_playlist=create_playlist,
)
except Exception as exc: # pragma: no cover - UI behavior
self.after(0, lambda e=exc: self._handle_plan_error(e))
return
self.after(0, lambda s=summary: self._on_execute_complete(s))
def _on_execute_complete(self, summary: Dict[str, object]) -> None:
self.plan_running = False
self.plan_cancel.clear()
cancelled = bool(summary.get("cancelled"))
moved = int(summary.get("moved", 0))
copied = int(summary.get("copied", 0))
transferred = int(summary.get("transferred", moved + copied))
errors = summary.get("errors", []) or []
playlist_path = summary.get("playlist_path")
if cancelled:
status = "Execution cancelled."
self.plan_progress_var.set(0)
self.plan_progress_label.set("Cancelled")
self._log_event("execute_cancelled", status)
else:
parts = []
if copied:
parts.append(f"Copied {copied}")
if moved:
parts.append(f"Moved {moved}")
if not parts:
parts.append("No files transferred")
status = "Execution complete. " + " and ".join(parts) + "."
self.plan_progress_var.set(1)
self.plan_progress_label.set("Complete")
self._log_event(
"execute_complete",
status,
{"moved": moved, "copied": copied, "transferred": transferred},
)
self.plan_status_var.set(status)
if errors:
messagebox.showerror("Execution Errors", "\n".join(errors))
elif not cancelled:
messagebox.showinfo("Execution Complete", status)
if playlist_path:
self._show_playlist_popup(str(playlist_path))
self._refresh_plan_actions()
def _show_playlist_popup(self, path: str) -> None:
popup = tk.Toplevel(self)
popup.title("Playlist Created")
popup.transient(self.winfo_toplevel())
ttk.Label(popup, text=f"Playlist saved:\n{path}", wraplength=420, justify="left").pack(
padx=12, pady=(12, 8), anchor="w"
)
btns = ttk.Frame(popup)
btns.pack(padx=12, pady=(0, 12), anchor="e")
def copy_path() -> None:
try:
popup.clipboard_clear()
popup.clipboard_append(path)
except Exception:
pass
ttk.Button(btns, text="Copy Path", command=copy_path).pack(side="left")
ttk.Button(btns, text="Close", command=popup.destroy).pack(side="left", padx=(6, 0))
popup.grab_set()
popup.lift()
def _describe_state(self, state: ScanState) -> str:
return state.value.replace("_", " ").title()
def preview_report(self, summary: dict[str, int]) -> bool:
"""Open a modal preview dialog to confirm report export counts."""
return ReportPreviewDialog.prompt(self, summary)
def _on_close(self) -> None:
if self._persist_session() and self._on_close_callback:
self._on_close_callback()
def set_folders(self, library_root: str | None = None, incoming_root: str | None = None) -> None:
"""Update the selected folders, persisting them to the scan session."""
changed = False
if library_root:
self.library_var.set(library_root)
self.session.library_root = library_root
changed = True
if incoming_root:
self.incoming_var.set(incoming_root)
self.session.incoming_root = incoming_root
changed = True
if changed:
save_scan_session(self.session)
# ── Scan + Progress -------------------------------------------------
def _cancel_event_for(self, kind: str) -> threading.Event:
return self.library_cancel if kind == "library" else self.incoming_cancel
def _start_scan(self, kind: str) -> None:
if not self._persist_session():
return
folder = self.library_var.get().strip() if kind == "library" else self.incoming_var.get().strip()
if not folder:
messagebox.showerror("Missing Folder", f"Please choose a {kind} folder before scanning.")
return
cancel_event = self._cancel_event_for(kind)
cancel_event.clear()
self.progress_vars[kind].set(0)
self.progress_totals[kind] = 0
self.progress_labels[kind].set("Scanning…")
self.phase_labels[kind].set("")
self.partial_labels[kind].set("")
self.partial_flags[kind] = False
self.session.scan_state = ScanState.SCANNING_LIBRARY if kind == "library" else ScanState.SCANNING_INCOMING
self.scan_state_var.set(self._describe_state(self.session.scan_state))
self._log_event("scan_start", f"Scanning {folder}", {"kind": kind, "folder": folder})
thread = threading.Thread(target=self._scan_worker, args=(kind, folder, cancel_event), daemon=True)
thread.start()
def _cancel_scan(self, kind: str) -> None:
cancel_event = self._cancel_event_for(kind)
cancel_event.set()
self.partial_labels[kind].set("Cancelling… Partial results will be kept.")
self._log_event("scan_cancel", f"Cancellation requested for {kind}", {"kind": kind})
def _scan_worker(self, kind: str, folder: str, cancel_event: threading.Event) -> None:
db_root = self.library_var.get().strip() or folder
docs_dir = os.path.join(db_root, "Docs")
os.makedirs(docs_dir, exist_ok=True)
db_path = os.path.join(docs_dir, ".soundvault.db")
progress_cb = self._make_progress_handler(kind)
try:
records = library_sync._scan_folder(
folder,
db_path,
log_callback=lambda msg: self._log_scan_message(kind, msg),
progress_callback=progress_cb,
cancel_event=cancel_event,
)
except Exception as exc: # pragma: no cover - UI only
self._log_event("scan_error", str(exc), {"kind": kind})
self.after(0, lambda e=exc: messagebox.showerror("Scan Failed", str(e)))
return
self.after(0, lambda recs=records: self._on_scan_complete(kind, recs))
def _make_progress_handler(self, kind: str):
def handler(current: int, total: int, path: str, phase: str) -> None:
self.after(0, lambda c=current, t=total, p=path, ph=phase: self._update_progress(kind, c, t, p, ph))
return handler
def _update_progress(self, kind: str, current: int, total: int, path: str, phase: str) -> None:
if total:
self.progress_totals[kind] = total
self.progress_vars[kind].set(current / total if total else 0)
label = f"{phase.title()}: {os.path.basename(path) if path else ''}".strip()
self.phase_labels[kind].set(label)
def _on_scan_complete(self, kind: str, records: Sequence[TrackRecord]) -> None: