feat(oma-pm)!: add --download-only option (#586)

eatradish · web-flow · commit 1a449900e26d · 2025-10-09T15:00:40.000+08:00
diff --git a/i18n/en-US/oma.ftl b/i18n/en-US/oma.ftl
@@ -426,3 +426,4 @@ clap-mark-hold = Lock package version(s), this will prevent the specified packag
 clap-mark-unhold = Unlock package version(s), this will undo the “hold” status on the specified package(s)
 clap-mark-manual = Mark package(s) as manually installed, this will prevent the specified package(s) from being removed when all reverse dependencies were removed
 clap-mark-auto = Mark package(s) as automatically installed, this will mark the specified package(s) for removal when all reverse dependencies were removed
+clap-download-only-help = Only download package(s) and dependency(ies) (without installing)
diff --git a/i18n/zh-CN/oma.ftl b/i18n/zh-CN/oma.ftl
@@ -417,3 +417,4 @@ clap-mark-unhold = 解锁软件包版本，这将撤销指定软件包的 "保
 clap-mark-manual = 将软件包标记为手动安装、 这将防止指定软件包在所有逆向依赖关系被移除后被移除
 clap-mark-auto = 将软件包标记为自动安装，这将标记指定软件包在所有逆向依赖关系被移除后被移除
 yes-mode-conflict-ui = 在 UI 模式下 `--yes` 模式将不启用。
+clap-download-only-help = 只下载软件包和其依赖项，不安装
diff --git a/oma-pm/examples/install_fish.rs b/oma-pm/examples/install_fish.rs
@@ -5,7 +5,7 @@ use flume::unbounded;
 use oma_apt::util::{get_apt_progress_string, terminal_height, terminal_width};
 use oma_fetch::{Event, reqwest::ClientBuilder};
 use oma_pm::{
-    CommitNetworkConfig,
+    CommitConfig,
     apt::{AptConfig, InstallProgressOpt, OmaApt, OmaAptArgs, OmaAptError},
     matches::PackagesMatcher,
     progress::InstallProgressManager,
@@ -124,9 +124,10 @@ fn main() -> Result<(), OmaAptError> {
         InstallProgressOpt::TermLike(Box::new(MyInstallProgressManager)),
         &op,
         &client,
-        CommitNetworkConfig {
+        CommitConfig {
             network_thread: None,
             auth_config: Some(&AuthConfig::system("/").unwrap()),
+            download_only: false,
         },
         None,
         async |event| {
diff --git a/oma-pm/src/apt.rs b/oma-pm/src/apt.rs
@@ -36,7 +36,7 @@ pub use oma_pm_operation_type::*;
 use zbus::Connection;
 
 use crate::{
-    commit::{CommitNetworkConfig, CustomDownloadMessage, DoInstall},
+    commit::{CommitConfig, CustomDownloadMessage, DoInstall},
     dbus::create_session,
     download::download_pkgs,
     matches::MatcherError,
@@ -586,7 +586,7 @@ impl OmaApt {
         install_progress_manager: InstallProgressOpt,
         op: &OmaOperation,
         client: &Client,
-        config: CommitNetworkConfig,
+        config: CommitConfig,
         custom_download_message: Option<CustomDownloadMessage>,
         callback: impl AsyncFn(Event),
     ) -> OmaAptResult<()> {
diff --git a/oma-pm/src/commit.rs b/oma-pm/src/commit.rs
@@ -21,16 +21,17 @@ use crate::{
 
 const TIME_FORMAT: &str = "%H:%M:%S on %Y-%m-%d";
 
-pub struct CommitNetworkConfig<'a> {
+pub struct CommitConfig<'a> {
     pub network_thread: Option<usize>,
     pub auth_config: Option<&'a AuthConfig>,
+    pub download_only: bool,
 }
 
 pub struct DoInstall<'a> {
     apt: OmaApt,
     client: &'a Client,
     sysroot: &'a str,
-    config: CommitNetworkConfig<'a>,
+    config: CommitConfig<'a>,
 }
 
 pub type CustomDownloadMessage = Box<dyn Fn(&InstallEntry) -> Cow<'static, str>>;
@@ -40,7 +41,7 @@ impl<'a> DoInstall<'a> {
         apt: OmaApt,
         client: &'a Client,
         sysroot: &'a str,
-        config: CommitNetworkConfig<'a>,
+        config: CommitConfig<'a>,
     ) -> Result<Self, OmaAptError> {
         Ok(Self {
             apt,
@@ -63,7 +64,9 @@ impl<'a> DoInstall<'a> {
             return Err(OmaAptError::FailedToDownload(summary.failed.len()));
         }
 
-        self.do_install(install_progress_manager, op)?;
+        if !self.config.download_only {
+            self.do_install(install_progress_manager, op)?;
+        }
 
         Ok(())
     }
diff --git a/oma-pm/src/lib.rs b/oma-pm/src/lib.rs
@@ -39,7 +39,7 @@ mod commit;
 mod dbus;
 mod download;
 pub mod utils;
-pub use commit::CommitNetworkConfig;
+pub use commit::CommitConfig;
 pub mod sort;
 pub use apt_auth_config;
 pub use commit::CustomDownloadMessage;
diff --git a/src/subcommand/history.rs b/src/subcommand/history.rs
@@ -95,6 +95,9 @@ pub struct Undo {
     /// Remove package(s) also remove configuration file(s), like apt purge
     #[arg(long, visible_alias = "purge", help = fl!("clap-remove-config-help"))]
     remove_config: bool,
+    /// Only download dependencies, not install
+    #[arg(long, short, help = fl!("clap-download-only-help"))]
+    download_only: bool,
     /// Run oma in "dry-run" mode. Useful for testing changes and operations without making changes to the system
     #[arg(from_global, help = fl!("clap-dry-run-help"), long_help = fl!("clap-dry-run-long-help"))]
     dry_run: bool,
@@ -147,6 +150,7 @@ impl CliExecuter for Undo {
             no_refresh_topics,
             no_check_battery,
             no_take_wake_lock,
+            download_only,
         } = self;
 
         lock_oma(&sysroot)?;
@@ -303,6 +307,7 @@ impl CliExecuter for Undo {
             .autoremove(autoremove)
             .network_thread(download_threads.unwrap_or_else(|| config.network_thread()))
             .maybe_auth_config(auth_config.as_ref())
+            .download_only(download_only)
             .build()
             .run()?;
 
diff --git a/src/subcommand/install.rs b/src/subcommand/install.rs
@@ -97,6 +97,9 @@ pub struct Install {
     /// Auto remove unnecessary package(s)
     #[arg(long, help = fl!("clap-autoremove-help"))]
     autoremove: bool,
+    /// Only download dependencies, not install
+    #[arg(long, short, help = fl!("clap-download-only-help"))]
+    download_only: bool,
     /// Remove package(s) also remove configuration file(s), like apt purge
     #[arg(long, visible_alias = "purge", help = fl!("clap-remove-config-help"))]
     remove_config: bool,
@@ -139,6 +142,7 @@ impl CliExecuter for Install {
             download_threads,
             no_check_battery,
             no_take_wake_lock,
+            download_only,
         } = self;
 
         if !dry_run {
@@ -245,6 +249,7 @@ impl CliExecuter for Install {
             .network_thread(download_threads.unwrap_or_else(|| config.network_thread()))
             .maybe_auth_config(auth_config)
             .fix_dpkg_status(!no_fix_dpkg_status)
+            .download_only(download_only)
             .build()
             .run()
     }
diff --git a/src/subcommand/pick.rs b/src/subcommand/pick.rs
@@ -57,6 +57,9 @@ pub struct Pick {
     /// Remove package(s) also remove configuration file(s), like apt purge
     #[arg(long, visible_alias = "purge", help = fl!("clap-remove-config-help"))]
     remove_config: bool,
+    /// Only download dependencies, not install
+    #[arg(long, short, help = fl!("clap-download-only-help"))]
+    download_only: bool,
     /// Run oma in "dry-run" mode. Useful for testing changes and operations without making changes to the system
     #[arg(from_global, help = fl!("clap-dry-run-help"), long_help = fl!("clap-dry-run-long-help"))]
     dry_run: bool,
@@ -101,6 +104,7 @@ impl CliExecuter for Pick {
             download_threads,
             no_check_battery,
             no_take_wake_lock,
+            download_only,
         } = self;
 
         if !dry_run {
@@ -231,6 +235,7 @@ impl CliExecuter for Pick {
             .autoremove(autoremove)
             .network_thread(download_threads.unwrap_or_else(|| config.network_thread()))
             .maybe_auth_config(auth_config)
+            .download_only(download_only)
             .build()
             .run()
     }
diff --git a/src/subcommand/topics.rs b/src/subcommand/topics.rs
@@ -82,6 +82,9 @@ pub struct Topics {
     /// Remove package(s) also remove configuration file(s), like apt purge
     #[arg(long, visible_alias = "purge", help = fl!("clap-remove-config-help"))]
     remove_config: bool,
+    /// Only download dependencies, not install
+    #[arg(long, short, help = fl!("clap-download-only-help"))]
+    download_only: bool,
     /// Run oma in "dry-run" mode. Useful for testing changes and operations without making changes to the system
     #[arg(from_global, help = fl!("clap-dry-run-help"), long_help = fl!("clap-dry-run-long-help"))]
     dry_run: bool,
@@ -167,6 +170,7 @@ impl CliExecuter for Topics {
             no_take_wake_lock,
             only_apply_sources_list,
             yes,
+            download_only,
         } = self;
 
         if !dry_run {
@@ -348,6 +352,7 @@ impl CliExecuter for Topics {
                 .check_tum(true)
                 .topics_enabled(opt_in)
                 .topics_disabled(opt_out)
+                .download_only(download_only)
                 .build()
                 .run()?;
 
@@ -379,7 +384,7 @@ impl CliExecuter for Topics {
                 }
             }
             Err(e) => {
-                if !always_write_status {
+                if !always_write_status && !download_only {
                     error!("{}", fl!("topics-unchanged"));
                     revert_sources_list(&tm)?;
                     RT.block_on(tm.write_enabled(true))?;
diff --git a/src/subcommand/upgrade.rs b/src/subcommand/upgrade.rs
@@ -73,6 +73,9 @@ pub(crate) struct Upgrade {
     /// Do not allow removal of packages during upgrade (like `apt upgrade')
     #[arg(long, help = fl!("clap-no-remove-help"))]
     no_remove: bool,
+    /// Only download dependencies, not install
+    #[arg(long, short, help = fl!("clap-download-only-help"))]
+    download_only: bool,
     /// Run oma in "dry-run" mode. Useful for testing changes and operations without making changes to the system
     #[arg(from_global, help = fl!("clap-dry-run-help"), long_help = fl!("clap-dry-run-long-help"))]
     dry_run: bool,
@@ -120,6 +123,7 @@ impl CliExecuter for Upgrade {
             download_threads,
             no_check_battery,
             no_take_wake_lock,
+            download_only,
         } = self;
 
         if !dry_run {
@@ -236,6 +240,7 @@ impl CliExecuter for Upgrade {
             .network_thread(download_threads.unwrap_or_else(|| config.network_thread()))
             .maybe_auth_config(Some(&auth_config))
             .fix_dpkg_status(!no_fix_dpkg_status)
+            .download_only(download_only)
             .build()
             .run()?;
 
diff --git a/src/subcommand/utils.rs b/src/subcommand/utils.rs
@@ -63,7 +63,7 @@ use oma_history::HistoryInfo;
 use oma_history::connect_db;
 use oma_history::create_db_file;
 use oma_history::write_history_entry;
-use oma_pm::CommitNetworkConfig;
+use oma_pm::CommitConfig;
 use oma_pm::CustomDownloadMessage;
 use oma_pm::apt::AptConfig;
 use oma_pm::apt::InstallProgressOpt;
@@ -320,6 +320,8 @@ pub(crate) struct CommitChanges<'a> {
     topics_enabled: Vec<String>,
     #[builder(default)]
     topics_disabled: Vec<String>,
+    #[builder(default)]
+    download_only: bool,
 }
 
 impl CommitChanges<'_> {
@@ -342,6 +344,7 @@ impl CommitChanges<'_> {
             check_tum,
             topics_enabled,
             topics_disabled,
+            download_only,
         } = self;
 
         fix_broken(
@@ -440,9 +443,10 @@ impl CommitChanges<'_> {
             }),
             &op,
             &HTTP_CLIENT,
-            CommitNetworkConfig {
+            CommitConfig {
                 network_thread: Some(network_thread),
                 auth_config,
+                download_only,
             },
             download_message(),
             async |event| {
@@ -465,6 +469,20 @@ impl CommitChanges<'_> {
                     AptConfig::new(),
                 )?;
 
+                if download_only {
+                    space_tips(&apt, sysroot);
+
+                    let len = op.install.len();
+                    let path = apt.get_archive_dir().to_string_lossy();
+
+                    success!(
+                        "{}",
+                        fl!("successfully-download-to-path", len = len, path = path)
+                    );
+
+                    return Ok(0);
+                }
+
                 write_oma_installed_status(&apt, &sysroot)?;
 
                 autoremovable_tips(ar_count, ar_size);
@@ -488,6 +506,7 @@ impl CommitChanges<'_> {
 
                 history_success_tips(dry_run);
                 display_suggest_tips(suggest, recommend);
+
                 space_tips(&apt, sysroot);
 
                 Ok(0)
@@ -497,6 +516,10 @@ impl CommitChanges<'_> {
                     return Err(e.into());
                 }
 
+                if download_only {
+                    return Err(e.into());
+                }
+
                 let apt = OmaApt::new(
                     vec![],
                     OmaAptArgs::builder().build(),
