bench-forgejo/modules/avatar/avatar.go

340 lines
8.1 KiB
Go
Raw Normal View History

2014-03-23 15:43:23 +05:30
// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
// for www.gravatar.com image cache
2014-03-24 18:46:00 +05:30
/*
It is recommend to use this way
cacheDir := "./cache"
defaultImg := "./default.jpg"
2014-03-26 18:56:31 +05:30
http.Handle("/avatar/", avatar.CacheServer(cacheDir, defaultImg))
2014-03-24 18:46:00 +05:30
*/
package avatar
import (
"crypto/md5"
"encoding/hex"
"errors"
"fmt"
"image"
"image/color/palette"
"image/jpeg"
"image/png"
"io"
"math/rand"
"net/http"
"net/url"
"os"
"path/filepath"
"strings"
"sync"
"time"
2015-09-27 03:24:02 +05:30
"github.com/issue9/identicon"
"github.com/nfnt/resize"
2014-03-25 21:42:27 +05:30
"github.com/gogits/gogs/modules/log"
2014-11-17 08:02:26 +05:30
"github.com/gogits/gogs/modules/setting"
)
2015-11-14 03:13:43 +05:30
//FIXME: remove cache module
2014-11-17 08:02:26 +05:30
var gravatarSource string
func UpdateGravatarSource() {
2014-11-17 08:02:26 +05:30
gravatarSource = setting.GravatarSource
2015-08-29 09:33:40 +05:30
if strings.HasPrefix(gravatarSource, "//") {
gravatarSource = "http:" + gravatarSource
2015-08-29 12:14:38 +05:30
} else if !strings.HasPrefix(gravatarSource, "http://") &&
!strings.HasPrefix(gravatarSource, "https://") {
gravatarSource = "http://" + gravatarSource
2014-11-17 08:02:26 +05:30
}
2015-08-29 09:33:40 +05:30
log.Debug("avatar.UpdateGravatarSource(update gavatar source): %s", gravatarSource)
2014-11-17 08:02:26 +05:30
}
// hash email to md5 string
2014-12-07 06:52:48 +05:30
// keep this func in order to make this package independent
func HashEmail(email string) string {
// https://en.gravatar.com/site/implement/hash/
email = strings.TrimSpace(email)
email = strings.ToLower(email)
h := md5.New()
h.Write([]byte(email))
return hex.EncodeToString(h.Sum(nil))
}
const _RANDOM_AVATAR_SIZE = 200
// RandomImage generates and returns a random avatar image.
func RandomImage(data []byte) (image.Image, error) {
randExtent := len(palette.WebSafe) - 32
rand.Seed(time.Now().UnixNano())
colorIndex := rand.Intn(randExtent)
backColorIndex := colorIndex - 1
if backColorIndex < 0 {
backColorIndex = randExtent - 1
}
// Size, background, forecolor
imgMaker, err := identicon.New(_RANDOM_AVATAR_SIZE,
palette.WebSafe[backColorIndex], palette.WebSafe[colorIndex:colorIndex+32]...)
if err != nil {
return nil, err
}
return imgMaker.Make(data), nil
}
2014-03-28 05:12:10 +05:30
// Avatar represents the avatar object.
type Avatar struct {
Hash string
2014-03-23 15:43:23 +05:30
AlterImage string // image path
cacheDir string // image save dir
reqParams string
imagePath string
expireDuration time.Duration
}
func New(hash string, cacheDir string) *Avatar {
return &Avatar{
Hash: hash,
cacheDir: cacheDir,
expireDuration: time.Minute * 10,
reqParams: url.Values{
"d": {"retro"},
"size": {"200"},
"r": {"pg"}}.Encode(),
imagePath: filepath.Join(cacheDir, hash+".image"), //maybe png or jpeg
}
}
2014-03-23 15:43:23 +05:30
func (this *Avatar) HasCache() bool {
fileInfo, err := os.Stat(this.imagePath)
return err == nil && fileInfo.Mode().IsRegular()
}
func (this *Avatar) Modtime() (modtime time.Time, err error) {
fileInfo, err := os.Stat(this.imagePath)
if err != nil {
return
}
return fileInfo.ModTime(), nil
}
func (this *Avatar) Expired() bool {
2014-03-23 15:43:23 +05:30
modtime, err := this.Modtime()
return err != nil || time.Since(modtime) > this.expireDuration
}
// default image format: jpeg
func (this *Avatar) Encode(wr io.Writer, size int) (err error) {
var img image.Image
decodeImageFile := func(file string) (img image.Image, err error) {
fd, err := os.Open(file)
if err != nil {
return
}
defer fd.Close()
2014-03-28 05:12:10 +05:30
if img, err = jpeg.Decode(fd); err != nil {
fd.Seek(0, os.SEEK_SET)
img, err = png.Decode(fd)
}
return
}
imgPath := this.imagePath
2014-03-23 15:43:23 +05:30
if !this.HasCache() {
if this.AlterImage == "" {
return errors.New("request image failed, and no alt image offered")
}
imgPath = this.AlterImage
}
2014-03-28 05:12:10 +05:30
if img, err = decodeImageFile(imgPath); err != nil {
return
}
2015-11-14 03:13:43 +05:30
m := resize.Resize(uint(size), 0, img, resize.Lanczos3)
return jpeg.Encode(wr, m, nil)
}
// get image from gravatar.com
func (this *Avatar) Update() {
UpdateGravatarSource()
2014-11-17 08:02:26 +05:30
thunder.Fetch(gravatarSource+this.Hash+"?"+this.reqParams,
this.imagePath)
}
2014-03-28 05:12:10 +05:30
func (this *Avatar) UpdateTimeout(timeout time.Duration) (err error) {
UpdateGravatarSource()
select {
case <-time.After(timeout):
2014-03-24 18:46:00 +05:30
err = fmt.Errorf("get gravatar image %s timeout", this.Hash)
2014-11-17 08:02:26 +05:30
case err = <-thunder.GoFetch(gravatarSource+this.Hash+"?"+this.reqParams,
this.imagePath):
}
return err
}
2014-03-26 18:56:31 +05:30
type service struct {
2014-03-23 15:43:23 +05:30
cacheDir string
altImage string
}
2014-03-28 05:12:10 +05:30
func (this *service) mustInt(r *http.Request, defaultValue int, keys ...string) (v int) {
2014-03-23 15:43:23 +05:30
for _, k := range keys {
if _, err := fmt.Sscanf(r.FormValue(k), "%d", &v); err == nil {
defaultValue = v
}
}
2014-03-23 15:43:23 +05:30
return defaultValue
}
2014-03-26 18:56:31 +05:30
func (this *service) ServeHTTP(w http.ResponseWriter, r *http.Request) {
2014-03-23 15:43:23 +05:30
urlPath := r.URL.Path
hash := urlPath[strings.LastIndex(urlPath, "/")+1:]
2014-03-24 18:46:00 +05:30
size := this.mustInt(r, 80, "s", "size") // default size = 80*80
2014-03-23 15:43:23 +05:30
avatar := New(hash, this.cacheDir)
avatar.AlterImage = this.altImage
if avatar.Expired() {
2014-04-16 05:31:20 +05:30
if err := avatar.UpdateTimeout(time.Millisecond * 1000); err != nil {
2014-03-24 18:46:00 +05:30
log.Trace("avatar update error: %v", err)
2014-04-16 05:31:20 +05:30
return
}
}
2014-03-23 15:43:23 +05:30
if modtime, err := avatar.Modtime(); err == nil {
etag := fmt.Sprintf("size(%d)", size)
if t, err := time.Parse(http.TimeFormat, r.Header.Get("If-Modified-Since")); err == nil && modtime.Before(t.Add(1*time.Second)) && etag == r.Header.Get("If-None-Match") {
h := w.Header()
delete(h, "Content-Type")
delete(h, "Content-Length")
w.WriteHeader(http.StatusNotModified)
return
}
w.Header().Set("Last-Modified", modtime.UTC().Format(http.TimeFormat))
w.Header().Set("ETag", etag)
}
w.Header().Set("Content-Type", "image/jpeg")
2014-03-28 05:12:10 +05:30
if err := avatar.Encode(w, size); err != nil {
2014-03-24 18:46:00 +05:30
log.Warn("avatar encode error: %v", err)
2014-03-23 15:43:23 +05:30
w.WriteHeader(500)
}
}
2014-03-26 18:56:31 +05:30
// http.Handle("/avatar/", avatar.CacheServer("./cache"))
func CacheServer(cacheDir string, defaultImgPath string) http.Handler {
return &service{
2014-03-23 15:43:23 +05:30
cacheDir: cacheDir,
altImage: defaultImgPath,
}
}
2014-03-23 15:43:23 +05:30
// thunder downloader
var thunder = &Thunder{QueueSize: 10}
type Thunder struct {
QueueSize int // download queue size
q chan *thunderTask
once sync.Once
}
func (t *Thunder) init() {
if t.QueueSize < 1 {
t.QueueSize = 1
}
t.q = make(chan *thunderTask, t.QueueSize)
for i := 0; i < t.QueueSize; i++ {
go func() {
for {
task := <-t.q
task.Fetch()
}
}()
}
}
func (t *Thunder) Fetch(url string, saveFile string) error {
t.once.Do(t.init)
task := &thunderTask{
Url: url,
SaveFile: saveFile,
}
task.Add(1)
t.q <- task
task.Wait()
return task.err
}
func (t *Thunder) GoFetch(url, saveFile string) chan error {
c := make(chan error)
go func() {
c <- t.Fetch(url, saveFile)
}()
return c
}
// thunder download
type thunderTask struct {
Url string
SaveFile string
sync.WaitGroup
err error
}
func (this *thunderTask) Fetch() {
this.err = this.fetch()
this.Done()
}
var client = &http.Client{}
func (this *thunderTask) fetch() error {
2014-04-16 05:31:20 +05:30
log.Debug("avatar.fetch(fetch new avatar): %s", this.Url)
req, _ := http.NewRequest("GET", this.Url, nil)
req.Header.Set("Accept", "text/html,application/xhtml+xml,application/xml;q=0.9,image/jpeg,image/png,*/*;q=0.8")
req.Header.Set("Accept-Encoding", "deflate,sdch")
req.Header.Set("Accept-Language", "zh-CN,zh;q=0.8")
req.Header.Set("Cache-Control", "no-cache")
req.Header.Set("User-Agent", "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.154 Safari/537.36")
resp, err := client.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
return fmt.Errorf("status code: %d", resp.StatusCode)
}
/*
log.Println("headers:", resp.Header)
switch resp.Header.Get("Content-Type") {
case "image/jpeg":
this.SaveFile += ".jpeg"
case "image/png":
this.SaveFile += ".png"
}
*/
/*
imgType := resp.Header.Get("Content-Type")
if imgType != "image/jpeg" && imgType != "image/png" {
return errors.New("not png or jpeg")
}
*/
tmpFile := this.SaveFile + ".part" // mv to destination when finished
fd, err := os.Create(tmpFile)
if err != nil {
return err
}
_, err = io.Copy(fd, resp.Body)
fd.Close()
if err != nil {
os.Remove(tmpFile)
return err
}
return os.Rename(tmpFile, this.SaveFile)
}