mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-25 21:44:20 -04:00
Why this refactor The goal is to move most files from `models` package to `models.xxx` package. Many models depend on avatar model, so just move this first. And the existing logic is not clear, there are too many function like `AvatarLink`, `RelAvatarLink`, `SizedRelAvatarLink`, `SizedAvatarLink`, `MakeFinalAvatarURL`, `HashedAvatarLink`, etc. This refactor make everything clear: * user.AvatarLink() * user.AvatarLinkWithSize(size) * avatars.GenerateEmailAvatarFastLink(email, size) * avatars.GenerateEmailAvatarFinalLink(email, size) And many duplicated code are deleted in route handler, the handler and the model share the same avatar logic now.
161 lines
4.4 KiB
Go
161 lines
4.4 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package models
|
|
|
|
import (
|
|
"crypto/md5"
|
|
"fmt"
|
|
"image/png"
|
|
"io"
|
|
|
|
"code.gitea.io/gitea/models/avatars"
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/modules/avatar"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/storage"
|
|
)
|
|
|
|
// CustomAvatarRelativePath returns user custom avatar relative path.
|
|
func (u *User) CustomAvatarRelativePath() string {
|
|
return u.Avatar
|
|
}
|
|
|
|
// GenerateRandomAvatar generates a random avatar for user.
|
|
func (u *User) GenerateRandomAvatar() error {
|
|
return u.generateRandomAvatar(db.GetEngine(db.DefaultContext))
|
|
}
|
|
|
|
func (u *User) generateRandomAvatar(e db.Engine) error {
|
|
seed := u.Email
|
|
if len(seed) == 0 {
|
|
seed = u.Name
|
|
}
|
|
|
|
img, err := avatar.RandomImage([]byte(seed))
|
|
if err != nil {
|
|
return fmt.Errorf("RandomImage: %v", err)
|
|
}
|
|
|
|
u.Avatar = avatars.HashEmail(seed)
|
|
|
|
// Don't share the images so that we can delete them easily
|
|
if err := storage.SaveFrom(storage.Avatars, u.CustomAvatarRelativePath(), func(w io.Writer) error {
|
|
if err := png.Encode(w, img); err != nil {
|
|
log.Error("Encode: %v", err)
|
|
}
|
|
return err
|
|
}); err != nil {
|
|
return fmt.Errorf("Failed to create dir %s: %v", u.CustomAvatarRelativePath(), err)
|
|
}
|
|
|
|
if _, err := e.ID(u.ID).Cols("avatar").Update(u); err != nil {
|
|
return err
|
|
}
|
|
|
|
log.Info("New random avatar created: %d", u.ID)
|
|
return nil
|
|
}
|
|
|
|
// AvatarLinkWithSize returns a link to the user's avatar with size. size <= 0 means default size
|
|
func (u *User) AvatarLinkWithSize(size int) string {
|
|
if u.ID == -1 {
|
|
// ghost user
|
|
return avatars.DefaultAvatarLink()
|
|
}
|
|
|
|
useLocalAvatar := false
|
|
autoGenerateAvatar := false
|
|
|
|
switch {
|
|
case u.UseCustomAvatar:
|
|
useLocalAvatar = true
|
|
case setting.DisableGravatar, setting.OfflineMode:
|
|
useLocalAvatar = true
|
|
autoGenerateAvatar = true
|
|
}
|
|
|
|
if useLocalAvatar {
|
|
if u.Avatar == "" && autoGenerateAvatar {
|
|
if err := u.GenerateRandomAvatar(); err != nil {
|
|
log.Error("GenerateRandomAvatar: %v", err)
|
|
}
|
|
}
|
|
if u.Avatar == "" {
|
|
return avatars.DefaultAvatarLink()
|
|
}
|
|
return avatars.GenerateUserAvatarImageLink(u.Avatar, size)
|
|
}
|
|
return avatars.GenerateEmailAvatarFastLink(u.AvatarEmail, size)
|
|
}
|
|
|
|
// AvatarLink returns a avatar link with default size
|
|
func (u *User) AvatarLink() string {
|
|
return u.AvatarLinkWithSize(0)
|
|
}
|
|
|
|
// UploadAvatar saves custom avatar for user.
|
|
// FIXME: split uploads to different subdirs in case we have massive users.
|
|
func (u *User) UploadAvatar(data []byte) error {
|
|
m, err := avatar.Prepare(data)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
sess := db.NewSession(db.DefaultContext)
|
|
defer sess.Close()
|
|
if err = sess.Begin(); err != nil {
|
|
return err
|
|
}
|
|
|
|
u.UseCustomAvatar = true
|
|
// Different users can upload same image as avatar
|
|
// If we prefix it with u.ID, it will be separated
|
|
// Otherwise, if any of the users delete his avatar
|
|
// Other users will lose their avatars too.
|
|
u.Avatar = fmt.Sprintf("%x", md5.Sum([]byte(fmt.Sprintf("%d-%x", u.ID, md5.Sum(data)))))
|
|
if err = updateUserCols(sess, u, "use_custom_avatar", "avatar"); err != nil {
|
|
return fmt.Errorf("updateUser: %v", err)
|
|
}
|
|
|
|
if err := storage.SaveFrom(storage.Avatars, u.CustomAvatarRelativePath(), func(w io.Writer) error {
|
|
if err := png.Encode(w, *m); err != nil {
|
|
log.Error("Encode: %v", err)
|
|
}
|
|
return err
|
|
}); err != nil {
|
|
return fmt.Errorf("Failed to create dir %s: %v", u.CustomAvatarRelativePath(), err)
|
|
}
|
|
|
|
return sess.Commit()
|
|
}
|
|
|
|
// IsUploadAvatarChanged returns true if the current user's avatar would be changed with the provided data
|
|
func (u *User) IsUploadAvatarChanged(data []byte) bool {
|
|
if !u.UseCustomAvatar || len(u.Avatar) == 0 {
|
|
return true
|
|
}
|
|
avatarID := fmt.Sprintf("%x", md5.Sum([]byte(fmt.Sprintf("%d-%x", u.ID, md5.Sum(data)))))
|
|
return u.Avatar != avatarID
|
|
}
|
|
|
|
// DeleteAvatar deletes the user's custom avatar.
|
|
func (u *User) DeleteAvatar() error {
|
|
aPath := u.CustomAvatarRelativePath()
|
|
log.Trace("DeleteAvatar[%d]: %s", u.ID, aPath)
|
|
if len(u.Avatar) > 0 {
|
|
if err := storage.Avatars.Delete(aPath); err != nil {
|
|
return fmt.Errorf("Failed to remove %s: %v", aPath, err)
|
|
}
|
|
}
|
|
|
|
u.UseCustomAvatar = false
|
|
u.Avatar = ""
|
|
if _, err := db.GetEngine(db.DefaultContext).ID(u.ID).Cols("avatar, use_custom_avatar").Update(u); err != nil {
|
|
return fmt.Errorf("UpdateUser: %v", err)
|
|
}
|
|
return nil
|
|
}
|