drop-app/src-tauri/src/downloads/download_agent.rs

use crate::auth::generate_authorization_header;
use crate::db::DatabaseImpls;
use crate::downloads::manifest::{DropDownloadContext, DropManifest};
use crate::remote::RemoteAccessError;
use crate::DB;
use log::{debug, error, info};
use rayon::ThreadPoolBuilder;
use std::fmt::{Display, Formatter};
use std::fs::{create_dir_all, File};
use std::io;
use std::path::Path;
use std::sync::mpsc::Sender;
use std::sync::{Arc, Mutex};
use urlencoding::encode;

#[cfg(target_os = "linux")]
use rustix::fs::{fallocate, FallocateFlags};

use super::download_logic::download_game_chunk;
use super::download_manager::DownloadManagerSignal;
use super::download_thread_control_flag::{DownloadThreadControl, DownloadThreadControlFlag};
use super::progress_object::ProgressObject;

pub struct GameDownloadAgent {
    pub id: String,
    pub version: String,
    pub control_flag: DownloadThreadControl,
    pub target_download_dir: usize,
    contexts: Mutex<Vec<DropDownloadContext>>,
    pub manifest: Mutex<Option<DropManifest>>,
    pub progress: ProgressObject,
    sender: Sender<DownloadManagerSignal>,
}

#[derive(Debug)]
pub enum GameDownloadError {
    Communication(RemoteAccessError),
    Checksum,
    Setup(SetupError),
    Lock,
    IoError(io::Error),
    DownloadError,
}

#[derive(Debug)]
pub enum SetupError {
    Context,
}

impl Display for GameDownloadError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            GameDownloadError::Communication(error) => write!(f, "{}", error),
            GameDownloadError::Setup(error) => write!(f, "{:?}", error),
            GameDownloadError::Lock => write!(f, "Failed to acquire lock. Something has gone very wrong internally. Please restart the application"),
            GameDownloadError::Checksum => write!(f, "Checksum failed to validate for download"),
            GameDownloadError::IoError(error) => write!(f, "{}", error),
            GameDownloadError::DownloadError => write!(f, "Download failed. See Download Manager status for specific error"),
        }
    }
}

impl GameDownloadAgent {
    pub fn new(
        id: String,
        version: String,
        target_download_dir: usize,
        sender: Sender<DownloadManagerSignal>,
    ) -> Self {
        // Don't run by default
        let control_flag = DownloadThreadControl::new(DownloadThreadControlFlag::Stop);
        Self {
            id,
            version,
            control_flag,
            manifest: Mutex::new(None),
            target_download_dir,
            contexts: Mutex::new(Vec::new()),
            progress: ProgressObject::new(0, 0),
            sender,
        }
    }

    // Blocking
    pub fn setup_download(&self) -> Result<(), GameDownloadError> {
        self.ensure_manifest_exists()?;
        info!("Ensured manifest exists");

        self.ensure_contexts()?;
        info!("Ensured contexts exists");

        self.control_flag.set(DownloadThreadControlFlag::Go);

        Ok(())
    }

    // Blocking
    pub fn download(&self) -> Result<(), GameDownloadError> {
        self.setup_download()?;
        self.set_progress_object_params();
        self.run().map_err(|_| GameDownloadError::DownloadError)?;

        Ok(())
    }

    pub fn ensure_manifest_exists(&self) -> Result<(), GameDownloadError> {
        if self.manifest.lock().unwrap().is_some() {
            return Ok(());
        }

        self.download_manifest()
    }

    fn download_manifest(&self) -> Result<(), GameDownloadError> {
        let base_url = DB.fetch_base_url();
        let manifest_url = base_url
            .join(
                format!(
                    "/api/v1/client/metadata/manifest?id={}&version={}",
                    self.id,
                    encode(&self.version)
                )
                .as_str(),
            )
            .unwrap();

        let header = generate_authorization_header();
        let client = reqwest::blocking::Client::new();
        let response = client
            .get(manifest_url.to_string())
            .header("Authorization", header)
            .send()
            .unwrap();

        if response.status() != 200 {
            return Err(GameDownloadError::Communication(
                RemoteAccessError::ManifestDownloadFailed(
                    response.status(),
                    response.text().unwrap(),
                ),
            ));
        }

        let manifest_download = response.json::<DropManifest>().unwrap();

        if let Ok(mut manifest) = self.manifest.lock() {
            *manifest = Some(manifest_download);
            return Ok(());
        }

        Err(GameDownloadError::Lock)
    }

    fn set_progress_object_params(&self) {
        // Avoid re-setting it
        if self.progress.get_max() != 0 {
            return;
        }

        let lock = self.contexts.lock().unwrap();
        let length = lock.len();

        let chunk_count = lock.iter().map(|chunk| chunk.length).sum();

        debug!("Setting ProgressObject max to {}", chunk_count);
        self.progress.set_max(chunk_count);
        debug!("Setting ProgressObject size to {}", length);
        self.progress.set_size(length);
        debug!("Setting ProgressObject time to now");
        self.progress.set_time_now();
    }

    pub fn ensure_contexts(&self) -> Result<(), GameDownloadError> {
        let context_lock = self.contexts.lock().unwrap();
        if !context_lock.is_empty() {
            return Ok(());
        }
        drop(context_lock);

        self.generate_contexts()?;
        return Ok(());
    }

    pub fn generate_contexts(&self) -> Result<(), GameDownloadError> {
        let db_lock = DB.borrow_data().unwrap();
        let data_base_dir = db_lock.games.install_dirs[self.target_download_dir].clone();
        drop(db_lock);

        let manifest = self.manifest.lock().unwrap().clone().unwrap();
        let game_id = self.id.clone();

        let data_base_dir_path = Path::new(&data_base_dir);

        let mut contexts = Vec::new();
        let base_path = data_base_dir_path.join(game_id.clone()).clone();
        create_dir_all(base_path.clone()).unwrap();

        for (raw_path, chunk) in manifest {
            let path = base_path.join(Path::new(&raw_path));

            let container = path.parent().unwrap();
            create_dir_all(container).unwrap();

            let file = File::create(path.clone()).unwrap();
            let mut running_offset = 0;

            for (i, length) in chunk.lengths.iter().enumerate() {
                contexts.push(DropDownloadContext {
                    file_name: raw_path.to_string(),
                    version: chunk.versionName.to_string(),
                    offset: running_offset,
                    index: i,
                    game_id: game_id.to_string(),
                    path: path.clone(),
                    checksum: chunk.checksums[i].clone(),
                    length: *length,
                });
                running_offset += *length as u64;
            }

            #[cfg(target_os = "linux")]
            if running_offset > 0 {
                let _ = fallocate(file, FallocateFlags::empty(), 0, running_offset);
            }
        }

        if let Ok(mut context_lock) = self.contexts.lock() {
            *context_lock = contexts;
            return Ok(());
        }

        Err(GameDownloadError::Setup(SetupError::Context))
    }

    pub fn run(&self) -> Result<(), ()> {
        info!("downloading game: {}", self.id);
        const DOWNLOAD_MAX_THREADS: usize = 4;

        let pool = ThreadPoolBuilder::new()
            .num_threads(DOWNLOAD_MAX_THREADS)
            .build()
            .unwrap();

        let completed_indexes = Arc::new(Mutex::new(Vec::new()));
        let completed_indexes_loop_arc = completed_indexes.clone();

        pool.scope(move |scope| {
            let contexts = self.contexts.lock().unwrap();

            for (index, context) in contexts.iter().enumerate() {
                let context = context.clone();
                let control_flag = self.control_flag.clone(); // Clone arcs
                let progress = self.progress.get(index); // Clone arcs
                let completed_indexes_ref = completed_indexes_loop_arc.clone();

                scope.spawn(move |_| {
                    match download_game_chunk(context.clone(), control_flag, progress) {
                        Ok(res) => match res {
                            true => {
                                let mut lock = completed_indexes_ref.lock().unwrap();
                                lock.push(index);
                            }
                            false => {}
                        },
                        Err(e) => {
                            error!("GameDownloadError: {}", e);
                            self.sender.send(DownloadManagerSignal::Error(e)).unwrap();
                        }
                    }
                });
            }
        });

        let mut context_lock = self.contexts.lock().unwrap();
        let mut completed_lock = completed_indexes.lock().unwrap();

        // Sort desc so we don't have to modify indexes
        completed_lock.sort_by(|a, b| b.cmp(a));

        for index in completed_lock.iter() {
            context_lock.remove(*index);
        }

        // If we're not out of contexts, we're not done, so we don't fire completed
        if !context_lock.is_empty() {
            info!("Download agent didn't finish, not sending completed signal");
            return Ok(());
        }

        // We've completed
        self.sender
            .send(DownloadManagerSignal::Completed(self.id.clone()))
            .unwrap();

        Ok(())
    }
}