Gitea/models/avatars/avatar.go

// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package avatars

import (
	"context"
	"net/url"
	"path"
	"strconv"
	"strings"

	"gitea.dev/models/db"
	"gitea.dev/modules/avatar"
	"gitea.dev/modules/base"
	"gitea.dev/modules/cache"
	"gitea.dev/modules/log"
	"gitea.dev/modules/setting"

	"xorm.io/builder"
)

const (
	// DefaultAvatarClass is the default class of a rendered avatar
	DefaultAvatarClass = "ui avatar tw-align-middle"
	// DefaultAvatarPixelSize is the default size in pixels of a rendered avatar
	DefaultAvatarPixelSize = 28
)

const emailHashType = "sha256" // so a later algorithm change can tell old rows apart

// EmailHash keeps the email out of the rendered page
type EmailHash struct {
	Hash     string `xorm:"pk varchar(64)"`
	Email    string `xorm:"UNIQUE(email_hashtype) NOT NULL"`
	HashType string `xorm:"UNIQUE(email_hashtype) NOT NULL varchar(16)"`
}

func init() {
	db.RegisterModel(new(EmailHash))
}

// DefaultAvatarLink the default avatar link
func DefaultAvatarLink() string {
	return setting.AppSubURL + "/assets/img/avatar_default.png"
}

// HashEmail hashes an email address the way avatar services address it. https://docs.gravatar.com/api/avatars/images/
func HashEmail(email string) string {
	return base.EncodeSha256(strings.ToLower(strings.TrimSpace(email)))
}

func emailHashCacheKey(hash string) string {
	return cache.SafeCacheKey("Avatar", hash)
}

// GetEmailForHash converts a provided hash to the email
func GetEmailForHash(ctx context.Context, hash string) (string, error) {
	hash = strings.ToLower(strings.TrimSpace(hash))
	return cache.GetString(emailHashCacheKey(hash), func() (string, error) {
		emailHash, has, err := db.Get[EmailHash](ctx, builder.Eq{"`hash`": hash})
		if err != nil {
			return "", err
		} else if !has {
			return "", nil
		}
		return emailHash.Email, nil
	})
}

// saveEmailHash returns the hash and stores the pair for GetEmailForHash
func saveEmailHash(ctx context.Context, email string) string {
	lowerEmail := strings.ToLower(strings.TrimSpace(email))
	emailHash := HashEmail(lowerEmail)
	// a key of its own, GetEmailForHash caches an unknown hash as empty
	_, _ = cache.GetString(cache.SafeCacheKey("AvatarStored", emailHash), func() (string, error) {
		// the check keeps a duplicate key error out of a transaction the caller may hold
		has, err := db.Exist[EmailHash](ctx, builder.Eq{"`hash`": emailHash})
		if err == nil && !has {
			_, err = db.GetEngine(ctx).Insert(&EmailHash{Email: lowerEmail, Hash: emailHash, HashType: emailHashType})
			cache.Remove(emailHashCacheKey(emailHash)) // a lookup may have cached it as unknown
		}
		return lowerEmail, err // an error must leave the hash unmarked
	})
	return emailHash
}

// GenerateUserAvatarFastLink returns a fast link (302) to the user's avatar: "/user/avatar/${User.Name}/${size}"
func GenerateUserAvatarFastLink(userName string, size int) string {
	if size < 0 {
		size = 0
	}
	return setting.AppSubURL + "/user/avatar/" + url.PathEscape(userName) + "/" + strconv.Itoa(size)
}

// GenerateUserAvatarImageLink returns a link for `User.Avatar` image file: "/avatars/${User.Avatar}"
func GenerateUserAvatarImageLink(userAvatar string, size int) string {
	if size > 0 {
		return setting.AppSubURL + "/avatars/" + url.PathEscape(userAvatar) + "?size=" + strconv.Itoa(size)
	}
	return setting.AppSubURL + "/avatars/" + url.PathEscape(userAvatar)
}

func generateSourceAvatarURL(source url.URL, email string, size int) string {
	source.Path = path.Join(source.Path, HashEmail(email))
	urlQuery := source.Query()
	urlQuery.Set("d", "identicon")
	if size > 0 {
		urlQuery.Set("s", strconv.Itoa(size))
	}
	source.RawQuery = urlQuery.Encode()
	return source.String()
}

// generateEmailAvatarLink returns a email avatar link, a final link may query DNS
func generateEmailAvatarLink(ctx context.Context, email string, size int, final bool) string {
	email = strings.TrimSpace(email)
	if email == "" {
		return DefaultAvatarLink()
	}

	federated := setting.Config().Picture.EnableFederatedAvatar.Value(ctx)
	if federated && !final {
		// return a 302 link, so page rendering never waits for the DNS query
		link := setting.AppSubURL + "/avatar/" + url.PathEscape(saveEmailHash(ctx, email))
		if size > 0 {
			link += "?size=" + strconv.Itoa(size)
		}
		return link
	}
	if !federated && setting.Config().Picture.DisableGravatar.Value(ctx) {
		return DefaultAvatarLink()
	}

	source, err := url.Parse(setting.GravatarSource)
	if err != nil {
		log.Error("unable to parse GravatarSource %q: %v", setting.GravatarSource, err)
		return DefaultAvatarLink()
	}
	if federated {
		if host := avatar.LookupFederatedHost(ctx, email, source.Scheme == "https"); host != "" {
			source.Host, source.Path = host, "/avatar"
		}
	}
	return generateSourceAvatarURL(*source, email, size)
}

// GenerateEmailAvatarFastLink returns a avatar link (fast, the link may be a delegated one: "/avatar/${hash}")
func GenerateEmailAvatarFastLink(ctx context.Context, email string, size int) string {
	return generateEmailAvatarLink(ctx, email, size, false)
}

// GenerateEmailAvatarFinalLink returns a avatar final link (maybe slow)
func GenerateEmailAvatarFinalLink(ctx context.Context, email string, size int) string {
	return generateEmailAvatarLink(ctx, email, size, true)
}