Maintenance: refactor servers updater code

- Require at least 80% of number of servers now to pass
- Each provider is in its own package with a common structure
- Unzip package with unzipper interface
- Openvpn package with extraction and download functions

internal/updater/providers/protonvpn/api.go

@@ -0,0 +1,65 @@
+package protonvpn
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"net"
+	"net/http"
+)
+
+var (
+	ErrHTTPStatusCodeNotOK   = errors.New("HTTP status code not OK")
+	ErrUnmarshalResponseBody = errors.New("failed unmarshaling response body")
+)
+
+type apiData struct {
+	LogicalServers []logicalServer
+}
+
+type logicalServer struct {
+	Name        string
+	ExitCountry string
+	Region      *string
+	City        *string
+	Servers     []physicalServer
+}
+
+type physicalServer struct {
+	EntryIP net.IP
+	ExitIP  net.IP
+	Domain  string
+	Status  uint8
+}
+
+func fetchAPI(ctx context.Context, client *http.Client) (
+	data apiData, err error) {
+	const url = "https://api.protonmail.ch/vpn/logicals"
+
+	request, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
+	if err != nil {
+		return data, err
+	}
+
+	response, err := client.Do(request)
+	if err != nil {
+		return data, err
+	}
+	defer response.Body.Close()
+
+	if response.StatusCode != http.StatusOK {
+		return data, fmt.Errorf("%w: %s", ErrHTTPStatusCodeNotOK, response.Status)
+	}
+
+	decoder := json.NewDecoder(response.Body)
+	if err := decoder.Decode(&data); err != nil {
+		return data, fmt.Errorf("%w: %s", ErrUnmarshalResponseBody, err)
+	}
+
+	if err := response.Body.Close(); err != nil {
+		return data, err
+	}
+
+	return data, nil
+}

internal/updater/providers/protonvpn/countries.go

@@ -0,0 +1,14 @@
+package protonvpn
+
+import "strings"
+
+func codeToCountry(countryCode string, countryCodes map[string]string) (
+	country string, warning string) {
+	countryCode = strings.ToLower(countryCode)
+	country, ok := countryCodes[countryCode]
+	if !ok {
+		warning = "unknown country code: " + countryCode
+		country = countryCode
+	}
+	return country, warning
+}

internal/updater/providers/protonvpn/servers.go

@@ -0,0 +1,98 @@
+// Package protonvpn contains code to obtain the server information
+// for the ProtonVPN provider.
+package protonvpn
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/models"
+)
+
+var ErrNotEnoughServers = errors.New("not enough servers found")
+
+func GetServers(ctx context.Context, client *http.Client, minServers int) (
+	servers []models.ProtonvpnServer, warnings []string, err error) {
+	data, err := fetchAPI(ctx, client)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	countryCodes := constants.CountryCodes()
+
+	var count int
+	for _, logicalServer := range data.LogicalServers {
+		count += len(logicalServer.Servers)
+	}
+
+	if count < minServers {
+		return nil, warnings, fmt.Errorf("%w: %d and expected at least %d",
+			ErrNotEnoughServers, count, minServers)
+	}
+
+	servers = make([]models.ProtonvpnServer, 0, count)
+	for _, logicalServer := range data.LogicalServers {
+		for _, physicalServer := range logicalServer.Servers {
+			server, warning, err := makeServer(
+				physicalServer, logicalServer, countryCodes)
+
+			if warning != "" {
+				warnings = append(warnings, warning)
+			}
+
+			if err != nil {
+				warnings = append(warnings, err.Error())
+				continue
+			}
+
+			servers = append(servers, server)
+		}
+	}
+
+	if len(servers) < minServers {
+		return nil, warnings, fmt.Errorf("%w: %d and expected at least %d",
+			ErrNotEnoughServers, len(servers), minServers)
+	}
+
+	sortServers(servers)
+
+	return servers, warnings, nil
+}
+
+var errServerStatusZero = errors.New("ignoring server with status 0")
+
+func makeServer(physical physicalServer, logical logicalServer,
+	countryCodes map[string]string) (server models.ProtonvpnServer,
+	warning string, err error) {
+	if physical.Status == 0 {
+		return server, "", fmt.Errorf("%w: %s",
+			errServerStatusZero, physical.Domain)
+	}
+
+	countryCode := logical.ExitCountry
+	country, warning := codeToCountry(countryCode, countryCodes)
+
+	server = models.ProtonvpnServer{
+		// Note: for multi-hop use the server name or hostname
+		// instead of the country
+		Country:  country,
+		Region:   getStringValue(logical.Region),
+		City:     getStringValue(logical.City),
+		Name:     logical.Name,
+		Hostname: physical.Domain,
+		EntryIP:  physical.EntryIP,
+		ExitIP:   physical.ExitIP,
+	}
+
+	return server, warning, nil
+}
+
+func getStringValue(ptr *string) string {
+	if ptr == nil {
+		return ""
+	}
+	return *ptr
+}

internal/updater/providers/protonvpn/sort.go

@@ -0,0 +1,26 @@
+package protonvpn
+
+import (
+	"sort"
+
+	"github.com/qdm12/gluetun/internal/models"
+)
+
+func sortServers(servers []models.ProtonvpnServer) {
+	sort.Slice(servers, func(i, j int) bool {
+		a, b := servers[i], servers[j]
+		if a.Country == b.Country { //nolint:nestif
+			if a.Region == b.Region {
+				if a.City == b.City {
+					if a.Name == b.Name {
+						return a.Hostname < b.Hostname
+					}
+					return a.Name < b.Name
+				}
+				return a.City < b.City
+			}
+			return a.Region < b.Region
+		}
+		return a.Country < b.Country
+	})
+}

internal/updater/providers/protonvpn/string.go

@@ -0,0 +1,14 @@
+package protonvpn
+
+import "github.com/qdm12/gluetun/internal/models"
+
+func Stringify(servers []models.ProtonvpnServer) (s string) {
+	s = "func ProtonvpnServers() []models.ProtonvpnServer {\n"
+	s += "	return []models.ProtonvpnServer{\n"
+	for _, server := range servers {
+		s += "		" + server.String() + ",\n"
+	}
+	s += "	}\n"
+	s += "}"
+	return s
+}