feat: delete branding files

+ a file is being deleted after its reference has been removed from
  the site info. The user has no way to access the file again. Therefore
  the file would become an orphan if not deleted.

+ an if clause had to be added to CleanOrphanUploadFiles, because it
  would otherwise remove the branding and avatar files.

Author: Daniel Auer

internal/controller_admin/siteinfo_controller.go

@@ -28,6 +28,7 @@ import (
 	"github.com/apache/answer/internal/schema"
 	"github.com/apache/answer/internal/service/siteinfo"
 	"github.com/gin-gonic/gin"
+	"github.com/segmentfault/pacman/log"
 )
 
 // SiteInfoController site info controller
@@ -274,7 +275,12 @@ func (sc *SiteInfoController) UpdateBranding(ctx *gin.Context) {
 	if handler.BindAndCheck(ctx, req) {
 		return
 	}
-	err := sc.siteInfoService.SaveSiteBranding(ctx, req)
+	currentBranding, _ := sc.siteInfoService.GetSiteBranding(ctx)
+	err := sc.siteInfoService.CleanUpRemovedBrandingFiles(ctx, req, currentBranding)
+	if err != nil {
+		log.Error(err)
+	}
+	err = sc.siteInfoService.SaveSiteBranding(ctx, req)
 	handler.HandleResponse(ctx, err, nil)
 }
 

internal/repo/file_record/file_record_repo.go

@@ -82,3 +82,18 @@ func (fr *fileRecordRepo) UpdateFileRecord(ctx context.Context, fileRecord *enti
 	}
 	return
 }
+
+// GetFileRecordByURL gets a file record by its url
+func (fr *fileRecordRepo) GetFileRecordByURL(ctx context.Context, fileURL string) (record *entity.FileRecord, err error) {
+	record = &entity.FileRecord{}
+	session := fr.data.DB.Context(ctx)
+	exists, err := session.Where("file_url = ? AND status = ?", fileURL, entity.FileRecordStatusAvailable).Get(record)
+	if err != nil {
+		err = errors.InternalServer(reason.DatabaseError).WithError(err).WithStack()
+		return
+	}
+	if !exists {
+		return
+	}
+	return record, nil
+}

internal/service/file_record/file_record_service.go

@@ -24,6 +24,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 	"time"
 
 	"github.com/apache/answer/internal/base/constant"
@@ -44,6 +45,7 @@ type FileRecordRepo interface {
 	GetFileRecordPage(ctx context.Context, page, pageSize int, cond *entity.FileRecord) (
 		fileRecordList []*entity.FileRecord, total int64, err error)
 	DeleteFileRecord(ctx context.Context, id int) (err error)
+	GetFileRecordByURL(ctx context.Context, fileURL string) (record *entity.FileRecord, err error)
 }
 
 // FileRecordService file record service
@@ -104,6 +106,9 @@ func (fs *FileRecordService) CleanOrphanUploadFiles(ctx context.Context) {
 			if fileRecord.CreatedAt.AddDate(0, 0, 2).After(time.Now()) {
 				continue
 			}
+			if isBrandingOrAvatarFile(fileRecord.FilePath) {
+				continue
+			}
 			if checker.IsNotZeroString(fileRecord.ObjectID) {
 				_, exist, err := fs.revisionRepo.GetLastRevisionByObjectID(ctx, fileRecord.ObjectID)
 				if err != nil {
@@ -129,14 +134,18 @@ func (fs *FileRecordService) CleanOrphanUploadFiles(ctx context.Context) {
 				}
 			}
 			// Delete and move the file record
-			if err := fs.deleteAndMoveFileRecord(ctx, fileRecord); err != nil {
+			if err := fs.DeleteAndMoveFileRecord(ctx, fileRecord); err != nil {
 				log.Error(err)
 			}
 		}
 		page++
 	}
 }
 
+func isBrandingOrAvatarFile(filePath string) bool {
+	return strings.Contains(filePath, constant.BrandingSubPath+"/") || strings.Contains(filePath, constant.AvatarSubPath+"/")
+}
+
 func (fs *FileRecordService) PurgeDeletedFiles(ctx context.Context) {
 	deletedPath := filepath.Join(fs.serviceConfig.UploadPath, constant.DeletedSubPath)
 	log.Infof("purge deleted files: %s", deletedPath)
@@ -152,7 +161,7 @@ func (fs *FileRecordService) PurgeDeletedFiles(ctx context.Context) {
 	return
 }
 
-func (fs *FileRecordService) deleteAndMoveFileRecord(ctx context.Context, fileRecord *entity.FileRecord) error {
+func (fs *FileRecordService) DeleteAndMoveFileRecord(ctx context.Context, fileRecord *entity.FileRecord) error {
 	// Delete the file record
 	if err := fs.fileRecordRepo.DeleteFileRecord(ctx, fileRecord.ID); err != nil {
 		return fmt.Errorf("delete file record error: %v", err)
@@ -170,3 +179,12 @@ func (fs *FileRecordService) deleteAndMoveFileRecord(ctx context.Context, fileRe
 	log.Debugf("delete and move file: %s", fileRecord.FileURL)
 	return nil
 }
+
+func (fs *FileRecordService) GetFileRecordByURL(ctx context.Context, fileURL string) (record *entity.FileRecord, err error) {
+	record, err = fs.fileRecordRepo.GetFileRecordByURL(ctx, fileURL)
+	if err != nil {
+		log.Errorf("error retrieving file record by URL: %v", err)
+		return
+	}
+	return
+}

internal/service/siteinfo/siteinfo_service.go

@@ -33,6 +33,7 @@ import (
 	"github.com/apache/answer/internal/schema"
 	"github.com/apache/answer/internal/service/config"
 	"github.com/apache/answer/internal/service/export"
+	"github.com/apache/answer/internal/service/file_record"
 	questioncommon "github.com/apache/answer/internal/service/question_common"
 	"github.com/apache/answer/internal/service/siteinfo_common"
 	tagcommon "github.com/apache/answer/internal/service/tag_common"
@@ -49,6 +50,7 @@ type SiteInfoService struct {
 	tagCommonService      *tagcommon.TagCommonService
 	configService         *config.ConfigService
 	questioncommon        *questioncommon.QuestionCommon
+	fileRecordService     *file_record.FileRecordService
 }
 
 func NewSiteInfoService(
@@ -58,6 +60,7 @@ func NewSiteInfoService(
 	tagCommonService *tagcommon.TagCommonService,
 	configService *config.ConfigService,
 	questioncommon *questioncommon.QuestionCommon,
+	fileRecordService *file_record.FileRecordService,
 
 ) *SiteInfoService {
 	plugin.RegisterGetSiteURLFunc(func() string {
@@ -76,6 +79,7 @@ func NewSiteInfoService(
 		tagCommonService:      tagCommonService,
 		configService:         configService,
 		questioncommon:        questioncommon,
+		fileRecordService:     fileRecordService,
 	}
 }
 
@@ -438,3 +442,43 @@ func (s *SiteInfoService) UpdatePrivilegesConfig(ctx context.Context, req *schem
 	}
 	return
 }
+
+func (s *SiteInfoService) CleanUpRemovedBrandingFiles(
+	ctx context.Context,
+	newBranding *schema.SiteBrandingReq,
+	currentBranding *schema.SiteBrandingResp,
+) error {
+	currentFiles := map[string]string{
+		"logo":        currentBranding.Logo,
+		"mobile_logo": currentBranding.MobileLogo,
+		"square_icon": currentBranding.SquareIcon,
+		"favicon":     currentBranding.Favicon,
+	}
+
+	newFiles := map[string]string{
+		"logo":        newBranding.Logo,
+		"mobile_logo": newBranding.MobileLogo,
+		"square_icon": newBranding.SquareIcon,
+		"favicon":     newBranding.Favicon,
+	}
+
+	for key, currentFile := range currentFiles {
+		newFile := newFiles[key]
+		if currentFile != "" && currentFile != newFile {
+			fileRecord, err := s.fileRecordService.GetFileRecordByURL(ctx, currentFile)
+			if err != nil {
+				log.Error(err)
+				continue
+			}
+			if fileRecord == nil {
+				log.Error("could not fetch file record by url")
+				continue
+			}
+			if err := s.fileRecordService.DeleteAndMoveFileRecord(ctx, fileRecord); err != nil {
+				log.Error(err)
+			}
+		}
+	}
+
+	return nil
+}