path: root/crates/shirabe/src/command/run_script_command.rs

//! ref: composer/src/Composer/Command/RunScriptCommand.php

use anyhow::Result;
use indexmap::IndexMap;
use shirabe_external_packages::symfony::component::console::input::InputInterface;
use shirabe_external_packages::symfony::component::console::output::OutputInterface;
use shirabe_php_shim::{InvalidArgumentException, PhpMixed, RuntimeException};

use crate::command::{BaseCommand, BaseCommandData, HasBaseCommandData};
use crate::composer::{Composer, PartialComposer};
use crate::console::input::InputArgument;
use crate::console::input::InputOption;
use crate::io::IOInterface;
use crate::io::IOInterfaceImmutable;
use crate::script::Event as ScriptEvent;
use crate::script::ScriptEvents;
use crate::util::Platform;
use crate::util::ProcessExecutor;

#[derive(Debug)]
pub struct RunScriptCommand {
    base_command_data: BaseCommandData,

    script_events: Vec<&'static str>,
}

impl RunScriptCommand {
    pub fn new() -> Self {
        Self {
            base_command_data: BaseCommandData {
                composer: None,
                io: None,
            },
            script_events: vec![
                ScriptEvents::PRE_INSTALL_CMD,
                ScriptEvents::POST_INSTALL_CMD,
                ScriptEvents::PRE_UPDATE_CMD,
                ScriptEvents::POST_UPDATE_CMD,
                ScriptEvents::PRE_STATUS_CMD,
                ScriptEvents::POST_STATUS_CMD,
                ScriptEvents::POST_ROOT_PACKAGE_INSTALL,
                ScriptEvents::POST_CREATE_PROJECT_CMD,
                ScriptEvents::PRE_ARCHIVE_CMD,
                ScriptEvents::POST_ARCHIVE_CMD,
                ScriptEvents::PRE_AUTOLOAD_DUMP,
                ScriptEvents::POST_AUTOLOAD_DUMP,
            ],
        }
    }

    pub fn configure(&mut self) {
        self.set_name("run-script")
            .set_aliases(&["run".to_string()])
            .set_description("Runs the scripts defined in composer.json")
            .set_definition(&[
                // TODO(cli-completion): script-name completion was provided via a closure suggesting runtime script names
                InputArgument::new(
                    "script",
                    Some(InputArgument::OPTIONAL),
                    "Script name to run.",
                    None,
                )
                .unwrap()
                .into(),
                InputArgument::new(
                    "args",
                    Some(InputArgument::IS_ARRAY | InputArgument::OPTIONAL),
                    "",
                    None,
                )
                .unwrap()
                .into(),
                InputOption::new(
                    "timeout",
                    None,
                    Some(InputOption::VALUE_REQUIRED),
                    "Sets script timeout in seconds, or 0 for never.",
                    None,
                )
                .unwrap()
                .into(),
                InputOption::new(
                    "dev",
                    None,
                    Some(InputOption::VALUE_NONE),
                    "Sets the dev mode.",
                    None,
                )
                .unwrap()
                .into(),
                InputOption::new(
                    "no-dev",
                    None,
                    Some(InputOption::VALUE_NONE),
                    "Disables the dev mode.",
                    None,
                )
                .unwrap()
                .into(),
                InputOption::new(
                    "list",
                    Some(PhpMixed::String("l".to_string())),
                    Some(InputOption::VALUE_NONE),
                    "List scripts.",
                    None,
                )
                .unwrap()
                .into(),
            ])
            .set_help(
                "The <info>run-script</info> command runs scripts defined in composer.json:\n\n\
                <info>php composer.phar run-script post-update-cmd</info>\n\n\
                Read more at https://getcomposer.org/doc/03-cli.md#run-script-run",
            );
    }

    pub fn interact(
        &mut self,
        input: &mut dyn InputInterface,
        _output: &dyn OutputInterface,
    ) -> Result<()> {
        let scripts = self.get_scripts()?;
        if scripts.is_empty() {
            return Ok(());
        }

        if input.get_argument("script").as_string().is_some()
            || input.get_option("list").as_bool().unwrap_or(false)
        {
            return Ok(());
        }

        let mut options = indexmap::IndexMap::new();
        for script in &scripts {
            options.insert(script.0.clone(), script.1.clone());
        }

        let io = self.get_io();
        let script = io.select(
            "Script to run: ".to_string(),
            options.keys().cloned().collect(),
            PhpMixed::String(String::new()),
            PhpMixed::Int(1),
            "Invalid script name \"%s\"".to_string(),
            false,
        );

        if let Some(selected) = script.as_string() {
            // TODO(phase-b): input is &dyn InputInterface but set_argument needs &mut.
            let _ = selected;
        }

        Ok(())
    }

    pub fn execute(
        &mut self,
        input: &dyn InputInterface,
        output: &dyn OutputInterface,
    ) -> Result<i64> {
        if input.get_option("list").as_bool().unwrap_or(false) {
            return self.list_scripts(output);
        }

        let script = match input.get_argument("script").as_string() {
            None => {
                return Err(RuntimeException {
                    message: "Missing required argument \"script\"".to_string(),
                    code: 0,
                }
                .into());
            }
            Some(s) => s.to_string(),
        };

        if !self.script_events.contains(&script.as_str()) {
            let const_name = script.to_uppercase().replace('-', "_");
            if ScriptEvents::is_defined(&const_name) {
                return Err(InvalidArgumentException {
                    message: format!("Script \"{}\" cannot be run with this command", script),
                    code: 0,
                }
                .into());
            }
        }

        let composer = self.require_composer(None, None)?;
        let dispatcher = crate::command::composer_full(&composer)
            .get_event_dispatcher()
            .clone();
        let dev_mode = input.get_option("dev").as_bool().unwrap_or(false)
            || !input.get_option("no-dev").as_bool().unwrap_or(false);
        // TODO(phase-b): ScriptEvent::new takes Composer/IOInterface by value; placeholder construction.
        let _ = (script.clone(), &composer, dev_mode);
        let has_listeners = false;
        if !has_listeners {
            return Err(InvalidArgumentException {
                message: format!("Script \"{}\" is not defined in this package", script),
                code: 0,
            }
            .into());
        }

        let args: Vec<String> = input
            .get_argument("args")
            .as_list()
            .map(|l| {
                l.iter()
                    .filter_map(|v| v.as_string().map(|s| s.to_string()))
                    .collect()
            })
            .unwrap_or_default();

        if let Some(timeout_val) = input.get_option("timeout").as_string() {
            let timeout_str = timeout_val.to_string();
            if !timeout_str.chars().all(|c| c.is_ascii_digit()) {
                return Err(RuntimeException {
                    message:
                        "Timeout value must be numeric and positive if defined, or 0 for forever"
                            .to_string(),
                    code: 0,
                }
                .into());
            }
            let timeout: i64 = timeout_str.parse().unwrap_or(0);
            ProcessExecutor::set_timeout(timeout);
        }

        Platform::put_env("COMPOSER_DEV_MODE", if dev_mode { "1" } else { "0" });

        Ok(dispatcher
            .borrow_mut()
            .dispatch_script(&script, dev_mode, args, IndexMap::new())?)
    }

    fn list_scripts(&mut self, output: &dyn OutputInterface) -> Result<i64> {
        let scripts = self.get_scripts()?;
        if scripts.is_empty() {
            return Ok(0);
        }

        let io = self.get_io();
        io.write_error("<info>scripts:</info>");
        let table: Vec<PhpMixed> = scripts
            .iter()
            .map(|(name, desc)| {
                PhpMixed::List(vec![
                    Box::new(PhpMixed::String(format!("  {}", name))),
                    Box::new(PhpMixed::String(desc.clone())),
                ])
            })
            .collect();

        self.render_table(table, output);

        Ok(0)
    }

    fn get_scripts(&mut self) -> Result<Vec<(String, String)>> {
        let composer = self.require_composer(None, None)?;
        let scripts = crate::command::composer_full(&composer)
            .get_package()
            .get_scripts();
        drop(composer);
        if scripts.is_empty() {
            return Ok(vec![]);
        }

        let mut result: Vec<(String, String)> = vec![];
        for (name, _script) in scripts {
            // TODO(phase-b): Application::find returns PhpMixed; placeholder description.
            let _ = self.get_application()?.find(&name);
            let description = String::new();
            result.push((name, description));
        }

        Ok(result)
    }
}

impl HasBaseCommandData for RunScriptCommand {
    fn base_command_data(&self) -> &BaseCommandData {
        &self.base_command_data
    }

    fn base_command_data_mut(&mut self) -> &mut BaseCommandData {
        &mut self.base_command_data
    }
}