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.1",
  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 unescape_string(string):
 863     if string[0] == '"' and string[-1] == '"':
 864         return string[1:-1]
 865
 866     return string.replace("\\'", "'")
 867
 868
 869 def retrieve_string(app_dir, string, xmlfiles=None):
 870
 871     if xmlfiles is None:
 872         xmlfiles = []
 873         for res_dir in [
 874             os.path.join(app_dir, 'res'),
 875             os.path.join(app_dir, 'src', 'main', 'res'),
 876         ]:
 877             for r, d, f in os.walk(res_dir):
 878                 if os.path.basename(r) == 'values':
 879                     xmlfiles += [os.path.join(r, x) for x in f if x.endswith('.xml')]
 880
 881     if not string.startswith('@string/'):
 882         return unescape_string(string)
 883
 884     name = string[len('@string/'):]
 885
 886     for path in xmlfiles:
 887         if not os.path.isfile(path):
 888             continue
 889         xml = parse_xml(path)
 890         element = xml.find('string[@name="' + name + '"]')
 891         if element is not None and element.text is not None:
 892             return retrieve_string(app_dir, element.text.encode('utf-8'), xmlfiles)
 893
 894     return ''
 895
 896
 897 # Return list of existing files that will be used to find the highest vercode
 898 def manifest_paths(app_dir, flavours):
 899
 900     possible_manifests = \
 901         [os.path.join(app_dir, 'AndroidManifest.xml'),
 902          os.path.join(app_dir, 'src', 'main', 'AndroidManifest.xml'),
 903          os.path.join(app_dir, 'src', 'AndroidManifest.xml'),
 904          os.path.join(app_dir, 'build.gradle')]
 905
 906     for flavour in flavours:
 907         if flavour == 'yes':
 908             continue
 909         possible_manifests.append(
 910             os.path.join(app_dir, 'src', flavour, 'AndroidManifest.xml'))
 911
 912     return [path for path in possible_manifests if os.path.isfile(path)]
 913
 914
 915 # Retrieve the package name. Returns the name, or None if not found.
 916 def fetch_real_name(app_dir, flavours):
 917     for path in manifest_paths(app_dir, flavours):
 918         if not has_extension(path, 'xml') or not os.path.isfile(path):
 919             continue
 920         logging.debug("fetch_real_name: Checking manifest at " + path)
 921         xml = parse_xml(path)
 922         app = xml.find('application')
 923         if "{http://schemas.android.com/apk/res/android}label" not in app.attrib:
 924             continue
 925         label = app.attrib["{http://schemas.android.com/apk/res/android}label"].encode('utf-8')
 926         result = retrieve_string(app_dir, label)
 927         if result:
 928             result = result.strip()
 929         return result
 930     return None
 931
 932
 933 # Retrieve the version name
 934 def version_name(original, app_dir, flavours):
 935     for path in manifest_paths(app_dir, flavours):
 936         if not has_extension(path, 'xml'):
 937             continue
 938         string = retrieve_string(app_dir, original)
 939         if string:
 940             return string
 941     return original
 942
 943
 944 def get_library_references(root_dir):
 945     libraries = []
 946     proppath = os.path.join(root_dir, 'project.properties')
 947     if not os.path.isfile(proppath):
 948         return libraries
 949     for line in file(proppath):
 950         if not line.startswith('android.library.reference.'):
 951             continue
 952         path = line.split('=')[1].strip()
 953         relpath = os.path.join(root_dir, path)
 954         if not os.path.isdir(relpath):
 955             continue
 956         logging.debug("Found subproject at %s" % path)
 957         libraries.append(path)
 958     return libraries
 959
 960
 961 def ant_subprojects(root_dir):
 962     subprojects = get_library_references(root_dir)
 963     for subpath in subprojects:
 964         subrelpath = os.path.join(root_dir, subpath)
 965         for p in get_library_references(subrelpath):
 966             relp = os.path.normpath(os.path.join(subpath, p))
 967             if relp not in subprojects:
 968                 subprojects.insert(0, relp)
 969     return subprojects
 970
 971
 972 def remove_debuggable_flags(root_dir):
 973     # Remove forced debuggable flags
 974     logging.debug("Removing debuggable flags from %s" % root_dir)
 975     for root, dirs, files in os.walk(root_dir):
 976         if 'AndroidManifest.xml' in files:
 977             path = os.path.join(root, 'AndroidManifest.xml')
 978             p = FDroidPopen(['sed', '-i', 's/android:debuggable="[^"]*"//g', path], output=False)
 979             if p.returncode != 0:
 980                 raise BuildException("Failed to remove debuggable flags of %s" % path)
 981
 982
 983 # Extract some information from the AndroidManifest.xml at the given path.
 984 # Returns (version, vercode, package), any or all of which might be None.
 985 # All values returned are strings.
 986 def parse_androidmanifests(paths, ignoreversions=None):
 987
 988     if not paths:
 989         return (None, None, None)
 990
 991     vcsearch_g = re.compile(r'.*versionCode *=* *["\']*([0-9]+)["\']*').search
 992     vnsearch_g = re.compile(r'.*versionName *=* *(["\'])((?:(?=(\\?))\3.)*?)\1.*').search
 993     psearch_g = re.compile(r'.*packageName *=* *["\']([^"]+)["\'].*').search
 994
 995     ignoresearch = re.compile(ignoreversions).search if ignoreversions else None
 996
 997     max_version = None
 998     max_vercode = None
 999     max_package = None
1000
1001     for path in paths:
1002
1003         if not os.path.isfile(path):
1004             continue
1005
1006         logging.debug("Parsing manifest at {0}".format(path))
1007         gradle = has_extension(path, 'gradle')
1008         version = None
1009         vercode = None
1010         # Remember package name, may be defined separately from version+vercode
1011         package = max_package
1012
1013         if gradle:
1014             for line in file(path):
1015                 if not package:
1016                     matches = psearch_g(line)
1017                     if matches:
1018                         package = matches.group(1)
1019                 if not version:
1020                     matches = vnsearch_g(line)
1021                     if matches:
1022                         version = matches.group(2)
1023                 if not vercode:
1024                     matches = vcsearch_g(line)
1025                     if matches:
1026                         vercode = matches.group(1)
1027         else:
1028             xml = parse_xml(path)
1029             if "package" in xml.attrib:
1030                 package = xml.attrib["package"].encode('utf-8')
1031             if "{http://schemas.android.com/apk/res/android}versionName" in xml.attrib:
1032                 version = xml.attrib["{http://schemas.android.com/apk/res/android}versionName"].encode('utf-8')
1033             if "{http://schemas.android.com/apk/res/android}versionCode" in xml.attrib:
1034                 a = xml.attrib["{http://schemas.android.com/apk/res/android}versionCode"].encode('utf-8')
1035                 if string_is_integer(a):
1036                     vercode = a
1037
1038         logging.debug("..got package={0}, version={1}, vercode={2}"
1039                       .format(package, version, vercode))
1040
1041         # Always grab the package name and version name in case they are not
1042         # together with the highest version code
1043         if max_package is None and package is not None:
1044             max_package = package
1045         if max_version is None and version is not None:
1046             max_version = version
1047
1048         if max_vercode is None or (vercode is not None and vercode > max_vercode):
1049             if not ignoresearch or not ignoresearch(version):
1050                 if version is not None:
1051                     max_version = version
1052                 if vercode is not None:
1053                     max_vercode = vercode
1054                 if package is not None:
1055                     max_package = package
1056             else:
1057                 max_version = "Ignore"
1058
1059     if max_version is None:
1060         max_version = "Unknown"
1061
1062     if max_package and not is_valid_package_name(max_package):
1063         raise FDroidException("Invalid package name {0}".format(max_package))
1064
1065     return (max_version, max_vercode, max_package)
1066
1067
1068 def is_valid_package_name(name):
1069     return re.match("[A-Za-z_][A-Za-z_0-9.]+$", name)
1070
1071
1072 class FDroidException(Exception):
1073
1074     def __init__(self, value, detail=None):
1075         self.value = value
1076         self.detail = detail
1077
1078     def get_wikitext(self):
1079         ret = repr(self.value) + "\n"
1080         if self.detail:
1081             ret += "=detail=\n"
1082             ret += "<pre>\n"
1083             txt = self.detail[-8192:] if len(self.detail) > 8192 else self.detail
1084             ret += str(txt)
1085             ret += "</pre>\n"
1086         return ret
1087
1088     def __str__(self):
1089         ret = self.value
1090         if self.detail:
1091             ret += "\n==== detail begin ====\n%s\n==== detail end ====" % self.detail.strip()
1092         return ret
1093
1094
1095 class VCSException(FDroidException):
1096     pass
1097
1098
1099 class BuildException(FDroidException):
1100     pass
1101
1102
1103 # Get the specified source library.
1104 # Returns the path to it. Normally this is the path to be used when referencing
1105 # it, which may be a subdirectory of the actual project. If you want the base
1106 # directory of the project, pass 'basepath=True'.
1107 def getsrclib(spec, srclib_dir, subdir=None, basepath=False,
1108               raw=False, prepare=True, preponly=False):
1109
1110     number = None
1111     subdir = None
1112     if raw:
1113         name = spec
1114         ref = None
1115     else:
1116         name, ref = spec.split('@')
1117         if ':' in name:
1118             number, name = name.split(':', 1)
1119         if '/' in name:
1120             name, subdir = name.split('/', 1)
1121
1122     if name not in metadata.srclibs:
1123         raise VCSException('srclib ' + name + ' not found.')
1124
1125     srclib = metadata.srclibs[name]
1126
1127     sdir = os.path.join(srclib_dir, name)
1128
1129     if not preponly:
1130         vcs = getvcs(srclib["Repo Type"], srclib["Repo"], sdir)
1131         vcs.srclib = (name, number, sdir)
1132         if ref:
1133             vcs.gotorevision(ref)
1134
1135         if raw:
1136             return vcs
1137
1138     libdir = None
1139     if subdir:
1140         libdir = os.path.join(sdir, subdir)
1141     elif srclib["Subdir"]:
1142         for subdir in srclib["Subdir"]:
1143             libdir_candidate = os.path.join(sdir, subdir)
1144             if os.path.exists(libdir_candidate):
1145                 libdir = libdir_candidate
1146                 break
1147
1148     if libdir is None:
1149         libdir = sdir
1150
1151     remove_signing_keys(sdir)
1152     remove_debuggable_flags(sdir)
1153
1154     if prepare:
1155
1156         if srclib["Prepare"]:
1157             cmd = replace_config_vars(srclib["Prepare"], None)
1158
1159             p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=libdir)
1160             if p.returncode != 0:
1161                 raise BuildException("Error running prepare command for srclib %s"
1162                                      % name, p.output)
1163
1164     if basepath:
1165         libdir = sdir
1166
1167     return (name, number, libdir)
1168
1169
1170 # Prepare the source code for a particular build
1171 #  'vcs'         - the appropriate vcs object for the application
1172 #  'app'         - the application details from the metadata
1173 #  'build'       - the build details from the metadata
1174 #  'build_dir'   - the path to the build directory, usually
1175 #                   'build/app.id'
1176 #  'srclib_dir'  - the path to the source libraries directory, usually
1177 #                   'build/srclib'
1178 #  'extlib_dir'  - the path to the external libraries directory, usually
1179 #                   'build/extlib'
1180 # Returns the (root, srclibpaths) where:
1181 #   'root' is the root directory, which may be the same as 'build_dir' or may
1182 #          be a subdirectory of it.
1183 #   'srclibpaths' is information on the srclibs being used
1184 def prepare_source(vcs, app, build, build_dir, srclib_dir, extlib_dir, onserver=False):
1185
1186     # Optionally, the actual app source can be in a subdirectory
1187     if build['subdir']:
1188         root_dir = os.path.join(build_dir, build['subdir'])
1189     else:
1190         root_dir = build_dir
1191
1192     # Get a working copy of the right revision
1193     logging.info("Getting source for revision " + build['commit'])
1194     vcs.gotorevision(build['commit'])
1195
1196     # Initialise submodules if requred
1197     if build['submodules']:
1198         logging.info("Initialising submodules")
1199         vcs.initsubmodules()
1200
1201     # Check that a subdir (if we're using one) exists. This has to happen
1202     # after the checkout, since it might not exist elsewhere
1203     if not os.path.exists(root_dir):
1204         raise BuildException('Missing subdir ' + root_dir)
1205
1206     # Run an init command if one is required
1207     if build['init']:
1208         cmd = replace_config_vars(build['init'], build)
1209         logging.info("Running 'init' commands in %s" % root_dir)
1210
1211         p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1212         if p.returncode != 0:
1213             raise BuildException("Error running init command for %s:%s" %
1214                                  (app['id'], build['version']), p.output)
1215
1216     # Apply patches if any
1217     if build['patch']:
1218         logging.info("Applying patches")
1219         for patch in build['patch']:
1220             patch = patch.strip()
1221             logging.info("Applying " + patch)
1222             patch_path = os.path.join('metadata', app['id'], patch)
1223             p = FDroidPopen(['patch', '-p1', '-i', os.path.abspath(patch_path)], cwd=build_dir)
1224             if p.returncode != 0:
1225                 raise BuildException("Failed to apply patch %s" % patch_path)
1226
1227     # Get required source libraries
1228     srclibpaths = []
1229     if build['srclibs']:
1230         logging.info("Collecting source libraries")
1231         for lib in build['srclibs']:
1232             srclibpaths.append(getsrclib(lib, srclib_dir, build, preponly=onserver))
1233
1234     for name, number, libpath in srclibpaths:
1235         place_srclib(root_dir, int(number) if number else None, libpath)
1236
1237     basesrclib = vcs.getsrclib()
1238     # If one was used for the main source, add that too.
1239     if basesrclib:
1240         srclibpaths.append(basesrclib)
1241
1242     # Update the local.properties file
1243     localprops = [os.path.join(build_dir, 'local.properties')]
1244     if build['subdir']:
1245         localprops += [os.path.join(root_dir, 'local.properties')]
1246     for path in localprops:
1247         props = ""
1248         if os.path.isfile(path):
1249             logging.info("Updating local.properties file at %s" % path)
1250             f = open(path, 'r')
1251             props += f.read()
1252             f.close()
1253             props += '\n'
1254         else:
1255             logging.info("Creating local.properties file at %s" % path)
1256         # Fix old-fashioned 'sdk-location' by copying
1257         # from sdk.dir, if necessary
1258         if build['oldsdkloc']:
1259             sdkloc = re.match(r".*^sdk.dir=(\S+)$.*", props,
1260                               re.S | re.M).group(1)
1261             props += "sdk-location=%s\n" % sdkloc
1262         else:
1263             props += "sdk.dir=%s\n" % config['sdk_path']
1264             props += "sdk-location=%s\n" % config['sdk_path']
1265         if build['ndk_path']:
1266             # Add ndk location
1267             props += "ndk.dir=%s\n" % build['ndk_path']
1268             props += "ndk-location=%s\n" % build['ndk_path']
1269         # Add java.encoding if necessary
1270         if build['encoding']:
1271             props += "java.encoding=%s\n" % build['encoding']
1272         f = open(path, 'w')
1273         f.write(props)
1274         f.close()
1275
1276     flavours = []
1277     if build['type'] == 'gradle':
1278         flavours = build['gradle']
1279
1280         version_regex = re.compile(r"[^/]*'com\.android\.tools\.build:gradle:([^\.]+\.[^\.]+).*'.*")
1281         gradlepluginver = None
1282
1283         gradle_dirs = [root_dir]
1284
1285         # Parent dir build.gradle
1286         parent_dir = os.path.normpath(os.path.join(root_dir, '..'))
1287         if parent_dir.startswith(build_dir):
1288             gradle_dirs.append(parent_dir)
1289
1290         for dir_path in gradle_dirs:
1291             if gradlepluginver:
1292                 break
1293             if not os.path.isdir(dir_path):
1294                 continue
1295             for filename in os.listdir(dir_path):
1296                 if not filename.endswith('.gradle'):
1297                     continue
1298                 path = os.path.join(dir_path, filename)
1299                 if not os.path.isfile(path):
1300                     continue
1301                 for line in file(path):
1302                     match = version_regex.match(line)
1303                     if match:
1304                         gradlepluginver = match.group(1)
1305                         break
1306
1307         if gradlepluginver:
1308             build['gradlepluginver'] = LooseVersion(gradlepluginver)
1309         else:
1310             logging.warn("Could not fetch the gradle plugin version, defaulting to 0.11")
1311             build['gradlepluginver'] = LooseVersion('0.11')
1312
1313         if build['target']:
1314             n = build["target"].split('-')[1]
1315             FDroidPopen(['sed', '-i',
1316                          's@compileSdkVersion *[0-9]*@compileSdkVersion ' + n + '@g',
1317                          'build.gradle'], cwd=root_dir, output=False)
1318
1319     # Remove forced debuggable flags
1320     remove_debuggable_flags(root_dir)
1321
1322     # Insert version code and number into the manifest if necessary
1323     if build['forceversion']:
1324         logging.info("Changing the version name")
1325         for path in manifest_paths(root_dir, flavours):
1326             if not os.path.isfile(path):
1327                 continue
1328             if has_extension(path, 'xml'):
1329                 p = FDroidPopen(['sed', '-i',
1330                                  's/android:versionName="[^"]*"/android:versionName="' + build['version'] + '"/g',
1331                                  path], output=False)
1332                 if p.returncode != 0:
1333                     raise BuildException("Failed to amend manifest")
1334             elif has_extension(path, 'gradle'):
1335                 p = FDroidPopen(['sed', '-i',
1336                                  's/versionName *=* *.*/versionName = "' + build['version'] + '"/g',
1337                                  path], output=False)
1338                 if p.returncode != 0:
1339                     raise BuildException("Failed to amend build.gradle")
1340     if build['forcevercode']:
1341         logging.info("Changing the version code")
1342         for path in manifest_paths(root_dir, flavours):
1343             if not os.path.isfile(path):
1344                 continue
1345             if has_extension(path, 'xml'):
1346                 p = FDroidPopen(['sed', '-i',
1347                                  's/android:versionCode="[^"]*"/android:versionCode="' + build['vercode'] + '"/g',
1348                                  path], output=False)
1349                 if p.returncode != 0:
1350                     raise BuildException("Failed to amend manifest")
1351             elif has_extension(path, 'gradle'):
1352                 p = FDroidPopen(['sed', '-i',
1353                                  's/versionCode *=* *[0-9]*/versionCode = ' + build['vercode'] + '/g',
1354                                  path], output=False)
1355                 if p.returncode != 0:
1356                     raise BuildException("Failed to amend build.gradle")
1357
1358     # Delete unwanted files
1359     if build['rm']:
1360         logging.info("Removing specified files")
1361         for part in getpaths(build_dir, build, 'rm'):
1362             dest = os.path.join(build_dir, part)
1363             logging.info("Removing {0}".format(part))
1364             if os.path.lexists(dest):
1365                 if os.path.islink(dest):
1366                     FDroidPopen(['unlink', dest], output=False)
1367                 else:
1368                     FDroidPopen(['rm', '-rf', dest], output=False)
1369             else:
1370                 logging.info("...but it didn't exist")
1371
1372     remove_signing_keys(build_dir)
1373
1374     # Add required external libraries
1375     if build['extlibs']:
1376         logging.info("Collecting prebuilt libraries")
1377         libsdir = os.path.join(root_dir, 'libs')
1378         if not os.path.exists(libsdir):
1379             os.mkdir(libsdir)
1380         for lib in build['extlibs']:
1381             lib = lib.strip()
1382             logging.info("...installing extlib {0}".format(lib))
1383             libf = os.path.basename(lib)
1384             libsrc = os.path.join(extlib_dir, lib)
1385             if not os.path.exists(libsrc):
1386                 raise BuildException("Missing extlib file {0}".format(libsrc))
1387             shutil.copyfile(libsrc, os.path.join(libsdir, libf))
1388
1389     # Run a pre-build command if one is required
1390     if build['prebuild']:
1391         logging.info("Running 'prebuild' commands in %s" % root_dir)
1392
1393         cmd = replace_config_vars(build['prebuild'], build)
1394
1395         # Substitute source library paths into prebuild commands
1396         for name, number, libpath in srclibpaths:
1397             libpath = os.path.relpath(libpath, root_dir)
1398             cmd = cmd.replace('$$' + name + '$$', libpath)
1399
1400         p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1401         if p.returncode != 0:
1402             raise BuildException("Error running prebuild command for %s:%s" %
1403                                  (app['id'], build['version']), p.output)
1404
1405     # Generate (or update) the ant build file, build.xml...
1406     if build['update'] and build['update'] != ['no'] and build['type'] == 'ant':
1407         parms = ['android', 'update', 'lib-project']
1408         lparms = ['android', 'update', 'project']
1409
1410         if build['target']:
1411             parms += ['-t', build['target']]
1412             lparms += ['-t', build['target']]
1413         if build['update'] == ['auto']:
1414             update_dirs = ant_subprojects(root_dir) + ['.']
1415         else:
1416             update_dirs = build['update']
1417
1418         for d in update_dirs:
1419             subdir = os.path.join(root_dir, d)
1420             if d == '.':
1421                 logging.debug("Updating main project")
1422                 cmd = parms + ['-p', d]
1423             else:
1424                 logging.debug("Updating subproject %s" % d)
1425                 cmd = lparms + ['-p', d]
1426             p = SdkToolsPopen(cmd, cwd=root_dir)
1427             # Check to see whether an error was returned without a proper exit
1428             # code (this is the case for the 'no target set or target invalid'
1429             # error)
1430             if p.returncode != 0 or p.output.startswith("Error: "):
1431                 raise BuildException("Failed to update project at %s" % d, p.output)
1432             # Clean update dirs via ant
1433             if d != '.':
1434                 logging.info("Cleaning subproject %s" % d)
1435                 p = FDroidPopen(['ant', 'clean'], cwd=subdir)
1436
1437     return (root_dir, srclibpaths)
1438
1439
1440 # Split and extend via globbing the paths from a field
1441 def getpaths(build_dir, build, field):
1442     paths = []
1443     for p in build[field]:
1444         p = p.strip()
1445         full_path = os.path.join(build_dir, p)
1446         full_path = os.path.normpath(full_path)
1447         paths += [r[len(build_dir) + 1:] for r in glob.glob(full_path)]
1448     return paths
1449
1450
1451 # Scan the source code in the given directory (and all subdirectories)
1452 # and return the number of fatal problems encountered
1453 def scan_source(build_dir, root_dir, thisbuild):
1454
1455     count = 0
1456
1457     # Common known non-free blobs (always lower case):
1458     usual_suspects = [
1459         re.compile(r'flurryagent', re.IGNORECASE),
1460         re.compile(r'paypal.*mpl', re.IGNORECASE),
1461         re.compile(r'google.*analytics', re.IGNORECASE),
1462         re.compile(r'admob.*sdk.*android', re.IGNORECASE),
1463         re.compile(r'google.*ad.*view', re.IGNORECASE),
1464         re.compile(r'google.*admob', re.IGNORECASE),
1465         re.compile(r'google.*play.*services', re.IGNORECASE),
1466         re.compile(r'crittercism', re.IGNORECASE),
1467         re.compile(r'heyzap', re.IGNORECASE),
1468         re.compile(r'jpct.*ae', re.IGNORECASE),
1469         re.compile(r'youtube.*android.*player.*api', re.IGNORECASE),
1470         re.compile(r'bugsense', re.IGNORECASE),
1471         re.compile(r'crashlytics', re.IGNORECASE),
1472         re.compile(r'ouya.*sdk', re.IGNORECASE),
1473         re.compile(r'libspen23', re.IGNORECASE),
1474     ]
1475
1476     scanignore = getpaths(build_dir, thisbuild, 'scanignore')
1477     scandelete = getpaths(build_dir, thisbuild, 'scandelete')
1478
1479     scanignore_worked = set()
1480     scandelete_worked = set()
1481
1482     try:
1483         ms = magic.open(magic.MIME_TYPE)
1484         ms.load()
1485     except AttributeError:
1486         ms = None
1487
1488     def toignore(fd):
1489         for p in scanignore:
1490             if fd.startswith(p):
1491                 scanignore_worked.add(p)
1492                 return True
1493         return False
1494
1495     def todelete(fd):
1496         for p in scandelete:
1497             if fd.startswith(p):
1498                 scandelete_worked.add(p)
1499                 return True
1500         return False
1501
1502     def ignoreproblem(what, fd, fp):
1503         logging.info('Ignoring %s at %s' % (what, fd))
1504         return 0
1505
1506     def removeproblem(what, fd, fp):
1507         logging.info('Removing %s at %s' % (what, fd))
1508         os.remove(fp)
1509         return 0
1510
1511     def warnproblem(what, fd):
1512         logging.warn('Found %s at %s' % (what, fd))
1513
1514     def handleproblem(what, fd, fp):
1515         if toignore(fd):
1516             return ignoreproblem(what, fd, fp)
1517         if todelete(fd):
1518             return removeproblem(what, fd, fp)
1519         logging.error('Found %s at %s' % (what, fd))
1520         return 1
1521
1522     # Iterate through all files in the source code
1523     for r, d, f in os.walk(build_dir, topdown=True):
1524
1525         # It's topdown, so checking the basename is enough
1526         for ignoredir in ('.hg', '.git', '.svn', '.bzr'):
1527             if ignoredir in d:
1528                 d.remove(ignoredir)
1529
1530         for curfile in f:
1531
1532             # Path (relative) to the file
1533             fp = os.path.join(r, curfile)
1534             fd = fp[len(build_dir) + 1:]
1535
1536             try:
1537                 mime = magic.from_file(fp, mime=True) if ms is None else ms.file(fp)
1538             except UnicodeError:
1539                 warnproblem('malformed magic number', fd)
1540
1541             if mime == 'application/x-sharedlib':
1542                 count += handleproblem('shared library', fd, fp)
1543
1544             elif mime == 'application/x-archive':
1545                 count += handleproblem('static library', fd, fp)
1546
1547             elif mime == 'application/x-executable':
1548                 count += handleproblem('binary executable', fd, fp)
1549
1550             elif mime == 'application/x-java-applet':
1551                 count += handleproblem('Java compiled class', fd, fp)
1552
1553             elif mime in (
1554                     'application/jar',
1555                     'application/zip',
1556                     'application/java-archive',
1557                     'application/octet-stream',
1558                     'binary', ):
1559
1560                 if has_extension(fp, 'apk'):
1561                     removeproblem('APK file', fd, fp)
1562
1563                 elif has_extension(fp, 'jar'):
1564
1565                     if any(suspect.match(curfile) for suspect in usual_suspects):
1566                         count += handleproblem('usual supect', fd, fp)
1567                     else:
1568                         warnproblem('JAR file', fd)
1569
1570                 elif has_extension(fp, 'zip'):
1571                     warnproblem('ZIP file', fd)
1572
1573                 else:
1574                     warnproblem('unknown compressed or binary file', fd)
1575
1576             elif has_extension(fp, 'java') and os.path.isfile(fp):
1577                 if not os.path.isfile(fp):
1578                     continue
1579                 for line in file(fp):
1580                     if 'DexClassLoader' in line:
1581                         count += handleproblem('DexClassLoader', fd, fp)
1582                         break
1583     if ms is not None:
1584         ms.close()
1585
1586     for p in scanignore:
1587         if p not in scanignore_worked:
1588             logging.error('Unused scanignore path: %s' % p)
1589             count += 1
1590
1591     for p in scandelete:
1592         if p not in scandelete_worked:
1593             logging.error('Unused scandelete path: %s' % p)
1594             count += 1
1595
1596     # Presence of a jni directory without buildjni=yes might
1597     # indicate a problem (if it's not a problem, explicitly use
1598     # buildjni=no to bypass this check)
1599     if (os.path.exists(os.path.join(root_dir, 'jni')) and
1600             not thisbuild['buildjni']):
1601         logging.error('Found jni directory, but buildjni is not enabled. Set it to \'no\' to ignore.')
1602         count += 1
1603
1604     return count
1605
1606
1607 class KnownApks:
1608
1609     def __init__(self):
1610         self.path = os.path.join('stats', 'known_apks.txt')
1611         self.apks = {}
1612         if os.path.isfile(self.path):
1613             for line in file(self.path):
1614                 t = line.rstrip().split(' ')
1615                 if len(t) == 2:
1616                     self.apks[t[0]] = (t[1], None)
1617                 else:
1618                     self.apks[t[0]] = (t[1], time.strptime(t[2], '%Y-%m-%d'))
1619         self.changed = False
1620
1621     def writeifchanged(self):
1622         if self.changed:
1623             if not os.path.exists('stats'):
1624                 os.mkdir('stats')
1625             f = open(self.path, 'w')
1626             lst = []
1627             for apk, app in self.apks.iteritems():
1628                 appid, added = app
1629                 line = apk + ' ' + appid
1630                 if added:
1631                     line += ' ' + time.strftime('%Y-%m-%d', added)
1632                 lst.append(line)
1633             for line in sorted(lst):
1634                 f.write(line + '\n')
1635             f.close()
1636
1637     # Record an apk (if it's new, otherwise does nothing)
1638     # Returns the date it was added.
1639     def recordapk(self, apk, app):
1640         if apk not in self.apks:
1641             self.apks[apk] = (app, time.gmtime(time.time()))
1642             self.changed = True
1643         _, added = self.apks[apk]
1644         return added
1645
1646     # Look up information - given the 'apkname', returns (app id, date added/None).
1647     # Or returns None for an unknown apk.
1648     def getapp(self, apkname):
1649         if apkname in self.apks:
1650             return self.apks[apkname]
1651         return None
1652
1653     # Get the most recent 'num' apps added to the repo, as a list of package ids
1654     # with the most recent first.
1655     def getlatest(self, num):
1656         apps = {}
1657         for apk, app in self.apks.iteritems():
1658             appid, added = app
1659             if added:
1660                 if appid in apps:
1661                     if apps[appid] > added:
1662                         apps[appid] = added
1663                 else:
1664                     apps[appid] = added
1665         sortedapps = sorted(apps.iteritems(), key=operator.itemgetter(1))[-num:]
1666         lst = [app for app, _ in sortedapps]
1667         lst.reverse()
1668         return lst
1669
1670
1671 def isApkDebuggable(apkfile, config):
1672     """Returns True if the given apk file is debuggable
1673
1674     :param apkfile: full path to the apk to check"""
1675
1676     p = SdkToolsPopen(['aapt', 'dump', 'xmltree', apkfile, 'AndroidManifest.xml'],
1677                       output=False)
1678     if p.returncode != 0:
1679         logging.critical("Failed to get apk manifest information")
1680         sys.exit(1)
1681     for line in p.output.splitlines():
1682         if 'android:debuggable' in line and not line.endswith('0x0'):
1683             return True
1684     return False
1685
1686
1687 class AsynchronousFileReader(threading.Thread):
1688
1689     '''
1690     Helper class to implement asynchronous reading of a file
1691     in a separate thread. Pushes read lines on a queue to
1692     be consumed in another thread.
1693     '''
1694
1695     def __init__(self, fd, queue):
1696         assert isinstance(queue, Queue.Queue)
1697         assert callable(fd.readline)
1698         threading.Thread.__init__(self)
1699         self._fd = fd
1700         self._queue = queue
1701
1702     def run(self):
1703         '''The body of the tread: read lines and put them on the queue.'''
1704         for line in iter(self._fd.readline, ''):
1705             self._queue.put(line)
1706
1707     def eof(self):
1708         '''Check whether there is no more content to expect.'''
1709         return not self.is_alive() and self._queue.empty()
1710
1711
1712 class PopenResult:
1713     returncode = None
1714     output = ''
1715
1716
1717 def SdkToolsPopen(commands, cwd=None, output=True):
1718     cmd = commands[0]
1719     if cmd not in config:
1720         config[cmd] = find_sdk_tools_cmd(commands[0])
1721     return FDroidPopen([config[cmd]] + commands[1:],
1722                        cwd=cwd, output=output)
1723
1724
1725 def FDroidPopen(commands, cwd=None, output=True):
1726     """
1727     Run a command and capture the possibly huge output.
1728
1729     :param commands: command and argument list like in subprocess.Popen
1730     :param cwd: optionally specifies a working directory
1731     :returns: A PopenResult.
1732     """
1733
1734     global env
1735
1736     if cwd:
1737         cwd = os.path.normpath(cwd)
1738         logging.debug("Directory: %s" % cwd)
1739     logging.debug("> %s" % ' '.join(commands))
1740
1741     result = PopenResult()
1742     p = None
1743     try:
1744         p = subprocess.Popen(commands, cwd=cwd, shell=False, env=env,
1745                              stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
1746     except OSError, e:
1747         raise BuildException("OSError while trying to execute " +
1748                              ' '.join(commands) + ': ' + str(e))
1749
1750     stdout_queue = Queue.Queue()
1751     stdout_reader = AsynchronousFileReader(p.stdout, stdout_queue)
1752     stdout_reader.start()
1753
1754     # Check the queue for output (until there is no more to get)
1755     while not stdout_reader.eof():
1756         while not stdout_queue.empty():
1757             line = stdout_queue.get()
1758             if output and options.verbose:
1759                 # Output directly to console
1760                 sys.stderr.write(line)
1761                 sys.stderr.flush()
1762             result.output += line
1763
1764         time.sleep(0.1)
1765
1766     result.returncode = p.wait()
1767     return result
1768
1769
1770 def remove_signing_keys(build_dir):
1771     comment = re.compile(r'[ ]*//')
1772     signing_configs = re.compile(r'^[\t ]*signingConfigs[ \t]*{[ \t]*$')
1773     line_matches = [
1774         re.compile(r'^[\t ]*signingConfig [^ ]*$'),
1775         re.compile(r'.*android\.signingConfigs\.[^{]*$'),
1776         re.compile(r'.*variant\.outputFile = .*'),
1777         re.compile(r'.*output\.outputFile = .*'),
1778         re.compile(r'.*\.readLine\(.*'),
1779     ]
1780     for root, dirs, files in os.walk(build_dir):
1781         if 'build.gradle' in files:
1782             path = os.path.join(root, 'build.gradle')
1783
1784             with open(path, "r") as o:
1785                 lines = o.readlines()
1786
1787             changed = False
1788
1789             opened = 0
1790             i = 0
1791             with open(path, "w") as o:
1792                 while i < len(lines):
1793                     line = lines[i]
1794                     i += 1
1795                     while line.endswith('\\\n'):
1796                         line = line.rstrip('\\\n') + lines[i]
1797                         i += 1
1798
1799                     if comment.match(line):
1800                         continue
1801
1802                     if opened > 0:
1803                         opened += line.count('{')
1804                         opened -= line.count('}')
1805                         continue
1806
1807                     if signing_configs.match(line):
1808                         changed = True
1809                         opened += 1
1810                         continue
1811
1812                     if any(s.match(line) for s in line_matches):
1813                         changed = True
1814                         continue
1815
1816                     if opened == 0:
1817                         o.write(line)
1818
1819             if changed:
1820                 logging.info("Cleaned build.gradle of keysigning configs at %s" % path)
1821
1822         for propfile in [
1823                 'project.properties',
1824                 'build.properties',
1825                 'default.properties',
1826                 'ant.properties', ]:
1827             if propfile in files:
1828                 path = os.path.join(root, propfile)
1829
1830                 with open(path, "r") as o:
1831                     lines = o.readlines()
1832
1833                 changed = False
1834
1835                 with open(path, "w") as o:
1836                     for line in lines:
1837                         if any(line.startswith(s) for s in ('key.store', 'key.alias')):
1838                             changed = True
1839                             continue
1840
1841                         o.write(line)
1842
1843                 if changed:
1844                     logging.info("Cleaned %s of keysigning configs at %s" % (propfile, path))
1845
1846
1847 def reset_env_path():
1848     global env, orig_path
1849     env['PATH'] = orig_path
1850
1851
1852 def add_to_env_path(path):
1853     global env
1854     paths = env['PATH'].split(os.pathsep)
1855     if path in paths:
1856         return
1857     paths.append(path)
1858     env['PATH'] = os.pathsep.join(paths)
1859
1860
1861 def replace_config_vars(cmd, build):
1862     global env
1863     cmd = cmd.replace('$$SDK$$', config['sdk_path'])
1864     # env['ANDROID_NDK'] is set in build_local right before prepare_source
1865     cmd = cmd.replace('$$NDK$$', env['ANDROID_NDK'])
1866     cmd = cmd.replace('$$MVN3$$', config['mvn3'])
1867     if build is not None:
1868         cmd = cmd.replace('$$COMMIT$$', build['commit'])
1869         cmd = cmd.replace('$$VERSION$$', build['version'])
1870         cmd = cmd.replace('$$VERCODE$$', build['vercode'])
1871     return cmd
1872
1873
1874 def place_srclib(root_dir, number, libpath):
1875     if not number:
1876         return
1877     relpath = os.path.relpath(libpath, root_dir)
1878     proppath = os.path.join(root_dir, 'project.properties')
1879
1880     lines = []
1881     if os.path.isfile(proppath):
1882         with open(proppath, "r") as o:
1883             lines = o.readlines()
1884
1885     with open(proppath, "w") as o:
1886         placed = False
1887         for line in lines:
1888             if line.startswith('android.library.reference.%d=' % number):
1889                 o.write('android.library.reference.%d=%s\n' % (number, relpath))
1890                 placed = True
1891             else:
1892                 o.write(line)
1893         if not placed:
1894             o.write('android.library.reference.%d=%s\n' % (number, relpath))
1895
1896
1897 def verify_apks(signed_apk, unsigned_apk, tmp_dir):
1898     """Verify that two apks are the same
1899
1900     One of the inputs is signed, the other is unsigned. The signature metadata
1901     is transferred from the signed to the unsigned apk, and then jarsigner is
1902     used to verify that the signature from the signed apk is also varlid for
1903     the unsigned one.
1904     :param signed_apk: Path to a signed apk file
1905     :param unsigned_apk: Path to an unsigned apk file expected to match it
1906     :param tmp_dir: Path to directory for temporary files
1907     :returns: None if the verification is successful, otherwise a string
1908               describing what went wrong.
1909     """
1910     sigfile = re.compile(r'META-INF/[0-9A-Za-z]+\.(SF|RSA)')
1911     with ZipFile(signed_apk) as signed_apk_as_zip:
1912         meta_inf_files = ['META-INF/MANIFEST.MF']
1913         for f in signed_apk_as_zip.namelist():
1914             if sigfile.match(f):
1915                 meta_inf_files.append(f)
1916         if len(meta_inf_files) < 3:
1917             return "Signature files missing from {0}".format(signed_apk)
1918         signed_apk_as_zip.extractall(tmp_dir, meta_inf_files)
1919     with ZipFile(unsigned_apk, mode='a') as unsigned_apk_as_zip:
1920         for meta_inf_file in meta_inf_files:
1921             unsigned_apk_as_zip.write(os.path.join(tmp_dir, meta_inf_file), arcname=meta_inf_file)
1922
1923     if subprocess.call(['jarsigner', '-verify', unsigned_apk]) != 0:
1924         logging.info("...NOT verified - {0}".format(signed_apk))
1925         return compare_apks(signed_apk, unsigned_apk, tmp_dir)
1926     logging.info("...successfully verified")
1927     return None
1928
1929
1930 def compare_apks(apk1, apk2, tmp_dir):
1931     """Compare two apks
1932
1933     Returns None if the apk content is the same (apart from the signing key),
1934     otherwise a string describing what's different, or what went wrong when
1935     trying to do the comparison.
1936     """
1937
1938     badchars = re.compile('''[/ :;'"]''')
1939     apk1dir = os.path.join(tmp_dir, badchars.sub('_', apk1[0:-4]))  # trim .apk
1940     apk2dir = os.path.join(tmp_dir, badchars.sub('_', apk2[0:-4]))  # trim .apk
1941     for d in [apk1dir, apk2dir]:
1942         if os.path.exists(d):
1943             shutil.rmtree(d)
1944         os.mkdir(d)
1945         os.mkdir(os.path.join(d, 'jar-xf'))
1946
1947     if subprocess.call(['jar', 'xf',
1948                         os.path.abspath(apk1)],
1949                        cwd=os.path.join(apk1dir, 'jar-xf')) != 0:
1950         return("Failed to unpack " + apk1)
1951     if subprocess.call(['jar', 'xf',
1952                         os.path.abspath(apk2)],
1953                        cwd=os.path.join(apk2dir, 'jar-xf')) != 0:
1954         return("Failed to unpack " + apk2)
1955
1956     # try to find apktool in the path, if it hasn't been manually configed
1957     if 'apktool' not in config:
1958         tmp = find_command('apktool')
1959         if tmp is not None:
1960             config['apktool'] = tmp
1961     if 'apktool' in config:
1962         if subprocess.call([config['apktool'], 'd', os.path.abspath(apk1), '--output', 'apktool'],
1963                            cwd=apk1dir) != 0:
1964             return("Failed to unpack " + apk1)
1965         if subprocess.call([config['apktool'], 'd', os.path.abspath(apk2), '--output', 'apktool'],
1966                            cwd=apk2dir) != 0:
1967             return("Failed to unpack " + apk2)
1968
1969     p = FDroidPopen(['diff', '-r', apk1dir, apk2dir], output=False)
1970     lines = p.output.splitlines()
1971     if len(lines) != 1 or 'META-INF' not in lines[0]:
1972         meld = find_command('meld')
1973         if meld is not None:
1974             p = FDroidPopen(['meld', apk1dir, apk2dir], output=False)
1975         return("Unexpected diff output - " + p.output)
1976
1977     # since everything verifies, delete the comparison to keep cruft down
1978     shutil.rmtree(apk1dir)
1979     shutil.rmtree(apk2dir)
1980
1981     # If we get here, it seems like they're the same!
1982     return None
1983
1984
1985 def find_command(command):
1986     '''find the full path of a command, or None if it can't be found in the PATH'''
1987
1988     def is_exe(fpath):
1989         return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
1990
1991     fpath, fname = os.path.split(command)
1992     if fpath:
1993         if is_exe(command):
1994             return command
1995     else:
1996         for path in os.environ["PATH"].split(os.pathsep):
1997             path = path.strip('"')
1998             exe_file = os.path.join(path, command)
1999             if is_exe(exe_file):
2000                 return exe_file
2001
2002     return None
2003
2004
2005 def genpassword():
2006     '''generate a random password for when generating keys'''
2007     h = hashlib.sha256()
2008     h.update(os.urandom(16))  # salt
2009     h.update(bytes(socket.getfqdn()))
2010     return h.digest().encode('base64').strip()
2011
2012
2013 def genkeystore(localconfig):
2014     '''Generate a new key with random passwords and add it to new keystore'''
2015     logging.info('Generating a new key in "' + localconfig['keystore'] + '"...')
2016     keystoredir = os.path.dirname(localconfig['keystore'])
2017     if keystoredir is None or keystoredir == '':
2018         keystoredir = os.path.join(os.getcwd(), keystoredir)
2019     if not os.path.exists(keystoredir):
2020         os.makedirs(keystoredir, mode=0o700)
2021
2022     write_password_file("keystorepass", localconfig['keystorepass'])
2023     write_password_file("keypass", localconfig['keypass'])
2024     p = FDroidPopen(['keytool', '-genkey',
2025                      '-keystore', localconfig['keystore'],
2026                      '-alias', localconfig['repo_keyalias'],
2027                      '-keyalg', 'RSA', '-keysize', '4096',
2028                      '-sigalg', 'SHA256withRSA',
2029                      '-validity', '10000',
2030                      '-storepass:file', config['keystorepassfile'],
2031                      '-keypass:file', config['keypassfile'],
2032                      '-dname', localconfig['keydname']])
2033     # TODO keypass should be sent via stdin
2034     os.chmod(localconfig['keystore'], 0o0600)
2035     if p.returncode != 0:
2036         raise BuildException("Failed to generate key", p.output)
2037     # now show the lovely key that was just generated
2038     p = FDroidPopen(['keytool', '-list', '-v',
2039                      '-keystore', localconfig['keystore'],
2040                      '-alias', localconfig['repo_keyalias'],
2041                      '-storepass:file', config['keystorepassfile']])
2042     logging.info(p.output.strip() + '\n\n')
2043
2044
2045 def write_to_config(thisconfig, key, value=None):
2046     '''write a key/value to the local config.py'''
2047     if value is None:
2048         origkey = key + '_orig'
2049         value = thisconfig[origkey] if origkey in thisconfig else thisconfig[key]
2050     with open('config.py', 'r') as f:
2051         data = f.read()
2052     pattern = '\n[\s#]*' + key + '\s*=\s*"[^"]*"'
2053     repl = '\n' + key + ' = "' + value + '"'
2054     data = re.sub(pattern, repl, data)
2055     # if this key is not in the file, append it
2056     if not re.match('\s*' + key + '\s*=\s*"', data):
2057         data += repl
2058     # make sure the file ends with a carraige return
2059     if not re.match('\n$', data):
2060         data += '\n'
2061     with open('config.py', 'w') as f:
2062         f.writelines(data)
2063
2064
2065 def parse_xml(path):
2066     return XMLElementTree.parse(path).getroot()
2067
2068
2069 def string_is_integer(string):
2070     try:
2071         int(string)
2072         return True
2073     except ValueError:
2074         return False