path: root/crates/shirabe/src/io/console_io.rs

//! ref: composer/src/Composer/IO/ConsoleIO.php

use indexmap::IndexMap;
use shirabe_external_packages::composer::pcre::preg::Preg;
use shirabe_external_packages::symfony::component::console::helper::helper_set::HelperSet;
use shirabe_external_packages::symfony::component::console::helper::progress_bar::ProgressBar;
use shirabe_external_packages::symfony::component::console::helper::table::Table;
use shirabe_external_packages::symfony::component::console::input::input_interface::InputInterface;
use shirabe_external_packages::symfony::component::console::output::console_output_interface::ConsoleOutputInterface;
use shirabe_external_packages::symfony::component::console::output::output_interface::OutputInterface;
use shirabe_external_packages::symfony::component::console::question::choice_question::ChoiceQuestion;
use shirabe_external_packages::symfony::component::console::question::question::Question;
use shirabe_php_shim::{
    array_filter, array_keys, array_search, count, function_exists, implode, in_array, is_array,
    is_string, mb_check_encoding, mb_convert_encoding, microtime, sprintf, str_repeat, strip_tags,
    strlen, PhpMixed,
};

use crate::io::base_io::BaseIO;
use crate::io::io_interface::IOInterface;
use crate::question::strict_confirmation_question::StrictConfirmationQuestion;
use crate::util::silencer::Silencer;

/// The Input/Output helper.
#[derive(Debug)]
pub struct ConsoleIO {
    pub(crate) inner: BaseIO,
    pub(crate) input: Box<dyn InputInterface>,
    pub(crate) output: Box<dyn OutputInterface>,
    pub(crate) helper_set: HelperSet,
    pub(crate) last_message: String,
    pub(crate) last_message_err: String,

    /// @var float
    start_time: Option<f64>,
    /// @var array<IOInterface::*, OutputInterface::VERBOSITY_*>
    verbosity_map: IndexMap<i64, i64>,
}

impl ConsoleIO {
    /// Constructor.
    ///
    /// @param InputInterface  $input     The input instance
    /// @param OutputInterface $output    The output instance
    /// @param HelperSet       $helperSet The helperSet instance
    pub fn new(
        input: Box<dyn InputInterface>,
        output: Box<dyn OutputInterface>,
        helper_set: HelperSet,
    ) -> Self {
        let mut verbosity_map = IndexMap::new();
        verbosity_map.insert(IOInterface::QUIET, OutputInterface::VERBOSITY_QUIET);
        verbosity_map.insert(IOInterface::NORMAL, OutputInterface::VERBOSITY_NORMAL);
        verbosity_map.insert(IOInterface::VERBOSE, OutputInterface::VERBOSITY_VERBOSE);
        verbosity_map.insert(
            IOInterface::VERY_VERBOSE,
            OutputInterface::VERBOSITY_VERY_VERBOSE,
        );
        verbosity_map.insert(IOInterface::DEBUG, OutputInterface::VERBOSITY_DEBUG);
        Self {
            inner: BaseIO {
                authentications: IndexMap::new(),
            },
            input,
            output,
            helper_set,
            last_message: String::new(),
            last_message_err: String::new(),
            start_time: None,
            verbosity_map,
        }
    }

    pub fn enable_debugging(&mut self, start_time: f64) {
        self.start_time = Some(start_time);
    }

    pub fn is_interactive(&self) -> bool {
        self.input.is_interactive()
    }

    pub fn is_decorated(&self) -> bool {
        self.output.is_decorated()
    }

    pub fn is_verbose(&self) -> bool {
        self.output.is_verbose()
    }

    pub fn is_very_verbose(&self) -> bool {
        self.output.is_very_verbose()
    }

    pub fn is_debug(&self) -> bool {
        self.output.is_debug()
    }

    pub fn write(&mut self, messages: PhpMixed, newline: bool, verbosity: i64) {
        let messages = Self::sanitize(messages, true);

        self.do_write(messages, newline, false, verbosity, false);
    }

    pub fn write_error(&mut self, messages: PhpMixed, newline: bool, verbosity: i64) {
        let messages = Self::sanitize(messages, true);

        self.do_write(messages, newline, true, verbosity, false);
    }

    pub fn write_raw(&mut self, messages: PhpMixed, newline: bool, verbosity: i64) {
        self.do_write(messages, newline, false, verbosity, true);
    }

    pub fn write_error_raw(&mut self, messages: PhpMixed, newline: bool, verbosity: i64) {
        self.do_write(messages, newline, true, verbosity, true);
    }

    /// @param string[]|string $messages
    fn do_write(
        &mut self,
        messages: PhpMixed,
        newline: bool,
        stderr: bool,
        verbosity: i64,
        raw: bool,
    ) {
        let mut sf_verbosity = *self.verbosity_map.get(&verbosity).unwrap_or(&0);
        if sf_verbosity > self.output.get_verbosity() {
            return;
        }

        if raw {
            sf_verbosity |= OutputInterface::OUTPUT_RAW;
        }

        let messages = if let Some(start_time) = self.start_time {
            let memory_usage = (shirabe_php_shim::memory_get_usage() as f64) / 1024.0 / 1024.0;
            let time_spent = microtime(true) - start_time;
            // PHP: array_map(fn ($message): string => sprintf(...), (array) $messages)
            let arr: Vec<String> = match &messages {
                PhpMixed::String(s) => vec![s.clone()],
                PhpMixed::List(l) => l
                    .iter()
                    .filter_map(|v| v.as_string().map(|s| s.to_string()))
                    .collect(),
                _ => vec![],
            };
            let mapped: Vec<String> = arr
                .into_iter()
                .map(|message| {
                    sprintf(
                        "[%.1fMiB/%.2fs] %s",
                        &[
                            PhpMixed::Float(memory_usage),
                            PhpMixed::Float(time_spent),
                            PhpMixed::String(message),
                        ],
                    )
                })
                .collect();
            PhpMixed::List(mapped.into_iter().map(|s| Box::new(PhpMixed::String(s))).collect())
        } else {
            messages
        };

        if true == stderr && self.output.is_console_output_interface() {
            // TODO(phase-b): downcast Box<dyn OutputInterface> to ConsoleOutputInterface
            let console_output: &dyn ConsoleOutputInterface =
                todo!("downcast self.output to ConsoleOutputInterface");
            console_output
                .get_error_output()
                .write(messages.clone(), newline, sf_verbosity);
            // PHP: implode($newline ? "\n" : '', (array) $messages)
            self.last_message_err = implode(
                if newline { "\n" } else { "" },
                &Self::to_string_list(&messages),
            );

            return;
        }

        self.output.write(messages.clone(), newline, sf_verbosity);
        self.last_message = implode(
            if newline { "\n" } else { "" },
            &Self::to_string_list(&messages),
        );
    }

    pub fn overwrite(
        &mut self,
        messages: PhpMixed,
        newline: bool,
        size: Option<i64>,
        verbosity: i64,
    ) {
        self.do_overwrite(messages, newline, size, false, verbosity);
    }

    pub fn overwrite_error(
        &mut self,
        messages: PhpMixed,
        newline: bool,
        size: Option<i64>,
        verbosity: i64,
    ) {
        self.do_overwrite(messages, newline, size, true, verbosity);
    }

    /// @param string[]|string $messages
    fn do_overwrite(
        &mut self,
        messages: PhpMixed,
        newline: bool,
        size: Option<i64>,
        stderr: bool,
        verbosity: i64,
    ) {
        // messages can be an array, let's convert it to string anyway
        let messages_str = implode(
            if newline { "\n" } else { "" },
            &Self::to_string_list(&messages),
        );

        // since overwrite is supposed to overwrite last message...
        let size = size.unwrap_or_else(|| {
            // removing possible formatting of lastMessage with strip_tags
            strlen(&strip_tags(if stderr {
                &self.last_message_err
            } else {
                &self.last_message
            }))
        });
        // ...let's fill its length with backspaces
        self.do_write(
            PhpMixed::String(str_repeat("\x08", size as usize)),
            false,
            stderr,
            verbosity,
            false,
        );

        // write the new message
        self.do_write(
            PhpMixed::String(messages_str.clone()),
            false,
            stderr,
            verbosity,
            false,
        );

        // In cmd.exe on Win8.1 (possibly 10?), the line can not be cleared, so we need to
        // track the length of previous output and fill it with spaces to make sure the line is cleared.
        // See https://github.com/composer/composer/pull/5836 for more details
        let fill = size - strlen(&strip_tags(&messages_str));
        if fill > 0 {
            // whitespace whatever has left
            self.do_write(
                PhpMixed::String(str_repeat(" ", fill as usize)),
                false,
                stderr,
                verbosity,
                false,
            );
            // move the cursor back
            self.do_write(
                PhpMixed::String(str_repeat("\x08", fill as usize)),
                false,
                stderr,
                verbosity,
                false,
            );
        }

        if newline {
            self.do_write(
                PhpMixed::String(String::new()),
                true,
                stderr,
                verbosity,
                false,
            );
        }

        if stderr {
            self.last_message_err = messages_str;
        } else {
            self.last_message = messages_str;
        }
    }

    pub fn get_progress_bar(&self, max: i64) -> ProgressBar {
        ProgressBar::new(self.get_error_output(), max)
    }

    pub fn ask(&mut self, question: PhpMixed, default: PhpMixed) -> PhpMixed {
        // PHP: $helper = $this->helperSet->get('question');
        let helper = self.helper_set.get("question");
        let question = Question::new(
            Self::sanitize(question, true),
            if is_string(&default) {
                Self::sanitize(default, true)
            } else {
                default
            },
        );

        helper.ask(&*self.input, self.get_error_output(), &question)
    }

    pub fn ask_confirmation(&mut self, question: PhpMixed, default: bool) -> bool {
        let helper = self.helper_set.get("question");
        let default_mixed = PhpMixed::Bool(default);
        let question = StrictConfirmationQuestion::new(
            Self::sanitize(question, true),
            if is_string(&default_mixed) {
                Self::sanitize(default_mixed, true)
            } else {
                default_mixed
            },
        );

        helper
            .ask(&*self.input, self.get_error_output(), &question)
            .as_bool()
            .unwrap_or(false)
    }

    pub fn ask_and_validate(
        &mut self,
        question: PhpMixed,
        validator: Box<dyn Fn(PhpMixed) -> PhpMixed>,
        attempts: Option<i64>,
        default: PhpMixed,
    ) -> PhpMixed {
        let helper = self.helper_set.get("question");
        let mut question = Question::new(
            Self::sanitize(question, true),
            if is_string(&default) {
                Self::sanitize(default, true)
            } else {
                default
            },
        );
        question.set_validator(validator);
        question.set_max_attempts(attempts);

        helper.ask(&*self.input, self.get_error_output(), &question)
    }

    pub fn ask_and_hide_answer(&mut self, question: PhpMixed) -> Option<String> {
        let helper = self.helper_set.get("question");
        let mut question = Question::new(Self::sanitize(question, true), PhpMixed::Null);
        question.set_hidden(true);

        helper
            .ask(&*self.input, self.get_error_output(), &question)
            .as_string()
            .map(|s| s.to_string())
    }

    pub fn select(
        &mut self,
        question: PhpMixed,
        choices: PhpMixed,
        default: PhpMixed,
        // PHP: int|false attempts
        attempts: PhpMixed,
        error_message: String,
        multiselect: bool,
    ) -> PhpMixed {
        let helper = self.helper_set.get("question");
        let mut question = ChoiceQuestion::new(
            Self::sanitize(question, true),
            Self::sanitize(choices.clone(), true),
            if is_string(&default) {
                Self::sanitize(default, true)
            } else {
                default
            },
        );
        // PHP: IOInterface requires false, and Question requires null or int
        let max_attempts = match attempts {
            PhpMixed::Bool(false) => None,
            PhpMixed::Int(i) => Some(i),
            _ => None,
        };
        question.set_max_attempts(max_attempts);
        question.set_error_message(&error_message);
        question.set_multiselect(multiselect);

        let result = helper.ask(&*self.input, self.get_error_output(), &question);

        // PHP: $isAssoc = (bool) \count(array_filter(array_keys($choices), 'is_string'));
        let choice_keys: Vec<String> = match &choices {
            PhpMixed::Array(a) => a.keys().cloned().collect(),
            PhpMixed::List(_) => vec![],
            _ => vec![],
        };
        let is_assoc = !choice_keys.is_empty()
            && choice_keys.iter().any(|k| !k.parse::<i64>().is_ok());
        if is_assoc {
            return result;
        }

        if !is_array(&result) {
            // PHP: (string) array_search($result, $choices, true)
            // TODO(phase-b): array_search signature requires IndexMap<String, String>
            let result_str = result.as_string().unwrap_or("").to_string();
            let haystack: IndexMap<String, String> = match &choices {
                PhpMixed::List(l) => l
                    .iter()
                    .enumerate()
                    .filter_map(|(i, v)| {
                        v.as_string().map(|s| (i.to_string(), s.to_string()))
                    })
                    .collect(),
                _ => IndexMap::new(),
            };
            return PhpMixed::String(array_search(&result_str, &haystack).unwrap_or_default());
        }

        let mut results: Vec<String> = vec![];
        let result_list = result.as_list().cloned().unwrap_or_default();
        let choice_list: Vec<(String, PhpMixed)> = match &choices {
            PhpMixed::List(l) => l
                .iter()
                .enumerate()
                .map(|(i, v)| (i.to_string(), (**v).clone()))
                .collect(),
            PhpMixed::Array(a) => a.iter().map(|(k, v)| (k.clone(), (**v).clone())).collect(),
            _ => vec![],
        };
        for (index, choice) in &choice_list {
            if in_array(
                choice.clone(),
                &PhpMixed::List(result_list.clone()),
                true,
            ) {
                results.push(index.clone());
            }
        }

        PhpMixed::List(
            results
                .into_iter()
                .map(|s| Box::new(PhpMixed::String(s)))
                .collect(),
        )
    }

    pub fn get_table(&self) -> Table {
        Table::new(&*self.output)
    }

    fn get_error_output(&self) -> &dyn OutputInterface {
        if self.output.is_console_output_interface() {
            // TODO(phase-b): downcast Box<dyn OutputInterface> to ConsoleOutputInterface
            return todo!("downcast self.output to ConsoleOutputInterface and call get_error_output()");
        }

        &*self.output
    }

    /// Sanitize string to remove control characters
    ///
    /// If $allowNewlines is true, \x0A (\n) and \x0D\x0A (\r\n) are let through. Single \r are still sanitized away to prevent overwriting whole lines.
    ///
    /// All other control chars (except NULL bytes) as well as ANSI escape sequences are removed.
    ///
    /// Invalid unicode sequences are turned into question marks.
    ///
    /// @param string|iterable<string> $messages
    /// @return string|array<string>
    /// @phpstan-return ($messages is string ? string : array<string>)
    pub fn sanitize(messages: PhpMixed, allow_newlines: bool) -> PhpMixed {
        // Match ANSI escape sequences:
        // - CSI (Control Sequence Introducer): ESC [ params intermediate final
        // - OSC (Operating System Command): ESC ] ... ESC \ or BEL
        // - Other ESC sequences: ESC followed by any character
        let escape_pattern =
            r"\x1B\[[\x30-\x3F]*[\x20-\x2F]*[\x40-\x7E]|\x1B\].*?(?:\x1B\\|\x07)|\x1B.";
        let pattern = if allow_newlines {
            format!("{{{}|[\\x01-\\x09\\x0B\\x0C\\x0E-\\x1A]|\\r(?!\\n)}}u", escape_pattern)
        } else {
            format!("{{{}|[\\x01-\\x1A]}}u", escape_pattern)
        };
        if is_string(&messages) {
            let message = Self::ensure_valid_utf8(messages.as_string().unwrap_or(""));
            return PhpMixed::String(Preg::replace(&pattern, "", &message));
        }

        // PHP: $sanitized = []; foreach ($messages as $key => $message) { ... }
        let mut sanitized: IndexMap<String, PhpMixed> = IndexMap::new();
        match &messages {
            PhpMixed::List(l) => {
                for (key, message) in l.iter().enumerate() {
                    let s = Self::ensure_valid_utf8(message.as_string().unwrap_or(""));
                    sanitized
                        .insert(key.to_string(), PhpMixed::String(Preg::replace(&pattern, "", &s)));
                }
            }
            PhpMixed::Array(a) => {
                for (key, message) in a {
                    let s = Self::ensure_valid_utf8(message.as_string().unwrap_or(""));
                    sanitized
                        .insert(key.clone(), PhpMixed::String(Preg::replace(&pattern, "", &s)));
                }
            }
            _ => {}
        }

        PhpMixed::Array(
            sanitized
                .into_iter()
                .map(|(k, v)| (k, Box::new(v)))
                .collect(),
        )
    }

    /// Ensures a string is valid UTF-8, replacing invalid byte sequences with '?'
    fn ensure_valid_utf8(string: &str) -> String {
        // Quick check: if string is already valid UTF-8, return as-is
        if function_exists("mb_check_encoding") && mb_check_encoding(string, "UTF-8") {
            return string.to_string();
        }

        // Use mb_convert_encoding to replace invalid sequences with '?'
        // This makes it visible when data quality issues occur
        if function_exists("mb_convert_encoding") {
            return mb_convert_encoding(string.as_bytes().to_vec(), "UTF-8", "UTF-8");
        }

        // Fallback to iconv if mbstring unavailable
        if function_exists("iconv") {
            let cleaned = Silencer::call(|| {
                Ok(shirabe_php_shim::iconv("UTF-8", "UTF-8//TRANSLIT", string))
            });
            if let Ok(Some(c)) = cleaned {
                return c;
            }
        }

        // Last resort: return as-is (should never happen - Composer requires mbstring OR iconv)
        string.to_string()
    }

    /// Helper: PHP `(array) $messages` then collect strings
    fn to_string_list(messages: &PhpMixed) -> Vec<String> {
        match messages {
            PhpMixed::String(s) => vec![s.clone()],
            PhpMixed::List(l) => l
                .iter()
                .filter_map(|v| v.as_string().map(|s| s.to_string()))
                .collect(),
            PhpMixed::Array(a) => a
                .values()
                .filter_map(|v| v.as_string().map(|s| s.to_string()))
                .collect(),
            _ => vec![],
        }
    }
}