mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-29 05:56:38 +08:00
ryan
aa4faddade
Result: {"status":"keep","total_issues":8,"golint_canonicalheader":0,"golint_errname":0,"golint_errorlint":1,"golint_exhaustive":0,"golint_forcetypeassert":0,"golint_gosec":0,"golint_intrange":0,"golint_modernize":3,"golint_nilnil":3,"golint_perfsprint":0,"golint_prealloc":0,"golint_recvcheck":1,"golint_usestdlibvars":0,"golint_wastedassign":0,"golint_total":8,"golint_test_testifylint":0,"golint_test_thelper":0,"golint_test_usetesting":0,"golint_test_total":0,"golint_vetx_total":0,"eslint_problems":0,"eslint_errors":0,"eslint_warnings":0,"tsc_errors":0,"vitest_failed":0,"vitest_total":116,"measure_s":81}
291 lines
11 KiB
Go
291 lines
11 KiB
Go
// Copyright 2026 Arctel.net
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package openresty
|
|
|
|
import (
|
|
"fmt"
|
|
"strconv"
|
|
"strings"
|
|
)
|
|
|
|
const (
|
|
// OriginErrorPageSupportPath is the SupportFile path for the origin error HTML template.
|
|
OriginErrorPageSupportPath = "error_pages/origin_error.html.tmpl"
|
|
|
|
// OriginErrorPageInternalLocation is the named nginx location that serves the error body.
|
|
// OriginErrorPageInternalLocation is the named nginx location that serves the error body
|
|
// for the all-methods mode (get_only disabled). Must be a NAMED location (@...), not a
|
|
// URI internal redirect: error_page URI redirects rewrite the request method to GET, so a
|
|
// method check inside the location could never distinguish POST/PUT. Named locations keep
|
|
// the original method and (without the `=` form) the original error status.
|
|
//
|
|
// When get_only is enabled this location is NOT emitted: GET-only mode replaces the body
|
|
// via Lua header/body filters inside the proxy location, so non-GET responses pass through
|
|
// with their original status and body.
|
|
OriginErrorPageInternalLocation = "@__openflare_origin_error"
|
|
defaultOriginErrorPageStatusTag = "500-599"
|
|
)
|
|
|
|
// DefaultOriginErrorPageHTML is the built-in default (aligned with frontend minimalist).
|
|
// Placeholders {{status}} and {{host}} are substituted at request time by Lua.
|
|
const DefaultOriginErrorPageHTML = `<!DOCTYPE html>
|
|
<html lang="zh-CN">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>{{status}} | OpenFlare</title>
|
|
<style>
|
|
* { box-sizing: border-box; margin: 0; padding: 0; }
|
|
body {
|
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
|
|
background-color: #ffffff;
|
|
color: #333333;
|
|
height: 100vh;
|
|
display: flex;
|
|
flex-direction: column;
|
|
justify-content: center;
|
|
align-items: center;
|
|
text-align: center;
|
|
padding: 48px 24px;
|
|
-webkit-font-smoothing: antialiased;
|
|
}
|
|
.container {
|
|
max-width: 600px;
|
|
width: 100%;
|
|
display: flex;
|
|
flex-direction: column;
|
|
align-items: center;
|
|
gap: 24px;
|
|
}
|
|
.error-code {
|
|
font-size: 48px;
|
|
font-weight: 700;
|
|
color: #333333;
|
|
line-height: 1.2;
|
|
letter-spacing: -0.02em;
|
|
}
|
|
.error-description {
|
|
font-size: 20px;
|
|
line-height: 1.6;
|
|
color: #666666;
|
|
max-width: 480px;
|
|
}
|
|
.host {
|
|
font-size: 14px;
|
|
color: #999999;
|
|
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;
|
|
word-break: break-all;
|
|
}
|
|
.footer {
|
|
margin-top: 48px;
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: center;
|
|
gap: 8px;
|
|
color: #999999;
|
|
font-size: 14px;
|
|
font-weight: 500;
|
|
}
|
|
.brand-icon { width: 24px; height: 24px; fill: currentColor; display: block; }
|
|
@media (max-width: 480px) {
|
|
.error-code { font-size: 36px; }
|
|
.error-description { font-size: 18px; }
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="container">
|
|
<h1 class="error-code" aria-label="HTTP status">{{status}}</h1>
|
|
<p class="error-description">
|
|
The upstream server is unreachable. Please try again later or contact the site administrator if the problem persists.
|
|
</p>
|
|
<p class="host">{{host}}</p>
|
|
<div class="footer">
|
|
<svg class="brand-icon" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
|
|
<path d="M13 2L3 14H12L11 22L21 10H12L13 2Z" />
|
|
</svg>
|
|
<span>OpenFlare</span>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
`
|
|
|
|
// EffectiveOriginErrorPageHTML returns custom HTML when set, otherwise the built-in default.
|
|
func EffectiveOriginErrorPageHTML(cfg ConfigSnapshot) string {
|
|
if strings.TrimSpace(cfg.OriginErrorPageHTML) == "" {
|
|
return DefaultOriginErrorPageHTML
|
|
}
|
|
return cfg.OriginErrorPageHTML
|
|
}
|
|
|
|
func effectiveOriginErrorPageStatusTags(cfg ConfigSnapshot) []string {
|
|
if len(cfg.OriginErrorPageStatusCodes) == 0 {
|
|
return []string{defaultOriginErrorPageStatusTag}
|
|
}
|
|
return cfg.OriginErrorPageStatusCodes
|
|
}
|
|
|
|
func originErrorPageSupportFile(cfg ConfigSnapshot) SupportFile {
|
|
return SupportFile{
|
|
Path: OriginErrorPageSupportPath,
|
|
Content: EffectiveOriginErrorPageHTML(cfg),
|
|
}
|
|
}
|
|
|
|
func renderOriginErrorPageIntercept(cfg ConfigSnapshot) string {
|
|
if !cfg.OriginErrorPageEnabled {
|
|
return ""
|
|
}
|
|
codes, err := ExpandStatusCodeTags(effectiveOriginErrorPageStatusTags(cfg))
|
|
if err != nil || len(codes) == 0 {
|
|
return ""
|
|
}
|
|
if cfg.OriginErrorPageGetOnly {
|
|
// GET-only mode must NOT use proxy_intercept_errors: interception discards
|
|
// the upstream error body, so non-GET requests could never receive the
|
|
// original response (nginx would serve its own default error page instead).
|
|
// The body is replaced by Lua header/body filters that only fire for GET;
|
|
// non-GET responses pass through with status, headers and body untouched.
|
|
return renderOriginErrorPageLuaFilterBlock(codes)
|
|
}
|
|
// Intercept at the proxy level for all methods. nginx does not allow
|
|
// proxy_intercept_errors inside limit_except (only allow/deny are valid
|
|
// there), so the custom HTML is served by the named error location.
|
|
return " proxy_intercept_errors on;\n"
|
|
}
|
|
|
|
// renderOriginErrorPageLuaFilterBlock emits the GET-only body replacement inside the
|
|
// proxy location. header_filter decides whether the response should be replaced and
|
|
// reads the template once into ngx.ctx; body_filter swaps the upstream body for the
|
|
// custom HTML and forces end-of-body so remaining upstream chunks are discarded.
|
|
// Non-GET requests (or statuses outside the configured set) are never touched.
|
|
func renderOriginErrorPageLuaFilterBlock(codes []int) string {
|
|
codeList := make([]string, len(codes))
|
|
for i, code := range codes {
|
|
codeList[i] = strconv.Itoa(code)
|
|
}
|
|
return fmt.Sprintf(` header_filter_by_lua_block {
|
|
local codes = {%s}
|
|
local function match(code)
|
|
for _, c in ipairs(codes) do
|
|
if c == code then
|
|
return true
|
|
end
|
|
end
|
|
return false
|
|
end
|
|
local status = ngx.status
|
|
if match(status) and ngx.req.get_method() == "GET" then
|
|
ngx.header.content_length = nil
|
|
ngx.header["Content-Type"] = "text/html; charset=utf-8"
|
|
local f = io.open("%s", "r")
|
|
local body = f and f:read("*a")
|
|
if f then
|
|
f:close()
|
|
end
|
|
if not body then
|
|
body = "<!DOCTYPE html><html><head><meta charset=\"utf-8\"><title>" .. tostring(status) .. "</title></head><body><h1>" .. tostring(status) .. "</h1></body></html>"
|
|
end
|
|
body = body:gsub("{{status}}", function() return tostring(status) end)
|
|
body = body:gsub("{{host}}", function() return ngx.var.host or "" end)
|
|
ngx.ctx.openflare_error_html = body
|
|
end
|
|
}
|
|
body_filter_by_lua_block {
|
|
local html = ngx.ctx.openflare_error_html
|
|
if html then
|
|
ngx.arg[1] = html
|
|
ngx.arg[2] = true
|
|
ngx.ctx.openflare_error_html = nil
|
|
end
|
|
}
|
|
`, strings.Join(codeList, ", "), ErrorPageTmplPlaceholder)
|
|
}
|
|
|
|
// renderOriginErrorPageServerBits emits server-level error_page + named error location
|
|
// for the all-methods mode. Returns empty string when disabled, expand fails, no codes
|
|
// remain, or get_only is enabled (GET-only mode replaces the body via Lua filters inside
|
|
// the proxy location, see renderOriginErrorPageIntercept).
|
|
//
|
|
// IMPORTANT: do NOT use `error_page CODE = @name` (equals without response code).
|
|
// That form adopts the status returned by the error URI; content_by_lua defaults
|
|
// to 200 and ngx.status is often 0, so clients saw 200 with body "{{status}}"→"0".
|
|
// Without `=`, nginx keeps the original error status for the redirect.
|
|
func renderOriginErrorPageServerBits(cfg ConfigSnapshot) string {
|
|
if !cfg.OriginErrorPageEnabled || cfg.OriginErrorPageGetOnly {
|
|
return ""
|
|
}
|
|
codes, err := ExpandStatusCodeTags(effectiveOriginErrorPageStatusTags(cfg))
|
|
if err != nil || len(codes) == 0 {
|
|
return ""
|
|
}
|
|
parts := make([]string, len(codes))
|
|
for i, code := range codes {
|
|
parts[i] = strconv.Itoa(code)
|
|
}
|
|
var builder strings.Builder
|
|
// No `=` — preserve original error status (502 stays 502).
|
|
fmt.Fprintf(&builder, " error_page %s %s;\n", strings.Join(parts, " "), OriginErrorPageInternalLocation)
|
|
builder.WriteString(renderOriginErrorPageInternalLocation())
|
|
return builder.String()
|
|
}
|
|
|
|
func renderOriginErrorPageInternalLocation() string {
|
|
// Resolve status from $status (set by error_page redirect), then
|
|
// upstream_status, then ngx.status. Force ngx.status so the client receives
|
|
// the real error code. Use function replacers so host/status with `%` are safe.
|
|
//
|
|
// Note: fmt.Sprintf is used only for the path placeholders; Lua `%` must be
|
|
// written as `%%` so Sprintf does not treat them as format verbs.
|
|
//
|
|
// The location is NAMED (@...), not a URI internal redirect: URI redirects
|
|
// (location = /uri) rewrite the request method to GET. Named locations keep
|
|
// the original method and (without `=`) the original error status.
|
|
return fmt.Sprintf(` location %s {
|
|
default_type text/html;
|
|
charset utf-8;
|
|
content_by_lua_block {
|
|
local function resolve_error_status()
|
|
local code = tonumber(ngx.var.status)
|
|
if code and code >= 400 then
|
|
return code
|
|
end
|
|
local upstream = ngx.var.upstream_status or ""
|
|
-- multi-upstream: "502, 502" or failed connect "0"
|
|
local first = upstream:match("(%%d+)")
|
|
code = tonumber(first)
|
|
if code and code >= 400 then
|
|
return code
|
|
end
|
|
code = tonumber(ngx.status)
|
|
if code and code >= 400 then
|
|
return code
|
|
end
|
|
return 502
|
|
end
|
|
|
|
local code = resolve_error_status()
|
|
ngx.status = code
|
|
|
|
local f = io.open("%s", "r")
|
|
if not f then
|
|
ngx.header["Content-Type"] = "text/html; charset=utf-8"
|
|
ngx.say("Error ", tostring(code))
|
|
return
|
|
end
|
|
local body = f:read("*a")
|
|
f:close()
|
|
local status = tostring(code)
|
|
local host = ngx.var.host or ""
|
|
-- function replacer: plain insert, no percent pattern side effects
|
|
body = body:gsub("{{status}}", function() return status end)
|
|
body = body:gsub("{{host}}", function() return host end)
|
|
ngx.header["Content-Type"] = "text/html; charset=utf-8"
|
|
ngx.say(body)
|
|
}
|
|
}
|
|
`, OriginErrorPageInternalLocation, ErrorPageTmplPlaceholder)
|
|
}
|