tauri_plugin/build/

mobile.rs

// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

//! Mobile-specific build utilities.

use std::{
  fs::{copy, create_dir, create_dir_all, remove_dir_all},
  path::{Path, PathBuf},
};

use anyhow::{Context, Result};

use super::{build_var, cfg_alias};

/// Patches the entitlements file of the iOS project of the application that depends on this
/// plugin, so the plugin can request the capabilities its native code needs
/// (push notifications, app groups, HealthKit, iCloud...).
///
/// It edits `<project>/<app-name>_iOS/<app-name>_iOS.entitlements` of the Xcode project
/// generated by `tauri ios init`, reading its path from the `TAURI_IOS_PROJECT_PATH` and
/// `TAURI_IOS_APP_NAME` environment variables set by the Tauri CLI. It is a no-op when they are
/// not set (a plain `cargo build`, or a desktop build) or when the file does not exist, and the
/// file is only written when the closure actually changed it.
///
/// Must be called from the plugin `build.rs`, ideally guarded by a
/// [`plugin_config`](super::plugin_config) value so the app can opt in to the entitlement.
/// Only available on macOS hosts, where the iOS project can be built.
///
/// # Examples
///
/// ```rust,no_run
/// tauri_plugin::mobile::update_entitlements(|entitlements| {
///   entitlements.insert("aps-environment".into(), "development".into());
/// })
/// .expect("failed to update entitlements");
/// ```
#[cfg(target_os = "macos")]
pub fn update_entitlements<F: FnOnce(&mut plist::Dictionary)>(f: F) -> Result<()> {
  if let (Some(project_path), Ok(app_name)) = (
    std::env::var_os("TAURI_IOS_PROJECT_PATH").map(PathBuf::from),
    std::env::var("TAURI_IOS_APP_NAME"),
  ) {
    update_plist_file(
      project_path
        .join(format!("{app_name}_iOS"))
        .join(format!("{app_name}_iOS.entitlements")),
      f,
    )?;
  }

  Ok(())
}

/// Patches the `Info.plist` of the iOS project of the application that depends on this plugin,
/// which is where iOS expects the usage descriptions, URL schemes and background modes a
/// plugin needs to be declared.
///
/// It edits `<project>/<app-name>_iOS/Info.plist` of the Xcode project generated by
/// `tauri ios init`, reading its path from the `TAURI_IOS_PROJECT_PATH` and
/// `TAURI_IOS_APP_NAME` environment variables set by the Tauri CLI. It is a no-op when they are
/// not set (a plain `cargo build`, or a desktop build) or when the file does not exist, and the
/// file is only written when the closure actually changed it.
///
/// Must be called from the plugin `build.rs`. Values that are specific to the application, such
/// as the text shown on a permission prompt, should be read from the plugin configuration with
/// [`plugin_config`](super::plugin_config) instead of hardcoded.
/// Only available on macOS hosts, where the iOS project can be built.
///
/// # Examples
///
/// ```rust,no_run
/// tauri_plugin::mobile::update_info_plist(|plist| {
///   plist.insert(
///     "NSCameraUsageDescription".into(),
///     "This app needs the camera to scan QR codes".into(),
///   );
/// })
/// .expect("failed to update Info.plist");
/// ```
#[cfg(target_os = "macos")]
pub fn update_info_plist<F: FnOnce(&mut plist::Dictionary)>(f: F) -> Result<()> {
  if let (Some(project_path), Ok(app_name)) = (
    std::env::var_os("TAURI_IOS_PROJECT_PATH").map(PathBuf::from),
    std::env::var("TAURI_IOS_APP_NAME"),
  ) {
    update_plist_file(
      project_path
        .join(format!("{app_name}_iOS"))
        .join("Info.plist"),
      f,
    )?;
  }

  Ok(())
}

/// Updates the Android manifest by inserting XML content into a specified parent tag.
pub fn update_android_manifest(block_identifier: &str, parent: &str, insert: String) -> Result<()> {
  tauri_utils::build::update_android_manifest(block_identifier, parent, insert)
}

pub(crate) fn setup(
  android_path: Option<PathBuf>,
  #[allow(unused_variables)] ios_path: Option<PathBuf>,
) -> Result<()> {
  let target_os = build_var("CARGO_CFG_TARGET_OS")?;
  let mobile = target_os == "android" || target_os == "ios";
  cfg_alias("mobile", mobile);
  cfg_alias("desktop", !mobile);

  match target_os.as_str() {
    "android" => {
      if let Some(path) = android_path {
        let manifest_dir = build_var("CARGO_MANIFEST_DIR").map(PathBuf::from)?;
        let source = manifest_dir.join(path);

        let tauri_library_path = std::env::var("DEP_TAURI_ANDROID_LIBRARY_PATH")
            .expect("missing `DEP_TAURI_ANDROID_LIBRARY_PATH` environment variable. Make sure `tauri` is a dependency of the plugin.");
        println!("cargo:rerun-if-env-changed=DEP_TAURI_ANDROID_LIBRARY_PATH");

        create_dir_all(source.join(".tauri")).context("failed to create .tauri directory")?;
        copy_folder(
          Path::new(&tauri_library_path),
          &source.join(".tauri").join("tauri-api"),
          &[],
        )
        .context("failed to copy tauri-api to the plugin project")?;

        println!("cargo:android_library_path={}", source.display());
      }
    }
    #[cfg(target_os = "macos")]
    "ios" => {
      if let Some(path) = ios_path {
        let manifest_dir = std::env::var("CARGO_MANIFEST_DIR")
          .map(PathBuf::from)
          .unwrap();
        let tauri_library_path = std::env::var("DEP_TAURI_IOS_LIBRARY_PATH")
            .expect("missing `DEP_TAURI_IOS_LIBRARY_PATH` environment variable. Make sure `tauri` is a dependency of the plugin.");

        let tauri_dep_path = path.parent().unwrap().join(".tauri");
        create_dir_all(&tauri_dep_path).context("failed to create .tauri directory")?;
        copy_folder(
          Path::new(&tauri_library_path),
          &tauri_dep_path.join("tauri-api"),
          &[".build", "Package.resolved", "Tests"],
        )
        .context("failed to copy tauri-api to the plugin project")?;
        tauri_utils::build::link_apple_library(
          &std::env::var("CARGO_PKG_NAME").unwrap(),
          manifest_dir.join(path),
        );
      }
    }
    _ => (),
  }

  Ok(())
}

fn copy_folder(source: &Path, target: &Path, ignore_paths: &[&str]) -> Result<()> {
  let _ = remove_dir_all(target);

  for entry in walkdir::WalkDir::new(source) {
    let entry = entry?;
    let rel_path = entry.path().strip_prefix(source)?;
    let rel_path_str = rel_path.to_string_lossy();
    if ignore_paths
      .iter()
      .any(|path| rel_path_str.starts_with(path))
    {
      continue;
    }
    let dest_path = target.join(rel_path);

    if entry.file_type().is_dir() {
      create_dir(&dest_path)
        .with_context(|| format!("failed to create directory {}", dest_path.display()))?;
    } else {
      copy(entry.path(), &dest_path).with_context(|| {
        format!(
          "failed to copy {} to {}",
          entry.path().display(),
          dest_path.display()
        )
      })?;
      println!("cargo:rerun-if-changed={}", entry.path().display());
    }
  }

  Ok(())
}

#[cfg(target_os = "macos")]
fn update_plist_file<P: AsRef<Path>, F: FnOnce(&mut plist::Dictionary)>(
  path: P,
  f: F,
) -> Result<()> {
  use std::io::Cursor;

  let path = path.as_ref();
  if path.exists() {
    let plist_str = std::fs::read_to_string(path)?;
    let mut plist = plist::Value::from_reader(Cursor::new(&plist_str))?;
    if let Some(dict) = plist.as_dictionary_mut() {
      f(dict);
      let mut plist_buf = Vec::new();
      let writer = Cursor::new(&mut plist_buf);
      plist::to_writer_xml(writer, &plist)?;
      let new_plist_str = String::from_utf8(plist_buf)?;
      if new_plist_str != plist_str {
        std::fs::write(path, new_plist_str)?;
      }
    }
  }

  Ok(())
}

#[cfg(test)]
mod tests {
  #[test]
  fn update_android_manifest() {
    use tauri_utils::build::update_android_manifest;

    // This test would require setting up the environment, so we just verify it compiles
    // The actual implementation is tested in tauri-utils
    let _result = update_android_manifest("test", "activity", "<test></test>".to_string());
  }
}