mount.go 5.29 KB
Newer Older
Tommi Virtanen's avatar
Tommi Virtanen committed
1 2 3 4 5 6
// Package mount provides a Datastore that has other Datastores
// mounted at various key prefixes.
package mount

import (
	"errors"
Jeromy's avatar
Jeromy committed
7
	"io"
8
	"sort"
Tommi Virtanen's avatar
Tommi Virtanen committed
9 10
	"strings"

Jeromy's avatar
Jeromy committed
11 12
	"github.com/ipfs/go-datastore"
	"github.com/ipfs/go-datastore/query"
Tommi Virtanen's avatar
Tommi Virtanen committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
)

var (
	ErrNoMount = errors.New("no datastore mounted for this key")
)

type Mount struct {
	Prefix    datastore.Key
	Datastore datastore.Datastore
}

func New(mounts []Mount) *Datastore {
	// make a copy so we're sure it doesn't mutate
	m := make([]Mount, len(mounts))
	for i, v := range mounts {
		m[i] = v
	}
30
	sort.Slice(m, func(i, j int) bool { return m[i].Prefix.String() > m[j].Prefix.String() })
Tommi Virtanen's avatar
Tommi Virtanen committed
31 32 33 34 35 36 37 38 39
	return &Datastore{mounts: m}
}

type Datastore struct {
	mounts []Mount
}

var _ datastore.Datastore = (*Datastore)(nil)

40
func (d *Datastore) lookup(key datastore.Key) (ds datastore.Datastore, mountpoint, rest datastore.Key) {
Tommi Virtanen's avatar
Tommi Virtanen committed
41
	for _, m := range d.mounts {
42
		if m.Prefix.Equal(key) || m.Prefix.IsAncestorOf(key) {
Tommi Virtanen's avatar
Tommi Virtanen committed
43 44
			s := strings.TrimPrefix(key.String(), m.Prefix.String())
			k := datastore.NewKey(s)
45
			return m.Datastore, m.Prefix, k
Tommi Virtanen's avatar
Tommi Virtanen committed
46 47
		}
	}
48
	return nil, datastore.NewKey("/"), key
Tommi Virtanen's avatar
Tommi Virtanen committed
49 50
}

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
// lookupAll returns all mounts that might contain keys that are descendant of <key>
//
// Matching: /ao/e
//
// /          B /ao/e
// /a/        not matching
// /ao/       B /e
// /ao/e/     A /
// /ao/e/uh/  A /
// /aoe/      not matching
func (d *Datastore) lookupAll(key datastore.Key) (ds []datastore.Datastore, mountpoint, rest []datastore.Key) {
	for _, m := range d.mounts {
		p := m.Prefix.String()
		if len(p) > 1 {
			p = p + "/"
		}

		if strings.HasPrefix(p, key.String()) {
			ds = append(ds, m.Datastore)
			mountpoint = append(mountpoint, m.Prefix)
			rest = append(rest, datastore.NewKey("/"))
		} else if strings.HasPrefix(key.String(), p) {
			r := strings.TrimPrefix(key.String(), m.Prefix.String())

			ds = append(ds, m.Datastore)
			mountpoint = append(mountpoint, m.Prefix)
			rest = append(rest, datastore.NewKey(r))
		}
	}
	return ds, mountpoint, rest
}

Tommi Virtanen's avatar
Tommi Virtanen committed
83
func (d *Datastore) Put(key datastore.Key, value interface{}) error {
84
	ds, _, k := d.lookup(key)
Tommi Virtanen's avatar
Tommi Virtanen committed
85 86 87 88 89 90 91
	if ds == nil {
		return ErrNoMount
	}
	return ds.Put(k, value)
}

func (d *Datastore) Get(key datastore.Key) (value interface{}, err error) {
92
	ds, _, k := d.lookup(key)
Tommi Virtanen's avatar
Tommi Virtanen committed
93 94 95 96 97 98 99
	if ds == nil {
		return nil, datastore.ErrNotFound
	}
	return ds.Get(k)
}

func (d *Datastore) Has(key datastore.Key) (exists bool, err error) {
100
	ds, _, k := d.lookup(key)
Tommi Virtanen's avatar
Tommi Virtanen committed
101 102 103 104
	if ds == nil {
		return false, nil
	}
	return ds.Has(k)
Tommi Virtanen's avatar
Tommi Virtanen committed
105 106 107
}

func (d *Datastore) Delete(key datastore.Key) error {
108
	ds, _, k := d.lookup(key)
Tommi Virtanen's avatar
Tommi Virtanen committed
109 110 111 112
	if ds == nil {
		return datastore.ErrNotFound
	}
	return ds.Delete(k)
Tommi Virtanen's avatar
Tommi Virtanen committed
113 114 115
}

func (d *Datastore) Query(q query.Query) (query.Results, error) {
116 117 118 119
	if len(q.Filters) > 0 ||
		len(q.Orders) > 0 ||
		q.Limit > 0 ||
		q.Offset > 0 {
120 121
		// TODO this is still overly simplistic, but the only callers are
		// `ipfs refs local` and ipfs-ds-convert.
122 123
		return nil, errors.New("mount only supports listing all prefixed keys in random order")
	}
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
	prefix := datastore.NewKey(q.Prefix)
	dses, mounts, rests := d.lookupAll(prefix)

	// current itorator state
	var res query.Results
	var ds datastore.Datastore
	var mount datastore.Key
	var rest datastore.Key
	i := 0

	return query.ResultsFromIterator(q, query.Iterator{
		Next: func() (query.Result, bool) {
			var r query.Result
			var more bool

			for try := true; try; try = len(dses) > i {
				if ds == nil {
					if len(dses) <= i {
						//This should not happen normally
						return query.Result{}, false
					}

					ds = dses[i]
					mount = mounts[i]
					rest = rests[i]

					q2 := q
					q2.Prefix = rest.String()
					r, err := ds.Query(q2)
					if err != nil {
						return query.Result{Error: err}, false
					}
					res = r
				}

				r, more = res.NextSync()
				if !more {
					ds = nil
					i++
					more = len(dses) > i
				} else {
					break
				}
			}

			r.Key = mount.Child(datastore.RawKey(r.Key)).String()
			return r, more
171
		},
172 173 174 175 176
		Close: func() error {
			if len(mounts) > i {
				return res.Close()
			}
			return nil
177
		},
178
	}), nil
Tommi Virtanen's avatar
Tommi Virtanen committed
179
}
Jeromy's avatar
Jeromy committed
180

Jeromy's avatar
Jeromy committed
181 182 183 184 185 186 187 188 189 190 191 192
func (d *Datastore) Close() error {
	for _, d := range d.mounts {
		if c, ok := d.Datastore.(io.Closer); ok {
			err := c.Close()
			if err != nil {
				return err
			}
		}
	}
	return nil
}

Jeromy's avatar
Jeromy committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
type mountBatch struct {
	mounts map[string]datastore.Batch

	d *Datastore
}

func (d *Datastore) Batch() (datastore.Batch, error) {
	return &mountBatch{
		mounts: make(map[string]datastore.Batch),
		d:      d,
	}, nil
}

func (mt *mountBatch) lookupBatch(key datastore.Key) (datastore.Batch, datastore.Key, error) {
	child, loc, rest := mt.d.lookup(key)
	t, ok := mt.mounts[loc.String()]
	if !ok {
Jeromy's avatar
Jeromy committed
210
		bds, ok := child.(datastore.Batching)
Jeromy's avatar
Jeromy committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
		if !ok {
			return nil, datastore.NewKey(""), datastore.ErrBatchUnsupported
		}
		var err error
		t, err = bds.Batch()
		if err != nil {
			return nil, datastore.NewKey(""), err
		}
		mt.mounts[loc.String()] = t
	}
	return t, rest, nil
}

func (mt *mountBatch) Put(key datastore.Key, val interface{}) error {
	t, rest, err := mt.lookupBatch(key)
	if err != nil {
		return err
	}

	return t.Put(rest, val)
}

func (mt *mountBatch) Delete(key datastore.Key) error {
	t, rest, err := mt.lookupBatch(key)
	if err != nil {
		return err
	}

	return t.Delete(rest)
}

func (mt *mountBatch) Commit() error {
	for _, t := range mt.mounts {
		err := t.Commit()
		if err != nil {
			return err
		}
	}
	return nil
}