mirror of
				https://github.com/go-gitea/gitea
				synced 2025-11-04 05:18:25 +00:00 
			
		
		
		
	Add nakedret, unconvert, wastedassign, stylecheck and nolintlint linters to improve code readability - nakedret - https://github.com/alexkohler/nakedret - nakedret is a Go static analysis tool to find naked returns in functions greater than a specified function length. - unconvert - https://github.com/mdempsky/unconvert - Remove unnecessary type conversions - wastedassign - https://github.com/sanposhiho/wastedassign - wastedassign finds wasted assignment statements. - notlintlint - Reports ill-formed or insufficient nolint directives - stylecheck - https://staticcheck.io/docs/checks/#ST - keep style consistent - excluded: [ST1003 - Poorly chosen identifier](https://staticcheck.io/docs/checks/#ST1003) and [ST1005 - Incorrectly formatted error string](https://staticcheck.io/docs/checks/#ST1005)
		
			
				
	
	
		
			87 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			87 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2020 The Gitea Authors. All rights reserved.
 | 
						|
// Use of this source code is governed by a MIT-style
 | 
						|
// license that can be found in the LICENSE file.
 | 
						|
 | 
						|
package context
 | 
						|
 | 
						|
import (
 | 
						|
	"context"
 | 
						|
	"fmt"
 | 
						|
	"net/http"
 | 
						|
	"time"
 | 
						|
 | 
						|
	"code.gitea.io/gitea/modules/graceful"
 | 
						|
	"code.gitea.io/gitea/modules/process"
 | 
						|
)
 | 
						|
 | 
						|
// PrivateContext represents a context for private routes
 | 
						|
type PrivateContext struct {
 | 
						|
	*Context
 | 
						|
	Override context.Context
 | 
						|
}
 | 
						|
 | 
						|
// Deadline is part of the interface for context.Context and we pass this to the request context
 | 
						|
func (ctx *PrivateContext) Deadline() (deadline time.Time, ok bool) {
 | 
						|
	if ctx.Override != nil {
 | 
						|
		return ctx.Override.Deadline()
 | 
						|
	}
 | 
						|
	return ctx.Req.Context().Deadline()
 | 
						|
}
 | 
						|
 | 
						|
// Done is part of the interface for context.Context and we pass this to the request context
 | 
						|
func (ctx *PrivateContext) Done() <-chan struct{} {
 | 
						|
	if ctx.Override != nil {
 | 
						|
		return ctx.Override.Done()
 | 
						|
	}
 | 
						|
	return ctx.Req.Context().Done()
 | 
						|
}
 | 
						|
 | 
						|
// Err is part of the interface for context.Context and we pass this to the request context
 | 
						|
func (ctx *PrivateContext) Err() error {
 | 
						|
	if ctx.Override != nil {
 | 
						|
		return ctx.Override.Err()
 | 
						|
	}
 | 
						|
	return ctx.Req.Context().Err()
 | 
						|
}
 | 
						|
 | 
						|
var privateContextKey interface{} = "default_private_context"
 | 
						|
 | 
						|
// WithPrivateContext set up private context in request
 | 
						|
func WithPrivateContext(req *http.Request, ctx *PrivateContext) *http.Request {
 | 
						|
	return req.WithContext(context.WithValue(req.Context(), privateContextKey, ctx))
 | 
						|
}
 | 
						|
 | 
						|
// GetPrivateContext returns a context for Private routes
 | 
						|
func GetPrivateContext(req *http.Request) *PrivateContext {
 | 
						|
	return req.Context().Value(privateContextKey).(*PrivateContext)
 | 
						|
}
 | 
						|
 | 
						|
// PrivateContexter returns apicontext as middleware
 | 
						|
func PrivateContexter() func(http.Handler) http.Handler {
 | 
						|
	return func(next http.Handler) http.Handler {
 | 
						|
		return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 | 
						|
			ctx := &PrivateContext{
 | 
						|
				Context: &Context{
 | 
						|
					Resp: NewResponse(w),
 | 
						|
					Data: map[string]interface{}{},
 | 
						|
				},
 | 
						|
			}
 | 
						|
			defer ctx.Close()
 | 
						|
 | 
						|
			ctx.Req = WithPrivateContext(req, ctx)
 | 
						|
			ctx.Data["Context"] = ctx
 | 
						|
			next.ServeHTTP(ctx.Resp, ctx.Req)
 | 
						|
		})
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
// OverrideContext overrides the underlying request context for Done() etc.
 | 
						|
// This function should be used when there is a need for work to continue even if the request has been cancelled.
 | 
						|
// Primarily this affects hook/post-receive and hook/proc-receive both of which need to continue working even if
 | 
						|
// the underlying request has timed out from the ssh/http push
 | 
						|
func OverrideContext(ctx *PrivateContext) (cancel context.CancelFunc) {
 | 
						|
	// We now need to override the request context as the base for our work because even if the request is cancelled we have to continue this work
 | 
						|
	ctx.Override, _, cancel = process.GetManager().AddTypedContext(graceful.GetManager().HammerContext(), fmt.Sprintf("PrivateContext: %s", ctx.Req.RequestURI), process.RequestProcessType, true)
 | 
						|
	return cancel
 | 
						|
}
 |