1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
|
package speedtest
import (
"context"
"crypto/tls"
"crypto/x509"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"net"
"net/http"
"os"
"strings"
"sync"
"time"
"github.com/gocarina/gocsv"
log "github.com/sirupsen/logrus"
"github.com/urfave/cli/v2"
"github.com/librespeed/speedtest-cli/defs"
"github.com/librespeed/speedtest-cli/report"
)
const (
// serverListUrl is the default remote server JSON URL
serverListUrl = `https://librespeed.org/backend-servers/servers.php`
defaultTelemetryLevel = "basic"
defaultTelemetryServer = "https://librespeed.org"
defaultTelemetryPath = "/results/telemetry.php"
defaultTelemetryShare = "/results/"
)
type PingJob struct {
Index int
Server defs.Server
}
type PingResult struct {
Index int
Ping float64
}
// SpeedTest is the actual main function that handles the speed test(s)
func SpeedTest(c *cli.Context) error {
// check for suppressed output flags
var silent bool
if c.Bool(defs.OptionSimple) || c.Bool(defs.OptionJSON) || c.Bool(defs.OptionCSV) {
log.SetLevel(log.WarnLevel)
silent = true
}
// check for debug flag
if c.Bool(defs.OptionDebug) {
log.SetLevel(log.DebugLevel)
}
// print help
if c.Bool(defs.OptionHelp) {
return cli.ShowAppHelp(c)
}
// print version
if c.Bool(defs.OptionVersion) {
log.SetOutput(os.Stdout)
log.Warnf("%s %s (built on %s)", defs.ProgName, defs.ProgVersion, defs.BuildDate)
log.Warn("https://github.com/librespeed/speedtest-cli")
log.Warn("Licensed under GNU Lesser General Public License v3.0")
log.Warn("LibreSpeed\tCopyright (C) 2016-2020 Federico Dossena")
log.Warn("librespeed-cli\tCopyright (C) 2020 Maddie Zhan")
log.Warn("librespeed.org\tCopyright (C)")
return nil
}
if c.String(defs.OptionSource) != "" && c.String(defs.OptionInterface) != "" {
return fmt.Errorf("incompatible options '%s' and '%s'", defs.OptionSource, defs.OptionInterface)
}
// set CSV delimiter
gocsv.TagSeparator = c.String(defs.OptionCSVDelimiter)
// if --csv-header is given, print the header and exit (same behavior speedtest-cli)
if c.Bool(defs.OptionCSVHeader) {
var rep []report.CSVReport
b, _ := gocsv.MarshalBytes(&rep)
os.Stdout.WriteString(string(b))
return nil
}
// read telemetry settings if --share or any --telemetry option is given
var telemetryServer defs.TelemetryServer
telemetryJSON := c.String(defs.OptionTelemetryJSON)
telemetryLevel := c.String(defs.OptionTelemetryLevel)
telemetryServerString := c.String(defs.OptionTelemetryServer)
telemetryPath := c.String(defs.OptionTelemetryPath)
telemetryShare := c.String(defs.OptionTelemetryShare)
if c.Bool(defs.OptionShare) || telemetryJSON != "" || telemetryLevel != "" || telemetryServerString != "" || telemetryPath != "" || telemetryShare != "" {
if telemetryJSON != "" {
b, err := ioutil.ReadFile(telemetryJSON)
if err != nil {
log.Errorf("Cannot read %s: %s", telemetryJSON, err)
return err
}
if err := json.Unmarshal(b, &telemetryServer); err != nil {
log.Errorf("Error parsing %s: %s", telemetryJSON, err)
return err
}
}
if telemetryLevel != "" {
if telemetryLevel != "disabled" && telemetryLevel != "basic" && telemetryLevel != "full" && telemetryLevel != "debug" {
log.Fatalf("Unsupported telemetry level: %s", telemetryLevel)
}
telemetryServer.Level = telemetryLevel
} else if telemetryServer.Level == "" {
telemetryServer.Level = defaultTelemetryLevel
}
if telemetryServerString != "" {
telemetryServer.Server = telemetryServerString
} else if telemetryServer.Server == "" {
telemetryServer.Server = defaultTelemetryServer
}
if telemetryPath != "" {
telemetryServer.Path = telemetryPath
} else if telemetryServer.Path == "" {
telemetryServer.Path = defaultTelemetryPath
}
if telemetryShare != "" {
telemetryServer.Share = telemetryShare
} else if telemetryServer.Share == "" {
telemetryServer.Share = defaultTelemetryShare
}
}
if req := c.Int(defs.OptionConcurrent); req <= 0 {
log.Errorf("Concurrent requests cannot be lower than 1: %d is given", req)
return errors.New("invalid concurrent requests setting")
}
noICMP := c.Bool(defs.OptionNoICMP)
// HTTP requests timeout
http.DefaultClient.Timeout = time.Duration(c.Int(defs.OptionTimeout)) * time.Second
forceIPv4 := c.Bool(defs.OptionIPv4)
forceIPv6 := c.Bool(defs.OptionIPv6)
var network string
switch {
case forceIPv4:
network = "ip4"
case forceIPv6:
network = "ip6"
default:
network = "ip"
}
transport := http.DefaultTransport.(*http.Transport).Clone()
if caCertFileName := c.String(defs.OptionCACert); caCertFileName != "" {
caCert, err := ioutil.ReadFile(caCertFileName)
if err != nil {
log.Fatal(err)
}
caCertPool := x509.NewCertPool()
caCertPool.AppendCertsFromPEM(caCert)
transport.TLSClientConfig = &tls.Config{
InsecureSkipVerify: c.Bool(defs.OptionSkipCertVerify),
RootCAs: caCertPool,
}
} else {
transport.TLSClientConfig = &tls.Config{
InsecureSkipVerify: c.Bool(defs.OptionSkipCertVerify),
}
}
dialer := &net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
}
// bind to source IP address if given
if src := c.String(defs.OptionSource); src != "" {
var err error
dialer, err = newDialerAddressBound(src, network)
if err != nil {
return err
}
}
// bind to interface if given
// bind to interface if given
iface := c.String(defs.OptionInterface)
fwmark := c.Int(defs.OptionFwmark)
if iface != "" || fwmark > 0 {
var err error
dialer, err = newDialerInterfaceOrFwmarkBound(iface, fwmark)
if err != nil {
return err
}
// ICMP ping does not support interface binding.
noICMP = true
}
// enforce if ipv4/ipv6 is forced
var dialContext func(context.Context, string, string) (net.Conn, error)
switch {
case forceIPv4:
dialContext = func(ctx context.Context, network, address string) (conn net.Conn, err error) {
return dialer.DialContext(ctx, "tcp4", address)
}
case forceIPv6:
dialContext = func(ctx context.Context, network, address string) (conn net.Conn, err error) {
return dialer.DialContext(ctx, "tcp6", address)
}
default:
dialContext = dialer.DialContext
}
// set default HTTP client's Transport to the one that binds the source address
// this is modified from http.DefaultTransport
transport.DialContext = dialContext
http.DefaultClient.Transport = transport
// load server list
var servers []defs.Server
var err error
if str := c.String(defs.OptionLocalJSON); str != "" {
switch str {
case "-":
// load server list from stdin
log.Info("Using local JSON server list from stdin")
servers, err = getLocalServersReader(c.Bool(defs.OptionSecure), os.Stdin, c.IntSlice(defs.OptionExclude), c.IntSlice(defs.OptionServer), !c.Bool(defs.OptionList))
default:
// load server list from local JSON file
log.Infof("Using local JSON server list: %s", str)
servers, err = getLocalServers(c.Bool(defs.OptionSecure), str, c.IntSlice(defs.OptionExclude), c.IntSlice(defs.OptionServer), !c.Bool(defs.OptionList))
}
} else {
// fetch the server list JSON and parse it into the `servers` array
serverUrl := serverListUrl
if str := c.String(defs.OptionServerJSON); str != "" {
serverUrl = str
}
log.Infof("Retrieving server list from %s", serverUrl)
servers, err = getServerList(c.Bool(defs.OptionSecure), serverUrl, c.IntSlice(defs.OptionExclude), c.IntSlice(defs.OptionServer), !c.Bool(defs.OptionList))
if err != nil {
log.Info("Retry with /.well-known/librespeed")
servers, err = getServerList(c.Bool(defs.OptionSecure), serverUrl+"/.well-known/librespeed", c.IntSlice(defs.OptionExclude), c.IntSlice(defs.OptionServer), !c.Bool(defs.OptionList))
}
}
if err != nil {
log.Errorf("Error when fetching server list: %s", err)
return err
}
// if --list is given, list all the servers fetched and exit
if c.Bool(defs.OptionList) {
for _, svr := range servers {
var sponsorMsg string
if svr.Sponsor() != "" {
sponsorMsg = fmt.Sprintf(" [Sponsor: %s]", svr.Sponsor())
}
log.Warnf("%d: %s (%s) %s", svr.ID, svr.Name, svr.Server, sponsorMsg)
}
return nil
}
// if --server is given, do speed tests with all of them
if len(c.IntSlice(defs.OptionServer)) > 0 {
return doSpeedTest(c, servers, telemetryServer, network, silent, noICMP)
} else {
// else select the fastest server from the list
log.Info("Selecting the fastest server based on ping")
var wg sync.WaitGroup
jobs := make(chan PingJob, len(servers))
results := make(chan PingResult, len(servers))
done := make(chan struct{})
pingList := make(map[int]float64)
// spawn 10 concurrent pingers
for i := 0; i < 10; i++ {
go pingWorker(jobs, results, &wg, c.String(defs.OptionSource), network, noICMP)
}
// send ping jobs to workers
for idx, server := range servers {
wg.Add(1)
jobs <- PingJob{Index: idx, Server: server}
}
go func() {
wg.Wait()
close(done)
}()
Loop:
for {
select {
case result := <-results:
pingList[result.Index] = result.Ping
case <-done:
break Loop
}
}
if len(pingList) == 0 {
log.Fatal("No server is currently available, please try again later.")
}
// get the fastest server's index in the `servers` array
var serverIdx int
for idx, ping := range pingList {
if ping > 0 && ping <= pingList[serverIdx] {
serverIdx = idx
}
}
// do speed test on the server
return doSpeedTest(c, []defs.Server{servers[serverIdx]}, telemetryServer, network, silent, noICMP)
}
}
func pingWorker(jobs <-chan PingJob, results chan<- PingResult, wg *sync.WaitGroup, srcIp, network string, noICMP bool) {
for {
job := <-jobs
server := job.Server
// get the URL of the speed test server from the JSON
u, err := server.GetURL()
if err != nil {
log.Debugf("Server URL is invalid for %s (%s), skipping", server.Name, server.Server)
wg.Done()
return
}
// check the server is up by accessing the ping URL and checking its returned value == empty and status code == 200
if server.IsUp() {
// skip ICMP if option given
server.NoICMP = noICMP
// if server is up, get ping
ping, _, err := server.ICMPPingAndJitter(1, srcIp, network)
if err != nil {
log.Debugf("Can't ping server %s (%s), skipping", server.Name, u.Hostname())
wg.Done()
return
}
// return result
results <- PingResult{Index: job.Index, Ping: ping}
wg.Done()
} else {
log.Debugf("Server %s (%s) doesn't seem to be up, skipping", server.Name, u.Hostname())
wg.Done()
}
}
}
// getServerList fetches the server JSON from a remote server
func getServerList(forceHTTPS bool, serverList string, excludes, specific []int, filter bool) ([]defs.Server, error) {
// --exclude and --server cannot be used at the same time
if len(excludes) > 0 && len(specific) > 0 {
return nil, errors.New("either --exclude or --server can be used")
}
// getting the server list from remote
var servers []defs.Server
req, err := http.NewRequest(http.MethodGet, serverList, nil)
if err != nil {
return nil, err
}
req.Header.Set("User-Agent", defs.UserAgent)
resp, err := http.DefaultClient.Do(req)
if err != nil {
return nil, err
}
b, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if err := json.Unmarshal(b, &servers); err != nil {
return nil, err
}
return preprocessServers(servers, forceHTTPS, excludes, specific, filter)
}
// getLocalServersReader loads the server JSON from an io.Reader
func getLocalServersReader(forceHTTPS bool, reader io.ReadCloser, excludes, specific []int, filter bool) ([]defs.Server, error) {
defer reader.Close()
var servers []defs.Server
b, err := ioutil.ReadAll(reader)
if err != nil {
return nil, err
}
if err := json.Unmarshal(b, &servers); err != nil {
return nil, err
}
return preprocessServers(servers, forceHTTPS, excludes, specific, filter)
}
// getLocalServers loads the server JSON from a local file
func getLocalServers(forceHTTPS bool, jsonFile string, excludes, specific []int, filter bool) ([]defs.Server, error) {
f, err := os.OpenFile(jsonFile, os.O_RDONLY, 0644)
if err != nil {
return nil, err
}
return getLocalServersReader(forceHTTPS, f, excludes, specific, filter)
}
// preprocessServers makes some needed modifications to the servers fetched
func preprocessServers(servers []defs.Server, forceHTTPS bool, excludes, specific []int, filter bool) ([]defs.Server, error) {
for i := range servers {
u, err := servers[i].GetURL()
if err != nil {
return nil, err
}
// if no scheme is defined, use http as default, or https when --secure is given in cli options
// if the scheme is predefined and --secure is not given, we will use it as-is
if forceHTTPS {
u.Scheme = "https"
} else if u.Scheme == "" {
// if `secure` is not used and no scheme is defined, use http
u.Scheme = "http"
}
// modify the server struct in the array in place
servers[i].Server = u.String()
}
if len(excludes) > 0 && len(specific) > 0 {
return nil, errors.New("either --exclude or --specific can be used")
}
if filter {
// exclude servers from --exclude
if len(excludes) > 0 {
var ret []defs.Server
for _, server := range servers {
if contains(excludes, server.ID) {
continue
}
ret = append(ret, server)
}
return ret, nil
}
// use only servers from --server
// special value -1 will test all servers
if len(specific) > 0 && !contains(specific, -1) {
var ret []defs.Server
for _, server := range servers {
if contains(specific, server.ID) {
ret = append(ret, server)
}
}
if len(ret) == 0 {
error_message := fmt.Sprintf("specified server(s) not found: %v", specific)
return nil, errors.New(error_message)
}
return ret, nil
}
}
return servers, nil
}
// contains is a helper function to check if an int is in an int array
func contains(arr []int, val int) bool {
for _, v := range arr {
if v == val {
return true
}
}
return false
}
func newDialerAddressBound(src string, network string) (dialer *net.Dialer, err error) {
// first we parse the IP to see if it's valid
addr, err := net.ResolveIPAddr(network, src)
if err != nil {
if strings.Contains(err.Error(), "no suitable address") {
if network == "ip6" {
log.Errorf("Address %s is not a valid IPv6 address", src)
} else {
log.Errorf("Address %s is not a valid IPv4 address", src)
}
} else {
log.Errorf("Error parsing source IP: %s", err)
}
return nil, err
}
log.Debugf("Using %s as source IP", src)
localTCPAddr := &net.TCPAddr{IP: addr.IP}
defaultDialer := &net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
}
defaultDialer.LocalAddr = localTCPAddr
return defaultDialer, nil
}
|