build.pl

#!/usr/bin/env perl

use strict;
use warnings;

use FindBin qw($Bin);
use lib $Bin;

use Xposed;

use Archive::Zip qw(:ERROR_CODES :CONSTANTS);
use Data::Dumper;
use File::Basename;
use File::Copy;
use File::Path qw(make_path remove_tree);
use Getopt::Std;
use POSIX qw(strftime);
use Tie::IxHash;
use Term::ANSIColor;

our $VERSION = '0.9';

my %opts;
$| = 1;

# Main routine
sub main() {
    $Getopt::Std::STANDARD_HELP_VERSION = 1;
    getopts('a:firs:t:v', \%opts) || usage(2);
    $opts{'r'} //= 0;

    # Load the config file
    print_status("Loading config file $Bin/build.conf...", 0);
    $Xposed::cfg = Xposed::load_config("$Bin/build.conf") || exit 1;

    # Check some build requirements
    print_status('Checking requirements...', 0);
    Xposed::check_requirements() || exit 1;

    my $action = $opts{'a'} || 'build';
    if ($action eq 'build') {
        my $jar = $Xposed::cfg->val('General', 'outdir') . '/java/XposedBridge.jar';
        if (!-r $jar) {
            print_error("$jar doesn't exist or isn't readable");
            exit 1;
        }

        # Determine build targets
        my $target_spec = $opts{'t'} || '';
        print_status("Expanding targets from '$target_spec'...", 0);
        my @targets = Xposed::expand_targets($target_spec, 1);
        if (!@targets) {
            print_error('No valid targets specified');
            usage(2);
        }
        print "\n";

        # Check whether flashing is possible
        if ($opts{'f'} && $#targets != 0) {
            print_error('Flashing is only supported for a single target!');
            exit 1;
        }

        # Build the specified targets
        foreach my $target (@targets) {
            all_in_one($target->{'platform'}, $target->{'sdk'}, !$opts{'v'}) || exit 1;
        }
    } elsif ($action eq 'java') {
        # Build XposedBridge.jar
        build_java() || exit 1;
    } elsif ($action eq 'prunelogs') {
        # Remove old logs
        prune_logs() || exit 1;
    } else {
        print_error("Unknown action specified: $action");
        usage(2);
    }

    print_status('Done!', 0);
}

# Print usage and exit
sub usage($) {
    my $exit = shift;
    print STDERR <<USAGE;

This script helps to compile and package the Xposed executables and libraries.

Usage: $0 [-v] [-i] [-f] [-a <action>][-t <targets>] [-s <steps>] [-r]
  -a   Execute <action>. The default is "build".
  -f   Flash the files after building and performs a soft reboot. Requires step "zip".
  -t   Build for targets specified in <targets>.
  -r   Mark this as a release build. Currently only affects GPG signing.
  -s   Limit build steps to <steps>. By default, all steps are performed.
  -i   Incremental build. Compile faster by skipping dependencies (like mm/mmm).
  -v   Verbose mode. Display the build log instead of redirecting it to a file.

Possible actions are:
  build       Builds the native executables and libraries.
  java        Builds the Java part (XposedBridge).
  prunelogs   Removes logs which are older than 24 hours.

Format of <targets> is: <platform>:<sdk>[/<platform2>:<sdk2>/...]
  <platform> is a comma-separated list of: arm, x86, arm64 (and up to SDK 17, also armv5)
  <sdk> is a comma-separated list of integers (e.g. 21 for Android 5.0)
  Both platform and SDK accept the wildcard "all".

Values for <steps> are provided as a comma-separated list of:
  compile   Compile executables and libraries.
  collect   Collect compiled files and put them in the output directory.
  prop      Create the xposed.prop file.
  zip       Create the flashable ZIP file.
  gpg       Sign the ZIP file with GPG (as configured).


Examples:
$0 -t arm:all/x86,arm64:21
   (build ARM files for all SDKs, plus x86 and arm64 files for SDK 21)

USAGE
    exit $exit if $exit >= 0;
}

sub HELP_MESSAGE() {
    usage(-1);
}

sub VERSION_MESSAGE() {
    print "Xposed build script, version $VERSION\n";
}

# Returns whether a certain build step should be performed
sub should_perform_step($) {
    my $step = shift;
    return 1 if !$opts{'s'};
    my @steps = split(m/[, ]+/, $opts{'s'});
    foreach (@steps) {
        return 1 if $step eq $_;
    }
    return 0;
}

# Performs all build steps for one platform/SDK combination
sub all_in_one($$;$) {
    my $platform = shift;
    my $sdk = shift;
    my $silent = shift || 0;

    print_status("Processing SDK $sdk, platform $platform...", 0);

    compile($platform, $sdk, $silent) || return 0;
    if ($platform ne 'host' && $platform ne 'hostd') {
        collect($platform, $sdk) || return 0;
        create_xposed_prop($platform, $sdk, !$silent) || return 0;
        create_zip($platform, $sdk) || return 0;
        gpg_sign($platform, $sdk) || return 0;
    }

    print "\n\n";

    return 1;
}

# Compile Xposed (and possibly ART) for one SDK/platform
sub compile($$;$) {
    my $platform = shift;
    my $sdk = shift;
    my $silent = shift || 0;

    should_perform_step('compile') || return 1;
    print_status("Compiling...", 1);

    my @params = Xposed::get_make_parameters($platform, $sdk);
    my @targets = qw(xposed);
    my @makefiles = qw(frameworks/base/cmds/xposed/Android.mk);

    # Version-specific targets
    if ($sdk < 21) {
        push @targets, qw/libxposed_dalvik/;
    } else {
        push @targets, qw/libxposed_art/;
        push @targets, qw/libart libart-compiler libart-disassembler libsigchain/;
        push @targets, qw/dex2oat oatdump patchoat/;
        push @makefiles, qw(art/Android.mk);
    }

    if ($platform eq 'host') {
        $ENV{'HOST_PREFER_32_BIT'} = 'true' if $sdk < 24;
        $ENV{'ART_BUILD_HOST_NDEBUG'} = 'true';
        @targets = qw(
            out/host/linux-x86/bin/dex2oat
            out/host/linux-x86/bin/oatdump
        );
        @makefiles = qw(art/Android.mk);
    } elsif ($platform eq 'hostd') {
        $ENV{'HOST_PREFER_32_BIT'} = 'true' if $sdk < 24;
        $ENV{'ART_BUILD_HOST_DEBUG'} = 'true';
        @targets = qw(
            out/host/linux-x86/bin/dex2oatd
            out/host/linux-x86/bin/oatdumpd
        );
        @makefiles = qw(art/Android.mk);
    }

    my $result = Xposed::compile($platform, $sdk, \@params, \@targets, \@makefiles, $opts{'i'}, $silent);

    delete($ENV{'ART_BUILD_HOST_NDEBUG'});
    delete($ENV{'ART_BUILD_HOST_DEBUG'});

    return $result;
}

# Collect final files into a single directory
sub collect($$) {
    my $platform = shift;
    my $sdk = shift;

    should_perform_step('collect') || return 1;
    print_status("Collecting compiled files...", 1);

    my $coldir = Xposed::get_collection_dir($platform, $sdk);
    make_path($coldir);
    my $rootdir = Xposed::get_rootdir($sdk) || return 0;
    my $outdir = Xposed::get_outdir($platform) || return 0;

    # Clear collection directory
    remove_tree($coldir . '/files');
    return 0 if -e $coldir . '/files';

    # Copy files
    my $files = get_compiled_files($platform, $sdk);
    while( my ($file, $target) = each(%$files)) {
        $file = $rootdir . '/' . $outdir . $file;
        $target = $coldir . '/files' . $target;
        print "$file => $target\n";
        make_path(dirname($target));
        if (!copy($file, $target)) {
            print_error("Copy failed: $!");
            return 0;
        }
    }

    return 1;
}

# Returns a hash paths of compiled files
sub get_compiled_files($$) {
    my $platform = shift;
    my $sdk = shift;

    my %files;
    tie(%files, 'Tie::IxHash');

    if ($sdk < 21) {
        $files{'/system/bin/app_process_xposed'} = '/system/bin/app_process_xposed';
        $files{$_} = $_ foreach qw(
            /system/lib/libxposed_dalvik.so
        );
    } else {
        $files{$_} = $_ foreach qw(
            /system/bin/app_process32_xposed
            /system/lib/libxposed_art.so

            /system/lib/libart.so
            /system/lib/libart-compiler.so
            /system/lib/libart-disassembler.so
            /system/lib/libsigchain.so

            /system/bin/dex2oat
            /system/bin/oatdump
            /system/bin/patchoat
        );

        if ($platform eq 'arm64') {
            # libart-disassembler is required by oatdump only, which is a 64-bit executable
            delete $files{'/system/lib/libart-disassembler.so'};

            $files{$_} = $_ foreach qw(
                /system/bin/app_process64_xposed
                /system/lib64/libxposed_art.so

                /system/lib64/libart.so
                /system/lib64/libart-disassembler.so
                /system/lib64/libsigchain.so
            );

            if ($sdk >= 24) {
                $files{'/system/lib64/libart-compiler.so'} = '/system/lib64/libart-compiler.so';
            }
        }
    }

    return \%files;
}

# Creates the /system/xposed.prop file
sub create_xposed_prop($$;$) {
    my $platform = shift;
    my $sdk = shift;
    my $print = shift || 0;

    should_perform_step('prop') || return 1;
    print_status("Creating xposed.prop file...", 1);

    # Open the file
    my $coldir = Xposed::get_collection_dir($platform, $sdk);
    my $propfile = $coldir . '/files/system/xposed.prop';
    print "$propfile\n";
    make_path(dirname($propfile));
    if (!open(PROPFILE, '>', $propfile)) {
        print_error("Could not write to $propfile: $!");
        return 0;
    }

    # Prepare variables
    my $version = Xposed::get_version();
    if ($platform eq 'armv5') {
        $platform = 'arm';
    }

    # Calculate minimum / maximum compatible SDK versions
    my $minsdk = $sdk;
    my $maxsdk = $sdk;

    if ($sdk >= 15 && $sdk <= 19) {
        $minsdk = 15;
        $maxsdk = 19;
    }

    # Write to file
    my $content = <<EOF;
version=$version
arch=$platform
minsdk=$minsdk
maxsdk=$maxsdk
EOF

    if ($sdk >= 24) {
        $content .= "requires:fbe_aware=1\n"
    }

    print PROPFILE $content;
    print $content if $print;

    # Close the file
    close(PROPFILE);

    return 1;
}

# Create a flashable ZIP file with the compiled and some static files
sub create_zip($$) {
    my $platform = shift;
    my $sdk = shift;

    should_perform_step('zip') || return 1;
    print_status("Creating flashable ZIP file...", 1);

    # Create a new ZIP file
    my $zip = Archive::Zip->new();
    my $outdir = $Xposed::cfg->val('General', 'outdir');
    my $coldir = Xposed::get_collection_dir($platform, $sdk);
    make_path($coldir);
    $zip->addTree($coldir . '/files/', '') == AZ_OK || return 0;
    $zip->addDirectory('system/framework/') || return 0;
    $zip->addFile("$outdir/java/XposedBridge.jar", 'system/framework/XposedBridge.jar') || return 0;
    # TODO: We probably need different files for older releases
    $zip->addTree($Bin . '/zipstatic/_all/', '') == AZ_OK || return 0;
    $zip->addTree($Bin . '/zipstatic/' . $platform . '/', '') == AZ_OK || return 0;

    # Set last modification time to "now"
    my $now = time();
    foreach my $member($zip->members()) {
        $member->setLastModFileDateTimeFromUnix($now);
    }

    # Write the ZIP file to disk
    my ($version, $suffix) = Xposed::get_version_for_filename();
    my $zipname = sprintf('xposed-v%s-sdk%d-%s%s.zip', $version, $sdk, $platform, $suffix);
    my $zippath = $coldir . '/' . $zipname;
    print "$zippath\n";
    $zip->writeToFileNamed($zippath) == AZ_OK || return 0;

    Xposed::sign_zip($zippath);

    # Create a stable symlink to the latest version
    my $latestlink = $coldir . '/latest.zip';
    unlink($latestlink);
    if (!symlink($zipname, $latestlink)) {
        print_error("Could not create link $latestlink -> $zipname: $!");
    }

    # Create a symlink in a version-specific directory for easier collection
    my $versiondir = Xposed::get_version_dir();
    my $versionlink = $versiondir . '/' . $zipname;
    make_path($versiondir);
    unlink($versionlink);
    if (!symlink($zippath, $versionlink)) {
        print_error("Could not create link $versionlink -> $zippath: $!");
    }

    # Flash the file (if requested)
    if ($opts{'f'}) {
        print_status("Flashing ZIP file...", 1);
        my $shell = `adb shell id` =~ m/uid=0/ ? 'sh' : 'su';
        system("adb push $zippath /data/local/tmp/xposed.zip") == 0 || return 0;
        system("adb push $Bin/zipstatic/$platform/META-INF/com/google/android/update-binary /data/local/tmp/update-binary") == 0 || return 0;
        system("adb shell 'chmod 700 /data/local/tmp/update-binary'") == 0  || return 0;
        system("adb shell $shell -c \\'NO_UIPRINT=1 /data/local/tmp/update-binary 2 1 /data/local/tmp/xposed.zip\\'") == 0  || return 0;
        system("adb shell 'rm /data/local/tmp/update-binary /data/local/tmp/xposed.zip'") == 0 || return 0;
        system("adb shell $shell -c stop") == 0 || return 0;
        sleep(2);
        system("adb shell $shell -c start") == 0 || return 0;
    }

    return 1;
}

# Sign the ZIP file with GPG.
sub gpg_sign($$) {
    my $platform = shift;
    my $sdk = shift;

    should_perform_step('gpg') || return 1;
    Xposed::should_gpg_sign($opts{'r'}) || return 1;
    print_status("Signing ZIP file with GPG...", 1);

    # Calculate ZIP path.
    my $coldir = Xposed::get_collection_dir($platform, $sdk);
    my ($version, $suffix) = Xposed::get_version_for_filename();
    my $zipname = sprintf('xposed-v%s-sdk%d-%s%s.zip', $version, $sdk, $platform, $suffix);
    my $zippath = $coldir . '/' . $zipname;
    print "$zippath.asc\n";

    # Sign the file.
    return Xposed::gpg_sign($zippath);
}

# Build XposedBridge.jar
sub build_java() {
    print_status('Building the Java part...', 0);
    my $javadir = $Xposed::cfg->val('General', 'javadir');
    if (!-d $javadir) {
        print_error('[General][javadir] must point to a directory');
        return 0;
    }

    print_status('Compiling...', 1);
    chdir($javadir);
    system('./gradlew app:assembleRelease lint') == 0 || return 0;
    print "\n";

    print_status('Copying APK to XposedBridge.jar...', 1);
    my $base = $javadir . '/app/build/outputs/apk/app-release';
    foreach my $suffix ('.apk', '-unaligned.apk', '-unsigned.apk') {
        my $file = $base . $suffix;
        if (-f $file) {
            my $target = $Xposed::cfg->val('General', 'outdir') . '/java/XposedBridge.jar';
            print "$file => $target\n";
            make_path(dirname($target));
            if (!copy($file, $target)) {
                print_error("Copy failed: $!");
                return 0;
            }
            print "\n";
            return 1;
        } else {
           print "Skipping non-existent $file\n";
        }
    }

    print_error('No suitable file found, please check the build results');
    return 0;
}

# Remove old logs
sub prune_logs(;$) {
    my $cutoff = shift || (time() - 86400);
    print_status('Cleaning log files...', 0);

    foreach my $logdir (glob($Xposed::cfg->val('General', 'outdir') . '/sdk*/*/logs/')) {
        print_status("Cleaning $logdir...", 1);

        my $removed = 0;
        opendir(DIR, $logdir) || next;
        foreach my $file (sort readdir(DIR)) {
            next if ($file !~ m/\.log$/);
            my $filepath = $logdir . '/' . $file;
            my $modtime = (stat($filepath))[9];
            if ($modtime < $cutoff) {
                print "[REMOVE]  $file\n";
                unlink($filepath);
                $removed = 1;
            } else {
                print "[KEEP]    $file\n";
            }
        }
        closedir(DIR);

        print "\n" if $removed;
    }

    return 1;
}

main();