dinghy-lib 0.8.4

Cross-compilation made easier - see main crate cargo-dinghy
Documentation
use crate::config::PlatformConfiguration;
use crate::toolchain::ToolchainConfig;
use crate::{Device, Platform, PlatformManager, Result};
use fs_err as fs;
use std::fs::FileType;
use std::{env, path, process};

pub use self::device::AndroidDevice;

use crate::android::platform::AndroidPlatform;
use crate::utils::LogCommandExt;
use anyhow::{anyhow, bail, Context};
use log::debug;

mod device;
mod platform;

pub struct AndroidManager {
    adb: path::PathBuf,
}

impl PlatformManager for AndroidManager {
    fn devices(&self) -> Result<Vec<Box<dyn Device>>> {
        let result = process::Command::new(&self.adb)
            .arg("devices")
            .log_invocation(3)
            .output()?;
        let mut devices = vec![];
        let device_regex = ::regex::Regex::new(r#"^(\S+)\tdevice\r?$"#)?;
        for line in String::from_utf8(result.stdout)?.split("\n").skip(1) {
            if let Some(caps) = device_regex.captures(line) {
                let d = AndroidDevice::from_id(self.adb.clone(), &caps[1])?;
                debug!(
                    "Discovered Android device {} ({:?})",
                    d, d.supported_targets
                );
                devices.push(Box::new(d) as Box<dyn Device>);
            }
        }
        Ok(devices)
    }
    fn platforms(&self) -> Result<Vec<Box<dyn Platform>>> {
        if let Some(ndk) = ndk()? {
            let default_api_level = "21";
            debug!("Android NDK: {:?}", ndk);
            let version = ndk_version(&ndk)?;
            let major = version
                .split(".")
                .next()
                .ok_or_else(|| anyhow!("Invalid version found for ndk {:?}", &ndk))?;
            let major: usize = major
                .parse()
                .with_context(|| format!("Invalid version found for ndk {:?}", &ndk))?;
            debug!(
                "Android ndk: {:?}, ndk version: {}, major: {}",
                ndk, version, major
            );
            if major >= 19 {
                let mut platforms = vec![];
                let prebuilt = ndk.join("toolchains/llvm/prebuilt");
                let tools = prebuilt
                    .read_dir()?
                    .filter(|it| {
                        // ensure we only check dirs as macOS may add pesky .DS_Store files...
                        it.as_ref()
                            .ok()
                            .and_then(|it| it.file_type().ok().as_ref().map(FileType::is_dir))
                            .unwrap_or(false)
                    })
                    .next()
                    .ok_or_else(|| anyhow!("No tools in toolchain"))??;
                let bin = tools.path().join("bin");
                debug!("Android tools bin: {:?}", bin);
                let libclang_path = tools.path().join(if major >= 26 { "lib" } else { "lib64" });
                for (rustc_cpu, cc_cpu, binutils_cpu, abi_kind) in &[
                    ("aarch64", "aarch64", "aarch64", "android"),
                    ("armv7", "armv7a", "arm", "androideabi"),
                    ("i686", "i686", "i686", "android"),
                    ("x86_64", "x86_64", "x86_64", "android"),
                ] {
                    let mut api_levels: Vec<String> = Vec::new();
                    for entry in fs::read_dir(tools.path().join(format!(
                        "sysroot/usr/lib/{}-linux-{}",
                        binutils_cpu, abi_kind
                    )))? {
                        let entry = entry?;
                        if entry.file_type()?.is_dir() {
                            let folder_name = entry.file_name().into_string().unwrap();
                            match folder_name.parse::<u32>() {
                                Ok(_) => api_levels.push(folder_name),
                                Err(_) => {}
                            }
                        }
                    }
                    api_levels.sort();
                    let create_platform = |api: &str, suffix: &str| {
                        let id = format!("auto-android-{}{}", rustc_cpu, suffix);
                        let tc = ToolchainConfig {
                            bin_dir: bin.clone(),
                            rustc_triple: format!("{}-linux-{}", rustc_cpu, abi_kind),
                            root: prebuilt.clone(),
                            sysroot: Some(tools.path().join("sysroot")),
                            cc: "clang".to_string(),
                            cxx: "clang++".to_string(),
                            binutils_prefix: format!("{}-linux-{}", binutils_cpu, abi_kind),
                            cc_prefix: format!("{}-linux-{}{}", cc_cpu, abi_kind, api),
                        };
                        AndroidPlatform::new(
                            PlatformConfiguration::default(),
                            id,
                            tc,
                            major,
                            ndk.clone(),
                            libclang_path.clone(),
                        )
                    };
                    for api in api_levels.iter() {
                        platforms.push(create_platform(&api, &format!("-api{}", api))?);
                    }
                    if !api_levels.is_empty() {
                        platforms.push(create_platform(
                            api_levels
                                .first()
                                .expect("The api level vector shouldn't be empty"),
                            "-min",
                        )?);
                        platforms.push(create_platform(
                            api_levels
                                .last()
                                .expect("The api level vector shouldn't be empty"),
                            "-latest",
                        )?);
                    }
                    platforms.push(create_platform(default_api_level, "")?);
                }
                return Ok(platforms);
            }
        }
        return Ok(vec![]);
    }
}

impl AndroidManager {
    pub fn probe() -> Option<AndroidManager> {
        match adb() {
            Ok(adb) => {
                debug!("ADB found: {:?}", adb);
                Some(AndroidManager { adb })
            }
            Err(_) => {
                debug!("adb not found in path, android disabled");
                None
            }
        }
    }
}

fn probable_sdk_locs() -> Result<Vec<path::PathBuf>> {
    let mut v = vec![];
    for var in &[
        "ANDROID_HOME",
        "ANDROID_SDK",
        "ANDROID_SDK_ROOT",
        "ANDROID_SDK_HOME",
    ] {
        if let Ok(path) = env::var(var) {
            let path = path::Path::new(&path);
            if path.is_dir() {
                v.push(path.to_path_buf())
            }
        }
    }
    if let Ok(home) = env::var("HOME") {
        let mac = path::Path::new(&home).join("Library/Android/sdk");
        if mac.is_dir() {
            v.push(mac);
        }
        let linux = path::Path::new(&home).join("Android/Sdk");
        if linux.is_dir() {
            v.push(linux);
        }
    }
    let casks = path::PathBuf::from("/usr/local/Caskroom/android-sdk");
    if casks.is_dir() {
        for kid in casks.read_dir()? {
            let kid = kid?;
            if kid.file_name() != ".metadata" {
                v.push(kid.path());
            }
        }
    }
    debug!("Candidates SDK: {:?}", v);
    Ok(v)
}

fn ndk() -> Result<Option<path::PathBuf>> {
    if let Ok(path) = env::var("ANDROID_NDK_HOME") {
        return Ok(Some(path.into()));
    }
    if let Ok(path) = env::var("ANDROID_NDK") {
        return Ok(Some(path.into()));
    }
    for sdk in probable_sdk_locs()? {
        if sdk.join("ndk-bundle/source.properties").is_file() {
            return Ok(Some(sdk.join("ndk-bundle")));
        }
        if let Some(ndk) = find_non_legacy_ndk(&sdk)? {
            return Ok(Some(ndk));
        }
    }
    debug!("Android NDK not found");
    Ok(None)
}

fn ndk_version(ndk: &path::Path) -> Result<String> {
    let sources_prop_file = ndk.join("source.properties");
    let props = fs::read_to_string(&sources_prop_file)
        .with_context(|| format!("Reading prop file {sources_prop_file:?}"))?;
    let revision_line = props
        .split("\n")
        .find(|l| l.starts_with("Pkg.Revision"))
        .with_context(|| {
            format!(
                "{:?} does not contain a Pkg.Revision line. Invalid SDK?",
                sources_prop_file
            )
        })?;
    Ok(revision_line.split(" ").last().unwrap().to_string())
}

fn adb() -> Result<path::PathBuf> {
    fn try_out(command: &path::Path) -> bool {
        match process::Command::new(command)
            .arg("--version")
            .stdout(process::Stdio::null())
            .stderr(process::Stdio::null())
            .log_invocation(3)
            .status()
        {
            Ok(_) => true,
            Err(_) => false,
        }
    }
    if let Ok(adb) = env::var("DINGHY_ANDROID_ADB") {
        return Ok(adb.into());
    }
    if let Ok(adb) = ::which::which("adb") {
        return Ok(adb);
    }
    for loc in probable_sdk_locs()? {
        let adb = loc.join("platform-tools/adb");
        if try_out(&adb) {
            return Ok(adb.into());
        }
    }
    bail!("Adb could be found")
}

fn find_non_legacy_ndk(sdk: &path::Path) -> Result<Option<path::PathBuf>> {
    let ndk_root = sdk.join("ndk");
    if !ndk_root.is_dir() {
        return Ok(None);
    }
    let ndk = fs::read_dir(ndk_root)?
        .filter_map(Result::ok)
        .filter_map(|directory| {
            directory
                .path()
                .file_name()
                .and_then(|name| {
                    let name = name.to_string_lossy();
                    // Filter out directory if we fail to parse directory name to semver
                    semver::Version::parse(&name).ok()
                })
                .map(|version| (directory, version))
        })
        .max_by(|left, right| {
            let left_version: &semver::Version = &left.1;
            let right_version: &semver::Version = &right.1;
            left_version.cmp(right_version)
        })
        .map(|tuple| tuple.0.path());
    Ok(ndk)
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn test_find_non_legacy_ndk() {
        let sdk_dir = tempfile::tempdir().unwrap();
        let sdk = sdk_dir.path();
        let ndk_root = sdk.join("ndk");
        let ndk_versions = ["21.1.123456", "21.3.6528147", "20.1.5948944"];
        for version in &ndk_versions {
            let path = ndk_root.join(version);
            fs::create_dir_all(path).unwrap();
        }

        let ndk = find_non_legacy_ndk(sdk).unwrap();

        let expected = ndk_root.join("21.3.6528147");
        assert_eq!(Some(expected), ndk);
    }

    #[test]
    fn test_find_non_legacy_ndk_on_non_existing_directory() {
        let sdk = tempfile::tempdir().unwrap();

        let ndk = find_non_legacy_ndk(sdk.path()).unwrap();

        assert_eq!(None, ndk);
    }
}