micro/store/file/file.go

359 lines
7.2 KiB
Go
Raw Normal View History

2020-04-07 14:53:22 +03:00
// Package local is a file system backed store
package file
import (
"encoding/json"
"os"
"path/filepath"
"sort"
"strings"
"time"
"github.com/micro/go-micro/v2/store"
"github.com/pkg/errors"
2020-04-07 21:45:27 +03:00
bolt "go.etcd.io/bbolt"
2020-04-07 14:53:22 +03:00
)
var (
// DefaultDatabase is the namespace that the bbolt store
// will use if no namespace is provided.
DefaultDatabase = "micro"
// DefaultTable when none is specified
DefaultTable = "micro"
// DefaultDir is the default directory for bbolt files
2020-04-11 13:23:41 +03:00
DefaultDir = filepath.Join(os.TempDir(), "micro", "store")
2020-04-08 11:57:51 +03:00
// bucket used for data storage
dataBucket = "data"
)
2020-04-07 14:53:22 +03:00
// NewStore returns a memory store
func NewStore(opts ...store.Option) store.Store {
2020-04-07 21:45:27 +03:00
s := &fileStore{}
s.init(opts...)
2020-04-07 14:53:22 +03:00
return s
}
type fileStore struct {
2020-04-07 21:45:27 +03:00
options store.Options
dir string
fileName string
dbPath string
// the database handle
db *bolt.DB
2020-04-07 14:53:22 +03:00
}
2020-04-07 21:45:27 +03:00
// record stored by us
type record struct {
Key string
Value []byte
ExpiresAt time.Time
}
func (m *fileStore) delete(key string) error {
return m.db.Update(func(tx *bolt.Tx) error {
2020-04-08 11:57:51 +03:00
b := tx.Bucket([]byte(dataBucket))
2020-04-07 21:45:27 +03:00
if b == nil {
return nil
}
return b.Delete([]byte(key))
})
}
func (m *fileStore) init(opts ...store.Option) error {
2020-04-07 14:53:22 +03:00
for _, o := range opts {
o(&m.options)
}
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
if m.options.Database == "" {
m.options.Database = DefaultDatabase
2020-04-07 14:53:22 +03:00
}
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
if m.options.Table == "" {
// bbolt requires bucketname to not be empty
m.options.Table = DefaultTable
2020-04-07 14:53:22 +03:00
}
2020-04-07 21:45:27 +03:00
// create a directory /tmp/micro
dir := filepath.Join(DefaultDir, m.options.Database)
2020-04-07 21:45:27 +03:00
// create the database handle
fname := m.options.Table + ".db"
// Ignoring this as the folder might exist.
// Reads/Writes updates will return with sensible error messages
// about the dir not existing in case this cannot create the path anyway
os.MkdirAll(dir, 0700)
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
m.dir = dir
m.fileName = fname
2020-04-07 21:45:27 +03:00
m.dbPath = filepath.Join(dir, fname)
// close existing handle
if m.db != nil {
m.db.Close()
}
// create new db handle
db, err := bolt.Open(m.dbPath, 0700, &bolt.Options{Timeout: 5 * time.Second})
if err != nil {
return err
}
// set the new db
m.db = db
// create the table
return db.Update(func(tx *bolt.Tx) error {
2020-04-08 11:57:51 +03:00
_, err := tx.CreateBucketIfNotExists([]byte(dataBucket))
2020-04-07 21:45:27 +03:00
return err
})
2020-04-07 14:53:22 +03:00
}
2020-04-07 21:45:27 +03:00
func (m *fileStore) list(limit, offset uint) []string {
var allItems []string
m.db.View(func(tx *bolt.Tx) error {
2020-04-08 11:57:51 +03:00
b := tx.Bucket([]byte(dataBucket))
2020-04-07 21:45:27 +03:00
// nothing to read
if b == nil {
return nil
}
// @todo very inefficient
if err := b.ForEach(func(k, v []byte) error {
storedRecord := &record{}
if err := json.Unmarshal(v, storedRecord); err != nil {
return err
}
if !storedRecord.ExpiresAt.IsZero() {
if storedRecord.ExpiresAt.Before(time.Now()) {
return nil
}
}
allItems = append(allItems, string(k))
return nil
}); err != nil {
return err
}
return nil
})
allKeys := make([]string, len(allItems))
for i, k := range allItems {
allKeys[i] = k
}
if limit != 0 || offset != 0 {
sort.Slice(allKeys, func(i, j int) bool { return allKeys[i] < allKeys[j] })
min := func(i, j uint) uint {
if i < j {
return i
}
return j
}
return allKeys[offset:min(limit, uint(len(allKeys)))]
}
return allKeys
}
func (m *fileStore) get(k string) (*store.Record, error) {
var value []byte
m.db.View(func(tx *bolt.Tx) error {
// @todo this is still very experimental...
2020-04-08 11:57:51 +03:00
b := tx.Bucket([]byte(dataBucket))
2020-04-07 21:45:27 +03:00
if b == nil {
return nil
}
value = b.Get([]byte(k))
return nil
})
if value == nil {
return nil, store.ErrNotFound
}
storedRecord := &record{}
if err := json.Unmarshal(value, storedRecord); err != nil {
return nil, err
}
newRecord := &store.Record{}
newRecord.Key = storedRecord.Key
newRecord.Value = storedRecord.Value
if !storedRecord.ExpiresAt.IsZero() {
if storedRecord.ExpiresAt.Before(time.Now()) {
return nil, store.ErrNotFound
}
newRecord.Expiry = time.Until(storedRecord.ExpiresAt)
}
return newRecord, nil
}
func (m *fileStore) set(r *store.Record) error {
// copy the incoming record and then
// convert the expiry in to a hard timestamp
item := &record{}
item.Key = r.Key
item.Value = r.Value
if r.Expiry != 0 {
item.ExpiresAt = time.Now().Add(r.Expiry)
}
// marshal the data
data, _ := json.Marshal(item)
return m.db.Update(func(tx *bolt.Tx) error {
2020-04-08 11:57:51 +03:00
b := tx.Bucket([]byte(dataBucket))
2020-04-07 21:45:27 +03:00
if b == nil {
var err error
2020-04-08 11:57:51 +03:00
b, err = tx.CreateBucketIfNotExists([]byte(dataBucket))
2020-04-07 21:45:27 +03:00
if err != nil {
return err
}
}
return b.Put([]byte(r.Key), data)
})
}
func (m *fileStore) Close() error {
if m.db != nil {
return m.db.Close()
}
return nil
}
2020-04-07 21:45:27 +03:00
func (m *fileStore) Init(opts ...store.Option) error {
return m.init(opts...)
}
func (m *fileStore) Delete(key string, opts ...store.DeleteOption) error {
deleteOptions := store.DeleteOptions{}
for _, o := range opts {
o(&deleteOptions)
}
return m.delete(key)
2020-04-07 14:53:22 +03:00
}
func (m *fileStore) Read(key string, opts ...store.ReadOption) ([]*store.Record, error) {
readOpts := store.ReadOptions{}
for _, o := range opts {
o(&readOpts)
}
var keys []string
// Handle Prefix / suffix
2020-04-07 21:45:27 +03:00
// TODO: do range scan here rather than listing all keys
2020-04-07 14:53:22 +03:00
if readOpts.Prefix || readOpts.Suffix {
var opts []store.ListOption
if readOpts.Prefix {
opts = append(opts, store.ListPrefix(key))
}
if readOpts.Suffix {
opts = append(opts, store.ListSuffix(key))
}
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
opts = append(opts, store.ListLimit(readOpts.Limit))
opts = append(opts, store.ListOffset(readOpts.Offset))
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
k, err := m.List(opts...)
if err != nil {
return nil, errors.Wrap(err, "FileStore: Read couldn't List()")
}
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
keys = k
} else {
keys = []string{key}
}
var results []*store.Record
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
for _, k := range keys {
r, err := m.get(k)
if err != nil {
return results, err
}
results = append(results, r)
}
2020-04-07 21:45:27 +03:00
return results, nil
2020-04-07 14:53:22 +03:00
}
func (m *fileStore) Write(r *store.Record, opts ...store.WriteOption) error {
writeOpts := store.WriteOptions{}
for _, o := range opts {
o(&writeOpts)
}
if len(opts) > 0 {
// Copy the record before applying options, or the incoming record will be mutated
newRecord := store.Record{}
newRecord.Key = r.Key
newRecord.Value = r.Value
newRecord.Expiry = r.Expiry
if !writeOpts.Expiry.IsZero() {
newRecord.Expiry = time.Until(writeOpts.Expiry)
}
if writeOpts.TTL != 0 {
newRecord.Expiry = writeOpts.TTL
}
2020-04-07 21:45:27 +03:00
return m.set(&newRecord)
2020-04-07 14:53:22 +03:00
}
2020-04-07 21:45:27 +03:00
return m.set(r)
2020-04-07 14:53:22 +03:00
}
func (m *fileStore) Options() store.Options {
return m.options
}
func (m *fileStore) List(opts ...store.ListOption) ([]string, error) {
listOptions := store.ListOptions{}
for _, o := range opts {
o(&listOptions)
}
2020-04-07 21:45:27 +03:00
// TODO apply prefix/suffix in range query
2020-04-07 14:53:22 +03:00
allKeys := m.list(listOptions.Limit, listOptions.Offset)
if len(listOptions.Prefix) > 0 {
var prefixKeys []string
for _, k := range allKeys {
if strings.HasPrefix(k, listOptions.Prefix) {
prefixKeys = append(prefixKeys, k)
}
}
allKeys = prefixKeys
}
2020-04-07 21:45:27 +03:00
2020-04-07 14:53:22 +03:00
if len(listOptions.Suffix) > 0 {
var suffixKeys []string
for _, k := range allKeys {
if strings.HasSuffix(k, listOptions.Suffix) {
suffixKeys = append(suffixKeys, k)
}
}
allKeys = suffixKeys
}
return allKeys, nil
}
2020-04-07 21:45:27 +03:00
func (m *fileStore) String() string {
return "file"
2020-04-07 14:53:22 +03:00
}