Skip to content

Commit

Permalink
Decorate friendly name in case of OCM users
Browse files Browse the repository at this point in the history
  • Loading branch information
@glpatcern
glpatcern committed Mar 3, 2023
1 parent 3ebd42f commit db07dbc
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 31 deletions.
22 changes: 11 additions & 11 deletions docs/content/en/docs/config/packages/app/provider/wopi/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,87 +9,87 @@ description: >
# _struct: config_

{{% dir name="mime_types" type="[]string" default=nil %}}
Inherited from the appprovider. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L64)
Inherited from the appprovider. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L68)
{{< highlight toml >}}
[app.provider.wopi]
mime_types = nil
{{< /highlight >}}
{{% /dir %}}

{{% dir name="iop_secret" type="string" default="" %}}
The IOP secret used to connect to the wopiserver. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L65)
The IOP secret used to connect to the wopiserver. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L69)
{{< highlight toml >}}
[app.provider.wopi]
iop_secret = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="wopi_url" type="string" default="" %}}
The wopiserver's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L66)
The wopiserver's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L70)
{{< highlight toml >}}
[app.provider.wopi]
wopi_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_name" type="string" default="" %}}
The App user-friendly name. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L67)
The App user-friendly name. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L71)
{{< highlight toml >}}
[app.provider.wopi]
app_name = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_icon_uri" type="string" default="" %}}
A URI to a static asset which represents the app icon. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L68)
A URI to a static asset which represents the app icon. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L72)
{{< highlight toml >}}
[app.provider.wopi]
app_icon_uri = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="folder_base_url" type="string" default="" %}}
The base URL to generate links to navigate back to the containing folder. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L69)
The base URL to generate links to navigate back to the containing folder. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L73)
{{< highlight toml >}}
[app.provider.wopi]
folder_base_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_url" type="string" default="" %}}
The App URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L70)
The App URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L74)
{{< highlight toml >}}
[app.provider.wopi]
app_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_int_url" type="string" default="" %}}
The internal app URL in case of dockerized deployments. Defaults to AppURL [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L71)
The internal app URL in case of dockerized deployments. Defaults to AppURL [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L75)
{{< highlight toml >}}
[app.provider.wopi]
app_int_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_api_key" type="string" default="" %}}
The API key used by the app, if applicable. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L72)
The API key used by the app, if applicable. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L76)
{{< highlight toml >}}
[app.provider.wopi]
app_api_key = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="jwt_secret" type="string" default="" %}}
The JWT secret to be used to retrieve the token TTL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L73)
The JWT secret to be used to retrieve the token TTL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L77)
{{< highlight toml >}}
[app.provider.wopi]
jwt_secret = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_desktop_only" type="bool" default=false %}}
Specifies if the app can be opened only on desktop. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L74)
Specifies if the app can be opened only on desktop. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L78)
{{< highlight toml >}}
[app.provider.wopi]
app_desktop_only = false
Expand Down
39 changes: 24 additions & 15 deletions pkg/app/provider/wopi/wopi.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ import (

const publicLinkURLPrefix = "/files/link/public/"

const ocmLinkURLPrefix = "/files/spaces/sciencemesh/"

func init() {
registry.Register("wopi", New)
}
Expand Down Expand Up @@ -158,7 +160,6 @@ func (p *wopiProvider) GetAppURL(ctx context.Context, resource *provider.Resourc
} else {
q.Add("userid", u.Id.OpaqueId+"@"+u.Id.Idp)
}
q.Add("username", u.DisplayName)

scopes, ok := ctxpkg.ContextGetScopes(ctx)
if !ok {
Expand All @@ -168,19 +169,27 @@ func (p *wopiProvider) GetAppURL(ctx context.Context, resource *provider.Resourc

// TODO (lopresti) consolidate with the templating implemented in the edge branch;
// here we assume the FolderBaseURL looks like `https://<hostname>` and we
// either append `/files/spaces/<full_path>` or publicLinkURLPrefix + `/<relative_path>`
// either append `/files/spaces/<full_path>` or the proper URL prefix + `/<relative_path>`
var rPath string
var pathErr error
if _, ok := utils.HasPublicShareRole(u); ok {
// we are in a public link
q.Del("username") // on public shares default to "Guest xyz"
var err error
rPath, err = getPathForPublicLink(ctx, scopes, resource)
if err != nil {
log.Warn().Err(err).Msg("wopi: failed to extract relative path from public link scope")
// we are in a public link, username is not set so it will default to "Guest xyz"
rPath, pathErr = getPathForExternalLink(ctx, scopes, resource, publicLinkURLPrefix)
if pathErr != nil {
log.Warn().Err(pathErr).Msg("wopi: failed to extract relative path from public link scope")
}
} else if u.Username == "" {
// OCM users have no username: use displayname@Idp
q.Add("username", u.DisplayName+"@"+u.Id.Idp)
// and resolve the folder
rPath, pathErr = getPathForExternalLink(ctx, scopes, resource, ocmLinkURLPrefix)
if pathErr != nil {
log.Warn().Err(pathErr).Msg("wopi: failed to extract relative path from ocm link scope")
}
} else {
// in all other cases use the resource's path
rPath = "/files/spaces/" + path.Dir(resource.Path)
q.Add("username", u.DisplayName)
}
if rPath != "" {
fu, err := url.JoinPath(p.conf.FolderBaseURL, rPath)
Expand Down Expand Up @@ -472,13 +481,13 @@ func parseWopiDiscovery(body io.Reader) (map[string]map[string]string, error) {
return appURLs, nil
}

func getPathForPublicLink(ctx context.Context, scopes map[string]*authpb.Scope, resource *provider.ResourceInfo) (string, error) {
pubShares, err := scope.GetPublicSharesFromScopes(scopes)
func getPathForExternalLink(ctx context.Context, scopes map[string]*authpb.Scope, resource *provider.ResourceInfo, pathPrefix string) (string, error) {
shares, err := scope.GetPublicOcmSharesFromScopes(scopes)
if err != nil {
return "", err
}
if len(pubShares) > 1 {
return "", errors.New("More than one public share found in the scope, lookup not implemented")
if len(shares) > 1 {
return "", errors.New("More than one public or OCM share found in the scope, lookup not implemented")
}

client, err := pool.GetGatewayServiceClient(pool.Endpoint(sharedconf.GetGatewaySVC("")))
Expand All @@ -487,7 +496,7 @@ func getPathForPublicLink(ctx context.Context, scopes map[string]*authpb.Scope,
}
statRes, err := client.Stat(ctx, &provider.StatRequest{
Ref: &provider.Reference{
ResourceId: pubShares[0].ResourceId,
ResourceId: shares[0].ResourceId,
},
})
if err != nil {
Expand All @@ -496,7 +505,7 @@ func getPathForPublicLink(ctx context.Context, scopes map[string]*authpb.Scope,

if statRes.Info.Path == resource.Path {
// this is a direct link to the resource
return publicLinkURLPrefix + pubShares[0].Token, nil
return pathPrefix + shares[0].Token, nil
}
// otherwise we are in a subfolder of the public link
relPath, err := filepath.Rel(statRes.Info.Path, resource.Path)
Expand All @@ -506,5 +515,5 @@ func getPathForPublicLink(ctx context.Context, scopes map[string]*authpb.Scope,
if strings.HasPrefix(relPath, "../") {
return "", errors.New("Scope path does not contain target resource")
}
return path.Join(publicLinkURLPrefix+pubShares[0].Token, path.Dir(relPath)), nil
return path.Join(pathPrefix+shares[0].Token, path.Dir(relPath)), nil
}
6 changes: 3 additions & 3 deletions pkg/auth/scope/publicshare.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,11 +136,11 @@ func AddPublicShareScope(share *link.PublicShare, role authpb.Role, scopes map[s
return scopes, nil
}

// GetPublicSharesFromScopes returns all the public shares in the given scope.
func GetPublicSharesFromScopes(scopes map[string]*authpb.Scope) ([]*link.PublicShare, error) {
// GetPublicOcmSharesFromScopes returns all public and OCM shares in the given scope.
func GetPublicOcmSharesFromScopes(scopes map[string]*authpb.Scope) ([]*link.PublicShare, error) {
var shares []*link.PublicShare
for k, s := range scopes {
if strings.HasPrefix(k, "publicshare:") {
if strings.HasPrefix(k, "publicshare:") || strings.HasPrefix(k, "ocmshare:") {
res := s.Resource
if res.Decoder != "json" {
return nil, errtypes.InternalError("resource should be json encoded")
Expand Down
4 changes: 2 additions & 2 deletions pkg/utils/utils.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ func HasPublicShareRole(u *userpb.User) (string, bool) {
return "", false
}

// HasPermissions returns true if all permissions defined in the stuict toCheck
// HasPermissions returns true if all permissions defined in the struct toCheck
// are set in the target.
func HasPermissions(target, toCheck *provider.ResourcePermissions) bool {
targetStruct := reflect.ValueOf(target).Elem()
Expand All @@ -383,7 +383,7 @@ func HasPermissions(target, toCheck *provider.ResourcePermissions) bool {
return true
}

// UserIsLightweight returns true if the user is a lightweith
// UserIsLightweight returns true if the user is a lightweight
// or federated account.
func UserIsLightweight(u *userpb.User) bool {
return u.Id.Type == userpb.UserType_USER_TYPE_FEDERATED ||
Expand Down

0 comments on commit db07dbc

Please sign in to comment.