perkeep/pkg/server/thumbcache.go

/*
Copyright 2011 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package server

import (
	"errors"
	"fmt"

	"camlistore.org/pkg/blob"
	"camlistore.org/pkg/lru"
	"camlistore.org/pkg/sorted"
)

const memLRUSize = 1024 // arbitrary

var errCacheMiss = errors.New("not in cache")

// ThumbMeta is a mapping from an image's scaling parameters (encoding
// as an opaque "key" string) and the blobref of the thumbnail
// (currently its file schema blob).
// ThumbMeta is safe for concurrent use by multiple goroutines.
//
// The key will be some string containing the original full-sized image's
// blobref, its target dimensions, and any possible transformations on
// it (e.g. cropping it to square).
type ThumbMeta struct {
	mem *lru.Cache      // key -> blob.Ref
	kv  sorted.KeyValue // optional
}

// NewThumbMeta returns a new in-memory ThumbMeta, backed with the
// optional kv.
// If kv is nil, key/value pairs are stored in memory only.
func NewThumbMeta(kv sorted.KeyValue) *ThumbMeta {
	return &ThumbMeta{
		mem: lru.New(memLRUSize),
		kv:  kv,
	}
}

func (m *ThumbMeta) Get(key string) (blob.Ref, error) {
	var br blob.Ref
	if v, ok := m.mem.Get(key); ok {
		return v.(blob.Ref), nil
	}
	if m.kv != nil {
		v, err := m.kv.Get(key)
		if err == sorted.ErrNotFound {
			return br, errCacheMiss
		}
		if err != nil {
			return br, err
		}
		br, ok := blob.Parse(v)
		if !ok {
			return br, fmt.Errorf("Invalid blobref %q found for key %q in thumbnail mea", v, key)
		}
		m.mem.Add(key, br)
		return br, nil
	}
	return br, errCacheMiss
}

func (m *ThumbMeta) Put(key string, br blob.Ref) error {
	m.mem.Add(key, br)
	if m.kv != nil {
		return m.kv.Set(key, br.String())
	}
	return nil
}