feat: support custom oma plugin as subcommand (#534)

* feat: support custom oma plugin as subcommand

* feat: add localisation for subcmd-related strings

---------

Co-authored-by: Mingcong Bai <[email protected]>

Author: eatradish

Cargo.lock

@@ -10,7 +10,7 @@ authors = ["eatradish <[email protected]>"]
 
 [dependencies]
 # Cli
-clap = { version = "4.5.19", features = ["cargo", "wrap_help", "color", "derive", "env"] }
+clap = { version = "4.5.19", features = ["cargo", "wrap_help", "color", "derive", "env", "string"] }
 anyhow = "1.0.89"
 ctrlc = "3.4.5"
 dialoguer = "0.12.0"
@@ -51,6 +51,7 @@ termtree = "0.5.1"
 textwrap = "0.16.2"
 sysinfo = "0.37"
 once_cell = "1.21"
+itertools = "0.14.0"
 
 # oma crates
 oma-utils = { path = "./oma-utils", features = ["dbus", "human-bytes", "oma"] }

Cargo.toml

@@ -297,3 +297,6 @@ not-allow-delete-using-kernel = Not allow deletion of the Linux kernel version i
 yes-mode-conflict-ui = `--yes` mode will not be applied in UI mode.
 oma-refresh-no-metadata-to-download = No suitable package metadata available based on your repository configuration.
 delete-current-kernel-tips = { $kernel } is currently in use, removing it may render the system inoperable.
+custom-command-unknown = Unknown command: `{ $subcmd }'.
+custom-command-applet-exec = Executing custom command oma-{ $subcmd } ...
+custom-command-applet-exception = Custom command exited with error { $s }.

i18n/en-US/oma.ftl

@@ -290,3 +290,6 @@ not-allow-delete-using-kernel = 不允许删除正在使用的 Linux 内核版
 yes-mode-conflict-ui = UI 模式下将不会应用 `--yes` 模式。
 oma-refresh-no-metadata-to-download = 源配置中没有适用的软件包元数据。
 delete-current-kernel-tips = { $kernel } 为正在使用的内核，移除后可能导致系统无法工作。
+custom-command-unknown = 未知命令：`{ $subcmd }'。
+custom-command-applet-exec = 正在执行自定义命令 oma-{ $subcmd } ...
+custom-command-applet-exception = 自定义命令异常退出，错误码：{ $s }。

i18n/zh-CN/oma.ftl

@@ -1,7 +1,8 @@
-use std::env;
+use std::{env, ffi::OsStr, path::Path};
 
-use clap::{Args, Parser, Subcommand, crate_name, crate_version};
+use clap::{Arg, Args, Command, Parser, Subcommand, crate_name, crate_version};
 use enum_dispatch::enum_dispatch;
+use itertools::Itertools;
 
 use crate::{
     GlobalOptions,
@@ -42,7 +43,15 @@ pub(crate) trait CliExecuter {
 }
 
 #[derive(Parser, Debug)]
-#[command(version, about, long_about = None, disable_version_flag = true, max_term_width = 80, after_help = after_help())]
+#[command(
+    version,
+    about,
+    long_about = None,
+    disable_version_flag = true,
+    max_term_width = 80,
+    after_help = after_help(),
+    subcommands = custom_subcmds()
+)]
 pub struct OhManagerAilurus {
     #[command(flatten)]
     pub global: GlobalOptions,
@@ -152,6 +161,58 @@ fn after_help() -> &'static str {
     }
 }
 
+fn custom_subcmds() -> Vec<Command> {
+    let plugins = list_helpers();
+    if let Ok(plugins) = plugins {
+        plugins
+            .iter()
+            .map(|plugin| {
+                let name = plugin.strip_prefix("oma-").unwrap_or("???");
+                Command::new(name.to_string())
+                    .arg(
+                        Arg::new("COMMANDS")
+                            .required(false)
+                            .num_args(1..)
+                            .help("Applet specific commands"),
+                    )
+                    .about("")
+            })
+            .collect()
+    } else {
+        vec![]
+    }
+}
+
+fn list_helpers() -> Result<Vec<String>, anyhow::Error> {
+    let mut plugins_dir: Box<dyn Iterator<Item = _>> =
+        Box::new(Path::new("/usr/libexec").read_dir()?);
+
+    let plugins_local_dir = Path::new("/usr/local/libexec").read_dir();
+
+    if let Ok(plugins_local_dir) = plugins_local_dir {
+        plugins_dir = Box::new(plugins_dir.chain(plugins_local_dir));
+    }
+
+    let plugins = plugins_dir
+        .filter_map(|x| {
+            if let Ok(x) = x {
+                let path = x.path();
+                let filename = path
+                    .file_name()
+                    .unwrap_or_else(|| OsStr::new(""))
+                    .to_string_lossy();
+                if path.is_file() && filename.starts_with("oma-") {
+                    return Some(filename.to_string());
+                }
+            }
+            None
+        })
+        .unique()
+        .collect();
+
+    Ok(plugins)
+}
+
 #[test]
 fn test() {
     use clap::CommandFactory;

src/args.rs

@@ -4,7 +4,7 @@ use std::fs::{create_dir_all, read_dir, remove_file};
 use std::io::{self, IsTerminal, stderr, stdin};
 use std::path::{Path, PathBuf};
 
-use std::process::exit;
+use std::process::{Command, exit};
 use std::sync::{LazyLock, OnceLock};
 use std::thread;
 use std::time::{Duration, SystemTime, UNIX_EPOCH};
@@ -23,7 +23,7 @@ mod utils;
 
 use args::{CliExecuter, OhManagerAilurus, print_version};
 use clap::builder::FalseyValueParser;
-use clap::{ArgAction, Args, ColorChoice, CommandFactory, Parser};
+use clap::{ArgAction, ArgMatches, Args, ColorChoice, CommandFactory, FromArgMatches};
 use clap_complete::CompleteEnv;
 use error::OutputError;
 use i18n_embed::{DesktopLanguageRequester, Localizer};
@@ -152,7 +152,8 @@ fn main() {
 
     ctrlc::set_handler(single_handler).expect("oma could not initialize SIGINT handler.");
 
-    let oma = OhManagerAilurus::parse();
+    // 要适配额外的插件子命令，所以这里要保留 matches
+    let (matches, oma) = parse_args();
 
     if oma.global.version {
         print_version();
@@ -185,7 +186,7 @@ fn main() {
         }
     }
 
-    let code = match try_main(oma, &config) {
+    let code = match try_main(oma, config, matches) {
         Ok(exit_code) => {
             unlock_oma().ok();
             exit_code
@@ -208,6 +209,19 @@ fn main() {
     exit(code);
 }
 
+fn parse_args() -> (ArgMatches, OhManagerAilurus) {
+    let matches = OhManagerAilurus::command().get_matches();
+    let oma = match OhManagerAilurus::from_arg_matches(&matches).map_err(|e| {
+        let mut cmd = OhManagerAilurus::command();
+        e.format(&mut cmd)
+    }) {
+        Ok(oma) => oma,
+        Err(e) => e.exit(),
+    };
+
+    (matches, oma)
+}
+
 fn init_localizer() {
     let localizer = crate::lang::localizer();
     let requested_languages = DesktopLanguageRequester::requested_languages();
@@ -371,15 +385,47 @@ fn enable_ansi(oma: &OhManagerAilurus) -> bool {
         || oma.global.color == ColorChoice::Always
 }
 
-fn try_main(oma: OhManagerAilurus, config: &Config) -> Result<i32, OutputError> {
-    init_color_formatter(&oma, config);
+fn try_main(
+    oma: OhManagerAilurus,
+    config: Config,
+    matches: ArgMatches,
+) -> Result<i32, OutputError> {
+    init_color_formatter(&oma, &config);
 
     let no_progress =
         oma.global.no_progress || !is_terminal() || oma.global.debug || oma.global.dry_run;
 
     let code = match oma.subcmd {
-        Some(subcmd) => subcmd.execute(config, no_progress),
-        None => Tui::from(&oma.global).execute(config, no_progress),
+        Some(subcmd) => subcmd.execute(&config, no_progress),
+        None => {
+            if let Some((subcommand, args)) = matches.subcommand() {
+                let mut plugin = Path::new("/usr/local/libexec").join(format!("oma-{subcommand}"));
+                let plugin_fallback = Path::new("/usr/libexec").join(format!("oma-{subcommand}"));
+
+                if !plugin.is_file() {
+                    plugin = plugin_fallback;
+                    if !plugin.is_file() {
+                        error!("{}", fl!("custom-command-unknown", subcmd = subcommand));
+                        return Ok(1);
+                    }
+                }
+
+                info!("{}", fl!("custom-command-applet-exec", subcmd = subcommand));
+                let mut process = &mut Command::new(plugin);
+                if let Some(args) = args.get_many::<String>("COMMANDS") {
+                    process = process.args(args);
+                }
+
+                let status = process.status().unwrap().code().unwrap();
+                if status != 0 {
+                    error!("{}", fl!("custom-command-applet-exception", s = status));
+                }
+
+                Ok(status)
+            } else {
+                Tui::from(&oma.global).execute(&config, no_progress)
+            }
+        }
     };
 
     if !oma.global.no_bell && config.bell() {