cargo-bundle 0.10.0

// An iOS package is laid out like:
//
// Foobar.app         # Actually a directory
//     Foobar             # The main binary executable of the app
//     Info.plist         # An XML file containing the app's metadata
//     ...                # Icons and other resource files
//
// See https://developer.apple.com/go/?id=bundle-structure for a full
// explanation.

use super::common;
use crate::Settings;
use anyhow::Context;
use image::{self, GenericImageView};
use std::collections::BTreeSet;
use std::ffi::OsStr;
use std::fs::{self, File};
use std::io::Write;
use std::path::{Path, PathBuf};

pub fn bundle_project(settings: &Settings) -> crate::Result<Vec<PathBuf>> {
    common::print_warning("iOS bundle support is still experimental.")?;

    let app_bundle_name = format!("{}.app", settings.bundle_name());
    common::print_bundling(&app_bundle_name)?;
    let bundle_dir = settings
        .project_out_directory()
        .join("bundle/ios")
        .join(&app_bundle_name);
    if bundle_dir.exists() {
        fs::remove_dir_all(&bundle_dir)
            .with_context(|| format!("Failed to remove old {app_bundle_name}"))?;
    }
    fs::create_dir_all(&bundle_dir)
        .with_context(|| format!("Failed to create bundle directory at {bundle_dir:?}"))?;

    for src in settings.resource_files() {
        let src = src?;
        let dest = bundle_dir.join(common::resource_relpath(&src));
        common::copy_file(&src, &dest)
            .with_context(|| format!("Failed to copy resource file {src:?}"))?;
    }

    let icon_filenames =
        generate_icon_files(&bundle_dir, settings).with_context(|| "Failed to create app icons")?;
    generate_info_plist(&bundle_dir, settings, &icon_filenames)
        .with_context(|| "Failed to create Info.plist")?;
    let bin_path = bundle_dir.join(settings.binary_name());
    common::copy_file(settings.binary_path(), &bin_path)
        .with_context(|| format!("Failed to copy binary from {:?}", settings.binary_path()))?;
    Ok(vec![bundle_dir])
}

/// Generate the icon files and store them under the `bundle_dir`.
fn generate_icon_files(bundle_dir: &Path, settings: &Settings) -> crate::Result<Vec<String>> {
    let mut filenames = Vec::new();
    {
        let mut get_dest_path = |width: u32, height: u32, is_retina: bool| {
            let filename = format!(
                "icon_{}x{}{}.png",
                width,
                height,
                if is_retina { "@2x" } else { "" }
            );
            let path = bundle_dir.join(&filename);
            filenames.push(filename);
            path
        };
        let mut sizes = BTreeSet::new();
        // Prefer PNG files.
        for icon_path in settings.icon_files() {
            let icon_path = icon_path?;
            if icon_path.extension() != Some(OsStr::new("png")) {
                continue;
            }
            let img = image::ImageReader::open(&icon_path)?
                .with_guessed_format()?
                .decode()?;
            let (width, height) = img.dimensions();
            let is_retina = common::is_retina(&icon_path);
            if !sizes.contains(&(width, height, is_retina)) {
                sizes.insert((width, height, is_retina));
                let dest_path = get_dest_path(width, height, is_retina);
                common::copy_file(&icon_path, &dest_path)?;
            }
        }
        // Fall back to non-PNG files for any missing sizes.
        for icon_path in settings.icon_files() {
            let icon_path = icon_path?;
            if icon_path.extension() == Some(OsStr::new("png")) {
                continue;
            } else if icon_path.extension() == Some(OsStr::new("icns")) {
                let icon_family = icns::IconFamily::read(File::open(&icon_path)?)?;
                for icon_type in icon_family.available_icons() {
                    let width = icon_type.screen_width();
                    let height = icon_type.screen_height();
                    let is_retina = icon_type.pixel_density() > 1;
                    if !sizes.contains(&(width, height, is_retina)) {
                        sizes.insert((width, height, is_retina));
                        let dest_path = get_dest_path(width, height, is_retina);
                        let icon = icon_family.get_icon_with_type(icon_type)?;
                        icon.write_png(File::create(dest_path)?)?;
                    }
                }
            } else if icon_path.extension() == Some(OsStr::new("svg")) {
                // TODO: convert svg to appropriate format?
            } else {
                let icon = image::open(&icon_path)?;
                let (width, height) = icon.dimensions();
                let is_retina = common::is_retina(&icon_path);
                if !sizes.contains(&(width, height, is_retina)) {
                    sizes.insert((width, height, is_retina));
                    let dest_path = get_dest_path(width, height, is_retina);
                    let mut file = common::create_file(&dest_path)?;
                    icon.write_to(&mut file, image::ImageFormat::Png)?;
                }
            }
        }
    }
    Ok(filenames)
}

fn generate_info_plist(
    bundle_dir: &Path,
    settings: &Settings,
    icon_filenames: &Vec<String>,
) -> crate::Result<()> {
    let file = &mut common::create_file(&bundle_dir.join("Info.plist"))?;
    write!(
        file,
        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
            <!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \
            \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n\
            <plist version=\"1.0\">\n\
            <dict>\n"
    )?;

    write!(
        file,
        "  <key>CFBundleIdentifier</key>\n  <string>{}</string>\n",
        settings.bundle_identifier()
    )?;
    write!(
        file,
        "  <key>CFBundleDisplayName</key>\n  <string>{}</string>\n",
        settings.bundle_name()
    )?;
    write!(
        file,
        "  <key>CFBundleName</key>\n  <string>{}</string>\n",
        settings.bundle_name()
    )?;
    write!(
        file,
        "  <key>CFBundleExecutable</key>\n  <string>{}</string>\n",
        settings.binary_name()
    )?;
    write!(
        file,
        "  <key>CFBundleVersion</key>\n  <string>{}</string>\n",
        settings.version_string()
    )?;
    write!(
        file,
        "  <key>CFBundleShortVersionString</key>\n  <string>{}</string>\n",
        settings.version_string()
    )?;
    write!(
        file,
        "  <key>CFBundleDevelopmentRegion</key>\n  <string>en_US</string>\n"
    )?;
    write!(
        file,
        "  <key>UILaunchStoryboardName</key>\n  <string></string>\n"
    )?;

    if !icon_filenames.is_empty() {
        write!(file, "  <key>CFBundleIconFiles</key>\n  <array>\n")?;
        for filename in icon_filenames {
            writeln!(file, "    <string>{filename}</string>")?;
        }
        writeln!(file, "  </array>")?;
    }
    write!(file, "  <key>LSRequiresIPhoneOS</key>\n  <true/>\n")?;
    write!(file, "</dict>\n</plist>\n")?;
    file.flush()?;
    Ok(())
}