summaryrefslogtreecommitdiffstats
path: root/modules/avatar
diff options
context:
space:
mode:
Diffstat (limited to 'modules/avatar')
-rw-r--r--modules/avatar/avatar.go296
-rw-r--r--modules/avatar/avatar_test.go61
2 files changed, 357 insertions, 0 deletions
diff --git a/modules/avatar/avatar.go b/modules/avatar/avatar.go
new file mode 100644
index 0000000000..edeb256ffe
--- /dev/null
+++ b/modules/avatar/avatar.go
@@ -0,0 +1,296 @@
+// 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
+
+/*
+It is recommend to use this way
+
+ cacheDir := "./cache"
+ defaultImg := "./default.jpg"
+ http.Handle("/avatar/", avatar.CacheServer(cacheDir, defaultImg))
+*/
+package avatar
+
+import (
+ "crypto/md5"
+ "encoding/hex"
+ "errors"
+ "fmt"
+ "image"
+ "image/jpeg"
+ "image/png"
+ "io"
+ "net/http"
+ "net/url"
+ "os"
+ "path/filepath"
+ "strings"
+ "sync"
+ "time"
+
+ "github.com/nfnt/resize"
+
+ "github.com/gogits/gogs/modules/log"
+)
+
+var (
+ gravatar = "http://www.gravatar.com/avatar"
+)
+
+// hash email to md5 string
+// keep this func in order to make this package indenpent
+func HashEmail(email string) string {
+ h := md5.New()
+ h.Write([]byte(strings.ToLower(email)))
+ return hex.EncodeToString(h.Sum(nil))
+}
+
+// Avatar represents the avatar object.
+type Avatar struct {
+ Hash string
+ 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
+ }
+}
+
+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 {
+ 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()
+
+ if img, err = jpeg.Decode(fd); err != nil {
+ fd.Seek(0, os.SEEK_SET)
+ img, err = png.Decode(fd)
+ }
+ return
+ }
+ imgPath := this.imagePath
+ if !this.HasCache() {
+ if this.AlterImage == "" {
+ return errors.New("request image failed, and no alt image offered")
+ }
+ imgPath = this.AlterImage
+ }
+
+ if img, err = decodeImageFile(imgPath); err != nil {
+ return
+ }
+ m := resize.Resize(uint(size), 0, img, resize.Lanczos3)
+ return jpeg.Encode(wr, m, nil)
+}
+
+// get image from gravatar.com
+func (this *Avatar) Update() {
+ thunder.Fetch(gravatar+"/"+this.Hash+"?"+this.reqParams,
+ this.imagePath)
+}
+
+func (this *Avatar) UpdateTimeout(timeout time.Duration) (err error) {
+ select {
+ case <-time.After(timeout):
+ err = fmt.Errorf("get gravatar image %s timeout", this.Hash)
+ case err = <-thunder.GoFetch(gravatar+"/"+this.Hash+"?"+this.reqParams,
+ this.imagePath):
+ }
+ return err
+}
+
+type service struct {
+ cacheDir string
+ altImage string
+}
+
+func (this *service) mustInt(r *http.Request, defaultValue int, keys ...string) (v int) {
+ for _, k := range keys {
+ if _, err := fmt.Sscanf(r.FormValue(k), "%d", &v); err == nil {
+ defaultValue = v
+ }
+ }
+ return defaultValue
+}
+
+func (this *service) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+ urlPath := r.URL.Path
+ hash := urlPath[strings.LastIndex(urlPath, "/")+1:]
+ size := this.mustInt(r, 80, "s", "size") // default size = 80*80
+
+ avatar := New(hash, this.cacheDir)
+ avatar.AlterImage = this.altImage
+ if avatar.Expired() {
+ err := avatar.UpdateTimeout(time.Millisecond * 500)
+ if err != nil {
+ log.Trace("avatar update error: %v", err)
+ }
+ }
+ 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")
+
+ if err := avatar.Encode(w, size); err != nil {
+ log.Warn("avatar encode error: %v", err)
+ w.WriteHeader(500)
+ }
+}
+
+// http.Handle("/avatar/", avatar.CacheServer("./cache"))
+func CacheServer(cacheDir string, defaultImgPath string) http.Handler {
+ return &service{
+ cacheDir: cacheDir,
+ altImage: defaultImgPath,
+ }
+}
+
+// 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 {
+ 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)
+}
diff --git a/modules/avatar/avatar_test.go b/modules/avatar/avatar_test.go
new file mode 100644
index 0000000000..0cbf70fe60
--- /dev/null
+++ b/modules/avatar/avatar_test.go
@@ -0,0 +1,61 @@
+// 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.
+package avatar_test
+
+import (
+ "errors"
+ "os"
+ "strconv"
+ "testing"
+ "time"
+
+ "github.com/gogits/gogs/modules/avatar"
+ "github.com/gogits/gogs/modules/log"
+)
+
+const TMPDIR = "test-avatar"
+
+func TestFetch(t *testing.T) {
+ os.Mkdir(TMPDIR, 0755)
+ defer os.RemoveAll(TMPDIR)
+
+ hash := avatar.HashEmail("ssx205@gmail.com")
+ a := avatar.New(hash, TMPDIR)
+ a.UpdateTimeout(time.Millisecond * 200)
+}
+
+func TestFetchMany(t *testing.T) {
+ os.Mkdir(TMPDIR, 0755)
+ defer os.RemoveAll(TMPDIR)
+
+ t.Log("start")
+ var n = 5
+ ch := make(chan bool, n)
+ for i := 0; i < n; i++ {
+ go func(i int) {
+ hash := avatar.HashEmail(strconv.Itoa(i) + "ssx205@gmail.com")
+ a := avatar.New(hash, TMPDIR)
+ a.Update()
+ t.Log("finish", hash)
+ ch <- true
+ }(i)
+ }
+ for i := 0; i < n; i++ {
+ <-ch
+ }
+ t.Log("end")
+}
+
+// cat
+// wget http://www.artsjournal.com/artfulmanager/wp/wp-content/uploads/2013/12/200x200xmirror_cat.jpg.pagespeed.ic.GOZSv6v1_H.jpg -O default.jpg
+/*
+func TestHttp(t *testing.T) {
+ http.Handle("/", avatar.CacheServer("./", "default.jpg"))
+ http.ListenAndServe(":8001", nil)
+}
+*/
+
+func TestLogTrace(t *testing.T) {
+ log.Trace("%v", errors.New("console log test"))
+}