Feat: Perfect privacy support (#606)

internal/configuration/perfectprivacy.go

@@ -0,0 +1,43 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readPerfectPrivacy(r reader) (err error) {
+	settings.Name = constants.Perfectprivacy
+	servers := r.servers.GetPerfectprivacy()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.PerfectprivacyCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readPerfectPrivacy(r)
+}
+
+func (settings *OpenVPNSelection) readPerfectPrivacy(r reader) (err error) {
+	settings.TCP, err = readOpenVPNProtocol(r)
+	if err != nil {
+		return err
+	}
+
+	portValidation := openvpnPortValidation{
+		tcp:        settings.TCP,
+		allowedTCP: []uint16{44, 443, 4433},
+		allowedUDP: []uint16{44, 443, 4433},
+	}
+	settings.CustomPort, err = readOpenVPNCustomPort(r, portValidation)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/provider.go

@@ -67,6 +67,8 @@ func (settings *Provider) read(r reader, vpnType string) error {
 		err = settings.readMullvad(r)
 	case constants.Nordvpn:
 		err = settings.readNordvpn(r)
+	case constants.Perfectprivacy:
+		err = settings.readPerfectPrivacy(r)
 	case constants.Privado:
 		err = settings.readPrivado(r)
 	case constants.PrivateInternetAccess:
@@ -108,7 +110,7 @@ func (settings *Provider) readVPNServiceProvider(r reader, vpnType string) (err
 			constants.Custom,
 			"cyberghost", constants.Expressvpn, "fastestvpn", "hidemyass", "ipvanish",
 			"ivpn", "mullvad", "nordvpn",
-			"privado", "pia", "private internet access", "privatevpn", "protonvpn",
+			constants.Perfectprivacy, "privado", "pia", "private internet access", "privatevpn", "protonvpn",
 			"purevpn", "surfshark", "torguard", constants.VPNUnlimited, "vyprvpn",
 			constants.Wevpn, "windscribe"}
 	case constants.Wireguard:

internal/configuration/provider_test.go

@@ -168,6 +168,21 @@ func Test_Provider_lines(t *testing.T) {
 				"      |--Protocol: udp",
 			},
 		},
+		"perfectprivacy": {
+			settings: Provider{
+				Name: constants.Perfectprivacy,
+				ServerSelection: ServerSelection{
+					VPN:    constants.OpenVPN,
+					Cities: []string{"a", "b"},
+				},
+			},
+			lines: []string{
+				"|--Perfect Privacy settings:",
+				"   |--Cities: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
 		"privado": {
 			settings: Provider{
 				Name: constants.Privado,

internal/configuration/selection.go

@@ -17,7 +17,8 @@ type ServerSelection struct { //nolint:maligned
 
 	// Expressvpn, Fastestvpn, HideMyAss, IPVanish, IVPN, Mullvad, PrivateVPN, Protonvpn, PureVPN, VPNUnlimited
 	Countries []string `json:"countries"`
-	// Expressvpn, HideMyAss, IPVanish, IVPN, Mullvad, PrivateVPN, Protonvpn, PureVPN, VPNUnlimited, WeVPN, Windscribe
+	// Expressvpn, HideMyAss, IPVanish, IVPN, Mullvad, Perfectprivacy, PrivateVPN, Protonvpn,
+	// PureVPN, VPNUnlimited, WeVPN, Windscribe
 	Cities []string `json:"cities"`
 	// Expressvpn, Fastestvpn, HideMyAss, IPVanish, IVPN, PrivateVPN, Windscribe, Privado, Protonvpn, VPNUnlimited, WeVPN
 	Hostnames []string `json:"hostnames"`

internal/configuration/updater.go

@@ -9,27 +9,28 @@ import (
 )
 
 type Updater struct {
-	Period       time.Duration `json:"period"`
-	DNSAddress   string        `json:"dns_address"`
-	Cyberghost   bool          `json:"cyberghost"`
-	Expressvpn   bool          `json:"expressvpn"`
-	Fastestvpn   bool          `json:"fastestvpn"`
-	HideMyAss    bool          `json:"hidemyass"`
-	Ipvanish     bool          `json:"ipvanish"`
-	Ivpn         bool          `json:"ivpn"`
-	Mullvad      bool          `json:"mullvad"`
-	Nordvpn      bool          `json:"nordvpn"`
-	PIA          bool          `json:"pia"`
-	Privado      bool          `json:"privado"`
-	Privatevpn   bool          `json:"privatevpn"`
-	Protonvpn    bool          `json:"protonvpn"`
-	Purevpn      bool          `json:"purevpn"`
-	Surfshark    bool          `json:"surfshark"`
-	Torguard     bool          `json:"torguard"`
-	VPNUnlimited bool          `json:"vpnunlimited"`
-	Vyprvpn      bool          `json:"vyprvpn"`
-	Wevpn        bool          `json:"wevpn"`
-	Windscribe   bool          `json:"windscribe"`
+	Period         time.Duration `json:"period"`
+	DNSAddress     string        `json:"dns_address"`
+	Cyberghost     bool          `json:"cyberghost"`
+	Expressvpn     bool          `json:"expressvpn"`
+	Fastestvpn     bool          `json:"fastestvpn"`
+	HideMyAss      bool          `json:"hidemyass"`
+	Ipvanish       bool          `json:"ipvanish"`
+	Ivpn           bool          `json:"ivpn"`
+	Mullvad        bool          `json:"mullvad"`
+	Nordvpn        bool          `json:"nordvpn"`
+	Perfectprivacy bool          `json:"perfectprivacy"`
+	PIA            bool          `json:"pia"`
+	Privado        bool          `json:"privado"`
+	Privatevpn     bool          `json:"privatevpn"`
+	Protonvpn      bool          `json:"protonvpn"`
+	Purevpn        bool          `json:"purevpn"`
+	Surfshark      bool          `json:"surfshark"`
+	Torguard       bool          `json:"torguard"`
+	VPNUnlimited   bool          `json:"vpnunlimited"`
+	Vyprvpn        bool          `json:"vyprvpn"`
+	Wevpn          bool          `json:"wevpn"`
+	Windscribe     bool          `json:"windscribe"`
 	// The two below should be used in CLI mode only
 	CLI bool `json:"-"`
 }
@@ -57,6 +58,7 @@ func (settings *Updater) EnableAll() {
 	settings.Ivpn = true
 	settings.Mullvad = true
 	settings.Nordvpn = true
+	settings.Perfectprivacy = true
 	settings.Privado = true
 	settings.PIA = true
 	settings.Privado = true