1 # -*- coding: utf-8 -*-
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>
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.
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.
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/>.
37 def get_default_config():
39 'sdk_path': os.getenv("ANDROID_HOME"),
40 'ndk_path': "$ANDROID_NDK",
41 'build_tools': "19.0.3",
46 'update_stats': False,
47 'stats_to_carbon': False,
49 'build_server_always': False,
50 'keystore': '$HOME/.local/share/fdroidserver/keystore.jks',
51 'smartcardoptions': [],
59 def read_config(opts, config_file='config.py'):
60 """Read the repository config
62 The config is read from config_file, which is in the current directory when
63 any of the repo management commands are used.
65 global config, options
67 if config is not None:
69 if not os.path.isfile(config_file):
70 logging.critical("Missing config file - is this a repo directory?")
77 logging.debug("Reading %s" % config_file)
78 execfile(config_file, config)
80 # smartcardoptions must be a list since its command line args for Popen
81 if 'smartcardoptions' in config:
82 config['smartcardoptions'] = config['smartcardoptions'].split(' ')
83 elif 'keystore' in config and config['keystore'] == 'NONE':
84 # keystore='NONE' means use smartcard, these are required defaults
85 config['smartcardoptions'] = ['-storetype', 'PKCS11', '-providerName',
86 'SunPKCS11-OpenSC', '-providerClass',
87 'sun.security.pkcs11.SunPKCS11',
88 '-providerArg', 'opensc-fdroid.cfg']
90 defconfig = get_default_config()
91 for k, v in defconfig.items():
95 # Expand environment variables
96 for k, v in config.items():
99 v = os.path.expanduser(v)
100 config[k] = os.path.expandvars(v)
102 if not test_sdk_exists(config):
105 if any(k in config for k in ["keystore", "keystorepass", "keypass"]):
106 st = os.stat(config_file)
107 if st.st_mode & stat.S_IRWXG or st.st_mode & stat.S_IRWXO:
108 logging.warn("unsafe permissions on {0} (should be 0600)!".format(config_file))
110 for k in ["keystorepass", "keypass"]:
112 write_password_file(k)
114 # since this is used with rsync, where trailing slashes have meaning,
115 # ensure there is always a trailing slash
116 if 'serverwebroot' in config:
117 if config['serverwebroot'][-1] != '/':
118 config['serverwebroot'] += '/'
119 config['serverwebroot'] = config['serverwebroot'].replace('//', '/')
123 def test_sdk_exists(c):
124 if c['sdk_path'] is None:
125 # c['sdk_path'] is set to the value of ANDROID_HOME by default
126 logging.critical('No Android SDK found! ANDROID_HOME is not set and sdk_path is not in config.py!')
127 logging.info('You can use ANDROID_HOME to set the path to your SDK, i.e.:')
128 logging.info('\texport ANDROID_HOME=/opt/android-sdk')
130 if not os.path.exists(c['sdk_path']):
131 logging.critical('Android SDK path "' + c['sdk_path'] + '" does not exist!')
133 if not os.path.isdir(c['sdk_path']):
134 logging.critical('Android SDK path "' + c['sdk_path'] + '" is not a directory!')
136 if not os.path.isdir(os.path.join(c['sdk_path'], 'build-tools')):
137 logging.critical('Android SDK path "' + c['sdk_path'] + '" does not contain "build-tools/"!')
141 def write_password_file(pwtype, password=None):
143 writes out passwords to a protected file instead of passing passwords as
144 command line argments
146 filename = '.fdroid.' + pwtype + '.txt'
147 fd = os.open(filename, os.O_CREAT | os.O_TRUNC | os.O_WRONLY, 0600)
149 os.write(fd, config[pwtype])
151 os.write(fd, password)
153 config[pwtype + 'file'] = filename
155 # Given the arguments in the form of multiple appid:[vc] strings, this returns
156 # a dictionary with the set of vercodes specified for each package.
157 def read_pkg_args(args, allow_vercodes=False):
164 if allow_vercodes and ':' in p:
165 package, vercode = p.split(':')
167 package, vercode = p, None
168 if package not in vercodes:
169 vercodes[package] = [vercode] if vercode else []
171 elif vercode and vercode not in vercodes[package]:
172 vercodes[package] += [vercode] if vercode else []
176 # On top of what read_pkg_args does, this returns the whole app metadata, but
177 # limiting the builds list to the builds matching the vercodes specified.
178 def read_app_args(args, allapps, allow_vercodes=False):
180 vercodes = read_pkg_args(args, allow_vercodes)
185 apps = [app for app in allapps if app['id'] in vercodes]
187 if len(apps) != len(vercodes):
188 allids = [app["id"] for app in allapps]
191 logging.critical("No such package: %s" % p)
192 raise Exception("Found invalid app ids in arguments")
194 raise Exception("No packages specified")
198 vc = vercodes[app['id']]
201 app['builds'] = [b for b in app['builds'] if b['vercode'] in vc]
202 if len(app['builds']) != len(vercodes[app['id']]):
204 allvcs = [b['vercode'] for b in app['builds']]
205 for v in vercodes[app['id']]:
207 logging.critical("No such vercode %s for app %s" % (v, app['id']))
210 raise Exception("Found invalid vercodes for some apps")
214 def has_extension(filename, extension):
215 name, ext = os.path.splitext(filename)
216 ext = ext.lower()[1:]
217 return ext == extension
221 def apknameinfo(filename):
223 filename = os.path.basename(filename)
224 if apk_regex is None:
225 apk_regex = re.compile(r"^(.+)_([0-9]+)\.apk$")
226 m = apk_regex.match(filename)
228 result = (m.group(1), m.group(2))
229 except AttributeError:
230 raise Exception("Invalid apk name: %s" % filename)
233 def getapkname(app, build):
234 return "%s_%s.apk" % (app['id'], build['vercode'])
236 def getsrcname(app, build):
237 return "%s_%s_src.tar.gz" % (app['id'], build['vercode'])
243 return app['Auto Name']
247 return '%s (%s)' % (app['Current Version'], app['Current Version Code'])
249 def getvcs(vcstype, remote, local):
251 return vcs_git(remote, local)
253 return vcs_svn(remote, local)
254 if vcstype == 'git-svn':
255 return vcs_gitsvn(remote, local)
257 return vcs_hg(remote, local)
259 return vcs_bzr(remote, local)
260 if vcstype == 'srclib':
261 if local != 'build/srclib/' + remote:
262 raise VCSException("Error: srclib paths are hard-coded!")
263 return getsrclib(remote, 'build/srclib', raw=True)
264 raise VCSException("Invalid vcs type " + vcstype)
266 def getsrclibvcs(name):
267 srclib_path = os.path.join('srclibs', name + ".txt")
268 if not os.path.exists(srclib_path):
269 raise VCSException("Missing srclib " + name)
270 return metadata.parse_srclib(srclib_path)['Repo Type']
273 def __init__(self, remote, local):
275 # svn, git-svn and bzr may require auth
277 if self.repotype() in ('svn', 'git-svn', 'bzr'):
279 self.username, remote = remote.split('@')
280 if ':' not in self.username:
281 raise VCSException("Password required with username")
282 self.username, self.password = self.username.split(':')
286 self.refreshed = False
292 # Take the local repository to a clean version of the given revision, which
293 # is specificed in the VCS's native format. Beforehand, the repository can
294 # be dirty, or even non-existent. If the repository does already exist
295 # locally, it will be updated from the origin, but only once in the
296 # lifetime of the vcs object.
297 # None is acceptable for 'rev' if you know you are cloning a clean copy of
298 # the repo - otherwise it must specify a valid revision.
299 def gotorevision(self, rev):
301 # The .fdroidvcs-id file for a repo tells us what VCS type
302 # and remote that directory was created from, allowing us to drop it
303 # automatically if either of those things changes.
304 fdpath = os.path.join(self.local, '..',
305 '.fdroidvcs-' + os.path.basename(self.local))
306 cdata = self.repotype() + ' ' + self.remote
309 if os.path.exists(self.local):
310 if os.path.exists(fdpath):
311 with open(fdpath, 'r') as f:
312 fsdata = f.read().strip()
317 logging.info("Repository details changed - deleting")
320 logging.info("Repository details missing - deleting")
322 shutil.rmtree(self.local)
324 self.gotorevisionx(rev)
326 # If necessary, write the .fdroidvcs file.
328 with open(fdpath, 'w') as f:
331 # Derived classes need to implement this. It's called once basic checking
332 # has been performend.
333 def gotorevisionx(self, rev):
334 raise VCSException("This VCS type doesn't define gotorevisionx")
336 # Initialise and update submodules
337 def initsubmodules(self):
338 raise VCSException('Submodules not supported for this vcs type')
340 # Get a list of all known tags
342 raise VCSException('gettags not supported for this vcs type')
344 # Get a list of latest number tags
345 def latesttags(self, number):
346 raise VCSException('latesttags not supported for this vcs type')
348 # Get current commit reference (hash, revision, etc)
350 raise VCSException('getref not supported for this vcs type')
352 # Returns the srclib (name, path) used in setting up the current
362 # If the local directory exists, but is somehow not a git repository, git
363 # will traverse up the directory tree until it finds one that is (i.e.
364 # fdroidserver) and then we'll proceed to destroy it! This is called as
367 p = SilentPopen(['git', 'rev-parse', '--show-toplevel'], cwd=self.local)
368 result = p.stdout.rstrip()
369 if not result.endswith(self.local):
370 raise VCSException('Repository mismatch')
372 def gotorevisionx(self, rev):
373 if not os.path.exists(self.local):
375 p = FDroidPopen(['git', 'clone', self.remote, self.local])
376 if p.returncode != 0:
377 raise VCSException("Git clone failed")
381 # Discard any working tree changes
382 p = SilentPopen(['git', 'reset', '--hard'], cwd=self.local)
383 if p.returncode != 0:
384 raise VCSException("Git reset failed")
385 # Remove untracked files now, in case they're tracked in the target
386 # revision (it happens!)
387 p = SilentPopen(['git', 'clean', '-dffx'], cwd=self.local)
388 if p.returncode != 0:
389 raise VCSException("Git clean failed")
390 if not self.refreshed:
391 # Get latest commits and tags from remote
392 p = FDroidPopen(['git', 'fetch', 'origin'], cwd=self.local)
393 if p.returncode != 0:
394 raise VCSException("Git fetch failed")
395 p = SilentPopen(['git', 'fetch', '--prune', '--tags', 'origin'], cwd=self.local)
396 if p.returncode != 0:
397 raise VCSException("Git fetch failed")
398 self.refreshed = True
399 # Check out the appropriate revision
400 rev = str(rev if rev else 'origin/master')
401 p = SilentPopen(['git', 'checkout', '-f', rev], cwd=self.local)
402 if p.returncode != 0:
403 raise VCSException("Git checkout failed")
404 # Get rid of any uncontrolled files left behind
405 p = SilentPopen(['git', 'clean', '-dffx'], cwd=self.local)
406 if p.returncode != 0:
407 raise VCSException("Git clean failed")
409 def initsubmodules(self):
411 submfile = os.path.join(self.local, '.gitmodules')
412 if not os.path.isfile(submfile):
413 raise VCSException("No git submodules available")
415 # fix submodules not accessible without an account and public key auth
416 with open(submfile, 'r') as f:
417 lines = f.readlines()
418 with open(submfile, 'w') as f:
420 if 'git@github.com' in line:
421 line = line.replace('git@github.com:', 'https://github.com/')
425 ['git', 'reset', '--hard'],
426 ['git', 'clean', '-dffx'],
428 p = SilentPopen(['git', 'submodule', 'foreach', '--recursive'] + cmd, cwd=self.local)
429 if p.returncode != 0:
430 raise VCSException("Git submodule reset failed")
431 p = FDroidPopen(['git', 'submodule', 'sync'], cwd=self.local)
432 if p.returncode != 0:
433 raise VCSException("Git submodule sync failed")
434 p = FDroidPopen(['git', 'submodule', 'update', '--init', '--force', '--recursive'], cwd=self.local)
435 if p.returncode != 0:
436 raise VCSException("Git submodule update failed")
440 p = SilentPopen(['git', 'tag'], cwd=self.local)
441 return p.stdout.splitlines()
443 def latesttags(self, alltags, number):
445 p = SilentPopen(['echo "'+'\n'.join(alltags)+'" | \
446 xargs -I@ git log --format=format:"%at @%n" -1 @ | \
447 sort -n | awk \'{print $2}\''],
448 cwd=self.local, shell=True)
449 return p.stdout.splitlines()[-number:]
452 class vcs_gitsvn(vcs):
457 # Damn git-svn tries to use a graphical password prompt, so we have to
458 # trick it into taking the password from stdin
460 if self.username is None:
462 return ('echo "%s" | DISPLAY="" ' % self.password, ' --username "%s"' % self.username)
464 # If the local directory exists, but is somehow not a git repository, git
465 # will traverse up the directory tree until it finds one that is (i.e.
466 # fdroidserver) and then we'll proceed to destory it! This is called as
469 p = SilentPopen(['git', 'rev-parse', '--show-toplevel'], cwd=self.local)
470 result = p.stdout.rstrip()
471 if not result.endswith(self.local):
472 raise VCSException('Repository mismatch')
474 def gotorevisionx(self, rev):
475 if not os.path.exists(self.local):
477 gitsvn_cmd = '%sgit svn clone%s' % self.userargs()
478 if ';' in self.remote:
479 remote_split = self.remote.split(';')
480 for i in remote_split[1:]:
481 if i.startswith('trunk='):
482 gitsvn_cmd += ' -T %s' % i[6:]
483 elif i.startswith('tags='):
484 gitsvn_cmd += ' -t %s' % i[5:]
485 elif i.startswith('branches='):
486 gitsvn_cmd += ' -b %s' % i[9:]
487 p = SilentPopen([gitsvn_cmd + " %s %s" % (remote_split[0], self.local)], shell=True)
488 if p.returncode != 0:
489 raise VCSException("Git clone failed")
491 p = SilentPopen([gitsvn_cmd + " %s %s" % (self.remote, self.local)], shell=True)
492 if p.returncode != 0:
493 raise VCSException("Git clone failed")
497 # Discard any working tree changes
498 p = SilentPopen(['git', 'reset', '--hard'], cwd=self.local)
499 if p.returncode != 0:
500 raise VCSException("Git reset failed")
501 # Remove untracked files now, in case they're tracked in the target
502 # revision (it happens!)
503 p = SilentPopen(['git', 'clean', '-dffx'], cwd=self.local)
504 if p.returncode != 0:
505 raise VCSException("Git clean failed")
506 if not self.refreshed:
507 # Get new commits, branches and tags from repo
508 p = SilentPopen(['%sgit svn fetch %s' % self.userargs()], cwd=self.local, shell=True)
509 if p.returncode != 0:
510 raise VCSException("Git svn fetch failed")
511 p = SilentPopen(['%sgit svn rebase %s' % self.userargs()], cwd=self.local, shell=True)
512 if p.returncode != 0:
513 raise VCSException("Git svn rebase failed")
514 self.refreshed = True
516 rev = str(rev if rev else 'master')
518 nospaces_rev = rev.replace(' ', '%20')
519 # Try finding a svn tag
520 p = SilentPopen(['git', 'checkout', 'tags/' + nospaces_rev], cwd=self.local)
521 if p.returncode != 0:
522 # No tag found, normal svn rev translation
523 # Translate svn rev into git format
524 rev_split = rev.split('/')
525 if len(rev_split) > 1:
526 treeish = rev_split[0]
527 svn_rev = rev_split[1]
530 # if no branch is specified, then assume trunk (ie. 'master'
535 p = SilentPopen(['git', 'svn', 'find-rev', 'r' + svn_rev, treeish], cwd=self.local)
536 git_rev = p.stdout.rstrip()
538 if p.returncode != 0 or not git_rev:
539 # Try a plain git checkout as a last resort
540 p = SilentPopen(['git', 'checkout', rev], cwd=self.local)
541 if p.returncode != 0:
542 raise VCSException("No git treeish found and direct git checkout failed")
544 # Check out the git rev equivalent to the svn rev
545 p = SilentPopen(['git', 'checkout', git_rev], cwd=self.local)
546 if p.returncode != 0:
547 raise VCSException("Git svn checkout failed")
549 # Get rid of any uncontrolled files left behind
550 p = SilentPopen(['git', 'clean', '-dffx'], cwd=self.local)
551 if p.returncode != 0:
552 raise VCSException("Git clean failed")
556 return os.listdir(os.path.join(self.local, '.git/svn/refs/remotes/tags'))
560 p = SilentPopen(['git', 'svn', 'find-rev', 'HEAD'], cwd=self.local)
561 if p.returncode != 0:
563 return p.stdout.strip()
571 if self.username is None:
572 return ['--non-interactive']
573 return ['--username', self.username,
574 '--password', self.password,
577 def gotorevisionx(self, rev):
578 if not os.path.exists(self.local):
579 p = SilentPopen(['svn', 'checkout', self.remote, self.local] + self.userargs())
580 if p.returncode != 0:
581 raise VCSException("Svn checkout failed")
585 r"svn status | awk '/\?/ {print $2}' | xargs rm -rf"):
586 p = SilentPopen([svncommand], cwd=self.local, shell=True)
587 if p.returncode != 0:
588 raise VCSException("Svn reset ({0}) failed in {1}".format(svncommand, self.local))
589 if not self.refreshed:
590 p = SilentPopen(['svn', 'update'] + self.userargs(), cwd=self.local)
591 if p.returncode != 0:
592 raise VCSException("Svn update failed")
593 self.refreshed = True
595 revargs = list(['-r', rev] if rev else [])
596 p = SilentPopen(['svn', 'update', '--force'] + revargs + self.userargs(), cwd=self.local)
597 if p.returncode != 0:
598 raise VCSException("Svn update failed")
601 p = SilentPopen(['svn', 'info'], cwd=self.local)
602 for line in p.stdout.splitlines():
603 if line and line.startswith('Last Changed Rev: '):
612 def gotorevisionx(self, rev):
613 if not os.path.exists(self.local):
614 p = SilentPopen(['hg', 'clone', self.remote, self.local])
615 if p.returncode != 0:
616 raise VCSException("Hg clone failed")
618 p = SilentPopen(['hg status -uS | xargs rm -rf'], cwd=self.local, shell=True)
619 if p.returncode != 0:
620 raise VCSException("Hg clean failed")
621 if not self.refreshed:
622 p = SilentPopen(['hg', 'pull'], cwd=self.local)
623 if p.returncode != 0:
624 raise VCSException("Hg pull failed")
625 self.refreshed = True
627 rev = str(rev if rev else 'default')
630 p = SilentPopen(['hg', 'update', '-C', rev], cwd=self.local)
631 if p.returncode != 0:
632 raise VCSException("Hg checkout failed")
633 p = SilentPopen(['hg', 'purge', '--all'], cwd=self.local)
634 # Also delete untracked files, we have to enable purge extension for that:
635 if "'purge' is provided by the following extension" in p.stdout:
636 with open(self.local+"/.hg/hgrc", "a") as myfile:
637 myfile.write("\n[extensions]\nhgext.purge=\n")
638 p = SilentPopen(['hg', 'purge', '--all'], cwd=self.local)
639 if p.returncode != 0:
640 raise VCSException("HG purge failed")
641 elif p.returncode != 0:
642 raise VCSException("HG purge failed")
645 p = SilentPopen(['hg', 'tags', '-q'], cwd=self.local)
646 return p.stdout.splitlines()[1:]
654 def gotorevisionx(self, rev):
655 if not os.path.exists(self.local):
656 p = SilentPopen(['bzr', 'branch', self.remote, self.local])
657 if p.returncode != 0:
658 raise VCSException("Bzr branch failed")
660 p = SilentPopen(['bzr', 'clean-tree', '--force', '--unknown', '--ignored'], cwd=self.local)
661 if p.returncode != 0:
662 raise VCSException("Bzr revert failed")
663 if not self.refreshed:
664 p = SilentPopen(['bzr', 'pull'], cwd=self.local)
665 if p.returncode != 0:
666 raise VCSException("Bzr update failed")
667 self.refreshed = True
669 revargs = list(['-r', rev] if rev else [])
670 p = SilentPopen(['bzr', 'revert'] + revargs, cwd=self.local)
671 if p.returncode != 0:
672 raise VCSException("Bzr revert failed")
675 p = SilentPopen(['bzr', 'tags'], cwd=self.local)
676 return [tag.split(' ')[0].strip() for tag in
677 p.stdout.splitlines()]
679 def retrieve_string(app_dir, string, xmlfiles=None):
682 os.path.join(app_dir, 'res'),
683 os.path.join(app_dir, 'src/main'),
688 for res_dir in res_dirs:
689 for r, d, f in os.walk(res_dir):
690 if r.endswith('/values'):
691 xmlfiles += [os.path.join(r, x) for x in f if x.endswith('.xml')]
694 if string.startswith('@string/'):
695 string_search = re.compile(r'.*"'+string[8:]+'".*?>([^<]+?)<.*').search
696 elif string.startswith('&') and string.endswith(';'):
697 string_search = re.compile(r'.*<!ENTITY.*'+string[1:-1]+'.*?"([^"]+?)".*>').search
699 if string_search is not None:
700 for xmlfile in xmlfiles:
701 for line in file(xmlfile):
702 matches = string_search(line)
704 return retrieve_string(app_dir, matches.group(1), xmlfiles)
707 return string.replace("\\'", "'")
709 # Return list of existing files that will be used to find the highest vercode
710 def manifest_paths(app_dir, flavour):
712 possible_manifests = [ os.path.join(app_dir, 'AndroidManifest.xml'),
713 os.path.join(app_dir, 'src', 'main', 'AndroidManifest.xml'),
714 os.path.join(app_dir, 'src', 'AndroidManifest.xml'),
715 os.path.join(app_dir, 'build.gradle') ]
718 possible_manifests.append(
719 os.path.join(app_dir, 'src', flavour, 'AndroidManifest.xml'))
721 return [path for path in possible_manifests if os.path.isfile(path)]
723 # Retrieve the package name. Returns the name, or None if not found.
724 def fetch_real_name(app_dir, flavour):
725 app_search = re.compile(r'.*<application.*').search
726 name_search = re.compile(r'.*android:label="([^"]+)".*').search
728 for f in manifest_paths(app_dir, flavour):
729 if not has_extension(f, 'xml'):
731 logging.debug("fetch_real_name: Checking manifest at " + f)
737 matches = name_search(line)
739 stringname = matches.group(1)
740 logging.debug("fetch_real_name: using string " + stringname)
741 result = retrieve_string(app_dir, stringname)
743 result = result.strip()
747 # Retrieve the version name
748 def version_name(original, app_dir, flavour):
749 for f in manifest_paths(app_dir, flavour):
750 if not has_extension(f, 'xml'):
752 string = retrieve_string(app_dir, original)
757 def get_library_references(root_dir):
759 proppath = os.path.join(root_dir, 'project.properties')
760 if not os.path.isfile(proppath):
762 with open(proppath) as f:
763 for line in f.readlines():
764 if not line.startswith('android.library.reference.'):
766 path = line.split('=')[1].strip()
767 relpath = os.path.join(root_dir, path)
768 if not os.path.isdir(relpath):
770 logging.info("Found subproject at %s" % path)
771 libraries.append(path)
774 def ant_subprojects(root_dir):
775 subprojects = get_library_references(root_dir)
776 for subpath in subprojects:
777 subrelpath = os.path.join(root_dir, subpath)
778 for p in get_library_references(subrelpath):
779 relp = os.path.normpath(os.path.join(subpath, p))
780 if relp not in subprojects:
781 subprojects.insert(0, relp)
784 def remove_debuggable_flags(root_dir):
785 # Remove forced debuggable flags
786 logging.info("Removing debuggable flags")
787 for root, dirs, files in os.walk(root_dir):
788 if 'AndroidManifest.xml' in files:
789 path = os.path.join(root, 'AndroidManifest.xml')
790 p = FDroidPopen(['sed', '-i', 's/android:debuggable="[^"]*"//g', path])
791 if p.returncode != 0:
792 raise BuildException("Failed to remove debuggable flags of %s" % path)
794 # Extract some information from the AndroidManifest.xml at the given path.
795 # Returns (version, vercode, package), any or all of which might be None.
796 # All values returned are strings.
797 def parse_androidmanifests(paths):
800 return (None, None, None)
802 vcsearch = re.compile(r'.*:versionCode="([0-9]+?)".*').search
803 vnsearch = re.compile(r'.*:versionName="([^"]+?)".*').search
804 psearch = re.compile(r'.*package="([^"]+)".*').search
806 vcsearch_g = re.compile(r'.*versionCode *=* *["\']*([0-9]+)["\']*').search
807 vnsearch_g = re.compile(r'.*versionName *=* *(["\'])((?:(?=(\\?))\3.)*?)\1.*').search
808 psearch_g = re.compile(r'.*packageName *=* *["\']([^"]+)["\'].*').search
816 gradle = has_extension(path, 'gradle')
819 # Remember package name, may be defined separately from version+vercode
820 package = max_package
822 for line in file(path):
825 matches = psearch_g(line)
827 matches = psearch(line)
829 package = matches.group(1)
832 matches = vnsearch_g(line)
834 matches = vnsearch(line)
836 version = matches.group(2 if gradle else 1)
839 matches = vcsearch_g(line)
841 matches = vcsearch(line)
843 vercode = matches.group(1)
845 # Better some package name than nothing
846 if max_package is None:
847 max_package = package
849 if max_vercode is None or (vercode is not None and vercode > max_vercode):
850 max_version = version
851 max_vercode = vercode
852 max_package = package
854 if max_version is None:
855 max_version = "Unknown"
857 return (max_version, max_vercode, max_package)
859 class BuildException(Exception):
860 def __init__(self, value, detail = None):
864 def get_wikitext(self):
865 ret = repr(self.value) + "\n"
869 txt = self.detail[-8192:] if len(self.detail) > 8192 else self.detail
875 ret = repr(self.value)
877 ret += "\n==== detail begin ====\n%s\n==== detail end ====" % self.detail.strip()
880 class VCSException(Exception):
881 def __init__(self, value):
885 return repr(self.value)
887 # Get the specified source library.
888 # Returns the path to it. Normally this is the path to be used when referencing
889 # it, which may be a subdirectory of the actual project. If you want the base
890 # directory of the project, pass 'basepath=True'.
891 def getsrclib(spec, srclib_dir, srclibpaths=[], subdir=None,
892 basepath=False, raw=False, prepare=True, preponly=False):
900 name, ref = spec.split('@')
902 number, name = name.split(':', 1)
904 name, subdir = name.split('/', 1)
906 srclib_path = os.path.join('srclibs', name + ".txt")
908 if not os.path.exists(srclib_path):
909 raise BuildException('srclib ' + name + ' not found.')
911 srclib = metadata.parse_srclib(srclib_path)
913 sdir = os.path.join(srclib_dir, name)
916 vcs = getvcs(srclib["Repo Type"], srclib["Repo"], sdir)
917 vcs.srclib = (name, number, sdir)
919 vcs.gotorevision(ref)
926 libdir = os.path.join(sdir, subdir)
927 elif srclib["Subdir"]:
928 for subdir in srclib["Subdir"]:
929 libdir_candidate = os.path.join(sdir, subdir)
930 if os.path.exists(libdir_candidate):
931 libdir = libdir_candidate
937 if srclib["Srclibs"]:
939 for lib in srclib["Srclibs"].replace(';', ',').split(','):
941 for t in srclibpaths:
946 raise BuildException('Missing recursive srclib %s for %s' % (
948 place_srclib(libdir, n, s_tuple[2])
951 remove_signing_keys(sdir)
952 remove_debuggable_flags(sdir)
956 if srclib["Prepare"]:
957 cmd = replace_config_vars(srclib["Prepare"])
959 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=libdir)
960 if p.returncode != 0:
961 raise BuildException("Error running prepare command for srclib %s"
967 return (name, number, libdir)
970 # Prepare the source code for a particular build
971 # 'vcs' - the appropriate vcs object for the application
972 # 'app' - the application details from the metadata
973 # 'build' - the build details from the metadata
974 # 'build_dir' - the path to the build directory, usually
976 # 'srclib_dir' - the path to the source libraries directory, usually
978 # 'extlib_dir' - the path to the external libraries directory, usually
980 # Returns the (root, srclibpaths) where:
981 # 'root' is the root directory, which may be the same as 'build_dir' or may
982 # be a subdirectory of it.
983 # 'srclibpaths' is information on the srclibs being used
984 def prepare_source(vcs, app, build, build_dir, srclib_dir, extlib_dir, onserver=False):
986 # Optionally, the actual app source can be in a subdirectory
987 if 'subdir' in build:
988 root_dir = os.path.join(build_dir, build['subdir'])
992 # Get a working copy of the right revision
993 logging.info("Getting source for revision " + build['commit'])
994 vcs.gotorevision(build['commit'])
996 # Initialise submodules if requred
997 if build['submodules']:
998 logging.info("Initialising submodules")
1001 # Check that a subdir (if we're using one) exists. This has to happen
1002 # after the checkout, since it might not exist elsewhere
1003 if not os.path.exists(root_dir):
1004 raise BuildException('Missing subdir ' + root_dir)
1006 # Run an init command if one is required
1008 cmd = replace_config_vars(build['init'])
1009 logging.info("Running 'init' commands in %s" % root_dir)
1011 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1012 if p.returncode != 0:
1013 raise BuildException("Error running init command for %s:%s" %
1014 (app['id'], build['version']), p.stdout)
1016 # Apply patches if any
1017 if 'patch' in build:
1018 for patch in build['patch']:
1019 patch = patch.strip()
1020 logging.info("Applying " + patch)
1021 patch_path = os.path.join('metadata', app['id'], patch)
1022 p = FDroidPopen(['patch', '-p1', '-i', os.path.abspath(patch_path)], cwd=build_dir)
1023 if p.returncode != 0:
1024 raise BuildException("Failed to apply patch %s" % patch_path)
1026 # Get required source libraries
1028 if 'srclibs' in build:
1029 logging.info("Collecting source libraries")
1030 for lib in build['srclibs']:
1031 srclibpaths.append(getsrclib(lib, srclib_dir, srclibpaths,
1034 for name, number, libpath in srclibpaths:
1035 place_srclib(root_dir, int(number) if number else None, libpath)
1037 basesrclib = vcs.getsrclib()
1038 # If one was used for the main source, add that too.
1040 srclibpaths.append(basesrclib)
1042 # Update the local.properties file
1043 localprops = [ os.path.join(build_dir, 'local.properties') ]
1044 if 'subdir' in build:
1045 localprops += [ os.path.join(root_dir, 'local.properties') ]
1046 for path in localprops:
1047 if not os.path.isfile(path):
1049 logging.info("Updating properties file at %s" % path)
1054 # Fix old-fashioned 'sdk-location' by copying
1055 # from sdk.dir, if necessary
1056 if build['oldsdkloc']:
1057 sdkloc = re.match(r".*^sdk.dir=(\S+)$.*", props,
1059 props += "sdk-location=%s\n" % sdkloc
1061 props += "sdk.dir=%s\n" % config['sdk_path']
1062 props += "sdk-location=%s\n" % config['sdk_path']
1063 if 'ndk_path' in config:
1065 props += "ndk.dir=%s\n" % config['ndk_path']
1066 props += "ndk-location=%s\n" % config['ndk_path']
1067 # Add java.encoding if necessary
1068 if 'encoding' in build:
1069 props += "java.encoding=%s\n" % build['encoding']
1075 if build['type'] == 'gradle':
1076 flavour = build['gradle'].split('@')[0]
1077 if flavour in ['main', 'yes', '']:
1080 if 'target' in build:
1081 n = build["target"].split('-')[1]
1082 FDroidPopen(['sed', '-i',
1083 's@compileSdkVersion *[0-9]*@compileSdkVersion '+n+'@g',
1084 'build.gradle'], cwd=root_dir)
1085 if '@' in build['gradle']:
1086 gradle_dir = os.path.join(root_dir, build['gradle'].split('@', 1)[1])
1087 gradle_dir = os.path.normpath(gradle_dir)
1088 FDroidPopen(['sed', '-i',
1089 's@compileSdkVersion *[0-9]*@compileSdkVersion '+n+'@g',
1090 'build.gradle'], cwd=gradle_dir)
1092 # Remove forced debuggable flags
1093 remove_debuggable_flags(root_dir)
1095 # Insert version code and number into the manifest if necessary
1096 if build['forceversion']:
1097 logging.info("Changing the version name")
1098 for path in manifest_paths(root_dir, flavour):
1099 if not os.path.isfile(path):
1101 if has_extension(path, 'xml'):
1102 p = SilentPopen(['sed', '-i',
1103 's/android:versionName="[^"]*"/android:versionName="' + build['version'] + '"/g',
1105 if p.returncode != 0:
1106 raise BuildException("Failed to amend manifest")
1107 elif has_extension(path, 'gradle'):
1108 p = SilentPopen(['sed', '-i',
1109 's/versionName *=* *"[^"]*"/versionName = "' + build['version'] + '"/g',
1111 if p.returncode != 0:
1112 raise BuildException("Failed to amend build.gradle")
1113 if build['forcevercode']:
1114 logging.info("Changing the version code")
1115 for path in manifest_paths(root_dir, flavour):
1116 if not os.path.isfile(path):
1118 if has_extension(path, 'xml'):
1119 p = SilentPopen(['sed', '-i',
1120 's/android:versionCode="[^"]*"/android:versionCode="' + build['vercode'] + '"/g',
1122 if p.returncode != 0:
1123 raise BuildException("Failed to amend manifest")
1124 elif has_extension(path, 'gradle'):
1125 p = SilentPopen(['sed', '-i',
1126 's/versionCode *=* *[0-9]*/versionCode = ' + build['vercode'] + '/g',
1128 if p.returncode != 0:
1129 raise BuildException("Failed to amend build.gradle")
1131 # Delete unwanted files
1133 for part in getpaths(build_dir, build, 'rm'):
1134 dest = os.path.join(build_dir, part)
1135 logging.info("Removing {0}".format(part))
1136 if os.path.lexists(dest):
1137 if os.path.islink(dest):
1138 SilentPopen(['unlink ' + dest], shell=True)
1140 SilentPopen(['rm -rf ' + dest], shell=True)
1142 logging.info("...but it didn't exist")
1144 remove_signing_keys(build_dir)
1146 # Add required external libraries
1147 if 'extlibs' in build:
1148 logging.info("Collecting prebuilt libraries")
1149 libsdir = os.path.join(root_dir, 'libs')
1150 if not os.path.exists(libsdir):
1152 for lib in build['extlibs']:
1154 logging.info("...installing extlib {0}".format(lib))
1155 libf = os.path.basename(lib)
1156 libsrc = os.path.join(extlib_dir, lib)
1157 if not os.path.exists(libsrc):
1158 raise BuildException("Missing extlib file {0}".format(libsrc))
1159 shutil.copyfile(libsrc, os.path.join(libsdir, libf))
1161 # Run a pre-build command if one is required
1162 if 'prebuild' in build:
1163 cmd = replace_config_vars(build['prebuild'])
1165 # Substitute source library paths into prebuild commands
1166 for name, number, libpath in srclibpaths:
1167 libpath = os.path.relpath(libpath, root_dir)
1168 cmd = cmd.replace('$$' + name + '$$', libpath)
1170 logging.info("Running 'prebuild' commands in %s" % root_dir)
1172 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1173 if p.returncode != 0:
1174 raise BuildException("Error running prebuild command for %s:%s" %
1175 (app['id'], build['version']), p.stdout)
1177 updatemode = build.get('update', ['auto'])
1178 # Generate (or update) the ant build file, build.xml...
1179 if updatemode != ['no'] and build['type'] == 'ant':
1180 parms = [os.path.join(config['sdk_path'], 'tools', 'android'), 'update']
1181 lparms = parms + ['lib-project']
1182 parms = parms + ['project']
1184 if 'target' in build and build['target']:
1185 parms += ['-t', build['target']]
1186 lparms += ['-t', build['target']]
1187 if updatemode == ['auto']:
1188 update_dirs = ant_subprojects(root_dir) + ['.']
1190 update_dirs = updatemode
1192 for d in update_dirs:
1193 subdir = os.path.join(root_dir, d)
1195 print("Updating main project")
1196 cmd = parms + ['-p', d]
1198 print("Updating subproject %s" % d)
1199 cmd = lparms + ['-p', d]
1200 p = FDroidPopen(cmd, cwd=root_dir)
1201 # Check to see whether an error was returned without a proper exit
1202 # code (this is the case for the 'no target set or target invalid'
1204 if p.returncode != 0 or p.stdout.startswith("Error: "):
1205 raise BuildException("Failed to update project at %s" % d, p.stdout)
1206 # Clean update dirs via ant
1208 logging.info("Cleaning subproject %s" % d)
1209 p = FDroidPopen(['ant', 'clean'], cwd=subdir)
1211 return (root_dir, srclibpaths)
1213 # Split and extend via globbing the paths from a field
1214 def getpaths(build_dir, build, field):
1216 if field not in build:
1218 for p in build[field]:
1220 full_path = os.path.join(build_dir, p)
1221 full_path = os.path.normpath(full_path)
1222 paths += [r[len(build_dir)+1:] for r in glob.glob(full_path)]
1225 # Scan the source code in the given directory (and all subdirectories)
1226 # and return the number of fatal problems encountered
1227 def scan_source(build_dir, root_dir, thisbuild):
1231 # Common known non-free blobs (always lower case):
1233 re.compile(r'flurryagent', re.IGNORECASE),
1234 re.compile(r'paypal.*mpl', re.IGNORECASE),
1235 re.compile(r'libgoogleanalytics', re.IGNORECASE),
1236 re.compile(r'admob.*sdk.*android', re.IGNORECASE),
1237 re.compile(r'googleadview', re.IGNORECASE),
1238 re.compile(r'googleadmobadssdk', re.IGNORECASE),
1239 re.compile(r'google.*play.*services', re.IGNORECASE),
1240 re.compile(r'crittercism', re.IGNORECASE),
1241 re.compile(r'heyzap', re.IGNORECASE),
1242 re.compile(r'jpct.*ae', re.IGNORECASE),
1243 re.compile(r'youtubeandroidplayerapi', re.IGNORECASE),
1244 re.compile(r'bugsense', re.IGNORECASE),
1245 re.compile(r'crashlytics', re.IGNORECASE),
1246 re.compile(r'ouya.*sdk', re.IGNORECASE),
1249 scanignore = getpaths(build_dir, thisbuild, 'scanignore')
1250 scandelete = getpaths(build_dir, thisbuild, 'scandelete')
1253 ms = magic.open(magic.MIME_TYPE)
1255 except AttributeError:
1259 for i in scanignore:
1260 if fd.startswith(i):
1265 for i in scandelete:
1266 if fd.startswith(i):
1270 def removeproblem(what, fd, fp):
1271 logging.info('Removing %s at %s' % (what, fd))
1274 def warnproblem(what, fd):
1275 logging.warn('Found %s at %s' % (what, fd))
1277 def handleproblem(what, fd, fp):
1279 removeproblem(what, fd, fp)
1281 logging.error('Found %s at %s' % (what, fd))
1285 def insidedir(path, dirname):
1286 return path.endswith('/%s' % dirname) or '/%s/' % dirname in path
1288 # Iterate through all files in the source code
1289 for r, d, f in os.walk(build_dir):
1291 if any(insidedir(r, d) for d in ('.hg', '.git', '.svn', '.bzr')):
1296 # Path (relative) to the file
1297 fp = os.path.join(r, curfile)
1298 fd = fp[len(build_dir)+1:]
1300 # Check if this file has been explicitly excluded from scanning
1304 mime = magic.from_file(fp, mime=True) if ms is None else ms.file(fp)
1306 if mime == 'application/x-sharedlib':
1307 count += handleproblem('shared library', fd, fp)
1309 elif mime == 'application/x-archive':
1310 count += handleproblem('static library', fd, fp)
1312 elif mime == 'application/x-executable':
1313 count += handleproblem('binary executable', fd, fp)
1315 elif mime == 'application/x-java-applet':
1316 count += handleproblem('Java compiled class', fd, fp)
1321 'application/java-archive',
1322 'application/octet-stream',
1326 if has_extension(fp, 'apk'):
1327 removeproblem('APK file', fd, fp)
1329 elif has_extension(fp, 'jar'):
1331 if any(suspect.match(curfile) for suspect in usual_suspects):
1332 count += handleproblem('usual supect', fd, fp)
1334 warnproblem('JAR file', fd)
1336 elif has_extension(fp, 'zip'):
1337 warnproblem('ZIP file', fd)
1340 warnproblem('unknown compressed or binary file', fd)
1342 elif has_extension(fp, 'java'):
1343 for line in file(fp):
1344 if 'DexClassLoader' in line:
1345 count += handleproblem('DexClassLoader', fd, fp)
1350 # Presence of a jni directory without buildjni=yes might
1351 # indicate a problem (if it's not a problem, explicitly use
1352 # buildjni=no to bypass this check)
1353 if (os.path.exists(os.path.join(root_dir, 'jni')) and
1354 thisbuild.get('buildjni') is None):
1355 logging.warn('Found jni directory, but buildjni is not enabled')
1364 self.path = os.path.join('stats', 'known_apks.txt')
1366 if os.path.exists(self.path):
1367 for line in file( self.path):
1368 t = line.rstrip().split(' ')
1370 self.apks[t[0]] = (t[1], None)
1372 self.apks[t[0]] = (t[1], time.strptime(t[2], '%Y-%m-%d'))
1373 self.changed = False
1375 def writeifchanged(self):
1377 if not os.path.exists('stats'):
1379 f = open(self.path, 'w')
1381 for apk, app in self.apks.iteritems():
1383 line = apk + ' ' + appid
1385 line += ' ' + time.strftime('%Y-%m-%d', added)
1387 for line in sorted(lst):
1388 f.write(line + '\n')
1391 # Record an apk (if it's new, otherwise does nothing)
1392 # Returns the date it was added.
1393 def recordapk(self, apk, app):
1394 if not apk in self.apks:
1395 self.apks[apk] = (app, time.gmtime(time.time()))
1397 _, added = self.apks[apk]
1400 # Look up information - given the 'apkname', returns (app id, date added/None).
1401 # Or returns None for an unknown apk.
1402 def getapp(self, apkname):
1403 if apkname in self.apks:
1404 return self.apks[apkname]
1407 # Get the most recent 'num' apps added to the repo, as a list of package ids
1408 # with the most recent first.
1409 def getlatest(self, num):
1411 for apk, app in self.apks.iteritems():
1415 if apps[appid] > added:
1419 sortedapps = sorted(apps.iteritems(), key=operator.itemgetter(1))[-num:]
1420 lst = [app for app, _ in sortedapps]
1424 def isApkDebuggable(apkfile, config):
1425 """Returns True if the given apk file is debuggable
1427 :param apkfile: full path to the apk to check"""
1429 p = SilentPopen([os.path.join(config['sdk_path'],
1430 'build-tools', config['build_tools'], 'aapt'),
1431 'dump', 'xmltree', apkfile, 'AndroidManifest.xml'])
1432 if p.returncode != 0:
1433 logging.critical("Failed to get apk manifest information")
1435 for line in p.stdout.splitlines():
1436 if 'android:debuggable' in line and not line.endswith('0x0'):
1441 class AsynchronousFileReader(threading.Thread):
1443 Helper class to implement asynchronous reading of a file
1444 in a separate thread. Pushes read lines on a queue to
1445 be consumed in another thread.
1448 def __init__(self, fd, queue):
1449 assert isinstance(queue, Queue.Queue)
1450 assert callable(fd.readline)
1451 threading.Thread.__init__(self)
1456 '''The body of the tread: read lines and put them on the queue.'''
1457 for line in iter(self._fd.readline, ''):
1458 self._queue.put(line)
1461 '''Check whether there is no more content to expect.'''
1462 return not self.is_alive() and self._queue.empty()
1468 def SilentPopen(commands, cwd=None, shell=False):
1469 return FDroidPopen(commands, cwd=cwd, shell=shell, output=False)
1471 def FDroidPopen(commands, cwd=None, shell=False, output=True):
1473 Run a command and capture the possibly huge output.
1475 :param commands: command and argument list like in subprocess.Popen
1476 :param cwd: optionally specifies a working directory
1477 :returns: A PopenResult.
1482 cwd = os.path.normpath(cwd)
1483 logging.info("Directory: %s" % cwd)
1484 logging.info("> %s" % ' '.join(commands))
1486 result = PopenResult()
1487 p = subprocess.Popen(commands, cwd=cwd, shell=shell,
1488 stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
1490 stdout_queue = Queue.Queue()
1491 stdout_reader = AsynchronousFileReader(p.stdout, stdout_queue)
1492 stdout_reader.start()
1494 # Check the queue for output (until there is no more to get)
1495 while not stdout_reader.eof():
1496 while not stdout_queue.empty():
1497 line = stdout_queue.get()
1498 if output and options.verbose:
1499 # Output directly to console
1500 sys.stdout.write(line)
1502 result.stdout += line
1507 result.returncode = p.returncode
1510 def remove_signing_keys(build_dir):
1511 comment = re.compile(r'[ ]*//')
1512 signing_configs = re.compile(r'^[\t ]*signingConfigs[ \t]*{[ \t]*$')
1514 re.compile(r'^[\t ]*signingConfig [^ ]*$'),
1515 re.compile(r'.*android\.signingConfigs\..*'),
1516 re.compile(r'.*variant\.outputFile = .*'),
1517 re.compile(r'.*\.readLine\(.*'),
1519 for root, dirs, files in os.walk(build_dir):
1520 if 'build.gradle' in files:
1521 path = os.path.join(root, 'build.gradle')
1523 with open(path, "r") as o:
1524 lines = o.readlines()
1527 with open(path, "w") as o:
1529 if comment.match(line):
1533 opened += line.count('{')
1534 opened -= line.count('}')
1537 if signing_configs.match(line):
1541 if any(s.match(line) for s in line_matches):
1547 logging.info("Cleaned build.gradle of keysigning configs at %s" % path)
1550 'project.properties',
1552 'default.properties',
1555 if propfile in files:
1556 path = os.path.join(root, propfile)
1558 with open(path, "r") as o:
1559 lines = o.readlines()
1561 with open(path, "w") as o:
1563 if line.startswith('key.store'):
1565 if line.startswith('key.alias'):
1569 logging.info("Cleaned %s of keysigning configs at %s" % (propfile, path))
1571 def replace_config_vars(cmd):
1572 cmd = cmd.replace('$$SDK$$', config['sdk_path'])
1573 cmd = cmd.replace('$$NDK$$', config['ndk_path'])
1574 cmd = cmd.replace('$$MVN3$$', config['mvn3'])
1577 def place_srclib(root_dir, number, libpath):
1580 relpath = os.path.relpath(libpath, root_dir)
1581 proppath = os.path.join(root_dir, 'project.properties')
1584 if os.path.isfile(proppath):
1585 with open(proppath, "r") as o:
1586 lines = o.readlines()
1588 with open(proppath, "w") as o:
1591 if line.startswith('android.library.reference.%d=' % number):
1592 o.write('android.library.reference.%d=%s\n' % (number, relpath))
1597 o.write('android.library.reference.%d=%s\n' % (number, relpath))