modio 0.13.0

//! Modfile interface
use std::ffi::OsStr;
use std::path::Path;

use mime::APPLICATION_OCTET_STREAM;
use serde::ser::{Serialize, SerializeMap, Serializer};
use tokio::io::AsyncRead;

use crate::file_source::FileSource;
use crate::prelude::*;
use crate::types::id::{FileId, GameId, ModId};
use crate::TargetPlatform;

pub use crate::types::files::{
    Download, File, FileHash, Platform, PlatformStatus, VirusResult, VirusScan, VirusStatus,
};

/// Interface for the modfiles of a mod.
#[derive(Clone)]
pub struct Files {
    modio: Modio,
    game: GameId,
    mod_id: ModId,
}

impl Files {
    pub(crate) fn new(modio: Modio, game: GameId, mod_id: ModId) -> Self {
        Self {
            modio,
            game,
            mod_id,
        }
    }

    /// Returns a `Query` interface to retrieve all files that are published
    /// for a mod this `Files` refers to.
    ///
    /// See [Filters and sorting](filters).
    pub fn search(&self, filter: Filter) -> Query<File> {
        let route = Route::GetFiles {
            game_id: self.game,
            mod_id: self.mod_id,
        };
        Query::new(self.modio.clone(), route, filter)
    }

    /// Return a reference to a file.
    pub fn get(&self, id: FileId) -> FileRef {
        FileRef::new(self.modio.clone(), self.game, self.mod_id, id)
    }

    /// Add a file for a mod that this `Files` refers to. [required: token]
    #[allow(clippy::should_implement_trait)]
    pub async fn add(self, options: AddFileOptions) -> Result<File> {
        let route = Route::AddFile {
            game_id: self.game,
            mod_id: self.mod_id,
        };
        self.modio
            .request(route)
            .multipart(Form::from(options))
            .send()
            .await
    }
}

/// Reference interface of a modfile.
#[derive(Clone)]
pub struct FileRef {
    modio: Modio,
    game: GameId,
    mod_id: ModId,
    id: FileId,
}

impl FileRef {
    pub(crate) fn new(modio: Modio, game: GameId, mod_id: ModId, id: FileId) -> Self {
        Self {
            modio,
            game,
            mod_id,
            id,
        }
    }

    /// Get a reference to the Modio modfile object that this `FileRef` refers to.
    pub async fn get(self) -> Result<File> {
        let route = Route::GetFile {
            game_id: self.game,
            mod_id: self.mod_id,
            file_id: self.id,
        };
        self.modio.request(route).send().await
    }

    /// Edit details of a modfile. [required: token]
    pub async fn edit(self, options: EditFileOptions) -> Result<Editing<File>> {
        let route = Route::EditFile {
            game_id: self.game,
            mod_id: self.mod_id,
            file_id: self.id,
        };
        self.modio.request(route).form(&options).send().await
    }

    /// Delete a modfile. [required: token]
    pub async fn delete(self) -> Result<()> {
        let route = Route::DeleteFile {
            game_id: self.game,
            mod_id: self.mod_id,
            file_id: self.id,
        };
        self.modio.request(route).send().await
    }

    /// Edit the platform status of a modfile. [required: token]
    pub async fn edit_platform_status(self, options: EditPlatformStatusOptions) -> Result<File> {
        let route = Route::ManagePlatformStatus {
            game_id: self.game,
            mod_id: self.mod_id,
            file_id: self.id,
        };
        self.modio.request(route).form(&options).send().await
    }
}

/// Modfile filters and sorting.
///
/// # Filters
/// - `Fulltext`
/// - `Id`
/// - `ModId`
/// - `DateAdded`
/// - `DateScanned`
/// - `VirusStatus`
/// - `VirusPositive`
/// - `Filesize`
/// - `Filehash`
/// - `Filename`
/// - `Version`
/// - `Changelog`
///
/// # Sorting
/// - `Id`
/// - `ModId`
/// - `DateAdded`
/// - `Version`
///
/// See [modio docs](https://docs.mod.io/restapiref/#get-modfiles) for more information.
///
/// By default this returns up to `100` items. You can limit the result by using `limit` and
/// `offset`.
///
/// # Example
/// ```
/// use modio::filter::prelude::*;
/// use modio::files::filters::Id;
///
/// let filter = Id::_in(vec![1, 2]).order_by(Id::desc());
/// ```
#[rustfmt::skip]
pub mod filters {
    #[doc(inline)]
    pub use crate::filter::prelude::Fulltext;
    #[doc(inline)]
    pub use crate::filter::prelude::Id;
    #[doc(inline)]
    pub use crate::filter::prelude::ModId;
    #[doc(inline)]
    pub use crate::filter::prelude::DateAdded;

    filter!(DateScanned, DATE_SCANNED, "date_scanned", Eq, NotEq, In, Cmp);
    filter!(VirusStatus, VIRUS_STATUS, "virus_status", Eq, NotEq, In, Cmp);
    filter!(VirusPositive, VIRUS_POSITIVE, "virus_positive", Eq, NotEq, In, Cmp);
    filter!(Filesize, FILESIZE, "filesize", Eq, NotEq, In, Cmp, OrderBy);
    filter!(Filehash, FILEHASH, "filehash", Eq, NotEq, In, Like);
    filter!(Filename, FILENAME, "filename", Eq, NotEq, In, Like);
    filter!(Version, VERSION, "version", Eq, NotEq, In, Like, OrderBy);
    filter!(Changelog, CHANGELOG, "changelog", Eq, NotEq, In, Like);
}

pub struct AddFileOptions {
    source: FileSource,
    version: Option<String>,
    changelog: Option<String>,
    active: Option<bool>,
    filehash: Option<String>,
    metadata_blob: Option<String>,
}

impl AddFileOptions {
    pub fn with_read<R, S>(inner: R, filename: S) -> AddFileOptions
    where
        R: AsyncRead + Send + Sync + Unpin + 'static,
        S: Into<String>,
    {
        AddFileOptions {
            source: FileSource::new_from_read(inner, filename.into(), APPLICATION_OCTET_STREAM),
            version: None,
            changelog: None,
            active: None,
            filehash: None,
            metadata_blob: None,
        }
    }

    pub fn with_file<P: AsRef<Path>>(file: P) -> AddFileOptions {
        let file = file.as_ref();
        let filename = file
            .file_name()
            .and_then(OsStr::to_str)
            .map_or_else(String::new, ToString::to_string);

        Self::with_file_name(file, filename)
    }

    pub fn with_file_name<P, S>(file: P, filename: S) -> AddFileOptions
    where
        P: AsRef<Path>,
        S: Into<String>,
    {
        let file = file.as_ref();

        AddFileOptions {
            source: FileSource::new_from_file(file, filename.into(), APPLICATION_OCTET_STREAM),
            version: None,
            changelog: None,
            active: None,
            filehash: None,
            metadata_blob: None,
        }
    }

    option!(version);
    option!(changelog);
    option!(active: bool);
    option!(filehash);
    option!(metadata_blob);
}

#[doc(hidden)]
impl From<AddFileOptions> for Form {
    fn from(opts: AddFileOptions) -> Form {
        let mut form = Form::new();
        if let Some(version) = opts.version {
            form = form.text("version", version);
        }
        if let Some(changelog) = opts.changelog {
            form = form.text("changelog", changelog);
        }
        if let Some(active) = opts.active {
            form = form.text("active", active.to_string());
        }
        if let Some(filehash) = opts.filehash {
            form = form.text("filehash", filehash);
        }
        if let Some(metadata_blob) = opts.metadata_blob {
            form = form.text("metadata_blob", metadata_blob);
        }
        form.part("filedata", opts.source.into())
    }
}

#[derive(Default)]
pub struct EditFileOptions {
    params: std::collections::BTreeMap<&'static str, String>,
}

impl EditFileOptions {
    option!(version >> "version");
    option!(changelog >> "changelog");
    option!(active: bool >> "active");
    option!(metadata_blob >> "metadata_blob");
}

impl_serialize_params!(EditFileOptions >> params);

pub struct EditPlatformStatusOptions {
    approved: Vec<TargetPlatform>,
    denied: Vec<TargetPlatform>,
}

impl EditPlatformStatusOptions {
    pub fn new(approved: &[TargetPlatform], denied: &[TargetPlatform]) -> Self {
        Self {
            approved: approved.to_vec(),
            denied: denied.to_vec(),
        }
    }
}

impl Serialize for EditPlatformStatusOptions {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        let mut s = serializer.serialize_map(Some(self.approved.len() + self.denied.len()))?;
        for target in &self.approved {
            s.serialize_entry("approved[]", target)?;
        }
        for target in &self.denied {
            s.serialize_entry("denied[]", target)?;
        }
        s.end()
    }
}