rpfm_ipc/

helpers.rs

//---------------------------------------------------------------------------//
// Copyright (c) 2017-2026 I&smael Gutiérrez González. All rights reserved.
//
// This file is part of the Rusted PackFile Manager (RPFM) project,
// which can be found here: https://github.com/Frodo45127/rpfm.
//
// This file is licensed under the MIT license, which can be found here:
// https://github.com/Frodo45127/rpfm/blob/master/LICENSE.
//---------------------------------------------------------------------------//

//! # IPC Helpers Module
//!
//! This module provides helper data structures for marshalling complex data between the UI and server.
//! These types serve as lightweight, serializable representations of core library types, designed
//! specifically for IPC transfer.
//!
//! ## Key Types
//!
//! ### Container Information
//!
//! - [`ContainerInfo`]: A reduced representation of a PackFile, containing only the metadata needed
//!   by the UI (file name, path, version, type, compression settings).
//!
//! ### File Information
//!
//! - [`RFileInfo`]: Metadata about a packed file within a container (path, container name, timestamp,
//!   file type). Used extensively in tree views and file listings.
//! - [`VideoInfo`]: Metadata specific to video files (format, dimensions, framerate, etc.).
//!
//! ### Dependencies
//!
//! - [`DependenciesInfo`]: Contains paths to all dependency files (AssKit tables, vanilla files,
//!   parent mod files) for populating dependency tree views.
//!
//! ### Data Sources
//!
//! - [`DataSource`]: Discriminates where data comes from (current PackFile, game files, parent mods,
//!   AssKit files, or external files). Used throughout the UI to track file origins.
//!
//! ### File Creation
//!
//! - [`NewFile`]: Enum containing the parameters needed to create new files of various types
//!   (AnimPack, DB table, Loc file, etc.).
//!
//! ### API Responses
//!
//! - [`APIResponse`]: Represents update check results (new update available, no update, etc.).
//!
//! ## Design Notes
//!
//! These types are intentionally simple and focus on data transfer rather than business logic.
//! They use `#[derive(Serialize, Deserialize)]` for JSON serialization over WebSocket, and
//! `#[derive(Getters)]` for convenient read-only access to fields.

use getset::Getters;
use rayon::prelude::*;
use schemars::JsonSchema;
use serde_derive::{Serialize, Deserialize};

use std::collections::BTreeMap;
use std::fmt::{self, Display};

use rpfm_extensions::dependencies::Dependencies;
use rpfm_extensions::search::{GlobalSearch, SearchSource};

use rpfm_lib::compression::CompressionFormat;
use rpfm_lib::games::{*, pfh_file_type::PFHFileType, pfh_version::PFHVersion};
use rpfm_lib::files::{animpack::*, Container, ContainerPath, db::*, FileType, pack::*, RFile, text::TextFormat, video::*};

//-------------------------------------------------------------------------------//
//                              Enums & Structs
//-------------------------------------------------------------------------------//

/// This struct is a reduced version of the `PackFile` one, used to pass just the needed data to an UI.
///
/// Don't create this one manually. Get it `From` the `PackFile` one, and use it as you need it.
#[derive(Clone, Debug, Default, Getters, Serialize, Deserialize)]
#[getset(get = "pub")]
pub struct ContainerInfo {

    /// The name of the PackFile's file, if exists. If not, then this should be empty.
    file_name: String,

    /// The path of the PackFile on disk, if exists. If not, then this should be empty.
    file_path: String,

    /// The version of the PackFile.
    pfh_version: PFHVersion,

    /// The type of the PackFile.
    pfh_file_type: PFHFileType,

    /// The bitmasks applied to the PackFile.
    bitmask: PFHFlags,

    /// If the container needs to be compress on save. None for no compression.
    compress: CompressionFormat,

    /// The timestamp of the last time the PackFile was saved.
    timestamp: u64,
}

/// This struct represents the detailed info about the `PackedFile` we can provide to whoever request it.
#[derive(Clone, Debug, Default, Getters, Serialize, Deserialize)]
#[getset(get = "pub")]
pub struct RFileInfo {

    /// This is the path of the `PackedFile`.
    path: String,

    /// This is the name of the `Container` this file belongs to.
    container_name: Option<String>,

    /// This is the ***Last Modified*** time.
    timestamp: Option<u64>,

    file_type: FileType,

    // If the `PackedFile` is compressed or not.
    //is_compressed: bool,

    // If the `PackedFile` is encrypted or not.
    //is_encrypted: bool,

    // If the `PackedFile` has been cached or not.
    //is_cached: bool,

    // The type of the cached `PackedFile`.
    //cached_type: String,
}

/// This struct represents the detailed info about the `PackedFile` we can provide to whoever request it.
#[derive(Clone, Debug, Default, Getters, Serialize, Deserialize)]
#[getset(get = "pub")]
pub struct VideoInfo {

    /// Format of the video file
    format: SupportedFormats,

    /// Version number.
    version: u16,

    /// Codec FourCC (usually 'VP80').
    codec_four_cc: String,

    /// Width of the video in pixels.
    width: u16,

    /// Height of the video in pixels.
    height: u16,

    /// Number of frames on the video.
    num_frames: u32,

    /// Framerate of the video.
    framerate: f32,
}

/// This struct contains the minimal data needed (mainly paths), to know what we have loaded in out dependencies.
///
/// NOTE: As this is intended to be a "Just use it and discard it" struct, we allow public members to make operations
/// where we can move out of here faster.
#[derive(Debug, Clone, Default, Getters, Serialize, Deserialize)]
#[getset(get = "pub")]
pub struct DependenciesInfo {

    /// Full PackedFile-like paths of each asskit-only table.
    pub asskit_tables: Vec<RFileInfo>,

    /// Full list of vanilla PackedFile paths.
    pub vanilla_packed_files: Vec<RFileInfo>,

    /// Full list of parent PackedFile paths.
    pub parent_packed_files: Vec<RFileInfo>,
}

/// This enum represents the source of the data in the view.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy, Ord, PartialOrd, JsonSchema, Serialize, Deserialize)]
pub enum DataSource {

    /// This means the data is from somewhere in our PackFile.
    PackFile,

    /// This means the data is from one of the game files.
    GameFiles,

    /// This means the data comes from a parent PackFile.
    ParentFiles,

    /// This means the data comes from the AssKit files.
    AssKitFiles,

    /// This means the data comes from an external file.
    ExternalFile,
}

/// This enum contains the data needed to create a new PackedFile.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum NewFile {

    /// Name of the file.
    AnimPack(String),

    /// Name of the file, Name of the Table, Version of the Table.
    DB(String, String, i32),

    /// Name of the Table.
    Loc(String),

    /// Name of the file, version of the file, and a list of entries that must be cloned from existing values in vanilla files (from, to).
    PortraitSettings(String, u32, Vec<(String, String)>),

    /// Name of the file and its format.
    Text(String, TextFormat),

    /// Name of the file.
    VMD(String),

    /// Name of the file.
    WSModel(String),
}

/// This enum controls the possible responses from the server when checking for an update.
#[derive(Debug, PartialEq, Eq, serde_derive::Serialize, serde_derive::Deserialize)]
pub enum APIResponse {

    /// This means a beta update was found.
    NewBetaUpdate(String),

    /// This means a major stable update was found.
    NewStableUpdate(String),

    /// This means a minor stable update was found.
    NewUpdateHotfix(String),

    /// This means no update was found.
    NoUpdate,

    /// This means don't know if there was an update or not, because the version we got was invalid.
    UnknownVersion,
}

/// Information about an active session on the server.
///
/// This struct provides a snapshot of a session's state, including connection count
/// and timeout information. It's used by the session management dialog to display
/// available sessions and allow users to connect to specific ones.
#[derive(Clone, Debug, Default, Getters, Serialize, Deserialize)]
#[getset(get = "pub")]
pub struct SessionInfo {

    /// Unique identifier for the session.
    session_id: u64,

    /// Number of active connections to this session.
    connection_count: u32,

    /// Seconds remaining until session timeout (None if session has active connections).
    timeout_remaining_secs: Option<u64>,

    /// Whether the session has been marked for shutdown.
    is_shutting_down: bool,

    /// Names of the pack files currently open in this session.
    pack_names: Vec<String>,
}

//-------------------------------------------------------------------------------//
//                             Implementations
//-------------------------------------------------------------------------------//

impl From<&Pack> for ContainerInfo {
    fn from(pack: &Pack) -> Self {

        // If we have no disk file for the pack, it's a new one.
        let file_name = if pack.disk_file_path().is_empty() {
            "new_file.pack"
        } else {
            pack.disk_file_path().split('/').next_back().unwrap_or("unknown.pack")
        };

        Self {
            file_name: file_name.to_string(),
            file_path: pack.disk_file_path().to_string(),
            pfh_version: *pack.header().pfh_version(),
            pfh_file_type: *pack.header().pfh_file_type(),
            bitmask: *pack.header().bitmask(),
            timestamp: *pack.header().internal_timestamp(),
            compress: pack.compression_format(),
        }
    }
}

/// NOTE: DO NOT USE THIS FOR ANIMPACKS WITHIN PACKS.
///
/// It sets the path and name wrong in those cases.
impl From<&AnimPack> for ContainerInfo {
    fn from(animpack: &AnimPack) -> Self {
        Self {
            file_name: animpack.disk_file_path().split('/').next_back().unwrap_or("unknown.animpack").to_string(),
            file_path: animpack.disk_file_path().to_string(),
            ..Default::default()
        }
    }
}

/// Creates a [`ContainerInfo`] from an [`RFileInfo`].
///
/// This is used when treating an individual file as if it were a container (e.g., for AnimPacks
/// stored within a Pack). Most fields default to their default values since a single file
/// doesn't have pack-level metadata.
impl From<&RFileInfo> for ContainerInfo {
    fn from(file_info: &RFileInfo) -> Self {
        Self {
            file_name: ContainerPath::File(file_info.path().to_owned()).name().unwrap_or("unknown").to_string(),
            file_path: file_info.path().to_owned(),
            ..Default::default()
        }
    }
}

/// Creates an [`RFileInfo`] from an [`RFile`].
///
/// Extracts the path, container name, timestamp, and file type from the packed file.
/// This is the primary way to create file info for display in the UI.
impl From<&RFile> for RFileInfo {
    fn from(rfile: &RFile) -> Self {
        //let is_cached = !matches!(rfile.get_ref_decoded(), DecodedPackedFile::Unknown);
        //let cached_type = if let DecodedPackedFile::Unknown = rfile.get_ref_decoded() { "Not Yet Cached".to_owned() }
        //else { format!("{:?}", PackedFileType::from(rfile.get_ref_decoded())) };
        Self {
            path: rfile.path_in_container_raw().to_owned(),
            container_name: rfile.container_name().clone(),
            timestamp: rfile.timestamp(),
            file_type: rfile.file_type(),
            //is_compressed: rfile.get_ref_raw().get_compression_state(),
            //is_encrypted: rfile.get_ref_raw().get_encryption_state(),
            //is_cached,
            //cached_type,
        }
    }
}

/// Creates a [`VideoInfo`] from a [`Video`].
///
/// Extracts all video metadata (format, codec, dimensions, frame count, framerate) for display
/// in the UI's video viewer.
impl From<&Video> for VideoInfo {
    fn from(video: &Video) -> Self {
        Self {
            format: *video.format(),
            version: *video.version(),
            codec_four_cc: video.codec_four_cc().to_string(),
            width: *video.width(),
            height: *video.height(),
            num_frames: *video.num_frames(),
            framerate: *video.framerate(),
        }
    }
}

impl DependenciesInfo {
    pub fn new(dependencies: &Dependencies, table_name_logic: &VanillaDBTableNameLogic) -> Self {
        let asskit_tables = dependencies.asskit_only_db_tables().values().map(|table| {
            let table_name = match table_name_logic {
                VanillaDBTableNameLogic::DefaultName(ref name) => name,
                VanillaDBTableNameLogic::FolderName => table.table_name(),
            };

            RFileInfo::from_db(table, table_name)
        }).collect::<Vec<RFileInfo>>();

        let vanilla_packed_files = dependencies.vanilla_loose_files()
            .par_iter()
            .chain(dependencies.vanilla_files().par_iter())
            .map(|(_, value)| From::from(value))
            .collect::<Vec<RFileInfo>>();

        let parent_packed_files = dependencies.parent_files()
            .par_iter()
            .map(|(_, value)| From::from(value))
            .collect::<Vec<RFileInfo>>();

        Self {
            asskit_tables,
            vanilla_packed_files,
            parent_packed_files,
        }
    }
}

impl RFileInfo {

    /// This function returns the PackedFileInfo for all the PackedFiles the current search has searched on.
    pub fn info_from_global_search(global_search: &GlobalSearch, packs: &BTreeMap<String, Pack>) -> Vec<Self> {
        let types = global_search.search_on().types_to_search();

        // Only return info of stuff on the local Packs.
        if global_search.sources().iter().any(|s| matches!(s, SearchSource::Pack(_))) {
            packs.values().flat_map(|pack| pack.files_by_type(&types).iter().map(|x| From::from(*x)).collect::<Vec<_>>()).collect()
        } else {
            vec![]
        }
    }

    /// Returns the table name for DB files.
    ///
    /// For DB files, the path format is `db/<table_name>/<file_name>`, so this extracts
    /// the second path component. Returns `None` if the file is not a DB file or if
    /// the path doesn't have the expected structure.
    pub fn table_name(&self) -> Option<&str> {
        if self.file_type == FileType::DB {
            self.path().split('/').collect::<Vec<_>>().get(1).cloned()
        } else {
            None
        }
    }

    /// Creates an [`RFileInfo`] from a [`DB`] table and its file name.
    ///
    /// This is used to create file info for AssKit-only tables that don't have a backing
    /// [`RFile`]. The path is constructed as `db/<table_name>/<table_file_name>`.
    pub fn from_db(db: &DB, table_file_name: &str) -> Self {
        Self {
            path: format!("db/{}/{}", db.table_name(), table_file_name),
            container_name: None,
            timestamp: None,
            file_type: FileType::DB,
        }
    }
}

/// Displays the [`DataSource`] as a human-readable string.
///
/// Used for logging and UI display purposes.
impl Display for DataSource {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        Display::fmt(match self {
            Self::PackFile => "PackFile",
            Self::GameFiles => "GameFiles",
            Self::ParentFiles => "ParentFiles",
            Self::AssKitFiles => "AssKitFiles",
            Self::ExternalFile => "ExternalFile",
        }, f)
    }
}

/// Parses a [`DataSource`] from its string representation.
///
/// This is the inverse of the [`Display`] implementation. Panics if the string doesn't match
/// any known data source.
impl From<&str> for DataSource {
    fn from(value: &str) -> Self {
        match value {
            "PackFile" => Self::PackFile,
            "GameFiles" => Self::GameFiles,
            "ParentFiles" => Self::ParentFiles,
            "AssKitFiles" => Self::AssKitFiles,
            "ExternalFile" => Self::ExternalFile,
            _ => unreachable!("from data source {}", value)
        }
    }
}

impl SessionInfo {

    /// Create a new SessionInfo with the given parameters.
    pub fn new(
        session_id: u64,
        connection_count: u32,
        timeout_remaining_secs: Option<u64>,
        is_shutting_down: bool,
        pack_names: Vec<String>,
    ) -> Self {
        Self {
            session_id,
            connection_count,
            timeout_remaining_secs,
            is_shutting_down,
            pack_names,
        }
    }
}