💚 End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
Handle album folder names portably
Neeraj Guptac6ec07bbeed8
diff --git a/cli/pkg/remote_to_disk_album.go b/cli/pkg/remote_to_disk_album.goindex 792a8a7cd9..fdd715b31c 100644--- a/cli/pkg/remote_to_disk_album.go+++ b/cli/pkg/remote_to_disk_album.go@@ -20,7 +20,7 @@ func (c *ClICtrl) createLocalFolderForRemoteAlbums(ctx context.Context, accountreturn err}userID := ctx.Value("user_id").(int64)- folderToMetaMap, albumIDToMetaMap, err := readFolderMetadata(path)+ albumIDToMetaMap, err := readFolderMetadata(path)if err != nil {return err}@@ -35,46 +35,30 @@ func (c *ClICtrl) createLocalFolderForRemoteAlbums(ctx context.Context, accountif err = os.RemoveAll(filepath.Join(path, meta.FolderName)); err != nil {return err}- delete(folderToMetaMap, meta.FolderName)delete(albumIDToMetaMap, meta.ID)}continue}metaByID := albumIDToMetaMap[album.ID]- if metaByID != nil {- if strings.EqualFold(metaByID.AlbumName, album.AlbumName) {- continue- }+ if metaByID != nil && strings.EqualFold(metaByID.AlbumName, album.AlbumName) &&+ sanitizeAlbumFolderName(metaByID.FolderName) == metaByID.FolderName {+ continue}- albumFolderName := filepath.Clean(album.AlbumName)- albumFolderName = strings.NewReplacer(":", "_", "/", "_", "\\", "_").Replace(albumFolderName)- albumFolderName = strings.TrimSpace(albumFolderName)- if albumFolderName == "" || albumFolderName == "." || albumFolderName == ".." {- albumFolderName = "_"+ albumFolderName := sanitizeAlbumFolderName(album.AlbumName)+ albumFolderName, err = uniqueAlbumFolderName(path, albumFolderName)+ if err != nil {+ return err}- albumID := album.ID-- if _, ok := folderToMetaMap[albumFolderName]; ok {- for i := 1; ; i++ {- newAlbumName := fmt.Sprintf("%s_%d", albumFolderName, i)- if _, ok := folderToMetaMap[newAlbumName]; !ok {- albumFolderName = newAlbumName- break- }- }- }- albumPath := filepath.Clean(filepath.Join(path, albumFolderName))+ albumPath := filepath.Join(path, albumFolderName)metaPath := filepath.Join(albumPath, ".meta")if metaByID == nil {log.Printf("Adding folder %s for album %s", albumFolderName, album.AlbumName)for _, p := range []string{albumPath, metaPath} {- if _, err := os.Stat(p); os.IsNotExist(err) {- if err = os.Mkdir(p, 0755); err != nil {- return err- }+ if err = os.Mkdir(p, 0755); err != nil {+ return err}}} else {@@ -96,25 +80,63 @@ func (c *ClICtrl) createLocalFolderForRemoteAlbums(ctx context.Context, accountif err = writeJSONToFile(metaFilePath, metaData); err != nil {return err}- folderToMetaMap[albumFolderName] = &metaData- albumIDToMetaMap[albumID] = &metaData+ albumIDToMetaMap[album.ID] = &metaData}return nil}-func readFolderMetadata(path string) (map[string]*export.AlbumMetadata, map[int64]*export.AlbumMetadata, error) {- result := make(map[string]*export.AlbumMetadata)- albumIdToMetadataMap := make(map[int64]*export.AlbumMetadata)+func sanitizeAlbumFolderName(name string) string {+ name = strings.Map(func(r rune) rune {+ if r < ' ' || strings.ContainsRune(`<>:"/\|?*`, r) {+ return '_'+ }+ return r+ }, name)+ name = strings.TrimRight(strings.TrimSpace(name), ". ")+ if name == "" || isWindowsReservedName(name) {+ return "_" + name+ }+ return name+}++func isWindowsReservedName(name string) bool {+ base, _, _ := strings.Cut(name, ".")+ base = strings.ToUpper(strings.TrimRight(base, " "))+ switch base {+ case "CON", "PRN", "AUX", "NUL", "CONIN$", "CONOUT$",+ "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "COM¹", "COM²", "COM³",+ "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9", "LPT¹", "LPT²", "LPT³":+ return true+ }+ return false+}++func uniqueAlbumFolderName(root, name string) (string, error) {+ for i := 0; ; i++ {+ candidate := name+ if i > 0 {+ candidate = fmt.Sprintf("%s_%d", name, i)+ }+ _, err := os.Lstat(filepath.Join(root, candidate))+ if os.IsNotExist(err) {+ return candidate, nil+ }+ if err != nil {+ return "", err+ }+ }+}++func readFolderMetadata(path string) (map[int64]*export.AlbumMetadata, error) {+ albumIDToMetadataMap := make(map[int64]*export.AlbumMetadata)entries, err := os.ReadDir(path)if err != nil {- return nil, nil, err+ return nil, err}for _, entry := range entries {if entry.IsDir() {dirName := entry.Name()metaFilePath := filepath.Join(path, dirName, albumMetaFolder, albumMetaFile)- // Initialize as nil, will remain nil if JSON file is not found or not readable- result[dirName] = nilif _, err := os.Stat(metaFilePath); err == nil {var metaData export.AlbumMetadatametaDataBytes, err := os.ReadFile(metaFilePath)@@ -124,11 +146,10 @@ func readFolderMetadata(path string) (map[string]*export.AlbumMetadata, map[int6if err := json.Unmarshal(metaDataBytes, &metaData); err == nil {metaData.FolderName = dirName- result[dirName] = &metaData- albumIdToMetadataMap[metaData.ID] = &metaData+ albumIDToMetadataMap[metaData.ID] = &metaData}}}}- return result, albumIdToMetadataMap, nil+ return albumIDToMetadataMap, nil}diff --git a/cli/pkg/remote_to_disk_album_test.go b/cli/pkg/remote_to_disk_album_test.gonew file mode 100644index 0000000000..413184f30e--- /dev/null+++ b/cli/pkg/remote_to_disk_album_test.go@@ -0,0 +1,54 @@+package pkg++import (+ "os"+ "path/filepath"+ "testing"+)++func TestSanitizeAlbumFolderName(t *testing.T) {+ tests := []struct {+ name string+ want string+ }{+ {`Trip/2026\Raw`, "Trip_2026_Raw"},+ {`A<B>C:D"E|F?G*H`, "A_B_C_D_E_F_G_H"},+ {"A\x00B\x1fC", "A_B_C"},+ {"Album. ", "Album"},+ {"..", "_"},+ {"COM9.backup", "_COM9.backup"},+ {"LPT³.json", "_LPT³.json"},+ {"NUL .txt", "_NUL .txt"},+ {"COM10", "COM10"},+ {".CON", ".CON"},+ }+ for _, test := range tests {+ t.Run(test.name, func(t *testing.T) {+ if got := sanitizeAlbumFolderName(test.name); got != test.want {+ t.Fatalf("sanitizeAlbumFolderName(%q) = %q, want %q", test.name, got, test.want)+ }+ })+ }+}++func TestUniqueAlbumFolderNameUsesFilesystemCollisions(t *testing.T) {+ root := t.TempDir()+ for _, name := range []string{"Album", "album_1"} {+ if err := os.WriteFile(filepath.Join(root, name), nil, 0600); err != nil {+ t.Fatal(err)+ }+ }+ if _, err := os.Lstat(filepath.Join(root, "album")); os.IsNotExist(err) {+ if err := os.WriteFile(filepath.Join(root, "album"), nil, 0600); err != nil {+ t.Fatal(err)+ }+ }++ got, err := uniqueAlbumFolderName(root, "album")+ if err != nil {+ t.Fatal(err)+ }+ if got != "album_2" {+ t.Fatalf("uniqueAlbumFolderName() = %q, want %q", got, "album_2")+ }+}diff --git a/cli/pkg/remote_to_disk_file.go b/cli/pkg/remote_to_disk_file.goindex 6a0b010f32..3f1c953e70 100644--- a/cli/pkg/remote_to_disk_file.go+++ b/cli/pkg/remote_to_disk_file.go@@ -20,7 +20,7 @@ import (func (c *ClICtrl) syncFiles(ctx context.Context, account model.Account) error {log.Printf("Starting file download")exportRoot := account.ExportDir- _, albumIDToMetaMap, err := readFolderMetadata(exportRoot)+ albumIDToMetaMap, err := readFolderMetadata(exportRoot)if err != nil {return err}