From 54367746a3cfeb0f22d48c05e27ad2b859839210 Mon Sep 17 00:00:00 2001
From: Mohammed Al Sahaf <msaa1990@gmail.com>
Date: Sat, 15 Jun 2024 14:08:27 +0300
Subject: [PATCH] move modules around
Signed-off-by: Mohammed Al Sahaf <msaa1990@gmail.com>
---
modules/standard/proxy.go | 126 ++++++++++++++++++++++++++++++++++++++
network.go | 118 -----------------------------------
2 files changed, 126 insertions(+), 118 deletions(-)
create mode 100644 modules/standard/proxy.go
diff --git a/modules/standard/proxy.go b/modules/standard/proxy.go
new file mode 100644
index 000000000..d3ada40ea
--- /dev/null
+++ b/modules/standard/proxy.go
@@ -0,0 +1,126 @@
+package standard
+
+import (
+ "errors"
+ "net/http"
+ "net/url"
+ "strings"
+
+ "go.uber.org/zap"
+
+ "github.com/caddyserver/caddy/v2"
+)
+
+func init() {
+ caddy.RegisterModule(ProxyFromEnvironment{})
+ caddy.RegisterModule(ProxyFromURL{})
+}
+
+type ProxyFromEnvironment struct{}
+
+// ProxyFunc implements ProxyFuncProducer.
+func (p ProxyFromEnvironment) ProxyFunc() func(*http.Request) (*url.URL, error) {
+ return http.ProxyFromEnvironment
+}
+
+// CaddyModule implements Module.
+func (p ProxyFromEnvironment) CaddyModule() caddy.ModuleInfo {
+ return caddy.ModuleInfo{
+ ID: "caddy.network_proxy.source.environment",
+ New: func() caddy.Module {
+ return ProxyFromEnvironment{}
+ },
+ }
+}
+
+type ProxyFromURL struct {
+ URL string `json:"url"`
+
+ ctx caddy.Context
+ logger *zap.Logger
+}
+
+// CaddyModule implements Module.
+func (p ProxyFromURL) CaddyModule() caddy.ModuleInfo {
+ return caddy.ModuleInfo{
+ ID: "caddy.network_proxy.source.url",
+ New: func() caddy.Module {
+ return &ProxyFromURL{}
+ },
+ }
+}
+
+func (p *ProxyFromURL) Provision(ctx caddy.Context) error {
+ p.ctx = ctx
+ p.logger = ctx.Logger()
+ return nil
+}
+
+// Validate implements Validator.
+func (p ProxyFromURL) Validate() error {
+ if _, err := url.Parse(p.URL); err != nil {
+ return err
+ }
+ return nil
+}
+
+// ProxyFunc implements ProxyFuncProducer.
+func (p ProxyFromURL) ProxyFunc() func(*http.Request) (*url.URL, error) {
+ if strings.Contains(p.URL, "{") && strings.Contains(p.URL, "}") {
+ // courtesy of @ImpostorKeanu: https://github.com/caddyserver/caddy/pull/6397
+ return func(r *http.Request) (*url.URL, error) {
+ // retrieve the replacer from context.
+ repl, ok := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
+ if !ok {
+ err := errors.New("failed to obtain replacer from request")
+ p.logger.Error(err.Error())
+ return nil, err
+ }
+
+ // apply placeholders to the value
+ // note: h.ForwardProxyURL should never be empty at this point
+ s := repl.ReplaceAll(p.URL, "")
+ if s == "" {
+ p.logger.Error("forward_proxy_url was empty after applying placeholders",
+ zap.String("initial_value", p.URL),
+ zap.String("final_value", s),
+ zap.String("hint", "check for invalid placeholders"))
+ return nil, errors.New("empty value for forward_proxy_url")
+ }
+
+ // parse the url
+ pUrl, err := url.Parse(s)
+ if err != nil {
+ p.logger.Warn("failed to derive transport proxy from forward_proxy_url")
+ pUrl = nil
+ } else if pUrl.Host == "" || strings.Split("", pUrl.Host)[0] == ":" {
+ // url.Parse does not return an error on these values:
+ //
+ // - http://:80
+ // - pUrl.Host == ":80"
+ // - /some/path
+ // - pUrl.Host == ""
+ //
+ // Super edge cases, but humans are human.
+ err = errors.New("supplied forward_proxy_url is missing a host value")
+ pUrl = nil
+ } else {
+ p.logger.Debug("setting transport proxy url", zap.String("url", s))
+ }
+
+ return pUrl, err
+ }
+ }
+ return func(*http.Request) (*url.URL, error) {
+ return url.Parse(p.URL)
+ }
+}
+
+var (
+ _ caddy.Module = ProxyFromEnvironment{}
+ _ caddy.ProxyFuncProducer = ProxyFromEnvironment{}
+ _ caddy.Module = ProxyFromURL{}
+ _ caddy.Provisioner = &ProxyFromURL{}
+ _ caddy.Validator = ProxyFromURL{}
+ _ caddy.ProxyFuncProducer = ProxyFromURL{}
+)
diff --git a/network.go b/network.go
index 72c612762..c7f65ecbe 100644
--- a/network.go
+++ b/network.go
@@ -1,128 +1,10 @@
package caddy
import (
- "errors"
"net/http"
"net/url"
- "strings"
-
- "go.uber.org/zap"
)
-func init() {
- RegisterModule(ProxyFromEnvironment{})
- RegisterModule(ProxyFromURL{})
-}
-
type ProxyFuncProducer interface {
ProxyFunc() func(*http.Request) (*url.URL, error)
}
-
-type ProxyFromEnvironment struct{}
-
-// ProxyFunc implements ProxyFuncProducer.
-func (p ProxyFromEnvironment) ProxyFunc() func(*http.Request) (*url.URL, error) {
- return http.ProxyFromEnvironment
-}
-
-// CaddyModule implements Module.
-func (p ProxyFromEnvironment) CaddyModule() ModuleInfo {
- return ModuleInfo{
- ID: "caddy.network_proxy.source.environment",
- New: func() Module {
- return ProxyFromEnvironment{}
- },
- }
-}
-
-type ProxyFromURL struct {
- URL string `json:"url"`
-
- ctx Context
- logger *zap.Logger
-}
-
-// CaddyModule implements Module.
-func (p ProxyFromURL) CaddyModule() ModuleInfo {
- return ModuleInfo{
- ID: "caddy.network_proxy.source.url",
- New: func() Module {
- return &ProxyFromURL{}
- },
- }
-}
-
-func (p *ProxyFromURL) Provision(ctx Context) error {
- p.ctx = ctx
- p.logger = ctx.Logger()
- return nil
-}
-
-// Validate implements Validator.
-func (p ProxyFromURL) Validate() error {
- if _, err := url.Parse(p.URL); err != nil {
- return err
- }
- return nil
-}
-
-// ProxyFunc implements ProxyFuncProducer.
-func (p ProxyFromURL) ProxyFunc() func(*http.Request) (*url.URL, error) {
- if strings.Contains(p.URL, "{") && strings.Contains(p.URL, "}") {
- // courtesy of @ImpostorKeanu: https://github.com/caddyserver/caddy/pull/6397
- return func(r *http.Request) (*url.URL, error) {
- // retrieve the replacer from context.
- repl, ok := r.Context().Value(ReplacerCtxKey).(*Replacer)
- if !ok {
- err := errors.New("failed to obtain replacer from request")
- p.logger.Error(err.Error())
- return nil, err
- }
-
- // apply placeholders to the value
- // note: h.ForwardProxyURL should never be empty at this point
- s := repl.ReplaceAll(p.URL, "")
- if s == "" {
- p.logger.Error("forward_proxy_url was empty after applying placeholders",
- zap.String("initial_value", p.URL),
- zap.String("final_value", s),
- zap.String("hint", "check for invalid placeholders"))
- return nil, errors.New("empty value for forward_proxy_url")
- }
-
- // parse the url
- pUrl, err := url.Parse(s)
- if err != nil {
- p.logger.Warn("failed to derive transport proxy from forward_proxy_url")
- pUrl = nil
- } else if pUrl.Host == "" || strings.Split("", pUrl.Host)[0] == ":" {
- // url.Parse does not return an error on these values:
- //
- // - http://:80
- // - pUrl.Host == ":80"
- // - /some/path
- // - pUrl.Host == ""
- //
- // Super edge cases, but humans are human.
- err = errors.New("supplied forward_proxy_url is missing a host value")
- pUrl = nil
- } else {
- p.logger.Debug("setting transport proxy url", zap.String("url", s))
- }
-
- return pUrl, err
- }
- }
- return func(*http.Request) (*url.URL, error) {
- return url.Parse(p.URL)
- }
-}
-
-var (
- _ Module = ProxyFromEnvironment{}
- _ ProxyFuncProducer = ProxyFromEnvironment{}
- _ Module = ProxyFromURL{}
- _ Provisioner = &ProxyFromURL{}
- _ Validator = ProxyFromURL{}
- _ ProxyFuncProducer = ProxyFromURL{}
-)