fix: orphaned avatar and branding files are being deleted

+ added logic that removed orphaned within the clean up job. Files may
  be orphaned if a user uploads a file, but never saves it (registering
  it with the user profile or site info).

+ if a user switches avatars, for example from a customized avatar to the system default avatar, the file is not deleted anymore.

Author: Daniel Auer

cmd/wire_gen.go

@@ -101,3 +101,18 @@ func (sr *siteInfoRepo) setCache(ctx context.Context, siteType string, siteInfo
 		log.Error(err)
 	}
 }
+
+func (sr *siteInfoRepo) IsBrandingFileUsed(ctx context.Context, filePath string) (bool, error) {
+	siteInfo := &entity.SiteInfo{}
+	count, err := sr.data.DB.Context(ctx).
+		Table("site_info").
+		Where(builder.Eq{"type": "branding"}).
+		And(builder.Like{"content", "%" + filePath + "%"}).
+		Count(&siteInfo)
+
+	if err != nil {
+		return false, errors.InternalServer(reason.DatabaseError).WithError(err).WithStack()
+	}
+
+	return count > 0, nil
+}

internal/repo/site_info/siteinfo_repo.go

@@ -33,6 +33,7 @@ import (
 	"github.com/apache/answer/plugin"
 	"github.com/segmentfault/pacman/errors"
 	"github.com/segmentfault/pacman/log"
+	"xorm.io/builder"
 	"xorm.io/xorm"
 )
 
@@ -380,3 +381,17 @@ func decorateByUserCenterUser(original *entity.User, ucUser *plugin.UserCenterBa
 		original.Status = int(ucUser.Status)
 	}
 }
+
+func (ur *userRepo) IsAvatarFileUsed(ctx context.Context, filePath string) (bool, error) {
+	user := &entity.User{}
+	count, err := ur.data.DB.Context(ctx).
+		Table("user").
+		Where(builder.Like{"avatar", "%" + filePath + "%"}).
+		Count(&user)
+
+	if err != nil {
+		return false, errors.InternalServer(reason.DatabaseError).WithError(err).WithStack()
+	}
+
+	return count > 0, nil
+}

internal/repo/user/user_repo.go

@@ -385,21 +385,23 @@ func (us *UserService) cleanUpRemovedAvatar(
 	_ = json.Unmarshal([]byte(oldAvatarJSON), &oldAvatar)
 	_ = json.Unmarshal([]byte(newAvatarJSON), &newAvatar)
 
+	if len(oldAvatar.Custom) == 0 {
+		return
+	}
+
 	// clean up if old is custom and it's either removed or replaced
-	if oldAvatar.Type == "custom" && (newAvatar.Type != "custom" || oldAvatar.Custom != newAvatar.Custom) {
-		if oldAvatar.Custom != "" {
-			fileRecord, err := us.fileRecordService.GetFileRecordByURL(ctx, oldAvatar.Custom)
-			if err != nil {
-				log.Error(err)
-				return
-			}
-			if fileRecord == nil {
-				log.Warn("no file record found for old avatar url:", oldAvatar.Custom)
-				return
-			}
-			if err := us.fileRecordService.DeleteAndMoveFileRecord(ctx, fileRecord); err != nil {
-				log.Error(err)
-			}
+	if oldAvatar.Custom != newAvatar.Custom {
+		fileRecord, err := us.fileRecordService.GetFileRecordByURL(ctx, oldAvatar.Custom)
+		if err != nil {
+			log.Error(err)
+			return
+		}
+		if fileRecord == nil {
+			log.Warn("no file record found for old avatar url:", oldAvatar.Custom)
+			return
+		}
+		if err := us.fileRecordService.DeleteAndMoveFileRecord(ctx, fileRecord); err != nil {
+			log.Error(err)
 		}
 	}
 }

internal/service/content/user_service.go

@@ -32,6 +32,7 @@ import (
 	"github.com/apache/answer/internal/service/revision"
 	"github.com/apache/answer/internal/service/service_config"
 	"github.com/apache/answer/internal/service/siteinfo_common"
+	usercommon "github.com/apache/answer/internal/service/user_common"
 	"github.com/apache/answer/pkg/checker"
 	"github.com/apache/answer/pkg/dir"
 	"github.com/apache/answer/pkg/writer"
@@ -54,6 +55,7 @@ type FileRecordService struct {
 	revisionRepo    revision.RevisionRepo
 	serviceConfig   *service_config.ServiceConfig
 	siteInfoService siteinfo_common.SiteInfoCommonService
+	userService     *usercommon.UserCommon
 }
 
 // NewFileRecordService new file record service
@@ -62,12 +64,14 @@ func NewFileRecordService(
 	revisionRepo revision.RevisionRepo,
 	serviceConfig *service_config.ServiceConfig,
 	siteInfoService siteinfo_common.SiteInfoCommonService,
+	userService *usercommon.UserCommon,
 ) *FileRecordService {
 	return &FileRecordService{
 		fileRecordRepo:  fileRecordRepo,
 		revisionRepo:    revisionRepo,
 		serviceConfig:   serviceConfig,
 		siteInfoService: siteInfoService,
+		userService:     userService,
 	}
 }
 
@@ -107,6 +111,18 @@ func (fs *FileRecordService) CleanOrphanUploadFiles(ctx context.Context) {
 				continue
 			}
 			if isBrandingOrAvatarFile(fileRecord.FilePath) {
+				if strings.Contains(fileRecord.FilePath, constant.BrandingSubPath+"/") {
+					if fs.siteInfoService.IsBrandingFileUsed(ctx, fileRecord.FilePath) {
+						continue
+					}
+				} else if strings.Contains(fileRecord.FilePath, constant.AvatarSubPath+"/") {
+					if fs.userService.IsAvatarFileUsed(ctx, fileRecord.FilePath) {
+						continue
+					}
+				}
+				if err := fs.DeleteAndMoveFileRecord(ctx, fileRecord); err != nil {
+					log.Error(err)
+				}
 				continue
 			}
 			if checker.IsNotZeroString(fileRecord.ObjectID) {

internal/service/file_record/file_record_service.go

@@ -35,6 +35,7 @@ import (
 type SiteInfoRepo interface {
 	SaveByType(ctx context.Context, siteType string, data *entity.SiteInfo) (err error)
 	GetByType(ctx context.Context, siteType string) (siteInfo *entity.SiteInfo, exist bool, err error)
+	IsBrandingFileUsed(ctx context.Context, filePath string) (bool, error)
 }
 
 // siteInfoCommonService site info common service
@@ -56,6 +57,7 @@ type SiteInfoCommonService interface {
 	GetSiteTheme(ctx context.Context) (resp *schema.SiteThemeResp, err error)
 	GetSiteSeo(ctx context.Context) (resp *schema.SiteSeoResp, err error)
 	GetSiteInfoByType(ctx context.Context, siteType string, resp interface{}) (err error)
+	IsBrandingFileUsed(ctx context.Context, filePath string) bool
 }
 
 // NewSiteInfoCommonService new site info common service
@@ -233,3 +235,13 @@ func (s *siteInfoCommonService) GetSiteInfoByType(ctx context.Context, siteType
 	_ = json.Unmarshal([]byte(siteInfo.Content), resp)
 	return nil
 }
+
+func (s *siteInfoCommonService) IsBrandingFileUsed(ctx context.Context, filePath string) bool {
+	used, err := s.siteInfoRepo.IsBrandingFileUsed(ctx, filePath)
+	if err != nil {
+		log.Errorf("error checking if branding file is used: %v", err)
+		// will try again with the next clean up
+		return true
+	}
+	return used
+}

internal/service/siteinfo_common/siteinfo_service.go

@@ -60,6 +60,7 @@ type UserRepo interface {
 	GetByEmail(ctx context.Context, email string) (userInfo *entity.User, exist bool, err error)
 	GetUserCount(ctx context.Context) (count int64, err error)
 	SearchUserListByName(ctx context.Context, name string, limit int, onlyStaff bool) (userList []*entity.User, err error)
+	IsAvatarFileUsed(ctx context.Context, filePath string) (bool, error)
 }
 
 // UserCommon user service
@@ -245,3 +246,13 @@ func (us *UserCommon) CacheLoginUserInfo(ctx context.Context, userID string, use
 	}
 	return accessToken, userCacheInfo, nil
 }
+
+func (us *UserCommon) IsAvatarFileUsed(ctx context.Context, filePath string) bool {
+	used, err := us.userRepo.IsAvatarFileUsed(ctx, filePath)
+	if err != nil {
+		log.Errorf("error checking if branding file is used: %v", err)
+		// will try again with the next clean up
+		return true
+	}
+	return used
+}