mirror of
https://github.com/willnorris/imageproxy.git
synced 2024-12-16 21:56:43 -05:00
add basic caching support
includes two implementations, a no-op NopCache and an in-memory MemoryCache.
This commit is contained in:
parent
a8fb3012bd
commit
95fdd8b79f
6 changed files with 167 additions and 12 deletions
17
cache/cache.go
vendored
Normal file
17
cache/cache.go
vendored
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
// Package cache implements a image cache.
|
||||||
|
package cache
|
||||||
|
|
||||||
|
import "github.com/willnorris/go-imageproxy/data"
|
||||||
|
|
||||||
|
// Cache provides a cache for image metadata and transformed variants of the
|
||||||
|
// image.
|
||||||
|
type Cache interface {
|
||||||
|
// Get retrieves the cached Image for the provided image URL.
|
||||||
|
Get(string) (image *data.Image, ok bool)
|
||||||
|
|
||||||
|
// Put caches the provided Image.
|
||||||
|
Save(*data.Image)
|
||||||
|
|
||||||
|
// Delete deletes the cached Image and all variants for the image at the specified URL.
|
||||||
|
Delete(string)
|
||||||
|
}
|
27
cache/memory.go
vendored
Normal file
27
cache/memory.go
vendored
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
package cache
|
||||||
|
|
||||||
|
import "github.com/willnorris/go-imageproxy/data"
|
||||||
|
|
||||||
|
// MemoryCache provides an in-memory Cache implementation.
|
||||||
|
type MemoryCache struct {
|
||||||
|
images map[string]*data.Image
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewMemoryCache() *MemoryCache {
|
||||||
|
return &MemoryCache{
|
||||||
|
make(map[string]*data.Image),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c MemoryCache) Get(u string) (*data.Image, bool) {
|
||||||
|
image, ok := c.images[u]
|
||||||
|
return image, ok
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c MemoryCache) Save(image *data.Image) {
|
||||||
|
c.images[image.URL] = image
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c MemoryCache) Delete(u string) {
|
||||||
|
delete(c.images, u)
|
||||||
|
}
|
12
cache/nop.go
vendored
Normal file
12
cache/nop.go
vendored
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
package cache
|
||||||
|
|
||||||
|
import "github.com/willnorris/go-imageproxy/data"
|
||||||
|
|
||||||
|
// NopCache provides a no-op cache implementation that doesn't actually cache anything.
|
||||||
|
var NopCache = new(nopCache)
|
||||||
|
|
||||||
|
type nopCache struct{}
|
||||||
|
|
||||||
|
func (c nopCache) Get(u string) (*data.Image, bool) { return nil, false }
|
||||||
|
func (c nopCache) Save(image *data.Image) {}
|
||||||
|
func (c nopCache) Delete(u string) {}
|
22
data/data.go
22
data/data.go
|
@ -7,13 +7,14 @@ import (
|
||||||
"net/url"
|
"net/url"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Transform specifies transformations that can be performed on a
|
// Transform specifies transformations that can be performed on a
|
||||||
// requested image.
|
// requested image.
|
||||||
type Transform struct {
|
type Transform struct {
|
||||||
Width int `json:"width"` // requested width, in pixels
|
Width int // requested width, in pixels
|
||||||
Height int `json:"height"` // requested height, in pixels
|
Height int // requested height, in pixels
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o Transform) String() string {
|
func (o Transform) String() string {
|
||||||
|
@ -53,3 +54,20 @@ type Request struct {
|
||||||
URL *url.URL // URL of the image to proxy
|
URL *url.URL // URL of the image to proxy
|
||||||
Transform *Transform // Image transformation to perform
|
Transform *Transform // Image transformation to perform
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Image represents a remote image that is being proxied. It tracks where
|
||||||
|
// the image was originally retrieved from and how long the image can be cached.
|
||||||
|
type Image struct {
|
||||||
|
// URL of original remote image.
|
||||||
|
URL string
|
||||||
|
|
||||||
|
// Expires is the cache expiration time for the original image, as
|
||||||
|
// returned by the remote server.
|
||||||
|
Expires time.Time
|
||||||
|
|
||||||
|
// Etag returned from server when fetching image.
|
||||||
|
Etag string
|
||||||
|
|
||||||
|
// Bytes contains the actual image.
|
||||||
|
Bytes []byte
|
||||||
|
}
|
||||||
|
|
|
@ -1,16 +1,26 @@
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/willnorris/go-imageproxy/cache"
|
||||||
"github.com/willnorris/go-imageproxy/proxy"
|
"github.com/willnorris/go-imageproxy/proxy"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var port = flag.Int("port", 8080, "port to listen on")
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
flag.Parse()
|
||||||
|
|
||||||
|
fmt.Printf("go-imageproxy listening on port %d\n", *port)
|
||||||
|
|
||||||
p := proxy.NewProxy(nil)
|
p := proxy.NewProxy(nil)
|
||||||
|
p.Cache = cache.NewMemoryCache()
|
||||||
server := &http.Server{
|
server := &http.Server{
|
||||||
Addr: ":8080",
|
Addr: fmt.Sprintf(":%d", *port),
|
||||||
Handler: p,
|
Handler: p,
|
||||||
}
|
}
|
||||||
err := server.ListenAndServe()
|
err := server.ListenAndServe()
|
||||||
|
|
|
@ -2,12 +2,17 @@
|
||||||
package proxy
|
package proxy
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io/ioutil"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/golang/glog"
|
||||||
|
"github.com/willnorris/go-imageproxy/cache"
|
||||||
"github.com/willnorris/go-imageproxy/data"
|
"github.com/willnorris/go-imageproxy/data"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -60,6 +65,7 @@ func NewRequest(r *http.Request) (*data.Request, error) {
|
||||||
// Proxy serves image requests.
|
// Proxy serves image requests.
|
||||||
type Proxy struct {
|
type Proxy struct {
|
||||||
Client *http.Client // client used to fetch remote URLs
|
Client *http.Client // client used to fetch remote URLs
|
||||||
|
Cache cache.Cache
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewProxy constructs a new proxy. The provided http Client will be used to
|
// NewProxy constructs a new proxy. The provided http Client will be used to
|
||||||
|
@ -68,7 +74,7 @@ func NewProxy(client *http.Client) *Proxy {
|
||||||
if client == nil {
|
if client == nil {
|
||||||
client = http.DefaultClient
|
client = http.DefaultClient
|
||||||
}
|
}
|
||||||
return &Proxy{Client: client}
|
return &Proxy{Client: client, Cache: cache.NopCache}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ServeHTTP handles image requests.
|
// ServeHTTP handles image requests.
|
||||||
|
@ -78,20 +84,85 @@ func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||||
http.Error(w, fmt.Sprintf("invalid request URL: %v", err.Error()), http.StatusBadRequest)
|
http.Error(w, fmt.Sprintf("invalid request URL: %v", err.Error()), http.StatusBadRequest)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
resp, err := p.Client.Get(req.URL.String())
|
|
||||||
|
u := req.URL.String()
|
||||||
|
glog.Infof("request for image: %v", u)
|
||||||
|
|
||||||
|
image, ok := p.Cache.Get(u)
|
||||||
|
if !ok {
|
||||||
|
glog.Infof("image not cached")
|
||||||
|
image, err = p.fetchRemoteImage(u, nil)
|
||||||
|
if err != nil {
|
||||||
|
glog.Errorf("errorf fetching remote image: %v", err)
|
||||||
|
}
|
||||||
|
p.Cache.Save(image)
|
||||||
|
} else if time.Now().After(image.Expires) {
|
||||||
|
glog.Infof("cached image expired")
|
||||||
|
image, err = p.fetchRemoteImage(u, image)
|
||||||
|
if err != nil {
|
||||||
|
glog.Errorf("errorf fetching remote image: %v", err)
|
||||||
|
}
|
||||||
|
p.Cache.Save(image)
|
||||||
|
} else {
|
||||||
|
glog.Infof("serving from cache")
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Add("Content-Length", strconv.Itoa(len(image.Bytes)))
|
||||||
|
w.Header().Add("Expires", image.Expires.Format(time.RFC1123))
|
||||||
|
w.Write(image.Bytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Proxy) fetchRemoteImage(u string, cached *data.Image) (*data.Image, error) {
|
||||||
|
glog.Infof("fetching remote image: %s", u)
|
||||||
|
|
||||||
|
req, err := http.NewRequest("GET", u, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
http.Error(w, fmt.Sprintf("error fetching remote image: %v", err.Error()), http.StatusInternalServerError)
|
return nil, err
|
||||||
return
|
}
|
||||||
|
|
||||||
|
if cached != nil && cached.Etag != "" {
|
||||||
|
req.Header.Add("If-None-Match", cached.Etag)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := p.Client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if resp.StatusCode == http.StatusNotModified {
|
||||||
|
glog.Infof("remote image not modified (304 response)")
|
||||||
|
cached.Expires = parseExpires(resp)
|
||||||
|
return cached, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
if resp.StatusCode != http.StatusOK {
|
||||||
http.Error(w, fmt.Sprintf("error fetching remote image: %v", resp.Status), resp.StatusCode)
|
return nil, errors.New(fmt.Sprintf("HTTP status not OK: %v", resp.Status))
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
defer resp.Body.Close()
|
defer resp.Body.Close()
|
||||||
_, err = io.Copy(w, resp.Body)
|
b, err := ioutil.ReadAll(resp.Body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
http.Error(w, fmt.Sprintf("error fetching remote image: %v", err.Error()), http.StatusInternalServerError)
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return &data.Image{
|
||||||
|
URL: u,
|
||||||
|
Expires: parseExpires(resp),
|
||||||
|
Etag: resp.Header.Get("Etag"),
|
||||||
|
Bytes: b,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseExpires(resp *http.Response) time.Time {
|
||||||
|
exp := resp.Header.Get("Expires")
|
||||||
|
if exp == "" {
|
||||||
|
return time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
t, err := time.Parse(time.RFC1123, exp)
|
||||||
|
if err != nil {
|
||||||
|
return time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
return t
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue