-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetMusicFileProperties.py
More file actions
1127 lines (1007 loc) · 53.6 KB
/
Copy pathsetMusicFileProperties.py
File metadata and controls
1127 lines (1007 loc) · 53.6 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
#!python3
# -*- coding: utf-8 -*-
import os, sys, pathlib, datetime, re, argparse, stat, sqlite3
from typing import Any, Iterable, List, Iterator
from tabulate import tabulate # https://pypi.org/project/tabulate/
from operator import attrgetter
from ackPyHelpers import LogHelper, FileHelpers
from musicFileProperties import MusicFileProperties, TagNames, TagType
_myMusicBaseFolder = pathlib.Path(pathlib.Path.home() / "Music/MyMusic")
_musicAttributesDbPath = _myMusicBaseFolder / "musicAttributes.sqlite"
_defaultTableFormat = "presto"#"simple"
class DbRowHelper:
def __init__(self, row : sqlite3.Row):
self._row = row
@staticmethod
def EnumRows(rowList):
for row in rowList:
yield DbRowHelper(row)
@property
def DbId(self):
return self._row["MusicFileAttributesId"]
@property
def FilePath(self):
return f"{self.Folder}\\{self.Filename}{self.Extension}"
@property
def Folder(self):
return self._row["Folder"]
@property
def Filename(self):
return self._row["Filename"]
@property
def Extension(self):
return self._row["Extension"]
@property
def ModifyTimeUTC(self):
return self._row["ModifyTimeUTC"]
@property
def AlbumTitle(self):
return self._row["AlbumTitle"]
@property
def AlbumArtist(self):
return self._row["AlbumArtist"]
@property
def TrackArtist(self):
return self._row["TrackArtist"]
@property
def TrackTitle(self):
return self._row["TrackTitle"]
@property
def TrackNumber(self):
return self._row["TrackNumber"]
@property
def Year(self):
return self._row["Year"]
@property
def Composer(self):
return self._row["Composer"]
@property
def Producer(self):
return self._row["Producer"]
@property
def Conductor(self):
return self._row["Conductor"]
@property
def Copyright(self):
return self._row["Copyright"]
@property
def Publisher(self):
return self._row["Publisher"]
@property
def Lyrics(self):
return self._row["Lyrics"]
@property
def Comments(self):
return self._row["Comments"]
@property
def OriginalArtist(self):
return self._row["OriginalArtist"]
@property
def OriginalAlbum(self):
return self._row["OriginalAlbum"]
@property
def OriginalYear(self):
return self._row["OriginalYear"]
@property
def Genre(self):
return self._row["Genre"]
class PlaylistEntry:
def __init__(self, mf : MusicFileProperties, filename : str):
self.discNumber = int(mf.DiscNumber[0]) if len(mf.DiscNumber) > 0 else 0
self.trackNumber = int(mf.TrackNumber[0]) if len(mf.TrackNumber) > 0 else 0
self.trackArtist = "/".join(mf.TrackArtist)
self.trackTitle = mf.TrackTitle[0] if len(mf.TrackTitle) > 0 else ""
self.filename = filename
self.duration = mf.DurationSeconds
class ApprovedTagsList:
# TODO??: this is only being used now for after we clean junk tags from a file to show
# a list of tags in the file we weren't expecting; is there a better way to do this?
# and it doesn't really need to be a dict anymore either (not just doing M4A anymore...); just a set or list would be fine
def __init__(self) -> None:
self._tags = {
TagNames.AlbumTitle.upper(): TagNames.AlbumTitle,
TagNames.TrackTitle.upper(): TagNames.TrackTitle,
TagNames.AlbumArtist.upper(): TagNames.AlbumArtist,
TagNames.TrackArtist.upper(): TagNames.TrackArtist,
TagNames.YearReleased.upper(): TagNames.YearReleased,
TagNames.Composer.upper(): TagNames.Composer,
TagNames.Comment.upper(): TagNames.Comment,
TagNames.TrackNumber.upper(): TagNames.TrackNumber,
TagNames.TrackCount.upper(): TagNames.TrackCount,
TagNames.DiscNumber.upper(): TagNames.DiscNumber,
TagNames.DiscCount.upper(): TagNames.DiscCount,
TagNames.DiscSubTitle.upper(): TagNames.DiscSubTitle,
TagNames.Copyright.upper(): TagNames.Copyright,
TagNames.Conductor.upper(): TagNames.Conductor,
TagNames.Lyrics.upper(): TagNames.Lyrics,
TagNames.Writer.upper(): TagNames.Writer,
TagNames.Producer.upper(): TagNames.Producer,
TagNames.Engineer.upper(): TagNames.Engineer,
TagNames.MixedBy.upper(): TagNames.MixedBy,
TagNames.RemixedBy.upper(): TagNames.RemixedBy,
TagNames.Arranger.upper(): TagNames.Arranger,
TagNames.RecordLabel.upper(): TagNames.RecordLabel,
TagNames.Lyricist.upper(): TagNames.Lyricist,
TagNames.Language.upper(): TagNames.Language,
TagNames.OriginalAlbumTitle.upper(): TagNames.OriginalAlbumTitle,
TagNames.OriginalArtist.upper(): TagNames.OriginalArtist,
TagNames.OriginalReleaseYear.upper(): TagNames.OriginalReleaseYear,
TagNames.ReplayGainTrackGain.upper(): TagNames.ReplayGainTrackGain,
TagNames.ReplayGainTrackPeak.upper(): TagNames.ReplayGainTrackPeak,
TagNames.ReplayGainAlbumGain.upper(): TagNames.ReplayGainAlbumGain,
TagNames.ReplayGainAlbumPeak.upper(): TagNames.ReplayGainAlbumPeak,
TagNames.R128TrackGain.upper(): TagNames.R128TrackGain,
TagNames.R128AlbumGain.upper(): TagNames.R128AlbumGain,
TagNames.MusicBrainzDiscId.upper(): TagNames.MusicBrainzDiscId,
TagNames.MusicBrainzAlbumId.upper(): TagNames.MusicBrainzAlbumId,
TagNames.MusicBrainzTrackArtistId.upper(): TagNames.MusicBrainzTrackArtistId,
TagNames.MusicBrainzAlbumArtistId.upper(): TagNames.MusicBrainzAlbumArtistId,
TagNames.MusicBrainzTrackId.upper(): TagNames.MusicBrainzTrackId,
TagNames.MusicBrainzReleaseTrackId.upper(): TagNames.MusicBrainzReleaseTrackId,
TagNames.MusicBrainzAlbumReleaseCountry.upper(): TagNames.MusicBrainzAlbumReleaseCountry,
TagNames.MusicBrainzReleaseGroupId.upper(): TagNames.MusicBrainzReleaseGroupId,
TagNames.MusicBrainzReleaseType.upper(): TagNames.MusicBrainzReleaseType,
TagNames.MusicBrainzReleaseStatus.upper(): TagNames.MusicBrainzReleaseStatus,
TagNames.MediaType.upper(): TagNames.MediaType,
TagNames.MusicBrainzWorkId.upper(): TagNames.MusicBrainzWorkId,
TagNames.WorkTitle.upper(): TagNames.WorkTitle,
TagNames.AcoustidId.upper(): TagNames.AcoustidId,
TagNames.ISRC.upper(): TagNames.ISRC,
TagNames.Barcode.upper(): TagNames.Barcode,
TagNames.CatalogNumber.upper(): TagNames.CatalogNumber,
TagNames.AmazonId.upper(): TagNames.AmazonId,
TagNames.RecordLabel.upper(): TagNames.RecordLabel,
TagNames.MusicianCredits.upper(): TagNames.MusicianCredits,
TagNames.InvolvedPeople.upper(): TagNames.InvolvedPeople,
TagNames.DigitalPurchaseFrom.upper(): TagNames.DigitalPurchaseFrom,
TagNames.DigitalPurchaseDate.upper(): TagNames.DigitalPurchaseDate,
TagNames.DigitalPurchaseId.upper(): TagNames.DigitalPurchaseId,
TagNames.RecordedDate.upper(): TagNames.RecordedDate,
TagNames.ReleasedDate.upper(): TagNames.ReleasedDate,
TagNames.AllMusicArtistId.upper(): TagNames.AllMusicArtistId,
TagNames.AllMusicAlbumId.upper(): TagNames.AllMusicAlbumId,
TagNames.WikidataArtistId.upper(): TagNames.WikidataArtistId,
TagNames.WikidataAlbumId.upper(): TagNames.WikidataAlbumId,
TagNames.WikipediaArtistId.upper(): TagNames.WikipediaArtistId,
TagNames.WikipediaAlbumId.upper(): TagNames.WikipediaAlbumId,
TagNames.IMDbArtistId.upper(): TagNames.IMDbArtistId,
TagNames.DiscogsReleaseId.upper(): TagNames.DiscogsReleaseId,
TagNames.DiscogsArtistId.upper(): TagNames.DiscogsArtistId,
TagNames.DiscogsAlbumId.upper(): TagNames.DiscogsAlbumId,
}
def __len__(self) -> int:
return len(self._tags)
def __contains__(self, key : str) -> bool:
return key and key.upper() in self._tags
def __iter__(self) -> Iterator[str]:
for v in self._tags.values(): # should we just return the .values()?
yield v
class MusicFolderHandler:
#region class fields
_supportedFileTypesForCopy: list[str] = [".m4a", ".opus", ".wma", ".flac", ".oga", ".ogg", ".ape",] # ".mp3", ".wav",]
_supportedFileTypesGlob: list[str] = ["*.m4a", "*.opus", "*.wma", "*.flac", "*.oga", "*.ogg", "*.ape",] # "*.mp3", "*.wav",]
_disableWriteAccess = (stat.S_ISUID|stat.S_ISGID|stat.S_ISVTX|stat.S_IRWXU|stat.S_IRWXG|stat.S_IRWXO) ^ (stat.S_IWRITE|stat.S_IWGRP|stat.S_IWOTH)
_commentsProducerRegex = re.compile(r"produce(r|d)", re.IGNORECASE)
_composerRegex = re.compile(r"\s*(;|/)\s*")
_badCharsRegex = re.compile(r"[‘’“”\u2014\u2013\u2010]")
#_fancySingleQuotesRegex = re.compile(r"[‘’]")
#_fancyDoubleQuotesRegex = re.compile(r"[“”]")
_badQuotesRegex = re.compile(r"[‘’“”]")
#_badDashesRegex = re.compile(r"[\—\–\‐]") # m-dash, n-dash, hyphen
_badDashesRegex = re.compile(r"[\u2014\u2013\u2010]") # m-dash, n-dash, hyphen
_badFilenameCharsRegex = re.compile(r"[<>\\/\|\*\?:\"]")
_tagsToCopy = [ TagNames.AlbumTitle, TagNames.TrackTitle, TagNames.AlbumArtist, TagNames.TrackArtist, TagNames.YearReleased,
TagNames.Conductor, TagNames.Copyright, TagNames.RecordLabel, TagNames.Lyrics, TagNames.Composer,
TagNames.Lyricist, TagNames.Writer, TagNames.Producer, TagNames.Comment, TagNames.TrackNumber, TagNames.TrackCount,
TagNames.DiscNumber, TagNames.DiscCount, TagNames.DiscSubTitle, TagNames.MovementNumber, TagNames.MovementCount, TagNames.MovementName,
TagNames.Barcode, TagNames.CatalogNumber, TagNames.OriginalArtist, TagNames.OriginalAlbumTitle, TagNames.OriginalReleaseYear,
TagNames.MusicianCredits, TagNames.Engineer, TagNames.MixedBy, TagNames.Arranger, TagNames.RemixedBy,
TagNames.RecordedDate, TagNames.ReleasedDate, TagNames.MediaType, TagNames.ISRC,
TagNames.MusicBrainzAlbumArtistId, TagNames.MusicBrainzAlbumId, TagNames.MusicBrainzAlbumReleaseCountry,
TagNames.MusicBrainzReleaseStatus, TagNames.MusicBrainzDiscId, TagNames.MusicBrainzReleaseGroupId,
TagNames.MusicBrainzReleaseTrackId, TagNames.MusicBrainzTrackArtistId, TagNames.MusicBrainzTrackId,
TagNames.MusicBrainzWorkId, TagNames.WorkTitle, TagNames.DiscogsReleaseId, TagNames.AmazonId,
TagNames.DigitalPurchaseFrom, TagNames.DigitalPurchaseDate, TagNames.DigitalPurchaseId,
TagNames.AllMusicArtistId, TagNames.AllMusicAlbumId, TagNames.WikidataArtistId, TagNames.WikidataAlbumId,
TagNames.WikipediaArtistId, TagNames.WikipediaAlbumId, TagNames.IMDbArtistId, TagNames.AcoustidId,
TagNames.DiscogsArtistId, TagNames.DiscogsAlbumId, ]
_junkTagsToClean = [ TagNames.iTunSMPB, TagNames.Genre, TagNames.Cover, TagNames.Codec, TagNames.Encoder, TagNames.EncodedBy,
TagNames.EncodingSettings, TagNames.Source, TagNames.RippingTool, TagNames.RipDate,
TagNames.UPC, TagNames.Rating, TagNames.Script, TagNames.Artists,
TagNames.Performer, TagNames.OriginalReleaseDate, # think we've got a conflict with names from Picard and what i'm adding in Mp3tag ??
TagNames.OriginalReleaseYear, TagNames.AlbumTitleSort, TagNames.TrackTitleSort, TagNames.AlbumArtistSort,
TagNames.TrackArtistSort, TagNames.ComposerSort, TagNames.FileOwner, TagNames.OriginalFileName, ]
_extraJunkTagsByType: dict[str, list[str]] = {
# ".opus": [ TagNames.ReplayGainAlbumGain, TagNames.ReplayGainTrackGain, ] # TrackPeak, maybe AlbumPeak, can still get added by ReplayGain => let's keep them
}
_tagsToRename = [ TagNames.MusicBrainzReleaseType,
TagNames.MusicBrainzReleaseStatus, TagNames.MusicBrainzAlbumReleaseCountry, TagNames.MusicBrainzWorkId,
TagNames.MusicBrainzTrackId, TagNames.MusicBrainzReleaseTrackId, TagNames.MusicBrainzReleaseGroupId,
TagNames.MusicBrainzDiscId, TagNames.MusicBrainzTrackArtistId, TagNames.MusicBrainzAlbumId,
TagNames.MusicBrainzAlbumArtistId, TagNames.DiscSubTitle, TagNames.Lyrics, ]
_approvedTags = ApprovedTagsList()
_keepOnCleanAll = [ TagNames.AlbumTitle, TagNames.TrackTitle, TagNames.AlbumArtist, TagNames.TrackArtist, TagNames.TrackNumber,
TagNames.ReplayGainTrackGain, TagNames.ReplayGainTrackPeak, TagNames.ReplayGainAlbumGain, TagNames.ReplayGainAlbumPeak,
TagNames.R128TrackGain, TagNames.R128AlbumGain, ]
_approvedTagsNativeNamesCache: dict[TagType, list[str]] = dict()
_keepOnCleanNativeNamesCache: dict[TagType, list[str]] = dict()
#endregion
def __init__(self, folderPath : pathlib.Path = None, targetFolderPath : pathlib.Path = None, sourceFolderPath : pathlib.Path = None,
createPlaylist : bool = False, onlyPlaylist : bool = False, playlistName : str = None, onlyTimestamp : bool = False, enableSimpleLookup : bool = False,
whatIf : bool = False):
self._folderPath = folderPath
self._targetFolderPath = targetFolderPath
self._sourceFolderPath = sourceFolderPath
self._playlist = createPlaylist
self._onlyPlaylist = onlyPlaylist
self._playlistName = playlistName
self._onlyTimestamp = onlyTimestamp
self._enableSimpleLookup = enableSimpleLookup
self._whatIf = whatIf
# @deprecated("we're not using this any more, right?")
def SetFolderFilesFromDb(self):
#
# TODO: get rid of this and all the DB stuff; not needed anymore
___obsolete___ # if we try to use this function, blow up
#
renamedFolder = MusicFolderHandler._cleanUpPathNames(self._folderPath, self._whatIf)
if renamedFolder:
self._folderPath = renamedFolder
if not self._onlyPlaylist:
with sqliteConnHelper(_musicAttributesDbPath) as conn:
for f in self._folderPath.glob("*.m4a"):
mf = MusicFileProperties(f)
self._setMusicFileFromDb(mf, conn)
if (self._playlist or self._onlyPlaylist) and not self._onlyTimestamp:
MusicFolderHandler._createPlaylist(self._folderPath, self._playlistName, self._whatIf)
def CreatePlaylist(self):
renamedFolder = MusicFolderHandler._cleanUpPathNames(self._folderPath, self._whatIf)
if renamedFolder:
self._folderPath = renamedFolder
MusicFolderHandler._createPlaylist(self._folderPath, self._playlistName, self._whatIf)
def CopyFolderProperties(self, noRenames: bool = False, tweakModTimeBySecs: int = 0, keepTags: bool = False, onlyJunkTags: bool = False) -> int:
if not noRenames:
self.CleanUpPathNames()
filesNotFound = 0
for tf in FileHelpers.MultiGlob(self._targetFolderPath, MusicFolderHandler._supportedFileTypesGlob):
sf = self._sourceFolderPath / tf.name
if not sf.is_file():
origExt = sf.suffix
for ext in MusicFolderHandler._supportedFileTypesForCopy:
if ext != origExt:
sf = sf.with_suffix(ext)
if sf.is_file(): break
if not sf.is_file():
LogHelper.Warning(f'no source file found for file "{tf.name}"')
filesNotFound += 1
continue
trg = MusicFileProperties(tf)
src = MusicFileProperties(sf)
self._copyFileProperties(trg, src, tweakModTimeBySecs=tweakModTimeBySecs, keepTags=keepTags, onlyJunkTags=onlyJunkTags)
return 1 if filesNotFound > 0 else 0
def CleanFolderFiles(self, onlyJunkTags: bool = False, extraTagsToClean: list[str] = None) -> int:
"""returns 0 if no issues, or 1 if anything like unexpected tags"""
renamedFolder = MusicFolderHandler._cleanUpPathNames(self._folderPath, self._whatIf)
if renamedFolder:
self._folderPath = renamedFolder
result = 0
for f in FileHelpers.MultiGlob(self._folderPath, MusicFolderHandler._supportedFileTypesGlob):
mf = MusicFileProperties(f)
tmpResult = self._cleanFile(mf, onlyJunkTags, extraTagsToClean)
if tmpResult > result: result = tmpResult
return result
def CleanFile(self, filePath : pathlib.Path, onlyJunkTags: bool = False, extraTagsToClean: list[str] = None) -> int:
"""returns 0 if no issues, or 1 if anything like unexpected tags"""
mf = MusicFileProperties(filePath)
return self._cleanFile(mf, onlyJunkTags, extraTagsToClean)
def CleanUpPathNames(self) -> int:
renamedFolder = MusicFolderHandler._cleanUpPathNames(self._targetFolderPath, self._whatIf)
if renamedFolder:
self._targetFolderPath = renamedFolder
return 0
def _saveFile(self, musicFile: MusicFileProperties, originalLastModTime: float, originalLastAccessTime: float, quiet: bool, ignoreOnlyTimestamp: bool) -> None:
if not musicFile.HasChanges:
LogHelper.Verbose('no changes in file "{0}"', musicFile.FilePath.name)
return
if self._whatIf:
LogHelper.WhatIf(f'saving changes to file "{musicFile.FilePath.name}"')
else:
if quiet:
LogHelper.Verbose(f'saving changes to file "{musicFile.FilePath.name}"')
else:
LogHelper.Message(f'saving changes to file "{musicFile.FilePath.name}"')
musicFile.FilePath.chmod(musicFile.FilePath.stat().st_mode | stat.S_IWRITE) # make sure it's NOT readonly
if ignoreOnlyTimestamp or not self._onlyTimestamp:
musicFile.save(True)
os.utime(musicFile.FilePath, (originalLastAccessTime, originalLastModTime))
musicFile.FilePath.chmod(musicFile.FilePath.stat().st_mode & MusicFolderHandler._disableWriteAccess) # now make sure it IS readonly
def _copyFileProperties(self, targetMusicFile : MusicFileProperties, sourceMusicFile : MusicFileProperties, tweakModTimeBySecs: int = 0,
forceOverwrite: bool = False, keepTags: bool = False, onlyJunkTags: bool = False):
lastModTime = os.path.getmtime(sourceMusicFile.FilePath) + tweakModTimeBySecs
currLastAccessTime = os.path.getatime(targetMusicFile.FilePath)
if not keepTags:
if onlyJunkTags:
self._cleanJunkProperties(targetMusicFile)
else:
self._cleanAllTags(targetMusicFile)
LogHelper.Verbose('starting copy of tags from "{0}" to "{1}"', sourceMusicFile.FilePath, targetMusicFile.FilePath)
for tag in MusicFolderHandler._tagsToCopy:
LogHelper.Verbose('>>> copying tag "{0}" from source (if present)', tag)
self._copyTag(tag, sourceMusicFile, targetMusicFile)
self._saveFile(targetMusicFile, lastModTime, currLastAccessTime, False, True)
# @deprecated("we're not using this any more, right?")
def _setMusicFileFromDb(self, musicFile : MusicFileProperties, sqliteConn : sqlite3.Connection):
#
# this should be updated, if we ever use it again...; or just get rid of it...
___obsolete___
#
lastModTime = os.path.getmtime(musicFile.FilePath)
currLastAccessTime = os.path.getatime(musicFile.FilePath)
if not self._onlyTimestamp:
self._cleanJunkProperties(musicFile)
resultRows = []
resultsCount = 0
with sqliteCursorHelper(sqliteConn) as curs:
LogHelper.Verbose(f"doing db query: AlbumArtist: '{musicFile.AlbumArtist}' / AlbumTitle: '{musicFile.AlbumTitle}' / TrackArtist: '{musicFile.TrackArtist}' / TrackTitle: '{musicFile.TrackTitle}'")
queryHelper().doMusicFileDbQuery(curs, musicFile.TrackArtist, musicFile.AlbumArtist, musicFile.TrackTitle, musicFile.AlbumTitle)
resultRows = curs.fetchall()
resultsCount = len(resultRows)
if resultsCount == 0 and self._enableSimpleLookup:
LogHelper.Verbose(f"doing alt db query: TrackArtist: '{musicFile.TrackArtist}' / TrackTitle: '{musicFile.TrackTitle}'")
queryHelper().doMusicFileDbQueryAlt(curs, musicFile.TrackArtist, musicFile.TrackTitle)
resultRows = curs.fetchall()
resultsCount = len(resultRows)
if resultsCount == 0:
LogHelper.Warning2(f"No DB record found for file '{musicFile.FilePath.name}'")
elif resultsCount > 1:
row = MusicFolderHandler._handleMultipleRows(resultRows, musicFile)
if row:
LogHelper.Message(f"Setting properties from record id {row.DbId} for file '{musicFile.FilePath.name}'")
if not self._onlyTimestamp:
self._setFileProperties(musicFile, row)
if row.ModifyTimeUTC:
lastModTime = MusicFolderHandler._dbModifyTimeToTimestamp(row.ModifyTimeUTC)
else:
LogHelper.Warning(f"skipping setting properties for file '{musicFile.FilePath.name}'")
else:
row = DbRowHelper(resultRows[0])
LogHelper.Message(f"One DB record (id: {row.DbId}) found for file '{musicFile.FilePath.name}'")
if not self._onlyTimestamp:
self._setFileProperties(musicFile, row)
if row.ModifyTimeUTC:
lastModTime = MusicFolderHandler._dbModifyTimeToTimestamp(row.ModifyTimeUTC)
self._saveFile(musicFile, lastModTime, currLastAccessTime, True, False)
# @deprecated("we're not using this any more, right?")
def _setFileProperties(self, musicFile : MusicFileProperties, dbRow : DbRowHelper):
#
# this should be updated, if we ever use it again...; or just get rid of it...
___obsolete___
#
LogHelper.Verbose(f"setting properties on file '{musicFile.FilePath.stem}'")
if dbRow.AlbumTitle:
at = MusicFolderHandler._addFancyChars(dbRow.AlbumTitle)
self._logSetProperty("AlbumTitle", at)
musicFile.AlbumTitle = at
if dbRow.TrackTitle:
tt = MusicFolderHandler._addFancyChars(dbRow.TrackTitle)
self._logSetProperty("TrackTitle", tt)
musicFile.TrackTitle = tt
albumArtist = dbRow.AlbumArtist if dbRow.AlbumArtist else dbRow.TrackArtist
if albumArtist:
aa = MusicFolderHandler._addFancyChars(albumArtist)
self._logSetProperty("AlbumArtist", aa)
musicFile.AlbumArtist = aa
trackArtist = dbRow.TrackArtist if dbRow.TrackArtist else dbRow.AlbumArtist
if trackArtist:
ta = MusicFolderHandler._addFancyChars(trackArtist)
self._logSetProperty("TrackArtist", ta)
musicFile.TrackArtist = ta
if dbRow.Year:
year = int(dbRow.Year)
if year > 0:
self._logSetProperty("Year", dbRow.Year)
musicFile.Year = str(year)
if dbRow.Conductor:
self._logSetProperty("Conductor", dbRow.Conductor)
musicFile.Conductor = dbRow.Conductor
copyright = dbRow.Copyright
if copyright:
copyright = copyright.replace("(c)", "©").replace("(C)", "©").replace("(p)", "℗").replace("(P)", "℗")
self._logSetProperty("Copyright", copyright)
musicFile.Copyright = copyright
if dbRow.Publisher:
self._logSetProperty("Publisher", dbRow.Publisher)
musicFile.Publisher = dbRow.Publisher
if dbRow.OriginalArtist:
self._logSetProperty("OriginalArtist", dbRow.OriginalArtist)
musicFile.OriginalArtist = dbRow.OriginalArtist
if dbRow.OriginalAlbum:
self._logSetProperty("OriginalAlbum", dbRow.OriginalAlbum)
musicFile.OriginalAlbum = dbRow.OriginalAlbum
if dbRow.OriginalYear:
self._logSetProperty("OriginalYear", dbRow.OriginalYear)
musicFile.OriginalYear = dbRow.OriginalYear
# for lyrics & comments, i normalized the line endins to *nix style in DB, so maybe need to put that back?
# nothing in db has "\r\n", so can do simple replace:
lyrics = dbRow.Lyrics
if lyrics:
lyrics = lyrics.replace("\\n", "\r\n")
self._logSetProperty("Lyrics", lyrics)
musicFile.Lyrics = lyrics
# normalize Composer, Producer, any other multi-value lists: replace '\s*/\s*', '\s*;\s*', '\s*&\s*', '\s*and\s*', '\s*,\s*' (except what about e.g.', Jr.' ??), etc(?) with just '/'
# --> on second thought, just leave these alone; there's too much variability and the way they're formatted usually matches what the albums say, so should just keep that
composer = dbRow.Composer
if composer:
#composer = MusicFolderHandler._composerRegex.sub("/", composer) # don't think i need to do this; already did it for db??
self._logSetProperty("Composer", composer)
musicFile.Composer = composer
producer = dbRow.Producer
if producer:
self._logSetProperty("Producer", producer)
musicFile.Producer = producer
# handle Producer: if we got one from source file/DB, in addition to setting tag, add it to Comments if not already in there (search for 'Producer' or 'Produced' ??)
comments = dbRow.Comments
if comments:
comments = comments.replace("\\n", "\r\n")
if producer and not MusicFolderHandler._commentsProducerRegex.search(comments):
LogHelper.Verbose(f"adding producer '{producer}' to comments")
comments = f"Produced by: {producer}\r\n\r\n{comments}"
self._logSetProperty("Comments", comments)
musicFile.Comments = comments
elif producer:
comments = f"Produced by: {producer}"
self._logSetProperty("Comments", comments)
musicFile.Comments = comments
# if target file already has track number, leave it alone (?); same for disc number; and if we don't have a TotalDiscs in target file, set to '1'(?)
# also, some of the track numbers in the DB are like '2/8', so have to parse those; but with those, i have the TotalTracks, so...
dbTrackNum = dbRow.TrackNumber
if dbTrackNum:
trackPieces = dbTrackNum.partition("/")
trackNum = int(trackPieces[0]) if trackPieces[0] and trackPieces[0].strip() else 0
ttlTracks = int(trackPieces[2]) if trackPieces[2] and trackPieces[2].strip() else 0
#if not musicFile.TrackNumber and trackNum > 0:
if trackNum > 0:
self._logSetProperty("TrackNumber", str(trackNum))
musicFile.TrackNumber = trackNum
#if not musicFile.TotalTracks and ttlTracks > 0:
if ttlTracks > 0:
self._logSetProperty("TotalTracks", str(ttlTracks))
musicFile.TotalTracks = ttlTracks
## no Disc info in db (oversight?), so just default them to 1 if not already set:
#if not musicFile.DiscNumber:
# self._logSetProperty("DiscNumber", "1")
# musicFile.DiscNumber = 1
#if not musicFile.TotalDiscs:
# self._logSetProperty("TotalDiscs", "1")
# musicFile.TotalDiscs = 1
def _cleanFile(self, musicFile : MusicFileProperties, onlyJunkTags: bool, extraTagsToClean: list[str] = None) -> int:
lastModTime = os.path.getmtime(musicFile.FilePath)
currLastAccessTime = os.path.getatime(musicFile.FilePath)
if onlyJunkTags:
self._cleanJunkProperties(musicFile, extraTagsToClean)
else:
self._cleanAllTags(musicFile)
result = self._showUnexpectedTags(musicFile)
self._saveFile(musicFile, lastModTime, currLastAccessTime, False, True)
return result
def _cleanJunkProperties(self, musicFile : MusicFileProperties, extraTagsToClean: list[str] = None) -> None:
LogHelper.Verbose('XXX removing junk tags from file "{0}"', musicFile.FilePath)
for tag in MusicFolderHandler._junkTagsToClean:
MusicFolderHandler._removeTag(tag, musicFile)
if musicFile.FilePath.suffix.lower() in MusicFolderHandler._extraJunkTagsByType:
for tag in MusicFolderHandler._extraJunkTagsByType[musicFile.FilePath.suffix.lower()]:
MusicFolderHandler._removeTag(tag, musicFile)
if extraTagsToClean:
for tag in extraTagsToClean:
mapped = musicFile.mapToNativeTagName(tag)
isNativeName = mapped is None or len(mapped) == 0
MusicFolderHandler._removeTag(tag, musicFile, isNativeTagName=isNativeName)
for tag in MusicFolderHandler._tagsToRename:
MusicFolderHandler._cleanUpTagName(tag, musicFile)
def _cleanAllTags(self, musicFile: MusicFileProperties) -> None:
keepTags = MusicFolderHandler._getListOfTagsToKeepOnClean(musicFile)
tagsToDelete: set[str] = set()
# can't delete the tags while we're iterating the list of them, it throws off the iterator, so make list first:
LogHelper.Verbose('XXX building list of (almost) all tags to remove from file "{0}"', musicFile.FilePath)
for t in musicFile.getNativeTagNames():
if t.casefold() not in keepTags:
LogHelper.Verbose('adding native tag "{0}" for removal', t)
tagsToDelete.add(t)
else: LogHelper.Verbose('keeping native tag "{0}"', t)
# now we can delete them:
LogHelper.Verbose('XXX removing (almost) all tags from file "{0}"', musicFile.FilePath)
for t in tagsToDelete:
LogHelper.Verbose('XXX removing native tag "{0}"', t)
musicFile.deleteNativeTagValue(t)
def _showUnexpectedTags(self, musicFile: MusicFileProperties) -> int:
nativeApprovedTags = MusicFolderHandler._getListOfApprovedTags(musicFile)
unexpectedTags = []
for t,v in musicFile.getNativeTagValues():
if t.startswith('$$'): continue
if t.casefold() not in nativeApprovedTags:
strV = str(v)
if len(strV) > 120:
strV = strV[:117] + "..."
unexpectedTags.append((t, strV))
if unexpectedTags:
msg = f"unexpected tag(s) in file '{musicFile.FilePath.name}':"
for tup in unexpectedTags:
msg += f"{os.linesep} tag: {tup[0]}{os.linesep} value: {tup[1]}"
LogHelper.Warning(msg)
return 1
return 0
@staticmethod
def _cleanUpPathNames(folderPath: pathlib.Path, whatIf: bool) -> pathlib.Path|None:
renamedFolder = MusicFolderHandler._cleanUpFolderName(folderPath, whatIf)
if renamedFolder:
folderPath = renamedFolder
MusicFolderHandler._cleanUpFilenames(folderPath, whatIf)
return renamedFolder
@staticmethod
def _cleanUpFolderName(folderPath: pathlib.Path, whatIf: bool) -> pathlib.Path|None:
# check that folder name doesn't contain any funky characters and rename it if so (like fancy quotes etc)
folderName = folderPath.name
LogHelper.Verbose('checking folder "{0}" name for bad chars', folderName)
if MusicFolderHandler._hasBadChars(folderName):
folderName = MusicFolderHandler._fixBadChars(folderName)
LogHelper.Message2(f"renaming folder |{folderPath.name}| to |{folderName}|")
if whatIf:
LogHelper.WhatIf(f"renaming folder |{folderPath.name}| to |{folderName}|")
else:
return folderPath.rename((folderPath.parent / folderName))
return None
@staticmethod
def _cleanUpFilenames(folderPath: pathlib.Path, whatIf: bool) -> None:
# check all the file names for funky characters and rename them
for f in FileHelpers.MultiGlob(folderPath, MusicFolderHandler._supportedFileTypesGlob):
filename = f.name
LogHelper.Verbose('checking file "{0}" name for bad chars', filename)
if MusicFolderHandler._hasBadChars(filename):
filename = MusicFolderHandler._fixBadChars(filename)
LogHelper.Message2(f"renaming file |{f.name}| to |{filename}|")
if whatIf:
LogHelper.WhatIf(f"renaming file |{f.name}| to |{filename}|")
else:
f = f.rename((f.parent / filename))
@staticmethod
def _createPlaylist(folderPath: pathlib.Path, playlistName: str|None, whatIf: bool):
entries: list[PlaylistEntry] = []; isFirst = True; albumTitle = ''; albumArtist = ''
for f in FileHelpers.MultiGlob(folderPath, MusicFolderHandler._supportedFileTypesGlob):
mf = MusicFileProperties(f)
if isFirst:
albumTitle = playlistName if playlistName else "/".join(mf.AlbumTitle)
albumArtist = "/".join(mf.AlbumArtist) if len(mf.AlbumArtist) > 0 else "/".join(mf.TrackArtist)
isFirst = False
entries.append(PlaylistEntry(mf, f.name))
albumArtistForFile = albumArtist
if (albumArtistForFile.lower().startswith("the ")):
albumArtistForFile = albumArtistForFile[4:] + ", The"
elif (albumArtistForFile.lower().startswith("a ")):
albumArtistForFile = albumArtistForFile[2:] + ", A"
elif (albumArtistForFile.lower().startswith("an ")):
albumArtistForFile = albumArtistForFile[3:] + ", An"
#filename = f"{albumArtistForFile} - {albumTitle}.m3u8"
filename = f"{albumArtistForFile} - {albumTitle}.m3u"
filename = MusicFolderHandler._fixBadChars(filename)
filename = MusicFolderHandler._badFilenameCharsRegex.sub("_", filename)
playlist = pathlib.Path((folderPath / filename))
LogHelper.Message(f"creating playlist '{str(playlist)}'")
if whatIf:
LogHelper.WhatIf(f"creating playlist file '{playlist.name}'")
else:
if playlist.is_file():
# make sure it's not readonly:
playlist.chmod(playlist.stat().st_mode | stat.S_IWRITE)
#with playlist.open(mode='wt', encoding='utf-8') as pl:
with playlist.open(mode='wt', encoding='utf-8-sig') as pl:
pl.write("#EXTM3U\n")
if albumTitle:
if albumArtist:
pl.write(f"#PLAYLIST:{albumArtist} - {albumTitle}\n")
else:
pl.write(f"#PLAYLIST:{albumTitle}\n")
pl.write(f"#EXTALB:{albumTitle}\n")
if albumArtist:
pl.write(f"#EXTART:{albumArtist}\n")
for e in sorted(entries, key=attrgetter('discNumber', 'trackNumber')):
pl.write(f"#EXTINF:{round(e.duration)},{e.trackArtist} - {e.trackTitle}\n")
pl.write(f"{e.filename}\n")
playlist.chmod(playlist.stat().st_mode & MusicFolderHandler._disableWriteAccess)
def _logSetProperty(self, propertyName : str, value : str):
LogHelper.Verbose(' setting "{propertyName}" to "{value}"', propertyName = propertyName, value = lambda: MusicFolderHandler._ellipsify(value))
@staticmethod
def _ellipsify(value : str):
if value and len(value) > 64:
value = value[:61] + "..."
return value
@staticmethod
def _dbModifyTimeToTimestamp(value : str):
# for ModifyTimeUTC, i didn't use ISO format, so will need to do a ParseExtact kind of thing and make sure it's UTC:
return datetime.datetime.strptime(value, "%Y-%m-%d %H:%M:%S").replace(tzinfo=datetime.timezone.utc).timestamp()
@staticmethod
def _handleMultipleRows(dbRows : List, musicFile : MusicFileProperties):
LogHelper.Warning(f"Multiple DB record found for file '{musicFile.FilePath.name}':")
headers = ["Id", "FilePath", "AlbumArtist", "AlbumTitle", "TrackArtist", "TrackTitle"]
outputRows = []
ids = []
idsMap = dict()
for row in DbRowHelper.EnumRows(dbRows):
idStr = str(row.DbId)
ids.append(idStr)
idsMap[idStr] = row
outputRows.append([idStr, row.FilePath, row.AlbumArtist, row.AlbumTitle, row.TrackArtist, row.TrackTitle])
print(tabulate(outputRows, headers=headers, tablefmt=_defaultTableFormat))
print("")
prompt = f"Which song do you want to use? {', '.join(ids)}, or S to skip: "
while True:
choice = input(prompt)
if choice.upper() == 'S':
return None
if choice in idsMap:
return idsMap[choice]
print("please enter a value from the list")
@staticmethod
def _hasBadChars(value : str):
return bool(MusicFolderHandler._badCharsRegex.search(value))
@staticmethod
def _fixBadChars(value : str):
#value = MusicFolderHandler._fancySingleQuotesRegex.sub("'", value)
#value = MusicFolderHandler._fancyDoubleQuotesRegex.sub("'", value)
value = MusicFolderHandler._badQuotesRegex.sub("'", value)
value = MusicFolderHandler._badDashesRegex.sub("-", value)
return value
@staticmethod
def _addFancyChars(value : str):
return value.replace("'", "’").replace("...", "…")
@staticmethod
def _getListOfTagsToKeepOnClean(musicFile: MusicFileProperties) -> list[str]:
if musicFile.TagType not in MusicFolderHandler._keepOnCleanNativeNamesCache:
tags = MusicFolderHandler._mapApprovedTags(musicFile, MusicFolderHandler._keepOnCleanAll)
MusicFolderHandler._keepOnCleanNativeNamesCache[musicFile.TagType] = tags
return MusicFolderHandler._keepOnCleanNativeNamesCache[musicFile.TagType]
@staticmethod
def _getListOfApprovedTags(musicFile: MusicFileProperties) -> list[str]:
if musicFile.TagType not in MusicFolderHandler._approvedTagsNativeNamesCache:
tags = MusicFolderHandler._mapApprovedTags(musicFile, MusicFolderHandler._approvedTags)
MusicFolderHandler._approvedTagsNativeNamesCache[musicFile.TagType] = tags
return MusicFolderHandler._approvedTagsNativeNamesCache[musicFile.TagType]
@staticmethod
def _mapApprovedTags(musicFile: MusicFileProperties, approvedTags: Iterable[str]) -> list[str]:
#return [t for a in approvedTags for t in musicFile.mapToNativeTagName(a).append(a)] # blows up for some reason
tags = []
for a in approvedTags:
n = musicFile.mapToNativeTagName(a)
if len(n) > 0: tags.extend([t.casefold() for t in n])
else: tags.append(a.casefold())
return tags
@staticmethod
def _copyTag(tagName: str, source: MusicFileProperties, target: MusicFileProperties) -> None:
val = source.getTagValue(tagName)
if val:
target.setTagValue(tagName, val)
@staticmethod
def _removeTag(tagName: str, target: MusicFileProperties, isNativeTagName: bool = False) -> None:
# MusicFIleProperties.deleteTag() will check if file actually has the tag
# before trying to remove it and setting the isDirty flag...
LogHelper.Verbose('XXX removing tag "{0}"', tagName)
if isNativeTagName:
target.deleteNativeTagValue(tagName)
else:
target.deleteTag(tagName)
@staticmethod
def _cleanUpTagName(tagName: str, target: MusicFileProperties) -> None:
# we're handling old tag names mapped to new names in the mapping file and in how we're saving the tags,
# so all we have to do is get and re-save the property, if it's there:
LogHelper.Verbose('??? checking for tag name "{0}" to make sure name is correct', tagName)
val = target.getTagValue(tagName)
if not val: return
LogHelper.Verbose('>>> resaving tag name "{0}" to make sure name is correct', tagName)
target.setTagValue(tagName, val)
class sqliteConnHelper:
def __init__(self, sqliteFilename : str):
self._filename = sqliteFilename
def __enter__(self):
self._conn = sqlite3.connect(self._filename)
self._conn.row_factory = sqlite3.Row # have to use this to get rows with column names; default just returns plain tuples of the values;
return self._conn
def __exit__(self, exc_type, exc_value, traceback):
if self._conn:
self._conn.close()
self._conn = None
class sqliteCursorHelper:
def __init__(self, sqliteConn : sqlite3.Connection):
self._conn = sqliteConn
def __enter__(self):
self._cursor = self._conn.cursor()
return self._cursor
def __exit__(self, exc_type, exc_value, traceback):
if self._cursor:
self._cursor.close()
self._cursor = None
self._conn = None
class queryHelper:
@staticmethod
def _normalizeString(value : str):
if value is None:
return None
value = value.strip()
if value == '':
return None
value = value.replace("‘", "'").replace("’", "'").replace('”', '"').replace('“', '"').replace("—", "-").replace("–", "-").replace("‐", "-")
return value
def doSimpleDbQuery(self, sqliteCursor : sqlite3.Cursor, trackArtist : str, albumArtist : str, trackTitle : str, albumTitle : str):
trackArtist = queryHelper._normalizeString(trackArtist)
albumArtist = queryHelper._normalizeString(albumArtist)
trackTitle = queryHelper._normalizeString(trackTitle)
albumTitle = queryHelper._normalizeString(albumTitle)
query = """SELECT MusicFileAttributesId, Folder, Filename, Extension
FROM MusicFiles
WHERE (@trackArtist IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(TrackArtist, '’', ''''), '‘', ''''), '“', '"'), '”', '"') = @trackArtist COLLATE NOCASE) AND
(@albumArtist IS NULL OR AlbumArtist IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(AlbumArtist, '’', ''''), '‘', ''''), '“', '"'), '”', '"') = @albumArtist COLLATE NOCASE) AND
(@trackTitle IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(TrackTitle, '’', ''''), '‘', ''''), '“', '"'), '”', '"'), '—', '-'), '–', '-'), '‐', '-') = @trackTitle COLLATE NOCASE) AND
(@albumTitle IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(AlbumTitle, '’', ''''), '‘', ''''), '“', '"'), '”', '"'), '—', '-'), '–', '-'), '‐', '-') = @albumTitle COLLATE NOCASE)"""
# WHERE (@trackArtist IS NULL OR TrackArtistNormed = @trackArtist) AND
# (@albumArtist IS NULL OR AlbumArtistNormed IS NULL OR AlbumArtistNormed = @albumArtist) AND
# (@trackTitle IS NULL OR TrackTitleNormed = @trackTitle) AND
# (@albumTitle IS NULL OR AlbumTitleNormed = @albumTitle)"""
params = {
"trackArtist": trackArtist,
"albumArtist": albumArtist,
"trackTitle": trackTitle,
"albumTitle": albumTitle,
}
sqliteCursor.execute(query, params)
def doMusicFileDbQuery(self, sqliteCursor : sqlite3.Cursor, trackArtist : str, albumArtist : str, trackTitle : str, albumTitle : str):
trackArtist = queryHelper._normalizeString(trackArtist)
albumArtist = queryHelper._normalizeString(albumArtist)
trackTitle = queryHelper._normalizeString(trackTitle)
albumTitle = queryHelper._normalizeString(albumTitle)
# don't have any db records where AlbumArtis is not null and TrackArtist is null,
# but about 1/4 have it the other way, so allow AlbumArtist to be NULL:
query = """SELECT MusicFileAttributesId, Folder, Filename, Extension, ModifyTimeUTC,
AlbumTitle, AlbumArtist, TrackArtist, TrackTitle, TrackNumber, Year,
Composer, Producer, Conductor, Copyright, Publisher, Lyrics, Comments,
OriginalArtist, OriginalAlbum, OriginalYear, Genre
FROM MusicFiles
WHERE (@trackArtist IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(TrackArtist, '’', ''''), '‘', ''''), '“', '"'), '”', '"') = @trackArtist COLLATE NOCASE) AND
(@albumArtist IS NULL OR AlbumArtist IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(AlbumArtist, '’', ''''), '‘', ''''), '“', '"'), '”', '"') = @albumArtist COLLATE NOCASE) AND
(@trackTitle IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(TrackTitle, '’', ''''), '‘', ''''), '“', '"'), '”', '"'), '—', '-'), '–', '-'), '‐', '-') = @trackTitle COLLATE NOCASE) AND
(@albumTitle IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(AlbumTitle, '’', ''''), '‘', ''''), '“', '"'), '”', '"'), '—', '-'), '–', '-'), '‐', '-') = @albumTitle COLLATE NOCASE)"""
# sqlite doesn't have FUNCTIONs, so have to do all the REPLACES in the query; ick
# but looks like the REPLACEs turn off the COLLATE NOCASEs, so i have to put them back in in the query; again, ick
# also, it has computed columns for tables, which i tried, but sqlite does not have DROP COLUMN (???), so if i have to change the computed column,
# there's no way to do that, so went back to just using to doing it inline
params = {
"trackArtist": trackArtist,
"albumArtist": albumArtist,
"trackTitle": trackTitle,
"albumTitle": albumTitle,
}
sqliteCursor.execute(query, params)
def doMusicFileDbQueryAlt(self, sqliteCursor : sqlite3.Cursor, trackArtist : str, trackTitle : str):
trackArtist = queryHelper._normalizeString(trackArtist)
trackTitle = queryHelper._normalizeString(trackTitle)
# don't have any db records where AlbumArtis is not null and TrackArtist is null,
# but about 1/4 have it the other way, so allow AlbumArtist to be NULL:
query = """SELECT MusicFileAttributesId, Folder, Filename, Extension, ModifyTimeUTC,
AlbumTitle, AlbumArtist, TrackArtist, TrackTitle, TrackNumber, Year,
Composer, Producer, Conductor, Copyright, Publisher, Lyrics, Comments,
OriginalArtist, OriginalAlbum, OriginalYear, Genre
FROM MusicFiles
WHERE (@trackArtist IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(TrackArtist, '’', ''''), '‘', ''''), '“', '"'), '”', '"') = @trackArtist COLLATE NOCASE) AND
(@trackTitle IS NULL OR REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(TrackTitle, '’', ''''), '‘', ''''), '“', '"'), '”', '"'), '—', '-'), '–', '-'), '‐', '-') = @trackTitle COLLATE NOCASE)"""
# sqlite doesn't have FUNCTIONs, so have to do all the REPLACES in the query; ick
# but looks like the REPLACEs turn off the COLLATE NOCASEs, so i have to put them back in in the query; again, ick
# also, it has computed columns for tables, which i tried, but sqlite does not have DROP COLUMN (???), so if i have to change the computed column,
# there's no way to do that, so went back to just using to doing it inline
params = {
"trackArtist": trackArtist,
"trackTitle": trackTitle,
}
sqliteCursor.execute(query, params)
def queryDbCommand(args : argparse.Namespace) -> int:
LogHelper.Init()
headers = ["Id", "Filename"]
results = []
with sqliteConnHelper(_musicAttributesDbPath) as conn, sqliteCursorHelper(conn) as curs:
queryHelper().doSimpleDbQuery(curs, args.trackArtist, args.albumArtist, args.trackTitle, args.albumTitle)
for row in DbRowHelper.EnumRows(curs.fetchall()):
results.append([row.DbId, row.FilePath])
print(tabulate(results, headers=headers, tablefmt=_defaultTableFormat))
return 0
def setFolderPropertiesFromDbCommand(args) -> int:
LogHelper.Init(verbose=args.verbose)
folder = pathlib.Path(args.folderPath)#.resolve()
if not folder.is_dir():
print(f'folder "{args.folderPath}" does not exist, is not a folder or could not be accessed')
return 2
MusicFolderHandler(folderPath = folder, createPlaylist = args.playlist, onlyPlaylist = args.onlyPlaylist, playlistName = args.playlistName,
onlyTimestamp = args.timestamp, enableSimpleLookup = args.simpleLookup, whatIf = args.whatIf)\
.SetFolderFilesFromDb()
return 0
def createPlaylistCommand(args) -> int:
LogHelper.Init(verbose=args.verbose)
folder = pathlib.Path(args.folderPath)#.resolve()
if not folder.is_dir():
print(f'folder "{args.folderPath}" does not exist, is not a folder or could not be accessed')
return 2
MusicFolderHandler(folderPath = folder, playlistName = args.playlistName, whatIf = args.whatIf)\
.CreatePlaylist()
return 0
def copyFolderPropertiesCommand(args) -> int:
LogHelper.Init(verbose=args.verbose)
targetFolder = pathlib.Path(args.targetFolderPath)#.resolve()
if not targetFolder.is_dir():
print(f'folder "{args.targetFolderPath}" does not exist, is not a folder or could not be accessed')
return 2
sourceFolder = None
if args.sourceFolderPath:
sourceFolder = pathlib.Path(args.sourceFolderPath)#.resolve()
else:
LogHelper.Verbose('no source folder specified, trying to figure one out from target "{0}":', targetFolder)
# some assumptions about targetFolder here...
album = targetFolder.absolute()
artist = album.parent
LogHelper.Verbose('using artist name "{0}", album name "{1}"', artist.name, album.name)
targetArtistFldr = _myMusicBaseFolder / artist.name
if targetArtistFldr.is_dir():
LogHelper.Verbose('artist folder "{0}" exists, looking for album', targetArtistFldr)
maybeTargetAlbumFldr = targetArtistFldr / album.name
if maybeTargetAlbumFldr.is_dir(): # probably not, but maybe
LogHelper.Verbose('found album folder "{0}"', maybeTargetAlbumFldr)
sourceFolder = maybeTargetAlbumFldr
else:
#tempRe = re.compile(rf'^\[[\w\-]+\]\s+{ re.escape(album.name) }$', re.IGNORECASE)
#for f in targetArtistFldr.iterdir():
# if not f.is_dir(): continue
# if tempRe.match(f.name):
# sourceFolder = f
# break
for f in targetArtistFldr.glob(f"[[]*[]] {album.name}"):
LogHelper.Verbose('found album folder "{0}"', f)
sourceFolder = f
break
if sourceFolder:
LogHelper.MessageMagenta('using "{0}" as source folder', sourceFolder)
else:
LogHelper.Verbose('could not figure out a source folder, prompting for it:')
# ask for it
folderName = input("enter the source folder: ")
if folderName: folderName = folderName.strip('" ')
sourceFolder = pathlib.Path(folderName)
if not sourceFolder.is_dir():
print(f'folder "{args.sourceFolderPath}" does not exist, is not a folder or could not be accessed')
return 2
return MusicFolderHandler(targetFolderPath = targetFolder, sourceFolderPath = sourceFolder, whatIf = args.whatIf)\
.CopyFolderProperties(args.skipRenames, args.tweakModTimeSecs, args.keepTags, args.onlyCleanJunkTags)
def cleanFilesCommand(args) -> int:
LogHelper.Init(verbose=args.verbose)
p = pathlib.Path(args.path)#.resolve()
if p.is_dir():
return MusicFolderHandler(folderPath = p, whatIf = args.whatIf).CleanFolderFiles(args.onlyJunk)
elif p.is_file():
return MusicFolderHandler(whatIf = args.whatIf).CleanFile(p, args.onlyJunk)
else:
print(f'path "{args.path}" does not exist, is not a folder or could not be accessed')
return 2
def cleanNamesCommand(args) -> int:
LogHelper.Init(verbose=args.verbose)
p = pathlib.Path(args.path)#.resolve()
if p.is_dir():
return MusicFolderHandler(targetFolderPath = p, whatIf = args.whatIf).CleanUpPathNames()
else:
print(f'path "{args.path}" does not exist, is not a folder or could not be accessed')
return 2