mirror of
				https://github.com/caddyserver/caddy.git
				synced 2025-11-04 01:19:20 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			70 lines
		
	
	
		
			2.2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			70 lines
		
	
	
		
			2.2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2015 Matthew Holt and The Caddy 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 caddyhttp
 | 
						|
 | 
						|
import (
 | 
						|
	"fmt"
 | 
						|
	"net/http"
 | 
						|
	"strconv"
 | 
						|
 | 
						|
	"github.com/caddyserver/caddy/v2"
 | 
						|
)
 | 
						|
 | 
						|
func init() {
 | 
						|
	caddy.RegisterModule(StaticError{})
 | 
						|
}
 | 
						|
 | 
						|
// StaticError implements a simple handler that returns an error.
 | 
						|
// This handler returns an error value, but does not write a response.
 | 
						|
// This is useful when you want the server to act as if an error
 | 
						|
// occurred; for example, to invoke your custom error handling logic.
 | 
						|
//
 | 
						|
// Since this handler does not write a response, the error information
 | 
						|
// is for use by the server to know how to handle the error.
 | 
						|
type StaticError struct {
 | 
						|
	// The error message. Optional. Default is no error message.
 | 
						|
	Error string `json:"error,omitempty"`
 | 
						|
 | 
						|
	// The recommended HTTP status code. Can be either an integer or a
 | 
						|
	// string if placeholders are needed. Optional. Default is 500.
 | 
						|
	StatusCode WeakString `json:"status_code,omitempty"`
 | 
						|
}
 | 
						|
 | 
						|
// CaddyModule returns the Caddy module information.
 | 
						|
func (StaticError) CaddyModule() caddy.ModuleInfo {
 | 
						|
	return caddy.ModuleInfo{
 | 
						|
		ID:  "http.handlers.error",
 | 
						|
		New: func() caddy.Module { return new(StaticError) },
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func (e StaticError) ServeHTTP(w http.ResponseWriter, r *http.Request, _ Handler) error {
 | 
						|
	repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
 | 
						|
 | 
						|
	statusCode := http.StatusInternalServerError
 | 
						|
	if codeStr := e.StatusCode.String(); codeStr != "" {
 | 
						|
		intVal, err := strconv.Atoi(repl.ReplaceAll(codeStr, ""))
 | 
						|
		if err != nil {
 | 
						|
			return Error(http.StatusInternalServerError, err)
 | 
						|
		}
 | 
						|
		statusCode = intVal
 | 
						|
	}
 | 
						|
 | 
						|
	return Error(statusCode, fmt.Errorf("%s", e.Error))
 | 
						|
}
 | 
						|
 | 
						|
// Interface guard
 | 
						|
var _ MiddlewareHandler = (*StaticError)(nil)
 |