Completed
Push — master ( 0fa017...ea2799 )
by John
01:12
created

table_headers()   B

Complexity

Conditions 6

Size

Total Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 6
c 0
b 0
f 0
dl 0
loc 10
rs 8
1
#!/usr/bin/env python3
2
"""This module is used for network connections; APIs, downloading, etc."""
3
4
import os  # filesystem read
5
import xml.etree.ElementTree  # XML parsing
6
import re  # regexes
7
import hashlib  # base url creation
8
import concurrent.futures  # multiprocessing/threading
9
import glob  # pem file lookup
10
import requests  # downloading
11
from bs4 import BeautifulSoup  # scraping
12
from bbarchivist import utilities  # parse filesize
13
from bbarchivist.bbconstants import SERVERS  # lookup servers
14
15
__author__ = "Thurask"
16
__license__ = "WTFPL v2"
17
__copyright__ = "Copyright 2015-2016 Thurask"
18
19
20
def grab_pem():
21
    """
22
    Work with either local cacerts or system cacerts. Since cx_freeze is dumb.
23
    """
24
    try:
25
        pemfile = glob.glob(os.path.join(os.getcwd(), "cacert.pem"))[0]
26
    except IndexError:
27
        return requests.certs.where()  # no local cacerts
28
    else:
29
        return os.path.abspath(pemfile)  # local cacerts
30
31
32
def pem_wrapper(method):
33
    """
34
    Decorator to set REQUESTS_CA_BUNDLE.
35
36
    :param method: Method to use.
37
    :type method: function
38
    """
39
    def wrapper(*args, **kwargs):
40
        """
41
        Set REQUESTS_CA_BUNDLE before doing function.
42
        """
43
        os.environ["REQUESTS_CA_BUNDLE"] = grab_pem()
44
        return method(*args, **kwargs)
45
    return wrapper
46
47
48
@pem_wrapper
49
def get_length(url):
50
    """
51
    Get content-length header from some URL.
52
53
    :param url: The URL to check.
54
    :type url: str
55
    """
56
    if url is None:
57
        return 0
58
    try:
59
        heads = requests.head(url)
60
        fsize = heads.headers['content-length']
61
        return int(fsize)
62
    except requests.ConnectionError:
63
        return 0
64
65
66
@pem_wrapper
67
def download(url, output_directory=None):
68
    """
69
    Download file from given URL.
70
71
    :param url: URL to download from.
72
    :type url: str
73
74
    :param output_directory: Download folder. Default is local.
75
    :type output_directory: str
76
    """
77
    if output_directory is None:
78
        output_directory = os.getcwd()
79
    lfname = url.split('/')[-1]
80
    sname = utilities.stripper(lfname)
81
    fname = os.path.join(output_directory, lfname)
82
    with open(fname, "wb") as file:
83
        req = requests.get(url, stream=True)
84
        clength = req.headers['content-length']
85
        fsize = utilities.fsizer(clength)
86
        if req.status_code == 200:  # 200 OK
87
            print("DOWNLOADING {0} [{1}]".format(sname, fsize))
88
            for chunk in req.iter_content(chunk_size=1024):
89
                file.write(chunk)
90
        else:
91
            print("ERROR: HTTP {0} IN {1}".format(req.status_code, lfname))
92
    if os.stat(fname).st_size == 0:
93
        os.remove(fname)
94
95
def download_bootstrap(urls, outdir=None, workers=5):
96
    """
97
    Run downloaders for each file in given URL iterable.
98
99
    :param urls: URLs to download.
100
    :type urls: list
101
102
    :param outdir: Download folder. Default is handled in :func:`download`.
103
    :type outdir: str
104
105
    :param workers: Number of worker processes. Default is 5.
106
    :type workers: int
107
    """
108
    workers = len(urls) if len(urls) < workers else workers
109
    spinman = utilities.SpinManager()
110
    with concurrent.futures.ThreadPoolExecutor(max_workers=workers) as xec:
111
        try:
112
            spinman.start()
113
            for url in urls:
114
                xec.submit(download, url, outdir)
115
        except (KeyboardInterrupt, SystemExit):
116
            xec.shutdown()
117
            spinman.stop()
118
    spinman.stop()
119
    utilities.spinner_clear()
120
    utilities.line_begin()
121
122
123
def create_base_url(softwareversion):
124
    """
125
    Make the root URL for production server files.
126
127
    :param softwareversion: Software version to hash.
128
    :type softwareversion: str
129
    """
130
    # Hash software version
131
    swhash = hashlib.sha1(softwareversion.encode('utf-8'))
132
    hashedsoftwareversion = swhash.hexdigest()
133
    # Root of all urls
134
    baseurl = "http://cdn.fs.sl.blackberry.com/fs/qnx/production/" + hashedsoftwareversion
135
    return baseurl
136
137
138
@pem_wrapper
139
def availability(url):
140
    """
141
    Check HTTP status code of given URL.
142
    200 or 301-308 is OK, else is not.
143
144
    :param url: URL to check.
145
    :type url: str
146
    """
147
    try:
148
        avlty = requests.head(url)
149
        status = int(avlty.status_code)
150
        return status == 200 or 300 < status <= 308
151
    except requests.ConnectionError:
152
        return False
153
154
155
def clean_availability(results, server):
156
    """
157
    Clean availability for autolookup script.
158
159
    :param results: Result dict.
160
    :type results: dict(str: str)
161
162
    :param server: Server, key for result dict.
163
    :type server: str
164
    """
165
    marker = "PD" if server == "p" else server.upper()
166
    rel = results[server.lower()]
167
    avail = marker if rel != "SR not in system" and rel is not None else "  "
168
    return rel, avail
169
170
171
@pem_wrapper
172
def carrier_checker(mcc, mnc):
173
    """
174
    Query BlackBerry World to map a MCC and a MNC to a country and carrier.
175
176
    :param mcc: Country code.
177
    :type mcc: int
178
179
    :param mnc: Network code.
180
    :type mnc: int
181
    """
182
    url = "http://appworld.blackberry.com/ClientAPI/checkcarrier?homemcc={0}&homemnc={1}&devicevendorid=-1&pin=0".format(
183
        mcc, mnc)
184
    user_agent = {'User-agent': 'AppWorld/5.1.0.60'}
185
    req = requests.get(url, headers=user_agent)
186
    root = xml.etree.ElementTree.fromstring(req.text)
187
    for child in root:
188
        if child.tag == "country":
189
            country = child.get("name")
190
        if child.tag == "carrier":
191
            carrier = child.get("name")
192
    return country, carrier
193
194
195
def return_npc(mcc, mnc):
196
    """
197
    Format MCC and MNC into a NPC.
198
199
    :param mcc: Country code.
200
    :type mcc: int
201
202
    :param mnc: Network code.
203
    :type mnc: int
204
    """
205
    return "{0}{1}30".format(str(mcc).zfill(3), str(mnc).zfill(3))
206
207
208
@pem_wrapper
209
def carrier_query(npc, device, upgrade=False, blitz=False, forced=None):
210
    """
211
    Query BlackBerry servers, check which update is out for a carrier.
212
213
    :param npc: MCC + MNC (see `func:return_npc`)
214
    :type npc: int
215
216
    :param device: Hexadecimal hardware ID.
217
    :type device: str
218
219
    :param upgrade: Whether to use upgrade files. False by default.
220
    :type upgrade: bool
221
222
    :param blitz: Whether or not to create a blitz package. False by default.
223
    :type blitz: bool
224
225
    :param forced: Force a software release.
226
    :type forced: str
227
    """
228
    upg = "upgrade" if upgrade else "repair"
229
    forced = "latest" if forced is None else forced
230
    url = "https://cs.sl.blackberry.com/cse/updateDetails/2.2/"
231
    query = '<?xml version="1.0" encoding="UTF-8"?>'
232
    query += '<updateDetailRequest version="2.2.1" authEchoTS="1366644680359">'
233
    query += "<clientProperties>"
234
    query += "<hardware>"
235
    query += "<pin>0x2FFFFFB3</pin><bsn>1128121361</bsn>"
236
    query += "<imei>004401139269240</imei>"
237
    query += "<id>0x{0}</id>".format(device)
238
    query += "</hardware>"
239
    query += "<network>"
240
    query += "<homeNPC>0x{0}</homeNPC>".format(npc)
241
    query += "<iccid>89014104255505565333</iccid>"
242
    query += "</network>"
243
    query += "<software>"
244
    query += "<currentLocale>en_US</currentLocale>"
245
    query += "<legalLocale>en_US</legalLocale>"
246
    query += "</software>"
247
    query += "</clientProperties>"
248
    query += "<updateDirectives>"
249
    query += '<allowPatching type="REDBEND">true</allowPatching>'
250
    query += "<upgradeMode>{0}</upgradeMode>".format(upg)
251
    query += "<provideDescriptions>false</provideDescriptions>"
252
    query += "<provideFiles>true</provideFiles>"
253
    query += "<queryType>NOTIFICATION_CHECK</queryType>"
254
    query += "</updateDirectives>"
255
    query += "<pollType>manual</pollType>"
256
    query += "<resultPackageSetCriteria>"
257
    query += '<softwareRelease softwareReleaseVersion="{0}" />'.format(forced)
258
    query += "<releaseIndependent>"
259
    query += '<packageType operation="include">application</packageType>'
260
    query += "</releaseIndependent>"
261
    query += "</resultPackageSetCriteria>"
262
    query += "</updateDetailRequest>"
263
    header = {"Content-Type": "text/xml;charset=UTF-8"}
264
    req = requests.post(url, headers=header, data=query)
265
    return parse_carrier_xml(req.text, blitz)
266
267
268
def carrier_swver_get(root):
269
    """
270
    Get software release from carrier XML.
271
272
    :param root: ElementTree we're barking up.
273
    :type root: xml.etree.ElementTree.ElementTree
274
    """
275
    for child in root.iter("softwareReleaseMetadata"):
276
        swver = child.get("softwareReleaseVersion")
277
    return swver
278
279
280
def carrier_child_fileappend(child, files, baseurl, blitz=False):
281
    """
282
    Append bar file links to a list from a child element.
283
284
    :param child: Child element in use.
285
    :type child: xml.etree.ElementTree.Element
286
287
    :param files: Filelist.
288
    :type files: list(str)
289
290
    :param baseurl: Base URL, URL minus the filename.
291
    :type baseurl: str
292
293
    :param blitz: Whether or not to create a blitz package. False by default.
294
    :type blitz: bool
295
    """
296
    if not blitz:
297
        files.append(baseurl + child.get("path"))
298
    else:
299
        if child.get("type") not in ["system:radio", "system:desktop", "system:os"]:
300
            files.append(baseurl + child.get("path"))
301
    return files
302
303
304
def carrier_child_finder(root, files, baseurl, blitz=False):
305
    """
306
    Extract filenames, radio and OS from child elements.
307
308
    :param root: ElementTree we're barking up.
309
    :type root: xml.etree.ElementTree.ElementTree
310
311
    :param files: Filelist.
312
    :type files: list(str)
313
314
    :param baseurl: Base URL, URL minus the filename.
315
    :type baseurl: str
316
317
    :param blitz: Whether or not to create a blitz package. False by default.
318
    :type blitz: bool
319
    """
320
    osver = radver = ""
321
    for child in root.iter("package"):
322
        files = carrier_child_fileappend(child, files, baseurl, blitz)
323
        if child.get("type") == "system:radio":
324
            radver = child.get("version")
325
        elif child.get("type") == "system:desktop":
326
            osver = child.get("version")
327
        elif child.get("type") == "system:os":
328
            osver = child.get("version")
329
    return osver, radver, files
330
331
332
def parse_carrier_xml(data, blitz=False):
333
    """
334
    Parse the response to a carrier update request and return the juicy bits.
335
336
    :param data: The data to parse.
337
    :type data: xml
338
339
    :param blitz: Whether or not to create a blitz package. False by default.
340
    :type blitz: bool
341
    """
342
    root = xml.etree.ElementTree.fromstring(data)
343
    sw_exists = root.find('./data/content/softwareReleaseMetadata')
344
    swver = "N/A" if sw_exists is None else ""
345
    if sw_exists is not None:
346
        swver = carrier_swver_get(root)
347
    files = []
348
    package_exists = root.find('./data/content/fileSets/fileSet')
349
    osver = radver = ""
350
    if package_exists is not None:
351
        baseurl = "{0}/".format(package_exists.get("url"))
352
        osver, radver, files = carrier_child_finder(root, files, baseurl, blitz)
353
    return(swver, osver, radver, files)
354
355
356
@pem_wrapper
357
def sr_lookup(osver, server):
358
    """
359
    Software release lookup, with choice of server.
360
    :data:`bbarchivist.bbconstants.SERVERLIST` for server list.
361
362
    :param osver: OS version to lookup, 10.x.y.zzzz.
363
    :type osver: str
364
365
    :param server: Server to use.
366
    :type server: str
367
    """
368
    reg = re.compile(r"(\d{1,4}\.)(\d{1,4}\.)(\d{1,4}\.)(\d{1,4})")
369
    query = '<?xml version="1.0" encoding="UTF-8"?>'
370
    query += '<srVersionLookupRequest version="2.0.0"'
371
    query += ' authEchoTS="1366644680359">'
372
    query += '<clientProperties><hardware>'
373
    query += '<pin>0x2FFFFFB3</pin><bsn>1140011878</bsn>'
374
    query += '<imei>004402242176786</imei><id>0x8D00240A</id>'
375
    query += '<isBootROMSecure>true</isBootROMSecure>'
376
    query += '</hardware>'
377
    query += '<network>'
378
    query += '<vendorId>0x0</vendorId><homeNPC>0x60</homeNPC>'
379
    query += '<currentNPC>0x60</currentNPC><ecid>0x1</ecid>'
380
    query += '</network>'
381
    query += '<software><currentLocale>en_US</currentLocale>'
382
    query += '<legalLocale>en_US</legalLocale>'
383
    query += '<osVersion>{0}</osVersion>'.format(osver)
384
    query += '<omadmEnabled>false</omadmEnabled>'
385
    query += '</software></clientProperties>'
386
    query += '</srVersionLookupRequest>'
387
    header = {"Content-Type": "text/xml;charset=UTF-8"}
388
    try:
389
        req = requests.post(server, headers=header, data=query, timeout=1)
390
    except (requests.exceptions.Timeout, requests.exceptions.ConnectionError):
391
        return "SR not in system"
392
    try:
393
        root = xml.etree.ElementTree.fromstring(req.text)
394
    except xml.etree.ElementTree.ParseError:
395
        return "SR not in system"
396
    else:
397
        packages = root.findall('./data/content/')
398
        for package in packages:
399
            if package.text is not None:
400
                match = reg.match(package.text)
401
                if match:
402
                    return package.text
403
                else:
404
                    return "SR not in system"
405
406
407
def sr_lookup_bootstrap(osv):
408
    """
409
    Run lookups for each server for given OS.
410
411
    :param osv: OS to check.
412
    :type osv: str
413
    """
414
    with concurrent.futures.ThreadPoolExecutor(max_workers=5) as xec:
415
        try:
416
            results = {
417
                "p": None,
418
                "a1": None,
419
                "a2": None,
420
                "b1": None,
421
                "b2": None
422
            }
423
            for key in results:
424
                results[key] = xec.submit(sr_lookup, osv, SERVERS[key]).result()
425
            return results
426
        except KeyboardInterrupt:
427
            xec.shutdown(wait=False)
428
429
430
@pem_wrapper
431
def available_bundle_lookup(mcc, mnc, device):
432
    """
433
    Check which software releases were ever released for a carrier.
434
435
    :param mcc: Country code.
436
    :type mcc: int
437
438
    :param mnc: Network code.
439
    :type mnc: int
440
441
    :param device: Hexadecimal hardware ID.
442
    :type device: str
443
    """
444
    server = "https://cs.sl.blackberry.com/cse/availableBundles/1.0.0/"
445
    npc = return_npc(mcc, mnc)
446
    query = '<?xml version="1.0" encoding="UTF-8"?>'
447
    query += '<availableBundlesRequest version="1.0.0" '
448
    query += 'authEchoTS="1366644680359">'
449
    query += '<deviceId><pin>0x2FFFFFB3</pin></deviceId>'
450
    query += '<clientProperties><hardware><id>0x{0}</id>'.format(device)
451
    query += '<isBootROMSecure>true</isBootROMSecure></hardware>'
452
    query += '<network><vendorId>0x0</vendorId><homeNPC>0x{0}</homeNPC>'.format(npc)
453
    query += '<currentNPC>0x{0}</currentNPC></network><software>'.format(npc)
454
    query += '<currentLocale>en_US</currentLocale>'
455
    query += '<legalLocale>en_US</legalLocale>'
456
    query += '<osVersion>10.0.0.0</osVersion>'
457
    query += '<radioVersion>10.0.0.0</radioVersion></software>'
458
    query += '</clientProperties><updateDirectives><bundleVersionFilter>'
459
    query += '</bundleVersionFilter></updateDirectives>'
460
    query += '</availableBundlesRequest>'
461
    header = {"Content-Type": "text/xml;charset=UTF-8"}
462
    req = requests.post(server, headers=header, data=query)
463
    root = xml.etree.ElementTree.fromstring(req.text)
464
    package = root.find('./data/content')
465
    bundlelist = [child.attrib["version"] for child in package]
466
    return bundlelist
467
468
469
@pem_wrapper
470
def ptcrb_scraper(ptcrbid):
471
    """
472
    Get the PTCRB results for a given device.
473
474
    :param ptcrbid: Numerical ID from PTCRB (end of URL).
475
    :type ptcrbid: str
476
    """
477
    baseurl = "https://ptcrb.com/vendor/complete/view_complete_request_guest.cfm?modelid={0}".format(
478
        ptcrbid)
479
    req = requests.get(baseurl)
480
    soup = BeautifulSoup(req.content, 'html.parser')
481
    text = soup.get_text()
482
    text = text.replace("\r\n", " ")
483
    prelimlist = re.findall("OS .+[^\\n]", text, re.IGNORECASE)
484
    if not prelimlist:  # Priv
485
        prelimlist = re.findall(r"[A-Z]{3}[0-9]{3}[\s]", text)
486
    cleanlist = []
487
    for item in prelimlist:
488
        if not item.endswith("\r\n"):  # they should hire QC people...
489
            cleanlist.append(ptcrb_item_cleaner(item))
490
    return cleanlist
491
492
493
def ptcrb_item_cleaner(item):
494
    """
495
    Cleanup poorly formatted PTCRB entries written by an intern.
496
497
    :param item: The item to clean.
498
    :type item: str
499
    """
500
    item = item.replace("<td>", "")
501
    item = item.replace("</td>", "")
502
    item = item.replace("\n", "")
503
    item = item.replace(" (SR", ", SR")
504
    item = re.sub(r"\s?\((.*)$", "", item)
505
    item = re.sub(r"\sSV.*$", "", item)
506
    item = item.replace(")", "")
507
    item = item.replace(". ", ".")
508
    item = item.replace(";", "")
509
    item = item.replace("version", "Version")
510
    item = item.replace("Verison", "Version")
511
    if item.count("OS") > 1:
512
        templist = item.split("OS")
513
        templist[0] = "OS"
514
        item = "".join([templist[0], templist[1]])
515
    item = item.replace("SR", "SW Release")
516
    item = item.replace(" Version:", ":")
517
    item = item.replace("Version ", " ")
518
    item = item.replace(":1", ": 1")
519
    item = item.replace(", ", " ")
520
    item = item.replace("Software", "SW")
521
    item = item.replace("  ", " ")
522
    item = item.replace("OS ", "OS: ")
523
    item = item.replace("Radio ", "Radio: ")
524
    item = item.replace("Release ", "Release: ")
525
    spaclist = item.split(" ")
526
    if len(spaclist) > 1:
527
        while len(spaclist[1]) < 11:
528
            spaclist[1] += " "
529
        while len(spaclist[3]) < 11:
530
            spaclist[3] += " "
531
    else:
532
        spaclist.insert(0, "OS:")
533
    item = " ".join(spaclist)
534
    item = item.strip()
535
    return item
536
537
538
@pem_wrapper
539
def kernel_scraper(utils=False):
540
    """
541
    Scrape BlackBerry's GitHub kernel repo for available branches.
542
543
    :param utils: Check android-utils repo instead of android-linux-kernel. Default is False.
544
    :type utils: bool
545
    """
546
    repo = "android-utils" if utils else "android-linux-kernel"
547
    kernlist = []
548
    for page in range(1, 10):
549
        url = "https://github.com/blackberry/{0}/branches/all?page={1}".format(repo, page)
550
        req = requests.get(url)
551
        soup = BeautifulSoup(req.content, 'html.parser')
552
        if soup.find("div", {"class": "no-results-message"}):
553
            break
554
        else:
555
            text = soup.get_text()
556
            kernlist.extend(re.findall(r"msm[0-9]{4}\/[A-Z0-9]{6}", text, re.IGNORECASE))
557
    return kernlist
558
559
560
def root_generator(folder, build, variant="common"):
561
    """
562
    Generate roots for the SHAxxx hash lookup URLs.
563
564
    :param folder: Dictionary of variant: loader name pairs.
565
    :type folder: dict(str: str)
566
567
    :param build: Build to check, 3 letters + 3 numbers.
568
    :type build: str
569
570
    :param variant: Autoloader variant. Default is "common".
571
    :type variant: str
572
    """
573
    #Priv specific
574
    privx = "bbfoundation/hashfiles_priv/{0}".format(folder[variant])
575
    #DTEK50 specific
576
    dtek50x = "bbSupport/DTEK50" if build[:3] == "AAF" else "bbfoundation/hashfiles_priv/dtek50"
577
    #Pack it up
578
    roots = {"Priv": privx, "DTEK50": dtek50x}
579
    return roots
580
581
582
def make_droid_skeleton(method, build, device, variant="common"):
583
    """
584
    Make an Android autoloader/hash URL.
585
586
    :param method: None for regular OS links, "sha256/512" for SHA256 or 512 hash.
587
    :type method: str
588
589
    :param build: Build to check, 3 letters + 3 numbers.
590
    :type build: str
591
592
    :param device: Device to check.
593
    :type device: str
594
595
    :param variant: Autoloader variant. Default is "common".
596
    :type variant: str
597
    """
598
    folder = {"vzw-vzw": "verizon", "na-att": "att", "na-tmo": "tmo", "common": "default"}
599
    devices = {"Priv": "qc8992", "DTEK50": "qc8952_64_sfi"}
600
    roots = root_generator(folder, build, variant)
601
    base = "bbry_{2}_autoloader_user-{0}-{1}".format(variant, build.upper(), devices[device])
602
    if method is None:
603
        skel = "https://bbapps.download.blackberry.com/Priv/{0}.zip".format(base)
604
    else:
605
        skel = "http://ca.blackberry.com/content/dam/{1}/{0}.{2}sum".format(base, roots[device], method.lower())
606
    return skel
607
608
609
def bulk_droid_skeletons(devs, build, method=None):
610
    """
611
    Prepare list of Android autoloader/hash URLs.
612
613
    :param devs: List of devices.
614
    :type devs: list(str)
615
616
    :param build: Build to check, 3 letters + 3 numbers.
617
    :type build: str
618
619
    :param method: None for regular OS links, "sha256/512" for SHA256 or 512 hash.
620
    :type method: str
621
    """
622
    carrier_variants = ("common", "vzw-vzw", "na-tmo", "na-att")  # device variants
623
    common_variants = ("common", )  # no Americans
624
    carrier_devices = ("Priv", )  # may this list never expand in the future
625
    skels = []
626
    for dev in devs:
627
        varlist = carrier_variants if dev in carrier_devices else common_variants
628
        for var in varlist:
629
            skel = make_droid_skeleton(method, build, dev, var)
630
            skels.append(skel)
631
    return skels
632
633
634
def prepare_droid_list(device):
635
    """
636
    Convert single devices to a list, if necessary.
637
638
    :param device: Device to check.
639
    :type device: str
640
    """
641
    if isinstance(device, list):
642
        devs = device
643
    else:
644
        devs = []
645
        devs.append(device)
646
    return devs
647
648
649
def droid_scanner(build, device, method=None):
650
    """
651
    Check for Android autoloaders on BlackBerry's site.
652
653
    :param build: Build to check, 3 letters + 3 numbers.
654
    :type build: str
655
656
    :param device: Device to check.
657
    :type device: str
658
659
    :param method: None for regular OS links, "sha256/512" for SHA256 or 512 hash.
660
    :type method: str
661
    """
662
    devs = prepare_droid_list(device)
663
    skels = bulk_droid_skeletons(devs, build, method)
664
    with concurrent.futures.ThreadPoolExecutor(max_workers=len(skels)) as xec:
665
        results = []
666
        for skel in skels:
667
            avail = xec.submit(availability, skel)
668
            if avail.result():
669
                results.append(skel)
670
    return results if results else None
671
672
673
def chunker(iterable, inc):
674
    """
675
    Convert an iterable into a list of inc sized lists.
676
677
    :param chunker: Iterable to chunk.
678
    :type chunker: list
679
680
    :param inc: Increment; how big each chunk is.
681
    :type inc: int
682
    """
683
    chunks = [iterable[x:x+inc] for x in range(0, len(iterable), inc)]
684
    return chunks
685
686
687
def unicode_filter(intext):
688
    """
689
    Remove Unicode crap.
690
691
    :param intext: Text to filter.
692
    :type intext: str
693
    """
694
    return intext.replace("\u2013", "").strip()
695
696
697
def table_headers(pees):
698
    """
699
    Generate table headers from list of p tags.
700
701
    :param pees: List of p tags.
702
    :type pees: list(bs4.element.Tag)
703
    """
704
    bolds = [x for x in pees if x.find("b") and "BlackBerry" in x.text and not "experts" in x.text]
705
    bolds = [x.text for x in bolds]
706
    return bolds
707
708
709
def loader_page_scraper():
710
    """
711
    Return scraped autoloader page.
712
    """
713
    url = "http://ca.blackberry.com/content/blackberry-com/en_ca/support/smartphones/Android-OS-Reload.html"
714
    req = requests.get(url)
715
    soup = BeautifulSoup(req.content, "html.parser")
716
    tables = soup.find_all("table")
717
    headers = table_headers(soup.find_all("p"))
718
    for idx, table in enumerate(tables):
719
        print("~~~{0}~~~".format(headers[idx]))
720
        chunks = chunker(table.find_all("td"), 4)
721
        for chunk in chunks:
722
            key = unicode_filter(chunk[0].text)
723
            ver = unicode_filter(chunk[1].text)
724
            link = unicode_filter(chunk[2].find("a")["href"])
725
            print("{0}\n    {1}: {2}".format(key, ver, link))
726
        print(" ")
727
728
729
def base_metadata(url):
730
    """
731
    Get BBNDK metadata, base function.
732
    """
733
    req = requests.get(url)
734
    data = req.content
735
    entries = data.split(b"\n")
736
    metadata = [entry.split(b",")[1].decode("utf-8") for entry in entries if entry]
737
    return metadata
738
739
740
def ndk_metadata():
741
    """
742
    Get BBNDK target metadata.
743
    """
744
    data = base_metadata("http://downloads.blackberry.com/upr/developers/update/bbndk/metadata")
745
    metadata = [entry for entry in data if entry.startswith(("10.0", "10.1", "10.2"))]
746
    return metadata
747
748
749
def sim_metadata():
750
    """
751
    Get BBNDK simulator metadata.
752
    """
753
    metadata = base_metadata("http://downloads.blackberry.com/upr/developers/update/bbndk/simulator/simulator_metadata")
754
    return metadata
755
756
757
def runtime_metadata():
758
    """
759
    Get BBNDK runtime metadata.
760
    """
761
    metadata = base_metadata("http://downloads.blackberry.com/upr/developers/update/bbndk/runtime/runtime_metadata")
762
    return metadata
763
764
765
def series_generator(osversion):
766
    """
767
    Generate series/branch name from OS version.
768
769
    :param osversion: OS version.
770
    :type osversion: str
771
    """
772
    splits = osversion.split(".")
773
    return "BB{0}_{1}_{2}".format(*splits[0:3])
774
775
776
def devalpha_urls(osversion, skel):
777
    """
778
    Check individual Dev Alpha autoloader URLs.
779
780
    :param osversion: OS version.
781
    :type osversion: str
782
783
    :param skel: Individual skeleton format to try.
784
    :type skel: str
785
    """
786
    url = "http://downloads.blackberry.com/upr/developers/downloads/{0}{1}.exe".format(skel, osversion)
787
    req = requests.head(url)
788
    if req.status_code == 200:
789
        finals = (url, req.headers["content-length"])
790
    else:
791
        finals = ()
792
    return finals
793
794
795
def devalpha_urls_bootstrap(osversion, skeletons):
796
    """
797
    Get list of valid Dev Alpha autoloader URLs.
798
799
    :param osversion: OS version.
800
    :type osversion: str
801
802
    :param skeletons: List of skeleton formats to try.
803
    :type skeletons: list
804
    """
805
    with concurrent.futures.ThreadPoolExecutor(max_workers=5) as xec:
806
        try:
807
            finals = {}
808
            skels = skeletons
809
            for idx, skel in enumerate(skeletons):
810
                if "<SERIES>" in skel:
811
                    skels[idx] = skel.replace("<SERIES>", series_generator(osversion))
812
            for skel in skels:
813
                final = xec.submit(devalpha_urls, osversion, skel).result()
814
                if final:
815
                    finals[final[0]] = final[1]
816
            return finals
817
        except KeyboardInterrupt:
818
            xec.shutdown(wait=False)
819
820
821
def dev_dupe_cleaner(finals):
822
    """
823
    Clean duplicate autoloader entries.
824
825
    :param finals: Dict of URL:content-length pairs.
826
    :type finals: dict(str: str)
827
    """
828
    revo = {}
829
    for key, val in finals.items():
830
        revo.setdefault(val, set()).add(key)
831
    dupelist = [val for key, val in revo.items() if len(val) > 1]
832
    for dupe in dupelist:
833
        for entry in dupe:
834
            if "DevAlpha" in entry:
835
                del finals[entry]
836
    return finals
837