harbor/src/lib/context.go

// Copyright Project Harbor Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package lib

import (
	"context"
)

type contextKey string

// define all context key here to avoid conflict
const (
	contextKeyAPIVersion   contextKey = "apiVersion"
	contextKeyArtifactInfo contextKey = "artifactInfo"
	contextKeyAuthMode     contextKey = "authMode"
	contextKeyCarrySession contextKey = "carrySession"
	contextKeyRequestID    contextKey = "X-Request-ID"
)

// ArtifactInfo wraps the artifact info extracted from the request to "/v2/"
type ArtifactInfo struct {
	Repository           string
	Reference            string
	ProjectName          string
	Digest               string
	Tag                  string
	BlobMountRepository  string
	BlobMountProjectName string
	BlobMountDigest      string
}

func setToContext(ctx context.Context, key contextKey, value interface{}) context.Context {
	if ctx == nil {
		ctx = context.Background()
	}
	return context.WithValue(ctx, key, value)
}

func getFromContext(ctx context.Context, key contextKey) interface{} {
	if ctx == nil {
		return nil
	}
	return ctx.Value(key)
}

// WithAPIVersion returns a context with APIVersion set
func WithAPIVersion(ctx context.Context, version string) context.Context {
	return setToContext(ctx, contextKeyAPIVersion, version)
}

// GetAPIVersion gets the API version from the context
func GetAPIVersion(ctx context.Context) string {
	version := ""
	value := getFromContext(ctx, contextKeyAPIVersion)
	if value != nil {
		version, _ = value.(string)
	}
	return version
}

// WithArtifactInfo returns a context with ArtifactInfo set
func WithArtifactInfo(ctx context.Context, art ArtifactInfo) context.Context {
	return setToContext(ctx, contextKeyArtifactInfo, art)
}

// GetArtifactInfo gets the ArtifactInfo from the context
func GetArtifactInfo(ctx context.Context) (art ArtifactInfo) {
	value := getFromContext(ctx, contextKeyArtifactInfo)
	if value != nil {
		art, _ = value.(ArtifactInfo)
	}
	return
}

// WithAuthMode returns a context with auth mode set
func WithAuthMode(ctx context.Context, mode string) context.Context {
	return setToContext(ctx, contextKeyAuthMode, mode)
}

// GetAuthMode gets the auth mode from the context
func GetAuthMode(ctx context.Context) string {
	mode := ""
	value := getFromContext(ctx, contextKeyAuthMode)
	if value != nil {
		mode, _ = value.(string)
	}
	return mode
}

// WithCarrySession returns a context with "carry session" set that indicates whether the request carries session or not
func WithCarrySession(ctx context.Context, carrySession bool) context.Context {
	return setToContext(ctx, contextKeyCarrySession, carrySession)
}

// GetCarrySession gets the "carry session" from the context indicates whether the request carries session or not
func GetCarrySession(ctx context.Context) bool {
	carrySession := false
	value := getFromContext(ctx, contextKeyCarrySession)
	if value != nil {
		carrySession, _ = value.(bool)
	}
	return carrySession
}

// WithXRequestID returns a context with XRequestID set
func WithXRequestID(ctx context.Context, version string) context.Context {
	return setToContext(ctx, contextKeyRequestID, version)
}

// GetXRequestID gets the XRequestID from the context
func GetXRequestID(ctx context.Context) string {
	id := ""
	value := getFromContext(ctx, contextKeyRequestID)
	if value != nil {
		id, _ = value.(string)
	}
	return id
}