[#80] services/object: Implement iterators over split-tree leaves

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>

pkg/services/object/util/chain.go

@@ -1,6 +1,7 @@
 package util
 
 import (
+	"errors"
 	"fmt"
 
 	objectSDK "github.com/nspcc-dev/neofs-api-go/pkg/object"
@@ -26,6 +27,168 @@ type rangeChain struct {
 	id *objectSDK.ID
 }
 
+// HeadReceiver is an interface of entity that can receive
+// object header or the information about the object relations.
+type HeadReceiver interface {
+	// Head must return one of:
+	// * object header (*object.Object);
+	// * structured information about split-chain (*objectSDK.SplitInfo).
+	Head(*objectSDK.Address) (interface{}, error)
+}
+
+// SplitMemberHandler is a handler of next split-chain element.
+//
+// If reverseDirection arg is true, then the traversal is done in reverse order.
+// Stop boolean result provides the ability to interrupt the traversal.
+type SplitMemberHandler func(member *object.Object, reverseDirection bool) (stop bool)
+
+// IterateAllSplitLeaves is an iterator over all object split-tree leaves in direct order.
+func IterateAllSplitLeaves(r HeadReceiver, addr *objectSDK.Address, h func(*object.Object)) error {
+	return IterateSplitLeaves(r, addr, func(leaf *object.Object) bool {
+		h(leaf)
+		return false
+	})
+}
+
+// IterateSplitLeaves is an iterator over object split-tree leaves in direct order.
+//
+// If member handler returns true, then the iterator aborts without error.
+func IterateSplitLeaves(r HeadReceiver, addr *objectSDK.Address, h func(*object.Object) bool) error {
+	var (
+		reverse bool
+		leaves  []*object.Object
+	)
+
+	if err := TraverseSplitChain(r, addr, func(member *object.Object, reverseDirection bool) (stop bool) {
+		reverse = reverseDirection
+
+		if reverse {
+			leaves = append(leaves, member)
+			return false
+		}
+
+		return h(member)
+	}); err != nil {
+		return err
+	}
+
+	for i := len(leaves) - 1; i >= 0; i-- {
+		if h(leaves[i]) {
+			break
+		}
+	}
+
+	return nil
+}
+
+// TraverseSplitChain is an iterator over object split-tree leaves.
+//
+// Traversal occurs in one of two directions, which depends on what pslit info was received:
+// * in direct order for link part;
+// * in reverse order for last part.
+func TraverseSplitChain(r HeadReceiver, addr *objectSDK.Address, h SplitMemberHandler) error {
+	_, err := traverseSplitChain(r, addr, h)
+	return err
+}
+
+func traverseSplitChain(r HeadReceiver, addr *objectSDK.Address, h SplitMemberHandler) (bool, error) {
+	v, err := r.Head(addr)
+	if err != nil {
+		return false, err
+	}
+
+	cid := addr.ContainerID()
+
+	switch res := v.(type) {
+	default:
+		panic(fmt.Sprintf("unexpected result of %T: %T", r, v))
+	case *object.Object:
+		return h(res, false), nil
+	case *objectSDK.SplitInfo:
+		switch {
+		default:
+			return false, errors.New("lack of split information")
+		case res.Link() != nil:
+			addr := objectSDK.NewAddress()
+			addr.SetContainerID(cid)
+			addr.SetObjectID(res.Link())
+
+			chain := make([]*objectSDK.ID, 0)
+
+			if _, err := traverseSplitChain(r, addr, func(member *object.Object, reverseDirection bool) (stop bool) {
+				children := member.Children()
+
+				if reverseDirection {
+					chain = append(children, chain...)
+				} else {
+					chain = append(chain, children...)
+				}
+
+				return false
+			}); err != nil {
+				return false, err
+			}
+
+			var reverseChain []*object.Object
+
+			for i := range chain {
+				addr.SetObjectID(chain[i])
+
+				if stop, err := traverseSplitChain(r, addr, func(member *object.Object, reverseDirection bool) (stop bool) {
+					if !reverseDirection {
+						return h(member, false)
+					} else {
+						reverseChain = append(reverseChain, member)
+						return false
+					}
+				}); err != nil || stop {
+					return stop, err
+				}
+			}
+
+			for i := len(reverseChain) - 1; i >= 0; i-- {
+				if h(reverseChain[i], false) {
+					return true, nil
+				}
+			}
+		case res.LastPart() != nil:
+			addr := objectSDK.NewAddress()
+			addr.SetContainerID(cid)
+
+			for prev := res.LastPart(); prev != nil; {
+				addr.SetObjectID(prev)
+
+				var directChain []*object.Object
+
+				if _, err := traverseSplitChain(r, addr, func(member *object.Object, reverseDirection bool) (stop bool) {
+					if reverseDirection {
+						prev = member.PreviousID()
+						return h(member, true)
+					}
+
+					directChain = append(directChain, member)
+
+					return false
+				}); err != nil {
+					return false, err
+				}
+
+				for i := len(directChain) - 1; i >= 0; i-- {
+					if h(directChain[i], true) {
+						return true, nil
+					}
+				}
+
+				if len(directChain) > 0 {
+					prev = directChain[len(directChain)-1].PreviousID()
+				}
+			}
+		}
+	}
+
+	return false, nil
+}
+
 func NewRangeTraverser(originSize uint64, rightElement *object.Object, rngSeek *objectSDK.Range) *RangeTraverser {
 	right := &rangeChain{
 		bounds: &rangeBounds{