1
0
mirror of https://github.com/astaxie/beego.git synced 2024-12-25 18:10:50 +00:00
Beego/error.go

493 lines
13 KiB
Go
Raw Normal View History

2014-08-18 08:41:43 +00:00
// Copyright 2014 beego Author. All Rights Reserved.
2014-07-03 15:40:21 +00:00
//
2014-08-18 08:41:43 +00:00
// 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
2014-07-03 15:40:21 +00:00
//
2014-08-18 08:41:43 +00:00
// http://www.apache.org/licenses/LICENSE-2.0
2014-07-03 15:40:21 +00:00
//
2014-08-18 08:41:43 +00:00
// 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.
2015-02-26 15:34:43 +00:00
package beego
2013-09-09 16:00:11 +00:00
import (
"fmt"
"html/template"
"net/http"
2015-02-26 15:34:43 +00:00
"reflect"
2013-09-09 16:00:11 +00:00
"runtime"
2013-09-11 09:00:39 +00:00
"strconv"
2015-02-26 15:34:43 +00:00
"strings"
"github.com/astaxie/beego/context"
"github.com/astaxie/beego/utils"
2013-09-09 16:00:11 +00:00
)
2015-02-26 15:34:43 +00:00
const (
2020-07-08 10:09:01 +00:00
errorTypeHandler = iota
2015-02-26 15:34:43 +00:00
errorTypeController
2013-09-11 08:31:18 +00:00
)
2015-02-26 15:34:43 +00:00
2013-09-09 16:00:11 +00:00
var tpl = `
2013-12-06 05:44:54 +00:00
<!DOCTYPE html>
<html>
2013-09-09 16:00:11 +00:00
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>beego application error</title>
<style>
html, body, body * {padding: 0; margin: 0;}
#header {background:#ffd; border-bottom:solid 2px #A31515; padding: 20px 10px;}
#header h2{ }
#footer {border-top:solid 1px #aaa; padding: 5px 10px; font-size: 12px; color:green;}
#content {padding: 5px;}
#content .stack b{ font-size: 13px; color: red;}
#content .stack pre{padding-left: 10px;}
table {}
td.t {text-align: right; padding-right: 5px; color: #888;}
2013-12-06 05:44:54 +00:00
</style>
2013-09-09 16:00:11 +00:00
<script type="text/javascript">
</script>
2013-12-06 05:44:54 +00:00
</head>
2013-09-09 16:00:11 +00:00
<body>
<div id="header">
<h2>{{.AppError}}</h2>
</div>
<div id="content">
<table>
<tr>
<td class="t">Request Method: </td><td>{{.RequestMethod}}</td>
</tr>
<tr>
<td class="t">Request URL: </td><td>{{.RequestURL}}</td>
</tr>
<tr>
<td class="t">RemoteAddr: </td><td>{{.RemoteAddr }}</td>
</tr>
</table>
<div class="stack">
<b>Stack</b>
<pre>{{.Stack}}</pre>
</div>
</div>
<div id="footer">
<p>beego {{ .BeegoVersion }} (beego framework)</p>
<p>golang version: {{.GoVersion}}</p>
</div>
</body>
2013-12-06 05:44:54 +00:00
</html>
2013-09-09 16:00:11 +00:00
`
// render default application error page with error and stack string.
func showErr(err interface{}, ctx *context.Context, stack string) {
2013-09-09 16:00:11 +00:00
t, _ := template.New("beegoerrortemp").Parse(tpl)
data := map[string]string{
"AppError": fmt.Sprintf("%s:%v", BConfig.AppName, err),
"RequestMethod": ctx.Input.Method(),
"RequestURL": ctx.Input.URI(),
"RemoteAddr": ctx.Input.IP(),
"Stack": stack,
"BeegoVersion": VERSION,
"GoVersion": runtime.Version(),
}
2015-02-26 15:34:43 +00:00
t.Execute(ctx.ResponseWriter, data)
2013-09-09 16:00:11 +00:00
}
var errtpl = `
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>{{.Title}}</title>
<style type="text/css">
* {
margin:0;
padding:0;
}
body {
background-color:#EFEFEF;
font: .9em "Lucida Sans Unicode", "Lucida Grande", sans-serif;
}
#wrapper{
width:600px;
margin:40px auto 0;
text-align:center;
-moz-box-shadow: 5px 5px 10px rgba(0,0,0,0.3);
-webkit-box-shadow: 5px 5px 10px rgba(0,0,0,0.3);
box-shadow: 5px 5px 10px rgba(0,0,0,0.3);
}
#wrapper h1{
color:#FFF;
text-align:center;
margin-bottom:20px;
}
#wrapper a{
display:block;
font-size:.9em;
padding-top:20px;
color:#FFF;
text-decoration:none;
text-align:center;
}
#container {
width:600px;
padding-bottom:15px;
background-color:#FFFFFF;
}
.navtop{
height:40px;
background-color:#24B2EB;
padding:13px;
}
.content {
padding:10px 10px 25px;
background: #FFFFFF;
margin:;
color:#333;
}
a.button{
color:white;
padding:15px 20px;
text-shadow:1px 1px 0 #00A5FF;
font-weight:bold;
text-align:center;
border:1px solid #24B2EB;
margin:0px 200px;
clear:both;
background-color: #24B2EB;
border-radius:100px;
-moz-border-radius:100px;
-webkit-border-radius:100px;
}
a.button:hover{
text-decoration:none;
background-color: #24B2EB;
}
</style>
</head>
<body>
<div id="wrapper">
<div id="container">
<div class="navtop">
<h1>{{.Title}}</h1>
</div>
<div id="content">
{{.Content}}
<a href="/" title="Home" class="button">Go Home</a><br />
<br>Powered by beego {{.BeegoVersion}}
2013-09-09 16:00:11 +00:00
</div>
</div>
</div>
</body>
</html>
`
2015-02-26 15:34:43 +00:00
type errorInfo struct {
controllerType reflect.Type
handler http.HandlerFunc
method string
errorType int
}
2016-01-17 16:18:21 +00:00
// ErrorMaps holds map of http handlers for each error string.
2015-09-18 02:32:21 +00:00
// there is 10 kinds default error(40x and 50x)
2020-08-05 13:57:20 +00:00
// Deprecated: using pkg/, we will delete this in v2.1.0
2015-09-17 15:05:45 +00:00
var ErrorMaps = make(map[string]*errorInfo, 10)
2013-09-09 16:00:11 +00:00
2015-02-26 15:49:24 +00:00
// show 401 unauthorized error.
func unauthorized(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
401,
"<br>The page you have requested can't be authorized."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br>The credentials you supplied are incorrect"+
"<br>There are errors in the website address"+
"</ul>",
)
2013-09-09 16:00:11 +00:00
}
2015-02-26 15:49:24 +00:00
// show 402 Payment Required
func paymentRequired(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
402,
"<br>The page you have requested Payment Required."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br>The credentials you supplied are incorrect"+
"<br>There are errors in the website address"+
"</ul>",
)
2013-09-09 16:00:11 +00:00
}
// show 403 forbidden error.
2015-02-26 15:49:24 +00:00
func forbidden(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
403,
"<br>The page you have requested is forbidden."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br>Your address may be blocked"+
"<br>The site may be disabled"+
"<br>You need to log in"+
"</ul>",
)
2013-09-09 16:00:11 +00:00
}
// show 422 missing xsrf token
func missingxsrf(rw http.ResponseWriter, r *http.Request) {
responseError(rw, r,
422,
"<br>The page you have requested is forbidden."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br>'_xsrf' argument missing from POST"+
"</ul>",
)
}
// show 417 invalid xsrf token
func invalidxsrf(rw http.ResponseWriter, r *http.Request) {
responseError(rw, r,
417,
"<br>The page you have requested is forbidden."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br>expected XSRF not found"+
"</ul>",
)
}
2016-03-17 01:35:14 +00:00
// show 404 not found error.
2015-02-26 15:49:24 +00:00
func notFound(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
404,
"<br>The page you have requested has flown the coop."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br>The page has moved"+
"<br>The page no longer exists"+
"<br>You were looking for your puppy and got lost"+
"<br>You like 404 pages"+
"</ul>",
)
2015-02-26 15:49:24 +00:00
}
// show 405 Method Not Allowed
func methodNotAllowed(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
405,
"<br>The method you have requested Not Allowed."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br>The method specified in the Request-Line is not allowed for the resource identified by the Request-URI"+
"<br>The response MUST include an Allow header containing a list of valid methods for the requested resource."+
"</ul>",
)
2013-09-09 16:00:11 +00:00
}
// show 500 internal server error.
2015-02-26 15:49:24 +00:00
func internalServerError(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
500,
"<br>The page you have requested is down right now."+
"<br><br><ul>"+
"<br>Please try again later and report the error to the website administrator"+
"<br></ul>",
)
2013-09-09 16:00:11 +00:00
}
2015-02-26 15:49:24 +00:00
// show 501 Not Implemented.
func notImplemented(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
501,
"<br>The page you have requested is Not Implemented."+
"<br><br><ul>"+
"<br>Please try again later and report the error to the website administrator"+
"<br></ul>",
)
2015-02-26 15:49:24 +00:00
}
// show 502 Bad Gateway.
func badGateway(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
502,
"<br>The page you have requested is down right now."+
"<br><br><ul>"+
"<br>The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request."+
"<br>Please try again later and report the error to the website administrator"+
"<br></ul>",
)
2015-02-26 15:49:24 +00:00
}
// show 503 service unavailable error.
func serviceUnavailable(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
503,
"<br>The page you have requested is unavailable."+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br><br>The page is overloaded"+
"<br>Please try again later."+
"</ul>",
)
2015-02-26 15:49:24 +00:00
}
// show 504 Gateway Timeout.
func gatewayTimeout(rw http.ResponseWriter, r *http.Request) {
2016-03-17 01:35:14 +00:00
responseError(rw, r,
504,
"<br>The page you have requested is unavailable"+
"<br>Perhaps you are here because:"+
"<br><br><ul>"+
"<br><br>The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI."+
"<br>Please try again later."+
"</ul>",
)
}
2020-07-08 10:09:01 +00:00
// show 413 Payload Too Large
func payloadTooLarge(rw http.ResponseWriter, r *http.Request) {
responseError(rw, r,
413,
`<br>The page you have requested is unavailable.
<br>Perhaps you are here because:<br><br>
<ul>
<br>The request entity is larger than limits defined by server.
<br>Please change the request entity and try again.
</ul>
`,
2020-07-08 10:09:01 +00:00
)
}
2016-03-17 01:35:14 +00:00
func responseError(rw http.ResponseWriter, r *http.Request, errCode int, errContent string) {
2015-02-26 15:49:24 +00:00
t, _ := template.New("beegoerrortemp").Parse(errtpl)
data := M{
2016-03-17 01:35:14 +00:00
"Title": http.StatusText(errCode),
"BeegoVersion": VERSION,
"Content": template.HTML(errContent),
}
2015-02-26 15:49:24 +00:00
t.Execute(rw, data)
2013-12-06 05:44:54 +00:00
}
2015-02-26 15:34:43 +00:00
// ErrorHandler registers http.HandlerFunc to each http err code string.
// usage:
// beego.ErrorHandler("404",NotFound)
// beego.ErrorHandler("500",InternalServerError)
2020-08-05 13:57:20 +00:00
// Deprecated: using pkg/, we will delete this in v2.1.0
2015-09-08 13:41:38 +00:00
func ErrorHandler(code string, h http.HandlerFunc) *App {
ErrorMaps[code] = &errorInfo{
errorType: errorTypeHandler,
handler: h,
method: code,
}
2015-02-26 15:34:43 +00:00
return BeeApp
}
// ErrorController registers ControllerInterface to each http err code string.
// usage:
2015-09-08 13:41:38 +00:00
// beego.ErrorController(&controllers.ErrorController{})
2020-08-05 13:57:20 +00:00
// Deprecated: using pkg/, we will delete this in v2.1.0
2015-02-26 15:34:43 +00:00
func ErrorController(c ControllerInterface) *App {
reflectVal := reflect.ValueOf(c)
rt := reflectVal.Type()
ct := reflect.Indirect(reflectVal).Type()
for i := 0; i < rt.NumMethod(); i++ {
2015-09-18 09:59:28 +00:00
methodName := rt.Method(i).Name
if !utils.InSlice(methodName, exceptMethod) && strings.HasPrefix(methodName, "Error") {
errName := strings.TrimPrefix(methodName, "Error")
ErrorMaps[errName] = &errorInfo{
errorType: errorTypeController,
controllerType: ct,
method: methodName,
}
2015-02-26 15:34:43 +00:00
}
}
return BeeApp
}
2016-06-01 13:30:04 +00:00
// Exception Write HttpStatus with errCode and Exec error handler if exist.
2020-08-05 13:57:20 +00:00
// Deprecated: using pkg/, we will delete this in v2.1.0
2016-06-01 13:30:04 +00:00
func Exception(errCode uint64, ctx *context.Context) {
exception(strconv.FormatUint(errCode, 10), ctx)
}
// show error string as simple text message.
2015-09-17 02:33:12 +00:00
// if error string is empty, show 503 or 500 error as default.
func exception(errCode string, ctx *context.Context) {
2015-09-18 09:03:00 +00:00
atoi := func(code string) int {
v, err := strconv.Atoi(code)
if err == nil {
return v
2015-09-18 02:31:10 +00:00
}
if ctx.Output.Status == 0 {
return 503
}
return ctx.Output.Status
2015-09-18 09:03:00 +00:00
}
for _, ec := range []string{errCode, "503", "500"} {
2015-09-17 02:33:12 +00:00
if h, ok := ErrorMaps[ec]; ok {
2015-09-18 09:03:00 +00:00
executeError(h, ctx, atoi(ec))
2015-09-17 02:33:12 +00:00
return
}
2013-09-11 09:00:39 +00:00
}
2015-09-17 02:33:12 +00:00
//if 50x error has been removed from errorMap
2015-09-18 09:03:00 +00:00
ctx.ResponseWriter.WriteHeader(atoi(errCode))
2015-09-17 02:33:12 +00:00
ctx.WriteString(errCode)
2015-02-26 15:34:43 +00:00
}
2015-03-30 12:35:57 +00:00
func executeError(err *errorInfo, ctx *context.Context, code int) {
//make sure to log the error in the access log
2019-02-14 15:29:26 +00:00
LogAccess(ctx, nil, code)
2015-02-26 15:34:43 +00:00
if err.errorType == errorTypeHandler {
2016-02-01 14:39:41 +00:00
ctx.ResponseWriter.WriteHeader(code)
2015-02-26 15:34:43 +00:00
err.handler(ctx.ResponseWriter, ctx.Request)
return
2015-02-23 03:50:13 +00:00
}
2015-02-26 15:34:43 +00:00
if err.errorType == errorTypeController {
2015-03-30 12:35:57 +00:00
ctx.Output.SetStatus(code)
2015-02-26 15:34:43 +00:00
//Invoke the request handler
vc := reflect.New(err.controllerType)
execController, ok := vc.Interface().(ControllerInterface)
if !ok {
panic("controller is not ControllerInterface")
}
//call the controller init function
execController.Init(ctx, err.controllerType.Name(), err.method, vc.Interface())
//call prepare function
execController.Prepare()
execController.URLMapping()
method := vc.MethodByName(err.method)
method.Call([]reflect.Value{})
2015-02-26 15:34:43 +00:00
//render template
2015-12-09 15:35:04 +00:00
if BConfig.WebConfig.AutoRender {
2015-03-30 12:35:57 +00:00
if err := execController.Render(); err != nil {
panic(err)
2015-02-26 15:34:43 +00:00
}
}
// finish all runrouter. release resource
execController.Finish()
2015-02-23 03:50:13 +00:00
}
2013-09-11 09:00:39 +00:00
}