zakura 1.0.4

//! Zakurad Subcommands

#![allow(non_local_definitions)]

use std::path::PathBuf;

use abscissa_core::{config::Override, Command, Configurable, FrameworkError, Runnable};

use crate::config::ZakuradConfig;

pub use self::{entry_point::EntryPoint, start::StartCmd};

use self::{
    copy_state::CopyStateCmd, generate::GenerateCmd, prune_state::PruneStateCmd,
    rollback_state::RollbackStateCmd, tip_height::TipHeightCmd,
    validate_vct_sprout_history::ValidateVctSproutHistoryCmd,
};

pub mod start;

mod copy_state;
mod entry_point;
mod generate;
pub mod prune_state;
pub mod rollback_state;
mod tip_height;
mod validate_vct_sprout_history;

#[cfg(test)]
mod tests;

use ZakuradCmd::*;

/// Zakura configuration filename.
pub const CONFIG_FILE: &str = "zakura.toml";

/// Legacy Zebra configuration filename.
const LEGACY_CONFIG_FILE: &str = "zebrad.toml";

/// Zakurad Subcommands
#[derive(Command, Debug, clap::Subcommand)]
pub enum ZakuradCmd {
    /// The `copy-state` subcommand, used to debug cached chain state (expert users only)
    // TODO: hide this command from users in release builds (#3279)
    CopyState(CopyStateCmd),

    /// Generate a default `zakura.toml` configuration
    Generate(GenerateCmd),

    /// Prune Zebra's finalized raw transaction data on disk
    PruneState(PruneStateCmd),

    /// Roll back Zebra's finalized chain state on disk
    RollbackState(RollbackStateCmd),

    /// Start the application (default command)
    Start(StartCmd),

    /// Print the tip block height of Zebra's chain state on disk
    TipHeight(TipHeightCmd),

    /// Validate repaired VCT Sprout history in the state database
    ValidateVctSproutHistory(ValidateVctSproutHistoryCmd),
}

impl ZakuradCmd {
    /// Returns true if this command is a server command.
    ///
    /// Servers load extra components, and use the configured tracing filter.
    ///
    /// For example, `Start` acts as a Zcash node.
    pub(crate) fn is_server(&self) -> bool {
        // List all the commands, so new commands have to make a choice here
        match self {
            // Commands that run as a configured server
            CopyState(_) | Start(_) => true,

            // Utility commands that don't use server components
            Generate(_)
            | PruneState(_)
            | RollbackState(_)
            | TipHeight(_)
            | ValidateVctSproutHistory(_) => false,
        }
    }

    /// Returns true if this command shows the Zebra intro logo and text.
    ///
    /// For example, `Start` acts as a Zcash node.
    pub(crate) fn uses_intro(&self) -> bool {
        // List all the commands, so new commands have to make a choice here
        match self {
            // Commands that need an intro
            Start(_) => true,

            // Utility commands
            CopyState(_)
            | Generate(_)
            | PruneState(_)
            | RollbackState(_)
            | TipHeight(_)
            | ValidateVctSproutHistory(_) => false,
        }
    }

    /// Returns true if this command should ignore errors when
    /// attempting to load a config file.
    pub(crate) fn should_ignore_load_config_error(&self) -> bool {
        matches!(self, ZakuradCmd::Generate(_))
    }

    /// Returns the default log level for this command, based on the `verbose` command line flag.
    ///
    /// Some commands need to be quiet by default.
    pub(crate) fn default_tracing_filter(&self, verbose: bool) -> &'static str {
        let only_show_warnings = match self {
            // Commands that generate quiet output by default.
            // This output:
            // - is used by automated tools, or
            // - needs to be read easily.
            Generate(_)
            | PruneState(_)
            | RollbackState(_)
            | TipHeight(_)
            | ValidateVctSproutHistory(_) => true,

            // Commands that generate informative logging output by default.
            CopyState(_) | Start(_) => false,
        };

        if only_show_warnings && !verbose {
            "warn"
        } else if only_show_warnings || !verbose {
            "info"
        } else {
            "debug"
        }
    }
}

impl Runnable for ZakuradCmd {
    fn run(&self) {
        match self {
            CopyState(cmd) => cmd.run(),
            Generate(cmd) => cmd.run(),
            PruneState(cmd) => cmd.run(),
            RollbackState(cmd) => cmd.run(),
            Start(cmd) => cmd.run(),
            TipHeight(cmd) => cmd.run(),
            ValidateVctSproutHistory(cmd) => cmd.run(),
        }
    }
}

/// This trait allows you to define how application configuration is loaded.
impl Configurable<ZakuradConfig> for ZakuradCmd {
    /// Location of the configuration file
    fn config_path(&self) -> Option<PathBuf> {
        let if_exists = |f: PathBuf| if f.exists() { Some(f) } else { None };

        dirs::preference_dir().and_then(|path| {
            let config_path = path.join(CONFIG_FILE);
            if let Some(config_path) = if_exists(config_path) {
                return Some(config_path);
            }

            let legacy_config_path = path.join(LEGACY_CONFIG_FILE);
            if let Some(legacy_config_path) = if_exists(legacy_config_path) {
                tracing::warn!(
                    config_file = ?legacy_config_path,
                    "zebrad.toml is deprecated; rename this config file to zakura.toml"
                );
                return Some(legacy_config_path);
            }

            None
        })

        // Note: Changes in how configuration is loaded may need usage
        // edits in generate.rs
    }

    /// Apply changes to the config after it's been loaded, e.g. overriding
    /// values in a config file using command-line options.
    ///
    /// This can be safely deleted if you don't want to override config
    /// settings from command-line options.
    fn process_config(&self, config: ZakuradConfig) -> Result<ZakuradConfig, FrameworkError> {
        match self {
            ZakuradCmd::Start(cmd) => cmd.override_config(config),
            _ => Ok(config),
        }
    }
}