fdroidserver/common.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # common.py - part of the FDroid server tools
   4 # Copyright (C) 2010-13, Ciaran Gultnieks, ciaran@ciarang.com
   5 # Copyright (C) 2013-2014 Daniel Martí <mvdan@mvdan.cc>
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU Affero General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU Affero General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Affero General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 import os
  21 import sys
  22 import re
  23 import shutil
  24 import glob
  25 import stat
  26 import subprocess
  27 import time
  28 import operator
  29 import Queue
  30 import threading
  31 import magic
  32 import logging
  33 import hashlib
  34 import socket
  35 import xml.etree.ElementTree as XMLElementTree
  36
  37 from distutils.version import LooseVersion
  38 from zipfile import ZipFile
  39
  40 import metadata
  41
  42 XMLElementTree.register_namespace('android', 'http://schemas.android.com/apk/res/android')
  43
  44 config = None
  45 options = None
  46 env = None
  47 orig_path = None
  48
  49
  50 default_config = {
  51     'sdk_path': "$ANDROID_HOME",
  52     'ndk_paths': {
  53         'r9b': None,
  54         'r10d': "$ANDROID_NDK"
  55     },
  56     'build_tools': "22.0.0",
  57     'ant': "ant",
  58     'mvn3': "mvn",
  59     'gradle': 'gradle',
  60     'sync_from_local_copy_dir': False,
  61     'make_current_version_link': True,
  62     'current_version_name_source': 'Name',
  63     'update_stats': False,
  64     'stats_ignore': [],
  65     'stats_server': None,
  66     'stats_user': None,
  67     'stats_to_carbon': False,
  68     'repo_maxage': 0,
  69     'build_server_always': False,
  70     'keystore': 'keystore.jks',
  71     'smartcardoptions': [],
  72     'char_limits': {
  73         'Summary': 50,
  74         'Description': 1500
  75     },
  76     'keyaliases': {},
  77     'repo_url': "https://MyFirstFDroidRepo.org/fdroid/repo",
  78     'repo_name': "My First FDroid Repo Demo",
  79     'repo_icon': "fdroid-icon.png",
  80     'repo_description': '''
  81         This is a repository of apps to be used with FDroid. Applications in this
  82         repository are either official binaries built by the original application
  83         developers, or are binaries built from source by the admin of f-droid.org
  84         using the tools on https://gitlab.com/u/fdroid.
  85         ''',
  86     'archive_older': 0,
  87 }
  88
  89
  90 def fill_config_defaults(thisconfig):
  91     for k, v in default_config.items():
  92         if k not in thisconfig:
  93             thisconfig[k] = v
  94
  95     # Expand paths (~users and $vars)
  96     def expand_path(path):
  97         if path is None:
  98             return None
  99         orig = path
 100         path = os.path.expanduser(path)
 101         path = os.path.expandvars(path)
 102         if orig == path:
 103             return None
 104         return path
 105
 106     for k in ['sdk_path', 'ant', 'mvn3', 'gradle', 'keystore', 'repo_icon']:
 107         v = thisconfig[k]
 108         exp = expand_path(v)
 109         if exp is not None:
 110             thisconfig[k] = exp
 111             thisconfig[k + '_orig'] = v
 112
 113     for k in ['ndk_paths']:
 114         d = thisconfig[k]
 115         for k2 in d.copy():
 116             v = d[k2]
 117             exp = expand_path(v)
 118             if exp is not None:
 119                 thisconfig[k][k2] = exp
 120                 thisconfig[k][k2 + '_orig'] = v
 121
 122
 123 def read_config(opts, config_file='config.py'):
 124     """Read the repository config
 125
 126     The config is read from config_file, which is in the current directory when
 127     any of the repo management commands are used.
 128     """
 129     global config, options, env, orig_path
 130
 131     if config is not None:
 132         return config
 133     if not os.path.isfile(config_file):
 134         logging.critical("Missing config file - is this a repo directory?")
 135         sys.exit(2)
 136
 137     options = opts
 138
 139     config = {}
 140
 141     logging.debug("Reading %s" % config_file)
 142     execfile(config_file, config)
 143
 144     # smartcardoptions must be a list since its command line args for Popen
 145     if 'smartcardoptions' in config:
 146         config['smartcardoptions'] = config['smartcardoptions'].split(' ')
 147     elif 'keystore' in config and config['keystore'] == 'NONE':
 148         # keystore='NONE' means use smartcard, these are required defaults
 149         config['smartcardoptions'] = ['-storetype', 'PKCS11', '-providerName',
 150                                       'SunPKCS11-OpenSC', '-providerClass',
 151                                       'sun.security.pkcs11.SunPKCS11',
 152                                       '-providerArg', 'opensc-fdroid.cfg']
 153
 154     if any(k in config for k in ["keystore", "keystorepass", "keypass"]):
 155         st = os.stat(config_file)
 156         if st.st_mode & stat.S_IRWXG or st.st_mode & stat.S_IRWXO:
 157             logging.warn("unsafe permissions on {0} (should be 0600)!".format(config_file))
 158
 159     fill_config_defaults(config)
 160
 161     # There is no standard, so just set up the most common environment
 162     # variables
 163     env = os.environ
 164     orig_path = env['PATH']
 165     for n in ['ANDROID_HOME', 'ANDROID_SDK']:
 166         env[n] = config['sdk_path']
 167
 168     for k in ["keystorepass", "keypass"]:
 169         if k in config:
 170             write_password_file(k)
 171
 172     for k in ["repo_description", "archive_description"]:
 173         if k in config:
 174             config[k] = clean_description(config[k])
 175
 176     if 'serverwebroot' in config:
 177         if isinstance(config['serverwebroot'], basestring):
 178             roots = [config['serverwebroot']]
 179         elif all(isinstance(item, basestring) for item in config['serverwebroot']):
 180             roots = config['serverwebroot']
 181         else:
 182             raise TypeError('only accepts strings, lists, and tuples')
 183         rootlist = []
 184         for rootstr in roots:
 185             # since this is used with rsync, where trailing slashes have
 186             # meaning, ensure there is always a trailing slash
 187             if rootstr[-1] != '/':
 188                 rootstr += '/'
 189             rootlist.append(rootstr.replace('//', '/'))
 190         config['serverwebroot'] = rootlist
 191
 192     return config
 193
 194
 195 def get_ndk_path(version):
 196     if version is None:
 197         version = 'r10d'  # latest
 198     paths = config['ndk_paths']
 199     if version not in paths:
 200         return ''
 201     return paths[version] or ''
 202
 203
 204 def find_sdk_tools_cmd(cmd):
 205     '''find a working path to a tool from the Android SDK'''
 206
 207     tooldirs = []
 208     if config is not None and 'sdk_path' in config and os.path.exists(config['sdk_path']):
 209         # try to find a working path to this command, in all the recent possible paths
 210         if 'build_tools' in config:
 211             build_tools = os.path.join(config['sdk_path'], 'build-tools')
 212             # if 'build_tools' was manually set and exists, check only that one
 213             configed_build_tools = os.path.join(build_tools, config['build_tools'])
 214             if os.path.exists(configed_build_tools):
 215                 tooldirs.append(configed_build_tools)
 216             else:
 217                 # no configed version, so hunt known paths for it
 218                 for f in sorted(os.listdir(build_tools), reverse=True):
 219                     if os.path.isdir(os.path.join(build_tools, f)):
 220                         tooldirs.append(os.path.join(build_tools, f))
 221                 tooldirs.append(build_tools)
 222         sdk_tools = os.path.join(config['sdk_path'], 'tools')
 223         if os.path.exists(sdk_tools):
 224             tooldirs.append(sdk_tools)
 225         sdk_platform_tools = os.path.join(config['sdk_path'], 'platform-tools')
 226         if os.path.exists(sdk_platform_tools):
 227             tooldirs.append(sdk_platform_tools)
 228     tooldirs.append('/usr/bin')
 229     for d in tooldirs:
 230         if os.path.isfile(os.path.join(d, cmd)):
 231             return os.path.join(d, cmd)
 232     # did not find the command, exit with error message
 233     ensure_build_tools_exists(config)
 234
 235
 236 def test_sdk_exists(thisconfig):
 237     if 'sdk_path' not in thisconfig:
 238         if 'aapt' in thisconfig and os.path.isfile(thisconfig['aapt']):
 239             return True
 240         else:
 241             logging.error("'sdk_path' not set in config.py!")
 242             return False
 243     if thisconfig['sdk_path'] == default_config['sdk_path']:
 244         logging.error('No Android SDK found!')
 245         logging.error('You can use ANDROID_HOME to set the path to your SDK, i.e.:')
 246         logging.error('\texport ANDROID_HOME=/opt/android-sdk')
 247         return False
 248     if not os.path.exists(thisconfig['sdk_path']):
 249         logging.critical('Android SDK path "' + thisconfig['sdk_path'] + '" does not exist!')
 250         return False
 251     if not os.path.isdir(thisconfig['sdk_path']):
 252         logging.critical('Android SDK path "' + thisconfig['sdk_path'] + '" is not a directory!')
 253         return False
 254     for d in ['build-tools', 'platform-tools', 'tools']:
 255         if not os.path.isdir(os.path.join(thisconfig['sdk_path'], d)):
 256             logging.critical('Android SDK path "%s" does not contain "%s/"!' % (
 257                 thisconfig['sdk_path'], d))
 258             return False
 259     return True
 260
 261
 262 def ensure_build_tools_exists(thisconfig):
 263     if not test_sdk_exists(thisconfig):
 264         sys.exit(3)
 265     build_tools = os.path.join(thisconfig['sdk_path'], 'build-tools')
 266     versioned_build_tools = os.path.join(build_tools, thisconfig['build_tools'])
 267     if not os.path.isdir(versioned_build_tools):
 268         logging.critical('Android Build Tools path "'
 269                          + versioned_build_tools + '" does not exist!')
 270         sys.exit(3)
 271
 272
 273 def write_password_file(pwtype, password=None):
 274     '''
 275     writes out passwords to a protected file instead of passing passwords as
 276     command line argments
 277     '''
 278     filename = '.fdroid.' + pwtype + '.txt'
 279     fd = os.open(filename, os.O_CREAT | os.O_TRUNC | os.O_WRONLY, 0600)
 280     if password is None:
 281         os.write(fd, config[pwtype])
 282     else:
 283         os.write(fd, password)
 284     os.close(fd)
 285     config[pwtype + 'file'] = filename
 286
 287
 288 # Given the arguments in the form of multiple appid:[vc] strings, this returns
 289 # a dictionary with the set of vercodes specified for each package.
 290 def read_pkg_args(args, allow_vercodes=False):
 291
 292     vercodes = {}
 293     if not args:
 294         return vercodes
 295
 296     for p in args:
 297         if allow_vercodes and ':' in p:
 298             package, vercode = p.split(':')
 299         else:
 300             package, vercode = p, None
 301         if package not in vercodes:
 302             vercodes[package] = [vercode] if vercode else []
 303             continue
 304         elif vercode and vercode not in vercodes[package]:
 305             vercodes[package] += [vercode] if vercode else []
 306
 307     return vercodes
 308
 309
 310 # On top of what read_pkg_args does, this returns the whole app metadata, but
 311 # limiting the builds list to the builds matching the vercodes specified.
 312 def read_app_args(args, allapps, allow_vercodes=False):
 313
 314     vercodes = read_pkg_args(args, allow_vercodes)
 315
 316     if not vercodes:
 317         return allapps
 318
 319     apps = {}
 320     for appid, app in allapps.iteritems():
 321         if appid in vercodes:
 322             apps[appid] = app
 323
 324     if len(apps) != len(vercodes):
 325         for p in vercodes:
 326             if p not in allapps:
 327                 logging.critical("No such package: %s" % p)
 328         raise FDroidException("Found invalid app ids in arguments")
 329     if not apps:
 330         raise FDroidException("No packages specified")
 331
 332     error = False
 333     for appid, app in apps.iteritems():
 334         vc = vercodes[appid]
 335         if not vc:
 336             continue
 337         app['builds'] = [b for b in app['builds'] if b['vercode'] in vc]
 338         if len(app['builds']) != len(vercodes[appid]):
 339             error = True
 340             allvcs = [b['vercode'] for b in app['builds']]
 341             for v in vercodes[appid]:
 342                 if v not in allvcs:
 343                     logging.critical("No such vercode %s for app %s" % (v, appid))
 344
 345     if error:
 346         raise FDroidException("Found invalid vercodes for some apps")
 347
 348     return apps
 349
 350
 351 def has_extension(filename, extension):
 352     name, ext = os.path.splitext(filename)
 353     ext = ext.lower()[1:]
 354     return ext == extension
 355
 356 apk_regex = None
 357
 358
 359 def clean_description(description):
 360     'Remove unneeded newlines and spaces from a block of description text'
 361     returnstring = ''
 362     # this is split up by paragraph to make removing the newlines easier
 363     for paragraph in re.split(r'\n\n', description):
 364         paragraph = re.sub('\r', '', paragraph)
 365         paragraph = re.sub('\n', ' ', paragraph)
 366         paragraph = re.sub(' {2,}', ' ', paragraph)
 367         paragraph = re.sub('^\s*(\w)', r'\1', paragraph)
 368         returnstring += paragraph + '\n\n'
 369     return returnstring.rstrip('\n')
 370
 371
 372 def apknameinfo(filename):
 373     global apk_regex
 374     filename = os.path.basename(filename)
 375     if apk_regex is None:
 376         apk_regex = re.compile(r"^(.+)_([0-9]+)\.apk$")
 377     m = apk_regex.match(filename)
 378     try:
 379         result = (m.group(1), m.group(2))
 380     except AttributeError:
 381         raise FDroidException("Invalid apk name: %s" % filename)
 382     return result
 383
 384
 385 def getapkname(app, build):
 386     return "%s_%s.apk" % (app['id'], build['vercode'])
 387
 388
 389 def getsrcname(app, build):
 390     return "%s_%s_src.tar.gz" % (app['id'], build['vercode'])
 391
 392
 393 def getappname(app):
 394     if app['Name']:
 395         return app['Name']
 396     if app['Auto Name']:
 397         return app['Auto Name']
 398     return app['id']
 399
 400
 401 def getcvname(app):
 402     return '%s (%s)' % (app['Current Version'], app['Current Version Code'])
 403
 404
 405 def getvcs(vcstype, remote, local):
 406     if vcstype == 'git':
 407         return vcs_git(remote, local)
 408     if vcstype == 'git-svn':
 409         return vcs_gitsvn(remote, local)
 410     if vcstype == 'hg':
 411         return vcs_hg(remote, local)
 412     if vcstype == 'bzr':
 413         return vcs_bzr(remote, local)
 414     if vcstype == 'srclib':
 415         if local != os.path.join('build', 'srclib', remote):
 416             raise VCSException("Error: srclib paths are hard-coded!")
 417         return getsrclib(remote, os.path.join('build', 'srclib'), raw=True)
 418     if vcstype == 'svn':
 419         raise VCSException("Deprecated vcs type 'svn' - please use 'git-svn' instead")
 420     raise VCSException("Invalid vcs type " + vcstype)
 421
 422
 423 def getsrclibvcs(name):
 424     if name not in metadata.srclibs:
 425         raise VCSException("Missing srclib " + name)
 426     return metadata.srclibs[name]['Repo Type']
 427
 428
 429 class vcs:
 430
 431     def __init__(self, remote, local):
 432
 433         # svn, git-svn and bzr may require auth
 434         self.username = None
 435         if self.repotype() in ('git-svn', 'bzr'):
 436             if '@' in remote:
 437                 if self.repotype == 'git-svn':
 438                     raise VCSException("Authentication is not supported for git-svn")
 439                 self.username, remote = remote.split('@')
 440                 if ':' not in self.username:
 441                     raise VCSException("Password required with username")
 442                 self.username, self.password = self.username.split(':')
 443
 444         self.remote = remote
 445         self.local = local
 446         self.clone_failed = False
 447         self.refreshed = False
 448         self.srclib = None
 449
 450     def repotype(self):
 451         return None
 452
 453     # Take the local repository to a clean version of the given revision, which
 454     # is specificed in the VCS's native format. Beforehand, the repository can
 455     # be dirty, or even non-existent. If the repository does already exist
 456     # locally, it will be updated from the origin, but only once in the
 457     # lifetime of the vcs object.
 458     # None is acceptable for 'rev' if you know you are cloning a clean copy of
 459     # the repo - otherwise it must specify a valid revision.
 460     def gotorevision(self, rev):
 461
 462         if self.clone_failed:
 463             raise VCSException("Downloading the repository already failed once, not trying again.")
 464
 465         # The .fdroidvcs-id file for a repo tells us what VCS type
 466         # and remote that directory was created from, allowing us to drop it
 467         # automatically if either of those things changes.
 468         fdpath = os.path.join(self.local, '..',
 469                               '.fdroidvcs-' + os.path.basename(self.local))
 470         cdata = self.repotype() + ' ' + self.remote
 471         writeback = True
 472         deleterepo = False
 473         if os.path.exists(self.local):
 474             if os.path.exists(fdpath):
 475                 with open(fdpath, 'r') as f:
 476                     fsdata = f.read().strip()
 477                 if fsdata == cdata:
 478                     writeback = False
 479                 else:
 480                     deleterepo = True
 481                     logging.info("Repository details for %s changed - deleting" % (
 482                         self.local))
 483             else:
 484                 deleterepo = True
 485                 logging.info("Repository details for %s missing - deleting" % (
 486                     self.local))
 487         if deleterepo:
 488             shutil.rmtree(self.local)
 489
 490         exc = None
 491
 492         try:
 493             self.gotorevisionx(rev)
 494         except FDroidException, e:
 495             exc = e
 496
 497         # If necessary, write the .fdroidvcs file.
 498         if writeback and not self.clone_failed:
 499             with open(fdpath, 'w') as f:
 500                 f.write(cdata)
 501
 502         if exc is not None:
 503             raise exc
 504
 505     # Derived classes need to implement this. It's called once basic checking
 506     # has been performend.
 507     def gotorevisionx(self, rev):
 508         raise VCSException("This VCS type doesn't define gotorevisionx")
 509
 510     # Initialise and update submodules
 511     def initsubmodules(self):
 512         raise VCSException('Submodules not supported for this vcs type')
 513
 514     # Get a list of all known tags
 515     def gettags(self):
 516         if not self._gettags:
 517             raise VCSException('gettags not supported for this vcs type')
 518         rtags = []
 519         for tag in self._gettags():
 520             if re.match('[-A-Za-z0-9_. ]+$', tag):
 521                 rtags.append(tag)
 522         return rtags
 523
 524     def latesttags(self, tags, number):
 525         """Get the most recent tags in a given list.
 526
 527         :param tags: a list of tags
 528         :param number: the number to return
 529         :returns: A list containing the most recent tags in the provided
 530                   list, up to the maximum number given.
 531         """
 532         raise VCSException('latesttags not supported for this vcs type')
 533
 534     # Get current commit reference (hash, revision, etc)
 535     def getref(self):
 536         raise VCSException('getref not supported for this vcs type')
 537
 538     # Returns the srclib (name, path) used in setting up the current
 539     # revision, or None.
 540     def getsrclib(self):
 541         return self.srclib
 542
 543
 544 class vcs_git(vcs):
 545
 546     def repotype(self):
 547         return 'git'
 548
 549     # If the local directory exists, but is somehow not a git repository, git
 550     # will traverse up the directory tree until it finds one that is (i.e.
 551     # fdroidserver) and then we'll proceed to destroy it! This is called as
 552     # a safety check.
 553     def checkrepo(self):
 554         p = FDroidPopen(['git', 'rev-parse', '--show-toplevel'], cwd=self.local, output=False)
 555         result = p.output.rstrip()
 556         if not result.endswith(self.local):
 557             raise VCSException('Repository mismatch')
 558
 559     def gotorevisionx(self, rev):
 560         if not os.path.exists(self.local):
 561             # Brand new checkout
 562             p = FDroidPopen(['git', 'clone', self.remote, self.local])
 563             if p.returncode != 0:
 564                 self.clone_failed = True
 565                 raise VCSException("Git clone failed", p.output)
 566             self.checkrepo()
 567         else:
 568             self.checkrepo()
 569             # Discard any working tree changes
 570             p = FDroidPopen(['git', 'reset', '--hard'], cwd=self.local, output=False)
 571             if p.returncode != 0:
 572                 raise VCSException("Git reset failed", p.output)
 573             # Remove untracked files now, in case they're tracked in the target
 574             # revision (it happens!)
 575             p = FDroidPopen(['git', 'clean', '-dffx'], cwd=self.local, output=False)
 576             if p.returncode != 0:
 577                 raise VCSException("Git clean failed", p.output)
 578             if not self.refreshed:
 579                 # Get latest commits and tags from remote
 580                 p = FDroidPopen(['git', 'fetch', 'origin'], cwd=self.local)
 581                 if p.returncode != 0:
 582                     raise VCSException("Git fetch failed", p.output)
 583                 p = FDroidPopen(['git', 'fetch', '--prune', '--tags', 'origin'], cwd=self.local, output=False)
 584                 if p.returncode != 0:
 585                     raise VCSException("Git fetch failed", p.output)
 586                 # Recreate origin/HEAD as git clone would do it, in case it disappeared
 587                 p = FDroidPopen(['git', 'remote', 'set-head', 'origin', '--auto'], cwd=self.local, output=False)
 588                 if p.returncode != 0:
 589                     lines = p.output.splitlines()
 590                     if 'Multiple remote HEAD branches' not in lines[0]:
 591                         raise VCSException("Git remote set-head failed", p.output)
 592                     branch = lines[1].split(' ')[-1]
 593                     p2 = FDroidPopen(['git', 'remote', 'set-head', 'origin', branch], cwd=self.local, output=False)
 594                     if p2.returncode != 0:
 595                         raise VCSException("Git remote set-head failed", p.output + '\n' + p2.output)
 596                 self.refreshed = True
 597         # origin/HEAD is the HEAD of the remote, e.g. the "default branch" on
 598         # a github repo. Most of the time this is the same as origin/master.
 599         rev = rev or 'origin/HEAD'
 600         p = FDroidPopen(['git', 'checkout', '-f', rev], cwd=self.local, output=False)
 601         if p.returncode != 0:
 602             raise VCSException("Git checkout of '%s' failed" % rev, p.output)
 603         # Get rid of any uncontrolled files left behind
 604         p = FDroidPopen(['git', 'clean', '-dffx'], cwd=self.local, output=False)
 605         if p.returncode != 0:
 606             raise VCSException("Git clean failed", p.output)
 607
 608     def initsubmodules(self):
 609         self.checkrepo()
 610         submfile = os.path.join(self.local, '.gitmodules')
 611         if not os.path.isfile(submfile):
 612             raise VCSException("No git submodules available")
 613
 614         # fix submodules not accessible without an account and public key auth
 615         with open(submfile, 'r') as f:
 616             lines = f.readlines()
 617         with open(submfile, 'w') as f:
 618             for line in lines:
 619                 if 'git@github.com' in line:
 620                     line = line.replace('git@github.com:', 'https://github.com/')
 621                 f.write(line)
 622
 623         for cmd in [
 624                 ['git', 'reset', '--hard'],
 625                 ['git', 'clean', '-dffx'],
 626                 ]:
 627             p = FDroidPopen(['git', 'submodule', 'foreach', '--recursive'] + cmd, cwd=self.local, output=False)
 628             if p.returncode != 0:
 629                 raise VCSException("Git submodule reset failed", p.output)
 630         p = FDroidPopen(['git', 'submodule', 'sync'], cwd=self.local, output=False)
 631         if p.returncode != 0:
 632             raise VCSException("Git submodule sync failed", p.output)
 633         p = FDroidPopen(['git', 'submodule', 'update', '--init', '--force', '--recursive'], cwd=self.local)
 634         if p.returncode != 0:
 635             raise VCSException("Git submodule update failed", p.output)
 636
 637     def _gettags(self):
 638         self.checkrepo()
 639         p = FDroidPopen(['git', 'tag'], cwd=self.local, output=False)
 640         return p.output.splitlines()
 641
 642     def latesttags(self, tags, number):
 643         self.checkrepo()
 644         tl = []
 645         for tag in tags:
 646             p = FDroidPopen(
 647                 ['git', 'show', '--format=format:%ct', '-s', tag],
 648                 cwd=self.local, output=False)
 649             # Timestamp is on the last line. For a normal tag, it's the only
 650             # line, but for annotated tags, the rest of the info precedes it.
 651             ts = int(p.output.splitlines()[-1])
 652             tl.append((ts, tag))
 653         latest = []
 654         for _, t in sorted(tl)[-number:]:
 655             latest.append(t)
 656         return latest
 657
 658
 659 class vcs_gitsvn(vcs):
 660
 661     def repotype(self):
 662         return 'git-svn'
 663
 664     # If the local directory exists, but is somehow not a git repository, git
 665     # will traverse up the directory tree until it finds one that is (i.e.
 666     # fdroidserver) and then we'll proceed to destory it! This is called as
 667     # a safety check.
 668     def checkrepo(self):
 669         p = FDroidPopen(['git', 'rev-parse', '--show-toplevel'], cwd=self.local, output=False)
 670         result = p.output.rstrip()
 671         if not result.endswith(self.local):
 672             raise VCSException('Repository mismatch')
 673
 674     def gotorevisionx(self, rev):
 675         if not os.path.exists(self.local):
 676             # Brand new checkout
 677             gitsvn_args = ['git', 'svn', 'clone']
 678             if ';' in self.remote:
 679                 remote_split = self.remote.split(';')
 680                 for i in remote_split[1:]:
 681                     if i.startswith('trunk='):
 682                         gitsvn_args.extend(['-T', i[6:]])
 683                     elif i.startswith('tags='):
 684                         gitsvn_args.extend(['-t', i[5:]])
 685                     elif i.startswith('branches='):
 686                         gitsvn_args.extend(['-b', i[9:]])
 687                 gitsvn_args.extend([remote_split[0], self.local])
 688                 p = FDroidPopen(gitsvn_args, output=False)
 689                 if p.returncode != 0:
 690                     self.clone_failed = True
 691                     raise VCSException("Git svn clone failed", p.output)
 692             else:
 693                 gitsvn_args.extend([self.remote, self.local])
 694                 p = FDroidPopen(gitsvn_args, output=False)
 695                 if p.returncode != 0:
 696                     self.clone_failed = True
 697                     raise VCSException("Git svn clone failed", p.output)
 698             self.checkrepo()
 699         else:
 700             self.checkrepo()
 701             # Discard any working tree changes
 702             p = FDroidPopen(['git', 'reset', '--hard'], cwd=self.local, output=False)
 703             if p.returncode != 0:
 704                 raise VCSException("Git reset failed", p.output)
 705             # Remove untracked files now, in case they're tracked in the target
 706             # revision (it happens!)
 707             p = FDroidPopen(['git', 'clean', '-dffx'], cwd=self.local, output=False)
 708             if p.returncode != 0:
 709                 raise VCSException("Git clean failed", p.output)
 710             if not self.refreshed:
 711                 # Get new commits, branches and tags from repo
 712                 p = FDroidPopen(['git', 'svn', 'fetch'], cwd=self.local, output=False)
 713                 if p.returncode != 0:
 714                     raise VCSException("Git svn fetch failed")
 715                 p = FDroidPopen(['git', 'svn', 'rebase'], cwd=self.local, output=False)
 716                 if p.returncode != 0:
 717                     raise VCSException("Git svn rebase failed", p.output)
 718                 self.refreshed = True
 719
 720         rev = rev or 'master'
 721         if rev:
 722             nospaces_rev = rev.replace(' ', '%20')
 723             # Try finding a svn tag
 724             for treeish in ['origin/', '']:
 725                 p = FDroidPopen(['git', 'checkout', treeish + 'tags/' + nospaces_rev], cwd=self.local, output=False)
 726                 if p.returncode == 0:
 727                     break
 728             if p.returncode != 0:
 729                 # No tag found, normal svn rev translation
 730                 # Translate svn rev into git format
 731                 rev_split = rev.split('/')
 732
 733                 p = None
 734                 for treeish in ['origin/', '']:
 735                     if len(rev_split) > 1:
 736                         treeish += rev_split[0]
 737                         svn_rev = rev_split[1]
 738
 739                     else:
 740                         # if no branch is specified, then assume trunk (i.e. 'master' branch):
 741                         treeish += 'master'
 742                         svn_rev = rev
 743
 744                     svn_rev = svn_rev if svn_rev[0] == 'r' else 'r' + svn_rev
 745
 746                     p = FDroidPopen(['git', 'svn', 'find-rev', '--before', svn_rev, treeish], cwd=self.local, output=False)
 747                     git_rev = p.output.rstrip()
 748
 749                     if p.returncode == 0 and git_rev:
 750                         break
 751
 752                 if p.returncode != 0 or not git_rev:
 753                     # Try a plain git checkout as a last resort
 754                     p = FDroidPopen(['git', 'checkout', rev], cwd=self.local, output=False)
 755                     if p.returncode != 0:
 756                         raise VCSException("No git treeish found and direct git checkout of '%s' failed" % rev, p.output)
 757                 else:
 758                     # Check out the git rev equivalent to the svn rev
 759                     p = FDroidPopen(['git', 'checkout', git_rev], cwd=self.local, output=False)
 760                     if p.returncode != 0:
 761                         raise VCSException("Git checkout of '%s' failed" % rev, p.output)
 762
 763         # Get rid of any uncontrolled files left behind
 764         p = FDroidPopen(['git', 'clean', '-dffx'], cwd=self.local, output=False)
 765         if p.returncode != 0:
 766             raise VCSException("Git clean failed", p.output)
 767
 768     def _gettags(self):
 769         self.checkrepo()
 770         for treeish in ['origin/', '']:
 771             d = os.path.join(self.local, '.git', 'svn', 'refs', 'remotes', treeish, 'tags')
 772             if os.path.isdir(d):
 773                 return os.listdir(d)
 774
 775     def getref(self):
 776         self.checkrepo()
 777         p = FDroidPopen(['git', 'svn', 'find-rev', 'HEAD'], cwd=self.local, output=False)
 778         if p.returncode != 0:
 779             return None
 780         return p.output.strip()
 781
 782
 783 class vcs_hg(vcs):
 784
 785     def repotype(self):
 786         return 'hg'
 787
 788     def gotorevisionx(self, rev):
 789         if not os.path.exists(self.local):
 790             p = FDroidPopen(['hg', 'clone', self.remote, self.local], output=False)
 791             if p.returncode != 0:
 792                 self.clone_failed = True
 793                 raise VCSException("Hg clone failed", p.output)
 794         else:
 795             p = FDroidPopen(['hg', 'status', '-uS'], cwd=self.local, output=False)
 796             if p.returncode != 0:
 797                 raise VCSException("Hg status failed", p.output)
 798             for line in p.output.splitlines():
 799                 if not line.startswith('? '):
 800                     raise VCSException("Unexpected output from hg status -uS: " + line)
 801                 FDroidPopen(['rm', '-rf', line[2:]], cwd=self.local, output=False)
 802             if not self.refreshed:
 803                 p = FDroidPopen(['hg', 'pull'], cwd=self.local, output=False)
 804                 if p.returncode != 0:
 805                     raise VCSException("Hg pull failed", p.output)
 806                 self.refreshed = True
 807
 808         rev = rev or 'default'
 809         if not rev:
 810             return
 811         p = FDroidPopen(['hg', 'update', '-C', rev], cwd=self.local, output=False)
 812         if p.returncode != 0:
 813             raise VCSException("Hg checkout of '%s' failed" % rev, p.output)
 814         p = FDroidPopen(['hg', 'purge', '--all'], cwd=self.local, output=False)
 815         # Also delete untracked files, we have to enable purge extension for that:
 816         if "'purge' is provided by the following extension" in p.output:
 817             with open(os.path.join(self.local, '.hg', 'hgrc'), "a") as myfile:
 818                 myfile.write("\n[extensions]\nhgext.purge=\n")
 819             p = FDroidPopen(['hg', 'purge', '--all'], cwd=self.local, output=False)
 820             if p.returncode != 0:
 821                 raise VCSException("HG purge failed", p.output)
 822         elif p.returncode != 0:
 823             raise VCSException("HG purge failed", p.output)
 824
 825     def _gettags(self):
 826         p = FDroidPopen(['hg', 'tags', '-q'], cwd=self.local, output=False)
 827         return p.output.splitlines()[1:]
 828
 829
 830 class vcs_bzr(vcs):
 831
 832     def repotype(self):
 833         return 'bzr'
 834
 835     def gotorevisionx(self, rev):
 836         if not os.path.exists(self.local):
 837             p = FDroidPopen(['bzr', 'branch', self.remote, self.local], output=False)
 838             if p.returncode != 0:
 839                 self.clone_failed = True
 840                 raise VCSException("Bzr branch failed", p.output)
 841         else:
 842             p = FDroidPopen(['bzr', 'clean-tree', '--force', '--unknown', '--ignored'], cwd=self.local, output=False)
 843             if p.returncode != 0:
 844                 raise VCSException("Bzr revert failed", p.output)
 845             if not self.refreshed:
 846                 p = FDroidPopen(['bzr', 'pull'], cwd=self.local, output=False)
 847                 if p.returncode != 0:
 848                     raise VCSException("Bzr update failed", p.output)
 849                 self.refreshed = True
 850
 851         revargs = list(['-r', rev] if rev else [])
 852         p = FDroidPopen(['bzr', 'revert'] + revargs, cwd=self.local, output=False)
 853         if p.returncode != 0:
 854             raise VCSException("Bzr revert of '%s' failed" % rev, p.output)
 855
 856     def _gettags(self):
 857         p = FDroidPopen(['bzr', 'tags'], cwd=self.local, output=False)
 858         return [tag.split('   ')[0].strip() for tag in
 859                 p.output.splitlines()]
 860
 861
 862 def retrieve_string(app_dir, string, xmlfiles=None):
 863
 864     if xmlfiles is None:
 865         xmlfiles = []
 866         for res_dir in [
 867             os.path.join(app_dir, 'res'),
 868             os.path.join(app_dir, 'src', 'main', 'res'),
 869         ]:
 870             for r, d, f in os.walk(res_dir):
 871                 if os.path.basename(r) == 'values':
 872                     xmlfiles += [os.path.join(r, x) for x in f if x.endswith('.xml')]
 873
 874     if not string.startswith('@string/'):
 875         return string.replace("\\'", "'")
 876
 877     name = string[len('@string/'):]
 878
 879     for path in xmlfiles:
 880         if not os.path.isfile(path):
 881             continue
 882         xml = parse_xml(path)
 883         element = xml.find('string[@name="' + name + '"]')
 884         if element is not None:
 885             return retrieve_string(app_dir, element.text, xmlfiles)
 886
 887     return ''
 888
 889
 890 # Return list of existing files that will be used to find the highest vercode
 891 def manifest_paths(app_dir, flavours):
 892
 893     possible_manifests = \
 894         [os.path.join(app_dir, 'AndroidManifest.xml'),
 895          os.path.join(app_dir, 'src', 'main', 'AndroidManifest.xml'),
 896          os.path.join(app_dir, 'src', 'AndroidManifest.xml'),
 897          os.path.join(app_dir, 'build.gradle')]
 898
 899     for flavour in flavours:
 900         if flavour == 'yes':
 901             continue
 902         possible_manifests.append(
 903             os.path.join(app_dir, 'src', flavour, 'AndroidManifest.xml'))
 904
 905     return [path for path in possible_manifests if os.path.isfile(path)]
 906
 907
 908 # Retrieve the package name. Returns the name, or None if not found.
 909 def fetch_real_name(app_dir, flavours):
 910     for path in manifest_paths(app_dir, flavours):
 911         if not has_extension(path, 'xml') or not os.path.isfile(path):
 912             continue
 913         logging.debug("fetch_real_name: Checking manifest at " + path)
 914         xml = parse_xml(path)
 915         app = xml.find('application')
 916         if "{http://schemas.android.com/apk/res/android}label" not in app.attrib:
 917             continue
 918         label = app.attrib["{http://schemas.android.com/apk/res/android}label"]
 919         result = retrieve_string(app_dir, label)
 920         if result:
 921             result = result.strip()
 922         return result
 923     return None
 924
 925
 926 # Retrieve the version name
 927 def version_name(original, app_dir, flavours):
 928     for path in manifest_paths(app_dir, flavours):
 929         if not has_extension(path, 'xml'):
 930             continue
 931         string = retrieve_string(app_dir, original)
 932         if string:
 933             return string
 934     return original
 935
 936
 937 def get_library_references(root_dir):
 938     libraries = []
 939     proppath = os.path.join(root_dir, 'project.properties')
 940     if not os.path.isfile(proppath):
 941         return libraries
 942     for line in file(proppath):
 943         if not line.startswith('android.library.reference.'):
 944             continue
 945         path = line.split('=')[1].strip()
 946         relpath = os.path.join(root_dir, path)
 947         if not os.path.isdir(relpath):
 948             continue
 949         logging.debug("Found subproject at %s" % path)
 950         libraries.append(path)
 951     return libraries
 952
 953
 954 def ant_subprojects(root_dir):
 955     subprojects = get_library_references(root_dir)
 956     for subpath in subprojects:
 957         subrelpath = os.path.join(root_dir, subpath)
 958         for p in get_library_references(subrelpath):
 959             relp = os.path.normpath(os.path.join(subpath, p))
 960             if relp not in subprojects:
 961                 subprojects.insert(0, relp)
 962     return subprojects
 963
 964
 965 def remove_debuggable_flags(root_dir):
 966     # Remove forced debuggable flags
 967     logging.debug("Removing debuggable flags from %s" % root_dir)
 968     for root, dirs, files in os.walk(root_dir):
 969         if 'AndroidManifest.xml' in files:
 970             path = os.path.join(root, 'AndroidManifest.xml')
 971             p = FDroidPopen(['sed', '-i', 's/android:debuggable="[^"]*"//g', path], output=False)
 972             if p.returncode != 0:
 973                 raise BuildException("Failed to remove debuggable flags of %s" % path)
 974
 975
 976 # Extract some information from the AndroidManifest.xml at the given path.
 977 # Returns (version, vercode, package), any or all of which might be None.
 978 # All values returned are strings.
 979 def parse_androidmanifests(paths, ignoreversions=None):
 980
 981     if not paths:
 982         return (None, None, None)
 983
 984     vcsearch_g = re.compile(r'.*versionCode *=* *["\']*([0-9]+)["\']*').search
 985     vnsearch_g = re.compile(r'.*versionName *=* *(["\'])((?:(?=(\\?))\3.)*?)\1.*').search
 986     psearch_g = re.compile(r'.*packageName *=* *["\']([^"]+)["\'].*').search
 987
 988     ignoresearch = re.compile(ignoreversions).search if ignoreversions else None
 989
 990     max_version = None
 991     max_vercode = None
 992     max_package = None
 993
 994     for path in paths:
 995
 996         if not os.path.isfile(path):
 997             continue
 998
 999         logging.debug("Parsing manifest at {0}".format(path))
1000         gradle = has_extension(path, 'gradle')
1001         version = None
1002         vercode = None
1003         # Remember package name, may be defined separately from version+vercode
1004         package = max_package
1005
1006         if gradle:
1007             for line in file(path):
1008                 if not package:
1009                     matches = psearch_g(line)
1010                     if matches:
1011                         package = matches.group(1)
1012                 if not version:
1013                     matches = vnsearch_g(line)
1014                     if matches:
1015                         version = matches.group(2)
1016                 if not vercode:
1017                     matches = vcsearch_g(line)
1018                     if matches:
1019                         vercode = matches.group(1)
1020         else:
1021             xml = parse_xml(path)
1022             if "package" in xml.attrib:
1023                 package = xml.attrib["package"]
1024             if "{http://schemas.android.com/apk/res/android}versionName" in xml.attrib:
1025                 version = xml.attrib["{http://schemas.android.com/apk/res/android}versionName"]
1026             if "{http://schemas.android.com/apk/res/android}versionCode" in xml.attrib:
1027                 vercode = xml.attrib["{http://schemas.android.com/apk/res/android}versionCode"]
1028
1029         logging.debug("..got package={0}, version={1}, vercode={2}"
1030                       .format(package, version, vercode))
1031
1032         # Always grab the package name and version name in case they are not
1033         # together with the highest version code
1034         if max_package is None and package is not None:
1035             max_package = package
1036         if max_version is None and version is not None:
1037             max_version = version
1038
1039         if max_vercode is None or (vercode is not None and vercode > max_vercode):
1040             if not ignoresearch or not ignoresearch(version):
1041                 if version is not None:
1042                     max_version = version
1043                 if vercode is not None:
1044                     max_vercode = vercode
1045                 if package is not None:
1046                     max_package = package
1047             else:
1048                 max_version = "Ignore"
1049
1050     if max_version is None:
1051         max_version = "Unknown"
1052
1053     if max_package and not is_valid_package_name(max_package):
1054         raise FDroidException("Invalid package name {0}".format(max_package))
1055
1056     return (max_version, max_vercode, max_package)
1057
1058
1059 def is_valid_package_name(name):
1060     return re.match("[A-Za-z_][A-Za-z_0-9.]+$", name)
1061
1062
1063 class FDroidException(Exception):
1064
1065     def __init__(self, value, detail=None):
1066         self.value = value
1067         self.detail = detail
1068
1069     def get_wikitext(self):
1070         ret = repr(self.value) + "\n"
1071         if self.detail:
1072             ret += "=detail=\n"
1073             ret += "<pre>\n"
1074             txt = self.detail[-8192:] if len(self.detail) > 8192 else self.detail
1075             ret += str(txt)
1076             ret += "</pre>\n"
1077         return ret
1078
1079     def __str__(self):
1080         ret = self.value
1081         if self.detail:
1082             ret += "\n==== detail begin ====\n%s\n==== detail end ====" % self.detail.strip()
1083         return ret
1084
1085
1086 class VCSException(FDroidException):
1087     pass
1088
1089
1090 class BuildException(FDroidException):
1091     pass
1092
1093
1094 # Get the specified source library.
1095 # Returns the path to it. Normally this is the path to be used when referencing
1096 # it, which may be a subdirectory of the actual project. If you want the base
1097 # directory of the project, pass 'basepath=True'.
1098 def getsrclib(spec, srclib_dir, subdir=None, basepath=False,
1099               raw=False, prepare=True, preponly=False):
1100
1101     number = None
1102     subdir = None
1103     if raw:
1104         name = spec
1105         ref = None
1106     else:
1107         name, ref = spec.split('@')
1108         if ':' in name:
1109             number, name = name.split(':', 1)
1110         if '/' in name:
1111             name, subdir = name.split('/', 1)
1112
1113     if name not in metadata.srclibs:
1114         raise VCSException('srclib ' + name + ' not found.')
1115
1116     srclib = metadata.srclibs[name]
1117
1118     sdir = os.path.join(srclib_dir, name)
1119
1120     if not preponly:
1121         vcs = getvcs(srclib["Repo Type"], srclib["Repo"], sdir)
1122         vcs.srclib = (name, number, sdir)
1123         if ref:
1124             vcs.gotorevision(ref)
1125
1126         if raw:
1127             return vcs
1128
1129     libdir = None
1130     if subdir:
1131         libdir = os.path.join(sdir, subdir)
1132     elif srclib["Subdir"]:
1133         for subdir in srclib["Subdir"]:
1134             libdir_candidate = os.path.join(sdir, subdir)
1135             if os.path.exists(libdir_candidate):
1136                 libdir = libdir_candidate
1137                 break
1138
1139     if libdir is None:
1140         libdir = sdir
1141
1142     remove_signing_keys(sdir)
1143     remove_debuggable_flags(sdir)
1144
1145     if prepare:
1146
1147         if srclib["Prepare"]:
1148             cmd = replace_config_vars(srclib["Prepare"], None)
1149
1150             p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=libdir)
1151             if p.returncode != 0:
1152                 raise BuildException("Error running prepare command for srclib %s"
1153                                      % name, p.output)
1154
1155     if basepath:
1156         libdir = sdir
1157
1158     return (name, number, libdir)
1159
1160
1161 # Prepare the source code for a particular build
1162 #  'vcs'         - the appropriate vcs object for the application
1163 #  'app'         - the application details from the metadata
1164 #  'build'       - the build details from the metadata
1165 #  'build_dir'   - the path to the build directory, usually
1166 #                   'build/app.id'
1167 #  'srclib_dir'  - the path to the source libraries directory, usually
1168 #                   'build/srclib'
1169 #  'extlib_dir'  - the path to the external libraries directory, usually
1170 #                   'build/extlib'
1171 # Returns the (root, srclibpaths) where:
1172 #   'root' is the root directory, which may be the same as 'build_dir' or may
1173 #          be a subdirectory of it.
1174 #   'srclibpaths' is information on the srclibs being used
1175 def prepare_source(vcs, app, build, build_dir, srclib_dir, extlib_dir, onserver=False):
1176
1177     # Optionally, the actual app source can be in a subdirectory
1178     if build['subdir']:
1179         root_dir = os.path.join(build_dir, build['subdir'])
1180     else:
1181         root_dir = build_dir
1182
1183     # Get a working copy of the right revision
1184     logging.info("Getting source for revision " + build['commit'])
1185     vcs.gotorevision(build['commit'])
1186
1187     # Initialise submodules if requred
1188     if build['submodules']:
1189         logging.info("Initialising submodules")
1190         vcs.initsubmodules()
1191
1192     # Check that a subdir (if we're using one) exists. This has to happen
1193     # after the checkout, since it might not exist elsewhere
1194     if not os.path.exists(root_dir):
1195         raise BuildException('Missing subdir ' + root_dir)
1196
1197     # Run an init command if one is required
1198     if build['init']:
1199         cmd = replace_config_vars(build['init'], build)
1200         logging.info("Running 'init' commands in %s" % root_dir)
1201
1202         p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1203         if p.returncode != 0:
1204             raise BuildException("Error running init command for %s:%s" %
1205                                  (app['id'], build['version']), p.output)
1206
1207     # Apply patches if any
1208     if build['patch']:
1209         logging.info("Applying patches")
1210         for patch in build['patch']:
1211             patch = patch.strip()
1212             logging.info("Applying " + patch)
1213             patch_path = os.path.join('metadata', app['id'], patch)
1214             p = FDroidPopen(['patch', '-p1', '-i', os.path.abspath(patch_path)], cwd=build_dir)
1215             if p.returncode != 0:
1216                 raise BuildException("Failed to apply patch %s" % patch_path)
1217
1218     # Get required source libraries
1219     srclibpaths = []
1220     if build['srclibs']:
1221         logging.info("Collecting source libraries")
1222         for lib in build['srclibs']:
1223             srclibpaths.append(getsrclib(lib, srclib_dir, build, preponly=onserver))
1224
1225     for name, number, libpath in srclibpaths:
1226         place_srclib(root_dir, int(number) if number else None, libpath)
1227
1228     basesrclib = vcs.getsrclib()
1229     # If one was used for the main source, add that too.
1230     if basesrclib:
1231         srclibpaths.append(basesrclib)
1232
1233     # Update the local.properties file
1234     localprops = [os.path.join(build_dir, 'local.properties')]
1235     if build['subdir']:
1236         localprops += [os.path.join(root_dir, 'local.properties')]
1237     for path in localprops:
1238         props = ""
1239         if os.path.isfile(path):
1240             logging.info("Updating local.properties file at %s" % path)
1241             f = open(path, 'r')
1242             props += f.read()
1243             f.close()
1244             props += '\n'
1245         else:
1246             logging.info("Creating local.properties file at %s" % path)
1247         # Fix old-fashioned 'sdk-location' by copying
1248         # from sdk.dir, if necessary
1249         if build['oldsdkloc']:
1250             sdkloc = re.match(r".*^sdk.dir=(\S+)$.*", props,
1251                               re.S | re.M).group(1)
1252             props += "sdk-location=%s\n" % sdkloc
1253         else:
1254             props += "sdk.dir=%s\n" % config['sdk_path']
1255             props += "sdk-location=%s\n" % config['sdk_path']
1256         if build['ndk_path']:
1257             # Add ndk location
1258             props += "ndk.dir=%s\n" % build['ndk_path']
1259             props += "ndk-location=%s\n" % build['ndk_path']
1260         # Add java.encoding if necessary
1261         if build['encoding']:
1262             props += "java.encoding=%s\n" % build['encoding']
1263         f = open(path, 'w')
1264         f.write(props)
1265         f.close()
1266
1267     flavours = []
1268     if build['type'] == 'gradle':
1269         flavours = build['gradle']
1270
1271         version_regex = re.compile(r"[^/]*'com\.android\.tools\.build:gradle:([^\.]+\.[^\.]+).*'.*")
1272         gradlepluginver = None
1273
1274         gradle_dirs = [root_dir]
1275
1276         # Parent dir build.gradle
1277         parent_dir = os.path.normpath(os.path.join(root_dir, '..'))
1278         if parent_dir.startswith(build_dir):
1279             gradle_dirs.append(parent_dir)
1280
1281         for dir_path in gradle_dirs:
1282             if gradlepluginver:
1283                 break
1284             if not os.path.isdir(dir_path):
1285                 continue
1286             for filename in os.listdir(dir_path):
1287                 if not filename.endswith('.gradle'):
1288                     continue
1289                 path = os.path.join(dir_path, filename)
1290                 if not os.path.isfile(path):
1291                     continue
1292                 for line in file(path):
1293                     match = version_regex.match(line)
1294                     if match:
1295                         gradlepluginver = match.group(1)
1296                         break
1297
1298         if gradlepluginver:
1299             build['gradlepluginver'] = LooseVersion(gradlepluginver)
1300         else:
1301             logging.warn("Could not fetch the gradle plugin version, defaulting to 0.11")
1302             build['gradlepluginver'] = LooseVersion('0.11')
1303
1304         if build['target']:
1305             n = build["target"].split('-')[1]
1306             FDroidPopen(['sed', '-i',
1307                          's@compileSdkVersion *[0-9]*@compileSdkVersion ' + n + '@g',
1308                          'build.gradle'], cwd=root_dir, output=False)
1309
1310     # Remove forced debuggable flags
1311     remove_debuggable_flags(root_dir)
1312
1313     # Insert version code and number into the manifest if necessary
1314     if build['forceversion']:
1315         logging.info("Changing the version name")
1316         for path in manifest_paths(root_dir, flavours):
1317             if not os.path.isfile(path):
1318                 continue
1319             if has_extension(path, 'xml'):
1320                 p = FDroidPopen(['sed', '-i',
1321                                  's/android:versionName="[^"]*"/android:versionName="' + build['version'] + '"/g',
1322                                  path], output=False)
1323                 if p.returncode != 0:
1324                     raise BuildException("Failed to amend manifest")
1325             elif has_extension(path, 'gradle'):
1326                 p = FDroidPopen(['sed', '-i',
1327                                  's/versionName *=* *.*/versionName = "' + build['version'] + '"/g',
1328                                  path], output=False)
1329                 if p.returncode != 0:
1330                     raise BuildException("Failed to amend build.gradle")
1331     if build['forcevercode']:
1332         logging.info("Changing the version code")
1333         for path in manifest_paths(root_dir, flavours):
1334             if not os.path.isfile(path):
1335                 continue
1336             if has_extension(path, 'xml'):
1337                 p = FDroidPopen(['sed', '-i',
1338                                  's/android:versionCode="[^"]*"/android:versionCode="' + build['vercode'] + '"/g',
1339                                  path], output=False)
1340                 if p.returncode != 0:
1341                     raise BuildException("Failed to amend manifest")
1342             elif has_extension(path, 'gradle'):
1343                 p = FDroidPopen(['sed', '-i',
1344                                  's/versionCode *=* *[0-9]*/versionCode = ' + build['vercode'] + '/g',
1345                                  path], output=False)
1346                 if p.returncode != 0:
1347                     raise BuildException("Failed to amend build.gradle")
1348
1349     # Delete unwanted files
1350     if build['rm']:
1351         logging.info("Removing specified files")
1352         for part in getpaths(build_dir, build, 'rm'):
1353             dest = os.path.join(build_dir, part)
1354             logging.info("Removing {0}".format(part))
1355             if os.path.lexists(dest):
1356                 if os.path.islink(dest):
1357                     FDroidPopen(['unlink', dest], output=False)
1358                 else:
1359                     FDroidPopen(['rm', '-rf', dest], output=False)
1360             else:
1361                 logging.info("...but it didn't exist")
1362
1363     remove_signing_keys(build_dir)
1364
1365     # Add required external libraries
1366     if build['extlibs']:
1367         logging.info("Collecting prebuilt libraries")
1368         libsdir = os.path.join(root_dir, 'libs')
1369         if not os.path.exists(libsdir):
1370             os.mkdir(libsdir)
1371         for lib in build['extlibs']:
1372             lib = lib.strip()
1373             logging.info("...installing extlib {0}".format(lib))
1374             libf = os.path.basename(lib)
1375             libsrc = os.path.join(extlib_dir, lib)
1376             if not os.path.exists(libsrc):
1377                 raise BuildException("Missing extlib file {0}".format(libsrc))
1378             shutil.copyfile(libsrc, os.path.join(libsdir, libf))
1379
1380     # Run a pre-build command if one is required
1381     if build['prebuild']:
1382         logging.info("Running 'prebuild' commands in %s" % root_dir)
1383
1384         cmd = replace_config_vars(build['prebuild'], build)
1385
1386         # Substitute source library paths into prebuild commands
1387         for name, number, libpath in srclibpaths:
1388             libpath = os.path.relpath(libpath, root_dir)
1389             cmd = cmd.replace('$$' + name + '$$', libpath)
1390
1391         p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1392         if p.returncode != 0:
1393             raise BuildException("Error running prebuild command for %s:%s" %
1394                                  (app['id'], build['version']), p.output)
1395
1396     # Generate (or update) the ant build file, build.xml...
1397     if build['update'] and build['update'] != ['no'] and build['type'] == 'ant':
1398         parms = ['android', 'update', 'lib-project']
1399         lparms = ['android', 'update', 'project']
1400
1401         if build['target']:
1402             parms += ['-t', build['target']]
1403             lparms += ['-t', build['target']]
1404         if build['update'] == ['auto']:
1405             update_dirs = ant_subprojects(root_dir) + ['.']
1406         else:
1407             update_dirs = build['update']
1408
1409         for d in update_dirs:
1410             subdir = os.path.join(root_dir, d)
1411             if d == '.':
1412                 logging.debug("Updating main project")
1413                 cmd = parms + ['-p', d]
1414             else:
1415                 logging.debug("Updating subproject %s" % d)
1416                 cmd = lparms + ['-p', d]
1417             p = SdkToolsPopen(cmd, cwd=root_dir)
1418             # Check to see whether an error was returned without a proper exit
1419             # code (this is the case for the 'no target set or target invalid'
1420             # error)
1421             if p.returncode != 0 or p.output.startswith("Error: "):
1422                 raise BuildException("Failed to update project at %s" % d, p.output)
1423             # Clean update dirs via ant
1424             if d != '.':
1425                 logging.info("Cleaning subproject %s" % d)
1426                 p = FDroidPopen(['ant', 'clean'], cwd=subdir)
1427
1428     return (root_dir, srclibpaths)
1429
1430
1431 # Split and extend via globbing the paths from a field
1432 def getpaths(build_dir, build, field):
1433     paths = []
1434     for p in build[field]:
1435         p = p.strip()
1436         full_path = os.path.join(build_dir, p)
1437         full_path = os.path.normpath(full_path)
1438         paths += [r[len(build_dir) + 1:] for r in glob.glob(full_path)]
1439     return paths
1440
1441
1442 # Scan the source code in the given directory (and all subdirectories)
1443 # and return the number of fatal problems encountered
1444 def scan_source(build_dir, root_dir, thisbuild):
1445
1446     count = 0
1447
1448     # Common known non-free blobs (always lower case):
1449     usual_suspects = [
1450         re.compile(r'flurryagent', re.IGNORECASE),
1451         re.compile(r'paypal.*mpl', re.IGNORECASE),
1452         re.compile(r'google.*analytics', re.IGNORECASE),
1453         re.compile(r'admob.*sdk.*android', re.IGNORECASE),
1454         re.compile(r'google.*ad.*view', re.IGNORECASE),
1455         re.compile(r'google.*admob', re.IGNORECASE),
1456         re.compile(r'google.*play.*services', re.IGNORECASE),
1457         re.compile(r'crittercism', re.IGNORECASE),
1458         re.compile(r'heyzap', re.IGNORECASE),
1459         re.compile(r'jpct.*ae', re.IGNORECASE),
1460         re.compile(r'youtube.*android.*player.*api', re.IGNORECASE),
1461         re.compile(r'bugsense', re.IGNORECASE),
1462         re.compile(r'crashlytics', re.IGNORECASE),
1463         re.compile(r'ouya.*sdk', re.IGNORECASE),
1464         re.compile(r'libspen23', re.IGNORECASE),
1465     ]
1466
1467     scanignore = getpaths(build_dir, thisbuild, 'scanignore')
1468     scandelete = getpaths(build_dir, thisbuild, 'scandelete')
1469
1470     scanignore_worked = set()
1471     scandelete_worked = set()
1472
1473     try:
1474         ms = magic.open(magic.MIME_TYPE)
1475         ms.load()
1476     except AttributeError:
1477         ms = None
1478
1479     def toignore(fd):
1480         for p in scanignore:
1481             if fd.startswith(p):
1482                 scanignore_worked.add(p)
1483                 return True
1484         return False
1485
1486     def todelete(fd):
1487         for p in scandelete:
1488             if fd.startswith(p):
1489                 scandelete_worked.add(p)
1490                 return True
1491         return False
1492
1493     def ignoreproblem(what, fd, fp):
1494         logging.info('Ignoring %s at %s' % (what, fd))
1495         return 0
1496
1497     def removeproblem(what, fd, fp):
1498         logging.info('Removing %s at %s' % (what, fd))
1499         os.remove(fp)
1500         return 0
1501
1502     def warnproblem(what, fd):
1503         logging.warn('Found %s at %s' % (what, fd))
1504
1505     def handleproblem(what, fd, fp):
1506         if toignore(fd):
1507             return ignoreproblem(what, fd, fp)
1508         if todelete(fd):
1509             return removeproblem(what, fd, fp)
1510         logging.error('Found %s at %s' % (what, fd))
1511         return 1
1512
1513     # Iterate through all files in the source code
1514     for r, d, f in os.walk(build_dir, topdown=True):
1515
1516         # It's topdown, so checking the basename is enough
1517         for ignoredir in ('.hg', '.git', '.svn', '.bzr'):
1518             if ignoredir in d:
1519                 d.remove(ignoredir)
1520
1521         for curfile in f:
1522
1523             # Path (relative) to the file
1524             fp = os.path.join(r, curfile)
1525             fd = fp[len(build_dir) + 1:]
1526
1527             try:
1528                 mime = magic.from_file(fp, mime=True) if ms is None else ms.file(fp)
1529             except UnicodeError:
1530                 warnproblem('malformed magic number', fd)
1531
1532             if mime == 'application/x-sharedlib':
1533                 count += handleproblem('shared library', fd, fp)
1534
1535             elif mime == 'application/x-archive':
1536                 count += handleproblem('static library', fd, fp)
1537
1538             elif mime == 'application/x-executable':
1539                 count += handleproblem('binary executable', fd, fp)
1540
1541             elif mime == 'application/x-java-applet':
1542                 count += handleproblem('Java compiled class', fd, fp)
1543
1544             elif mime in (
1545                     'application/jar',
1546                     'application/zip',
1547                     'application/java-archive',
1548                     'application/octet-stream',
1549                     'binary', ):
1550
1551                 if has_extension(fp, 'apk'):
1552                     removeproblem('APK file', fd, fp)
1553
1554                 elif has_extension(fp, 'jar'):
1555
1556                     if any(suspect.match(curfile) for suspect in usual_suspects):
1557                         count += handleproblem('usual supect', fd, fp)
1558                     else:
1559                         warnproblem('JAR file', fd)
1560
1561                 elif has_extension(fp, 'zip'):
1562                     warnproblem('ZIP file', fd)
1563
1564                 else:
1565                     warnproblem('unknown compressed or binary file', fd)
1566
1567             elif has_extension(fp, 'java') and os.path.isfile(fp):
1568                 if not os.path.isfile(fp):
1569                     continue
1570                 for line in file(fp):
1571                     if 'DexClassLoader' in line:
1572                         count += handleproblem('DexClassLoader', fd, fp)
1573                         break
1574     if ms is not None:
1575         ms.close()
1576
1577     for p in scanignore:
1578         if p not in scanignore_worked:
1579             logging.error('Unused scanignore path: %s' % p)
1580             count += 1
1581
1582     for p in scandelete:
1583         if p not in scandelete_worked:
1584             logging.error('Unused scandelete path: %s' % p)
1585             count += 1
1586
1587     # Presence of a jni directory without buildjni=yes might
1588     # indicate a problem (if it's not a problem, explicitly use
1589     # buildjni=no to bypass this check)
1590     if (os.path.exists(os.path.join(root_dir, 'jni')) and
1591             not thisbuild['buildjni']):
1592         logging.error('Found jni directory, but buildjni is not enabled. Set it to \'no\' to ignore.')
1593         count += 1
1594
1595     return count
1596
1597
1598 class KnownApks:
1599
1600     def __init__(self):
1601         self.path = os.path.join('stats', 'known_apks.txt')
1602         self.apks = {}
1603         if os.path.isfile(self.path):
1604             for line in file(self.path):
1605                 t = line.rstrip().split(' ')
1606                 if len(t) == 2:
1607                     self.apks[t[0]] = (t[1], None)
1608                 else:
1609                     self.apks[t[0]] = (t[1], time.strptime(t[2], '%Y-%m-%d'))
1610         self.changed = False
1611
1612     def writeifchanged(self):
1613         if self.changed:
1614             if not os.path.exists('stats'):
1615                 os.mkdir('stats')
1616             f = open(self.path, 'w')
1617             lst = []
1618             for apk, app in self.apks.iteritems():
1619                 appid, added = app
1620                 line = apk + ' ' + appid
1621                 if added:
1622                     line += ' ' + time.strftime('%Y-%m-%d', added)
1623                 lst.append(line)
1624             for line in sorted(lst):
1625                 f.write(line + '\n')
1626             f.close()
1627
1628     # Record an apk (if it's new, otherwise does nothing)
1629     # Returns the date it was added.
1630     def recordapk(self, apk, app):
1631         if apk not in self.apks:
1632             self.apks[apk] = (app, time.gmtime(time.time()))
1633             self.changed = True
1634         _, added = self.apks[apk]
1635         return added
1636
1637     # Look up information - given the 'apkname', returns (app id, date added/None).
1638     # Or returns None for an unknown apk.
1639     def getapp(self, apkname):
1640         if apkname in self.apks:
1641             return self.apks[apkname]
1642         return None
1643
1644     # Get the most recent 'num' apps added to the repo, as a list of package ids
1645     # with the most recent first.
1646     def getlatest(self, num):
1647         apps = {}
1648         for apk, app in self.apks.iteritems():
1649             appid, added = app
1650             if added:
1651                 if appid in apps:
1652                     if apps[appid] > added:
1653                         apps[appid] = added
1654                 else:
1655                     apps[appid] = added
1656         sortedapps = sorted(apps.iteritems(), key=operator.itemgetter(1))[-num:]
1657         lst = [app for app, _ in sortedapps]
1658         lst.reverse()
1659         return lst
1660
1661
1662 def isApkDebuggable(apkfile, config):
1663     """Returns True if the given apk file is debuggable
1664
1665     :param apkfile: full path to the apk to check"""
1666
1667     p = SdkToolsPopen(['aapt', 'dump', 'xmltree', apkfile, 'AndroidManifest.xml'],
1668                       output=False)
1669     if p.returncode != 0:
1670         logging.critical("Failed to get apk manifest information")
1671         sys.exit(1)
1672     for line in p.output.splitlines():
1673         if 'android:debuggable' in line and not line.endswith('0x0'):
1674             return True
1675     return False
1676
1677
1678 class AsynchronousFileReader(threading.Thread):
1679
1680     '''
1681     Helper class to implement asynchronous reading of a file
1682     in a separate thread. Pushes read lines on a queue to
1683     be consumed in another thread.
1684     '''
1685
1686     def __init__(self, fd, queue):
1687         assert isinstance(queue, Queue.Queue)
1688         assert callable(fd.readline)
1689         threading.Thread.__init__(self)
1690         self._fd = fd
1691         self._queue = queue
1692
1693     def run(self):
1694         '''The body of the tread: read lines and put them on the queue.'''
1695         for line in iter(self._fd.readline, ''):
1696             self._queue.put(line)
1697
1698     def eof(self):
1699         '''Check whether there is no more content to expect.'''
1700         return not self.is_alive() and self._queue.empty()
1701
1702
1703 class PopenResult:
1704     returncode = None
1705     output = ''
1706
1707
1708 def SdkToolsPopen(commands, cwd=None, output=True):
1709     cmd = commands[0]
1710     if cmd not in config:
1711         config[cmd] = find_sdk_tools_cmd(commands[0])
1712     return FDroidPopen([config[cmd]] + commands[1:],
1713                        cwd=cwd, output=output)
1714
1715
1716 def FDroidPopen(commands, cwd=None, output=True):
1717     """
1718     Run a command and capture the possibly huge output.
1719
1720     :param commands: command and argument list like in subprocess.Popen
1721     :param cwd: optionally specifies a working directory
1722     :returns: A PopenResult.
1723     """
1724
1725     global env
1726
1727     if cwd:
1728         cwd = os.path.normpath(cwd)
1729         logging.debug("Directory: %s" % cwd)
1730     logging.debug("> %s" % ' '.join(commands))
1731
1732     result = PopenResult()
1733     p = None
1734     try:
1735         p = subprocess.Popen(commands, cwd=cwd, shell=False, env=env,
1736                              stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
1737     except OSError, e:
1738         raise BuildException("OSError while trying to execute " +
1739                              ' '.join(commands) + ': ' + str(e))
1740
1741     stdout_queue = Queue.Queue()
1742     stdout_reader = AsynchronousFileReader(p.stdout, stdout_queue)
1743     stdout_reader.start()
1744
1745     # Check the queue for output (until there is no more to get)
1746     while not stdout_reader.eof():
1747         while not stdout_queue.empty():
1748             line = stdout_queue.get()
1749             if output and options.verbose:
1750                 # Output directly to console
1751                 sys.stderr.write(line)
1752                 sys.stderr.flush()
1753             result.output += line
1754
1755         time.sleep(0.1)
1756
1757     result.returncode = p.wait()
1758     return result
1759
1760
1761 def remove_signing_keys(build_dir):
1762     comment = re.compile(r'[ ]*//')
1763     signing_configs = re.compile(r'^[\t ]*signingConfigs[ \t]*{[ \t]*$')
1764     line_matches = [
1765         re.compile(r'^[\t ]*signingConfig [^ ]*$'),
1766         re.compile(r'.*android\.signingConfigs\.[^{]*$'),
1767         re.compile(r'.*variant\.outputFile = .*'),
1768         re.compile(r'.*output\.outputFile = .*'),
1769         re.compile(r'.*\.readLine\(.*'),
1770     ]
1771     for root, dirs, files in os.walk(build_dir):
1772         if 'build.gradle' in files:
1773             path = os.path.join(root, 'build.gradle')
1774
1775             with open(path, "r") as o:
1776                 lines = o.readlines()
1777
1778             changed = False
1779
1780             opened = 0
1781             i = 0
1782             with open(path, "w") as o:
1783                 while i < len(lines):
1784                     line = lines[i]
1785                     i += 1
1786                     while line.endswith('\\\n'):
1787                         line = line.rstrip('\\\n') + lines[i]
1788                         i += 1
1789
1790                     if comment.match(line):
1791                         continue
1792
1793                     if opened > 0:
1794                         opened += line.count('{')
1795                         opened -= line.count('}')
1796                         continue
1797
1798                     if signing_configs.match(line):
1799                         changed = True
1800                         opened += 1
1801                         continue
1802
1803                     if any(s.match(line) for s in line_matches):
1804                         changed = True
1805                         continue
1806
1807                     if opened == 0:
1808                         o.write(line)
1809
1810             if changed:
1811                 logging.info("Cleaned build.gradle of keysigning configs at %s" % path)
1812
1813         for propfile in [
1814                 'project.properties',
1815                 'build.properties',
1816                 'default.properties',
1817                 'ant.properties', ]:
1818             if propfile in files:
1819                 path = os.path.join(root, propfile)
1820
1821                 with open(path, "r") as o:
1822                     lines = o.readlines()
1823
1824                 changed = False
1825
1826                 with open(path, "w") as o:
1827                     for line in lines:
1828                         if any(line.startswith(s) for s in ('key.store', 'key.alias')):
1829                             changed = True
1830                             continue
1831
1832                         o.write(line)
1833
1834                 if changed:
1835                     logging.info("Cleaned %s of keysigning configs at %s" % (propfile, path))
1836
1837
1838 def reset_env_path():
1839     global env, orig_path
1840     env['PATH'] = orig_path
1841
1842
1843 def add_to_env_path(path):
1844     global env
1845     paths = env['PATH'].split(os.pathsep)
1846     if path in paths:
1847         return
1848     paths.append(path)
1849     env['PATH'] = os.pathsep.join(paths)
1850
1851
1852 def replace_config_vars(cmd, build):
1853     global env
1854     cmd = cmd.replace('$$SDK$$', config['sdk_path'])
1855     # env['ANDROID_NDK'] is set in build_local right before prepare_source
1856     cmd = cmd.replace('$$NDK$$', env['ANDROID_NDK'])
1857     cmd = cmd.replace('$$MVN3$$', config['mvn3'])
1858     if build is not None:
1859         cmd = cmd.replace('$$COMMIT$$', build['commit'])
1860         cmd = cmd.replace('$$VERSION$$', build['version'])
1861         cmd = cmd.replace('$$VERCODE$$', build['vercode'])
1862     return cmd
1863
1864
1865 def place_srclib(root_dir, number, libpath):
1866     if not number:
1867         return
1868     relpath = os.path.relpath(libpath, root_dir)
1869     proppath = os.path.join(root_dir, 'project.properties')
1870
1871     lines = []
1872     if os.path.isfile(proppath):
1873         with open(proppath, "r") as o:
1874             lines = o.readlines()
1875
1876     with open(proppath, "w") as o:
1877         placed = False
1878         for line in lines:
1879             if line.startswith('android.library.reference.%d=' % number):
1880                 o.write('android.library.reference.%d=%s\n' % (number, relpath))
1881                 placed = True
1882             else:
1883                 o.write(line)
1884         if not placed:
1885             o.write('android.library.reference.%d=%s\n' % (number, relpath))
1886
1887
1888 def verify_apks(signed_apk, unsigned_apk, tmp_dir):
1889     """Verify that two apks are the same
1890
1891     One of the inputs is signed, the other is unsigned. The signature metadata
1892     is transferred from the signed to the unsigned apk, and then jarsigner is
1893     used to verify that the signature from the signed apk is also varlid for
1894     the unsigned one.
1895     :param signed_apk: Path to a signed apk file
1896     :param unsigned_apk: Path to an unsigned apk file expected to match it
1897     :param tmp_dir: Path to directory for temporary files
1898     :returns: None if the verification is successful, otherwise a string
1899               describing what went wrong.
1900     """
1901     sigfile = re.compile(r'META-INF/[0-9A-Za-z]+\.(SF|RSA)')
1902     with ZipFile(signed_apk) as signed_apk_as_zip:
1903         meta_inf_files = ['META-INF/MANIFEST.MF']
1904         for f in signed_apk_as_zip.namelist():
1905             if sigfile.match(f):
1906                 meta_inf_files.append(f)
1907         if len(meta_inf_files) < 3:
1908             return "Signature files missing from {0}".format(signed_apk)
1909         signed_apk_as_zip.extractall(tmp_dir, meta_inf_files)
1910     with ZipFile(unsigned_apk, mode='a') as unsigned_apk_as_zip:
1911         for meta_inf_file in meta_inf_files:
1912             unsigned_apk_as_zip.write(os.path.join(tmp_dir, meta_inf_file), arcname=meta_inf_file)
1913
1914     if subprocess.call(['jarsigner', '-verify', unsigned_apk]) != 0:
1915         logging.info("...NOT verified - {0}".format(signed_apk))
1916         return compare_apks(signed_apk, unsigned_apk, tmp_dir)
1917     logging.info("...successfully verified")
1918     return None
1919
1920
1921 def compare_apks(apk1, apk2, tmp_dir):
1922     """Compare two apks
1923
1924     Returns None if the apk content is the same (apart from the signing key),
1925     otherwise a string describing what's different, or what went wrong when
1926     trying to do the comparison.
1927     """
1928
1929     badchars = re.compile('''[/ :;'"]''')
1930     apk1dir = os.path.join(tmp_dir, badchars.sub('_', apk1[0:-4]))  # trim .apk
1931     apk2dir = os.path.join(tmp_dir, badchars.sub('_', apk2[0:-4]))  # trim .apk
1932     for d in [apk1dir, apk2dir]:
1933         if os.path.exists(d):
1934             shutil.rmtree(d)
1935         os.mkdir(d)
1936         os.mkdir(os.path.join(d, 'jar-xf'))
1937
1938     if subprocess.call(['jar', 'xf',
1939                         os.path.abspath(apk1)],
1940                        cwd=os.path.join(apk1dir, 'jar-xf')) != 0:
1941         return("Failed to unpack " + apk1)
1942     if subprocess.call(['jar', 'xf',
1943                         os.path.abspath(apk2)],
1944                        cwd=os.path.join(apk2dir, 'jar-xf')) != 0:
1945         return("Failed to unpack " + apk2)
1946
1947     # try to find apktool in the path, if it hasn't been manually configed
1948     if 'apktool' not in config:
1949         tmp = find_command('apktool')
1950         if tmp is not None:
1951             config['apktool'] = tmp
1952     if 'apktool' in config:
1953         if subprocess.call([config['apktool'], 'd', os.path.abspath(apk1), '--output', 'apktool'],
1954                            cwd=apk1dir) != 0:
1955             return("Failed to unpack " + apk1)
1956         if subprocess.call([config['apktool'], 'd', os.path.abspath(apk2), '--output', 'apktool'],
1957                            cwd=apk2dir) != 0:
1958             return("Failed to unpack " + apk2)
1959
1960     p = FDroidPopen(['diff', '-r', apk1dir, apk2dir], output=False)
1961     lines = p.output.splitlines()
1962     if len(lines) != 1 or 'META-INF' not in lines[0]:
1963         meld = find_command('meld')
1964         if meld is not None:
1965             p = FDroidPopen(['meld', apk1dir, apk2dir], output=False)
1966         return("Unexpected diff output - " + p.output)
1967
1968     # since everything verifies, delete the comparison to keep cruft down
1969     shutil.rmtree(apk1dir)
1970     shutil.rmtree(apk2dir)
1971
1972     # If we get here, it seems like they're the same!
1973     return None
1974
1975
1976 def find_command(command):
1977     '''find the full path of a command, or None if it can't be found in the PATH'''
1978
1979     def is_exe(fpath):
1980         return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
1981
1982     fpath, fname = os.path.split(command)
1983     if fpath:
1984         if is_exe(command):
1985             return command
1986     else:
1987         for path in os.environ["PATH"].split(os.pathsep):
1988             path = path.strip('"')
1989             exe_file = os.path.join(path, command)
1990             if is_exe(exe_file):
1991                 return exe_file
1992
1993     return None
1994
1995
1996 def genpassword():
1997     '''generate a random password for when generating keys'''
1998     h = hashlib.sha256()
1999     h.update(os.urandom(16))  # salt
2000     h.update(bytes(socket.getfqdn()))
2001     return h.digest().encode('base64').strip()
2002
2003
2004 def genkeystore(localconfig):
2005     '''Generate a new key with random passwords and add it to new keystore'''
2006     logging.info('Generating a new key in "' + localconfig['keystore'] + '"...')
2007     keystoredir = os.path.dirname(localconfig['keystore'])
2008     if keystoredir is None or keystoredir == '':
2009         keystoredir = os.path.join(os.getcwd(), keystoredir)
2010     if not os.path.exists(keystoredir):
2011         os.makedirs(keystoredir, mode=0o700)
2012
2013     write_password_file("keystorepass", localconfig['keystorepass'])
2014     write_password_file("keypass", localconfig['keypass'])
2015     p = FDroidPopen(['keytool', '-genkey',
2016                      '-keystore', localconfig['keystore'],
2017                      '-alias', localconfig['repo_keyalias'],
2018                      '-keyalg', 'RSA', '-keysize', '4096',
2019                      '-sigalg', 'SHA256withRSA',
2020                      '-validity', '10000',
2021                      '-storepass:file', config['keystorepassfile'],
2022                      '-keypass:file', config['keypassfile'],
2023                      '-dname', localconfig['keydname']])
2024     # TODO keypass should be sent via stdin
2025     os.chmod(localconfig['keystore'], 0o0600)
2026     if p.returncode != 0:
2027         raise BuildException("Failed to generate key", p.output)
2028     # now show the lovely key that was just generated
2029     p = FDroidPopen(['keytool', '-list', '-v',
2030                      '-keystore', localconfig['keystore'],
2031                      '-alias', localconfig['repo_keyalias'],
2032                      '-storepass:file', config['keystorepassfile']])
2033     logging.info(p.output.strip() + '\n\n')
2034
2035
2036 def write_to_config(thisconfig, key, value=None):
2037     '''write a key/value to the local config.py'''
2038     if value is None:
2039         origkey = key + '_orig'
2040         value = thisconfig[origkey] if origkey in thisconfig else thisconfig[key]
2041     with open('config.py', 'r') as f:
2042         data = f.read()
2043     pattern = '\n[\s#]*' + key + '\s*=\s*"[^"]*"'
2044     repl = '\n' + key + ' = "' + value + '"'
2045     data = re.sub(pattern, repl, data)
2046     # if this key is not in the file, append it
2047     if not re.match('\s*' + key + '\s*=\s*"', data):
2048         data += repl
2049     # make sure the file ends with a carraige return
2050     if not re.match('\n$', data):
2051         data += '\n'
2052     with open('config.py', 'w') as f:
2053         f.writelines(data)
2054
2055
2056 def parse_xml(path):
2057     return XMLElementTree.parse(path).getroot()