feat(providers): add giganews support (#2479)

internal/provider/giganews/updater/filename.go

@@ -0,0 +1,22 @@
+package updater
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+)
+
+var errNotOvpnExt = errors.New("filename does not have the openvpn file extension")
+
+func parseFilename(fileName string) (
+	region string, err error,
+) {
+	const suffix = ".ovpn"
+	if !strings.HasSuffix(fileName, suffix) {
+		return "", fmt.Errorf("%w: %s", errNotOvpnExt, fileName)
+	}
+
+	region = strings.TrimSuffix(fileName, suffix)
+	region = strings.ReplaceAll(region, " - ", " ")
+	return region, nil
+}

internal/provider/giganews/updater/hosttoserver.go

@@ -0,0 +1,55 @@
+package updater
+
+import (
+	"net/netip"
+
+	"github.com/qdm12/gluetun/internal/constants/vpn"
+	"github.com/qdm12/gluetun/internal/models"
+)
+
+type hostToServer map[string]models.Server
+
+func (hts hostToServer) add(host, region string, tcp, udp bool) {
+	server, ok := hts[host]
+	if !ok {
+		server.VPN = vpn.OpenVPN
+		server.Hostname = host
+		server.Region = region
+	}
+	if tcp {
+		server.TCP = true
+	}
+	if udp {
+		server.UDP = true
+	}
+	hts[host] = server
+}
+
+func (hts hostToServer) toHostsSlice() (hosts []string) {
+	hosts = make([]string, 0, len(hts))
+	for host := range hts {
+		hosts = append(hosts, host)
+	}
+	return hosts
+}
+
+func (hts hostToServer) adaptWithIPs(hostToIPs map[string][]netip.Addr) {
+	for host, IPs := range hostToIPs {
+		server := hts[host]
+		server.IPs = IPs
+		hts[host] = server
+	}
+	for host, server := range hts {
+		if len(server.IPs) == 0 {
+			delete(hts, host)
+		}
+	}
+}
+
+func (hts hostToServer) toServersSlice() (servers []models.Server) {
+	servers = make([]models.Server, 0, len(hts))
+	for _, server := range hts {
+		servers = append(servers, server)
+	}
+	return servers
+}

internal/provider/giganews/updater/resolve.go

@@ -0,0 +1,28 @@
+package updater
+
+import (
+	"time"
+
+	"github.com/qdm12/gluetun/internal/updater/resolver"
+)
+
+func parallelResolverSettings(hosts []string) (settings resolver.ParallelSettings) {
+	const (
+		maxFailRatio    = 0.1
+		maxDuration     = 5 * time.Second
+		betweenDuration = time.Second
+		maxNoNew        = 2
+		maxFails        = 2
+	)
+	return resolver.ParallelSettings{
+		Hosts:        hosts,
+		MaxFailRatio: maxFailRatio,
+		Repeat: resolver.RepeatSettings{
+			MaxDuration:     maxDuration,
+			BetweenDuration: betweenDuration,
+			MaxNoNew:        maxNoNew,
+			MaxFails:        maxFails,
+			SortIPs:         true,
+		},
+	}
+}

internal/provider/giganews/updater/servers.go

@@ -0,0 +1,87 @@
+package updater
+
+import (
+	"context"
+	"fmt"
+	"sort"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/provider/common"
+	"github.com/qdm12/gluetun/internal/updater/openvpn"
+)
+
+func (u *Updater) FetchServers(ctx context.Context, minServers int) (
+	servers []models.Server, err error) {
+	const url = "https://support.vyprvpn.com/hc/article_attachments/360052617332/Vypr_OpenVPN_20200320.zip"
+	contents, err := u.unzipper.FetchAndExtract(ctx, url)
+	if err != nil {
+		return nil, err
+	} else if len(contents) < minServers {
+		return nil, fmt.Errorf("%w: %d and expected at least %d",
+			common.ErrNotEnoughServers, len(contents), minServers)
+	}
+
+	hts := make(hostToServer)
+
+	for fileName, content := range contents {
+		if !strings.HasSuffix(fileName, ".ovpn") {
+			continue // not an OpenVPN file
+		}
+
+		host, warning, err := openvpn.ExtractHost(content)
+		if warning != "" {
+			u.warner.Warn(warning)
+		}
+		if err != nil {
+			// treat error as warning and go to next file
+			u.warner.Warn(err.Error() + " in " + fileName)
+			continue
+		}
+		host = strings.ReplaceAll(host, "vyprvpn.com", "vpn.giganews.com")
+
+		tcp, udp, err := openvpn.ExtractProto(content)
+		if err != nil {
+			// treat error as warning and go to next file
+			u.warner.Warn(err.Error() + " in " + fileName)
+			continue
+		}
+
+		region, err := parseFilename(fileName)
+		if err != nil {
+			// treat error as warning and go to next file
+			u.warner.Warn(err.Error())
+			continue
+		}
+
+		hts.add(host, region, tcp, udp)
+	}
+
+	if len(hts) < minServers {
+		return nil, fmt.Errorf("%w: %d and expected at least %d",
+			common.ErrNotEnoughServers, len(hts), minServers)
+	}
+
+	hosts := hts.toHostsSlice()
+	resolveSettings := parallelResolverSettings(hosts)
+	hostToIPs, warnings, err := u.parallelResolver.Resolve(ctx, resolveSettings)
+	for _, warning := range warnings {
+		u.warner.Warn(warning)
+	}
+	if err != nil {
+		return nil, err
+	}
+
+	if len(hostToIPs) < minServers {
+		return nil, fmt.Errorf("%w: %d and expected at least %d",
+			common.ErrNotEnoughServers, len(servers), minServers)
+	}
+
+	hts.adaptWithIPs(hostToIPs)
+
+	servers = hts.toServersSlice()
+
+	sort.Sort(models.SortableServers(servers))
+
+	return servers, nil
+}

internal/provider/giganews/updater/updater.go

@@ -0,0 +1,20 @@
+package updater
+
+import (
+	"github.com/qdm12/gluetun/internal/provider/common"
+)
+
+type Updater struct {
+	unzipper         common.Unzipper
+	parallelResolver common.ParallelResolver
+	warner           common.Warner
+}
+
+func New(unzipper common.Unzipper, warner common.Warner,
+	parallelResolver common.ParallelResolver) *Updater {
+	return &Updater{
+		unzipper:         unzipper,
+		parallelResolver: parallelResolver,
+		warner:           warner,
+	}
+}