http: add user agent handling for HTTP requests (#534)

Author: bytemain

internal/base/interfaces.go

@@ -240,6 +240,10 @@ type RuntimeInfo struct {
 	PluginDirPath string `json:"pluginDirPath"`
 }
 
+type Navigator struct {
+	UserAgent string `json:"userAgent"`
+}
+
 type Package struct {
 	Main      *Info
 	Additions []*Info

internal/base/world.go

@@ -20,8 +20,9 @@ var (
 )
 
 const (
-	PluginObjKey = "PLUGIN"
-	OsType       = "OS_TYPE"
-	ArchType     = "ARCH_TYPE"
-	Runtime      = "RUNTIME"
+	PluginObjKey    = "PLUGIN"
+	NavigatorObjKey = "VFOX_NAVIGATOR"
+	OsType          = "OS_TYPE"
+	ArchType        = "ARCH_TYPE"
+	Runtime         = "RUNTIME"
 )

internal/plugin/luai/decode.go internal/plugin/luai/codec/decode.gointernal/plugin/luai/decode.go renamed to internal/plugin/luai/codec/decode.go

@@ -14,7 +14,7 @@
  *    limitations under the License.
  */
 
-package luai
+package codec
 
 import (
 	"errors"

internal/plugin/luai/encode.go internal/plugin/luai/codec/encode.gointernal/plugin/luai/encode.go renamed to internal/plugin/luai/codec/encode.go

@@ -14,7 +14,7 @@
  *    limitations under the License.
  */
 
-package luai
+package codec
 
 import (
 	"errors"
@@ -209,3 +209,11 @@ func Marshal(state *lua.LState, v any) (lua.LValue, error) {
 	}
 
 }
+
+func MustMarshal(state *lua.LState, v interface{}) lua.LValue {
+	value, err := Marshal(state, v)
+	if err != nil {
+		panic(err)
+	}
+	return value
+}

internal/plugin/luai/context.go

@@ -0,0 +1,62 @@
+/*
+ *    Copyright 2025 Han Li and contributors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+package luai
+
+import (
+	"fmt"
+	"strings"
+)
+
+// computeUserAgent constructs a user agent string for the vfox runtime and plugin.
+// 
+// Parameters:
+//   - runtimeVersion: the version of the vfox runtime (may be empty).
+//   - pluginName: the name of the plugin (will be prefixed with "vfox-" if not already).
+//   - pluginVersion: the version of the plugin (may be empty).
+//
+// Returns:
+//   A user agent string in the format "vfox/<runtimeVersion> vfox-<pluginName>/<pluginVersion>",
+//   omitting version information if not provided, and trimming extra spaces.
+func computeUserAgent(runtimeVersion, pluginName, pluginVersion string) string {
+	components := make([]string, 0, 2)
+	if runtimeVersion != "" {
+		components = append(components, fmt.Sprintf("vfox/%s", runtimeVersion))
+	} else {
+		components = append(components, "vfox")
+	}
+
+	name := ensurePrefix(pluginName)
+	if name != "" {
+		if pluginVersion != "" {
+			components = append(components, fmt.Sprintf("%s/%s", name, pluginVersion))
+		} else {
+			components = append(components, name)
+		}
+	}
+
+	return strings.TrimSpace(strings.Join(components, " "))
+}
+
+func ensurePrefix(name string) string {
+	if name == "" {
+		return ""
+	}
+	if strings.HasPrefix(name, "vfox-") {
+		return name
+	}
+	return "vfox-" + name
+}

internal/plugin/luai/example_test.go

@@ -22,6 +22,7 @@ import (
 	"testing"
 
 	"github.com/version-fox/vfox/internal/logger"
+	"github.com/version-fox/vfox/internal/plugin/luai/codec"
 	lua "github.com/yuin/gopher-lua"
 )
 
@@ -80,7 +81,7 @@ func TestExample(t *testing.T) {
 		}
 
 		table := L.ReturnedValue()
-		err := Unmarshal(table, &output)
+		err := codec.Unmarshal(table, &output)
 		if err != nil {
 			t.Fatalf("unmarshal map failed: %v", err)
 		}
@@ -111,7 +112,7 @@ func TestMarshalGoFunctions2(t *testing.T) {
 		goFunc := func() {
 			called = true
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -132,7 +133,7 @@ func TestMarshalGoFunctions2(t *testing.T) {
 			receivedInt = a
 			receivedString = b
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -153,7 +154,7 @@ func TestMarshalGoFunctions2(t *testing.T) {
 		goFunc := func() (int, string) {
 			return 42, "world"
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -176,7 +177,7 @@ func TestMarshalGoFunctions2(t *testing.T) {
 		goFunc := func(x int, y int) int {
 			return x + y
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -199,7 +200,7 @@ func TestMarshalGoFunctions2(t *testing.T) {
 			}
 			return fmt.Sprintf("%s%d", prefix, sum)
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -222,16 +223,16 @@ func TestMarshalGoFunctions2(t *testing.T) {
 		goFunc := func(s MyStruct) MyStruct {
 			return MyStruct{Name: s.Name + "_processed", Value: s.Value * 2}
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
 		L.Instance.SetGlobal("testFunc", luaFunc)
-		// Marshal the input struct for Lua
+		// codec.Marshal the input struct for Lua
 		inputStruct := MyStruct{Name: "input", Value: 10}
-		luaInput, err := Marshal(L.Instance, inputStruct)
+		luaInput, err := codec.Marshal(L.Instance, inputStruct)
 		if err != nil {
-			t.Fatalf("Failed to marshal input struct: %v", err)
+			t.Fatalf("Failed to codec.marshal input struct: %v", err)
 		}
 		L.Instance.SetGlobal("inputData", luaInput)
 
@@ -243,7 +244,7 @@ func TestMarshalGoFunctions2(t *testing.T) {
 
 		outputDataLua := L.Instance.GetGlobal("outputData")
 		var outputStruct MyStruct
-		if err := Unmarshal(outputDataLua, &outputStruct); err != nil {
+		if err := codec.Unmarshal(outputDataLua, &outputStruct); err != nil {
 			t.Fatalf("Failed to unmarshal output struct: %v", err)
 		}
 
@@ -424,7 +425,7 @@ func TestCases(t *testing.T) {
 			L := lua.NewState()
 			defer L.Close()
 
-			table, err := Marshal(L, tt.in)
+			table, err := codec.Marshal(L, tt.in)
 			if err != nil {
 				t.Fatalf("marshal map failed: %v", err)
 			}
@@ -461,7 +462,7 @@ func TestCases(t *testing.T) {
 				t.Fatalf("%s: unmarshalTest.ptr %#v is not a pointer to a zero value", tt.CaseName, tt.ptr)
 			}
 
-			err = Unmarshal(table, v.Interface())
+			err = codec.Unmarshal(table, v.Interface())
 
 			if err != tt.err {
 				t.Errorf("expected %+v, got %+v", tt.err, err)
@@ -499,7 +500,7 @@ func TestEncodeFunc(t *testing.T) {
 		L := NewLuaVM()
 		defer L.Close()
 
-		table, err := Marshal(L.Instance, testdata)
+		table, err := codec.Marshal(L.Instance, testdata)
 		if err != nil {
 			t.Fatalf("marshal map failed: %v", err)
 		}
@@ -526,7 +527,7 @@ func TestMarshalGoFunctions(t *testing.T) {
 		goFunc := func() {
 			called = true
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -547,7 +548,7 @@ func TestMarshalGoFunctions(t *testing.T) {
 			receivedInt = a
 			receivedString = b
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -568,7 +569,7 @@ func TestMarshalGoFunctions(t *testing.T) {
 		goFunc := func() (int, string) {
 			return 42, "world"
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -591,7 +592,7 @@ func TestMarshalGoFunctions(t *testing.T) {
 		goFunc := func(x int, y int) int {
 			return x + y
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -614,7 +615,7 @@ func TestMarshalGoFunctions(t *testing.T) {
 			}
 			return fmt.Sprintf("%s%d", prefix, sum)
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
@@ -637,16 +638,16 @@ func TestMarshalGoFunctions(t *testing.T) {
 		goFunc := func(s MyStruct) MyStruct {
 			return MyStruct{Name: s.Name + "_processed", Value: s.Value * 2}
 		}
-		luaFunc, err := Marshal(L.Instance, goFunc)
+		luaFunc, err := codec.Marshal(L.Instance, goFunc)
 		if err != nil {
 			t.Fatalf("Marshal failed: %v", err)
 		}
 		L.Instance.SetGlobal("testFunc", luaFunc)
-		// Marshal the input struct for Lua
+		// codec.Marshal the input struct for Lua
 		inputStruct := MyStruct{Name: "input", Value: 10}
-		luaInput, err := Marshal(L.Instance, inputStruct)
+		luaInput, err := codec.Marshal(L.Instance, inputStruct)
 		if err != nil {
-			t.Fatalf("Failed to marshal input struct: %v", err)
+			t.Fatalf("Failed to codec.marshal input struct: %v", err)
 		}
 		L.Instance.SetGlobal("inputData", luaInput)
 
@@ -656,7 +657,7 @@ func TestMarshalGoFunctions(t *testing.T) {
 
 		outputDataLua := L.Instance.GetGlobal("outputData")
 		var outputStruct MyStruct
-		if err := Unmarshal(outputDataLua, &outputStruct); err != nil {
+		if err := codec.Unmarshal(outputDataLua, &outputStruct); err != nil {
 			t.Fatalf("Failed to unmarshal output struct: %v", err)
 		}
 

internal/plugin/luai/module/http/http.go

@@ -25,7 +25,9 @@ import (
 	"path/filepath"
 
 	"github.com/schollz/progressbar/v3"
+	"github.com/version-fox/vfox/internal/base"
 	"github.com/version-fox/vfox/internal/config"
+	"github.com/version-fox/vfox/internal/plugin/luai/codec"
 	lua "github.com/yuin/gopher-lua"
 )
 
@@ -74,6 +76,8 @@ func (m *Module) Get(L *lua.LState) int {
 			})
 		}
 	}
+	m.ensureUserAgent(L, req)
+
 	resp, err := m.client.Do(req)
 	if err != nil {
 		L.Push(lua.LNil)
@@ -125,6 +129,8 @@ func (m *Module) Head(L *lua.LState) int {
 			})
 		}
 	}
+	m.ensureUserAgent(L, req)
+
 	resp, err := m.client.Do(req)
 	if err != nil {
 		L.Push(lua.LNil)
@@ -183,6 +189,7 @@ func (m *Module) DownloadFile(L *lua.LState) int {
 			})
 		}
 	}
+	m.ensureUserAgent(L, req)
 	resp, err := m.client.Do(req)
 	if err != nil {
 		L.Push(lua.LString(err.Error()))
@@ -240,7 +247,7 @@ func (m *Module) luaMap() map[string]lua.LGFunction {
 	}
 }
 
-func NewModule(proxy *config.Proxy) lua.LGFunction {
+func createModule(proxy *config.Proxy) lua.LGFunction {
 	return func(L *lua.LState) int {
 		client := &http.Client{}
 		if proxy.Enable {
@@ -261,3 +268,20 @@ func NewModule(proxy *config.Proxy) lua.LGFunction {
 		return 1
 	}
 }
+
+func (m *Module) ensureUserAgent(L *lua.LState, req *http.Request) {
+	if req.Header.Get("User-Agent") == "" {
+		navigatorValue := L.GetGlobal(base.NavigatorObjKey)
+		if navigatorValue != lua.LNil {
+			var navigator base.Navigator
+			err := codec.Unmarshal(navigatorValue, &navigator)
+			if err == nil {
+				req.Header.Set("User-Agent", navigator.UserAgent)
+			}
+		}
+	}
+}
+
+func Preload(L *lua.LState, proxy *config.Proxy) {
+	L.PreloadModule("http", createModule(proxy))
+}