2016-12-06 21:29:59 +00:00
|
|
|
package ipfscluster
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"sync"
|
2016-12-15 18:08:46 +00:00
|
|
|
"time"
|
2016-12-06 21:29:59 +00:00
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
cid "gx/ipfs/QmcTcsTvfaeEBRFo1TkFgT8sRmgi1n1LTZpecfVP8fzpGD/go-cid"
|
2016-12-06 21:29:59 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
|
|
|
pinEverywhere = -1
|
|
|
|
)
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
// A Pin or Unpin operation will be considered failed
|
|
|
|
// if the Cid has stayed in Pinning or Unpinning state
|
|
|
|
// for longer than these values.
|
|
|
|
var (
|
|
|
|
PinningTimeout = 15 * time.Minute
|
|
|
|
UnpinningTimeout = 10 * time.Second
|
|
|
|
)
|
|
|
|
|
2016-12-06 21:29:59 +00:00
|
|
|
const (
|
|
|
|
PinError = iota
|
2016-12-07 16:21:29 +00:00
|
|
|
UnpinError
|
2016-12-06 21:29:59 +00:00
|
|
|
Pinned
|
|
|
|
Pinning
|
|
|
|
Unpinning
|
|
|
|
Unpinned
|
|
|
|
)
|
|
|
|
|
|
|
|
type Pin struct {
|
2016-12-07 16:21:29 +00:00
|
|
|
Cid *cid.Cid
|
|
|
|
PinMode PinMode
|
|
|
|
Status PinStatus
|
2016-12-15 18:08:46 +00:00
|
|
|
TS time.Time
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type PinMode int
|
|
|
|
type PinStatus int
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
func (st PinStatus) String() string {
|
|
|
|
switch st {
|
|
|
|
case PinError:
|
|
|
|
return "pin_error"
|
|
|
|
case UnpinError:
|
|
|
|
return "unpin_error"
|
|
|
|
case Pinned:
|
|
|
|
return "pinned"
|
|
|
|
case Pinning:
|
|
|
|
return "pinning"
|
|
|
|
case Unpinning:
|
|
|
|
return "unpinning"
|
|
|
|
case Unpinned:
|
|
|
|
return "unpinned"
|
|
|
|
}
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
2016-12-06 21:29:59 +00:00
|
|
|
type MapPinTracker struct {
|
2016-12-12 12:54:58 +00:00
|
|
|
mux sync.Mutex
|
2016-12-06 21:29:59 +00:00
|
|
|
status map[string]Pin
|
|
|
|
|
2016-12-15 13:07:19 +00:00
|
|
|
ctx context.Context
|
2016-12-15 18:08:46 +00:00
|
|
|
rpcCh chan RPC
|
2016-12-09 19:54:46 +00:00
|
|
|
|
2016-12-15 13:07:19 +00:00
|
|
|
shutdownLock sync.Mutex
|
|
|
|
shutdown bool
|
|
|
|
shutdownCh chan struct{}
|
|
|
|
wg sync.WaitGroup
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func NewMapPinTracker() *MapPinTracker {
|
2016-12-09 19:54:46 +00:00
|
|
|
ctx := context.Background()
|
2016-12-06 21:29:59 +00:00
|
|
|
mpt := &MapPinTracker{
|
2016-12-09 19:54:46 +00:00
|
|
|
status: make(map[string]Pin),
|
2016-12-15 18:08:46 +00:00
|
|
|
rpcCh: make(chan RPC, RPCMaxQueue),
|
2016-12-09 19:54:46 +00:00
|
|
|
ctx: ctx,
|
2016-12-15 13:07:19 +00:00
|
|
|
shutdownCh: make(chan struct{}),
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
2016-12-15 13:19:41 +00:00
|
|
|
logger.Info("starting MapPinTracker")
|
2016-12-15 13:07:19 +00:00
|
|
|
mpt.run()
|
2016-12-06 21:29:59 +00:00
|
|
|
return mpt
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) run() {
|
2016-12-15 13:07:19 +00:00
|
|
|
mpt.wg.Add(1)
|
|
|
|
go func() {
|
|
|
|
defer mpt.wg.Done()
|
|
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
|
|
defer cancel()
|
|
|
|
mpt.ctx = ctx
|
|
|
|
<-mpt.shutdownCh
|
|
|
|
}()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) Shutdown() error {
|
|
|
|
mpt.shutdownLock.Lock()
|
|
|
|
defer mpt.shutdownLock.Unlock()
|
|
|
|
|
|
|
|
if mpt.shutdown {
|
|
|
|
logger.Debug("already shutdown")
|
|
|
|
return nil
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
2016-12-15 13:07:19 +00:00
|
|
|
|
2016-12-15 13:19:41 +00:00
|
|
|
logger.Info("stopping MapPinTracker")
|
2016-12-15 13:07:19 +00:00
|
|
|
mpt.shutdownCh <- struct{}{}
|
|
|
|
mpt.wg.Wait()
|
|
|
|
mpt.shutdown = true
|
|
|
|
return nil
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) set(c *cid.Cid, s PinStatus) error {
|
|
|
|
mpt.mux.Lock()
|
|
|
|
defer mpt.mux.Unlock()
|
2016-12-07 16:21:29 +00:00
|
|
|
if s == Unpinned {
|
|
|
|
delete(mpt.status, c.String())
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-12-06 21:29:59 +00:00
|
|
|
mpt.status[c.String()] = Pin{
|
2016-12-07 16:21:29 +00:00
|
|
|
Cid: c,
|
2016-12-06 21:29:59 +00:00
|
|
|
PinMode: pinEverywhere,
|
|
|
|
Status: s,
|
2016-12-15 18:08:46 +00:00
|
|
|
TS: time.Now(),
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-12-07 16:21:29 +00:00
|
|
|
func (mpt *MapPinTracker) get(c *cid.Cid) Pin {
|
|
|
|
mpt.mux.Lock()
|
|
|
|
defer mpt.mux.Unlock()
|
|
|
|
p, ok := mpt.status[c.String()]
|
|
|
|
if !ok {
|
|
|
|
return Pin{
|
|
|
|
Cid: c,
|
|
|
|
Status: Unpinned,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return p
|
|
|
|
}
|
|
|
|
|
2016-12-06 21:29:59 +00:00
|
|
|
func (mpt *MapPinTracker) Pinning(c *cid.Cid) error {
|
|
|
|
return mpt.set(c, Pinning)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) Unpinning(c *cid.Cid) error {
|
|
|
|
return mpt.set(c, Unpinning)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) Pinned(c *cid.Cid) error {
|
|
|
|
return mpt.set(c, Pinned)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) PinError(c *cid.Cid) error {
|
|
|
|
return mpt.set(c, PinError)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) UnpinError(c *cid.Cid) error {
|
|
|
|
return mpt.set(c, UnpinError)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) Unpinned(c *cid.Cid) error {
|
2016-12-07 16:21:29 +00:00
|
|
|
return mpt.set(c, Unpinned)
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
|
|
|
|
2016-12-07 16:21:29 +00:00
|
|
|
func (mpt *MapPinTracker) GetPin(c *cid.Cid) Pin {
|
|
|
|
return mpt.get(c)
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) ListPins() []Pin {
|
|
|
|
mpt.mux.Lock()
|
|
|
|
defer mpt.mux.Unlock()
|
|
|
|
pins := make([]Pin, 0, len(mpt.status))
|
|
|
|
for _, v := range mpt.status {
|
|
|
|
pins = append(pins, v)
|
|
|
|
}
|
|
|
|
return pins
|
|
|
|
}
|
|
|
|
|
2016-12-07 16:21:29 +00:00
|
|
|
func (mpt *MapPinTracker) Sync(c *cid.Cid) bool {
|
|
|
|
ctx, cancel := context.WithCancel(mpt.ctx)
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
p := mpt.get(c)
|
|
|
|
|
2016-12-14 16:25:21 +00:00
|
|
|
// We assume errors will need a Recover() so we return true
|
2016-12-07 16:21:29 +00:00
|
|
|
if p.Status == PinError || p.Status == UnpinError {
|
2016-12-14 16:25:21 +00:00
|
|
|
return true
|
2016-12-07 16:21:29 +00:00
|
|
|
}
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
resp := MakeRPC(ctx, mpt.rpcCh, NewRPC(IPFSIsPinnedRPC, c), true)
|
2016-12-07 16:21:29 +00:00
|
|
|
if resp.Error != nil {
|
|
|
|
if p.Status == Pinned || p.Status == Pinning {
|
|
|
|
mpt.set(c, PinError)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
if p.Status == Unpinned || p.Status == Unpinning {
|
|
|
|
mpt.set(c, UnpinError)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
ipfsPinned, ok := resp.Data.(bool)
|
|
|
|
if !ok {
|
|
|
|
logger.Error("wrong type of IPFSIsPinnedRPC response")
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
if ipfsPinned {
|
|
|
|
switch p.Status {
|
|
|
|
case Pinned:
|
|
|
|
return false
|
|
|
|
case Pinning:
|
|
|
|
mpt.set(c, Pinned)
|
|
|
|
return true
|
|
|
|
case Unpinning:
|
2016-12-15 18:08:46 +00:00
|
|
|
if time.Since(p.TS) > UnpinningTimeout {
|
|
|
|
mpt.set(c, UnpinError)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
2016-12-07 16:21:29 +00:00
|
|
|
case Unpinned:
|
|
|
|
mpt.set(c, UnpinError)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
switch p.Status {
|
|
|
|
case Pinned:
|
|
|
|
mpt.set(c, PinError)
|
|
|
|
return true
|
|
|
|
case Pinning:
|
2016-12-15 18:08:46 +00:00
|
|
|
if time.Since(p.TS) > PinningTimeout {
|
|
|
|
mpt.set(c, PinError)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
2016-12-07 16:21:29 +00:00
|
|
|
case Unpinning:
|
|
|
|
mpt.set(c, Unpinned)
|
|
|
|
return true
|
|
|
|
case Unpinned:
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) Recover(c *cid.Cid) error {
|
|
|
|
p := mpt.get(c)
|
|
|
|
if p.Status != PinError && p.Status != UnpinError {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
ctx, cancel := context.WithCancel(mpt.ctx)
|
|
|
|
defer cancel()
|
|
|
|
if p.Status == PinError {
|
2016-12-15 18:08:46 +00:00
|
|
|
MakeRPC(ctx, mpt.rpcCh, NewRPC(IPFSPinRPC, c), false)
|
2016-12-07 16:21:29 +00:00
|
|
|
}
|
|
|
|
if p.Status == UnpinError {
|
2016-12-15 18:08:46 +00:00
|
|
|
MakeRPC(ctx, mpt.rpcCh, NewRPC(IPFSUnpinRPC, c), false)
|
2016-12-07 16:21:29 +00:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (mpt *MapPinTracker) SyncAll() []Pin {
|
|
|
|
var changedPins []Pin
|
|
|
|
pins := mpt.ListPins()
|
|
|
|
for _, p := range pins {
|
|
|
|
changed := mpt.Sync(p.Cid)
|
|
|
|
if changed {
|
|
|
|
changedPins = append(changedPins, p)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return changedPins
|
|
|
|
}
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
func (mpt *MapPinTracker) SyncState(cState State) []Pin {
|
2016-12-09 19:54:46 +00:00
|
|
|
clusterPins := cState.ListPins()
|
|
|
|
clusterMap := make(map[string]struct{})
|
|
|
|
// Make a map for faster lookup
|
|
|
|
for _, c := range clusterPins {
|
|
|
|
var a struct{}
|
|
|
|
clusterMap[c.String()] = a
|
|
|
|
}
|
|
|
|
var toRemove []*cid.Cid
|
|
|
|
var toAdd []*cid.Cid
|
|
|
|
var changed []Pin
|
|
|
|
mpt.mux.Lock()
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
// Collect items in the State not in the tracker
|
2016-12-09 19:54:46 +00:00
|
|
|
for _, c := range clusterPins {
|
|
|
|
_, ok := mpt.status[c.String()]
|
|
|
|
if !ok {
|
|
|
|
toAdd = append(toAdd, c)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
// Collect items in the tracker not in the State
|
2016-12-09 19:54:46 +00:00
|
|
|
for _, p := range mpt.status {
|
|
|
|
_, ok := clusterMap[p.Cid.String()]
|
|
|
|
if !ok {
|
|
|
|
toRemove = append(toRemove, p.Cid)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Update new items and mark them as pinning error
|
|
|
|
for _, c := range toAdd {
|
|
|
|
p := Pin{
|
|
|
|
Cid: c,
|
|
|
|
PinMode: pinEverywhere,
|
|
|
|
Status: PinError,
|
|
|
|
}
|
|
|
|
mpt.status[c.String()] = p
|
|
|
|
changed = append(changed, p)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Mark items that need to be removed as unpin error
|
|
|
|
for _, c := range toRemove {
|
|
|
|
p := Pin{
|
|
|
|
Cid: c,
|
|
|
|
PinMode: pinEverywhere,
|
|
|
|
Status: UnpinError,
|
|
|
|
}
|
|
|
|
mpt.status[c.String()] = p
|
|
|
|
changed = append(changed, p)
|
|
|
|
}
|
|
|
|
mpt.mux.Unlock()
|
|
|
|
return changed
|
|
|
|
}
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
func (mpt *MapPinTracker) RpcChan() <-chan RPC {
|
2016-12-06 21:29:59 +00:00
|
|
|
return mpt.rpcCh
|
|
|
|
}
|