nntp_proxy/command/

handler.rs

//! Command handling with action types
//!
//! This module provides a CommandHandler that processes NNTP commands
//! and returns actions to be taken, separating command interpretation
//! from command execution.
//!
//! # NNTP Response Codes
//!
//! Response codes follow RFC 3977 Section 3.2:
//! <https://www.rfc-editor.org/rfc/rfc3977.html#section-3.2>
//!
//! ## Codes Used
//!
//! - `480` Authentication required
//!   <https://www.rfc-editor.org/rfc/rfc4643.html#section-2.4.1>
//! - `502` Command not implemented  
//!   <https://www.rfc-editor.org/rfc/rfc3977.html#section-3.2.1>
//!   Used when a command is recognized but not supported by this server

use super::classifier::NntpCommand;

/// Action to take in response to a command
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum CommandAction {
    /// Intercept and send authentication response to client
    InterceptAuth(AuthAction),
    /// Reject the command with an error message (NNTP response format with CRLF)
    Reject(&'static str),
    /// Forward the command to backend (stateless)
    ForwardStateless,
}

/// Specific authentication action
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum AuthAction {
    /// Send password required response (username provided)
    RequestPassword(String),
    /// Validate credentials and send appropriate response
    ValidateAndRespond { password: String },
}

/// Handler for processing commands and determining actions
pub struct CommandHandler;

impl CommandHandler {
    /// Process a command and return the action to take
    pub fn handle_command(command: &str) -> CommandAction {
        match NntpCommand::classify(command) {
            NntpCommand::AuthUser => {
                // Extract username from "AUTHINFO USER <username>"
                let username = command
                    .trim()
                    .strip_prefix("AUTHINFO USER")
                    .or_else(|| command.trim().strip_prefix("authinfo user"))
                    .unwrap_or("")
                    .trim()
                    .to_string();
                CommandAction::InterceptAuth(AuthAction::RequestPassword(username))
            }
            NntpCommand::AuthPass => {
                // Extract password from "AUTHINFO PASS <password>"
                let password = command
                    .trim()
                    .strip_prefix("AUTHINFO PASS")
                    .or_else(|| command.trim().strip_prefix("authinfo pass"))
                    .unwrap_or("")
                    .trim()
                    .to_string();
                CommandAction::InterceptAuth(AuthAction::ValidateAndRespond { password })
            }
            NntpCommand::Stateful => {
                // RFC 3977 Section 3.2.1: 502 Command not implemented
                // https://www.rfc-editor.org/rfc/rfc3977.html#section-3.2.1
                CommandAction::Reject("502 Command not implemented in stateless proxy mode\r\n")
            }
            NntpCommand::NonRoutable => {
                // RFC 3977 Section 3.2.1: 502 Command not implemented
                // https://www.rfc-editor.org/rfc/rfc3977.html#section-3.2.1
                CommandAction::Reject("502 Command not implemented in per-command routing mode\r\n")
            }
            NntpCommand::ArticleByMessageId => CommandAction::ForwardStateless,
            NntpCommand::Stateless => CommandAction::ForwardStateless,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_auth_user_command() {
        let action = CommandHandler::handle_command("AUTHINFO USER test");
        assert!(matches!(
            action,
            CommandAction::InterceptAuth(AuthAction::RequestPassword(ref username)) if username == "test"
        ));
    }

    #[test]
    fn test_auth_pass_command() {
        let action = CommandHandler::handle_command("AUTHINFO PASS secret");
        assert!(matches!(
            action,
            CommandAction::InterceptAuth(AuthAction::ValidateAndRespond { ref password }) if password == "secret"
        ));
    }

    #[test]
    fn test_stateful_command_rejected() {
        let action = CommandHandler::handle_command("GROUP alt.test");
        assert!(
            matches!(action, CommandAction::Reject(msg) if msg.contains("stateless")),
            "Expected Reject with 'stateless' in message"
        );
    }

    #[test]
    fn test_article_by_message_id() {
        let action = CommandHandler::handle_command("ARTICLE <test@example.com>");
        assert_eq!(action, CommandAction::ForwardStateless);
    }

    #[test]
    fn test_stateless_command() {
        let action = CommandHandler::handle_command("LIST");
        assert_eq!(action, CommandAction::ForwardStateless);

        let action = CommandHandler::handle_command("HELP");
        assert_eq!(action, CommandAction::ForwardStateless);
    }

    #[test]
    fn test_all_stateful_commands_rejected() {
        // Test various stateful commands
        let stateful_commands = vec![
            "GROUP alt.test",
            "NEXT",
            "LAST",
            "LISTGROUP alt.test",
            "ARTICLE 123",
            "HEAD 456",
            "BODY 789",
            "STAT",
            "XOVER 1-100",
        ];

        for cmd in stateful_commands {
            match CommandHandler::handle_command(cmd) {
                CommandAction::Reject(msg) => {
                    assert!(msg.contains("stateless") || msg.contains("not supported"));
                }
                other => panic!("Expected Reject for '{}', got {:?}", cmd, other),
            }
        }
    }

    #[test]
    fn test_all_article_by_msgid_forwarded() {
        // All message-ID based article commands should be forwarded as stateless
        let msgid_commands = vec![
            "ARTICLE <test@example.com>",
            "BODY <msg@server.org>",
            "HEAD <id@host.net>",
            "STAT <unique@domain.com>",
        ];

        for cmd in msgid_commands {
            assert_eq!(
                CommandHandler::handle_command(cmd),
                CommandAction::ForwardStateless,
                "Command '{}' should be forwarded as stateless",
                cmd
            );
        }
    }

    #[test]
    fn test_various_stateless_commands() {
        let stateless_commands = vec![
            "HELP",
            "LIST",
            "LIST ACTIVE",
            "LIST NEWSGROUPS",
            "DATE",
            "CAPABILITIES",
            "QUIT",
        ];

        for cmd in stateless_commands {
            assert_eq!(
                CommandHandler::handle_command(cmd),
                CommandAction::ForwardStateless,
                "Command '{}' should be stateless",
                cmd
            );
        }
    }

    #[test]
    fn test_case_insensitive_handling() {
        // Test that command handling is case-insensitive
        assert_eq!(
            CommandHandler::handle_command("list"),
            CommandAction::ForwardStateless
        );
        assert_eq!(
            CommandHandler::handle_command("LiSt"),
            CommandAction::ForwardStateless
        );
        assert_eq!(
            CommandHandler::handle_command("QUIT"),
            CommandAction::ForwardStateless
        );
        assert_eq!(
            CommandHandler::handle_command("quit"),
            CommandAction::ForwardStateless
        );
    }

    #[test]
    fn test_empty_command() {
        // Empty command should be treated as stateless (unknown)
        let action = CommandHandler::handle_command("");
        assert_eq!(action, CommandAction::ForwardStateless);
    }

    #[test]
    fn test_whitespace_handling() {
        // Command with leading/trailing whitespace
        let action = CommandHandler::handle_command("  LIST  ");
        assert_eq!(action, CommandAction::ForwardStateless);

        // Auth command with extra whitespace
        let action = CommandHandler::handle_command("  AUTHINFO USER test  ");
        assert!(matches!(
            action,
            CommandAction::InterceptAuth(AuthAction::RequestPassword(ref username)) if username == "test"
        ));
    }

    #[test]
    fn test_malformed_auth_commands() {
        // AUTHINFO without subcommand
        let action = CommandHandler::handle_command("AUTHINFO");
        assert_eq!(action, CommandAction::ForwardStateless);

        // AUTHINFO with unknown subcommand
        let action = CommandHandler::handle_command("AUTHINFO INVALID");
        assert_eq!(action, CommandAction::ForwardStateless);
    }

    #[test]
    fn test_auth_commands_without_arguments() {
        // AUTHINFO USER without username (still intercept, empty username)
        let action = CommandHandler::handle_command("AUTHINFO USER");
        assert!(matches!(
            action,
            CommandAction::InterceptAuth(AuthAction::RequestPassword(ref username)) if username.is_empty()
        ));

        // AUTHINFO PASS without password (still intercept, empty password)
        let action = CommandHandler::handle_command("AUTHINFO PASS");
        assert!(matches!(
            action,
            CommandAction::InterceptAuth(AuthAction::ValidateAndRespond { ref password }) if password.is_empty()
        ));
    }

    #[test]
    fn test_article_commands_with_newlines() {
        // Command with CRLF
        let action = CommandHandler::handle_command("ARTICLE <msg@test.com>\r\n");
        assert_eq!(action, CommandAction::ForwardStateless);

        // Command with just LF
        let action = CommandHandler::handle_command("LIST\n");
        assert_eq!(action, CommandAction::ForwardStateless);
    }

    #[test]
    fn test_very_long_commands() {
        // Very long stateless command
        let long_cmd = format!("LIST {}", "A".repeat(10000));
        let action = CommandHandler::handle_command(&long_cmd);
        assert_eq!(action, CommandAction::ForwardStateless);

        // Very long GROUP name (stateful)
        let long_group = format!("GROUP {}", "alt.".repeat(1000));
        match CommandHandler::handle_command(&long_group) {
            CommandAction::Reject(_) => {} // Expected
            other => panic!("Expected Reject for long GROUP, got {:?}", other),
        }
    }

    #[test]
    fn test_command_action_equality() {
        // Test that CommandAction implements PartialEq correctly
        assert_eq!(
            CommandAction::ForwardStateless,
            CommandAction::ForwardStateless
        );
        assert_eq!(
            CommandAction::InterceptAuth(AuthAction::RequestPassword("test".to_string())),
            CommandAction::InterceptAuth(AuthAction::RequestPassword("test".to_string()))
        );

        // Test inequality
        assert_ne!(
            CommandAction::InterceptAuth(AuthAction::RequestPassword("user1".to_string())),
            CommandAction::InterceptAuth(AuthAction::ValidateAndRespond {
                password: "pass1".to_string()
            })
        );
    }

    #[test]
    fn test_reject_messages() {
        // Verify reject messages are informative
        assert!(
            matches!(
                CommandHandler::handle_command("GROUP alt.test"),
                CommandAction::Reject(msg) if !msg.is_empty() && msg.len() > 10
            ),
            "Expected Reject with meaningful message"
        );
    }

    #[test]
    fn test_unknown_commands_forwarded() {
        // Unknown commands should be forwarded as stateless
        // The backend server will handle the error
        let unknown_commands = ["INVALIDCOMMAND", "XYZABC", "RANDOM DATA", "12345"];

        assert!(
            unknown_commands.iter().all(|cmd| {
                CommandHandler::handle_command(cmd) == CommandAction::ForwardStateless
            }),
            "All unknown commands should be forwarded as stateless"
        );
    }

    #[test]
    fn test_non_routable_commands_rejected() {
        // POST should be rejected
        assert!(
            matches!(
                CommandHandler::handle_command("POST"),
                CommandAction::Reject(msg) if msg.contains("routing")
            ),
            "Expected Reject for POST"
        );

        // IHAVE should be rejected
        assert!(
            matches!(
                CommandHandler::handle_command("IHAVE <test@example.com>"),
                CommandAction::Reject(msg) if msg.contains("routing")
            ),
            "Expected Reject for IHAVE"
        );

        // NEWGROUPS should be rejected
        assert!(
            matches!(
                CommandHandler::handle_command("NEWGROUPS 20240101 000000 GMT"),
                CommandAction::Reject(msg) if msg.contains("routing")
            ),
            "Expected Reject for NEWGROUPS"
        );

        // NEWNEWS should be rejected
        assert!(
            matches!(
                CommandHandler::handle_command("NEWNEWS * 20240101 000000 GMT"),
                CommandAction::Reject(msg) if msg.contains("routing")
            ),
            "Expected Reject for NEWNEWS"
        );
    }

    #[test]
    fn test_reject_message_content() {
        // Verify different reject messages for different command types
        let CommandAction::Reject(stateful_reject) =
            CommandHandler::handle_command("GROUP alt.test")
        else {
            panic!("Expected Reject")
        };

        let CommandAction::Reject(routing_reject) = CommandHandler::handle_command("POST") else {
            panic!("Expected Reject")
        };

        // They should have different messages
        assert!(stateful_reject.contains("stateless"));
        assert!(routing_reject.contains("routing"));
        assert_ne!(stateful_reject, routing_reject);
    }

    #[test]
    fn test_reject_response_format() {
        // RFC 3977 Section 3.1: Response format is "xyz text\r\n"
        // https://www.rfc-editor.org/rfc/rfc3977.html#section-3.1

        let CommandAction::Reject(response) = CommandHandler::handle_command("GROUP alt.test")
        else {
            panic!("Expected Reject")
        };

        // Must start with 3-digit status code
        assert!(response.len() >= 3, "Response too short");
        assert!(
            response[0..3].chars().all(|c| c.is_ascii_digit()),
            "First 3 chars must be digits, got: {}",
            &response[0..3]
        );

        // Must have space after status code
        assert_eq!(&response[3..4], " ", "Must have space after status code");

        // Must end with CRLF
        assert!(response.ends_with("\r\n"), "Response must end with CRLF");

        // Status code must be 502 (Command not implemented)
        // https://www.rfc-editor.org/rfc/rfc3977.html#section-3.2.1
        assert!(
            response.starts_with("502 "),
            "Expected 502 status code, got: {}",
            response
        );
    }

    #[test]
    fn test_all_reject_responses_are_valid_nntp() {
        // Test all commands that produce Reject responses
        let reject_commands = vec![
            "GROUP alt.test",
            "NEXT",
            "LAST",
            "POST",
            "IHAVE <test@example.com>",
            "NEWGROUPS 20240101 000000 GMT",
        ];

        for cmd in reject_commands {
            let CommandAction::Reject(response) = CommandHandler::handle_command(cmd) else {
                panic!("Expected Reject for command: {}", cmd);
            };

            // All must be valid NNTP format
            assert!(
                response.len() >= 5,
                "Response too short for {}: {}",
                cmd,
                response
            );
            assert!(
                response.starts_with(|c: char| c.is_ascii_digit()),
                "Must start with digit for {}: {}",
                cmd,
                response
            );
            assert!(
                response.ends_with("\r\n"),
                "Must end with CRLF for {}: {}",
                cmd,
                response
            );
            assert!(
                response.contains(' '),
                "Must have space separator for {}: {}",
                cmd,
                response
            );
        }
    }

    #[test]
    fn test_502_status_code_usage() {
        // RFC 3977 Section 3.2.1: 502 is "Command not implemented"
        // https://www.rfc-editor.org/rfc/rfc3977.html#section-3.2.1
        // "The command is not presently implemented by the server, although
        //  it may be implemented in the future."

        // Stateful commands in stateless mode
        let CommandAction::Reject(response) = CommandHandler::handle_command("GROUP alt.test")
        else {
            panic!("Expected Reject");
        };
        assert!(
            response.starts_with("502 "),
            "Stateful commands should return 502, got: {}",
            response
        );

        // Non-routable commands in routing mode
        let CommandAction::Reject(response) = CommandHandler::handle_command("POST") else {
            panic!("Expected Reject");
        };
        assert!(
            response.starts_with("502 "),
            "Non-routable commands should return 502, got: {}",
            response
        );
    }

    #[test]
    fn test_response_messages_are_descriptive() {
        // Responses should explain why the command is rejected
        let CommandAction::Reject(stateful) = CommandHandler::handle_command("GROUP alt.test")
        else {
            panic!("Expected Reject");
        };
        assert!(
            stateful.to_lowercase().contains("stateless")
                || stateful.to_lowercase().contains("mode"),
            "Should explain stateless mode restriction: {}",
            stateful
        );

        let CommandAction::Reject(routing) = CommandHandler::handle_command("POST") else {
            panic!("Expected Reject");
        };
        assert!(
            routing.to_lowercase().contains("routing") || routing.to_lowercase().contains("mode"),
            "Should explain routing mode restriction: {}",
            routing
        );
    }
}