Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Calculate etags on-the-fly for shares directory and home folder #1208

Merged
merged 6 commits into from
Sep 30, 2020
+326 −45
Merged

Calculate etags on-the-fly for shares directory and home folder #1208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b30f23c
Add etag package to generate a unique etag from multiple etags
ishank011 Sep 25, 2020
0984348
Add method to handle EOS directories so that we maintain same inode
ishank011 Sep 28, 2020
f40a283
Calculate etag of home and shares folder at gateway
ishank011 Sep 29, 2020
61be16b
Take shares folder into consideration only if it exists
ishank011 Sep 29, 2020
3b61e95
Sort children to maintain consistent md5 hash
ishank011 Sep 30, 2020
db8719f
Trim double quotes from etags
ishank011 Sep 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions changelog/unreleased/virtual-etag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Enhancement: Calculate etags on-the-fly for shares directory and home folder

We create references for accepted shares in the shares directory, but these
aren't updated when the original resource is modified. This PR adds the
functionality to generate the etag for the shares directory and correspondingly,
the home directory, based on the actual resources which the references point to,
enabling the sync functionality.

https://github.com/cs3org/reva/pull/1208
246 changes: 201 additions & 45 deletions internal/grpc/services/gateway/storageprovider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import (
"github.com/cs3org/reva/pkg/errtypes"
"github.com/cs3org/reva/pkg/rgrpc/status"
"github.com/cs3org/reva/pkg/rgrpc/todo/pool"
"github.com/cs3org/reva/pkg/storage/utils/etag"
"github.com/cs3org/reva/pkg/storage/utils/templates"
"github.com/cs3org/reva/pkg/user"
"github.com/dgrijalva/jwt-go"
Expand Down Expand Up @@ -1108,6 +1109,95 @@ func (s *svc) UnsetArbitraryMetadata(ctx context.Context, req *provider.UnsetArb
return res, nil
}

func (s *svc) statHome(ctx context.Context) (*provider.StatResponse, error) {
statRes, err := s.stat(ctx, &provider.StatRequest{
Ref: &provider.Reference{
Spec: &provider.Reference_Path{
Path: s.getHome(ctx),
},
},
})
if err != nil {
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating home"),
}, nil
}

if statRes.Status.Code != rpc.Code_CODE_OK {
if statRes.Status.Code == rpc.Code_CODE_NOT_FOUND {
return &provider.StatResponse{
Status: status.NewNotFound(ctx, "gateway: home not found"),
}, nil
}
err := status.NewErrorFromCode(statRes.Status.Code, "gateway")
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating home"),
}, nil
}

statSharedFolder, err := s.statSharesFolder(ctx)
if err != nil {
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating shares folder"),
}, nil
}
if statSharedFolder.Status.Code != rpc.Code_CODE_OK {
// If shares folder is not found, skip updating the etag
if statSharedFolder.Status.Code == rpc.Code_CODE_NOT_FOUND {
return statRes, nil
}
err := status.NewErrorFromCode(statSharedFolder.Status.Code, "gateway")
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating shares folder"),
}, nil
}

statRes.Info.Etag = etag.GenerateEtagFromResources(statRes.Info, []*provider.ResourceInfo{statSharedFolder.Info})
return statRes, nil
}

func (s *svc) statSharesFolder(ctx context.Context) (*provider.StatResponse, error) {
statRes, err := s.stat(ctx, &provider.StatRequest{
Ref: &provider.Reference{
Spec: &provider.Reference_Path{
Path: s.getSharedFolder(ctx),
},
},
})
if err != nil {
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating shares folder"),
}, nil
}

if statRes.Status.Code != rpc.Code_CODE_OK {
if statRes.Status.Code == rpc.Code_CODE_NOT_FOUND {
return &provider.StatResponse{
Status: status.NewNotFound(ctx, "gateway: shares folder not found"),
}, nil
}
err := status.NewErrorFromCode(statRes.Status.Code, "gateway")
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating shares folder"),
}, nil
}

lsRes, err := s.listSharesFolder(ctx)
if err != nil {
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error listing shares folder"),
}, nil
}
if lsRes.Status.Code != rpc.Code_CODE_OK {
err := status.NewErrorFromCode(lsRes.Status.Code, "gateway")
return &provider.StatResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating shares folder"),
}, nil
}
statRes.Info.Etag = etag.GenerateEtagFromResources(statRes.Info, lsRes.Infos)
return statRes, nil
}

func (s *svc) stat(ctx context.Context, req *provider.StatRequest) (*provider.StatResponse, error) {
c, err := s.find(ctx, req.Ref)
if err != nil {
Expand Down Expand Up @@ -1140,12 +1230,15 @@ func (s *svc) Stat(ctx context.Context, req *provider.StatRequest) (*provider.St
}, nil
}

if !s.inSharedFolder(ctx, p) {
return s.stat(ctx, req)
if path.Clean(p) == s.getHome(ctx) {
return s.statHome(ctx)
}

// TODO(labkode): we need to generate a unique etag based on the contained share names.
if s.isSharedFolder(ctx, p) {
return s.statSharesFolder(ctx)
}

if !s.inSharedFolder(ctx, p) {
return s.stat(ctx, req)
}

Expand Down Expand Up @@ -1368,6 +1461,102 @@ func (s *svc) ListContainerStream(_ *provider.ListContainerStreamRequest, _ gate
return errors.New("Unimplemented")
}

func (s *svc) listHome(ctx context.Context) (*provider.ListContainerResponse, error) {
lcr, err := s.listContainer(ctx, &provider.ListContainerRequest{
Ref: &provider.Reference{
Spec: &provider.Reference_Path{
Path: s.getHome(ctx),
},
},
})
if err != nil {
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error listing home"),
}, nil
}
if lcr.Status.Code != rpc.Code_CODE_OK {
err := status.NewErrorFromCode(lcr.Status.Code, "gateway")
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error listing home"),
}, nil
}

for i := range lcr.Infos {
if s.isSharedFolder(ctx, lcr.Infos[i].Path) {
statSharedFolder, err := s.statSharesFolder(ctx)
if err != nil {
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating shares folder"),
}, nil
}
if statSharedFolder.Status.Code != rpc.Code_CODE_OK {
if statSharedFolder.Status.Code == rpc.Code_CODE_NOT_FOUND {
return &provider.ListContainerResponse{
Status: status.NewNotFound(ctx, "gateway: shares folder not found"),
}, nil
}
err := status.NewErrorFromCode(statSharedFolder.Status.Code, "gateway")
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error stating shares folder"),
}, nil
}
lcr.Infos[i] = statSharedFolder.Info
break
}
}

return lcr, nil
}

func (s *svc) listSharesFolder(ctx context.Context) (*provider.ListContainerResponse, error) {
lcr, err := s.listContainer(ctx, &provider.ListContainerRequest{
Ref: &provider.Reference{
Spec: &provider.Reference_Path{
Path: s.getSharedFolder(ctx),
},
},
})
if err != nil {
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error listing shared folder"),
}, nil
}
if lcr.Status.Code != rpc.Code_CODE_OK {
err := status.NewErrorFromCode(lcr.Status.Code, "gateway")
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error listing shared folder"),
}, nil
}

for i, ref := range lcr.Infos {
info, protocol, err := s.checkRef(ctx, ref)
if err != nil {
if _, ok := err.(errtypes.IsNotFound); ok {
return &provider.ListContainerResponse{
Status: status.NewNotFound(ctx, "gateway: reference not found:"+ref.Target),
}, nil
}
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error resolving reference:"+ref.Path),
}, nil
}

if protocol == "webdav" {
info, err = s.webdavRefStat(ctx, ref.Target)
if err != nil {
// Might be the case that the webdav token has expired. In that case, use the reference's info
info = ref
}
}

base := path.Base(ref.Path)
info.Path = path.Join(ref.GetPath(), base)
lcr.Infos[i] = info
}

return lcr, nil
}

func (s *svc) listContainer(ctx context.Context, req *provider.ListContainerRequest) (*provider.ListContainerResponse, error) {
c, err := s.find(ctx, req.Ref)
if err != nil {
Expand Down Expand Up @@ -1405,46 +1594,16 @@ func (s *svc) ListContainer(ctx context.Context, req *provider.ListContainerRequ
}, nil
}

if !s.inSharedFolder(ctx, p) {
return s.listContainer(ctx, req)
if path.Clean(p) == s.getHome(ctx) {
return s.listHome(ctx)
}

if s.isSharedFolder(ctx, p) {
// TODO(labkode): we need to generate a unique etag if any of the underlying share changes.
// the response will contain all the share names and we need to convert them to non reference types.
lcr, err := s.listContainer(ctx, req)
if err != nil {
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error listing shared folder:"+req.Ref.String()),
}, nil
}

for i, ref := range lcr.Infos {
info, protocol, err := s.checkRef(ctx, ref)
if err != nil {
if _, ok := err.(errtypes.IsNotFound); ok {
return &provider.ListContainerResponse{
Status: status.NewNotFound(ctx, "gateway: reference not found:"+ref.Target),
}, nil
}
return &provider.ListContainerResponse{
Status: status.NewInternal(ctx, err, "gateway: error resolving reference:"+ref.Path),
}, nil
}

if protocol == "webdav" {
info, err = s.webdavRefStat(ctx, ref.Target)
if err != nil {
// Might be the case that the webdav token has expired. In that case, use the reference's info
info = ref
}
}
return s.listSharesFolder(ctx)
}

base := path.Base(ref.Path)
info.Path = path.Join(p, base)
lcr.Infos[i] = info
}
return lcr, nil
if !s.inSharedFolder(ctx, p) {
return s.listContainer(ctx, req)
}

// we need to provide the info of the target, not the reference.
Expand Down Expand Up @@ -1909,16 +2068,13 @@ func (s *svc) getStorageProviderClient(_ context.Context, p *registry.ProviderIn
}

func (s *svc) findProvider(ctx context.Context, ref *provider.Reference) (*registry.ProviderInfo, error) {
home, err := s.GetHome(ctx, &provider.GetHomeRequest{})
if err != nil {
return nil, err
}
if strings.HasPrefix(ref.GetPath(), home.Path) && s.c.HomeMapping != "" {
home := s.getHome(ctx)
if strings.HasPrefix(ref.GetPath(), home) && s.c.HomeMapping != "" {
if u, ok := user.ContextGetUser(ctx); ok {
layout := templates.WithUser(u, s.c.HomeMapping)
newRef := &provider.Reference{
Spec: &provider.Reference_Path{
Path: path.Join(layout, strings.TrimPrefix(ref.GetPath(), home.Path)),
Path: path.Join(layout, strings.TrimPrefix(ref.GetPath(), home)),
},
}
res, err := s.getStorageProvider(ctx, newRef)
Expand Down
Loading