kmon 1.7.1

use crate::style::Symbol;

/// Kernel module related command
#[derive(Debug)]
pub struct Command {
	pub cmd: String,
	pub desc: &'static str,
	pub title: String,
	pub symbol: Symbol,
}

impl Command {
	/// Create a new command instance.
	fn new(
		cmd: String,
		desc: &'static str,
		mut title: String,
		symbol: Symbol,
	) -> Self {
		// Parse the command title if '!' is given.
		if title.contains('!') {
			title = (*title
				.split('!')
				.collect::<Vec<&str>>()
				.last()
				.unwrap_or(&""))
			.to_string();
		}
		Self {
			cmd,
			desc,
			title,
			symbol,
		}
	}
}

/// Kernel module management commands
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ModuleCommand {
	None,
	Load,
	Unload,
	Reload,
	Blacklist,
	Clear,
}

impl TryFrom<String> for ModuleCommand {
	type Error = ();
	fn try_from(s: String) -> Result<Self, Self::Error> {
		match s.as_ref() {
			"load" => Ok(Self::Load),
			"unload" => Ok(Self::Unload),
			"reload" => Ok(Self::Reload),
			"blacklist" => Ok(Self::Blacklist),
			"clear" => Ok(Self::Clear),
			_ => Err(()),
		}
	}
}

impl ModuleCommand {
	/// Get Command struct from a enum element.
	pub fn get(self, module_name: &str) -> Command {
		match self {
            Self::None => Command::new(String::from(""), "", format!("Module: {module_name}"), Symbol::None),
            Self::Load => Command::new(
                if Self::is_module_filename(module_name) {
					format!("insmod {}", &module_name)
				} else {
					format!("modprobe {0} || insmod {0}.ko", &module_name)
				},
                "Add and remove modules from the Linux Kernel\n
                This command inserts a module to the kernel.",
                format!("Load: {module_name}"), Symbol::Anchor),
            Self::Unload => Command::new(
                format!("modprobe -r {0} || rmmod {0}", &module_name),
                "modprobe/rmmod: Add and remove modules from the Linux Kernel
                modprobe -r, --remove or rmmod\n
                This option causes modprobe to remove rather than insert a module. \
                If the modules it depends on are also unused, modprobe will try to \
                remove them too. \
                For modules loaded with insmod rmmod will be used instead. \
                There is usually no reason to remove modules, but some buggy \
                modules require it. Your distribution kernel may not have been \
                built to support removal of modules at all.",
                format!("Remove: {module_name}"), Symbol::CircleX),
            Self::Reload => Command::new(
                format!("{} && {}",
                    ModuleCommand::Unload.get(module_name).cmd,
                    ModuleCommand::Load.get(module_name).cmd),
                "modprobe/insmod/rmmod: Add and remove modules from the Linux Kernel\n
                This command reloads a module, removes and inserts to the kernel.",
                format!("Reload: {module_name}"), Symbol::FuelPump),
			Self::Blacklist => Command::new(
				format!("if ! grep -q {module} /etc/modprobe.d/blacklist.conf; then
				  echo 'blacklist {module}' >> /etc/modprobe.d/blacklist.conf
				  echo 'install {module} /bin/false' >> /etc/modprobe.d/blacklist.conf
				fi", module = &module_name),
				"This command blacklists a module and any other module that depends on it.\n
				Blacklisting is a mechanism to prevent the kernel module from loading. \
				This could be useful if, for example, the associated hardware is not needed, \
				or if loading that module causes problems.
				The blacklist command will blacklist a module so that it will not be loaded \
				automatically, but the module may be loaded if another non-blacklisted module \
				depends on it or if it is loaded manually. However, there is a workaround for \
				this behaviour; the install command instructs modprobe to run a custom command \
				instead of inserting the module in the kernel as normal, so the module will \
				always fail to load.",
				format!("Blacklist: {module_name}"), Symbol::SquareX),
			Self::Clear => Command::new(
				String::from("dmesg --clear"),
				"dmesg: Print or control the kernel ring buffer
				option: -C, --clear\n
				Clear the ring buffer.",
				String::from("Clear"), Symbol::Cloud),
        }
	}

	/// Check if module command is set.
	pub fn is_none(self) -> bool {
		self == Self::None
	}

	/// Check if module name is a filename with suffix 'ko'
	pub fn is_module_filename(module_name: &str) -> bool {
		match module_name.split('.').collect::<Vec<&str>>().last() {
			Some(v) => *v == "ko",
			None => false,
		}
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	#[test]
	fn test_module_command() {
		let module_command = ModuleCommand::None;
		assert!(module_command == ModuleCommand::None);

		assert_ne!("", ModuleCommand::None.get("test").title);
		assert_ne!("", ModuleCommand::Load.get("module").desc);
		assert_ne!("", ModuleCommand::Unload.get("!command").cmd);
		assert_ne!("", ModuleCommand::Blacklist.get("~").cmd);

		assert_eq!(
			"modprobe test-module || insmod test-module.ko",
			ModuleCommand::Load.get("test-module").cmd
		);
		assert_eq!(
			"insmod test-module.ko",
			ModuleCommand::Load.get("test-module.ko").cmd
		);

		assert_eq!(
			"modprobe -r test-module || rmmod test-module",
			ModuleCommand::Unload.get("test-module").cmd
		);
		assert_eq!(
			"modprobe -r test-module.ko || rmmod test-module.ko",
			ModuleCommand::Unload.get("test-module.ko").cmd
		);

		assert_eq!(
			format!(
				"{} && {}",
				ModuleCommand::Unload.get("test-module").cmd,
				ModuleCommand::Load.get("test-module").cmd
			),
			ModuleCommand::Reload.get("test-module").cmd,
		);

		assert_eq!(
			format!(
				"{} && {}",
				ModuleCommand::Unload.get("test-module.ko").cmd,
				ModuleCommand::Load.get("test-module.ko").cmd
			),
			ModuleCommand::Reload.get("test-module.ko").cmd,
		);
	}
}