Feat: Perfect privacy support (#606)

internal/updater/openvpn/extract.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"net"
+	"sort"
 	"strings"
 )
 
@@ -53,20 +54,38 @@ func ExtractHost(b []byte) (host, warning string, err error) {
 	return hosts[0], warning, nil
 }
 
+func ExtractIPs(b []byte) (ips []net.IP, err error) {
+	const rejectIP, rejectDomain = false, true
+	ipStrings := extractRemoteHosts(b, rejectIP, rejectDomain)
+	if len(ipStrings) == 0 {
+		return nil, ErrNoRemoteIP
+	}
+
+	sort.Slice(ipStrings, func(i, j int) bool {
+		return ipStrings[i] < ipStrings[j]
+	})
+
+	ips = make([]net.IP, len(ipStrings))
+	for i := range ipStrings {
+		ips[i] = net.ParseIP(ipStrings[i])
+	}
+
+	return ips, nil
+}
+
 func ExtractIP(b []byte) (ip net.IP, warning string, err error) {
-	const (
-		rejectIP     = false
-		rejectDomain = true
-	)
-	ips := extractRemoteHosts(b, rejectIP, rejectDomain)
-	if len(ips) == 0 {
-		return nil, "", ErrNoRemoteIP
-	} else if len(ips) > 1 {
+	ips, err := ExtractIPs(b)
+	if err != nil {
+		return nil, "", err
+	}
+
+	if len(ips) > 1 {
 		warning = fmt.Sprintf(
 			"only using the first IP address %s and discarding %d other hosts",
 			ips[0], len(ips)-1)
 	}
-	return net.ParseIP(ips[0]), warning, nil
+
+	return ips[0], warning, nil
 }
 
 func extractRemoteHosts(content []byte, rejectIP, rejectDomain bool) (hosts []string) {

internal/updater/providers.go

@@ -14,6 +14,7 @@ import (
 	"github.com/qdm12/gluetun/internal/updater/providers/ivpn"
 	"github.com/qdm12/gluetun/internal/updater/providers/mullvad"
 	"github.com/qdm12/gluetun/internal/updater/providers/nordvpn"
+	"github.com/qdm12/gluetun/internal/updater/providers/perfectprivacy"
 	"github.com/qdm12/gluetun/internal/updater/providers/pia"
 	"github.com/qdm12/gluetun/internal/updater/providers/privado"
 	"github.com/qdm12/gluetun/internal/updater/providers/privatevpn"
@@ -190,6 +191,27 @@ func (u *updater) updateNordvpn(ctx context.Context) (err error) {
 	return nil
 }
 
+func (u *updater) updatePerfectprivacy(ctx context.Context) (err error) {
+	minServers := getMinServers(len(u.servers.Perfectprivacy.Servers))
+	servers, warnings, err := perfectprivacy.GetServers(ctx, u.unzipper, minServers)
+	if u.options.CLI {
+		for _, warning := range warnings {
+			u.logger.Warn(constants.Perfectprivacy + ": " + warning)
+		}
+	}
+	if err != nil {
+		return err
+	}
+
+	if reflect.DeepEqual(u.servers.Perfectprivacy.Servers, servers) {
+		return nil
+	}
+
+	u.servers.Perfectprivacy.Timestamp = u.timeNow().Unix()
+	u.servers.Perfectprivacy.Servers = servers
+	return nil
+}
+
 func (u *updater) updatePIA(ctx context.Context) (err error) {
 	minServers := getMinServers(len(u.servers.Pia.Servers))
 	servers, err := pia.GetServers(ctx, u.client, minServers)

internal/updater/providers/perfectprivacy/citytoserver.go

@@ -0,0 +1,45 @@
+package perfectprivacy
+
+import (
+	"net"
+
+	"github.com/qdm12/gluetun/internal/models"
+)
+
+type cityToServer map[string]models.PerfectprivacyServer
+
+func (cts cityToServer) add(city string, ips []net.IP) {
+	server, ok := cts[city]
+	if !ok {
+		server.City = city
+		server.IPs = ips
+		server.TCP = true
+		server.UDP = true
+	} else {
+		// Do not insert duplicate IP addresses
+		existingIPs := make(map[string]struct{}, len(server.IPs))
+		for _, ip := range server.IPs {
+			existingIPs[ip.String()] = struct{}{}
+		}
+
+		for _, ip := range ips {
+			ipString := ip.String()
+			_, ok := existingIPs[ipString]
+			if ok {
+				continue
+			}
+			existingIPs[ipString] = struct{}{}
+			server.IPs = append(server.IPs, ip)
+		}
+	}
+
+	cts[city] = server
+}
+
+func (cts cityToServer) toServersSlice() (servers []models.PerfectprivacyServer) {
+	servers = make([]models.PerfectprivacyServer, 0, len(cts))
+	for _, server := range cts {
+		servers = append(servers, server)
+	}
+	return servers
+}

internal/updater/providers/perfectprivacy/filename.go

@@ -0,0 +1,20 @@
+package perfectprivacy
+
+import (
+	"strings"
+	"unicode"
+)
+
+func parseFilename(fileName string) (city string) {
+	const suffix = ".conf"
+	s := strings.TrimSuffix(fileName, suffix)
+
+	for i, r := range s {
+		if unicode.IsDigit(r) {
+			s = s[:i]
+			break
+		}
+	}
+
+	return s
+}

internal/updater/providers/perfectprivacy/servers.go

@@ -0,0 +1,73 @@
+package perfectprivacy
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/url"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/updater/openvpn"
+	"github.com/qdm12/gluetun/internal/updater/unzip"
+)
+
+var ErrNotEnoughServers = errors.New("not enough servers found")
+
+func GetServers(ctx context.Context, unzipper unzip.Unzipper, minServers int) (
+	servers []models.PerfectprivacyServer, warnings []string, err error) {
+	zipURL := url.URL{
+		Scheme: "https",
+		Host:   "www.perfect-privacy.com",
+		Path:   "/downloads/openvpn/get",
+	}
+	values := make(url.Values)
+	values.Set("system", "linux")
+	values.Set("scope", "server")
+	values.Set("filetype", "zip")
+	values.Set("protocol", "udp") // all support both TCP and UDP
+	zipURL.RawQuery = values.Encode()
+
+	contents, err := unzipper.FetchAndExtract(ctx, zipURL.String())
+	if err != nil {
+		return nil, nil, err
+	}
+
+	cts := make(cityToServer)
+
+	for fileName, content := range contents {
+		err := addServerFromOvpn(cts, fileName, content)
+		if err != nil {
+			warnings = append(warnings, fileName+": "+err.Error())
+		}
+	}
+
+	if len(cts) < minServers {
+		return nil, warnings, fmt.Errorf("%w: %d and expected at least %d",
+			ErrNotEnoughServers, len(cts), minServers)
+	}
+
+	servers = cts.toServersSlice()
+
+	sortServers(servers)
+
+	return servers, warnings, nil
+}
+
+func addServerFromOvpn(cts cityToServer,
+	fileName string, content []byte) (err error) {
+	if !strings.HasSuffix(fileName, ".conf") {
+		return nil // not an OpenVPN file
+	}
+
+	ips, err := openvpn.ExtractIPs(content)
+	if err != nil {
+		return err
+	}
+
+	city := parseFilename(fileName)
+
+	cts.add(city, ips)
+
+	return nil
+}

internal/updater/providers/perfectprivacy/sort.go

@@ -0,0 +1,13 @@
+package perfectprivacy
+
+import (
+	"sort"
+
+	"github.com/qdm12/gluetun/internal/models"
+)
+
+func sortServers(servers []models.PerfectprivacyServer) {
+	sort.Slice(servers, func(i, j int) bool {
+		return servers[i].City < servers[j].City
+	})
+}

internal/updater/unzip/extract.go

@@ -16,7 +16,8 @@ func zipExtractAll(zipBytes []byte) (contents map[string][]byte, err error) {
 	contents = map[string][]byte{}
 	for _, zf := range r.File {
 		fileName := filepath.Base(zf.Name)
-		if !strings.HasSuffix(fileName, ".ovpn") {
+		if !strings.HasSuffix(fileName, ".ovpn") &&
+			!strings.HasSuffix(fileName, ".conf") {
 			continue
 		}
 		f, err := zf.Open()

internal/updater/unzip/fetch.go

@@ -14,8 +14,6 @@ var (
 
 func (u *unzipper) FetchAndExtract(ctx context.Context, url string) (
 	contents map[string][]byte, err error) {
-	contents = make(map[string][]byte)
-
 	request, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
 	if err != nil {
 		return nil, err
@@ -40,13 +38,5 @@ func (u *unzipper) FetchAndExtract(ctx context.Context, url string) (
 		return nil, err
 	}
 
-	newContents, err := zipExtractAll(b)
-	if err != nil {
-		return nil, err
-	}
-	for fileName, content := range newContents {
-		contents[fileName] = content
-	}
-
-	return contents, nil
+	return zipExtractAll(b)
 }

internal/updater/updater.go

@@ -132,6 +132,16 @@ func (u *updater) UpdateServers(ctx context.Context) (allServers models.AllServe
 		}
 	}
 
+	if u.options.Perfectprivacy {
+		u.logger.Info("updating " + constants.Perfectprivacy + " servers...")
+		if err := u.updatePerfectprivacy(ctx); err != nil {
+			if ctxErr := ctx.Err(); ctxErr != nil {
+				return allServers, ctxErr
+			}
+			u.logger.Error(err.Error())
+		}
+	}
+
 	if u.options.Privado {
 		u.logger.Info("updating Privado servers...")
 		if err := u.updatePrivado(ctx); err != nil {