github.com/cs3org/reva/v2@v2.27.7/pkg/storage/utils/decomposedfs/usermapper/usermapper.go (about)

     1  // Copyright 2018-2021 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package usermapper
    20  
    21  import (
    22  	"context"
    23  )
    24  
    25  // Mapper is the interface that wraps the basic mapping methods
    26  type Mapper interface {
    27  	RunInBaseScope(f func() error) error
    28  	ScopeBase() (func() error, error)
    29  	ScopeUser(ctx context.Context) (func() error, error)
    30  	ScopeUserByIds(uid, gid int) (func() error, error)
    31  }
    32  
    33  // UnscopeFunc is a function that unscopes the current user
    34  type UnscopeFunc func() error
    35  
    36  // NullMapper is a user mapper that does nothing
    37  type NullMapper struct{}
    38  
    39  // RunInBaseScope runs the given function in the scope of the base user
    40  func (nm *NullMapper) RunInBaseScope(f func() error) error {
    41  	return f()
    42  }
    43  
    44  // ScopeBase returns to the base uid and gid returning a function that can be used to restore the previous scope
    45  func (nm *NullMapper) ScopeBase() (func() error, error) {
    46  	return func() error { return nil }, nil
    47  }
    48  
    49  // ScopeUser returns to the base uid and gid returning a function that can be used to restore the previous scope
    50  func (nm *NullMapper) ScopeUser(ctx context.Context) (func() error, error) {
    51  	return func() error { return nil }, nil
    52  }
    53  
    54  func (nm *NullMapper) ScopeUserByIds(uid, gid int) (func() error, error) {
    55  	return func() error { return nil }, nil
    56  }