chore(all): move sub-packages to internal/provider

internal/provider/cyberghost/updater/constants.go

@@ -0,0 +1,269 @@
+package cyberghost
+
+import "github.com/qdm12/gluetun/internal/constants"
+
+func getGroupIDToProtocol() map[string]string {
+	return map[string]string{
+		"87-1": constants.UDP, // Premium UDP Europe
+		"94-1": constants.UDP, // Premium UDP USA
+		"95-1": constants.UDP, // Premium UDP Asia
+		"87-8": constants.UDP, // NoSpy UDP Europe
+		"97-1": constants.TCP, // Premium TCP Europe
+		"93-1": constants.TCP, // Premium TCP USA
+		"96-1": constants.TCP, // Premium TCP Asia
+		"97-8": constants.TCP, // NoSpy TCP Europe
+	}
+}
+
+func getSubdomainToRegion() map[string]string {
+	return map[string]string{
+		"af": "Afghanistan",
+		"ax": "Aland Islands",
+		"al": "Albania",
+		"dz": "Algeria",
+		"as": "American Samoa",
+		"ad": "Andorra",
+		"ao": "Angola",
+		"ai": "Anguilla",
+		"aq": "Antarctica",
+		"ag": "Antigua and Barbuda",
+		"ar": "Argentina",
+		"am": "Armenia",
+		"aw": "Aruba",
+		"au": "Australia",
+		"at": "Austria",
+		"az": "Azerbaijan",
+		"bs": "Bahamas",
+		"bh": "Bahrain",
+		"bd": "Bangladesh",
+		"bb": "Barbados",
+		"by": "Belarus",
+		"be": "Belgium",
+		"bz": "Belize",
+		"bj": "Benin",
+		"bm": "Bermuda",
+		"bt": "Bhutan",
+		"bo": "Bolivia",
+		"bq": "Bonaire",
+		"ba": "Bosnia and Herzegovina",
+		"bw": "Botswana",
+		"bv": "Bouvet Island",
+		"br": "Brazil",
+		"io": "British Indian Ocean Territory",
+		"vg": "British Virgin Islands",
+		"bn": "Brunei Darussalam",
+		"bg": "Bulgaria",
+		"bf": "Burkina Faso",
+		"bi": "Burundi",
+		"kh": "Cambodia",
+		"cm": "Cameroon",
+		"ca": "Canada",
+		"cv": "Cape Verde",
+		"ky": "Cayman Islands",
+		"cf": "Central African Republic",
+		"td": "Chad",
+		"cl": "Chile",
+		"cn": "China",
+		"cx": "Christmas Island",
+		"cc": "Cocos Islands",
+		"co": "Colombia",
+		"km": "Comoros",
+		"cg": "Congo",
+		"ck": "Cook Islands",
+		"cr": "Costa Rica",
+		"ci": "Cote d'Ivoire",
+		"hr": "Croatia",
+		"cu": "Cuba",
+		"cw": "Curacao",
+		"cy": "Cyprus",
+		"cz": "Czech Republic",
+		"cd": "Democratic Republic of the Congo",
+		"dk": "Denmark",
+		"dj": "Djibouti",
+		"dm": "Dominica",
+		"do": "Dominican Republic",
+		"ec": "Ecuador",
+		"eg": "Egypt",
+		"sv": "El Salvador",
+		"gq": "Equatorial Guinea",
+		"er": "Eritrea",
+		"ee": "Estonia",
+		"et": "Ethiopia",
+		"fk": "Falkland Islands",
+		"fo": "Faroe Islands",
+		"fj": "Fiji",
+		"fi": "Finland",
+		"fr": "France",
+		"gf": "French Guiana",
+		"pf": "French Polynesia",
+		"tf": "French Southern Territories",
+		"ga": "Gabon",
+		"gm": "Gambia",
+		"ge": "Georgia",
+		"de": "Germany",
+		"gh": "Ghana",
+		"gi": "Gibraltar",
+		"gr": "Greece",
+		"gl": "Greenland",
+		"gd": "Grenada",
+		"gp": "Guadeloupe",
+		"gu": "Guam",
+		"gt": "Guatemala",
+		"gg": "Guernsey",
+		"gw": "Guinea-Bissau",
+		"gn": "Guinea",
+		"gy": "Guyana",
+		"ht": "Haiti",
+		"hm": "Heard Island and McDonald Islands",
+		"hn": "Honduras",
+		"hk": "Hong Kong",
+		"hu": "Hungary",
+		"is": "Iceland",
+		"in": "India",
+		"id": "Indonesia",
+		"ir": "Iran",
+		"iq": "Iraq",
+		"ie": "Ireland",
+		"im": "Isle of Man",
+		"il": "Israel",
+		"it": "Italy",
+		"jm": "Jamaica",
+		"jp": "Japan",
+		"je": "Jersey",
+		"jo": "Jordan",
+		"kz": "Kazakhstan",
+		"ke": "Kenya",
+		"ki": "Kiribati",
+		"kr": "Korea",
+		"kw": "Kuwait",
+		"kg": "Kyrgyzstan",
+		"la": "Lao People's Democratic Republic",
+		"lv": "Latvia",
+		"lb": "Lebanon",
+		"ls": "Lesotho",
+		"lr": "Liberia",
+		"ly": "Libya",
+		"li": "Liechtenstein",
+		"lt": "Lithuania",
+		"lu": "Luxembourg",
+		"mo": "Macao",
+		"mk": "Macedonia",
+		"mg": "Madagascar",
+		"mw": "Malawi",
+		"my": "Malaysia",
+		"mv": "Maldives",
+		"ml": "Mali",
+		"mt": "Malta",
+		"mh": "Marshall Islands",
+		"mq": "Martinique",
+		"mr": "Mauritania",
+		"mu": "Mauritius",
+		"yt": "Mayotte",
+		"mx": "Mexico",
+		"fm": "Micronesia",
+		"md": "Moldova",
+		"mc": "Monaco",
+		"mn": "Mongolia",
+		"me": "Montenegro",
+		"ms": "Montserrat",
+		"ma": "Morocco",
+		"mz": "Mozambique",
+		"mm": "Myanmar",
+		"na": "Namibia",
+		"nr": "Nauru",
+		"np": "Nepal",
+		"nl": "Netherlands",
+		"nc": "New Caledonia",
+		"nz": "New Zealand",
+		"ni": "Nicaragua",
+		"ne": "Niger",
+		"ng": "Nigeria",
+		"nu": "Niue",
+		"nf": "Norfolk Island",
+		"mp": "Northern Mariana Islands",
+		"no": "Norway",
+		"om": "Oman",
+		"pk": "Pakistan",
+		"pw": "Palau",
+		"ps": "Palestine, State of",
+		"pa": "Panama",
+		"pg": "Papua New Guinea",
+		"py": "Paraguay",
+		"pe": "Peru",
+		"ph": "Philippines",
+		"pn": "Pitcairn",
+		"pl": "Poland",
+		"pt": "Portugal",
+		"pr": "Puerto Rico",
+		"qa": "Qatar",
+		"re": "Reunion",
+		"ro": "Romania",
+		"ru": "Russian Federation",
+		"rw": "Rwanda",
+		"bl": "Saint Barthelemy",
+		"sh": "Saint Helena",
+		"kn": "Saint Kitts and Nevis",
+		"lc": "Saint Lucia",
+		"mf": "Saint Martin",
+		"pm": "Saint Pierre and Miquelon",
+		"vc": "Saint Vincent and the Grenadines",
+		"ws": "Samoa",
+		"sm": "San Marino",
+		"st": "Sao Tome and Principe",
+		"sa": "Saudi Arabia",
+		"sn": "Senegal",
+		"rs": "Serbia",
+		"sc": "Seychelles",
+		"sl": "Sierra Leone",
+		"sg": "Singapore",
+		"sx": "Sint Maarten",
+		"sk": "Slovakia",
+		"si": "Slovenia",
+		"sb": "Solomon Islands",
+		"so": "Somalia",
+		"za": "South Africa",
+		"gs": "South Georgia and the South Sandwich Islands",
+		"ss": "South Sudan",
+		"es": "Spain",
+		"lk": "Sri Lanka",
+		"sd": "Sudan",
+		"sr": "Suriname",
+		"sj": "Svalbard and Jan Mayen",
+		"sz": "Swaziland",
+		"se": "Sweden",
+		"ch": "Switzerland",
+		"sy": "Syrian Arab Republic",
+		"tw": "Taiwan",
+		"tj": "Tajikistan",
+		"tz": "Tanzania",
+		"th": "Thailand",
+		"tl": "Timor-Leste",
+		"tg": "Togo",
+		"tk": "Tokelau",
+		"to": "Tonga",
+		"tt": "Trinidad and Tobago",
+		"tn": "Tunisia",
+		"tr": "Turkey",
+		"tm": "Turkmenistan",
+		"tc": "Turks and Caicos Islands",
+		"tv": "Tuvalu",
+		"ug": "Uganda",
+		"ua": "Ukraine",
+		"ae": "United Arab Emirates",
+		"gb": "United Kingdom",
+		"um": "United States Minor Outlying Islands",
+		"us": "United States",
+		"uy": "Uruguay",
+		"vi": "US Virgin Islands",
+		"uz": "Uzbekistan",
+		"vu": "Vanuatu",
+		"va": "Vatican City State",
+		"ve": "Venezuela",
+		"vn": "Vietnam",
+		"wf": "Wallis and Futuna",
+		"eh": "Western Sahara",
+		"ye": "Yemen",
+		"zm": "Zambia",
+		"zw": "Zimbabwe",
+	}
+}

internal/provider/cyberghost/updater/countries.go

@@ -0,0 +1,15 @@
+package cyberghost
+
+func mergeCountryCodes(base, extend map[string]string) (merged map[string]string) {
+	merged = make(map[string]string, len(base))
+	for countryCode, region := range base {
+		merged[countryCode] = region
+	}
+	for countryCode := range base {
+		delete(extend, countryCode)
+	}
+	for countryCode, region := range extend {
+		merged[countryCode] = region
+	}
+	return merged
+}

internal/provider/cyberghost/updater/hosttoserver.go

@@ -0,0 +1,69 @@
+package cyberghost
+
+import (
+	"net"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/constants/vpn"
+	"github.com/qdm12/gluetun/internal/models"
+)
+
+type hostToServer map[string]models.Server
+
+func getPossibleServers() (possibleServers hostToServer) {
+	groupIDToProtocol := getGroupIDToProtocol()
+
+	cyberghostCountryCodes := getSubdomainToRegion()
+	allCountryCodes := constants.CountryCodes()
+	possibleCountryCodes := mergeCountryCodes(cyberghostCountryCodes, allCountryCodes)
+
+	n := len(groupIDToProtocol) * len(possibleCountryCodes)
+
+	possibleServers = make(hostToServer, n) // key is the host
+
+	for groupID, protocol := range groupIDToProtocol {
+		for countryCode, country := range possibleCountryCodes {
+			const domain = "cg-dialup.net"
+			possibleHost := groupID + "-" + countryCode + "." + domain
+			possibleServer := models.Server{
+				VPN:      vpn.OpenVPN,
+				Hostname: possibleHost,
+				Country:  country,
+				TCP:      protocol == constants.TCP,
+				UDP:      protocol == constants.UDP,
+			}
+			possibleServers[possibleHost] = possibleServer
+		}
+	}
+
+	return possibleServers
+}
+
+func (hts hostToServer) hostsSlice() (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][]net.IP) {
+	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) toSlice() (servers []models.Server) {
+	servers = make([]models.Server, 0, len(hts))
+	for _, server := range hts {
+		servers = append(servers, server)
+	}
+	return servers
+}

internal/provider/cyberghost/updater/resolve.go

@@ -0,0 +1,42 @@
+package cyberghost
+
+import (
+	"context"
+	"net"
+	"time"
+
+	"github.com/qdm12/gluetun/internal/updater/resolver"
+)
+
+func resolveHosts(ctx context.Context, presolver resolver.Parallel,
+	possibleHosts []string, minServers int) (
+	hostToIPs map[string][]net.IP, err error) {
+	const (
+		maxFailRatio    = 1
+		maxDuration     = 20 * time.Second
+		betweenDuration = time.Second
+		maxNoNew        = 4
+		maxFails        = 10
+	)
+	settings := resolver.ParallelSettings{
+		MaxFailRatio: maxFailRatio,
+		MinFound:     minServers,
+		Repeat: resolver.RepeatSettings{
+			MaxDuration:     maxDuration,
+			BetweenDuration: betweenDuration,
+			MaxNoNew:        maxNoNew,
+			MaxFails:        maxFails,
+			SortIPs:         true,
+		},
+	}
+	hostToIPs, _, err = presolver.Resolve(ctx, possibleHosts, settings)
+	if err != nil {
+		return nil, err
+	}
+
+	if err := ctx.Err(); err != nil {
+		return nil, err
+	}
+
+	return hostToIPs, nil
+}

internal/provider/cyberghost/updater/servers.go

@@ -0,0 +1,28 @@
+// Package cyberghost contains code to obtain the server information
+// for the Cyberghost provider.
+package cyberghost
+
+import (
+	"context"
+
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/updater/resolver"
+)
+
+func GetServers(ctx context.Context, presolver resolver.Parallel,
+	minServers int) (servers []models.Server, err error) {
+	possibleServers := getPossibleServers()
+
+	possibleHosts := possibleServers.hostsSlice()
+	hostToIPs, err := resolveHosts(ctx, presolver, possibleHosts, minServers)
+	if err != nil {
+		return nil, err
+	}
+
+	possibleServers.adaptWithIPs(hostToIPs)
+
+	servers = possibleServers.toSlice()
+
+	sortServers(servers)
+	return servers, nil
+}

internal/provider/cyberghost/updater/sort.go

@@ -0,0 +1,16 @@
+package cyberghost
+
+import (
+	"sort"
+
+	"github.com/qdm12/gluetun/internal/models"
+)
+
+func sortServers(servers []models.Server) {
+	sort.Slice(servers, func(i, j int) bool {
+		if servers[i].Country == servers[j].Country {
+			return servers[i].Hostname < servers[j].Hostname
+		}
+		return servers[i].Country < servers[j].Country
+	})
+}