From 6ced549deaecb42b9bb93ea9efcb4c1bbaabe8a4 Mon Sep 17 00:00:00 2001 From: mhsanaei Date: Sat, 20 Sep 2025 09:35:50 +0200 Subject: docs: add comments for all functions --- web/network/auto_https_conn.go | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'web/network/auto_https_conn.go') diff --git a/web/network/auto_https_conn.go b/web/network/auto_https_conn.go index d1a9d521..aa0e9dea 100644 --- a/web/network/auto_https_conn.go +++ b/web/network/auto_https_conn.go @@ -1,3 +1,5 @@ +// Package network provides network utilities for the 3x-ui web panel, +// including automatic HTTP to HTTPS redirection functionality. package network import ( @@ -9,6 +11,9 @@ import ( "sync" ) +// AutoHttpsConn wraps a net.Conn to provide automatic HTTP to HTTPS redirection. +// It intercepts the first read to detect HTTP requests and responds with a 307 redirect +// to the HTTPS equivalent URL. Subsequent reads work normally for HTTPS connections. type AutoHttpsConn struct { net.Conn @@ -18,6 +23,8 @@ type AutoHttpsConn struct { readRequestOnce sync.Once } +// NewAutoHttpsConn creates a new AutoHttpsConn that wraps the given connection. +// It enables automatic redirection of HTTP requests to HTTPS. func NewAutoHttpsConn(conn net.Conn) net.Conn { return &AutoHttpsConn{ Conn: conn, @@ -49,6 +56,9 @@ func (c *AutoHttpsConn) readRequest() bool { return true } +// Read implements the net.Conn Read method with automatic HTTPS redirection. +// On the first read, it checks if the request is HTTP and redirects to HTTPS if so. +// Subsequent reads work normally. func (c *AutoHttpsConn) Read(buf []byte) (int, error) { c.readRequestOnce.Do(func() { c.readRequest() -- cgit v1.2.3