# -*- coding: utf-8 -*- import os import re import csv import sys import math import errno import signal import socket import timeit import datetime import platform import threading import xml.parsers.expat try: import gzip GZIP_BASE = gzip.GzipFile except ImportError: gzip = None GZIP_BASE = object __version__ = '2.0.2' class FakeShutdownEvent(object): """Class to fake a threading.Event.isSet so that users of this module are not required to register their own threading.Event() """ @staticmethod def isSet(): "Dummy method to always return false""" return False # Some global variables we use DEBUG = False _GLOBAL_DEFAULT_TIMEOUT = object() # Begin import game to handle Python 2 and Python 3 try: import json except ImportError: try: import simplejson as json except ImportError: json = None try: import xml.etree.cElementTree as ET except ImportError: try: import xml.etree.ElementTree as ET except ImportError: from xml.dom import minidom as DOM from xml.parsers.expat import ExpatError ET = None try: from urllib2 import (urlopen, Request, HTTPError, URLError, AbstractHTTPHandler, ProxyHandler, HTTPDefaultErrorHandler, HTTPRedirectHandler, HTTPErrorProcessor, OpenerDirector) except ImportError: from urllib.request import (urlopen, Request, HTTPError, URLError, AbstractHTTPHandler, ProxyHandler, HTTPDefaultErrorHandler, HTTPRedirectHandler, HTTPErrorProcessor, OpenerDirector) try: from httplib import HTTPConnection, BadStatusLine except ImportError: from http.client import HTTPConnection, BadStatusLine try: from httplib import HTTPSConnection except ImportError: try: from http.client import HTTPSConnection except ImportError: HTTPSConnection = None try: from Queue import Queue except ImportError: from queue import Queue try: from urlparse import urlparse except ImportError: from urllib.parse import urlparse try: from urlparse import parse_qs except ImportError: try: from urllib.parse import parse_qs except ImportError: from cgi import parse_qs try: from hashlib import md5 except ImportError: from md5 import md5 try: from argparse import ArgumentParser as ArgParser from argparse import SUPPRESS as ARG_SUPPRESS PARSER_TYPE_INT = int PARSER_TYPE_STR = str PARSER_TYPE_FLOAT = float except ImportError: from optparse import OptionParser as ArgParser from optparse import SUPPRESS_HELP as ARG_SUPPRESS PARSER_TYPE_INT = 'int' PARSER_TYPE_STR = 'string' PARSER_TYPE_FLOAT = 'float' try: from cStringIO import StringIO BytesIO = None except ImportError: try: from StringIO import StringIO BytesIO = None except ImportError: from io import StringIO, BytesIO # Exception "constants" to support Python 2 through Python 3 try: import ssl try: CERT_ERROR = (ssl.CertificateError,) except AttributeError: CERT_ERROR = tuple() HTTP_ERRORS = ( (HTTPError, URLError, socket.error, ssl.SSLError, BadStatusLine) + CERT_ERROR ) except ImportError: ssl = None HTTP_ERRORS = (HTTPError, URLError, socket.error, BadStatusLine) class SpeedtestException(Exception): """Base exception for this module""" class SpeedtestCLIError(SpeedtestException): """Generic exception for raising errors during CLI operation""" class SpeedtestHTTPError(SpeedtestException): """Base HTTP exception for this module""" class SpeedtestConfigError(SpeedtestException): """Configuration XML is invalid""" class SpeedtestServersError(SpeedtestException): """Servers XML is invalid""" class ConfigRetrievalError(SpeedtestHTTPError): """Could not retrieve config.php""" class ServersRetrievalError(SpeedtestHTTPError): """Could not retrieve speedtest-servers.php""" class InvalidServerIDType(SpeedtestException): """Server ID used for filtering was not an integer""" class NoMatchedServers(SpeedtestException): """No servers matched when filtering""" class SpeedtestMiniConnectFailure(SpeedtestException): """Could not connect to the provided speedtest mini server""" class InvalidSpeedtestMiniServer(SpeedtestException): """Server provided as a speedtest mini server does not actually appear to be a speedtest mini server """ class ShareResultsConnectFailure(SpeedtestException): """Could not connect to speedtest.net API to POST results""" class ShareResultsSubmitFailure(SpeedtestException): """Unable to successfully POST results to speedtest.net API after connection """ class SpeedtestUploadTimeout(SpeedtestException): """testlength configuration reached during upload Used to ensure the upload halts when no additional data should be sent """ class SpeedtestBestServerFailure(SpeedtestException): """Unable to determine best server""" class SpeedtestMissingBestServer(SpeedtestException): """get_best_server not called or not able to determine best server""" def create_connection(address, timeout=_GLOBAL_DEFAULT_TIMEOUT, source_address=None): """Connect to *address* and return the socket object. Convenience function. Connect to *address* (a 2-tuple ``(host, port)``) and return the socket object. Passing the optional *timeout* parameter will set the timeout on the socket instance before attempting to connect. If no *timeout* is supplied, the global default timeout setting returned by :func:`getdefaulttimeout` is used. If *source_address* is set it must be a tuple of (host, port) for the socket to bind as a source address before making the connection. An host of '' or port 0 tells the OS to use the default. Largely vendored from Python 2.7, modified to work with Python 2.4 """ host, port = address err = None for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM): af, socktype, proto, canonname, sa = res sock = None try: sock = socket.socket(af, socktype, proto) if timeout is not _GLOBAL_DEFAULT_TIMEOUT: sock.settimeout(float(timeout)) if source_address: sock.bind(source_address) sock.connect(sa) return sock except socket.error: err = get_exception() if sock is not None: sock.close() if err is not None: raise err else: raise socket.error("getaddrinfo returns an empty list") class SpeedtestHTTPConnection(HTTPConnection): """Custom HTTPConnection to support source_address across Python 2.4 - Python 3 """ def __init__(self, *args, **kwargs): source_address = kwargs.pop('source_address', None) timeout = kwargs.pop('timeout', 10) HTTPConnection.__init__(self, *args, **kwargs) self.source_address = source_address self.timeout = timeout def connect(self): """Connect to the host and port specified in __init__.""" try: self.sock = socket.create_connection( (self.host, self.port), self.timeout, self.source_address ) except (AttributeError, TypeError): self.sock = create_connection( (self.host, self.port), self.timeout, self.source_address ) if HTTPSConnection: class SpeedtestHTTPSConnection(HTTPSConnection, SpeedtestHTTPConnection): """Custom HTTPSConnection to support source_address across Python 2.4 - Python 3 """ def __init__(self, *args, **kwargs): source_address = kwargs.pop('source_address', None) timeout = kwargs.pop('timeout', 10) HTTPSConnection.__init__(self, *args, **kwargs) self.timeout = timeout self.source_address = source_address def connect(self): "Connect to a host on a given (SSL) port." SpeedtestHTTPConnection.connect(self) kwargs = {} if ssl: if hasattr(ssl, 'SSLContext'): kwargs['server_hostname'] = self.host try: self.sock = self._context.wrap_socket(self.sock, **kwargs) except AttributeError: self.sock = ssl.wrap_socket(self.sock, **kwargs) def _build_connection(connection, source_address, timeout, context=None): """Cross Python 2.4 - Python 3 callable to build an ``HTTPConnection`` or ``HTTPSConnection`` with the args we need Called from ``http(s)_open`` methods of ``SpeedtestHTTPHandler`` or ``SpeedtestHTTPSHandler`` """ def inner(host, **kwargs): kwargs.update({ 'source_address': source_address, 'timeout': timeout }) if context: kwargs['context'] = context return connection(host, **kwargs) return inner class SpeedtestHTTPHandler(AbstractHTTPHandler): """Custom ``HTTPHandler`` that can build a ``HTTPConnection`` with the args we need for ``source_address`` and ``timeout`` """ def __init__(self, debuglevel=0, source_address=None, timeout=10): AbstractHTTPHandler.__init__(self, debuglevel) self.source_address = source_address self.timeout = timeout def http_open(self, req): return self.do_open( _build_connection( SpeedtestHTTPConnection, self.source_address, self.timeout ), req ) http_request = AbstractHTTPHandler.do_request_ class SpeedtestHTTPSHandler(AbstractHTTPHandler): """Custom ``HTTPSHandler`` that can build a ``HTTPSConnection`` with the args we need for ``source_address`` and ``timeout`` """ def __init__(self, debuglevel=0, context=None, source_address=None, timeout=10): AbstractHTTPHandler.__init__(self, debuglevel) self._context = context self.source_address = source_address self.timeout = timeout def https_open(self, req): return self.do_open( _build_connection( SpeedtestHTTPSConnection, self.source_address, self.timeout, context=self._context, ), req ) https_request = AbstractHTTPHandler.do_request_ def build_opener(source_address=None, timeout=10): """Function similar to ``urllib2.build_opener`` that will build an ``OpenerDirector`` with the explicit handlers we want, ``source_address`` for binding, ``timeout`` and our custom `User-Agent` """ printer('Timeout set to %d' % timeout, debug=True) if source_address: source_address_tuple = (source_address, 0) printer('Binding to source address: %r' % (source_address_tuple,), debug=True) else: source_address_tuple = None handlers = [ ProxyHandler(), SpeedtestHTTPHandler(source_address=source_address_tuple, timeout=timeout), SpeedtestHTTPSHandler(source_address=source_address_tuple, timeout=timeout), HTTPDefaultErrorHandler(), HTTPRedirectHandler(), HTTPErrorProcessor() ] opener = OpenerDirector() opener.addheaders = [('User-agent', build_user_agent())] for handler in handlers: opener.add_handler(handler) return opener class GzipDecodedResponse(GZIP_BASE): """A file-like object to decode a response encoded with the gzip method, as described in RFC 1952. Largely copied from ``xmlrpclib``/``xmlrpc.client`` and modified to work for py2.4-py3 """ def __init__(self, response): # response doesn't support tell() and read(), required by # GzipFile if not gzip: raise SpeedtestHTTPError('HTTP response body is gzip encoded, ' 'but gzip support is not available') IO = BytesIO or StringIO self.io = IO() while 1: chunk = response.read(1024) if len(chunk) == 0: break self.io.write(chunk) self.io.seek(0) gzip.GzipFile.__init__(self, mode='rb', fileobj=self.io) def close(self): try: gzip.GzipFile.close(self) finally: self.io.close() def get_exception(): """Helper function to work with py2.4-py3 for getting the current exception in a try/except block """ return sys.exc_info()[1] def distance(origin, destination): """Determine distance between 2 sets of [lat,lon] in km""" lat1, lon1 = origin lat2, lon2 = destination radius = 6371 # km dlat = math.radians(lat2 - lat1) dlon = math.radians(lon2 - lon1) a = (math.sin(dlat / 2) * math.sin(dlat / 2) + math.cos(math.radians(lat1)) * math.cos(math.radians(lat2)) * math.sin(dlon / 2) * math.sin(dlon / 2)) c = 2 * math.atan2(math.sqrt(a), math.sqrt(1 - a)) d = radius * c return d def build_user_agent(): """Build a Mozilla/5.0 compatible User-Agent string""" ua_tuple = ( 'Mozilla/5.0', '(%s; U; %s; en-us)' % (platform.system(), platform.architecture()[0]), 'Python/%s' % platform.python_version(), '(KHTML, like Gecko)', 'speedtest-cli/%s' % __version__ ) user_agent = ' '.join(ua_tuple) printer('User-Agent: %s' % user_agent, debug=True) return user_agent def build_request(url, data=None, headers=None, bump='0', secure=False): """Build a urllib2 request object This function automatically adds a User-Agent header to all requests """ if not headers: headers = {} if url[0] == ':': scheme = ('http', 'https')[bool(secure)] schemed_url = '%s%s' % (scheme, url) else: schemed_url = url if '?' in url: delim = '&' else: delim = '?' # WHO YOU GONNA CALL? CACHE BUSTERS! final_url = '%s%sx=%s.%s' % (schemed_url, delim, int(timeit.time.time() * 1000), bump) headers.update({ 'Cache-Control': 'no-cache', }) printer('%s %s' % (('GET', 'POST')[bool(data)], final_url), debug=True) return Request(final_url, data=data, headers=headers) def catch_request(request, opener=None): """Helper function to catch common exceptions encountered when establishing a connection with a HTTP/HTTPS request """ if opener: _open = opener.open else: _open = urlopen try: uh = _open(request) return uh, False except HTTP_ERRORS: e = get_exception() return None, e def get_response_stream(response): """Helper function to return either a Gzip reader if ``Content-Encoding`` is ``gzip`` otherwise the response itself """ try: getheader = response.headers.getheader except AttributeError: getheader = response.getheader if getheader('content-encoding') == 'gzip': return GzipDecodedResponse(response) return response def get_attributes_by_tag_name(dom, tag_name): """Retrieve an attribute from an XML document and return it in a consistent format Only used with xml.dom.minidom, which is likely only to be used with python versions older than 2.5 """ elem = dom.getElementsByTagName(tag_name)[0] return dict(list(elem.attributes.items())) def print_dots(shutdown_event): """Built in callback function used by Thread classes for printing status """ def inner(current, total, start=False, end=False): if shutdown_event.isSet(): return if current + 1 == total and end is True: print "." return inner def do_nothing(*args, **kwargs): pass class HTTPDownloader(threading.Thread): """Thread class for retrieving a URL""" def __init__(self, i, request, start, timeout, opener=None, shutdown_event=None): threading.Thread.__init__(self) self.request = request self.result = [0] self.starttime = start self.timeout = timeout self.i = i if opener: self._opener = opener.open else: self._opener = urlopen if shutdown_event: self._shutdown_event = shutdown_event else: self._shutdown_event = FakeShutdownEvent() def run(self): try: if (timeit.default_timer() - self.starttime) <= self.timeout: f = self._opener(self.request) while (not self._shutdown_event.isSet() and (timeit.default_timer() - self.starttime) <= self.timeout): self.result.append(len(f.read(10240))) if self.result[-1] == 0: break f.close() except IOError: pass class HTTPUploaderData(object): """File like object to improve cutting off the upload once the timeout has been reached """ def __init__(self, length, start, timeout, shutdown_event=None): self.length = length self.start = start self.timeout = timeout if shutdown_event: self._shutdown_event = shutdown_event else: self._shutdown_event = FakeShutdownEvent() self._data = None self.total = [0] def pre_allocate(self): chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ' multiplier = int(round(int(self.length) / 36.0)) IO = BytesIO or StringIO try: self._data = IO( ('content1=%s' % (chars * multiplier)[0:int(self.length) - 9] ).encode() ) except MemoryError: raise SpeedtestCLIError( 'Insufficient memory to pre-allocate upload data. Please ' 'use --no-pre-allocate' ) @property def data(self): if not self._data: self.pre_allocate() return self._data def read(self, n=10240): if ((timeit.default_timer() - self.start) <= self.timeout and not self._shutdown_event.isSet()): chunk = self.data.read(n) self.total.append(len(chunk)) return chunk else: raise SpeedtestUploadTimeout() def __len__(self): return self.length class HTTPUploader(threading.Thread): """Thread class for putting a URL""" def __init__(self, i, request, start, size, timeout, opener=None, shutdown_event=None): threading.Thread.__init__(self) self.request = request self.request.data.start = self.starttime = start self.size = size self.result = None self.timeout = timeout self.i = i if opener: self._opener = opener.open else: self._opener = urlopen if shutdown_event: self._shutdown_event = shutdown_event else: self._shutdown_event = FakeShutdownEvent() def run(self): request = self.request try: if ((timeit.default_timer() - self.starttime) <= self.timeout and not self._shutdown_event.isSet()): try: f = self._opener(request) except TypeError: # PY24 expects a string or buffer # This also causes issues with Ctrl-C, but we will concede # for the moment that Ctrl-C on PY24 isn't immediate request = build_request(self.request.get_full_url(), data=request.data.read(self.size)) f = self._opener(request) f.read(11) f.close() self.result = sum(self.request.data.total) else: self.result = 0 except (IOError, SpeedtestUploadTimeout): self.result = sum(self.request.data.total) class SpeedtestResults(object): def __init__(self, download=0, upload=0, ping=0, server=None, client=None, opener=None, secure=False): self.download = download self.upload = upload self.ping = ping if server is None: self.server = {} else: self.server = server self.client = client or {} self._share = None self.timestamp = '%sZ' % datetime.datetime.utcnow().isoformat() self.bytes_received = 0 self.bytes_sent = 0 if opener: self._opener = opener else: self._opener = build_opener() self._secure = secure def __repr__(self): return repr(self.dict()) def share(self): """POST data to the speedtest.net API to obtain a share results link """ if self._share: return self._share download = int(round(self.download / 1000.0, 0)) ping = int(round(self.ping, 0)) upload = int(round(self.upload / 1000.0, 0)) # Build the request to send results back to speedtest.net # We use a list instead of a dict because the API expects parameters # in a certain order api_data = [ 'recommendedserverid=%s' % self.server['id'], 'ping=%s' % ping, 'screenresolution=', 'promo=', 'download=%s' % download, 'screendpi=', 'upload=%s' % upload, 'testmethod=http', 'hash=%s' % md5(('%s-%s-%s-%s' % (ping, upload, download, '297aae72')) .encode()).hexdigest(), 'touchscreen=none', 'startmode=pingselect', 'accuracy=1', 'bytesreceived=%s' % self.bytes_received, 'bytessent=%s' % self.bytes_sent, 'serverid=%s' % self.server['id'], ] headers = {'Referer': 'http://c.speedtest.net/flash/speedtest.swf'} request = build_request('://www.speedtest.net/api/api.php', data='&'.join(api_data).encode(), headers=headers, secure=self._secure) f, e = catch_request(request, opener=self._opener) if e: raise ShareResultsConnectFailure(e) response = f.read() code = f.code f.close() if int(code) != 200: raise ShareResultsSubmitFailure('Could not submit results to ' 'speedtest.net') qsargs = parse_qs(response.decode()) resultid = qsargs.get('resultid') if not resultid or len(resultid) != 1: raise ShareResultsSubmitFailure('Could not submit results to ' 'speedtest.net') self._share = 'http://www.speedtest.net/result/%s.png' % resultid[0] return self._share def dict(self): """Return dictionary of result data""" return { 'download': self.download, 'upload': self.upload, 'ping': self.ping, 'server': self.server, 'timestamp': self.timestamp, 'bytes_sent': self.bytes_sent, 'bytes_received': self.bytes_received, 'share': self._share, 'client': self.client, } @staticmethod def csv_header(delimiter=','): """Return CSV Headers""" row = ['Server ID', 'Sponsor', 'Server Name', 'Timestamp', 'Distance', 'Ping', 'Download', 'Upload', 'Share', 'IP Address'] out = StringIO() writer = csv.writer(out, delimiter=delimiter, lineterminator='') writer.writerow([to_utf8(v) for v in row]) return out.getvalue() def csv(self, delimiter=','): """Return data in CSV format""" data = self.dict() out = StringIO() writer = csv.writer(out, delimiter=delimiter, lineterminator='') row = [data['server']['id'], data['server']['sponsor'], data['server']['name'], data['timestamp'], data['server']['d'], data['ping'], data['download'], data['upload'], self._share or '', self.client['ip']] writer.writerow([to_utf8(v) for v in row]) return out.getvalue() def json(self, pretty=False): """Return data in JSON format""" kwargs = {} if pretty: kwargs.update({ 'indent': 4, 'sort_keys': True }) return json.dumps(self.dict(), **kwargs) class Speedtest(object): """Class for performing standard speedtest.net testing operations""" def __init__(self, config=None, source_address=None, timeout=10, secure=False, shutdown_event=None): self.config = {} self._source_address = source_address self._timeout = timeout self._opener = build_opener(source_address, timeout) self._secure = secure if shutdown_event: self._shutdown_event = shutdown_event else: self._shutdown_event = FakeShutdownEvent() self.get_config() if config is not None: self.config.update(config) self.servers = {} self.closest = [] self._best = {} self.results = SpeedtestResults( client=self.config['client'], opener=self._opener, secure=secure, ) @property def best(self): if not self._best: raise SpeedtestMissingBestServer( 'get_best_server not called or not able to determine best ' 'server' ) return self._best def get_config(self): """Download the speedtest.net configuration and return only the data we are interested in """ headers = {} if gzip: headers['Accept-Encoding'] = 'gzip' request = build_request('://www.speedtest.net/speedtest-config.php', headers=headers, secure=self._secure) uh, e = catch_request(request, opener=self._opener) if e: raise ConfigRetrievalError(e) configxml_list = [] stream = get_response_stream(uh) while 1: try: configxml_list.append(stream.read(1024)) except (OSError, EOFError): raise ConfigRetrievalError(get_exception()) if len(configxml_list[-1]) == 0: break stream.close() uh.close() if int(uh.code) != 200: return None configxml = ''.encode().join(configxml_list) printer('Config XML:\n%s' % configxml, debug=True) try: try: root = ET.fromstring(configxml) except ET.ParseError: e = get_exception() raise SpeedtestConfigError( 'Malformed speedtest.net configuration: %s' % e ) server_config = root.find('server-config').attrib download = root.find('download').attrib upload = root.find('upload').attrib # times = root.find('times').attrib client = root.find('client').attrib except AttributeError: try: root = DOM.parseString(configxml) except ExpatError: e = get_exception() raise SpeedtestConfigError( 'Malformed speedtest.net configuration: %s' % e ) server_config = get_attributes_by_tag_name(root, 'server-config') download = get_attributes_by_tag_name(root, 'download') upload = get_attributes_by_tag_name(root, 'upload') # times = get_attributes_by_tag_name(root, 'times') client = get_attributes_by_tag_name(root, 'client') ignore_servers = list( map(int, server_config['ignoreids'].split(',')) ) ratio = int(upload['ratio']) upload_max = int(upload['maxchunkcount']) up_sizes = [32768, 65536, 131072, 262144, 524288, 1048576, 7340032] sizes = { 'upload': up_sizes[ratio - 1:], 'download': [350, 500, 750, 1000, 1500, 2000, 2500, 3000, 3500, 4000] } size_count = len(sizes['upload']) upload_count = int(math.ceil(upload_max / size_count)) counts = { 'upload': upload_count, 'download': int(download['threadsperurl']) } threads = { 'upload': int(upload['threads']), 'download': int(server_config['threadcount']) * 2 } length = { 'upload': int(upload['testlength']), 'download': int(download['testlength']) } self.config.update({ 'client': client, 'ignore_servers': ignore_servers, 'sizes': sizes, 'counts': counts, 'threads': threads, 'length': length, 'upload_max': upload_count * size_count }) try: self.lat_lon = (float(client['lat']), float(client['lon'])) except ValueError: raise SpeedtestConfigError( 'Unknown location: lat=%r lon=%r' % (client.get('lat'), client.get('lon')) ) printer('Config:\n%r' % self.config, debug=True) return self.config def get_servers(self, servers=None, exclude=None): """Retrieve a the list of speedtest.net servers, optionally filtered to servers matching those specified in the ``servers`` argument """ if servers is None: servers = [] if exclude is None: exclude = [] self.servers.clear() for server_list in (servers, exclude): for i, s in enumerate(server_list): try: server_list[i] = int(s) except ValueError: raise InvalidServerIDType( '%s is an invalid server type, must be int' % s ) urls = [ '://www.speedtest.net/speedtest-servers-static.php', 'http://c.speedtest.net/speedtest-servers-static.php', '://www.speedtest.net/speedtest-servers.php', 'http://c.speedtest.net/speedtest-servers.php', ] headers = {} if gzip: headers['Accept-Encoding'] = 'gzip' errors = [] for url in urls: try: request = build_request( '%s?threads=%s' % (url, self.config['threads']['download']), headers=headers, secure=self._secure ) uh, e = catch_request(request, opener=self._opener) if e: errors.append('%s' % e) raise ServersRetrievalError() stream = get_response_stream(uh) serversxml_list = [] while 1: try: serversxml_list.append(stream.read(1024)) except (OSError, EOFError): raise ServersRetrievalError(get_exception()) if len(serversxml_list[-1]) == 0: break stream.close() uh.close() if int(uh.code) != 200: raise ServersRetrievalError() serversxml = ''.encode().join(serversxml_list) printer('Servers XML:\n%s' % serversxml, debug=True) try: try: try: root = ET.fromstring(serversxml) except ET.ParseError: e = get_exception() raise SpeedtestServersError( 'Malformed speedtest.net server list: %s' % e ) elements = root.getiterator('server') except AttributeError: try: root = DOM.parseString(serversxml) except ExpatError: e = get_exception() raise SpeedtestServersError( 'Malformed speedtest.net server list: %s' % e ) elements = root.getElementsByTagName('server') except (SyntaxError, xml.parsers.expat.ExpatError): raise ServersRetrievalError() for server in elements: try: attrib = server.attrib except AttributeError: attrib = dict(list(server.attributes.items())) if servers and int(attrib.get('id')) not in servers: continue if (int(attrib.get('id')) in self.config['ignore_servers'] or int(attrib.get('id')) in exclude): continue try: d = distance(self.lat_lon, (float(attrib.get('lat')), float(attrib.get('lon')))) except Exception: continue attrib['d'] = d try: self.servers[d].append(attrib) except KeyError: self.servers[d] = [attrib] break except ServersRetrievalError: continue if (servers or exclude) and not self.servers: raise NoMatchedServers() return self.servers def set_mini_server(self, server): """Instead of querying for a list of servers, set a link to a speedtest mini server """ urlparts = urlparse(server) name, ext = os.path.splitext(urlparts[2]) if ext: url = os.path.dirname(server) else: url = server request = build_request(url) uh, e = catch_request(request, opener=self._opener) if e: raise SpeedtestMiniConnectFailure('Failed to connect to %s' % server) else: text = uh.read() uh.close() extension = re.findall('upload_?[Ee]xtension: "([^"]+)"', text.decode()) if not extension: for ext in ['php', 'asp', 'aspx', 'jsp']: try: f = self._opener.open( '%s/speedtest/upload.%s' % (url, ext) ) except Exception: pass else: data = f.read().strip().decode() if (f.code == 200 and len(data.splitlines()) == 1 and re.match('size=[0-9]', data)): extension = [ext] break if not urlparts or not extension: raise InvalidSpeedtestMiniServer('Invalid Speedtest Mini Server: ' '%s' % server) self.servers = [{ 'sponsor': 'Speedtest Mini', 'name': urlparts[1], 'd': 0, 'url': '%s/speedtest/upload.%s' % (url.rstrip('/'), extension[0]), 'latency': 0, 'id': 0 }] return self.servers def get_closest_servers(self, limit=5): """Limit servers to the closest speedtest.net servers based on geographic distance """ if not self.servers: self.get_servers() for d in sorted(self.servers.keys()): for s in self.servers[d]: self.closest.append(s) if len(self.closest) == limit: break else: continue break printer('Closest Servers:\n%r' % self.closest, debug=True) return self.closest def get_best_server(self, servers=None): """Perform a speedtest.net "ping" to determine which speedtest.net server has the lowest latency """ if not servers: if not self.closest: servers = self.get_closest_servers() servers = self.closest if self._source_address: source_address_tuple = (self._source_address, 0) else: source_address_tuple = None user_agent = build_user_agent() results = {} for server in servers: cum = [] url = os.path.dirname(server['url']) stamp = int(timeit.time.time() * 1000) latency_url = '%s/latency.txt?x=%s' % (url, stamp) for i in range(0, 3): this_latency_url = '%s.%s' % (latency_url, i) printer('%s %s' % ('GET', this_latency_url), debug=True) urlparts = urlparse(latency_url) try: if urlparts[0] == 'https': h = SpeedtestHTTPSConnection( urlparts[1], source_address=source_address_tuple ) else: h = SpeedtestHTTPConnection( urlparts[1], source_address=source_address_tuple ) headers = {'User-Agent': user_agent} path = '%s?%s' % (urlparts[2], urlparts[4]) start = timeit.default_timer() h.request("GET", path, headers=headers) r = h.getresponse() total = (timeit.default_timer() - start) except HTTP_ERRORS: e = get_exception() printer('ERROR: %r' % e, debug=True) cum.append(3600) continue text = r.read(9) if int(r.status) == 200 and text == 'test=test'.encode(): cum.append(total) else: cum.append(3600) h.close() avg = round((sum(cum) / 6) * 1000.0, 3) results[avg] = server try: fastest = sorted(results.keys())[0] except IndexError: raise SpeedtestBestServerFailure('Unable to connect to servers to ' 'test latency.') best = results[fastest] best['latency'] = fastest self.results.ping = fastest self.results.server = best self._best.update(best) printer('Best Server:\n%r' % best, debug=True) return best def download(self, callback=do_nothing): """Test download speed against speedtest.net""" urls = [] for size in self.config['sizes']['download']: for _ in range(0, self.config['counts']['download']): lon='%s/random%sx%s.jpg' %(os.path.dirname(self.best['url']), size, size) urls.append(lon) request_count = len(urls) requests = [] for i, url in enumerate(urls): requests.append( build_request(url, bump=i, secure=self._secure) ) def producer(q, requests, request_count): for i, request in enumerate(requests): thread = HTTPDownloader( i, request, start, self.config['length']['download'], opener=self._opener, shutdown_event=self._shutdown_event ) thread.start() q.put(thread, True) callback(i, request_count, start=True) finished = [] def consumer(q, request_count): while len(finished) < request_count: thread = q.get(True) while thread.isAlive(): thread.join(timeout=0.1) finished.append(sum(thread.result)) callback(thread.i, request_count, end=True) q = Queue(self.config['threads']['download']) prod_thread = threading.Thread(target=producer, args=(q, requests, request_count)) cons_thread = threading.Thread(target=consumer, args=(q, request_count)) start = timeit.default_timer() prod_thread.start() cons_thread.start() while prod_thread.isAlive(): prod_thread.join(timeout=0.1) while cons_thread.isAlive(): cons_thread.join(timeout=0.1) stop = timeit.default_timer() self.results.bytes_received = sum(finished) self.results.download = ( (self.results.bytes_received / (stop - start)) * 8.0 ) if self.results.download > 100000: self.config['threads']['upload'] = 8 return self.results.download def upload(self, callback=do_nothing, pre_allocate=True): """Test upload speed against speedtest.net""" sizes = [] for size in self.config['sizes']['upload']: for _ in range(0, self.config['counts']['upload']): sizes.append(size) # request_count = len(sizes) request_count = self.config['upload_max'] requests = [] for i, size in enumerate(sizes): # We set ``0`` for ``start`` and handle setting the actual # ``start`` in ``HTTPUploader`` to get better measurements data = HTTPUploaderData( size, 0, self.config['length']['upload'], shutdown_event=self._shutdown_event ) if pre_allocate: data.pre_allocate() requests.append( ( build_request(self.best['url'], data, secure=self._secure), size ) ) def producer(q, requests, request_count): for i, request in enumerate(requests[:request_count]): thread = HTTPUploader( i, request[0], start, request[1], self.config['length']['upload'], opener=self._opener, shutdown_event=self._shutdown_event ) thread.start() q.put(thread, True) callback(i, request_count, start=True) finished = [] def consumer(q, request_count): while len(finished) < request_count: thread = q.get(True) while thread.isAlive(): thread.join(timeout=0.1) finished.append(thread.result) callback(thread.i, request_count, end=True) q = Queue(self.config['threads']['upload']) prod_thread = threading.Thread(target=producer, args=(q, requests, request_count)) cons_thread = threading.Thread(target=consumer, args=(q, request_count)) start = timeit.default_timer() prod_thread.start() cons_thread.start() while prod_thread.isAlive(): prod_thread.join(timeout=0.1) while cons_thread.isAlive(): cons_thread.join(timeout=0.1) stop = timeit.default_timer() self.results.bytes_sent = sum(finished) self.results.upload = ( (self.results.bytes_sent / (stop - start)) * 8.0 ) return self.results.upload def ctrl_c(shutdown_event): """Catch Ctrl-C key sequence and set a SHUTDOWN_EVENT for our threaded operations """ def inner(signum, frame): shutdown_event.set() printer('\nCancelling...', error=True) sys.exit(0) return inner def version(): """Print the version""" printer(__version__) sys.exit(0) def csv_header(delimiter=','): """Print the CSV Headers""" printer(SpeedtestResults.csv_header(delimiter=delimiter)) sys.exit(0) def parse_args(): """Function to handle building and parsing of command line arguments""" description = ( 'Command line interface for testing internet bandwidth using ' 'speedtest.net.\n' '------------------------------------------------------------' '--------------\n' 'https://github.com/sivel/speedtest-cli') parser = ArgParser(description=description) # Give optparse.OptionParser an `add_argument` method for # compatibility with argparse.ArgumentParser try: parser.add_argument = parser.add_option except AttributeError: pass parser.add_argument('--no-download', dest='download', default=True, action='store_const', const=False, help='Do not perform download test') parser.add_argument('--no-upload', dest='upload', default=True, action='store_const', const=False, help='Do not perform upload test') parser.add_argument('--bytes', dest='units', action='store_const', const=('byte', 8), default=('bit', 1), help='Display values in bytes instead of bits. Does ' 'not affect the image generated by --share, nor ' 'output from --json or --csv') parser.add_argument('--share', action='store_true', help='Generate and provide a URL to the speedtest.net ' 'share results image, not displayed with --csv') parser.add_argument('--simple', action='store_true', default=False, help='Suppress verbose output, only show basic ' 'information') parser.add_argument('--csv', action='store_true', default=False, help='Suppress verbose output, only show basic ' 'information in CSV format. Speeds listed in ' 'bit/s and not affected by --bytes') parser.add_argument('--csv-delimiter', default=',', type=PARSER_TYPE_STR, help='Single character delimiter to use in CSV ' 'output. Default ","') parser.add_argument('--csv-header', action='store_true', default=False, help='Print CSV headers') parser.add_argument('--json', action='store_true', default=False, help='Suppress verbose output, only show basic ' 'information in JSON format. Speeds listed in ' 'bit/s and not affected by --bytes') parser.add_argument('--list', action='store_true', help='Display a list of speedtest.net servers ' 'sorted by distance') parser.add_argument('--server', type=PARSER_TYPE_INT, action='append', help='Specify a server ID to test against. Can be ' 'supplied multiple times') parser.add_argument('--exclude', type=PARSER_TYPE_INT, action='append', help='Exclude a server from selection. Can be ' 'supplied multiple times') parser.add_argument('--mini', help='URL of the Speedtest Mini server') parser.add_argument('--source', help='Source IP address to bind to') parser.add_argument('--timeout', default=10, type=PARSER_TYPE_FLOAT, help='HTTP timeout in seconds. Default 10') parser.add_argument('--secure', action='store_true', help='Use HTTPS instead of HTTP when communicating ' 'with speedtest.net operated servers') parser.add_argument('--no-pre-allocate', dest='pre_allocate', action='store_const', default=True, const=False, help='Do not pre allocate upload data. Pre allocation ' 'is enabled by default to improve upload ' 'performance. To support systems with ' 'insufficient memory, use this option to avoid a ' 'MemoryError') parser.add_argument('--version', action='store_true', help='Show the version number and exit') parser.add_argument('--debug', action='store_true', help=ARG_SUPPRESS, default=ARG_SUPPRESS) options = parser.parse_args() if isinstance(options, tuple): args = options[0] else: args = options return args def validate_optional_args(args): """Check if an argument was provided that depends on a module that may not be part of the Python standard library. If such an argument is supplied, and the module does not exist, exit with an error stating which module is missing. """ optional_args = { 'json': ('json/simplejson python module', json), 'secure': ('SSL support', HTTPSConnection), } for arg, info in optional_args.items(): if getattr(args, arg, False) and info[1] is None: raise SystemExit('%s is not installed. --%s is ' 'unavailable' % (info[0], arg)) def printer(string, quiet=False, debug=False, error=False, **kwargs): """Helper function print a string with various features""" if debug and not DEBUG: return if debug: if sys.stdout.isatty(): out = '\033[1;30mDEBUG: %s\033[0m' % string else: out = 'DEBUG: %s' % string else: out = string if error: kwargs['file'] = sys.stderr if not quiet: print(out) def shell(): """Run the full speedtest.net test""" global DEBUG shutdown_event = threading.Event() signal.signal(signal.SIGINT, ctrl_c(shutdown_event)) args = parse_args() # Print the version and exit if args.version: version() if not args.download and not args.upload: raise SpeedtestCLIError('Cannot supply both --no-download and ' '--no-upload') if len(args.csv_delimiter) != 1: raise SpeedtestCLIError('--csv-delimiter must be a single character') if args.csv_header: csv_header(args.csv_delimiter) validate_optional_args(args) debug = getattr(args, 'debug', False) if debug == 'SUPPRESSHELP': debug = False if debug: DEBUG = True if args.simple or args.csv or args.json: quiet = True else: quiet = False if args.csv or args.json: machine_format = True else: machine_format = False # Don't set a callback if we are running quietly if quiet or debug: callback = do_nothing else: callback = print_dots(shutdown_event) try: speedtest = Speedtest( source_address=args.source, timeout=args.timeout, secure=args.secure ) except (ConfigRetrievalError,) + HTTP_ERRORS: raise SpeedtestCLIError(get_exception()) if args.list: try: speedtest.get_servers() except (ServersRetrievalError,) + HTTP_ERRORS: raise SpeedtestCLIError(get_exception()) for _, servers in sorted(speedtest.servers.items()): for server in servers: line = ('%(id)5s) %(sponsor)s (%(name)s, %(country)s) ' '[%(d)0.2f km]' % server) try: printer(line) except IOError: e = get_exception() if e.errno != errno.EPIPE: raise sys.exit(0) printer('Testing from %(isp)s (%(ip)s)...' % speedtest.config['client'], quiet) if not args.mini: try: speedtest.get_servers(servers=args.server, exclude=args.exclude) except NoMatchedServers: raise SpeedtestCLIError( 'No matched servers: %s' % ', '.join('%s' % s for s in args.server) ) except (ServersRetrievalError,) + HTTP_ERRORS: raise SpeedtestCLIError(get_exception()) except InvalidServerIDType: raise SpeedtestCLIError( '%s is an invalid server type, must ' 'be an int' % ', '.join('%s' % s for s in args.server) ) if args.server and len(args.server) == 1: printer('Retrieving information for the selected server...', quiet) else: printer('Selecting best server based on ping...', quiet) speedtest.get_best_server() elif args.mini: speedtest.get_best_server(speedtest.set_mini_server(args.mini)) results = speedtest.results printer('Hosted by (%(name)s) [%(d)0.2f km]: ' '%(latency)s ms' % results.server, quiet) if args.download: printer('Testing download speed', quiet, end=('', '\n')[bool(debug)]) speedtest.download(callback=callback) printer('Download: %0.2f M%s/s' % ((results.download / 1000.0 / 1000.0) / args.units[1], args.units[0]), quiet) else: printer('Skipping download test', quiet) if args.upload: printer('Testing upload speed', quiet, end=('', '\n')[bool(debug)]) speedtest.upload(callback=callback, pre_allocate=args.pre_allocate) printer('Upload: %0.2f M%s/s' % ((results.upload / 1000.0 / 1000.0) / args.units[1], args.units[0]), quiet) else: printer('Skipping upload test', quiet) printer('Results:\n%r' % results.dict(), debug=True) if not args.simple and args.share: results.share() if args.simple: printer('Ping: %s ms\nDownload: %0.2f M%s/s\nUpload: %0.2f M%s/s' % (results.ping, (results.download / 1000.0 / 1000.0) / args.units[1], args.units[0], (results.upload / 1000.0 / 1000.0) / args.units[1], args.units[0])) elif args.csv: printer(results.csv(delimiter=args.csv_delimiter)) elif args.json: printer(results.json()) if args.share and not machine_format: printer('Share results: %s' % results.share()) def main(): try: shell() except KeyboardInterrupt: printer('\nCancelling...', error=True) except (SpeedtestException, SystemExit): e = get_exception() # Ignore a successful exit, or argparse exit if getattr(e, 'code', 1) not in (0, 2): raise SystemExit('ERROR: %s' % e) if __name__ == '__main__': main()