Implement Avatar Handler

Author: masudur-rahman

custom/conf/app.ini.sample

@@ -792,3 +792,9 @@ IS_INPUT_FILE = false
 ENABLED = false
 ; If you want to add authorization, specify a token here
 TOKEN =
+
+[storage]
+; URL of Bucket where files, such as, attachments, avatars, etc. are stored
+; If unset, file://<current_directory> is used to maintain backward compatibility
+; Consult https://gocloud.dev/howto/blob/ for URL format for various cloud providers
+BUCKET_URL =

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -507,8 +507,12 @@ Two special environment variables are passed to the render command:
 - `FORMAT`: Time format to diplay on UI. i.e. RFC1123 or 2006-01-02 15:04:05
 - `DEFAULT_UI_LOCATION`: Default location of time on the UI, so that we can display correct user's time on UI. i.e. Shanghai/Asia
 
+## Storage (`storage`)
+
+- `BUCKET_URL`: URL of Bucket where files, such as, attachments, avatars, etc. are stored. If unset, file://<current_directory> is used to maintain backward compatibility. Consult https://gocloud.dev/howto/blob/ for URL format for various cloud providers.
+
 ## Other (`other`)
 
 - `SHOW_FOOTER_BRANDING`: **false**: Show Gitea branding in the footer.
 - `SHOW_FOOTER_VERSION`: **true**: Show Gitea version information in the footer.
-- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: Show time of template execution in the footer.
+- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: Show time of template execution in the footer.

docs/content/doc/advanced/config-cheat-sheet.en-us.md.orig

@@ -25,7 +25,6 @@ require (
 	github.com/cznic/b v0.0.0-20181122101859-a26611c4d92d // indirect
 	github.com/cznic/mathutil v0.0.0-20181122101859-297441e03548 // indirect
 	github.com/cznic/strutil v0.0.0-20181122101858-275e90344537 // indirect
-	github.com/davecgh/go-spew v1.1.1
 	github.com/denisenkom/go-mssqldb v0.0.0-20190724012636-11b2859924c1
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/edsrzf/mmap-go v0.0.0-20170320065105-0bce6a688712 // indirect

go.mod

@@ -8,6 +8,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"os"
 	"path"
 
 	"code.gitea.io/gitea/modules/setting"
@@ -72,38 +73,44 @@ func (a *Attachment) DownloadURL() string {
 	return fmt.Sprintf("%sattachments/%s", setting.AppURL, a.UUID)
 }
 
-// uploadAttachmentToBucket uploads attachments to bucket
-func (attach *Attachment) UploadAttachmentToBucket(buf []byte, file io.Reader) (*Attachment, error) {
+// UploadToBucket uploads attachments to bucket
+func (a *Attachment) UploadToBucket(buf []byte, file io.Reader) (*Attachment, error) {
 	ctx := context.Background()
-	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.Bucket)
+	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.BucketURL)
 	if err != nil {
-		return nil, fmt.Errorf("Failed to setup bucket: %v", err)
+		return nil, fmt.Errorf("could not open bucket: %v", err)
 	}
-	bucket = blob.PrefixedBucket(bucket, "data/attachments/")
+	bucket = blob.PrefixedBucket(bucket, setting.AttachmentPath)
+	defer bucket.Close()
 
-	bucketWriter, err := bucket.NewWriter(ctx, attach.LocalPath(), nil)
+	bw, err := bucket.NewWriter(ctx, a.LocalPath(), nil)
 	if err != nil {
-		return nil, fmt.Errorf("Failed to obtain writer: %v", err)
+		return nil, fmt.Errorf("failed to obtain writer: %v", err)
 	}
-	var fileSize int64
-	if _, err = bucketWriter.Write(buf); err != nil {
+
+	if _, err = bw.Write(buf); err != nil {
 		return nil, fmt.Errorf("error occurred while writing: %v", err)
-	} else if fileSize, err = io.Copy(bucketWriter, file); err != nil {
+	} else if _, err = io.Copy(bw, file); err != nil {
 		return nil, fmt.Errorf("error occurred while copying: %v", err)
 	}
-	attach.Size = fileSize
+	if err = bw.Close(); err != nil {
+		return nil, fmt.Errorf("failed to close: %v", err)
+	}
 
-	if err = bucketWriter.Close(); err != nil {
-		return nil, fmt.Errorf("Failed to close: %v", err)
+	attrs, err := bucket.Attributes(ctx, a.LocalPath())
+	if err != nil {
+		return nil, fmt.Errorf("failed to read attributes: %v", err)
 	}
-	return attach, nil
+	a.Size = attrs.Size
+
+	return a, nil
 }
 
 // NewAttachment creates a new attachment object.
 func NewAttachment(attach *Attachment, buf []byte, file io.Reader) (_ *Attachment, err error) {
 	attach.UUID = gouuid.NewV4().String()
 
-	attach, err = attach.UploadAttachmentToBucket(buf, file)
+	attach, err = attach.UploadToBucket(buf, file)
 	if err != nil {
 		return nil, err
 	}
@@ -194,47 +201,44 @@ func getAttachmentByReleaseIDFileName(e Engine, releaseID int64, fileName string
 	return attach, nil
 }
 
-// GetAttachmentReader provides attachment reader from bucket
-func (attach *Attachment) GetAttachmentReader() (io.ReadCloser, error) {
+// Open provides attachment reader from bucket
+func (a *Attachment) Open() (io.ReadCloser, error) {
 	ctx := context.Background()
-	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.Bucket)
+	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.BucketURL)
 	if err != nil {
-		return nil, fmt.Errorf("Failed to setup bucket %v", err)
+		return nil, fmt.Errorf("could not open bucket %v", err)
 	}
-	bucket = blob.PrefixedBucket(bucket, "data/attachments/")
+	bucket = blob.PrefixedBucket(bucket, setting.AttachmentPath)
+	defer bucket.Close()
 
-	exist, err := bucket.Exists(ctx, attach.LocalPath())
+	exist, err := bucket.Exists(ctx, a.LocalPath())
 	if err != nil {
 		return nil, err
 	} else if !exist {
-		return nil, fmt.Errorf("Attachment not found")
-	}
-
-	reader, err := bucket.NewReader(ctx, attach.LocalPath(), nil)
-	if err != nil {
-		return nil, err
+		return nil, os.ErrNotExist
 	}
 
-	return reader, nil
+	return bucket.NewReader(ctx, a.LocalPath(), nil)
 }
 
-// deleteAttachmentFromBucket deletes attachments from bucket
-func (attach *Attachment) deleteAttachmentFromBucket() error {
+// deleteFromBucket deletes attachments from bucket
+func (a *Attachment) deleteFromBucket() error {
 	ctx := context.Background()
-	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.Bucket)
+	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.BucketURL)
 	if err != nil {
-		return fmt.Errorf("Failed to setup bucket: %v", err)
+		return fmt.Errorf("could not open bucket: %v", err)
 	}
-	bucket = blob.PrefixedBucket(bucket, "data/attachments/")
+	bucket = blob.PrefixedBucket(bucket, setting.AttachmentPath)
+	defer bucket.Close()
 
-	exist, err := bucket.Exists(ctx, attach.LocalPath())
+	exist, err := bucket.Exists(ctx, a.LocalPath())
 	if err != nil {
 		return err
 	} else if !exist {
-		return fmt.Errorf("repo avatar not found")
+		return os.ErrNotExist
 	}
 
-	return bucket.Delete(ctx, attach.LocalPath())
+	return bucket.Delete(ctx, a.LocalPath())
 }
 
 // DeleteAttachment deletes the given attachment and optionally the associated file.
@@ -261,7 +265,7 @@ func DeleteAttachments(attachments []*Attachment, remove bool) (int, error) {
 
 	if remove {
 		for i, a := range attachments {
-			if err := a.deleteAttachmentFromBucket(); err != nil {
+			if err := a.deleteFromBucket(); err != nil {
 				return i, err
 			}
 		}

models/attachment.go

@@ -2544,7 +2544,6 @@ func (repo *Repository) generateRandomAvatar(e Engine) error {
 	}
 
 	repo.Avatar = idToString
-
 	if err := repo.uploadAvatarToBucket(img); err != nil {
 		return err
 	}
@@ -2578,55 +2577,23 @@ func (repo *Repository) RelAvatarLink() string {
 	return repo.relAvatarLink(x)
 }
 
-// getAvatarLinkFromBucket returns repo avatar link from bucket
-func (repo *Repository) getAvatarLinkFromBucket() (string, error) {
-	ctx := context.Background()
-
-	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.Bucket)
-	if err != nil {
-		return "", fmt.Errorf("Failed to setup bucket: %v", err)
-	}
-	bucket = blob.PrefixedBucket(bucket, setting.RepositoryAvatarUploadPath+"/")
-
-	exist, err := bucket.Exists(ctx, repo.Avatar)
-	if exist {
-		opts := &blob.SignedURLOptions{
-			Expiry: blob.DefaultSignedURLExpiry,
-		}
-		signedUrl, err := bucket.SignedURL(ctx, repo.Avatar, opts)
-		if err != nil {
-			return "", err
-		}
-		return signedUrl, nil
-	}
-	return "", fmt.Errorf("File doesn't exist, error %v", err)
-}
-
 func (repo *Repository) relAvatarLink(e Engine) string {
 	// If no avatar - path is empty
 	avatarPath := repo.CustomAvatarPath()
-
-	var avatarLink string
-	var err error
-
-	if len(avatarPath) > 0 {
-		avatarLink, err = repo.getAvatarLinkFromBucket()
-	}
-	if len(avatarPath) == 0 || err != nil {
+	if len(avatarPath) == 0 || !isAvatarValid(repo.CustomAvatarPath()) {
 		switch mode := setting.RepositoryAvatarFallback; mode {
 		case "image":
 			return setting.RepositoryAvatarFallbackImage
 		case "random":
 			if err := repo.generateRandomAvatar(e); err != nil {
 				log.Error("generateRandomAvatar: %v", err)
 			}
-			avatarLink, _ = repo.getAvatarLinkFromBucket()
 		default:
 			// default behaviour: do not display avatar
 			return ""
 		}
 	}
-	return avatarLink
+	return setting.AppSubURL + "/avatars?obj=" + repo.CustomAvatarPath()
 }
 
 // avatarLink returns user avatar absolute link.
@@ -2644,27 +2611,28 @@ func (repo *Repository) avatarLink(e Engine) string {
 // uploadAvatarToBucket uploads repo avatar to bucket
 func (repo *Repository) uploadAvatarToBucket(img image.Image) error {
 	ctx := context.Background()
-	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.Bucket)
+	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.BucketURL)
 	if err != nil {
-		return fmt.Errorf("failed to setup bucket: %v", err)
+		return fmt.Errorf("could not open bucket: %v", err)
 	}
-	bucket = blob.PrefixedBucket(bucket, setting.RepositoryAvatarUploadPath+"/")
+	bucket = blob.PrefixedBucket(bucket, setting.RepositoryAvatarUploadPath)
+	defer bucket.Close()
 
 	buf := new(bytes.Buffer)
 	if err = png.Encode(buf, img); err != nil {
 		return fmt.Errorf("failed to encode: %v", err)
 	}
 	imgData := buf.Bytes()
 
-	bucketWriter, err := bucket.NewWriter(ctx, repo.Avatar, nil)
+	bw, err := bucket.NewWriter(ctx, repo.Avatar, nil)
 	if err != nil {
 		return fmt.Errorf("failed to obtain writer: %v", err)
 	}
 
-	if _, err = bucketWriter.Write(imgData); err != nil {
-		return fmt.Errorf("error occurred: %v", err)
+	if _, err = bw.Write(imgData); err != nil {
+		return fmt.Errorf("failed to write: %v", err)
 	}
-	if err = bucketWriter.Close(); err != nil {
+	if err = bw.Close(); err != nil {
 		return fmt.Errorf("failed to close: %v", err)
 	}
 
@@ -2692,42 +2660,42 @@ func (repo *Repository) UploadAvatar(data []byte) error {
 	// Then repo will be removed - only it avatar file will be removed
 	newAvatar := fmt.Sprintf("%d-%x", repo.ID, md5.Sum(data))
 	repo.Avatar = newAvatar
-	if len(oldAvatarPath) > 0 && oldAvatarPath != repo.CustomAvatarPath() {
-		repo.Avatar = oldAvatar
-		if err := repo.deleteAvatarFromBucket(); err != nil {
-			log.Trace("DeleteOldAvatar: ", err)
-		}
-	}
-	repo.Avatar = newAvatar
-
 	if _, err := sess.ID(repo.ID).Cols("avatar").Update(repo); err != nil {
 		return fmt.Errorf("UploadAvatar: Update repository avatar: %v", err)
 	}
 
-	if err := repo.uploadAvatarToBucket(*m); err != nil {
+	if err := repo.uploadAvatarToBucket(m); err != nil {
 		return err
 	}
 
+	if len(oldAvatarPath) > 0 && oldAvatarPath != repo.CustomAvatarPath() {
+		repo.Avatar = oldAvatar
+		if err := repo.deleteAvatarFromBucket(); err != nil {
+			log.Trace("DeleteOldAvatar: ", err)
+		}
+		repo.Avatar = newAvatar
+	}
+
 	return sess.Commit()
 }
 
 // deleteAvatarFromBucket deletes repo avatar from bucket
 func (repo *Repository) deleteAvatarFromBucket() error {
 	ctx := context.Background()
-	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.Bucket)
+	bucket, err := blob.OpenBucket(ctx, setting.FileStorage.BucketURL)
 	if err != nil {
-		return fmt.Errorf("Failed to setup bucket: %v", err)
+		return fmt.Errorf("could not open bucket: %v", err)
 	}
-	bucket = blob.PrefixedBucket(bucket, setting.RepositoryAvatarUploadPath+"/")
+	bucket = blob.PrefixedBucket(bucket, setting.RepositoryAvatarUploadPath)
+	defer bucket.Close()
 
 	exist, err := bucket.Exists(ctx, repo.Avatar)
 	if err != nil {
 		return err
-	} else if !exist {
-		return errors.New("Repo avatar not found")
+	} else if exist {
+		return bucket.Delete(ctx, repo.Avatar)
 	}
-
-	return bucket.Delete(ctx, repo.Avatar)
+	return nil
 }
 
 // DeleteAvatar deletes the repos's custom avatar.