shell/scripts/python/speedtest_cli.py at master · boxcore/shell · GitHub

Repository navigation

History

executable file

766 lines (657 loc) · 23.7 KB

Raw

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

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

#!/usr/bin/env python

# -*- coding: utf-8 -*-

# Licensed under the Apache License, Version 2.0 (the "License"); you may

# not use this file except in compliance with the License. You may obtain

# a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

# License for the specific language governing permissions and limitations

# under the License.

import os

import re

import sys

import math

import signal

import socket

import timeit

import threading

__version__ = '0.3.2'

# Some global variables we use

user_agent = 'speedtest-cli/%s' % __version__

source = None

shutdown_event = None

# Used for bound_interface

socket_socket = socket.socket

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

ET = None

# Begin import game to handle Python 2 and Python 3

try:

from urllib2 import urlopen, Request, HTTPError, URLError

except ImportError:

from urllib.request import urlopen, Request, HTTPError, URLError

try:

from httplib import HTTPConnection, HTTPSConnection

except ImportError:

from http.client import HTTPConnection, HTTPSConnection

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

except ImportError:

from optparse import OptionParser as ArgParser

try:

import builtins

except ImportError:

def print_(*args, **kwargs):

"""The new-style print function taken from

https://pypi.python.org/pypi/six/

"""

fp = kwargs.pop("file", sys.stdout)

if fp is None:

return

def write(data):

if not isinstance(data, basestring):

data = str(data)

fp.write(data)

want_unicode = False

sep = kwargs.pop("sep", None)

if sep is not None:

if isinstance(sep, unicode):

want_unicode = True

elif not isinstance(sep, str):

raise TypeError("sep must be None or a string")

end = kwargs.pop("end", None)

if end is not None:

if isinstance(end, unicode):

want_unicode = True

elif not isinstance(end, str):

raise TypeError("end must be None or a string")

if kwargs:

raise TypeError("invalid keyword arguments to print()")

if not want_unicode:

for arg in args:

if isinstance(arg, unicode):

want_unicode = True

break

if want_unicode:

newline = unicode("\n")

space = unicode(" ")

else:

newline = "\n"

space = " "

if sep is None:

sep = space

if end is None:

end = newline

for i, arg in enumerate(args):

if i:

write(sep)

write(arg)

write(end)

else:

print_ = getattr(builtins, 'print')

del builtins

class SpeedtestCliServerListError(Exception):

"""Internal Exception class used to indicate to move on to the next

URL for retrieving speedtest.net server details

"""

def bound_socket(*args, **kwargs):

"""Bind socket to a specified source IP address"""

global source

sock = socket_socket(*args, **kwargs)

sock.bind((source, 0))

return sock

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_request(url, data=None, headers={}):

"""Build a urllib2 request object

This function automatically adds a User-Agent header to all requests

"""

headers['User-Agent'] = user_agent

return Request(url, data=data, headers=headers)

def catch_request(request):

"""Helper function to catch common exceptions encountered when

establishing a connection with a HTTP/HTTPS request

"""

try:

uh = urlopen(request)

return uh

except (HTTPError, URLError, socket.error):

return False

class FileGetter(threading.Thread):

"""Thread class for retrieving a URL"""

def __init__(self, url, start):

self.url = url

self.result = None

self.starttime = start

threading.Thread.__init__(self)

def run(self):

self.result = [0]

try:

if (timeit.default_timer() - self.starttime) <= 10:

request = build_request(self.url)

f = urlopen(request)

while 1 and not shutdown_event.isSet():

self.result.append(len(f.read(10240)))

if self.result[-1] == 0:

break

f.close()

except IOError:

pass

def downloadSpeed(files, quiet=False):

"""Function to launch FileGetter threads and calculate download speeds"""

start = timeit.default_timer()

def producer(q, files):

for file in files:

thread = FileGetter(file, start)

thread.start()

q.put(thread, True)

if not quiet and not shutdown_event.isSet():

sys.stdout.write('.')

sys.stdout.flush()

finished = []

def consumer(q, total_files):

while len(finished) < total_files:

thread = q.get(True)

while thread.isAlive():

thread.join(timeout=0.1)

finished.append(sum(thread.result))

del thread

q = Queue(6)

prod_thread = threading.Thread(target=producer, args=(q, files))

cons_thread = threading.Thread(target=consumer, args=(q, len(files)))

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)

return (sum(finished) / (timeit.default_timer() - start))

class FilePutter(threading.Thread):

"""Thread class for putting a URL"""

def __init__(self, url, start, size):

self.url = url

chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'

data = chars * (int(round(int(size) / 36.0)))

self.data = ('content1=%s' % data[0:int(size) - 9]).encode()

del data

self.result = None

self.starttime = start

threading.Thread.__init__(self)

def run(self):

try:

if ((timeit.default_timer() - self.starttime) <= 10 and

not shutdown_event.isSet()):

request = build_request(self.url, data=self.data)

f = urlopen(request)

f.read(11)

f.close()

self.result = len(self.data)

else:

self.result = 0

except IOError:

self.result = 0

def uploadSpeed(url, sizes, quiet=False):

"""Function to launch FilePutter threads and calculate upload speeds"""

start = timeit.default_timer()

def producer(q, sizes):

for size in sizes:

thread = FilePutter(url, start, size)

thread.start()

q.put(thread, True)

if not quiet and not shutdown_event.isSet():

sys.stdout.write('.')

sys.stdout.flush()

finished = []

def consumer(q, total_sizes):

while len(finished) < total_sizes:

thread = q.get(True)

while thread.isAlive():

thread.join(timeout=0.1)

finished.append(thread.result)

del thread

q = Queue(6)

prod_thread = threading.Thread(target=producer, args=(q, sizes))

cons_thread = threading.Thread(target=consumer, args=(q, len(sizes)))

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)

return (sum(finished) / (timeit.default_timer() - start))

def getAttributesByTagName(dom, tagName):

"""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(tagName)[0]

return dict(list(elem.attributes.items()))

def getConfig():

"""Download the speedtest.net configuration and return only the data

we are interested in

"""

request = build_request('https://www.speedtest.net/speedtest-config.php')

uh = catch_request(request)

if uh is False:

print_('Could not retrieve speedtest.net configuration')

sys.exit(1)

configxml = []

while 1:

configxml.append(uh.read(10240))

if len(configxml[-1]) == 0:

break

if int(uh.code) != 200:

return None

uh.close()

try:

root = ET.fromstring(''.encode().join(configxml))

config = {

'client': root.find('client').attrib,

'times': root.find('times').attrib,

'download': root.find('download').attrib,

'upload': root.find('upload').attrib}

except AttributeError: # Python3 branch

root = DOM.parseString(''.join(configxml))

config = {

'client': getAttributesByTagName(root, 'client'),

'times': getAttributesByTagName(root, 'times'),

'download': getAttributesByTagName(root, 'download'),

'upload': getAttributesByTagName(root, 'upload')}

except SyntaxError:

print_('Failed to parse speedtest.net configuration')

sys.exit(1)

del root

del configxml

return config

def closestServers(client, all=False):

"""Determine the 5 closest speedtest.net servers based on geographic

distance

"""

urls = [

'https://www.speedtest.net/speedtest-servers-static.php',

'http://c.speedtest.net/speedtest-servers-static.php',

]

servers = {}

for url in urls:

try:

request = build_request(url)

uh = catch_request(request)

if uh is False:

raise SpeedtestCliServerListError

serversxml = []

while 1:

serversxml.append(uh.read(10240))

if len(serversxml[-1]) == 0:

break

if int(uh.code) != 200:

uh.close()

raise SpeedtestCliServerListError

uh.close()

try:

root = ET.fromstring(''.encode().join(serversxml))

elements = root.getiterator('server')

except AttributeError: # Python3 branch

root = DOM.parseString(''.join(serversxml))

elements = root.getElementsByTagName('server')

except SyntaxError:

raise SpeedtestCliServerListError

for server in elements:

try:

attrib = server.attrib

except AttributeError:

attrib = dict(list(server.attributes.items()))

d = distance([float(client['lat']),

float(client['lon'])],

[float(attrib.get('lat')),

float(attrib.get('lon'))])

attrib['d'] = d

if d not in servers:

servers[d] = [attrib]

else:

servers[d].append(attrib)

del root

del serversxml

del elements

except SpeedtestCliServerListError:

continue

# We were able to fetch and parse the list of speedtest.net servers

if servers:

break

if not servers:

print_('Failed to retrieve list of speedtest.net servers')

sys.exit(1)

closest = []

for d in sorted(servers.keys()):

for s in servers[d]:

closest.append(s)

if len(closest) == 5 and not all:

break

else:

continue

break

del servers

return closest

def getBestServer(servers):

"""Perform a speedtest.net latency request to determine which

speedtest.net server has the lowest latency

"""

results = {}

for server in servers:

cum = []

url = '%s/latency.txt' % os.path.dirname(server['url'])

urlparts = urlparse(url)

for i in range(0, 3):

try:

if urlparts[0] == 'https':

h = HTTPSConnection(urlparts[1])

else:

h = HTTPConnection(urlparts[1])

headers = {'User-Agent': user_agent}

start = timeit.default_timer()

h.request("GET", urlparts[2], headers=headers)

r = h.getresponse()

total = (timeit.default_timer() - start)

except (HTTPError, URLError, socket.error):

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, 3)

results[avg] = server

fastest = sorted(results.keys())[0]

best = results[fastest]

best['latency'] = fastest

return best

def ctrl_c(signum, frame):

"""Catch Ctrl-C key sequence and set a shutdown_event for our threaded

operations

"""

global shutdown_event

shutdown_event.set()

raise SystemExit('\nCancelling...')

def version():

"""Print the version"""

raise SystemExit(__version__)

def speedtest():

"""Run the full speedtest.net test"""

global shutdown_event, source

shutdown_event = threading.Event()

signal.signal(signal.SIGINT, ctrl_c)

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('--bytes', dest='units', action='store_const',

const=('byte', 1), default=('bit', 8),

help='Display values in bytes instead of bits. Does '

'not affect the image generated by --share')

parser.add_argument('--share', action='store_true',

help='Generate and provide a URL to the speedtest.net '

'share results image')

parser.add_argument('--simple', action='store_true',

help='Suppress verbose output, only show basic '

'information')

parser.add_argument('--list', action='store_true',

help='Display a list of speedtest.net servers '

'sorted by distance')

parser.add_argument('--server', help='Specify a server ID to test against')

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=int,

help='HTTP timeout in seconds. Default 10')

parser.add_argument('--version', action='store_true',

help='Show the version number and exit')

options = parser.parse_args()

if isinstance(options, tuple):

args = options[0]

else:

args = options

del options

# Print the version and exit

if args.version:

version()

socket.setdefaulttimeout(args.timeout)

# If specified bind to a specific IP address

if args.source:

source = args.source

socket.socket = bound_socket

if not args.simple:

print_('Retrieving speedtest.net configuration...')

try:

config = getConfig()

except URLError:

print_('Cannot retrieve speedtest configuration')

sys.exit(1)

if not args.simple:

print_('Retrieving speedtest.net server list...')

if args.list or args.server:

servers = closestServers(config['client'], True)

if args.list:

serverList = []

for server in servers:

line = ('%(id)4s) %(sponsor)s (%(name)s, %(country)s) '

'[%(d)0.2f km]' % server)

serverList.append(line)

# Python 2.7 and newer seem to be ok with the resultant encoding

# from parsing the XML, but older versions have some issues.

# This block should detect whether we need to encode or not

try:

unicode()

print_('\n'.join(serverList).encode('utf-8', 'ignore'))

except NameError:

print_('\n'.join(serverList))

except IOError:

pass

sys.exit(0)

else:

servers = closestServers(config['client'])

if not args.simple:

print_('Testing from %(isp)s (%(ip)s)...' % config['client'])

if args.server:

try:

best = getBestServer(filter(lambda x: x['id'] == args.server,

servers))

except IndexError:

print_('Invalid server ID')

sys.exit(1)

elif args.mini:

name, ext = os.path.splitext(args.mini)

if ext:

url = os.path.dirname(args.mini)

else:

url = args.mini

urlparts = urlparse(url)

try:

request = build_request(args.mini)

f = urlopen(request)

except:

print_('Invalid Speedtest Mini URL')

sys.exit(1)

else:

text = f.read()

f.close()

extension = re.findall('upload_extension: "([^"]+)"', text.decode())

if not extension:

for ext in ['php', 'asp', 'aspx', 'jsp']:

try:

request = build_request('%s/speedtest/upload.%s' %

(args.mini, ext))

f = urlopen(request)

except:

pass

else:

data = f.read().strip()

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:

print_('Please provide the full URL of your Speedtest Mini server')

sys.exit(1)

servers = [{

'sponsor': 'Speedtest Mini',

'name': urlparts[1],

'd': 0,

'url': '%s/speedtest/upload.%s' % (url.rstrip('/'), extension[0]),

'latency': 0,

'id': 0

}]

try:

best = getBestServer(servers)

except:

best = servers[0]

else:

if not args.simple:

print_('Selecting best server based on latency...')

best = getBestServer(servers)

if not args.simple:

# Python 2.7 and newer seem to be ok with the resultant encoding

# from parsing the XML, but older versions have some issues.

# This block should detect whether we need to encode or not

try:

unicode()

print_(('Hosted by %(sponsor)s (%(name)s) [%(d)0.2f km]: '

'%(latency)s ms' % best).encode('utf-8', 'ignore'))

except NameError:

print_('Hosted by %(sponsor)s (%(name)s) [%(d)0.2f km]: '

'%(latency)s ms' % best)

else:

print_('Ping: %(latency)s ms' % best)

sizes = [350, 500, 750, 1000, 1500, 2000, 2500, 3000, 3500, 4000]

urls = []

for size in sizes:

for i in range(0, 4):

urls.append('%s/random%sx%s.jpg' %

(os.path.dirname(best['url']), size, size))

if not args.simple:

print_('Testing download speed', end='')

dlspeed = downloadSpeed(urls, args.simple)

if not args.simple:

print_()

print_('Download: %0.2f M%s/s' %

((dlspeed / 1000 / 1000) * args.units[1], args.units[0]))

sizesizes = [int(.25 * 1000 * 1000), int(.5 * 1000 * 1000)]

sizes = []

for size in sizesizes:

for i in range(0, 25):

sizes.append(size)

if not args.simple:

print_('Testing upload speed', end='')

ulspeed = uploadSpeed(best['url'], sizes, args.simple)

if not args.simple:

print_()

print_('Upload: %0.2f M%s/s' %

((ulspeed / 1000 / 1000) * args.units[1], args.units[0]))

if args.share and args.mini:

print_('Cannot generate a speedtest.net share results image while '

'testing against a Speedtest Mini server')

elif args.share:

dlspeedk = int(round((dlspeed / 1000) * 8, 0))

ping = int(round(best['latency'], 0))

ulspeedk = int(round((ulspeed / 1000) * 8, 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

apiData = [

'download=%s' % dlspeedk,

'ping=%s' % ping,

'upload=%s' % ulspeedk,

'promo=',

'startmode=%s' % 'pingselect',

'recommendedserverid=%s' % best['id'],

'accuracy=%s' % 1,

'serverid=%s' % best['id'],

'hash=%s' % md5(('%s-%s-%s-%s' %

(ping, ulspeedk, dlspeedk, '297aae72'))

.encode()).hexdigest()]

headers = {'Referer': 'https://c.speedtest.net/flash/speedtest.swf'}

request = build_request('https://www.speedtest.net/api/api.php',

data='&'.join(apiData).encode(),

headers=headers)

f = catch_request(request)

if f is False:

print_('Could not submit results to speedtest.net')

sys.exit(1)

response = f.read()

code = f.code

f.close()

if int(code) != 200:

print_('Could not submit results to speedtest.net')

sys.exit(1)

qsargs = parse_qs(response.decode())

resultid = qsargs.get('resultid')

if not resultid or len(resultid) != 1:

print_('Could not submit results to speedtest.net')

sys.exit(1)

print_('Share results: https://www.speedtest.net/result/%s.png' %

resultid[0])

def main():

try:

speedtest()

except KeyboardInterrupt:

print_('\nCancelling...')

if __name__ == '__main__':

main()

# vim:ts=4:sw=4:expandtab

shell/scripts/python/speedtest_cli.py at master · boxcore/shell · GitHub

Repository navigation

Expand file tree

Breadcrumbs

speedtest_cli.py

Latest commit

History

Breadcrumbs

speedtest_cli.py

File metadata and controls