The highest tagged major version is
Documentation
¶
Index ¶
- Variables
- func Cast(v any, to any)
- func ExtractGranteeID(grantee *provider.Grantee) (*userpb.UserId, *grouppb.GroupId)
- func GetAppViewMode(viewMode string) appprovider.ViewMode
- func GetClientIP(r *http.Request) (string, error)
- func GetLDAPConnection(c *LDAPConn) (*ldap.Conn, error)
- func GetViewMode(viewMode string) gateway.OpenInAppRequest_ViewMode
- func GranteeEqual(u, v *provider.Grantee) bool
- func GroupEqual(u, v *grouppb.GroupId) bool
- func HasOCMShareRole(u *userpb.User) (string, bool)
- func HasPermissions(target, toCheck *provider.ResourcePermissions) bool
- func HasPublicShareRole(u *userpb.User) (string, bool)
- func IsAbsolutePathReference(ref *provider.Reference) bool
- func IsAbsoluteReference(ref *provider.Reference) bool
- func IsEmailValid(e string) bool
- func IsRelativeReference(ref *provider.Reference) bool
- func IsValidName(name string) bool
- func IsValidPhoneNumber(number string) bool
- func IsValidWebAddress(address string) bool
- func LaterTS(t1 *types.Timestamp, t2 *types.Timestamp) *types.Timestamp
- func MakeRelativePath(p string) string
- func MarshalProtoV1ToJSON(m proto.Message) ([]byte, error)
- func ParseStorageSpaceReference(sRef string) (provider.Reference, error)
- func RandString(n int) string
- func ResolvePath(path string) (string, error)
- func ResourceEqual(u, v *provider.Reference) bool
- func ResourceIDEqual(u, v *provider.ResourceId) bool
- func Skip(source string, prefixes []string) bool
- func SplitStorageSpaceID(ssid string) (storageid, nodeid string, err error)
- func TSToTime(ts *types.Timestamp) time.Time
- func TSToUnixNano(ts *types.Timestamp) uint64
- func ToSnakeCase(str string) string
- func UnmarshalJSONToProtoV1(b []byte, m proto.Message) error
- func UserEqual(u, v *userpb.UserId) bool
- func UserIsLightweight(u *userpb.User) bool
- func UserTypeMap(accountType string) userpb.UserType
- func UserTypeToString(accountType userpb.UserType) string
- type LDAPConn
Constants ¶
This section is empty.
Variables ¶
var ( // GlobalRegistry configures a service registry globally accessible. It defaults to a memory registry. The usage of // globals is not encouraged, and this is a workaround until the PR is out of a draft state. GlobalRegistry registry.Registry = memory.New(map[string]interface{}{}) )
Functions ¶
func Cast ¶ added in v1.25.0
Cast casts a value `v` to the value `to`. `v` is expected to be the underlying type of `to`. For example, if the type A is defined as func() and v is func(), to is of type A. to must be a pointer, otherwise the method panics.
func ExtractGranteeID ¶
ExtractGranteeID returns the ID, user or group, set in the GranteeId object.
func GetAppViewMode ¶ added in v1.24.0
func GetAppViewMode(viewMode string) appprovider.ViewMode
GetAppViewMode converts a human-readable string to an appprovider view mode for opening a resource in an app.
func GetClientIP ¶
GetClientIP retrieves the client IP from incoming requests.
func GetLDAPConnection ¶
GetLDAPConnection initializes an LDAPS connection and allows to set TLS options e.g. to add trusted Certificates or disable Certificate verification.
func GetViewMode ¶
func GetViewMode(viewMode string) gateway.OpenInAppRequest_ViewMode
GetViewMode converts a human-readable string to a view mode for opening a resource in an app.
func GranteeEqual ¶
GranteeEqual returns whether two grantees have the same field values.
func GroupEqual ¶
GroupEqual returns whether two groups have the same field values.
func HasOCMShareRole ¶ added in v0.0.29
HasOCMShareRole return true if the user has a ocm share role. If yes, the string is the type of role, viewer, editor or uploader.
func HasPermissions ¶ added in v0.0.20
func HasPermissions(target, toCheck *provider.ResourcePermissions) bool
HasPermissions returns true if all permissions defined in the struct toCheck are set in the target.
func HasPublicShareRole ¶ added in v0.0.3
HasPublicShareRole return true if the user has a public share role. If yes, the string is the type of role, viewer, editor or uploader.
func IsAbsolutePathReference ¶
IsAbsolutePathReference returns true if the given reference qualifies as a global path when only the path is set and starts with /.
func IsAbsoluteReference ¶
IsAbsoluteReference returns true if the given reference qualifies as absolute when either only the resource id is set or only the path is set and starts with /
TODO(corby): Currently if the path is empty, the ResourceId is set but has empty storageId and OpaqueId then the reference is still being viewed as absolute. We need to check if we want that because in some places we might not want to set both StorageId and OpaqueId so we can't do a hard check if they are set.
func IsEmailValid ¶
IsEmailValid checks whether the provided email has a valid format.
func IsRelativeReference ¶
IsRelativeReference returns true if the given reference qualifies as relative when the resource id is set and the path starts with a .
TODO(corby): Currently if the path begins with a dot, the ResourceId is set but has empty storageId and OpaqueId then the reference is still being viewed as relative. We need to check if we want that because in some places we might not want to set both StorageId and OpaqueId so we can't do a hard check if they are set.
func IsValidName ¶
IsValidName cheks if the given name doesn't contain any non-alpha, space or dash characters.
func IsValidPhoneNumber ¶
IsValidPhoneNumber checks whether the provided phone number has a valid format.
func IsValidWebAddress ¶
IsValidWebAddress checks whether the provided address is a valid URL.
func MakeRelativePath ¶
MakeRelativePath prefixes the path with a . to use it in a relative reference.
func MarshalProtoV1ToJSON ¶
MarshalProtoV1ToJSON marshals a proto V1 message to a JSON byte array TODO: update this once we start using V2 in CS3APIs.
func ParseStorageSpaceReference ¶
ParseStorageSpaceReference parses a string into a spaces reference. The expected format is `<storageid>!<nodeid>/<path>`.
func ResolvePath ¶
ResolvePath converts relative local paths to absolute paths.
func ResourceEqual ¶
ResourceEqual returns whether two resources have the same field values.
func ResourceIDEqual ¶
func ResourceIDEqual(u, v *provider.ResourceId) bool
ResourceIDEqual returns whether two resources have the same field values.
func Skip ¶
Skip evaluates whether a source endpoint contains any of the prefixes. i.e: /a/b/c/d/e contains prefix /a/b/c.
func SplitStorageSpaceID ¶
SplitStorageSpaceID can be used to split `storagespaceid` into `storageid` and `nodeid` Currently they are built using `<storageid>!<nodeid>` in the decomposedfs, but other drivers might return different ids. any place in the code that relies on this function should instead use the storage registry to look up the responsible storage provider. Note: This would in effect change the storage registry into a storage space registry.
func TSToUnixNano ¶
TSToUnixNano converts a protobuf Timestamp to uint64 with nanoseconds resolution.
func ToSnakeCase ¶
ToSnakeCase converts a CamelCase string to a snake_case string.
func UnmarshalJSONToProtoV1 ¶
UnmarshalJSONToProtoV1 decodes a JSON byte array to a specified proto message type TODO: update this once we start using V2 in CS3APIs.
func UserIsLightweight ¶ added in v0.0.20
UserIsLightweight returns true if the user is a lightweight or federated account.
func UserTypeMap ¶
UserTypeMap translates account type string to CS3 UserType.
func UserTypeToString ¶
UserTypeToString translates CS3 UserType to user-readable string.
Types ¶
type LDAPConn ¶
type LDAPConn struct {
Hostname string `mapstructure:"hostname"`
Port int `mapstructure:"port"`
Insecure bool `docs:"false;Whether to skip certificate checks when sending requests." mapstructure:"insecure"`
CACert string `mapstructure:"cacert"`
BindUsername string `mapstructure:"bind_username"`
BindPassword string `mapstructure:"bind_password"`
}
LDAPConn holds the basic parameter for setting up an LDAP connection.
Source Files
Directories