feat: support system proxy (#513)

.github/workflows/build.yml

@@ -215,7 +215,7 @@ jobs:
           overwrite: true
   build-linux:
     if: ${{ github.event.inputs.platform == 'all' || github.event.inputs.platform == 'linux' }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: [ get-release ]
     steps:
       - uses: actions/checkout@v3
@@ -228,7 +228,9 @@ jobs:
       - run: |
           sudo apt update -y
           # flutter build dependencies
-          sudo apt install -y ninja-build libgtk-3-dev libayatana-appindicator3-1 libayatana-appindicator3-dev
+          sudo apt install -y ninja-build libgtk-3-dev libappindicator3-dev
+          # rpm build dependencies
+          sudo apt install -y rpm patchelf
           # appimage build dependencies
           sudo apt install -y libfuse2 locate
           wget -O appimagetool "https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage"

README.md

@@ -53,11 +53,11 @@ Visit ✈ [Official Website](https://gopeed.com) | 📖 [Official Docs](https://
         </tr>
         <tr>
             <td><code>DEB</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.deb">Link</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux.deb">Link</a></td>
         </tr>
         <tr>
             <td><code>AppImage</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-x86_64.AppImage">Link</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.AppImage">Link</a></td>
         </tr>
         <tr>
             <td>Android</td>

README_ja-JP.md

@@ -53,11 +53,11 @@ Gopeed (正式名 Go Speed) は `Golang` + `Flutter` によって開発された
         </tr>
         <tr>
             <td><code>DEB</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.deb">Link</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux.deb">Link</a></td>
         </tr>
         <tr>
             <td><code>AppImage</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-x86_64.AppImage">Link</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.AppImage">Link</a></td>
         </tr>
         <tr>
             <td>Android</td>

README_vi-VN.md

@@ -53,11 +53,11 @@ Truy cập ✈ [Trang web chính thức](https://gopeed.com) | 📖 [Tài liệu
         </tr>
         <tr>
             <td><code>DEB</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.deb">Liên kết</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux.deb">Liên kết</a></td>
         </tr>
         <tr>
             <td><code>AppImage</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-x86_64.AppImage">Liên kết</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.AppImage">Liên kết</a></td>
         </tr>
         <tr>
             <td>Android</td>

README_zh-CN.md

@@ -53,11 +53,11 @@ Gopeed（全称 Go Speed），直译过来中文名叫做`够快下载器`（不
         </tr>
         <tr>
             <td><code>DEB</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.deb">前往</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux.deb">前往</a></td>
         </tr>
         <tr>
             <td><code>AppImage</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-x86_64.AppImage">前往</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.AppImage">前往</a></td>
         </tr>
         <tr>
             <td>Android</td>

README_zh-TW.md

@@ -53,11 +53,11 @@ Gopeed（全稱 Go Speed），是一款使用`Golang`+`Flutter`編寫的高速
         </tr>
         <tr>
             <td><code>DEB</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.deb">前往</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux.deb">前往</a></td>
         </tr>
         <tr>
             <td><code>AppImage</code></td>
-            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-x86_64.AppImage">前往</a></td>
+            <td><a href="https://gopeed.com/api/download?tpl=Gopeed-$version-linux-amd64.AppImage">前往</a></td>
         </tr>
         <tr>
             <td>Android</td>

go.mod

@@ -69,6 +69,7 @@ require (
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/kevinburke/ssh_config v1.2.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-ieproxy v0.0.11 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mschoch/smat v0.2.0 // indirect
 	github.com/pion/datachannel v1.5.5 // indirect

go.sum

@@ -270,6 +270,8 @@ github.com/matryer/is v1.2.0 h1:92UTHpy8CDwaJ08GqLDzhhuixiBUUD1p3AU6PHddz4A=
 github.com/matryer/is v1.2.0/go.mod h1:2fLPjFQM9rhQ15aVEtbuwhJinnOqrmgXPNdZsdwlWXA=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-ieproxy v0.0.11 h1:MQ/5BuGSgDAHZOJe6YY80IF2UVCfGkwfo6AeD7HtHYo=
+github.com/mattn/go-ieproxy v0.0.11/go.mod h1:/NsJd+kxZBmjMc5hrJCKMbP57B84rvq9BiDRbtO9AS0=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=

internal/controller/controller.go

@@ -1,14 +1,14 @@
 package controller
 
 import (
-	"net/url"
+	"github.com/GopeedLab/gopeed/pkg/base"
 	"os"
 	"path/filepath"
 )
 
 type Controller struct {
-	GetConfig func(v any) bool
-	ProxyUrl  *url.URL
+	GetConfig   func(v any) bool
+	ProxyConfig *base.DownloaderProxyConfig
 	FileController
 	//ContextDialer() (proxy.Dialer, error)
 }

internal/protocol/bt/fetcher.go

@@ -10,7 +10,6 @@ import (
 	"github.com/GopeedLab/gopeed/pkg/util"
 	"github.com/anacrolix/torrent"
 	"github.com/anacrolix/torrent/metainfo"
-	"net/http"
 	"path/filepath"
 	"strings"
 	"sync"
@@ -69,9 +68,7 @@ func (f *Fetcher) initClient() (err error) {
 	cfg.Bep20 = fmt.Sprintf("-GP%s-", parseBep20())
 	cfg.ExtendedHandshakeClientVersion = fmt.Sprintf("Gopeed %s", base.Version)
 	cfg.ListenPort = f.config.ListenPort
-	if f.ctl.ProxyUrl != nil {
-		cfg.HTTPProxy = http.ProxyURL(f.ctl.ProxyUrl)
-	}
+	cfg.HTTPProxy = f.ctl.ProxyConfig.ToHandler()
 	cfg.DefaultStorage = newFileOpts(newFileClientOpts{
 		ClientBaseDir: cfg.DataDir,
 		HandleFileTorrent: func(infoHash metainfo.Hash, ft *fileTorrentImpl) {

internal/protocol/bt/fetcher_test.go

@@ -8,8 +8,6 @@ import (
 	"github.com/GopeedLab/gopeed/internal/test"
 	"github.com/GopeedLab/gopeed/pkg/base"
 	"github.com/GopeedLab/gopeed/pkg/protocol/bt"
-	"github.com/GopeedLab/gopeed/pkg/util"
-	"net/url"
 	"os"
 	"reflect"
 	"testing"
@@ -60,7 +58,14 @@ func TestFetcher_ResolveWithProxy(t *testing.T) {
 	proxyListener := test.StartSocks5Server(usr, pwd)
 	defer proxyListener.Close()
 
-	doResolve(t, buildConfigFetcher(util.BuildProxyUrl("socks5", proxyListener.Addr().String(), usr, pwd)))
+	doResolve(t, buildConfigFetcher(&base.DownloaderProxyConfig{
+		Enable: true,
+		System: false,
+		Scheme: "socks5",
+		Host:   proxyListener.Addr().String(),
+		Usr:    usr,
+		Pwd:    pwd,
+	}))
 }
 
 func doResolve(t *testing.T, fetcher fetcher.Fetcher) {
@@ -100,7 +105,7 @@ func buildFetcher() fetcher.Fetcher {
 	return fetcher
 }
 
-func buildConfigFetcher(proxyUrl *url.URL) fetcher.Fetcher {
+func buildConfigFetcher(proxyConfig *base.DownloaderProxyConfig) fetcher.Fetcher {
 	fetcher := new(FetcherBuilder).Build()
 	newController := controller.NewController()
 	mockCfg := config{
@@ -114,7 +119,7 @@ func buildConfigFetcher(proxyUrl *url.URL) fetcher.Fetcher {
 		}
 		return true
 	}
-	newController.ProxyUrl = proxyUrl
+	newController.ProxyConfig = proxyConfig
 	fetcher.Setup(newController)
 	return fetcher
 }

internal/protocol/http/fetcher.go

@@ -451,12 +451,11 @@ func (f *Fetcher) splitChunk() (chunks []*chunk) {
 }
 
 func (f *Fetcher) buildClient() *http.Client {
-	transport := &http.Transport{}
+	transport := &http.Transport{
+		Proxy: f.ctl.ProxyConfig.ToHandler(),
+	}
 	// Cookie handle
 	jar, _ := cookiejar.New(nil)
-	if f.ctl.ProxyUrl != nil {
-		transport.Proxy = http.ProxyURL(f.ctl.ProxyUrl)
-	}
 	return &http.Client{
 		Transport: transport,
 		Jar:       jar,

internal/protocol/http/fetcher_test.go

@@ -8,7 +8,6 @@ import (
 	"github.com/GopeedLab/gopeed/internal/test"
 	"github.com/GopeedLab/gopeed/pkg/base"
 	"github.com/GopeedLab/gopeed/pkg/protocol/http"
-	"github.com/GopeedLab/gopeed/pkg/util"
 	"net"
 	"testing"
 	"time"
@@ -338,7 +337,11 @@ func downloadResume(listener net.Listener, connections int, t *testing.T) {
 func downloadWithProxy(httpListener net.Listener, proxyListener net.Listener, t *testing.T) {
 	fetcher := downloadReady(httpListener, 4, t)
 	ctl := controller.NewController()
-	ctl.ProxyUrl = util.BuildProxyUrl("socks5", proxyListener.Addr().String(), "", "")
+	ctl.ProxyConfig = &base.DownloaderProxyConfig{
+		Enable: true,
+		Scheme: "socks5",
+		Host:   proxyListener.Addr().String(),
+	}
 	fetcher.Setup(ctl)
 	err := fetcher.Start()
 	if err != nil {

internal/test/httptest.go

@@ -24,6 +24,11 @@ const (
 	Dir       = "./"
 	BuildFile = Dir + BuildName
 
+	ExternalDownloadUrl  = "https://raw.githubusercontent.com/GopeedLab/gopeed/v1.5.6/_docs/img/banner.png"
+	ExternalDownloadName = "banner.png"
+	ExternalDownloadSize = 26416
+	//ExternalDownloadMd5 = "c67c6e3cae79a95342485676571e8a5c"
+
 	DownloadName       = "download.data"
 	DownloadRename     = "download (1).data"
 	DownloadFile       = Dir + DownloadName

pkg/base/model.go

@@ -3,7 +3,10 @@ package base
 import (
 	"fmt"
 	"github.com/GopeedLab/gopeed/pkg/util"
+	"github.com/mattn/go-ieproxy"
 	"golang.org/x/exp/slices"
+	"net/http"
+	"net/url"
 	"time"
 )
 
@@ -128,3 +131,88 @@ func ParseOptsExtra[E any](opts *Options) error {
 	opts.Extra = &t
 	return nil
 }
+
+// DownloaderStoreConfig is the config that can restore the downloader.
+type DownloaderStoreConfig struct {
+	FirstLoad bool `json:"-"` // FirstLoad is the flag that the config is first time init and not from store
+
+	DownloadDir    string                 `json:"downloadDir"`    // DownloadDir is the default directory to save the downloaded files
+	MaxRunning     int                    `json:"maxRunning"`     // MaxRunning is the max running download count
+	ProtocolConfig map[string]any         `json:"protocolConfig"` // ProtocolConfig is special config for each protocol
+	Extra          map[string]any         `json:"extra"`
+	Proxy          *DownloaderProxyConfig `json:"proxy"`
+}
+
+func (cfg *DownloaderStoreConfig) Init() *DownloaderStoreConfig {
+	if cfg.MaxRunning == 0 {
+		cfg.MaxRunning = 5
+	}
+	if cfg.Proxy == nil {
+		cfg.Proxy = &DownloaderProxyConfig{}
+	}
+	return cfg
+}
+
+type DownloaderProxyConfig struct {
+	Enable bool `json:"enable"`
+	// System is the flag that use system proxy
+	System bool   `json:"system"`
+	Scheme string `json:"scheme"`
+	Host   string `json:"host"`
+	Usr    string `json:"usr"`
+	Pwd    string `json:"pwd"`
+}
+
+func (cfg *DownloaderProxyConfig) ToHandler() func(r *http.Request) (*url.URL, error) {
+	if cfg == nil || cfg.Enable == false {
+		return nil
+	}
+	if cfg.System {
+		ieproxy.ReloadConf()
+		return ieproxy.GetProxyFunc()
+	}
+	if cfg.Scheme == "" || cfg.Host == "" {
+		return nil
+	}
+	return http.ProxyURL(util.BuildProxyUrl(cfg.Scheme, cfg.Host, cfg.Usr, cfg.Pwd))
+}
+
+// ToUrl returns the proxy url, just for git clone
+func (cfg *DownloaderProxyConfig) ToUrl() *url.URL {
+	if cfg == nil || cfg.Enable == false {
+		return nil
+	}
+	if cfg.System {
+		ieproxy.ReloadConf()
+		static := ieproxy.GetConf().Static
+		if static.Active && len(static.Protocols) > 0 {
+			// If only one protocol, use it
+			if len(static.Protocols) == 1 {
+				for _, v := range static.Protocols {
+					return parseUrlSafe(v)
+				}
+			}
+			// Check https
+			if v, ok := static.Protocols["https"]; ok {
+				return parseUrlSafe(v)
+			}
+			// Check http
+			if v, ok := static.Protocols["http"]; ok {
+				return parseUrlSafe(v)
+			}
+		}
+		return nil
+	}
+	if cfg.Scheme == "" || cfg.Host == "" {
+		return nil
+	}
+	return util.BuildProxyUrl(cfg.Scheme, cfg.Host, cfg.Usr, cfg.Pwd)
+}
+
+func parseUrlSafe(rawUrl string) *url.URL {
+	u, err := url.Parse(rawUrl)
+	if err != nil {
+		return nil
+	}
+	return u
+}

pkg/download/downloader.go

@@ -110,15 +110,15 @@ func (d *Downloader) Setup() error {
 		return err
 	}
 	// load config from storage
-	var cfg DownloaderStoreConfig
+	var cfg base.DownloaderStoreConfig
 	exist, err := d.storage.Get(bucketConfig, "config", &cfg)
 	if err != nil {
 		return err
 	}
 	if exist {
 		d.cfg.DownloaderStoreConfig = &cfg
 	} else {
-		d.cfg.DownloaderStoreConfig = &DownloaderStoreConfig{
+		d.cfg.DownloaderStoreConfig = &base.DownloaderStoreConfig{
 			FirstLoad: true,
 		}
 	}
@@ -225,7 +225,7 @@ func (d *Downloader) setupFetcher(fetcher fetcher.Fetcher) {
 	ctl.GetConfig = func(v any) bool {
 		return d.getProtocolConfig(fetcher.Name(), v)
 	}
-	ctl.ProxyUrl = d.cfg.ProxyUrl()
+	ctl.ProxyConfig = d.cfg.Proxy
 	fetcher.Setup(ctl)
 }
 
@@ -603,11 +603,11 @@ func (d *Downloader) GetTasksByStatues(statues []base.Status) []*Task {
 	return tasks
 }
 
-func (d *Downloader) GetConfig() (*DownloaderStoreConfig, error) {
+func (d *Downloader) GetConfig() (*base.DownloaderStoreConfig, error) {
 	return d.cfg.DownloaderStoreConfig, nil
 }
 
-func (d *Downloader) PutConfig(v *DownloaderStoreConfig) error {
+func (d *Downloader) PutConfig(v *base.DownloaderStoreConfig) error {
 	d.cfg.DownloaderStoreConfig = v
 	return d.storage.Put(bucketConfig, "config", v)
 }