🎧 Your Personal Streaming Service
Go airsonicmadsonicmedia-servermusicmusic-servernavidromeopensubsonicraspberry-piself-hostedstreamerstreaming-apistreaming-audiosubsonicsubsonic-server
fix(scanner): detect in-place playlist edits via the folder content hash (#5914)
Junker der Provinzdff9e47c2ea5
diff --git a/scanner/folder_entry.go b/scanner/folder_entry.goindex 0e893d6e6..e7eef223c 100644--- a/scanner/folder_entry.go+++ b/scanner/folder_entry.go@@ -23,6 +23,7 @@ func newFolderEntry(job *scanJob, id, path string, info model.FolderUpdateInfo)path: path,audioFiles: make(map[string]fs.DirEntry),imageFiles: make(map[string]fs.DirEntry),+ playlistFiles: make(map[string]fs.DirEntry),albumIDMap: make(map[string]string),updTime: info.UpdatedAt,prevHash: info.Hash,@@ -41,7 +42,7 @@ type folderEntry struct {updTime time.Time // from DBaudioFiles map[string]fs.DirEntryimageFiles map[string]fs.DirEntry- numPlaylists int+ playlistFiles map[string]fs.DirEntrynumSubFolders intimagesUpdatedAt time.TimeprevHash string // Previous hash from DB@@ -57,7 +58,7 @@ type folderEntry struct {}func (f *folderEntry) hasNoFiles() bool {- return len(f.audioFiles) == 0 && len(f.imageFiles) == 0 && f.numPlaylists == 0+ return len(f.audioFiles) == 0 && len(f.imageFiles) == 0 && len(f.playlistFiles) == 0}func (f *folderEntry) isEmpty() bool {@@ -94,7 +95,7 @@ func (f *folderEntry) toFolder() *model.Folder {folder := model.NewFolder(f.job.lib, f.path)folder.NumAudioFiles = len(f.audioFiles)if playlists.InPath(*folder) {- folder.NumPlaylists = f.numPlaylists+ folder.NumPlaylists = len(f.playlistFiles)}folder.ImageFiles = slices.Collect(maps.Keys(f.imageFiles))folder.ImagesUpdatedAt = f.imagesUpdatedAt@@ -108,16 +109,18 @@ func (f *folderEntry) hash() string {h,"%s:%d:%d:%s",f.modTime.UTC(),- f.numPlaylists,+ len(f.playlistFiles), // redundant with the loop below, but dropping it re-hashes every folderf.numSubFolders,f.imagesUpdatedAt.UTC(),)- // Sort the keys of audio and image files to ensure consistent hashing+ // Sort the keys of audio, image and playlist files to ensure consistent hashingaudioKeys := slices.Collect(maps.Keys(f.audioFiles))slices.Sort(audioKeys)imageKeys := slices.Collect(maps.Keys(f.imageFiles))slices.Sort(imageKeys)+ playlistKeys := slices.Collect(maps.Keys(f.playlistFiles))+ slices.Sort(playlistKeys)// Include audio files with their size and modtimefor _, key := range audioKeys {@@ -135,5 +138,14 @@ func (f *folderEntry) hash() string {}}+ // Include playlist files, so a content edit is detected even when the folder's+ // mtime is preserved (rsync -a) or the playlist is not the newest file.+ for _, key := range playlistKeys {+ _, _ = io.WriteString(h, key)+ if info, err := f.playlistFiles[key].Info(); err == nil {+ _, _ = fmt.Fprintf(h, ":%d:%s", info.Size(), info.ModTime().UTC().String())+ }+ }+return hex.EncodeToString(h.Sum(nil))}diff --git a/scanner/folder_entry_test.go b/scanner/folder_entry_test.goindex e8e354b38..4493f9309 100644--- a/scanner/folder_entry_test.go+++ b/scanner/folder_entry_test.go@@ -48,6 +48,7 @@ var _ = Describe("folder_entry", func() {Expect(entry.path).To(Equal(path))Expect(entry.audioFiles).To(BeEmpty())Expect(entry.imageFiles).To(BeEmpty())+ Expect(entry.playlistFiles).To(BeEmpty())Expect(entry.albumIDMap).To(BeEmpty())Expect(entry.updTime).To(Equal(updateInfo.UpdatedAt))Expect(entry.prevHash).To(Equal(updateInfo.Hash))@@ -95,7 +96,7 @@ var _ = Describe("folder_entry", func() {})It("returns false when folder has playlists", func() {- entry.numPlaylists = 1+ entry.playlistFiles["list.m3u"] = &fakeDirEntry{name: "list.m3u"}Expect(entry.hasNoFiles()).To(BeFalse())})@@ -107,7 +108,7 @@ var _ = Describe("folder_entry", func() {It("returns false when folder has multiple types of content", func() {entry.audioFiles["test.mp3"] = &fakeDirEntry{name: "test.mp3"}entry.imageFiles["cover.jpg"] = &fakeDirEntry{name: "cover.jpg"}- entry.numPlaylists = 2+ entry.playlistFiles["list.m3u"] = &fakeDirEntry{name: "list.m3u"}entry.numSubFolders = 3Expect(entry.hasNoFiles()).To(BeFalse())})@@ -149,7 +150,11 @@ var _ = Describe("folder_entry", func() {"cover.jpg": &fakeDirEntry{name: "cover.jpg"},"folder.png": &fakeDirEntry{name: "folder.png"},}- entry.numPlaylists = 3+ entry.playlistFiles = map[string]fs.DirEntry{+ "list1.m3u": &fakeDirEntry{name: "list1.m3u"},+ "list2.m3u": &fakeDirEntry{name: "list2.m3u"},+ "list3.m3u": &fakeDirEntry{name: "list3.m3u"},+ }entry.imagesUpdatedAt = time.Now()})@@ -200,7 +205,10 @@ var _ = Describe("folder_entry", func() {"z.jpg": &fakeDirEntry{name: "z.jpg"},"x.png": &fakeDirEntry{name: "x.png"},}- entry.numPlaylists = 2+ entry.playlistFiles = map[string]fs.DirEntry{+ "q.m3u": &fakeDirEntry{name: "q.m3u"},+ "p.m3u": &fakeDirEntry{name: "p.m3u"},+ }entry.numSubFolders = 3hash1 := entry.hash()@@ -214,6 +222,10 @@ var _ = Describe("folder_entry", func() {"x.png": &fakeDirEntry{name: "x.png"},"z.jpg": &fakeDirEntry{name: "z.jpg"},}+ entry.playlistFiles = map[string]fs.DirEntry{+ "p.m3u": &fakeDirEntry{name: "p.m3u"},+ "q.m3u": &fakeDirEntry{name: "q.m3u"},+ }hash2 := entry.hash()Expect(hash1).To(Equal(hash2))@@ -252,10 +264,10 @@ var _ = Describe("folder_entry", func() {Expect(hash1).ToNot(Equal(hash2))})- It("produces different hash when playlist count changes", func() {+ It("produces different hash when playlist files change", func() {hash1 := entry.hash()- entry.numPlaylists = 5+ entry.playlistFiles["new.m3u"] = &fakeDirEntry{name: "new.m3u"}hash2 := entry.hash()Expect(hash1).ToNot(Equal(hash2))@@ -377,6 +389,58 @@ var _ = Describe("folder_entry", func() {Expect(hash1).ToNot(Equal(hash2))})+ It("produces different hash when playlist file size changes", func() {+ baseTime := time.Now()+ entry.playlistFiles["list.m3u"] = &fakeDirEntry{+ name: "list.m3u",+ fileInfo: &fakeFileInfo{name: "list.m3u", size: 1000, modTime: baseTime},+ }+ hash1 := entry.hash()++ entry.playlistFiles["list.m3u"] = &fakeDirEntry{+ name: "list.m3u",+ fileInfo: &fakeFileInfo{name: "list.m3u", size: 2000, modTime: baseTime},+ }+ hash2 := entry.hash()++ Expect(hash1).ToNot(Equal(hash2))+ })++ It("produces different hash when playlist file modification time changes", func() {+ baseTime := time.Now()+ entry.playlistFiles["list.m3u"] = &fakeDirEntry{+ name: "list.m3u",+ fileInfo: &fakeFileInfo{name: "list.m3u", size: 1000, modTime: baseTime},+ }+ hash1 := entry.hash()++ entry.playlistFiles["list.m3u"] = &fakeDirEntry{+ name: "list.m3u",+ fileInfo: &fakeFileInfo{name: "list.m3u", size: 1000, modTime: baseTime.Add(1 * time.Hour)},+ }+ hash2 := entry.hash()++ Expect(hash1).ToNot(Equal(hash2))+ })++ It("produces different hash when a playlist is renamed", func() {+ baseTime := time.Now()+ entry.playlistFiles["old.m3u"] = &fakeDirEntry{+ name: "old.m3u",+ fileInfo: &fakeFileInfo{name: "old.m3u", size: 1000, modTime: baseTime},+ }+ hash1 := entry.hash()++ delete(entry.playlistFiles, "old.m3u")+ entry.playlistFiles["new.m3u"] = &fakeDirEntry{+ name: "new.m3u",+ fileInfo: &fakeFileInfo{name: "new.m3u", size: 1000, modTime: baseTime},+ }+ hash2 := entry.hash()++ Expect(hash1).ToNot(Equal(hash2))+ })+It("produces valid hex-encoded hash", func() {hash := entry.hash()Expect(hash).To(HaveLen(32)) // MD5 hash should be 32 hex characters@@ -421,7 +485,7 @@ var _ = Describe("folder_entry", func() {})It("returns true when hash has changed", func() {- entry.numPlaylists = 10 // Change something to change the hash+ entry.playlistFiles["list.m3u"] = &fakeDirEntry{name: "list.m3u"} // Change something to change the hashExpect(entry.isOutdated()).To(BeTrue())})@@ -445,7 +509,7 @@ var _ = Describe("folder_entry", func() {It("returns true when full scan condition is not met but hash changed", func() {entry.updTime = entry.job.lib.LastScanStartedAt.Add(1 * time.Hour)- entry.numPlaylists = 10 // Change hash+ entry.playlistFiles["list.m3u"] = &fakeDirEntry{name: "list.m3u"} // Change hashExpect(entry.isOutdated()).To(BeTrue())})})diff --git a/scanner/phase_1_folders.go b/scanner/phase_1_folders.goindex 82e91d5ad..6107b3316 100644--- a/scanner/phase_1_folders.go+++ b/scanner/phase_1_folders.go@@ -165,7 +165,7 @@ func (p *phaseFolders) producer() ppl.Producer[*folderEntry] {log.Trace(p.ctx, "Scanner: Checking folder state", " folder", folder.path, "_updTime", folder.updTime,"_modTime", folder.modTime, "_lastScanStartedAt", folder.job.lib.LastScanStartedAt,"numAudioFiles", len(folder.audioFiles), "numImageFiles", len(folder.imageFiles),- "numPlaylists", folder.numPlaylists, "numSubfolders", folder.numSubFolders)+ "numPlaylists", len(folder.playlistFiles), "numSubfolders", folder.numSubFolders)// Check if folder is outdatedif folder.isOutdated() {@@ -492,7 +492,7 @@ func (p *phaseFolders) logFolder(entry *folderEntry) (*folderEntry, error) {logCall = log.Trace}logCall(p.ctx, "Scanner: Completed processing folder",- "audioCount", len(entry.audioFiles), "imageCount", len(entry.imageFiles), "plsCount", entry.numPlaylists,+ "audioCount", len(entry.audioFiles), "imageCount", len(entry.imageFiles), "plsCount", len(entry.playlistFiles),"elapsed", entry.elapsed.Elapsed(), "tracksMissing", len(entry.missingTracks),"tracksImported", len(entry.tracks), "library", entry.job.lib.Name, consts.Zwsp+"folder", entry.path)return entry, nildiff --git a/scanner/walk_dir_tree.go b/scanner/walk_dir_tree.goindex 887344b1b..20f6d4213 100644--- a/scanner/walk_dir_tree.go+++ b/scanner/walk_dir_tree.go@@ -82,7 +82,7 @@ func walkFolder(ctx context.Context, job *scanJob, currentFolder string, checkerdir := path.Clean(currentFolder)log.Trace(ctx, "Scanner: Found directory", " path", dir, "audioFiles", maps.Keys(folder.audioFiles),- "images", maps.Keys(folder.imageFiles), "playlists", folder.numPlaylists, "imagesUpdatedAt", folder.imagesUpdatedAt,+ "images", maps.Keys(folder.imageFiles), "playlists", len(folder.playlistFiles), "imagesUpdatedAt", folder.imagesUpdatedAt,"updTime", folder.updTime, "modTime", folder.modTime, "numChildren", len(children))folder.path = dirfolder.elapsed.Start()@@ -157,7 +157,7 @@ func loadDir(ctx context.Context, job *scanJob, dirPath string, checker *IgnoreCcase model.IsAudioFile(name):folder.audioFiles[entry.Name()] = entrycase model.IsValidPlaylist(name):- folder.numPlaylists+++ folder.playlistFiles[entry.Name()] = entrycase model.IsImageFile(name):folder.imageFiles[entry.Name()] = entryfolder.imagesUpdatedAt = utils.TimeNewest(folder.imagesUpdatedAt, fileInfo.ModTime(), folder.modTime)