Add some unofficial http error codes

Former-commit-id: 5b9ed411e446e5e4d5e6c3ec705c314cc5c1c9ec

core/router/api_builder.go

@@ -971,16 +971,10 @@ func (api *APIBuilder) Favicon(favPath string, requestPath ...string) *Route {
 	return api.registerResourceRoute(reqPath, h).Describe(description)
 }
 
-// OnErrorCode registers an error http status code
+// OnErrorCode registers a handlers chain for this `Party` for a specific HTTP status code.
-// based on the "statusCode" < 200 || >= 400 (came from `context.StatusCodeNotSuccessful`).
+// Read more at: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
-// The handler is being wrapped by a generic
+// Look `OnAnyErrorCode` too.
-// handler which will try to reset
-// the body if recorder was enabled
-// and/or disable the gzip if gzip response recorder
-// was active.
 func (api *APIBuilder) OnErrorCode(statusCode int, handlers ...context.Handler) {
-	// TODO: think a stable way for that and document it so end-developers
-	// not be suprised. Many feature requests in the past asked for that per-party error handlers.
 	api.handle(statusCode, "", "/", handlers...)
 
 	if api.relativePath != "/" {
@@ -988,17 +982,110 @@ func (api *APIBuilder) OnErrorCode(statusCode int, handlers ...context.Handler)
 	}
 }
 
-// OnAnyErrorCode registers a handler which called when error status code written.
+// ClientErrorCodes holds the 4xx Client errors.
-// Same as `OnErrorCode` but registers all http error codes based on the `context.StatusCodeNotSuccessful`
+var (
-// which defaults to < 200 || >= 400 for an error code, any previous error code will be overridden,
+	ClientErrorCodes = []int{
-// so call it first if you want to use any custom handler for a specific error status code.
+		http.StatusBadRequest,
-//
+		http.StatusUnauthorized,
-// Read more at: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+		http.StatusPaymentRequired,
+		http.StatusForbidden,
+		http.StatusNotFound,
+		http.StatusMethodNotAllowed,
+		http.StatusNotAcceptable,
+		http.StatusProxyAuthRequired,
+		http.StatusRequestTimeout,
+		http.StatusConflict,
+		http.StatusGone,
+		http.StatusLengthRequired,
+		http.StatusPreconditionFailed,
+		http.StatusRequestEntityTooLarge,
+		http.StatusRequestURITooLong,
+		http.StatusUnsupportedMediaType,
+		http.StatusRequestedRangeNotSatisfiable,
+		http.StatusExpectationFailed,
+		http.StatusTeapot,
+		http.StatusMisdirectedRequest,
+		http.StatusUnprocessableEntity,
+		http.StatusLocked,
+		http.StatusFailedDependency,
+		http.StatusTooEarly,
+		http.StatusUpgradeRequired,
+		http.StatusPreconditionRequired,
+		http.StatusTooManyRequests,
+		http.StatusRequestHeaderFieldsTooLarge,
+		http.StatusUnavailableForLegalReasons,
+		// Unofficial.
+		StatusPageExpired,
+		StatusBlockedByWindowsParentalControls,
+		StatusInvalidToken,
+		StatusTokenRequired,
+	}
+	// ServerErrorCodes holds the 5xx Server errors.
+	ServerErrorCodes = []int{
+		http.StatusInternalServerError,
+		http.StatusNotImplemented,
+		http.StatusBadGateway,
+		http.StatusServiceUnavailable,
+		http.StatusGatewayTimeout,
+		http.StatusHTTPVersionNotSupported,
+		http.StatusVariantAlsoNegotiates,
+		http.StatusInsufficientStorage,
+		http.StatusLoopDetected,
+		http.StatusNotExtended,
+		http.StatusNetworkAuthenticationRequired,
+		// Unofficial.
+		StatusBandwidthLimitExceeded,
+		StatusInvalidSSLCertificate,
+		StatusSiteOverloaded,
+		StatusSiteFrozen,
+		StatusNetworkReadTimeout,
+	}
+)
+
+// Unofficial status error codes.
+const (
+	// 4xx
+	StatusPageExpired                      = 419
+	StatusBlockedByWindowsParentalControls = 450
+	StatusInvalidToken                     = 498
+	StatusTokenRequired                    = 499
+	// 5xx
+	StatusBandwidthLimitExceeded = 509
+	StatusInvalidSSLCertificate  = 526
+	StatusSiteOverloaded         = 529
+	StatusSiteFrozen             = 530
+	StatusNetworkReadTimeout     = 598
+)
+
+var unofficialStatusText = map[int]string{
+	StatusPageExpired:                      "Page Expired",
+	StatusBlockedByWindowsParentalControls: "Blocked by Windows Parental Controls",
+	StatusInvalidToken:                     "Invalid Token",
+	StatusTokenRequired:                    "Token Required",
+	StatusBandwidthLimitExceeded:           "Bandwidth Limit Exceeded",
+	StatusInvalidSSLCertificate:            "Invalid SSL Certificate",
+	StatusSiteOverloaded:                   "Site is overloaded",
+	StatusSiteFrozen:                       "Site is frozen",
+	StatusNetworkReadTimeout:               "Network read timeout error",
+}
+
+// StatusText returns a text for the HTTP status code. It returns the empty
+// string if the code is unknown.
+func StatusText(code int) string {
+	text := http.StatusText(code)
+	if text == "" {
+		text = unofficialStatusText[code]
+	}
+
+	return text
+}
+
+// OnAnyErrorCode registers a handlers chain for all error codes
+// (4xxx and 5xxx, change the `ClientErrorCodes` and `ServerErrorCodes` variables to modify those)
+// Look `OnErrorCode` too.
 func (api *APIBuilder) OnAnyErrorCode(handlers ...context.Handler) {
-	for code := 100; code <= 511; code++ {
+	for _, statusCode := range append(ClientErrorCodes, ServerErrorCodes...) {
-		if context.StatusCodeNotSuccessful(code) {
+		api.OnErrorCode(statusCode, handlers...)
-			api.OnErrorCode(code, handlers...)
-		}
 	}
 }
 

core/router/handler.go

@@ -506,7 +506,7 @@ func (h *routerHandler) FireErrorCode(ctx context.Context) {
 	}
 
 	// not error handler found, write a default message.
-	ctx.WriteString(http.StatusText(statusCode))
+	ctx.WriteString(StatusText(statusCode))
 }
 
 func statusCodeSuccessful(statusCode int) bool {

core/router/party.go

@@ -33,20 +33,13 @@ type Party interface {
 	// Learn more at:  https://github.com/kataras/iris/tree/master/_examples/routing/dynamic-path
 	Macros() *macro.Macros
 
-	// OnErrorCode registers an error http status code
+	// OnErrorCode registers a handlers chain for this `Party` for a specific HTTP status code.
-	// based on the "statusCode" < 200 || >= 400 (came from `context.StatusCodeNotSuccessful`).
-	// The handler is being wrapped by a generic
-	// handler which will try to reset
-	// the body if recorder was enabled
-	// and/or disable the gzip if gzip response recorder
-	// was active.
-	OnErrorCode(statusCode int, handlers ...context.Handler)
-	// OnAnyErrorCode registers a handler which called when error status code written.
-	// Same as `OnErrorCode` but registers all http error codes based on the `context.StatusCodeNotSuccessful`
-	// which defaults to < 200 || >= 400 for an error code, any previous error code will be overridden,
-	// so call it first if you want to use any custom handler for a specific error status code.
-	//
 	// Read more at: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+	// Look `OnAnyErrorCode` too.
+	OnErrorCode(statusCode int, handlers ...context.Handler)
+	// OnAnyErrorCode registers a handlers chain for all error codes
+	// (4xxx and 5xxx, change the `ClientErrorCodes` and `ServerErrorCodes` variables to modify those)
+	// Look `OnErrorCode` too.
 	OnAnyErrorCode(handlers ...context.Handler)
 
 	// Party groups routes which may have the same prefix and share same handlers,

iris.go

@@ -78,6 +78,7 @@ const (
 	StatusLengthRequired               = 411 // RFC 7231, 6.5.10
 	StatusPreconditionFailed           = 412 // RFC 7232, 4.2
 	StatusRequestEntityTooLarge        = 413 // RFC 7231, 6.5.11
+	StatusPayloadTooRage               = StatusRequestEntityTooLarge
 	StatusRequestURITooLong            = 414 // RFC 7231, 6.5.12
 	StatusUnsupportedMediaType         = 415 // RFC 7231, 6.5.13
 	StatusRequestedRangeNotSatisfiable = 416 // RFC 7233, 4.4
@@ -93,7 +94,12 @@ const (
 	StatusTooManyRequests              = 429 // RFC 6585, 4
 	StatusRequestHeaderFieldsTooLarge  = 431 // RFC 6585, 5
 	StatusUnavailableForLegalReasons   = 451 // RFC 7725, 3
-
+	// Unofficial Client Errors.
+	StatusPageExpired                      = router.StatusPageExpired
+	StatusBlockedByWindowsParentalControls = router.StatusBlockedByWindowsParentalControls
+	StatusInvalidToken                     = router.StatusInvalidToken
+	StatusTokenRequired                    = router.StatusTokenRequired
+	//
 	StatusInternalServerError           = 500 // RFC 7231, 6.6.1
 	StatusNotImplemented                = 501 // RFC 7231, 6.6.2
 	StatusBadGateway                    = 502 // RFC 7231, 6.6.3
@@ -105,8 +111,20 @@ const (
 	StatusLoopDetected                  = 508 // RFC 5842, 7.2
 	StatusNotExtended                   = 510 // RFC 2774, 7
 	StatusNetworkAuthenticationRequired = 511 // RFC 6585, 6
+	// Unofficial Server Errors.
+	StatusBandwidthLimitExceeded = router.StatusBandwidthLimitExceeded
+	StatusInvalidSSLCertificate  = router.StatusInvalidSSLCertificate
+	StatusSiteOverloaded         = router.StatusSiteOverloaded
+	StatusSiteFrozen             = router.StatusSiteFrozen
+	StatusNetworkReadTimeout     = router.StatusNetworkReadTimeout
 )
 
+// StatusText returns a text for the HTTP status code. It returns the empty
+// string if the code is unknown.
+//
+// Shortcut for core/router#StatusText.
+var StatusText = router.StatusText
+
 // HTTP Methods copied from `net/http`.
 const (
 	MethodGet     = "GET"