Magisk/build.py

577 lines
19 KiB
Python
Raw Normal View History

2017-06-03 19:39:52 +02:00
#!/usr/bin/env python3
2017-06-03 14:19:01 +02:00
import sys
import os
import subprocess
2019-10-18 00:02:31 +02:00
is_windows = os.name == 'nt'
if is_windows:
import colorama
colorama.init()
2017-11-11 21:17:56 +01:00
2017-06-03 14:19:01 +02:00
def error(str):
print('\n' + '\033[41m' + str + '\033[0m' + '\n')
sys.exit(1)
2017-06-03 14:19:01 +02:00
def header(str):
print('\n' + '\033[44m' + str + '\033[0m' + '\n')
2017-06-03 14:19:01 +02:00
2018-08-05 20:01:04 +02:00
def vprint(str):
if args.verbose:
print(str)
2018-08-05 20:01:04 +02:00
2017-06-03 14:19:01 +02:00
# Environment checks
if not sys.version_info >= (3, 6):
error('Requires Python 3.6+')
2017-06-03 14:19:01 +02:00
if 'ANDROID_HOME' not in os.environ:
error('Please add Android SDK path to ANDROID_HOME environment variable!')
2017-06-03 14:19:01 +02:00
try:
subprocess.run(['java', '-version'],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
2017-06-03 14:19:01 +02:00
except FileNotFoundError:
error('Please install JDK and make sure \'java\' is available in PATH')
2017-06-03 14:19:01 +02:00
import argparse
import multiprocessing
import zipfile
import datetime
import errno
import shutil
import lzma
2017-11-14 22:25:19 +01:00
import tempfile
2017-06-03 14:19:01 +02:00
2019-10-18 00:02:31 +02:00
# Constants
if 'ANDROID_NDK_HOME' in os.environ:
ndk_build = os.path.join(os.environ['ANDROID_NDK_HOME'], 'ndk-build')
2017-12-04 08:16:41 +01:00
else:
ndk_build = os.path.join(
os.environ['ANDROID_HOME'], 'ndk-bundle', 'ndk-build')
2017-12-04 08:16:41 +01:00
2018-05-12 21:04:40 +02:00
cpu_count = multiprocessing.cpu_count()
2019-10-18 00:02:31 +02:00
gradlew = os.path.join('.', 'gradlew' + ('.bat' if is_windows else ''))
2018-06-10 10:55:00 +02:00
archs = ['armeabi-v7a', 'x86']
arch64 = ['arm64-v8a', 'x86_64']
2019-05-31 06:17:58 +02:00
support_targets = ['magisk', 'magiskinit', 'magiskboot', 'magiskpolicy', 'busybox', 'test']
default_targets = ['magisk', 'magiskinit', 'magiskboot', 'busybox']
2019-10-18 00:02:31 +02:00
build_tools = os.path.join(os.environ['ANDROID_HOME'], 'build-tools', '29.0.2')
2018-05-12 21:04:40 +02:00
2019-10-18 00:02:31 +02:00
# Global vars
config = {}
STDOUT = None
def mv(source, target):
try:
shutil.move(source, target)
2019-05-31 06:17:58 +02:00
vprint(f'mv: {source} -> {target}')
2019-02-11 23:14:29 +01:00
except:
pass
def cp(source, target):
try:
shutil.copyfile(source, target)
vprint(f'cp: {source} -> {target}')
2019-02-11 23:14:29 +01:00
except:
pass
def rm(file):
try:
os.remove(file)
2019-05-31 06:17:58 +02:00
vprint(f'rm: {file}')
except OSError as e:
if e.errno != errno.ENOENT:
raise
2017-06-03 14:19:01 +02:00
def mkdir(path, mode=0o777):
try:
os.mkdir(path, mode)
2019-02-11 23:14:29 +01:00
except:
pass
def mkdir_p(path, mode=0o777):
os.makedirs(path, mode, exist_ok=True)
def execv(cmd):
return subprocess.run(cmd, stdout=STDOUT)
def system(cmd):
return subprocess.run(cmd, shell=True, stdout=STDOUT)
def xz(data):
return lzma.compress(data, preset=9, check=lzma.CHECK_NONE)
def load_config(args):
# Some default values
config['outdir'] = 'out'
config['prettyName'] = 'false'
config['keyStore'] = 'release-key.jks'
# Load prop file
2019-10-23 12:57:47 +02:00
if not os.path.exists(args.config):
error(f'Please make sure {args.config} existed')
with open(args.config, 'r') as f:
for line in [l.strip(' \t\r\n') for l in f]:
if line.startswith('#') or len(line) == 0:
continue
prop = line.split('=')
if len(prop) != 2:
continue
config[prop[0].strip(' \t\r\n')] = prop[1].strip(' \t\r\n')
config['prettyName'] = config['prettyName'].lower() == 'true'
# Sanitize configs
if 'version' not in config or 'versionCode' not in config:
error('Config error: "version" and "versionCode" is required')
try:
config['versionCode'] = int(config['versionCode'])
except ValueError:
error('Config error: "versionCode" is required to be an integer')
if args.release and not os.path.exists(config['keyStore']):
error(f'Config error: assign "keyStore" to a java keystore')
mkdir_p(config['outdir'])
global STDOUT
STDOUT = None if args.verbose else subprocess.DEVNULL
def zip_with_msg(zip_file, source, target):
if not os.path.exists(source):
error(f'{source} does not exist! Try build \'binary\' and \'apk\' before zipping!')
zip_file.write(source, target)
vprint(f'zip: {source} -> {target}')
2017-06-03 14:19:01 +02:00
2018-05-12 21:04:40 +02:00
def collect_binary():
for arch in archs + arch64:
mkdir_p(os.path.join('native', 'out', arch))
2019-05-31 06:17:58 +02:00
for bin in support_targets + ['magiskinit64']:
source = os.path.join('native', 'libs', arch, bin)
target = os.path.join('native', 'out', arch, bin)
mv(source, target)
2017-06-03 14:19:01 +02:00
def clean_elf():
2019-10-18 00:02:31 +02:00
if is_windows:
elf_cleaner = os.path.join('tools', 'elf-cleaner.exe')
else:
elf_cleaner = os.path.join('native', 'out', 'elf-cleaner')
2019-10-18 00:02:31 +02:00
if not os.path.exists(elf_cleaner):
execv(['g++', 'tools/termux-elf-cleaner/termux-elf-cleaner.cpp',
'-o', elf_cleaner])
args = [elf_cleaner]
args.extend(os.path.join('native', 'out', arch, 'magisk') for arch in archs + arch64)
execv(args)
2018-08-09 22:41:21 +02:00
def sign_zip(unsigned, output, release):
if not release:
mv(unsigned, output)
return
signer_name = 'zipsigner-3.0.jar'
zipsigner = os.path.join('signing', 'build', 'libs', signer_name)
2018-08-09 22:41:21 +02:00
if not os.path.exists(zipsigner):
header('* Building ' + signer_name)
proc = execv([gradlew, 'signing:shadowJar'])
if proc.returncode != 0:
error(f'Build {signer_name} failed!')
2018-08-09 22:41:21 +02:00
header('* Signing Zip')
2018-08-09 22:41:21 +02:00
proc = execv(['java', '-jar', zipsigner, config['keyStore'], config['keyStorePass'],
config['keyAlias'], config['keyPass'], unsigned, output])
if proc.returncode != 0:
error('Signing zip failed!')
2018-08-09 22:41:21 +02:00
def binary_dump(src, out, var_name):
out.write(f'constexpr unsigned char {var_name}[] = {{')
for i, c in enumerate(xz(src.read())):
if i % 16 == 0:
out.write('\n')
out.write(f'0x{c:02X},')
out.write('\n};\n')
out.flush()
2018-08-09 22:41:21 +02:00
def gen_update_binary():
bs = 1024
update_bin = bytearray(bs)
file = os.path.join('native', 'out', 'x86', 'busybox')
with open(file, 'rb') as f:
x86_bb = f.read()
file = os.path.join('native', 'out', 'armeabi-v7a', 'busybox')
with open(file, 'rb') as f:
arm_bb = f.read()
file = os.path.join('scripts', 'update_binary.sh')
with open(file, 'rb') as f:
script = f.read()
# Align x86 busybox to bs
blk_cnt = (len(x86_bb) - 1) // bs + 1
script = script.replace(b'__X86_CNT__', b'%d' % blk_cnt)
update_bin[:len(script)] = script
update_bin.extend(x86_bb)
# Padding for alignment
update_bin.extend(b'\0' * (blk_cnt * bs - len(x86_bb)))
update_bin.extend(arm_bb)
return update_bin
2018-08-09 22:41:21 +02:00
def run_ndk_build(flags):
proc = system(f'{ndk_build} -C native {base_flags} {flags} -j{cpu_count}')
if proc.returncode != 0:
error('Build binary failed!')
collect_binary()
2018-05-12 21:04:40 +02:00
def build_binary(args):
if args.target:
2019-05-31 06:17:58 +02:00
args.target = set(args.target) & set(support_targets)
if not args.target:
return
else:
2019-05-31 06:17:58 +02:00
args.target = default_targets
header('* Building binaries: ' + ' '.join(args.target))
os.utime(os.path.join('native', 'jni', 'include', 'flags.h'))
# Basic flags
global base_flags
2019-02-12 11:17:02 +01:00
base_flags = f'MAGISK_VERSION={config["version"]} MAGISK_VER_CODE={config["versionCode"]}'
if not args.release:
base_flags += ' MAGISK_DEBUG=1'
if 'magisk' in args.target:
2019-04-05 21:17:57 +02:00
run_ndk_build('B_MAGISK=1 B_64BIT=1')
clean_elf()
# Dump the binary to header
for arch in archs:
bin_file = os.path.join('native', 'out', arch, 'magisk')
with open(os.path.join('native', 'out', arch, 'binaries_arch.h'), 'w') as out:
with open(bin_file, 'rb') as src:
binary_dump(src, out, 'magisk_xz')
for arch, arch32 in list(zip(arch64, archs)):
bin_file = os.path.join('native', 'out', arch, 'magisk')
with open(os.path.join('native', 'out', arch32, 'binaries_arch64.h'), 'w') as out:
with open(bin_file, 'rb') as src:
binary_dump(src, out, 'magisk_xz')
if 'magiskinit' in args.target:
if not os.path.exists(os.path.join('native', 'out', 'x86', 'binaries_arch.h')):
error('Build "magisk" before building "magiskinit"')
if not os.path.exists(os.path.join('native', 'out', 'binaries.h')):
error('Build stub APK before building "magiskinit"')
run_ndk_build('B_INIT=1')
run_ndk_build('B_INIT64=1')
2019-05-31 06:17:58 +02:00
if 'magiskpolicy' in args.target:
run_ndk_build('B_POLICY=1')
if 'magiskboot' in args.target:
run_ndk_build('B_BOOT=1')
2019-07-08 02:38:22 +02:00
if 'busybox' in args.target:
run_ndk_build('B_BB=1')
if 'test' in args.target:
2019-04-05 21:17:57 +02:00
run_ndk_build('B_TEST=1 B_64BIT=1')
def build_apk(args, module):
build_type = 'Release' if args.release else 'Debug'
2019-03-08 16:19:22 +01:00
proc = execv([gradlew, f'{module}:assemble{build_type}',
'-PconfigPath=' + os.path.abspath(args.config)])
if proc.returncode != 0:
2019-10-18 00:02:31 +02:00
error(f'Build {module} failed!')
2017-06-03 16:04:22 +02:00
build_type = build_type.lower()
apk = f'{module}-{build_type}.apk'
source = os.path.join(module, 'build', 'outputs', 'apk', build_type, apk)
target = os.path.join(config['outdir'], apk)
2019-10-18 00:02:31 +02:00
if args.release:
zipalign = os.path.join(build_tools, 'zipalign' + ('.exe' if is_windows else ''))
aapt2 = os.path.join(build_tools, 'aapt2' + ('.exe' if is_windows else ''))
apksigner = os.path.join(build_tools, 'apksigner' + ('.bat' if is_windows else ''))
try:
with tempfile.NamedTemporaryFile(delete=False) as f:
tmp = f.name
# AAPT2 optimization
execv([aapt2, 'optimize', '-o', tmp, '--enable-resource-obfuscation',
'--enable-resource-path-shortening', source])
# Recompress everything just to piss people off
with zipfile.ZipFile(source, 'w', compression=zipfile.ZIP_DEFLATED) as zout:
with zipfile.ZipFile(tmp) as zin:
for e in zin.namelist():
zout.writestr(e, zin.read(e))
# Zipalign
execv([zipalign, '-fz', '4', source, target])
# Sign APK
execv([apksigner, 'sign', '--v1-signer-name', 'CERT',
'--ks', config['keyStore'],
'--ks-pass', f'pass:{config["keyStorePass"]}',
'--ks-key-alias', config['keyAlias'],
'--key-pass', f'pass:{config["keyPass"]}', target])
finally:
rm(tmp)
rm(source)
else:
mv(source, target)
header('Output: ' + target)
return target
2018-08-09 23:54:26 +02:00
2018-08-20 06:02:38 +02:00
def build_app(args):
2019-03-12 22:01:37 +01:00
header('* Building Magisk Manager')
source = os.path.join('scripts', 'util_functions.sh')
2019-03-08 16:19:22 +01:00
target = os.path.join('app', 'src', 'main',
'res', 'raw', 'util_functions.sh')
cp(source, target)
build_apk(args, 'app')
2018-05-27 08:55:24 +02:00
2018-08-20 06:02:38 +02:00
def build_stub(args):
2019-03-12 22:01:37 +01:00
header('* Building Magisk Manager stub')
stub = build_apk(args, 'stub')
# Dump the stub APK to header
mkdir(os.path.join('native', 'out'))
with open(os.path.join('native', 'out', 'binaries.h'), 'w') as out:
with open(stub, 'rb') as src:
binary_dump(src, out, 'manager_xz')
2018-08-09 23:15:39 +02:00
2017-10-07 16:48:16 +02:00
def build_snet(args):
2019-03-12 22:01:37 +01:00
header('* Building snet extension')
proc = execv([gradlew, 'snet:assembleRelease'])
if proc.returncode != 0:
error('Build snet extention failed!')
source = os.path.join('snet', 'build', 'outputs', 'apk',
'release', 'snet-release-unsigned.apk')
2019-08-08 13:18:32 +02:00
target = os.path.join(config['outdir'], 'snet.jar')
# Extract classes.dex
with zipfile.ZipFile(target, 'w', compression=zipfile.ZIP_DEFLATED, allowZip64=False) as zout:
with zipfile.ZipFile(source) as zin:
2019-08-08 13:18:32 +02:00
zout.writestr('classes.dex', zin.read('classes.dex'))
rm(source)
header('Output: ' + target)
2017-06-03 14:19:01 +02:00
def zip_main(args):
header('* Packing Flashable Zip')
2019-10-18 00:02:31 +02:00
with tempfile.NamedTemporaryFile(delete=False) as f:
unsigned = f.name
with zipfile.ZipFile(unsigned, 'w', compression=zipfile.ZIP_DEFLATED, allowZip64=False) as zipf:
# update-binary
target = os.path.join('META-INF', 'com', 'google',
'android', 'update-binary')
vprint('zip: ' + target)
zipf.writestr(target, gen_update_binary())
# updater-script
source = os.path.join('scripts', 'flash_script.sh')
target = os.path.join('META-INF', 'com', 'google',
'android', 'updater-script')
zip_with_msg(zipf, source, target)
# Binaries
for lib_dir, zip_dir in [('armeabi-v7a', 'arm'), ('x86', 'x86')]:
for binary in ['magiskinit', 'magiskinit64', 'magiskboot']:
source = os.path.join('native', 'out', lib_dir, binary)
target = os.path.join(zip_dir, binary)
zip_with_msg(zipf, source, target)
# APK
source = os.path.join(
config['outdir'], 'app-release.apk' if args.release else 'app-debug.apk')
target = os.path.join('common', 'magisk.apk')
zip_with_msg(zipf, source, target)
# boot_patch.sh
source = os.path.join('scripts', 'boot_patch.sh')
target = os.path.join('common', 'boot_patch.sh')
zip_with_msg(zipf, source, target)
# util_functions.sh
source = os.path.join('scripts', 'util_functions.sh')
with open(source, 'r') as script:
# Add version info util_functions.sh
2019-03-08 16:19:22 +01:00
util_func = script.read().replace(
'#MAGISK_VERSION_STUB',
f'MAGISK_VER="{config["version"]}"\nMAGISK_VER_CODE={config["versionCode"]}')
target = os.path.join('common', 'util_functions.sh')
vprint(f'zip: {source} -> {target}')
zipf.writestr(target, util_func)
# addon.d.sh
source = os.path.join('scripts', 'addon.d.sh')
target = os.path.join('common', 'addon.d.sh')
zip_with_msg(zipf, source, target)
# chromeos
for tool in ['futility', 'kernel_data_key.vbprivk', 'kernel.keyblock']:
source = os.path.join('tools', tool)
target = os.path.join('chromeos', tool)
zip_with_msg(zipf, source, target)
# End of zipping
output = os.path.join(config['outdir'], f'Magisk-v{config["version"]}.zip' if config['prettyName'] else
'magisk-release.zip' if args.release else 'magisk-debug.zip')
sign_zip(unsigned, output, args.release)
2019-10-18 00:02:31 +02:00
rm(unsigned)
header('Output: ' + output)
2017-06-03 14:19:01 +02:00
def zip_uninstaller(args):
header('* Packing Uninstaller Zip')
2019-10-18 00:02:31 +02:00
with tempfile.NamedTemporaryFile(delete=False) as f:
unsigned = f.name
with zipfile.ZipFile(unsigned, 'w', compression=zipfile.ZIP_DEFLATED, allowZip64=False) as zipf:
# update-binary
target = os.path.join('META-INF', 'com', 'google',
'android', 'update-binary')
vprint('zip: ' + target)
zipf.writestr(target, gen_update_binary())
# updater-script
source = os.path.join('scripts', 'magisk_uninstaller.sh')
target = os.path.join('META-INF', 'com', 'google',
'android', 'updater-script')
zip_with_msg(zipf, source, target)
# Binaries
for lib_dir, zip_dir in [('armeabi-v7a', 'arm'), ('x86', 'x86')]:
2019-02-24 08:11:11 +01:00
source = os.path.join('native', 'out', lib_dir, 'magiskboot')
target = os.path.join(zip_dir, 'magiskboot')
zip_with_msg(zipf, source, target)
# util_functions.sh
source = os.path.join('scripts', 'util_functions.sh')
with open(source, 'r') as script:
target = os.path.join('util_functions.sh')
vprint(f'zip: {source} -> {target}')
zipf.writestr(target, script.read())
# chromeos
for tool in ['futility', 'kernel_data_key.vbprivk', 'kernel.keyblock']:
source = os.path.join('tools', tool)
target = os.path.join('chromeos', tool)
zip_with_msg(zipf, source, target)
# End of zipping
datestr = datetime.datetime.now().strftime("%Y%m%d")
output = os.path.join(config['outdir'], f'Magisk-uninstaller-{datestr}.zip'
if config['prettyName'] else 'magisk-uninstaller.zip')
sign_zip(unsigned, output, args.release)
2019-10-18 00:02:31 +02:00
rm(unsigned)
header('Output: ' + output)
2017-06-03 14:19:01 +02:00
def cleanup(args):
support_targets = {'native', 'java'}
if args.target:
args.target = set(args.target) & support_targets
else:
# If nothing specified, clean everything
args.target = support_targets
if 'native' in args.target:
header('* Cleaning native')
system(ndk_build + ' -C native B_MAGISK=1 B_INIT=1 B_BOOT=1 B_BB=1 clean')
shutil.rmtree(os.path.join('native', 'out'), ignore_errors=True)
if 'java' in args.target:
header('* Cleaning java')
2019-03-12 22:01:37 +01:00
execv([gradlew, 'clean'])
2018-05-12 21:04:40 +02:00
2018-08-09 23:54:26 +02:00
def build_all(args):
vars(args)['target'] = []
build_stub(args)
build_app(args)
build_binary(args)
zip_main(args)
zip_uninstaller(args)
2018-08-09 23:54:26 +02:00
2017-06-03 14:19:01 +02:00
parser = argparse.ArgumentParser(description='Magisk build script')
parser.add_argument('-r', '--release', action='store_true',
help='compile in release mode')
parser.add_argument('-v', '--verbose', action='store_true',
help='verbose output')
parser.add_argument('-c', '--config', default='config.prop',
help='override config file (default: config.prop)')
2017-06-03 14:19:01 +02:00
subparsers = parser.add_subparsers(title='actions')
all_parser = subparsers.add_parser(
'all', help='build binaries, apks, zips')
2017-06-03 14:19:01 +02:00
all_parser.set_defaults(func=build_all)
2018-08-09 23:54:26 +02:00
binary_parser = subparsers.add_parser('binary', help='build binaries')
binary_parser.add_argument(
'target', nargs='*', help=f"{', '.join(support_targets)}, \
2019-05-31 06:17:58 +02:00
or empty for defaults ({', '.join(default_targets)})")
2017-06-03 14:19:01 +02:00
binary_parser.set_defaults(func=build_binary)
app_parser = subparsers.add_parser('app', help='build Magisk Manager')
app_parser.set_defaults(func=build_app)
2017-06-03 14:19:01 +02:00
stub_parser = subparsers.add_parser(
'stub', help='build stub Magisk Manager')
2018-08-09 23:15:39 +02:00
stub_parser.set_defaults(func=build_stub)
snet_parser = subparsers.add_parser(
'snet', help='build snet extention for Magisk Manager')
2017-10-07 16:48:16 +02:00
snet_parser.set_defaults(func=build_snet)
zip_parser = subparsers.add_parser(
'zip', help='zip Magisk into a flashable zip')
2017-06-03 14:19:01 +02:00
zip_parser.set_defaults(func=zip_main)
un_parser = subparsers.add_parser(
'uninstaller', help='create flashable uninstaller')
2018-08-09 23:54:26 +02:00
un_parser.set_defaults(func=zip_uninstaller)
2017-06-03 14:19:01 +02:00
clean_parser = subparsers.add_parser('clean', help='cleanup')
clean_parser.add_argument(
'target', nargs='*', help='native, java, or empty to clean both')
2017-06-03 14:19:01 +02:00
clean_parser.set_defaults(func=cleanup)
if len(sys.argv) == 1:
parser.print_help()
sys.exit(1)
2017-06-03 14:19:01 +02:00
args = parser.parse_args()
load_config(args)
# Call corresponding functions
2017-06-03 14:19:01 +02:00
args.func(args)