github.com/cs3org/reva/v2@v2.27.7/pkg/ctx/userctx.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 ctx
    20  
    21  import (
    22  	"context"
    23  
    24  	userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
    25  )
    26  
    27  type key int
    28  
    29  const (
    30  	userKey key = iota
    31  	tokenKey
    32  	idKey
    33  	lockIDKey
    34  	scopeKey
    35  	initiatorKey
    36  )
    37  
    38  // ContextGetUser returns the user if set in the given context.
    39  func ContextGetUser(ctx context.Context) (*userpb.User, bool) {
    40  	u, ok := ctx.Value(userKey).(*userpb.User)
    41  	return u, ok
    42  }
    43  
    44  // ContextMustGetUser panics if user is not in context.
    45  func ContextMustGetUser(ctx context.Context) *userpb.User {
    46  	u, ok := ContextGetUser(ctx)
    47  	if !ok {
    48  		panic("user not found in context")
    49  	}
    50  	return u
    51  }
    52  
    53  // ContextSetUser stores the user in the context.
    54  func ContextSetUser(ctx context.Context, u *userpb.User) context.Context {
    55  	return context.WithValue(ctx, userKey, u)
    56  }
    57  
    58  // ContextGetUserID returns the user if set in the given context.
    59  func ContextGetUserID(ctx context.Context) (*userpb.UserId, bool) {
    60  	u, ok := ctx.Value(idKey).(*userpb.UserId)
    61  	return u, ok
    62  }
    63  
    64  // ContextSetUserID stores the userid in the context.
    65  func ContextSetUserID(ctx context.Context, id *userpb.UserId) context.Context {
    66  	return context.WithValue(ctx, idKey, id)
    67  }