Chore: improve code architecture

hub/route/configs.go

@@ -0,0 +1,69 @@
+package route
+
+import (
+	"net/http"
+
+	"github.com/Dreamacro/clash/hub/executor"
+	"github.com/Dreamacro/clash/log"
+	T "github.com/Dreamacro/clash/tunnel"
+	P "github.com/Dreamacro/clash/proxy"
+
+	"github.com/go-chi/chi"
+	"github.com/go-chi/render"
+)
+
+func configRouter() http.Handler {
+	r := chi.NewRouter()
+	r.Get("/", getConfigs)
+	return r
+}
+
+type configSchema struct {
+	Port      *int          `json:"port"`
+	SocksPort *int          `json:"socket-port"`
+	RedirPort *int          `json:"redir-port"`
+	AllowLan  *bool         `json:"allow-lan"`
+	Mode      *T.Mode       `json:"mode"`
+	LogLevel  *log.LogLevel `json:"log-level"`
+}
+
+func getConfigs(w http.ResponseWriter, r *http.Request) {
+	general := executor.GetGeneral()
+	render.Respond(w, r, general)
+}
+
+func pointerOrDefault (p *int, def int) int {
+	if p != nil {
+		return *p
+	}
+
+	return def
+}
+
+func updateConfigs(w http.ResponseWriter, r *http.Request) {
+	general := &configSchema{}
+	if err := render.DecodeJSON(r.Body, general); err != nil {
+		w.WriteHeader(http.StatusBadRequest)
+		render.Respond(w, r, ErrBadRequest)
+		return
+	}
+
+	if general.AllowLan != nil {
+		P.SetAllowLan(*general.AllowLan)
+	}
+	
+	ports := P.GetPorts()
+	P.ReCreateHTTP(pointerOrDefault(general.Port, ports.Port))
+	P.ReCreateSocks(pointerOrDefault(general.SocksPort, ports.SocksPort))
+	P.ReCreateRedir(pointerOrDefault(general.RedirPort, ports.RedirPort))
+
+	if general.Mode != nil {
+		T.Instance().SetMode(*general.Mode)
+	}
+
+	if general.LogLevel != nil {
+		log.SetLevel(*general.LogLevel)
+	}
+
+	w.WriteHeader(http.StatusNoContent)
+}

hub/route/ctxkeys.go

@@ -0,0 +1,12 @@
+package route
+
+var (
+	CtxKeyProxyName = contextKey("proxy name")
+	CtxKeyProxy     = contextKey("proxy")
+)
+
+type contextKey string
+
+func (c contextKey) String() string {
+	return "clash context key " + string(c)
+}

hub/route/errors.go

@@ -0,0 +1,22 @@
+package route
+
+var (
+	ErrUnauthorized   = newError("Unauthorized")
+	ErrBadRequest     = newError("Body invalid")
+	ErrForbidden      = newError("Forbidden")
+	ErrNotFound       = newError("Resource not found")
+	ErrRequestTimeout = newError("Timeout")
+)
+
+// HTTPError is custom HTTP error for API
+type HTTPError struct {
+	Message string `json:"message"`
+}
+
+func (e *HTTPError) Error() string {
+	return e.Message
+}
+
+func newError(msg string) *HTTPError {
+	return &HTTPError{Message: msg}
+}

hub/route/proxies.go

@@ -0,0 +1,137 @@
+package route
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/url"
+	"strconv"
+	"time"
+
+	A "github.com/Dreamacro/clash/adapters/outbound"
+	C "github.com/Dreamacro/clash/constant"
+	T "github.com/Dreamacro/clash/tunnel"
+
+	"github.com/go-chi/chi"
+	"github.com/go-chi/render"
+)
+
+func proxyRouter() http.Handler {
+	r := chi.NewRouter()
+	r.Get("/", getProxies)
+
+	r.Route("/{name}", func(r chi.Router) {
+		r.Use(parseProxyName, findProxyByName)
+		r.Get("/", getProxy)
+		r.Get("/delay", getProxyDelay)
+		r.Put("/", updateProxy)
+	})
+	return r
+}
+
+// When name is composed of a partial escape string, Golang does not unescape it
+func parseProxyName(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		name := chi.URLParam(r, "name")
+		if newName, err := url.PathUnescape(name); err == nil {
+			name = newName
+		}
+		ctx := context.WithValue(r.Context(), CtxKeyProxyName, name)
+		next.ServeHTTP(w, r.WithContext(ctx))
+	})
+}
+
+func findProxyByName(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		name := r.Context().Value(CtxKeyProxyName).(string)
+		proxies := T.Instance().Proxies()
+		proxy, exist := proxies[name]
+		if !exist {
+			w.WriteHeader(http.StatusNotFound)
+			render.Respond(w, r, ErrNotFound)
+			return
+		}
+
+		ctx := context.WithValue(r.Context(), CtxKeyProxy, proxy)
+		next.ServeHTTP(w, r.WithContext(ctx))
+	})
+}
+
+func getProxies(w http.ResponseWriter, r *http.Request) {
+	proxies := T.Instance().Proxies()
+	render.Respond(w, r, map[string]map[string]C.Proxy{
+		"proxies": proxies,
+	})
+}
+
+func getProxy(w http.ResponseWriter, r *http.Request) {
+	proxy := r.Context().Value(CtxKeyProxy).(C.Proxy)
+	render.Respond(w, r, proxy)
+}
+
+type UpdateProxyRequest struct {
+	Name string `json:"name"`
+}
+
+func updateProxy(w http.ResponseWriter, r *http.Request) {
+	req := UpdateProxyRequest{}
+	if err := render.DecodeJSON(r.Body, &req); err != nil {
+		w.WriteHeader(http.StatusBadRequest)
+		render.Respond(w, r, ErrBadRequest)
+		return
+	}
+
+	proxy := r.Context().Value(CtxKeyProxy).(C.Proxy)
+
+	selector, ok := proxy.(*A.Selector)
+	if !ok {
+		w.WriteHeader(http.StatusBadRequest)
+		render.Respond(w, r, ErrBadRequest)
+		return
+	}
+
+	if err := selector.Set(req.Name); err != nil {
+		w.WriteHeader(http.StatusBadRequest)
+		render.Respond(w, r, newError(fmt.Sprintf("Selector update error: %s", err.Error())))
+		return
+	}
+
+	w.WriteHeader(http.StatusNoContent)
+}
+
+func getProxyDelay(w http.ResponseWriter, r *http.Request) {
+	query := r.URL.Query()
+	url := query.Get("url")
+	timeout, err := strconv.ParseInt(query.Get("timeout"), 10, 16)
+	if err != nil {
+		w.WriteHeader(http.StatusBadRequest)
+		render.Respond(w, r, ErrBadRequest)
+		return
+	}
+
+	proxy := r.Context().Value(CtxKeyProxy).(C.Proxy)
+
+	sigCh := make(chan int16)
+	go func() {
+		t, err := A.DelayTest(proxy, url)
+		if err != nil {
+			sigCh <- 0
+		}
+		sigCh <- t
+	}()
+
+	select {
+	case <-time.After(time.Millisecond * time.Duration(timeout)):
+		w.WriteHeader(http.StatusRequestTimeout)
+		render.Respond(w, r, ErrRequestTimeout)
+	case t := <-sigCh:
+		if t == 0 {
+			w.WriteHeader(http.StatusServiceUnavailable)
+			render.Respond(w, r, newError("An error occurred in the delay test"))
+		} else {
+			render.Respond(w, r, map[string]int16{
+				"delay": t,
+			})
+		}
+	}
+}

hub/route/rules.go

@@ -0,0 +1,40 @@
+package route
+
+import (
+	"net/http"
+
+	T "github.com/Dreamacro/clash/tunnel"
+
+	"github.com/go-chi/chi"
+	"github.com/go-chi/render"
+)
+
+func ruleRouter() http.Handler {
+	r := chi.NewRouter()
+	r.Get("/", getRules)
+	return r
+}
+
+type Rule struct {
+	Type    string `json:"type"`
+	Payload string `json:"payload"`
+	Proxy   string `json:"proxy"`
+}
+
+func getRules(w http.ResponseWriter, r *http.Request) {
+	rawRules := T.Instance().Rules()
+
+	var rules []Rule
+	for _, rule := range rawRules {
+		rules = append(rules, Rule{
+			Type:    rule.RuleType().String(),
+			Payload: rule.Payload(),
+			Proxy:   rule.Adapter(),
+		})
+	}
+
+	w.WriteHeader(http.StatusOK)
+	render.Respond(w, r, map[string][]Rule{
+		"rules": rules,
+	})
+}

hub/route/server.go

@@ -0,0 +1,140 @@
+package route
+
+import (
+	"encoding/json"
+	"net/http"
+	"strings"
+	"time"
+
+	"github.com/Dreamacro/clash/log"
+	T "github.com/Dreamacro/clash/tunnel"
+
+	"github.com/go-chi/chi"
+	"github.com/go-chi/cors"
+	"github.com/go-chi/render"
+)
+
+var (
+	serverSecret = ""
+	serverAddr   = ""
+)
+
+type Traffic struct {
+	Up   int64 `json:"up"`
+	Down int64 `json:"down"`
+}
+
+func Start(addr string, secret string) {
+	if serverAddr != "" {
+		return
+	}
+
+	serverAddr = addr
+	serverSecret = secret
+
+	r := chi.NewRouter()
+
+	cors := cors.New(cors.Options{
+		AllowedOrigins: []string{"*"},
+		AllowedMethods: []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
+		AllowedHeaders: []string{"Content-Type", "Authorization"},
+		MaxAge:         300,
+	})
+
+	r.Use(cors.Handler, authentication)
+
+	r.With(jsonContentType).Get("/traffic", traffic)
+	r.With(jsonContentType).Get("/logs", getLogs)
+	r.Mount("/configs", configRouter())
+	r.Mount("/proxies", proxyRouter())
+	// r.Mount("/rules", ruleRouter())
+
+	log.Infoln("RESTful API listening at: %s", addr)
+	err := http.ListenAndServe(addr, r)
+	if err != nil {
+		log.Errorln("External controller error: %s", err.Error())
+	}
+}
+
+func jsonContentType(next http.Handler) http.Handler {
+	fn := func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "application/json")
+		next.ServeHTTP(w, r)
+	}
+	return http.HandlerFunc(fn)
+}
+
+func authentication(next http.Handler) http.Handler {
+	fn := func(w http.ResponseWriter, r *http.Request) {
+		header := r.Header.Get("Authorization")
+		text := strings.SplitN(header, " ", 2)
+
+		if serverSecret == "" {
+			next.ServeHTTP(w, r)
+			return
+		}
+
+		hasUnvalidHeader := text[0] != "Bearer"
+		hasUnvalidSecret := len(text) == 2 && text[1] != serverSecret
+		if hasUnvalidHeader || hasUnvalidSecret {
+			w.WriteHeader(http.StatusUnauthorized)
+			render.Respond(w, r, ErrUnauthorized)
+			return
+		}
+		next.ServeHTTP(w, r)
+	}
+	return http.HandlerFunc(fn)
+}
+
+func traffic(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+
+	tick := time.NewTicker(time.Second)
+	t := T.Instance().Traffic()
+	for range tick.C {
+		up, down := t.Now()
+		if err := json.NewEncoder(w).Encode(Traffic{
+			Up:   up,
+			Down: down,
+		}); err != nil {
+			break
+		}
+		w.(http.Flusher).Flush()
+	}
+}
+
+type Log struct {
+	Type    string `json:"type"`
+	Payload string `json:"payload"`
+}
+
+func getLogs(w http.ResponseWriter, r *http.Request) {
+	levelText := r.URL.Query().Get("level")
+	if levelText == "" {
+		levelText = "info"
+	}
+
+	level, ok := log.LogLevelMapping[levelText]
+	if !ok {
+		w.WriteHeader(http.StatusBadRequest)
+		render.Respond(w, r, ErrBadRequest)
+		return
+	}
+
+	sub := log.Subscribe()
+	render.Status(r, http.StatusOK)
+	for elm := range sub {
+		log := elm.(*log.Event)
+		if log.LogLevel < level {
+			continue
+		}
+
+		if err := json.NewEncoder(w).Encode(Log{
+			Type:    log.Type(),
+			Payload: log.Payload,
+		}); err != nil {
+			break
+		}
+		w.(http.Flusher).Flush()
+	}
+}