rusftp 0.2.1

// This file is part of the rusftp project
//
// Copyright (C) ANEO, 2024-2024. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use serde::{Deserialize, Serialize};
use thiserror::Error;

/// Status code of an operation.
///
/// `OK` indicates that the operations has been successful.
/// All other values indicate errors.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, Error)]
#[repr(u32)]
#[non_exhaustive]
pub enum StatusCode {
    /// Indicates successful completion of the operation.
    ///
    /// internal: `SSH_FX_OK`
    #[error("Ok")]
    #[default]
    Ok = 0,

    /// Indicates end-of-file condition.
    ///
    /// For [`Read`](crate::message::Read) it means that no more data is available in the file,
    /// and for [`ReadDir`](crate::message::ReadDir) it indicates that no more files are contained in the directory.
    ///
    /// internal: `SSH_FX_EOF`
    #[error("Eof")]
    Eof = 1,

    /// Returned when a reference is made to a file which should exist but doesn't.
    ///
    /// internal: `SSH_FX_NO_SUCH_FILE`
    #[error("NoSuchFile")]
    NoSuchFile = 2,

    /// Returned when the authenticated user does not have sufficient permissions to perform the operation.
    ///
    /// internal: `SSH_FX_PERMISSION_DENIED`
    #[error("PermissionDenied")]
    PermissionDenied = 3,

    /// A generic catch-all error message
    ///
    /// It should be returned if an error occurs for which there is no more specific error code defined.
    ///
    /// internal: `SSH_FX_FAILURE`
    #[error("Failure")]
    Failure = 4,

    /// May be returned if a badly formatted packet or protocol incompatibility is detected.
    ///
    /// internal: `SSH_FX_BAD_MESSAGE`
    #[error("BadMessage")]
    BadMessage = 5,

    /// A pseudo-error which indicates that the client has no connection to the server.
    ///
    /// It can only be generated locally by the client, and MUST NOT be returned by servers.
    ///
    /// internal: `SSH_FX_NO_CONNECTION`
    #[error("NoConnection")]
    NoConnection = 6,

    /// A pseudo-error which indicates that the connection to the server has been lost.
    ///
    /// It can only be generated locally by the client, and MUST NOT be returned by servers.
    ///
    /// internal: `SSH_FX_CONNECTION_LOST`
    #[error("ConnectionLost")]
    ConnectionLost = 7,

    /// Indicates that an attempt was made to perform an operation which is not supported for the server
    ///
    /// It may be generated locally by the client if e.g.  the version number exchange indicates
    /// that a required feature is not supported by the server,
    /// or it may be returned by the server if the server does not implement an operation.
    ///
    /// internal: `SSH_FX_OP_UNSUPPORTED`
    #[error("OpUnsupported")]
    OpUnsupported = 8,
}

/// Status of an operation.
///
/// A status code `OK` indicates that the operations has been successful.
/// All other status codes indicate errors.
///
/// internal: `SSH_FXP_STATUS`
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Status {
    /// Code of the status, see [`StatusCode`]
    pub code: StatusCode,
    /// Message of the error
    pub error: String,
    /// Language tag for the error message
    pub language: String,
}

impl StatusCode {
    /// Create a [`Status`] from a [`StatusCode`] and a message.
    ///
    /// The message should be descriptive of the status and match the status code.
    ///
    /// # Arguments
    ///
    /// * `msg` - Description of the status.
    pub fn to_status(self, msg: impl Into<String>) -> Status {
        let msg = msg.into();
        let msg = if msg.is_empty() {
            self.to_string()
        } else {
            msg
        };

        Status {
            code: self,
            error: msg,
            language: "en".into(),
        }
    }
}

impl std::fmt::Display for Status {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if self.error.is_empty() {
            write!(f, "{}", self.code)
        } else {
            write!(
                f,
                "{}: {}",
                self.code,
                String::from_utf8_lossy(self.error.as_ref())
            )
        }
    }
}

impl std::error::Error for Status {}

#[cfg(test)]
mod test {
    use crate::{
        message::test_utils::{encode_decode, fail_decode},
        wire::Error,
    };

    use super::{Status, StatusCode};

    const STATUS_VALID: &[u8] = b"\0\0\0\x01\0\0\0\x03eof\0\0\0\x02en";

    #[test]
    fn encode_success() {
        for (code, encoded) in [
            (StatusCode::Ok, b"\0\0\0\x00"),
            (StatusCode::Eof, b"\0\0\0\x01"),
            (StatusCode::NoSuchFile, b"\0\0\0\x02"),
            (StatusCode::PermissionDenied, b"\0\0\0\x03"),
            (StatusCode::Failure, b"\0\0\0\x04"),
            (StatusCode::BadMessage, b"\0\0\0\x05"),
            (StatusCode::NoConnection, b"\0\0\0\x06"),
            (StatusCode::ConnectionLost, b"\0\0\0\x07"),
            (StatusCode::OpUnsupported, b"\0\0\0\x08"),
        ] {
            encode_decode(code, encoded);
        }

        encode_decode(
            Status {
                code: StatusCode::Eof,
                error: String::from("eof"),
                language: String::from("en"),
            },
            STATUS_VALID,
        );
    }

    #[test]
    fn decode_failure() {
        for i in 0..STATUS_VALID.len() {
            assert_eq!(
                fail_decode::<Status>(&STATUS_VALID[..i]),
                Error::NotEnoughData
            );
        }
    }
}