modde_sources/nexus/

install.rs

//! Reusable single-mod install pipeline.
//!
//! Shared between `modde-cli`'s `install mod` command and the
//! `modde-ui` **Browse Nexus → Install** button. The caller is
//! responsible for:
//!
//! * Loading / creating the target profile and wiring the returned
//!   [`InstallOutcome`] back into it.
//! * Supplying an [`InstallProbe`] — this crate intentionally does not
//!   depend on `modde-games`, so the probe has to come from the edge
//!   (CLI / UI) where `modde_games::resolve_game_plugin` is available.
//!
//! This module does the download + extraction + analysis + execution,
//! and writes the skill dossier when detection fails.

use std::path::{Path, PathBuf};

use anyhow::{Context, Result};
use reqwest::Client;

use modde_core::installer::{
    self, DossierContext, InstallMethod, InstallPlan, InstallProbe, InstallerError, ProbeTrace,
};
use modde_core::paths;
use modde_core::{NexusFileId, NexusModId};

use super::api::NexusMod;
use super::cdn::generate_download_link;

/// Result of the install pipeline, mirroring `modde_cli::install::InstallOutcome`.
///
/// The caller decides how to persist each variant:
/// * `Installed` → `ModdeDb::record_install(..., InstallStatus::Installed)`
/// * `PendingUserInput` → row with `install_status = 'pending_user_input'`,
///    route the UI to a wizard
/// * `Unknown` → row with `install_status = 'unknown'`, surface the dossier
/// * `AlreadyStaged` → store dir already exists, skip download
pub enum InstallOutcome {
    Installed(InstallPlan),
    PendingUserInput {
        method: &'static str,
    },
    Unknown {
        dossier_path: PathBuf,
        method: InstallMethod,
    },
    AlreadyStaged,
}

/// Run the single-mod install pipeline end-to-end.
///
/// `client` and `api_key` are used for the CDN download only —
/// callers that want richer metadata for the dossier can pass in a
/// `mod_info` fetched separately. `probe` should come from
/// `modde_games::game_probe(plugin)` for the game this mod belongs to,
/// or [`InstallProbe::noop`] if the game isn't registered.
pub async fn install_single_mod(
    client: &Client,
    api_key: &str,
    game_domain: &str,
    mod_id: NexusModId,
    file_id: NexusFileId,
    mod_info: &NexusMod,
    probe: &InstallProbe,
) -> Result<InstallOutcome> {
    let store = paths::store_dir();
    let mod_store_dir = store.join(format!("{game_domain}_{mod_id}_{file_id}"));
    if mod_store_dir.exists() {
        return Ok(InstallOutcome::AlreadyStaged);
    }

    // Temp staging dir — analyze runs on the raw tree before we move
    // files into the canonical store layout. See
    // `modde_cli::commands::install::handle_single_mod` for the mirror
    // of this flow (kept separate so the CLI can print progress while
    // the UI can drive it from a `Task::perform`).
    let staging_root =
        paths::staging_dir().join(format!("install_{game_domain}_{mod_id}_{file_id}"));

    std::fs::create_dir_all(store.as_path())?;
    std::fs::create_dir_all(paths::staging_dir().as_path())?;

    // 1. Download via the CDN endpoint. This is gated on Nexus Premium;
    //    the caller should have verified that before getting here.
    let download_url = generate_download_link(client, api_key, game_domain, mod_id, file_id)
        .await
        .context("failed to get Nexus download link")?;
    let archive_path = store.join(format!("{mod_id}_{file_id}.zip"));
    download_with_reqwest(client, &download_url, &archive_path)
        .await
        .context("failed to download mod archive")?;

    // 2. Extract into the staging dir (NOT the store).
    if staging_root.exists() {
        let _ = std::fs::remove_dir_all(&staging_root);
    }
    std::fs::create_dir_all(&staging_root)?;
    installer::extract_archive(&archive_path, &staging_root)
        .context("failed to extract mod archive")?;

    // 3. Hash the archive for the plan, then remove it.
    let source_hash =
        installer::xxh64_file_hex(&archive_path).context("failed to hash downloaded archive")?;
    let _ = std::fs::remove_file(&archive_path);

    // 4. Analyze.
    let mut plan = installer::analyze(&staging_root, probe, source_hash)
        .context("installer analyze failed")?;

    let outcome = match &plan.method {
        InstallMethod::Unknown { .. } => {
            let dossier = write_dossier(
                &staging_root,
                game_domain,
                mod_id,
                file_id,
                mod_info,
                &plan.method,
            )?;
            InstallOutcome::Unknown {
                dossier_path: dossier,
                method: plan.method.clone(),
            }
        }
        _ if !plan.method.is_ready() => {
            // FOMOD / BAIN with no config yet — copy the extracted tree
            // into the store so a wizard can run later without
            // re-downloading. The CLI and UI paths agree here: the store
            // is the wizard's working copy.
            std::fs::create_dir_all(&mod_store_dir)?;
            copy_dir_tree(&staging_root, &mod_store_dir)
                .context("failed to copy staging to store for pending install")?;
            // Leaky abstraction: `method` is a runtime enum so we can't
            // tie the PendingUserInput string literal to its label. We
            // only ever produce `fomod` or `bain` here, so match and
            // pick the right label.
            let label = match plan.method {
                InstallMethod::Fomod { .. } => "fomod",
                InstallMethod::Bain { .. } => "bain",
                _ => "unknown",
            };
            InstallOutcome::PendingUserInput { method: label }
        }
        _ => {
            std::fs::create_dir_all(&mod_store_dir)?;
            match installer::execute(&mut plan, &staging_root, &mod_store_dir) {
                Ok(_files) => InstallOutcome::Installed(plan),
                Err(InstallerError::UnknownMethod { reason: _ }) => {
                    let dossier = write_dossier(
                        &staging_root,
                        game_domain,
                        mod_id,
                        file_id,
                        mod_info,
                        &plan.method,
                    )?;
                    InstallOutcome::Unknown {
                        dossier_path: dossier,
                        method: plan.method.clone(),
                    }
                }
                Err(InstallerError::RequiresUserInput { method }) => {
                    InstallOutcome::PendingUserInput { method }
                }
                Err(e) => return Err(e.into()),
            }
        }
    };

    // Clean up staging now that we've either moved files into the
    // store or written a dossier.
    let _ = std::fs::remove_dir_all(&staging_root);
    Ok(outcome)
}

async fn download_with_reqwest(client: &Client, url: &str, dest: &Path) -> Result<()> {
    use tokio::io::AsyncWriteExt as _;

    let resp = crate::error::status_error(
        client
            .get(url)
            .send()
            .await
            .context("download GET failed")?,
    )
    .context("download HTTP error")?;
    let bytes = resp.bytes().await.context("failed to read download body")?;
    if let Some(parent) = dest.parent() {
        std::fs::create_dir_all(parent)?;
    }
    let mut file = tokio::fs::File::create(dest).await?;
    file.write_all(&bytes).await?;
    file.flush().await?;
    Ok(())
}

fn write_dossier(
    extracted_dir: &Path,
    game_domain: &str,
    mod_id: NexusModId,
    file_id: NexusFileId,
    mod_info: &NexusMod,
    method: &InstallMethod,
) -> Result<PathBuf> {
    let ctx = DossierContext {
        game_id: game_domain.to_string(),
        game_domain: Some(game_domain.to_string()),
        nexus_mod_id: Some(mod_id),
        nexus_file_id: Some(file_id),
        mod_name: mod_info.name.clone(),
        mod_author: Some(mod_info.author.clone()),
        mod_version: Some(mod_info.version.clone()),
        mod_summary: mod_info.summary.clone(),
        nexus_url: Some(format!(
            "https://www.nexusmods.com/{game_domain}/mods/{mod_id}"
        )),
        // Hash was already consumed by the caller — we don't store it
        // again here because the dossier context uses it for dedup,
        // not for integrity. Pass an empty string if we've lost it.
        source_archive_hash: String::new(),
    };
    let trace = vec![ProbeTrace {
        probe: "generic+game".to_string(),
        matched: false,
        note: format!("verdict: {}", method.label()),
    }];
    installer::dump_dossier(extracted_dir, &ctx, method, trace)
        .context("failed to write unknown-installer dossier")
}

fn copy_dir_tree(src: &Path, dst: &Path) -> std::io::Result<()> {
    if !src.exists() {
        return Ok(());
    }
    std::fs::create_dir_all(dst)?;
    for entry in std::fs::read_dir(src)? {
        let entry = entry?;
        let src_path = entry.path();
        let dst_path = dst.join(entry.file_name());
        if src_path.is_dir() {
            copy_dir_tree(&src_path, &dst_path)?;
        } else if src_path.is_file() {
            std::fs::copy(&src_path, &dst_path)?;
        }
    }
    Ok(())
}