chiark / gitweb /
90fc291b1de04dc579d9813519d36ea43ce36b61
[fdroidserver.git] / fdroidserver / update.py
1 #!/usr/bin/env python3
2 #
3 # update.py - part of the FDroid server tools
4 # Copyright (C) 2016, Blue Jay Wireless
5 # Copyright (C) 2014-2016, Hans-Christoph Steiner <hans@eds.org>
6 # Copyright (C) 2010-2015, Ciaran Gultnieks <ciaran@ciarang.com>
7 # Copyright (C) 2013-2014, Daniel Martí <mvdan@mvdan.cc>
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU Affero General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 # GNU Affero General Public License for more details.
18 #
19 # You should have received a copy of the GNU Affero General Public License
20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
22 import sys
23 import os
24 import shutil
25 import glob
26 import re
27 import socket
28 import zipfile
29 import hashlib
30 import pickle
31 import time
32 from datetime import datetime
33 from argparse import ArgumentParser
34
35 import collections
36 from binascii import hexlify
37
38 from PIL import Image, PngImagePlugin
39 import logging
40
41 from . import _
42 from . import common
43 from . import index
44 from . import metadata
45 from .common import SdkToolsPopen
46 from .exception import BuildException, FDroidException
47
48 METADATA_VERSION = 19
49
50 # less than the valid range of versionCode, i.e. Java's Integer.MIN_VALUE
51 UNSET_VERSION_CODE = -0x100000000
52
53 APK_NAME_PAT = re.compile(".*name='([a-zA-Z0-9._]*)'.*")
54 APK_VERCODE_PAT = re.compile(".*versionCode='([0-9]*)'.*")
55 APK_VERNAME_PAT = re.compile(".*versionName='([^']*)'.*")
56 APK_LABEL_ICON_PAT = re.compile(".*\s+label='(.*)'\s+icon='(.*)'")
57 APK_SDK_VERSION_PAT = re.compile(".*'([0-9]*)'.*")
58 APK_PERMISSION_PAT = \
59     re.compile(".*(name='(?P<name>.*?)')(.*maxSdkVersion='(?P<maxSdkVersion>.*?)')?.*")
60 APK_FEATURE_PAT = re.compile(".*name='([^']*)'.*")
61
62 screen_densities = ['65534', '640', '480', '320', '240', '160', '120']
63 screen_resolutions = {
64     "xxxhdpi": '640',
65     "xxhdpi": '480',
66     "xhdpi": '320',
67     "hdpi": '240',
68     "mdpi": '160',
69     "ldpi": '120',
70     "undefined": '-1',
71     "anydpi": '65534',
72     "nodpi": '65535'
73 }
74
75 all_screen_densities = ['0'] + screen_densities
76
77 UsesPermission = collections.namedtuple('UsesPermission', ['name', 'maxSdkVersion'])
78 UsesPermissionSdk23 = collections.namedtuple('UsesPermissionSdk23', ['name', 'maxSdkVersion'])
79
80 ALLOWED_EXTENSIONS = ('png', 'jpg', 'jpeg')
81 GRAPHIC_NAMES = ('featureGraphic', 'icon', 'promoGraphic', 'tvBanner')
82 SCREENSHOT_DIRS = ('phoneScreenshots', 'sevenInchScreenshots',
83                    'tenInchScreenshots', 'tvScreenshots', 'wearScreenshots')
84
85 BLANK_PNG_INFO = PngImagePlugin.PngInfo()
86
87
88 def dpi_to_px(density):
89     return (int(density) * 48) / 160
90
91
92 def px_to_dpi(px):
93     return (int(px) * 160) / 48
94
95
96 def get_icon_dir(repodir, density):
97     if density == '0' or density == '65534':
98         return os.path.join(repodir, "icons")
99     else:
100         return os.path.join(repodir, "icons-%s" % density)
101
102
103 def get_icon_dirs(repodir):
104     for density in screen_densities:
105         yield get_icon_dir(repodir, density)
106
107
108 def get_all_icon_dirs(repodir):
109     for density in all_screen_densities:
110         yield get_icon_dir(repodir, density)
111
112
113 def update_wiki(apps, sortedids, apks):
114     """Update the wiki
115
116     :param apps: fully populated list of all applications
117     :param apks: all apks, except...
118     """
119     logging.info("Updating wiki")
120     wikicat = 'Apps'
121     wikiredircat = 'App Redirects'
122     import mwclient
123     site = mwclient.Site((config['wiki_protocol'], config['wiki_server']),
124                          path=config['wiki_path'])
125     site.login(config['wiki_user'], config['wiki_password'])
126     generated_pages = {}
127     generated_redirects = {}
128
129     for appid in sortedids:
130         app = metadata.App(apps[appid])
131
132         wikidata = ''
133         if app.Disabled:
134             wikidata += '{{Disabled|' + app.Disabled + '}}\n'
135         if app.AntiFeatures:
136             for af in sorted(app.AntiFeatures):
137                 wikidata += '{{AntiFeature|' + af + '}}\n'
138         if app.RequiresRoot:
139             requiresroot = 'Yes'
140         else:
141             requiresroot = 'No'
142         wikidata += '{{App|id=%s|name=%s|added=%s|lastupdated=%s|source=%s|tracker=%s|web=%s|changelog=%s|donate=%s|flattr=%s|liberapay=%s|bitcoin=%s|litecoin=%s|license=%s|root=%s|author=%s|email=%s}}\n' % (
143             appid,
144             app.Name,
145             app.added.strftime('%Y-%m-%d') if app.added else '',
146             app.lastUpdated.strftime('%Y-%m-%d') if app.lastUpdated else '',
147             app.SourceCode,
148             app.IssueTracker,
149             app.WebSite,
150             app.Changelog,
151             app.Donate,
152             app.FlattrID,
153             app.LiberapayID,
154             app.Bitcoin,
155             app.Litecoin,
156             app.License,
157             requiresroot,
158             app.AuthorName,
159             app.AuthorEmail)
160
161         if app.Provides:
162             wikidata += "This app provides: %s" % ', '.join(app.Summary.split(','))
163
164         wikidata += app.Summary
165         wikidata += " - [https://f-droid.org/repository/browse/?fdid=" + appid + " view in repository]\n\n"
166
167         wikidata += "=Description=\n"
168         wikidata += metadata.description_wiki(app.Description) + "\n"
169
170         wikidata += "=Maintainer Notes=\n"
171         if app.MaintainerNotes:
172             wikidata += metadata.description_wiki(app.MaintainerNotes) + "\n"
173         wikidata += "\nMetadata: [https://gitlab.com/fdroid/fdroiddata/blob/master/metadata/{0}.txt current] [https://gitlab.com/fdroid/fdroiddata/commits/master/metadata/{0}.txt history]\n".format(appid)
174
175         # Get a list of all packages for this application...
176         apklist = []
177         gotcurrentver = False
178         cantupdate = False
179         buildfails = False
180         for apk in apks:
181             if apk['packageName'] == appid:
182                 if str(apk['versionCode']) == app.CurrentVersionCode:
183                     gotcurrentver = True
184                 apklist.append(apk)
185         # Include ones we can't build, as a special case...
186         for build in app.builds:
187             if build.disable:
188                 if build.versionCode == app.CurrentVersionCode:
189                     cantupdate = True
190                 # TODO: Nasty: vercode is a string in the build, and an int elsewhere
191                 apklist.append({'versionCode': int(build.versionCode),
192                                 'versionName': build.versionName,
193                                 'buildproblem': "The build for this version was manually disabled. Reason: {0}".format(build.disable),
194                                 })
195             else:
196                 builtit = False
197                 for apk in apklist:
198                     if apk['versionCode'] == int(build.versionCode):
199                         builtit = True
200                         break
201                 if not builtit:
202                     buildfails = True
203                     apklist.append({'versionCode': int(build.versionCode),
204                                     'versionName': build.versionName,
205                                     'buildproblem': "The build for this version appears to have failed. Check the [[{0}/lastbuild_{1}|build log]].".format(appid, build.versionCode),
206                                     })
207         if app.CurrentVersionCode == '0':
208             cantupdate = True
209         # Sort with most recent first...
210         apklist = sorted(apklist, key=lambda apk: apk['versionCode'], reverse=True)
211
212         wikidata += "=Versions=\n"
213         if len(apklist) == 0:
214             wikidata += "We currently have no versions of this app available."
215         elif not gotcurrentver:
216             wikidata += "We don't have the current version of this app."
217         else:
218             wikidata += "We have the current version of this app."
219         wikidata += " (Check mode: " + app.UpdateCheckMode + ") "
220         wikidata += " (Auto-update mode: " + app.AutoUpdateMode + ")\n\n"
221         if len(app.NoSourceSince) > 0:
222             wikidata += "This application has partially or entirely been missing source code since version " + app.NoSourceSince + ".\n\n"
223         if len(app.CurrentVersion) > 0:
224             wikidata += "The current (recommended) version is " + app.CurrentVersion
225             wikidata += " (version code " + app.CurrentVersionCode + ").\n\n"
226         validapks = 0
227         for apk in apklist:
228             wikidata += "==" + apk['versionName'] + "==\n"
229
230             if 'buildproblem' in apk:
231                 wikidata += "We can't build this version: " + apk['buildproblem'] + "\n\n"
232             else:
233                 validapks += 1
234                 wikidata += "This version is built and signed by "
235                 if 'srcname' in apk:
236                     wikidata += "F-Droid, and guaranteed to correspond to the source tarball published with it.\n\n"
237                 else:
238                     wikidata += "the original developer.\n\n"
239             wikidata += "Version code: " + str(apk['versionCode']) + '\n'
240
241         wikidata += '\n[[Category:' + wikicat + ']]\n'
242         if len(app.NoSourceSince) > 0:
243             wikidata += '\n[[Category:Apps missing source code]]\n'
244         if validapks == 0 and not app.Disabled:
245             wikidata += '\n[[Category:Apps with no packages]]\n'
246         if cantupdate and not app.Disabled:
247             wikidata += "\n[[Category:Apps we cannot update]]\n"
248         if buildfails and not app.Disabled:
249             wikidata += "\n[[Category:Apps with failing builds]]\n"
250         elif not gotcurrentver and not cantupdate and not app.Disabled and app.UpdateCheckMode != "Static":
251             wikidata += '\n[[Category:Apps to Update]]\n'
252         if app.Disabled:
253             wikidata += '\n[[Category:Apps that are disabled]]\n'
254         if app.UpdateCheckMode == 'None' and not app.Disabled:
255             wikidata += '\n[[Category:Apps with no update check]]\n'
256         for appcat in app.Categories:
257             wikidata += '\n[[Category:{0}]]\n'.format(appcat)
258
259         # We can't have underscores in the page name, even if they're in
260         # the package ID, because MediaWiki messes with them...
261         pagename = appid.replace('_', ' ')
262
263         # Drop a trailing newline, because mediawiki is going to drop it anyway
264         # and it we don't we'll think the page has changed when it hasn't...
265         if wikidata.endswith('\n'):
266             wikidata = wikidata[:-1]
267
268         generated_pages[pagename] = wikidata
269
270         # Make a redirect from the name to the ID too, unless there's
271         # already an existing page with the name and it isn't a redirect.
272         noclobber = False
273         apppagename = app.Name.replace('_', ' ')
274         apppagename = apppagename.replace('{', '')
275         apppagename = apppagename.replace('}', ' ')
276         apppagename = apppagename.replace(':', ' ')
277         apppagename = apppagename.replace('[', ' ')
278         apppagename = apppagename.replace(']', ' ')
279         # Drop double spaces caused mostly by replacing ':' above
280         apppagename = apppagename.replace('  ', ' ')
281         for expagename in site.allpages(prefix=apppagename,
282                                         filterredir='nonredirects',
283                                         generator=False):
284             if expagename == apppagename:
285                 noclobber = True
286         # Another reason not to make the redirect page is if the app name
287         # is the same as it's ID, because that will overwrite the real page
288         # with an redirect to itself! (Although it seems like an odd
289         # scenario this happens a lot, e.g. where there is metadata but no
290         # builds or binaries to extract a name from.
291         if apppagename == pagename:
292             noclobber = True
293         if not noclobber:
294             generated_redirects[apppagename] = "#REDIRECT [[" + pagename + "]]\n[[Category:" + wikiredircat + "]]"
295
296     for tcat, genp in [(wikicat, generated_pages),
297                        (wikiredircat, generated_redirects)]:
298         catpages = site.Pages['Category:' + tcat]
299         existingpages = []
300         for page in catpages:
301             existingpages.append(page.name)
302             if page.name in genp:
303                 pagetxt = page.edit()
304                 if pagetxt != genp[page.name]:
305                     logging.debug("Updating modified page " + page.name)
306                     page.save(genp[page.name], summary='Auto-updated')
307                 else:
308                     logging.debug("Page " + page.name + " is unchanged")
309             else:
310                 logging.warn("Deleting page " + page.name)
311                 page.delete('No longer published')
312         for pagename, text in genp.items():
313             logging.debug("Checking " + pagename)
314             if pagename not in existingpages:
315                 logging.debug("Creating page " + pagename)
316                 try:
317                     newpage = site.Pages[pagename]
318                     newpage.save(text, summary='Auto-created')
319                 except Exception as e:
320                     logging.error("...FAILED to create page '{0}': {1}".format(pagename, e))
321
322     # Purge server cache to ensure counts are up to date
323     site.Pages['Repository Maintenance'].purge()
324
325     # Write a page with the last build log for this version code
326     wiki_page_path = 'update_' + time.strftime('%s', start_timestamp)
327     newpage = site.Pages[wiki_page_path]
328     txt = ''
329     txt += "* command line: <code>" + ' '.join(sys.argv) + "</code>\n"
330     txt += "* started at " + common.get_wiki_timestamp(start_timestamp) + '\n'
331     txt += "* completed at " + common.get_wiki_timestamp() + '\n'
332     txt += "\n\n"
333     txt += common.get_android_tools_version_log()
334     newpage.save(txt, summary='Run log')
335     newpage = site.Pages['update']
336     newpage.save('#REDIRECT [[' + wiki_page_path + ']]', summary='Update redirect')
337
338
339 def delete_disabled_builds(apps, apkcache, repodirs):
340     """Delete disabled build outputs.
341
342     :param apps: list of all applications, as per metadata.read_metadata
343     :param apkcache: current apk cache information
344     :param repodirs: the repo directories to process
345     """
346     for appid, app in apps.items():
347         for build in app['builds']:
348             if not build.disable:
349                 continue
350             apkfilename = common.get_release_filename(app, build)
351             iconfilename = "%s.%s.png" % (
352                 appid,
353                 build.versionCode)
354             for repodir in repodirs:
355                 files = [
356                     os.path.join(repodir, apkfilename),
357                     os.path.join(repodir, apkfilename + '.asc'),
358                     os.path.join(repodir, apkfilename[:-4] + "_src.tar.gz"),
359                 ]
360                 for density in all_screen_densities:
361                     repo_dir = get_icon_dir(repodir, density)
362                     files.append(os.path.join(repo_dir, iconfilename))
363
364                 for f in files:
365                     if os.path.exists(f):
366                         logging.info("Deleting disabled build output " + f)
367                         os.remove(f)
368             if apkfilename in apkcache:
369                 del apkcache[apkfilename]
370
371
372 def resize_icon(iconpath, density):
373
374     if not os.path.isfile(iconpath):
375         return
376
377     fp = None
378     try:
379         fp = open(iconpath, 'rb')
380         im = Image.open(fp)
381         size = dpi_to_px(density)
382
383         if any(length > size for length in im.size):
384             oldsize = im.size
385             im.thumbnail((size, size), Image.ANTIALIAS)
386             logging.debug("%s was too large at %s - new size is %s" % (
387                 iconpath, oldsize, im.size))
388             im.save(iconpath, "PNG", optimize=True,
389                     pnginfo=BLANK_PNG_INFO, icc_profile=None)
390
391     except Exception as e:
392         logging.error(_("Failed resizing {path}: {error}".format(path=iconpath, error=e)))
393
394     finally:
395         if fp:
396             fp.close()
397
398
399 def resize_all_icons(repodirs):
400     """Resize all icons that exceed the max size
401
402     :param repodirs: the repo directories to process
403     """
404     for repodir in repodirs:
405         for density in screen_densities:
406             icon_dir = get_icon_dir(repodir, density)
407             icon_glob = os.path.join(icon_dir, '*.png')
408             for iconpath in glob.glob(icon_glob):
409                 resize_icon(iconpath, density)
410
411
412 def getsig(apkpath):
413     """ Get the signing certificate of an apk. To get the same md5 has that
414     Android gets, we encode the .RSA certificate in a specific format and pass
415     it hex-encoded to the md5 digest algorithm.
416
417     :param apkpath: path to the apk
418     :returns: A string containing the md5 of the signature of the apk or None
419               if an error occurred.
420     """
421
422     with zipfile.ZipFile(apkpath, 'r') as apk:
423         certs = [n for n in apk.namelist() if common.CERT_PATH_REGEX.match(n)]
424
425         if len(certs) < 1:
426             logging.error(_("No signing certificates found in {path}").format(path=apkpath))
427             return None
428         if len(certs) > 1:
429             logging.error(_("Found multiple signing certificates in {path}").format(path=apkpath))
430             return None
431
432         cert = apk.read(certs[0])
433
434     cert_encoded = common.get_certificate(cert)
435
436     return hashlib.md5(hexlify(cert_encoded)).hexdigest()
437
438
439 def get_cache_file():
440     return os.path.join('tmp', 'apkcache')
441
442
443 def get_cache():
444     """Get the cached dict of the APK index
445
446     Gather information about all the apk files in the repo directory,
447     using cached data if possible. Some of the index operations take a
448     long time, like calculating the SHA-256 and verifying the APK
449     signature.
450
451     The cache is invalidated if the metadata version is different, or
452     the 'allow_disabled_algorithms' config/option is different.  In
453     those cases, there is no easy way to know what has changed from
454     the cache, so just rerun the whole thing.
455
456     :return: apkcache
457
458     """
459     apkcachefile = get_cache_file()
460     ada = options.allow_disabled_algorithms or config['allow_disabled_algorithms']
461     if not options.clean and os.path.exists(apkcachefile):
462         with open(apkcachefile, 'rb') as cf:
463             apkcache = pickle.load(cf, encoding='utf-8')
464         if apkcache.get("METADATA_VERSION") != METADATA_VERSION \
465            or apkcache.get('allow_disabled_algorithms') != ada:
466             apkcache = {}
467     else:
468         apkcache = {}
469
470     apkcache["METADATA_VERSION"] = METADATA_VERSION
471     apkcache['allow_disabled_algorithms'] = ada
472
473     return apkcache
474
475
476 def write_cache(apkcache):
477     apkcachefile = get_cache_file()
478     cache_path = os.path.dirname(apkcachefile)
479     if not os.path.exists(cache_path):
480         os.makedirs(cache_path)
481     with open(apkcachefile, 'wb') as cf:
482         pickle.dump(apkcache, cf)
483
484
485 def get_icon_bytes(apkzip, iconsrc):
486     '''ZIP has no official encoding, UTF-* and CP437 are defacto'''
487     try:
488         return apkzip.read(iconsrc)
489     except KeyError:
490         return apkzip.read(iconsrc.encode('utf-8').decode('cp437'))
491
492
493 def sha256sum(filename):
494     '''Calculate the sha256 of the given file'''
495     sha = hashlib.sha256()
496     with open(filename, 'rb') as f:
497         while True:
498             t = f.read(16384)
499             if len(t) == 0:
500                 break
501             sha.update(t)
502     return sha.hexdigest()
503
504
505 def has_known_vulnerability(filename):
506     """checks for known vulnerabilities in the APK
507
508     Checks OpenSSL .so files in the APK to see if they are a known vulnerable
509     version.  Google also enforces this:
510     https://support.google.com/faqs/answer/6376725?hl=en
511
512     Checks whether there are more than one classes.dex or AndroidManifest.xml
513     files, which is invalid and an essential part of the "Master Key" attack.
514     http://www.saurik.com/id/17
515
516     Janus is similar to Master Key but is perhaps easier to scan for.
517     https://www.guardsquare.com/en/blog/new-android-vulnerability-allows-attackers-modify-apps-without-affecting-their-signatures
518     """
519
520     found_vuln = False
521
522     # statically load this pattern
523     if not hasattr(has_known_vulnerability, "pattern"):
524         has_known_vulnerability.pattern = re.compile(b'.*OpenSSL ([01][0-9a-z.-]+)')
525
526     with open(filename.encode(), 'rb') as fp:
527         first4 = fp.read(4)
528     if first4 != b'\x50\x4b\x03\x04':
529         raise FDroidException(_('{path} has bad file signature "{pattern}", possible Janus exploit!')
530                               .format(path=filename, pattern=first4.decode().replace('\n', ' ')) + '\n'
531                               + 'https://www.guardsquare.com/en/blog/new-android-vulnerability-allows-attackers-modify-apps-without-affecting-their-signatures')
532
533     files_in_apk = set()
534     with zipfile.ZipFile(filename) as zf:
535         for name in zf.namelist():
536             if name.endswith('libcrypto.so') or name.endswith('libssl.so'):
537                 lib = zf.open(name)
538                 while True:
539                     chunk = lib.read(4096)
540                     if chunk == b'':
541                         break
542                     m = has_known_vulnerability.pattern.search(chunk)
543                     if m:
544                         version = m.group(1).decode('ascii')
545                         if (version.startswith('1.0.1') and len(version) > 5 and version[5] >= 'r') \
546                            or (version.startswith('1.0.2') and len(version) > 5 and version[5] >= 'f') \
547                            or re.match(r'[1-9]\.[1-9]\.[0-9].*', version):
548                             logging.debug(_('"{path}" contains recent {name} ({version})')
549                                           .format(path=filename, name=name, version=version))
550                         else:
551                             logging.warning(_('"{path}" contains outdated {name} ({version})')
552                                             .format(path=filename, name=name, version=version))
553                             found_vuln = True
554                         break
555             elif name == 'AndroidManifest.xml' or name == 'classes.dex' or name.endswith('.so'):
556                 if name in files_in_apk:
557                     logging.warning(_('{apkfilename} has multiple {name} files, looks like Master Key exploit!')
558                                     .format(apkfilename=filename, name=name))
559                     found_vuln = True
560                 files_in_apk.add(name)
561     return found_vuln
562
563
564 def insert_obbs(repodir, apps, apks):
565     """Scans the .obb files in a given repo directory and adds them to the
566     relevant APK instances.  OBB files have versionCodes like APK
567     files, and they are loosely associated.  If there is an OBB file
568     present, then any APK with the same or higher versionCode will use
569     that OBB file.  There are two OBB types: main and patch, each APK
570     can only have only have one of each.
571
572     https://developer.android.com/google/play/expansion-files.html
573
574     :param repodir: repo directory to scan
575     :param apps: list of current, valid apps
576     :param apks: current information on all APKs
577
578     """
579
580     def obbWarnDelete(f, msg):
581         logging.warning(msg + ' ' + f)
582         if options.delete_unknown:
583             logging.error(_("Deleting unknown file: {path}").format(path=f))
584             os.remove(f)
585
586     obbs = []
587     java_Integer_MIN_VALUE = -pow(2, 31)
588     currentPackageNames = apps.keys()
589     for f in glob.glob(os.path.join(repodir, '*.obb')):
590         obbfile = os.path.basename(f)
591         # obbfile looks like: [main|patch].<expansion-version>.<package-name>.obb
592         chunks = obbfile.split('.')
593         if chunks[0] != 'main' and chunks[0] != 'patch':
594             obbWarnDelete(f, _('OBB filename must start with "main." or "patch.":'))
595             continue
596         if not re.match(r'^-?[0-9]+$', chunks[1]):
597             obbWarnDelete(f, _('The OBB version code must come after "{name}.":')
598                           .format(name=chunks[0]))
599             continue
600         versionCode = int(chunks[1])
601         packagename = ".".join(chunks[2:-1])
602
603         highestVersionCode = java_Integer_MIN_VALUE
604         if packagename not in currentPackageNames:
605             obbWarnDelete(f, _("OBB's packagename does not match a supported APK:"))
606             continue
607         for apk in apks:
608             if packagename == apk['packageName'] and apk['versionCode'] > highestVersionCode:
609                 highestVersionCode = apk['versionCode']
610         if versionCode > highestVersionCode:
611             obbWarnDelete(f, _('OBB file has newer versionCode({integer}) than any APK:')
612                           .format(integer=str(versionCode)))
613             continue
614         obbsha256 = sha256sum(f)
615         obbs.append((packagename, versionCode, obbfile, obbsha256))
616
617     for apk in apks:
618         for (packagename, versionCode, obbfile, obbsha256) in sorted(obbs, reverse=True):
619             if versionCode <= apk['versionCode'] and packagename == apk['packageName']:
620                 if obbfile.startswith('main.') and 'obbMainFile' not in apk:
621                     apk['obbMainFile'] = obbfile
622                     apk['obbMainFileSha256'] = obbsha256
623                 elif obbfile.startswith('patch.') and 'obbPatchFile' not in apk:
624                     apk['obbPatchFile'] = obbfile
625                     apk['obbPatchFileSha256'] = obbsha256
626             if 'obbMainFile' in apk and 'obbPatchFile' in apk:
627                 break
628
629
630 def translate_per_build_anti_features(apps, apks):
631     """Grab the anti-features list from the build metadata
632
633     For most Anti-Features, they are really most applicable per-APK,
634     not for an app.  An app can fix a vulnerability, add/remove
635     tracking, etc.  This reads the 'antifeatures' list from the Build
636     entries in the fdroiddata metadata file, then transforms it into
637     the 'antiFeatures' list of unique items for the index.
638
639     The field key is all lower case in the metadata file to match the
640     rest of the Build fields.  It is 'antiFeatures' camel case in the
641     implementation, index, and fdroidclient since it is translated
642     from the build 'antifeatures' field, not directly included.
643
644     """
645
646     antiFeatures = dict()
647     for packageName, app in apps.items():
648         d = dict()
649         for build in app['builds']:
650             afl = build.get('antifeatures')
651             if afl:
652                 d[int(build.versionCode)] = afl
653         if len(d) > 0:
654             antiFeatures[packageName] = d
655
656     for apk in apks:
657         d = antiFeatures.get(apk['packageName'])
658         if d:
659             afl = d.get(apk['versionCode'])
660             if afl:
661                 apk['antiFeatures'].update(afl)
662
663
664 def _get_localized_dict(app, locale):
665     '''get the dict to add localized store metadata to'''
666     if 'localized' not in app:
667         app['localized'] = collections.OrderedDict()
668     if locale not in app['localized']:
669         app['localized'][locale] = collections.OrderedDict()
670     return app['localized'][locale]
671
672
673 def _set_localized_text_entry(app, locale, key, f):
674     limit = config['char_limits'][key]
675     localized = _get_localized_dict(app, locale)
676     with open(f) as fp:
677         text = fp.read()[:limit]
678         if len(text) > 0:
679             localized[key] = text
680
681
682 def _set_author_entry(app, key, f):
683     limit = config['char_limits']['author']
684     with open(f) as fp:
685         text = fp.read()[:limit]
686         if len(text) > 0:
687             app[key] = text
688
689
690 def _strip_and_copy_image(inpath, outpath):
691     """Remove any metadata from image and copy it to new path
692
693     Sadly, image metadata like EXIF can be used to exploit devices.
694     It is not used at all in the F-Droid ecosystem, so its much safer
695     just to remove it entirely.
696
697     """
698
699     extension = common.get_extension(inpath)[1]
700     if os.path.isdir(outpath):
701         outpath = os.path.join(outpath, os.path.basename(inpath))
702     if extension == 'png':
703         with open(inpath, 'rb') as fp:
704             in_image = Image.open(fp)
705             in_image.save(outpath, "PNG", optimize=True,
706                           pnginfo=BLANK_PNG_INFO, icc_profile=None)
707     elif extension == 'jpg' or extension == 'jpeg':
708         with open(inpath, 'rb') as fp:
709             in_image = Image.open(fp)
710             data = list(in_image.getdata())
711             out_image = Image.new(in_image.mode, in_image.size)
712         out_image.putdata(data)
713         out_image.save(outpath, "JPEG", optimize=True)
714     else:
715         raise FDroidException(_('Unsupported file type "{extension}" for repo graphic')
716                               .format(extension=extension))
717
718
719 def copy_triple_t_store_metadata(apps):
720     """Include store metadata from the app's source repo
721
722     The Triple-T Gradle Play Publisher is a plugin that has a standard
723     file layout for all of the metadata and graphics that the Google
724     Play Store accepts.  Since F-Droid has the git repo, it can just
725     pluck those files directly.  This method reads any text files into
726     the app dict, then copies any graphics into the fdroid repo
727     directory structure.
728
729     This needs to be run before insert_localized_app_metadata() so that
730     the graphics files that are copied into the fdroid repo get
731     properly indexed.
732
733     https://github.com/Triple-T/gradle-play-publisher#upload-images
734     https://github.com/Triple-T/gradle-play-publisher#play-store-metadata
735
736     """
737
738     if not os.path.isdir('build'):
739         return  # nothing to do
740
741     for packageName, app in apps.items():
742         for d in glob.glob(os.path.join('build', packageName, '*', 'src', '*', 'play')):
743             logging.debug('Triple-T Gradle Play Publisher: ' + d)
744             for root, dirs, files in os.walk(d):
745                 segments = root.split('/')
746                 locale = segments[-2]
747                 for f in files:
748                     if f == 'fulldescription':
749                         _set_localized_text_entry(app, locale, 'description',
750                                                   os.path.join(root, f))
751                         continue
752                     elif f == 'shortdescription':
753                         _set_localized_text_entry(app, locale, 'summary',
754                                                   os.path.join(root, f))
755                         continue
756                     elif f == 'title':
757                         _set_localized_text_entry(app, locale, 'name',
758                                                   os.path.join(root, f))
759                         continue
760                     elif f == 'video':
761                         _set_localized_text_entry(app, locale, 'video',
762                                                   os.path.join(root, f))
763                         continue
764                     elif f == 'whatsnew':
765                         _set_localized_text_entry(app, segments[-1], 'whatsNew',
766                                                   os.path.join(root, f))
767                         continue
768                     elif f == 'contactEmail':
769                         _set_author_entry(app, 'authorEmail', os.path.join(root, f))
770                         continue
771                     elif f == 'contactPhone':
772                         _set_author_entry(app, 'authorPhone', os.path.join(root, f))
773                         continue
774                     elif f == 'contactWebsite':
775                         _set_author_entry(app, 'authorWebSite', os.path.join(root, f))
776                         continue
777
778                     base, extension = common.get_extension(f)
779                     dirname = os.path.basename(root)
780                     if extension in ALLOWED_EXTENSIONS \
781                        and (dirname in GRAPHIC_NAMES or dirname in SCREENSHOT_DIRS):
782                         if segments[-2] == 'listing':
783                             locale = segments[-3]
784                         else:
785                             locale = segments[-2]
786                         destdir = os.path.join('repo', packageName, locale, dirname)
787                         os.makedirs(destdir, mode=0o755, exist_ok=True)
788                         sourcefile = os.path.join(root, f)
789                         destfile = os.path.join(destdir, os.path.basename(f))
790                         logging.debug('copying ' + sourcefile + ' ' + destfile)
791                         _strip_and_copy_image(sourcefile, destfile)
792
793
794 def insert_localized_app_metadata(apps):
795     """scans standard locations for graphics and localized text
796
797     Scans for localized description files, store graphics, and
798     screenshot PNG files in statically defined screenshots directory
799     and adds them to the app metadata.  The screenshots and graphic
800     must be PNG or JPEG files ending with ".png", ".jpg", or ".jpeg"
801     and must be in the following layout:
802     # TODO replace these docs with link to All_About_Descriptions_Graphics_and_Screenshots
803
804     repo/packageName/locale/featureGraphic.png
805     repo/packageName/locale/phoneScreenshots/1.png
806     repo/packageName/locale/phoneScreenshots/2.png
807
808     The changelog files must be text files named with the versionCode
809     ending with ".txt" and must be in the following layout:
810     https://github.com/fastlane/fastlane/blob/2.28.7/supply/README.md#changelogs-whats-new
811
812     repo/packageName/locale/changelogs/12345.txt
813
814     This will scan the each app's source repo then the metadata/ dir
815     for these standard locations of changelog files.  If it finds
816     them, they will be added to the dict of all packages, with the
817     versions in the metadata/ folder taking precendence over the what
818     is in the app's source repo.
819
820     Where "packageName" is the app's packageName and "locale" is the locale
821     of the graphics, e.g. what language they are in, using the IETF RFC5646
822     format (en-US, fr-CA, es-MX, etc).
823
824     This will also scan the app's git for a fastlane folder, and the
825     metadata/ folder and the apps' source repos for standard locations
826     of graphic and screenshot files.  If it finds them, it will copy
827     them into the repo.  The fastlane files follow this pattern:
828     https://github.com/fastlane/fastlane/blob/2.28.7/supply/README.md#images-and-screenshots
829
830     """
831
832     sourcedirs = glob.glob(os.path.join('build', '[A-Za-z]*', 'src', '[A-Za-z]*', 'fastlane', 'metadata', 'android', '[a-z][a-z]*'))
833     sourcedirs += glob.glob(os.path.join('build', '[A-Za-z]*', 'fastlane', 'metadata', 'android', '[a-z][a-z]*'))
834     sourcedirs += glob.glob(os.path.join('build', '[A-Za-z]*', 'metadata', '[a-z][a-z]*'))
835     sourcedirs += glob.glob(os.path.join('metadata', '[A-Za-z]*', '[a-z][a-z]*'))
836
837     for srcd in sorted(sourcedirs):
838         if not os.path.isdir(srcd):
839             continue
840         for root, dirs, files in os.walk(srcd):
841             segments = root.split('/')
842             packageName = segments[1]
843             if packageName not in apps:
844                 logging.debug(packageName + ' does not have app metadata, skipping l18n scan.')
845                 continue
846             locale = segments[-1]
847             destdir = os.path.join('repo', packageName, locale)
848
849             # flavours specified in build receipt
850             build_flavours = ""
851             if apps[packageName] and 'builds' in apps[packageName] and len(apps[packageName].builds) > 0\
852                     and 'gradle' in apps[packageName].builds[-1]:
853                 build_flavours = apps[packageName].builds[-1].gradle
854
855             if len(segments) >= 5 and segments[4] == "fastlane" and segments[3] not in build_flavours:
856                 logging.debug("ignoring due to wrong flavour")
857                 continue
858
859             for f in files:
860                 if f in ('description.txt', 'full_description.txt'):
861                     _set_localized_text_entry(apps[packageName], locale, 'description',
862                                               os.path.join(root, f))
863                     continue
864                 elif f in ('summary.txt', 'short_description.txt'):
865                     _set_localized_text_entry(apps[packageName], locale, 'summary',
866                                               os.path.join(root, f))
867                     continue
868                 elif f in ('name.txt', 'title.txt'):
869                     _set_localized_text_entry(apps[packageName], locale, 'name',
870                                               os.path.join(root, f))
871                     continue
872                 elif f == 'video.txt':
873                     _set_localized_text_entry(apps[packageName], locale, 'video',
874                                               os.path.join(root, f))
875                     continue
876                 elif f == str(apps[packageName]['CurrentVersionCode']) + '.txt':
877                     locale = segments[-2]
878                     _set_localized_text_entry(apps[packageName], locale, 'whatsNew',
879                                               os.path.join(root, f))
880                     continue
881
882                 base, extension = common.get_extension(f)
883                 if locale == 'images':
884                     locale = segments[-2]
885                     destdir = os.path.join('repo', packageName, locale)
886                 if base in GRAPHIC_NAMES and extension in ALLOWED_EXTENSIONS:
887                     os.makedirs(destdir, mode=0o755, exist_ok=True)
888                     logging.debug('copying ' + os.path.join(root, f) + ' ' + destdir)
889                     _strip_and_copy_image(os.path.join(root, f), destdir)
890             for d in dirs:
891                 if d in SCREENSHOT_DIRS:
892                     if locale == 'images':
893                         locale = segments[-2]
894                         destdir = os.path.join('repo', packageName, locale)
895                     for f in glob.glob(os.path.join(root, d, '*.*')):
896                         _ignored, extension = common.get_extension(f)
897                         if extension in ALLOWED_EXTENSIONS:
898                             screenshotdestdir = os.path.join(destdir, d)
899                             os.makedirs(screenshotdestdir, mode=0o755, exist_ok=True)
900                             logging.debug('copying ' + f + ' ' + screenshotdestdir)
901                             _strip_and_copy_image(f, screenshotdestdir)
902
903     repofiles = sorted(glob.glob(os.path.join('repo', '[A-Za-z]*', '[a-z][a-z][A-Z-.@]*')))
904     for d in repofiles:
905         if not os.path.isdir(d):
906             continue
907         for f in sorted(glob.glob(os.path.join(d, '*.*')) + glob.glob(os.path.join(d, '*Screenshots', '*.*'))):
908             if not os.path.isfile(f):
909                 continue
910             segments = f.split('/')
911             packageName = segments[1]
912             locale = segments[2]
913             screenshotdir = segments[3]
914             filename = os.path.basename(f)
915             base, extension = common.get_extension(filename)
916
917             if packageName not in apps:
918                 logging.warning(_('Found "{path}" graphic without metadata for app "{name}"!')
919                                 .format(path=filename, name=packageName))
920                 continue
921             graphics = _get_localized_dict(apps[packageName], locale)
922
923             if extension not in ALLOWED_EXTENSIONS:
924                 logging.warning(_('Only PNG and JPEG are supported for graphics, found: {path}').format(path=f))
925             elif base in GRAPHIC_NAMES:
926                 # there can only be zero or one of these per locale
927                 graphics[base] = filename
928             elif screenshotdir in SCREENSHOT_DIRS:
929                 # there can any number of these per locale
930                 logging.debug(_('adding to {name}: {path}').format(name=screenshotdir, path=f))
931                 if screenshotdir not in graphics:
932                     graphics[screenshotdir] = []
933                 graphics[screenshotdir].append(filename)
934             else:
935                 logging.warning(_('Unsupported graphics file found: {path}').format(path=f))
936
937
938 def scan_repo_files(apkcache, repodir, knownapks, use_date_from_file=False):
939     """Scan a repo for all files with an extension except APK/OBB
940
941     :param apkcache: current cached info about all repo files
942     :param repodir: repo directory to scan
943     :param knownapks: list of all known files, as per metadata.read_metadata
944     :param use_date_from_file: use date from file (instead of current date)
945                                for newly added files
946     """
947
948     cachechanged = False
949     repo_files = []
950     repodir = repodir.encode('utf-8')
951     for name in os.listdir(repodir):
952         file_extension = common.get_file_extension(name)
953         if file_extension == 'apk' or file_extension == 'obb':
954             continue
955         filename = os.path.join(repodir, name)
956         name_utf8 = name.decode('utf-8')
957         if filename.endswith(b'_src.tar.gz'):
958             logging.debug(_('skipping source tarball: {path}')
959                           .format(path=filename.decode('utf-8')))
960             continue
961         if not common.is_repo_file(filename):
962             continue
963         stat = os.stat(filename)
964         if stat.st_size == 0:
965             raise FDroidException(_('{path} is zero size!')
966                                   .format(path=filename))
967
968         shasum = sha256sum(filename)
969         usecache = False
970         if name in apkcache:
971             repo_file = apkcache[name]
972             # added time is cached as tuple but used here as datetime instance
973             if 'added' in repo_file:
974                 a = repo_file['added']
975                 if isinstance(a, datetime):
976                     repo_file['added'] = a
977                 else:
978                     repo_file['added'] = datetime(*a[:6])
979             if repo_file.get('hash') == shasum:
980                 logging.debug(_("Reading {apkfilename} from cache")
981                               .format(apkfilename=name_utf8))
982                 usecache = True
983             else:
984                 logging.debug(_("Ignoring stale cache data for {apkfilename}")
985                               .format(apkfilename=name_utf8))
986
987         if not usecache:
988             logging.debug(_("Processing {apkfilename}").format(apkfilename=name_utf8))
989             repo_file = collections.OrderedDict()
990             repo_file['name'] = os.path.splitext(name_utf8)[0]
991             # TODO rename apkname globally to something more generic
992             repo_file['apkName'] = name_utf8
993             repo_file['hash'] = shasum
994             repo_file['hashType'] = 'sha256'
995             repo_file['versionCode'] = 0
996             repo_file['versionName'] = shasum
997             # the static ID is the SHA256 unless it is set in the metadata
998             repo_file['packageName'] = shasum
999
1000             m = common.STANDARD_FILE_NAME_REGEX.match(name_utf8)
1001             if m:
1002                 repo_file['packageName'] = m.group(1)
1003                 repo_file['versionCode'] = int(m.group(2))
1004             srcfilename = name + b'_src.tar.gz'
1005             if os.path.exists(os.path.join(repodir, srcfilename)):
1006                 repo_file['srcname'] = srcfilename.decode('utf-8')
1007             repo_file['size'] = stat.st_size
1008
1009             apkcache[name] = repo_file
1010             cachechanged = True
1011
1012         if use_date_from_file:
1013             timestamp = stat.st_ctime
1014             default_date_param = time.gmtime(time.mktime(datetime.fromtimestamp(timestamp).timetuple()))
1015         else:
1016             default_date_param = None
1017
1018         # Record in knownapks, getting the added date at the same time..
1019         added = knownapks.recordapk(repo_file['apkName'], repo_file['packageName'],
1020                                     default_date=default_date_param)
1021         if added:
1022             repo_file['added'] = added
1023
1024         repo_files.append(repo_file)
1025
1026     return repo_files, cachechanged
1027
1028
1029 def scan_apk(apk_file):
1030     """
1031     Scans an APK file and returns dictionary with metadata of the APK.
1032
1033     Attention: This does *not* verify that the APK signature is correct.
1034
1035     :param apk_file: The (ideally absolute) path to the APK file
1036     :raises BuildException
1037     :return A dict containing APK metadata
1038     """
1039     apk = {
1040         'hash': sha256sum(apk_file),
1041         'hashType': 'sha256',
1042         'uses-permission': [],
1043         'uses-permission-sdk-23': [],
1044         'features': [],
1045         'icons_src': {},
1046         'icons': {},
1047         'antiFeatures': set(),
1048     }
1049
1050     if common.use_androguard():
1051         scan_apk_androguard(apk, apk_file)
1052     else:
1053         scan_apk_aapt(apk, apk_file)
1054
1055     # Get the signature, or rather the signing key fingerprints
1056     logging.debug('Getting signature of {0}'.format(os.path.basename(apk_file)))
1057     apk['sig'] = getsig(apk_file)
1058     if not apk['sig']:
1059         raise BuildException("Failed to get apk signature")
1060     apk['signer'] = common.apk_signer_fingerprint(os.path.join(os.getcwd(),
1061                                                                apk_file))
1062     if not apk.get('signer'):
1063         raise BuildException("Failed to get apk signing key fingerprint")
1064
1065     # Get size of the APK
1066     apk['size'] = os.path.getsize(apk_file)
1067
1068     if 'minSdkVersion' not in apk:
1069         logging.warning("No SDK version information found in {0}".format(apk_file))
1070         apk['minSdkVersion'] = 3  # aapt defaults to 3 as the min
1071     if 'targetSdkVersion' not in apk:
1072         apk['targetSdkVersion'] = apk['minSdkVersion']
1073
1074     # Check for known vulnerabilities
1075     if has_known_vulnerability(apk_file):
1076         apk['antiFeatures'].add('KnownVuln')
1077
1078     return apk
1079
1080
1081 def _get_apk_icons_src(apkfile, icon_name):
1082     """Extract the paths to the app icon in all available densities
1083
1084     """
1085     icons_src = dict()
1086     density_re = re.compile('^res/(.*)/' + icon_name + '\.(png|xml)$')
1087     with zipfile.ZipFile(apkfile) as zf:
1088         for filename in zf.namelist():
1089             m = density_re.match(filename)
1090             if m:
1091                 folder = m.group(1).split('-')
1092                 if len(folder) > 1:
1093                     density = screen_resolutions[folder[1]]
1094                 else:
1095                     density = '160'
1096                 icons_src[density] = m.group(0)
1097     if icons_src.get('-1') is None:
1098         icons_src['-1'] = icons_src['160']
1099     return icons_src
1100
1101
1102 def scan_apk_aapt(apk, apkfile):
1103     p = SdkToolsPopen(['aapt', 'dump', 'badging', apkfile], output=False)
1104     if p.returncode != 0:
1105         if options.delete_unknown:
1106             if os.path.exists(apkfile):
1107                 logging.error(_("Failed to get apk information, deleting {path}").format(path=apkfile))
1108                 os.remove(apkfile)
1109             else:
1110                 logging.error("Could not find {0} to remove it".format(apkfile))
1111         else:
1112             logging.error(_("Failed to get apk information, skipping {path}").format(path=apkfile))
1113         raise BuildException(_("Invalid APK"))
1114     icon_name = None
1115     for line in p.output.splitlines():
1116         if line.startswith("package:"):
1117             try:
1118                 apk['packageName'] = re.match(APK_NAME_PAT, line).group(1)
1119                 apk['versionCode'] = int(re.match(APK_VERCODE_PAT, line).group(1))
1120                 apk['versionName'] = re.match(APK_VERNAME_PAT, line).group(1)
1121             except Exception as e:
1122                 raise FDroidException("Package matching failed: " + str(e) + "\nLine was: " + line)
1123         elif line.startswith("application:"):
1124             m = re.match(APK_LABEL_ICON_PAT, line)
1125             if m:
1126                 apk['name'] = m.group(1)
1127                 icon_name = os.path.splitext(os.path.basename(m.group(2)))[0]
1128         elif not apk.get('name') and line.startswith("launchable-activity:"):
1129             # Only use launchable-activity as fallback to application
1130             apk['name'] = re.match(APK_LABEL_ICON_PAT, line).group(1)
1131         elif line.startswith("sdkVersion:"):
1132             m = re.match(APK_SDK_VERSION_PAT, line)
1133             if m is None:
1134                 logging.error(line.replace('sdkVersion:', '')
1135                               + ' is not a valid minSdkVersion!')
1136             else:
1137                 apk['minSdkVersion'] = m.group(1)
1138         elif line.startswith("targetSdkVersion:"):
1139             m = re.match(APK_SDK_VERSION_PAT, line)
1140             if m is None:
1141                 logging.error(line.replace('targetSdkVersion:', '')
1142                               + ' is not a valid targetSdkVersion!')
1143             else:
1144                 apk['targetSdkVersion'] = m.group(1)
1145         elif line.startswith("maxSdkVersion:"):
1146             apk['maxSdkVersion'] = re.match(APK_SDK_VERSION_PAT, line).group(1)
1147         elif line.startswith("native-code:"):
1148             apk['nativecode'] = []
1149             for arch in line[13:].split(' '):
1150                 apk['nativecode'].append(arch[1:-1])
1151         elif line.startswith('uses-permission:'):
1152             perm_match = re.match(APK_PERMISSION_PAT, line).groupdict()
1153             if perm_match['maxSdkVersion']:
1154                 perm_match['maxSdkVersion'] = int(perm_match['maxSdkVersion'])
1155             permission = UsesPermission(
1156                 perm_match['name'],
1157                 perm_match['maxSdkVersion']
1158             )
1159
1160             apk['uses-permission'].append(permission)
1161         elif line.startswith('uses-permission-sdk-23:'):
1162             perm_match = re.match(APK_PERMISSION_PAT, line).groupdict()
1163             if perm_match['maxSdkVersion']:
1164                 perm_match['maxSdkVersion'] = int(perm_match['maxSdkVersion'])
1165             permission_sdk_23 = UsesPermissionSdk23(
1166                 perm_match['name'],
1167                 perm_match['maxSdkVersion']
1168             )
1169
1170             apk['uses-permission-sdk-23'].append(permission_sdk_23)
1171
1172         elif line.startswith('uses-feature:'):
1173             feature = re.match(APK_FEATURE_PAT, line).group(1)
1174             # Filter out this, it's only added with the latest SDK tools and
1175             # causes problems for lots of apps.
1176             if feature != "android.hardware.screen.portrait" \
1177                     and feature != "android.hardware.screen.landscape":
1178                 if feature.startswith("android.feature."):
1179                     feature = feature[16:]
1180                 apk['features'].add(feature)
1181     apk['icons_src'] = _get_apk_icons_src(apkfile, icon_name)
1182
1183
1184 def scan_apk_androguard(apk, apkfile):
1185     try:
1186         from androguard.core.bytecodes.apk import APK
1187         apkobject = APK(apkfile)
1188         if apkobject.is_valid_APK():
1189             arsc = apkobject.get_android_resources()
1190         else:
1191             if options.delete_unknown:
1192                 if os.path.exists(apkfile):
1193                     logging.error(_("Failed to get apk information, deleting {path}")
1194                                   .format(path=apkfile))
1195                     os.remove(apkfile)
1196                 else:
1197                     logging.error(_("Could not find {path} to remove it")
1198                                   .format(path=apkfile))
1199             else:
1200                 logging.error(_("Failed to get apk information, skipping {path}")
1201                               .format(path=apkfile))
1202             raise BuildException(_("Invalid APK"))
1203     except ImportError:
1204         raise FDroidException("androguard library is not installed and aapt not present")
1205     except FileNotFoundError:
1206         logging.error(_("Could not open apk file for analysis"))
1207         raise BuildException(_("Invalid APK"))
1208
1209     apk['packageName'] = apkobject.get_package()
1210     apk['versionCode'] = int(apkobject.get_androidversion_code())
1211     apk['versionName'] = apkobject.get_androidversion_name()
1212     if apk['versionName'][0] == "@":
1213         version_id = int(apk['versionName'].replace("@", "0x"), 16)
1214         version_id = arsc.get_id(apk['packageName'], version_id)[1]
1215         apk['versionName'] = arsc.get_string(apk['packageName'], version_id)[1]
1216     apk['name'] = apkobject.get_app_name()
1217
1218     if apkobject.get_max_sdk_version() is not None:
1219         apk['maxSdkVersion'] = apkobject.get_max_sdk_version()
1220     if apkobject.get_min_sdk_version() is not None:
1221         apk['minSdkVersion'] = apkobject.get_min_sdk_version()
1222     if apkobject.get_target_sdk_version() is not None:
1223         apk['targetSdkVersion'] = apkobject.get_target_sdk_version()
1224
1225     icon_id = int(apkobject.get_element("application", "icon").replace("@", "0x"), 16)
1226     icon_name = arsc.get_id(apk['packageName'], icon_id)[1]
1227     apk['icons_src'] = _get_apk_icons_src(apkfile, icon_name)
1228
1229     arch_re = re.compile("^lib/(.*)/.*$")
1230     arch = set([arch_re.match(file).group(1) for file in apkobject.get_files() if arch_re.match(file)])
1231     if len(arch) >= 1:
1232         apk['nativecode'] = []
1233         apk['nativecode'].extend(sorted(list(arch)))
1234
1235     xml = apkobject.get_android_manifest_xml()
1236
1237     for item in xml.findall('uses-permission'):
1238         name = str(item.attrib['{' + xml.nsmap['android'] + '}name'])
1239         maxSdkVersion = item.attrib.get('{' + xml.nsmap['android'] + '}maxSdkVersion')
1240         maxSdkVersion = int(maxSdkVersion) if maxSdkVersion else None
1241         permission = UsesPermission(
1242             name,
1243             maxSdkVersion
1244         )
1245         apk['uses-permission'].append(permission)
1246     for name, maxSdkVersion in apkobject.get_uses_implied_permission_list():
1247         permission = UsesPermission(
1248             name,
1249             maxSdkVersion
1250         )
1251         apk['uses-permission'].append(permission)
1252
1253     for item in xml.findall('uses-permission-sdk-23'):
1254         name = str(item.attrib['{' + xml.nsmap['android'] + '}name'])
1255         maxSdkVersion = item.attrib.get('{' + xml.nsmap['android'] + '}maxSdkVersion')
1256         maxSdkVersion = int(maxSdkVersion) if maxSdkVersion else None
1257         permission_sdk_23 = UsesPermissionSdk23(
1258             name,
1259             maxSdkVersion
1260         )
1261         apk['uses-permission-sdk-23'].append(permission_sdk_23)
1262
1263     for item in xml.findall('uses-feature'):
1264         feature = str(item.attrib['{' + xml.nsmap['android'] + '}name'])
1265         if feature != "android.hardware.screen.portrait" \
1266                 and feature != "android.hardware.screen.landscape":
1267             if feature.startswith("android.feature."):
1268                 feature = feature[16:]
1269         required = item.attrib.get('{' + xml.nsmap['android'] + '}required')
1270         if required is None or required == 'true':
1271             apk['features'].append(feature)
1272
1273
1274 def process_apk(apkcache, apkfilename, repodir, knownapks, use_date_from_apk=False,
1275                 allow_disabled_algorithms=False, archive_bad_sig=False):
1276     """Processes the apk with the given filename in the given repo directory.
1277
1278     This also extracts the icons.
1279
1280     :param apkcache: current apk cache information
1281     :param apkfilename: the filename of the apk to scan
1282     :param repodir: repo directory to scan
1283     :param knownapks: known apks info
1284     :param use_date_from_apk: use date from APK (instead of current date)
1285                               for newly added APKs
1286     :param allow_disabled_algorithms: allow APKs with valid signatures that include
1287                                       disabled algorithms in the signature (e.g. MD5)
1288     :param archive_bad_sig: move APKs with a bad signature to the archive
1289     :returns: (skip, apk, cachechanged) where skip is a boolean indicating whether to skip this apk,
1290      apk is the scanned apk information, and cachechanged is True if the apkcache got changed.
1291     """
1292
1293     apk = {}
1294     apkfile = os.path.join(repodir, apkfilename)
1295
1296     cachechanged = False
1297     usecache = False
1298     if apkfilename in apkcache:
1299         apk = apkcache[apkfilename]
1300         if apk.get('hash') == sha256sum(apkfile):
1301             logging.debug(_("Reading {apkfilename} from cache")
1302                           .format(apkfilename=apkfilename))
1303             usecache = True
1304         else:
1305             logging.debug(_("Ignoring stale cache data for {apkfilename}")
1306                           .format(apkfilename=apkfilename))
1307
1308     if not usecache:
1309         logging.debug(_("Processing {apkfilename}").format(apkfilename=apkfilename))
1310
1311         try:
1312             apk = scan_apk(apkfile)
1313         except BuildException:
1314             logging.warning(_("Skipping '{apkfilename}' with invalid signature!")
1315                             .format(apkfilename=apkfilename))
1316             return True, None, False
1317
1318         # Check for debuggable apks...
1319         if common.is_apk_and_debuggable(apkfile):
1320             logging.warning('{0} is set to android:debuggable="true"'.format(apkfile))
1321
1322         if options.rename_apks:
1323             n = apk['packageName'] + '_' + str(apk['versionCode']) + '.apk'
1324             std_short_name = os.path.join(repodir, n)
1325             if apkfile != std_short_name:
1326                 if os.path.exists(std_short_name):
1327                     std_long_name = std_short_name.replace('.apk', '_' + apk['sig'][:7] + '.apk')
1328                     if apkfile != std_long_name:
1329                         if os.path.exists(std_long_name):
1330                             dupdir = os.path.join('duplicates', repodir)
1331                             if not os.path.isdir(dupdir):
1332                                 os.makedirs(dupdir, exist_ok=True)
1333                             dupfile = os.path.join('duplicates', std_long_name)
1334                             logging.warning('Moving duplicate ' + std_long_name + ' to ' + dupfile)
1335                             os.rename(apkfile, dupfile)
1336                             return True, None, False
1337                         else:
1338                             os.rename(apkfile, std_long_name)
1339                     apkfile = std_long_name
1340                 else:
1341                     os.rename(apkfile, std_short_name)
1342                     apkfile = std_short_name
1343                 apkfilename = apkfile[len(repodir) + 1:]
1344
1345         apk['apkName'] = apkfilename
1346         srcfilename = apkfilename[:-4] + "_src.tar.gz"
1347         if os.path.exists(os.path.join(repodir, srcfilename)):
1348             apk['srcname'] = srcfilename
1349
1350         # verify the jar signature is correct, allow deprecated
1351         # algorithms only if the APK is in the archive.
1352         skipapk = False
1353         if not common.verify_apk_signature(apkfile):
1354             if repodir == 'archive' or allow_disabled_algorithms:
1355                 if common.verify_old_apk_signature(apkfile):
1356                     apk['antiFeatures'].update(['KnownVuln', 'DisabledAlgorithm'])
1357                 else:
1358                     skipapk = True
1359             else:
1360                 skipapk = True
1361
1362         if skipapk:
1363             if archive_bad_sig:
1364                 logging.warning(_('Archiving {apkfilename} with invalid signature!')
1365                                 .format(apkfilename=apkfilename))
1366                 move_apk_between_sections(repodir, 'archive', apk)
1367             else:
1368                 logging.warning(_('Skipping {apkfilename} with invalid signature!')
1369                                 .format(apkfilename=apkfilename))
1370             return True, None, False
1371
1372         apkzip = zipfile.ZipFile(apkfile, 'r')
1373
1374         manifest = apkzip.getinfo('AndroidManifest.xml')
1375         # 1980-0-0 means zeroed out, any other invalid date should trigger a warning
1376         if (1980, 0, 0) != manifest.date_time[0:3]:
1377             try:
1378                 common.check_system_clock(datetime(*manifest.date_time), apkfilename)
1379             except ValueError as e:
1380                 logging.warning(_("{apkfilename}'s AndroidManifest.xml has a bad date: ")
1381                                 .format(apkfilename=apkfile) + str(e))
1382
1383         # extract icons from APK zip file
1384         iconfilename = "%s.%s" % (apk['packageName'], apk['versionCode'])
1385         try:
1386             empty_densities = extract_apk_icons(iconfilename, apk, apkzip, repodir)
1387         finally:
1388             apkzip.close()  # ensure that APK zip file gets closed
1389
1390         # resize existing icons for densities missing in the APK
1391         fill_missing_icon_densities(empty_densities, iconfilename, apk, repodir)
1392
1393         if use_date_from_apk and manifest.date_time[1] != 0:
1394             default_date_param = datetime(*manifest.date_time)
1395         else:
1396             default_date_param = None
1397
1398         # Record in known apks, getting the added date at the same time..
1399         added = knownapks.recordapk(apk['apkName'], apk['packageName'],
1400                                     default_date=default_date_param)
1401         if added:
1402             apk['added'] = added
1403
1404         apkcache[apkfilename] = apk
1405         cachechanged = True
1406
1407     return False, apk, cachechanged
1408
1409
1410 def process_apks(apkcache, repodir, knownapks, use_date_from_apk=False):
1411     """Processes the apks in the given repo directory.
1412
1413     This also extracts the icons.
1414
1415     :param apkcache: current apk cache information
1416     :param repodir: repo directory to scan
1417     :param knownapks: known apks info
1418     :param use_date_from_apk: use date from APK (instead of current date)
1419                               for newly added APKs
1420     :returns: (apks, cachechanged) where apks is a list of apk information,
1421               and cachechanged is True if the apkcache got changed.
1422     """
1423
1424     cachechanged = False
1425
1426     for icon_dir in get_all_icon_dirs(repodir):
1427         if os.path.exists(icon_dir):
1428             if options.clean:
1429                 shutil.rmtree(icon_dir)
1430                 os.makedirs(icon_dir)
1431         else:
1432             os.makedirs(icon_dir)
1433
1434     apks = []
1435     for apkfile in sorted(glob.glob(os.path.join(repodir, '*.apk'))):
1436         apkfilename = apkfile[len(repodir) + 1:]
1437         ada = options.allow_disabled_algorithms or config['allow_disabled_algorithms']
1438         (skip, apk, cachethis) = process_apk(apkcache, apkfilename, repodir, knownapks,
1439                                              use_date_from_apk, ada, True)
1440         if skip:
1441             continue
1442         apks.append(apk)
1443         cachechanged = cachechanged or cachethis
1444
1445     return apks, cachechanged
1446
1447
1448 def extract_apk_icons(icon_filename, apk, apkzip, repo_dir):
1449     """Extracts PNG icons from an APK with the supported pixel densities
1450
1451     Extracts icons from the given APK zip in various densities, saves
1452     them into given repo directory and stores their names in the APK
1453     metadata dictionary.  If the icon is an XML icon, then this tries
1454     to find PNG icon that can replace it.
1455
1456     :param icon_filename: A string representing the icon's file name
1457     :param apk: A populated dictionary containing APK metadata.
1458                 Needs to have 'icons_src' key
1459     :param apkzip: An opened zipfile.ZipFile of the APK file
1460     :param repo_dir: The directory of the APK's repository
1461     :return: A list of icon densities that are missing
1462
1463     """
1464     res_name_re = re.compile(r'res/(drawable|mipmap)-(x*[hlm]dpi|anydpi).*/(.*)_[0-9]+dp.(png|xml)')
1465     pngs = dict()
1466     for f in apkzip.namelist():
1467         m = res_name_re.match(f)
1468         if m and m.group(4) == 'png':
1469             density = screen_resolutions[m.group(2)]
1470             pngs[m.group(3) + '/' + density] = m.group(0)
1471
1472     icon_type = None
1473     empty_densities = []
1474     for density in screen_densities:
1475         if density not in apk['icons_src']:
1476             empty_densities.append(density)
1477             continue
1478         icon_src = apk['icons_src'][density]
1479         icon_dir = get_icon_dir(repo_dir, density)
1480         icon_type = '.png'
1481
1482         # Extract the icon files per density
1483         if icon_src.endswith('.xml'):
1484             m = res_name_re.match(icon_src)
1485             if m:
1486                 name = pngs.get(m.group(3) + '/' + str(density))
1487                 if name:
1488                     icon_src = name
1489             if icon_src.endswith('.xml'):
1490                 empty_densities.append(density)
1491                 icon_type = '.xml'
1492         icon_dest = os.path.join(icon_dir, icon_filename + icon_type)
1493
1494         try:
1495             with open(icon_dest, 'wb') as f:
1496                 f.write(get_icon_bytes(apkzip, icon_src))
1497             apk['icons'][density] = icon_filename + icon_type
1498         except (zipfile.BadZipFile, ValueError, KeyError) as e:
1499             logging.warning("Error retrieving icon file: %s %s", icon_dest, e)
1500             del apk['icons_src'][density]
1501             empty_densities.append(density)
1502
1503     # '-1' here is a remnant of the parsing of aapt output, meaning "no DPI specified"
1504     if '-1' in apk['icons_src']:
1505         icon_src = apk['icons_src']['-1']
1506         icon_type = icon_src[-4:]
1507         icon_path = os.path.join(get_icon_dir(repo_dir, '0'), icon_filename + icon_type)
1508         with open(icon_path, 'wb') as f:
1509             f.write(get_icon_bytes(apkzip, icon_src))
1510         if icon_type == '.png':
1511             im = None
1512             try:
1513                 im = Image.open(icon_path)
1514                 dpi = px_to_dpi(im.size[0])
1515                 for density in screen_densities:
1516                     if density in apk['icons']:
1517                         break
1518                     if density == screen_densities[-1] or dpi >= int(density):
1519                         apk['icons'][density] = icon_filename + icon_type
1520                         shutil.move(icon_path,
1521                                     os.path.join(get_icon_dir(repo_dir, density), icon_filename + icon_type))
1522                         empty_densities.remove(density)
1523                         break
1524             except Exception as e:
1525                 logging.warning(_("Failed reading {path}: {error}")
1526                                 .format(path=icon_path, error=e))
1527             finally:
1528                 if im and hasattr(im, 'close'):
1529                     im.close()
1530
1531     if apk['icons']:
1532         apk['icon'] = icon_filename + icon_type
1533
1534     return empty_densities
1535
1536
1537 def fill_missing_icon_densities(empty_densities, icon_filename, apk, repo_dir):
1538     """
1539     Resize existing PNG icons for densities missing in the APK to ensure all densities are available
1540
1541     :param empty_densities: A list of icon densities that are missing
1542     :param icon_filename: A string representing the icon's file name
1543     :param apk: A populated dictionary containing APK metadata. Needs to have 'icons' key
1544     :param repo_dir: The directory of the APK's repository
1545
1546     """
1547     icon_filename += '.png'
1548     # First try resizing down to not lose quality
1549     last_density = None
1550     for density in screen_densities:
1551         if density == '65534':  # not possible to generate 'anydpi' from other densities
1552             continue
1553         if density not in empty_densities:
1554             last_density = density
1555             continue
1556         if last_density is None:
1557             continue
1558         logging.debug("Density %s not available, resizing down from %s", density, last_density)
1559
1560         last_icon_path = os.path.join(get_icon_dir(repo_dir, last_density), icon_filename)
1561         icon_path = os.path.join(get_icon_dir(repo_dir, density), icon_filename)
1562         fp = None
1563         try:
1564             fp = open(last_icon_path, 'rb')
1565             im = Image.open(fp)
1566
1567             size = dpi_to_px(density)
1568
1569             im.thumbnail((size, size), Image.ANTIALIAS)
1570             im.save(icon_path, "PNG", optimize=True,
1571                     pnginfo=BLANK_PNG_INFO, icc_profile=None)
1572             empty_densities.remove(density)
1573         except Exception as e:
1574             logging.warning("Invalid image file at %s: %s", last_icon_path, e)
1575         finally:
1576             if fp:
1577                 fp.close()
1578
1579     # Then just copy from the highest resolution available
1580     last_density = None
1581     for density in reversed(screen_densities):
1582         if density not in empty_densities:
1583             last_density = density
1584             continue
1585
1586         if last_density is None:
1587             continue
1588
1589         shutil.copyfile(
1590             os.path.join(get_icon_dir(repo_dir, last_density), icon_filename),
1591             os.path.join(get_icon_dir(repo_dir, density), icon_filename)
1592         )
1593         empty_densities.remove(density)
1594
1595     for density in screen_densities:
1596         icon_dir = get_icon_dir(repo_dir, density)
1597         icon_dest = os.path.join(icon_dir, icon_filename)
1598         resize_icon(icon_dest, density)
1599
1600     # Copy from icons-mdpi to icons since mdpi is the baseline density
1601     baseline = os.path.join(get_icon_dir(repo_dir, '160'), icon_filename)
1602     if os.path.isfile(baseline):
1603         apk['icons']['0'] = icon_filename
1604         shutil.copyfile(baseline, os.path.join(get_icon_dir(repo_dir, '0'), icon_filename))
1605
1606
1607 def apply_info_from_latest_apk(apps, apks):
1608     """
1609     Some information from the apks needs to be applied up to the application level.
1610     When doing this, we use the info from the most recent version's apk.
1611     We deal with figuring out when the app was added and last updated at the same time.
1612     """
1613     for appid, app in apps.items():
1614         bestver = UNSET_VERSION_CODE
1615         for apk in apks:
1616             if apk['packageName'] == appid:
1617                 if apk['versionCode'] > bestver:
1618                     bestver = apk['versionCode']
1619                     bestapk = apk
1620
1621                 if 'added' in apk:
1622                     if not app.added or apk['added'] < app.added:
1623                         app.added = apk['added']
1624                     if not app.lastUpdated or apk['added'] > app.lastUpdated:
1625                         app.lastUpdated = apk['added']
1626
1627         if not app.added:
1628             logging.debug("Don't know when " + appid + " was added")
1629         if not app.lastUpdated:
1630             logging.debug("Don't know when " + appid + " was last updated")
1631
1632         if bestver == UNSET_VERSION_CODE:
1633
1634             if app.Name is None:
1635                 app.Name = app.AutoName or appid
1636             app.icon = None
1637             logging.debug("Application " + appid + " has no packages")
1638         else:
1639             if app.Name is None:
1640                 app.Name = bestapk['name']
1641             app.icon = bestapk['icon'] if 'icon' in bestapk else None
1642             if app.CurrentVersionCode is None:
1643                 app.CurrentVersionCode = str(bestver)
1644
1645
1646 def make_categories_txt(repodir, categories):
1647     '''Write a category list in the repo to allow quick access'''
1648     catdata = ''
1649     for cat in sorted(categories):
1650         catdata += cat + '\n'
1651     with open(os.path.join(repodir, 'categories.txt'), 'w', encoding='utf8') as f:
1652         f.write(catdata)
1653
1654
1655 def archive_old_apks(apps, apks, archapks, repodir, archivedir, defaultkeepversions):
1656
1657     def filter_apk_list_sorted(apk_list):
1658         res = []
1659         for apk in apk_list:
1660             if apk['packageName'] == appid:
1661                 res.append(apk)
1662
1663         # Sort the apk list by version code. First is highest/newest.
1664         return sorted(res, key=lambda apk: apk['versionCode'], reverse=True)
1665
1666     for appid, app in apps.items():
1667
1668         if app.ArchivePolicy:
1669             keepversions = int(app.ArchivePolicy[:-9])
1670         else:
1671             keepversions = defaultkeepversions
1672
1673         logging.debug(_("Checking archiving for {appid} - apks:{integer}, keepversions:{keep}, archapks:{arch}")
1674                       .format(appid=appid, integer=len(apks), keep=keepversions, arch=len(archapks)))
1675
1676         current_app_apks = filter_apk_list_sorted(apks)
1677         if len(current_app_apks) > keepversions:
1678             # Move back the ones we don't want.
1679             for apk in current_app_apks[keepversions:]:
1680                 move_apk_between_sections(repodir, archivedir, apk)
1681                 archapks.append(apk)
1682                 apks.remove(apk)
1683
1684         current_app_archapks = filter_apk_list_sorted(archapks)
1685         if len(current_app_apks) < keepversions and len(current_app_archapks) > 0:
1686             kept = 0
1687             # Move forward the ones we want again, except DisableAlgorithm
1688             for apk in current_app_archapks:
1689                 if 'DisabledAlgorithm' not in apk['antiFeatures']:
1690                     move_apk_between_sections(archivedir, repodir, apk)
1691                     archapks.remove(apk)
1692                     apks.append(apk)
1693                     kept += 1
1694                 if kept == keepversions:
1695                     break
1696
1697
1698 def move_apk_between_sections(from_dir, to_dir, apk):
1699     """move an APK from repo to archive or vice versa"""
1700
1701     def _move_file(from_dir, to_dir, filename, ignore_missing):
1702         from_path = os.path.join(from_dir, filename)
1703         if ignore_missing and not os.path.exists(from_path):
1704             return
1705         to_path = os.path.join(to_dir, filename)
1706         if not os.path.exists(to_dir):
1707             os.mkdir(to_dir)
1708         shutil.move(from_path, to_path)
1709
1710     if from_dir == to_dir:
1711         return
1712
1713     logging.info("Moving %s from %s to %s" % (apk['apkName'], from_dir, to_dir))
1714     _move_file(from_dir, to_dir, apk['apkName'], False)
1715     _move_file(from_dir, to_dir, apk['apkName'] + '.asc', True)
1716     for density in all_screen_densities:
1717         from_icon_dir = get_icon_dir(from_dir, density)
1718         to_icon_dir = get_icon_dir(to_dir, density)
1719         if density not in apk.get('icons', []):
1720             continue
1721         _move_file(from_icon_dir, to_icon_dir, apk['icons'][density], True)
1722     if 'srcname' in apk:
1723         _move_file(from_dir, to_dir, apk['srcname'], False)
1724
1725
1726 def add_apks_to_per_app_repos(repodir, apks):
1727     apks_per_app = dict()
1728     for apk in apks:
1729         apk['per_app_dir'] = os.path.join(apk['packageName'], 'fdroid')
1730         apk['per_app_repo'] = os.path.join(apk['per_app_dir'], 'repo')
1731         apk['per_app_icons'] = os.path.join(apk['per_app_repo'], 'icons')
1732         apks_per_app[apk['packageName']] = apk
1733
1734         if not os.path.exists(apk['per_app_icons']):
1735             logging.info(_('Adding new repo for only {name}').format(name=apk['packageName']))
1736             os.makedirs(apk['per_app_icons'])
1737
1738         apkpath = os.path.join(repodir, apk['apkName'])
1739         shutil.copy(apkpath, apk['per_app_repo'])
1740         apksigpath = apkpath + '.sig'
1741         if os.path.exists(apksigpath):
1742             shutil.copy(apksigpath, apk['per_app_repo'])
1743         apkascpath = apkpath + '.asc'
1744         if os.path.exists(apkascpath):
1745             shutil.copy(apkascpath, apk['per_app_repo'])
1746
1747
1748 def create_metadata_from_template(apk):
1749     '''create a new metadata file using internal or external template
1750
1751     Generate warnings for apk's with no metadata (or create skeleton
1752     metadata files, if requested on the command line).  Though the
1753     template file is YAML, this uses neither pyyaml nor ruamel.yaml
1754     since those impose things on the metadata file made from the
1755     template: field sort order, empty field value, formatting, etc.
1756     '''
1757
1758     import yaml
1759     if os.path.exists('template.yml'):
1760         with open('template.yml') as f:
1761             metatxt = f.read()
1762         if 'name' in apk and apk['name'] != '':
1763             metatxt = re.sub(r'''^(((Auto)?Name|Summary):)[ '"\.]*$''',
1764                              r'\1 ' + apk['name'],
1765                              metatxt,
1766                              flags=re.IGNORECASE | re.MULTILINE)
1767         else:
1768             logging.warning(_('{appid} does not have a name! Using package name instead.')
1769                             .format(appid=apk['packageName']))
1770             metatxt = re.sub(r'^(((Auto)?Name|Summary):).*$',
1771                              r'\1 ' + apk['packageName'],
1772                              metatxt,
1773                              flags=re.IGNORECASE | re.MULTILINE)
1774         with open(os.path.join('metadata', apk['packageName'] + '.yml'), 'w') as f:
1775             f.write(metatxt)
1776     else:
1777         app = dict()
1778         app['Categories'] = [os.path.basename(os.getcwd())]
1779         # include some blanks as part of the template
1780         app['AuthorName'] = ''
1781         app['Summary'] = ''
1782         app['WebSite'] = ''
1783         app['IssueTracker'] = ''
1784         app['SourceCode'] = ''
1785         app['CurrentVersionCode'] = 2147483647  # Java's Integer.MAX_VALUE
1786         if 'name' in apk and apk['name'] != '':
1787             app['Name'] = apk['name']
1788         else:
1789             logging.warning(_('{appid} does not have a name! Using package name instead.')
1790                             .format(appid=apk['packageName']))
1791             app['Name'] = apk['packageName']
1792         with open(os.path.join('metadata', apk['packageName'] + '.yml'), 'w') as f:
1793             yaml.dump(app, f, default_flow_style=False)
1794     logging.info(_("Generated skeleton metadata for {appid}").format(appid=apk['packageName']))
1795
1796
1797 config = None
1798 options = None
1799 start_timestamp = time.gmtime()
1800
1801
1802 def main():
1803
1804     global config, options
1805
1806     # Parse command line...
1807     parser = ArgumentParser()
1808     common.setup_global_opts(parser)
1809     parser.add_argument("--create-key", action="store_true", default=False,
1810                         help=_("Add a repo signing key to an unsigned repo"))
1811     parser.add_argument("-c", "--create-metadata", action="store_true", default=False,
1812                         help=_("Add skeleton metadata files for APKs that are missing them"))
1813     parser.add_argument("--delete-unknown", action="store_true", default=False,
1814                         help=_("Delete APKs and/or OBBs without metadata from the repo"))
1815     parser.add_argument("-b", "--buildreport", action="store_true", default=False,
1816                         help=_("Report on build data status"))
1817     parser.add_argument("-i", "--interactive", default=False, action="store_true",
1818                         help=_("Interactively ask about things that need updating."))
1819     parser.add_argument("-I", "--icons", action="store_true", default=False,
1820                         help=_("Resize all the icons exceeding the max pixel size and exit"))
1821     parser.add_argument("-e", "--editor", default="/etc/alternatives/editor",
1822                         help=_("Specify editor to use in interactive mode. Default " +
1823                                "is {path}").format(path='/etc/alternatives/editor'))
1824     parser.add_argument("-w", "--wiki", default=False, action="store_true",
1825                         help=_("Update the wiki"))
1826     parser.add_argument("--pretty", action="store_true", default=False,
1827                         help=_("Produce human-readable XML/JSON for index files"))
1828     parser.add_argument("--clean", action="store_true", default=False,
1829                         help=_("Clean update - don't uses caches, reprocess all APKs"))
1830     parser.add_argument("--nosign", action="store_true", default=False,
1831                         help=_("When configured for signed indexes, create only unsigned indexes at this stage"))
1832     parser.add_argument("--use-date-from-apk", action="store_true", default=False,
1833                         help=_("Use date from APK instead of current time for newly added APKs"))
1834     parser.add_argument("--rename-apks", action="store_true", default=False,
1835                         help=_("Rename APK files that do not match package.name_123.apk"))
1836     parser.add_argument("--allow-disabled-algorithms", action="store_true", default=False,
1837                         help=_("Include APKs that are signed with disabled algorithms like MD5"))
1838     metadata.add_metadata_arguments(parser)
1839     options = parser.parse_args()
1840     metadata.warnings_action = options.W
1841
1842     config = common.read_config(options)
1843
1844     if not ('jarsigner' in config and 'keytool' in config):
1845         raise FDroidException(_('Java JDK not found! Install in standard location or set java_paths!'))
1846
1847     repodirs = ['repo']
1848     if config['archive_older'] != 0:
1849         repodirs.append('archive')
1850         if not os.path.exists('archive'):
1851             os.mkdir('archive')
1852
1853     if options.icons:
1854         resize_all_icons(repodirs)
1855         sys.exit(0)
1856
1857     if options.rename_apks:
1858         options.clean = True
1859
1860     # check that icons exist now, rather than fail at the end of `fdroid update`
1861     for k in ['repo_icon', 'archive_icon']:
1862         if k in config:
1863             if not os.path.exists(config[k]):
1864                 logging.critical(_('{name} "{path}" does not exist! Correct it in config.py.')
1865                                  .format(name=k, path=config[k]))
1866                 sys.exit(1)
1867
1868     # if the user asks to create a keystore, do it now, reusing whatever it can
1869     if options.create_key:
1870         if os.path.exists(config['keystore']):
1871             logging.critical(_("Cowardily refusing to overwrite existing signing key setup!"))
1872             logging.critical("\t'" + config['keystore'] + "'")
1873             sys.exit(1)
1874
1875         if 'repo_keyalias' not in config:
1876             config['repo_keyalias'] = socket.getfqdn()
1877             common.write_to_config(config, 'repo_keyalias', config['repo_keyalias'])
1878         if 'keydname' not in config:
1879             config['keydname'] = 'CN=' + config['repo_keyalias'] + ', OU=F-Droid'
1880             common.write_to_config(config, 'keydname', config['keydname'])
1881         if 'keystore' not in config:
1882             config['keystore'] = common.default_config['keystore']
1883             common.write_to_config(config, 'keystore', config['keystore'])
1884
1885         password = common.genpassword()
1886         if 'keystorepass' not in config:
1887             config['keystorepass'] = password
1888             common.write_to_config(config, 'keystorepass', config['keystorepass'])
1889         if 'keypass' not in config:
1890             config['keypass'] = password
1891             common.write_to_config(config, 'keypass', config['keypass'])
1892         common.genkeystore(config)
1893
1894     # Get all apps...
1895     apps = metadata.read_metadata()
1896
1897     # Generate a list of categories...
1898     categories = set()
1899     for app in apps.values():
1900         categories.update(app.Categories)
1901
1902     # Read known apks data (will be updated and written back when we've finished)
1903     knownapks = common.KnownApks()
1904
1905     # Get APK cache
1906     apkcache = get_cache()
1907
1908     # Delete builds for disabled apps
1909     delete_disabled_builds(apps, apkcache, repodirs)
1910
1911     # Scan all apks in the main repo
1912     apks, cachechanged = process_apks(apkcache, repodirs[0], knownapks, options.use_date_from_apk)
1913
1914     files, fcachechanged = scan_repo_files(apkcache, repodirs[0], knownapks,
1915                                            options.use_date_from_apk)
1916     cachechanged = cachechanged or fcachechanged
1917     apks += files
1918     for apk in apks:
1919         if apk['packageName'] not in apps:
1920             if options.create_metadata:
1921                 create_metadata_from_template(apk)
1922                 apps = metadata.read_metadata()
1923             else:
1924                 msg = _("{apkfilename} ({appid}) has no metadata!") \
1925                     .format(apkfilename=apk['apkName'], appid=apk['packageName'])
1926                 if options.delete_unknown:
1927                     logging.warn(msg + '\n\t' + _("deleting: repo/{apkfilename}")
1928                                  .format(apkfilename=apk['apkName']))
1929                     rmf = os.path.join(repodirs[0], apk['apkName'])
1930                     if not os.path.exists(rmf):
1931                         logging.error(_("Could not find {path} to remove it").format(path=rmf))
1932                     else:
1933                         os.remove(rmf)
1934                 else:
1935                     logging.warn(msg + '\n\t' + _("Use `fdroid update -c` to create it."))
1936
1937     copy_triple_t_store_metadata(apps)
1938     insert_obbs(repodirs[0], apps, apks)
1939     insert_localized_app_metadata(apps)
1940     translate_per_build_anti_features(apps, apks)
1941
1942     # Scan the archive repo for apks as well
1943     if len(repodirs) > 1:
1944         archapks, cc = process_apks(apkcache, repodirs[1], knownapks, options.use_date_from_apk)
1945         if cc:
1946             cachechanged = True
1947     else:
1948         archapks = []
1949
1950     # Apply information from latest apks to the application and update dates
1951     apply_info_from_latest_apk(apps, apks + archapks)
1952
1953     # Sort the app list by name, then the web site doesn't have to by default.
1954     # (we had to wait until we'd scanned the apks to do this, because mostly the
1955     # name comes from there!)
1956     sortedids = sorted(apps.keys(), key=lambda appid: apps[appid].Name.upper())
1957
1958     # APKs are placed into multiple repos based on the app package, providing
1959     # per-app subscription feeds for nightly builds and things like it
1960     if config['per_app_repos']:
1961         add_apks_to_per_app_repos(repodirs[0], apks)
1962         for appid, app in apps.items():
1963             repodir = os.path.join(appid, 'fdroid', 'repo')
1964             appdict = dict()
1965             appdict[appid] = app
1966             if os.path.isdir(repodir):
1967                 index.make(appdict, [appid], apks, repodir, False)
1968             else:
1969                 logging.info(_('Skipping index generation for {appid}').format(appid=appid))
1970         return
1971
1972     if len(repodirs) > 1:
1973         archive_old_apks(apps, apks, archapks, repodirs[0], repodirs[1], config['archive_older'])
1974
1975     # Make the index for the main repo...
1976     index.make(apps, sortedids, apks, repodirs[0], False)
1977     make_categories_txt(repodirs[0], categories)
1978
1979     # If there's an archive repo,  make the index for it. We already scanned it
1980     # earlier on.
1981     if len(repodirs) > 1:
1982         index.make(apps, sortedids, archapks, repodirs[1], True)
1983
1984     git_remote = config.get('binary_transparency_remote')
1985     if git_remote or os.path.isdir(os.path.join('binary_transparency', '.git')):
1986         from . import btlog
1987         btlog.make_binary_transparency_log(repodirs)
1988
1989     if config['update_stats']:
1990         # Update known apks info...
1991         knownapks.writeifchanged()
1992
1993         # Generate latest apps data for widget
1994         if os.path.exists(os.path.join('stats', 'latestapps.txt')):
1995             data = ''
1996             with open(os.path.join('stats', 'latestapps.txt'), 'r', encoding='utf8') as f:
1997                 for line in f:
1998                     appid = line.rstrip()
1999                     data += appid + "\t"
2000                     app = apps[appid]
2001                     data += app.Name + "\t"
2002                     if app.icon is not None:
2003                         data += app.icon + "\t"
2004                     data += app.License + "\n"
2005             with open(os.path.join(repodirs[0], 'latestapps.dat'), 'w', encoding='utf8') as f:
2006                 f.write(data)
2007
2008     if cachechanged:
2009         write_cache(apkcache)
2010
2011     # Update the wiki...
2012     if options.wiki:
2013         update_wiki(apps, sortedids, apks + archapks)
2014
2015     logging.info(_("Finished"))
2016
2017
2018 if __name__ == "__main__":
2019     main()