feat: add support for custom compression options

Signed-off-by: eXhumer <[email protected]>

.github/workflows/rust.yml

@@ -40,7 +40,7 @@ jobs:
     outputs:
       version: ${{ steps.version.outputs.version }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Rust cache for ${{ matrix.platform.release_for }}
         uses: Swatinem/rust-cache@v2
@@ -58,7 +58,7 @@ jobs:
           strip: true
 
       - name: Upload binary
-        uses: actions/upload-artifact@v3.1.2
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.platform.name }}
           path: target/${{ matrix.platform.target }}/release/decky
@@ -70,7 +70,7 @@ jobs:
       contents: write
     if: github.event_name != 'pull_request'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Grab version
         id: version
@@ -79,7 +79,7 @@ jobs:
           echo "Version code is $version"
           echo "version=$version" >> $GITHUB_OUTPUT
 
-      - uses: actions/download-artifact@v4.1.7
+      - uses: actions/download-artifact@v4
         with:
           path: artifacts
 

Cargo.toml

@@ -22,6 +22,6 @@ sha2 = "0.10.7"
 tokio = { version = "1.24.2", features = ["full"] }
 users = "0.11.0"
 walkdir = "2.3.2"
-zip = { version = "0.6.3", default-features = false }
+zip = { version = "0.6.3", default-features = false, features = ["deflate"] }
 which = "4.4.0"
 dirs = "5"

src/cli/mod.rs

@@ -27,6 +27,12 @@ impl ContainerEngine {
 }
 
 
+#[derive(clap::ValueEnum, Clone)]
+pub enum CompressMethod {
+    Deflate,
+    Store,
+}
+
 #[derive(Subcommand)]
 pub enum Command {
     Plugin(PluginCLI),
@@ -70,6 +76,12 @@ pub enum PluginCommand {
 
         #[arg(short = 'e', long = "engine", default_value = "docker")]
         container_engine: ContainerEngine,
+
+        #[arg(short = 'm', long, default_value = "store")]
+        compression_method: CompressMethod,
+
+        #[arg(short = 'l', long)]
+        compression_level: Option<i32>,
     },
     New,
     Deploy {
@@ -94,6 +106,12 @@ pub enum PluginCommand {
         #[arg(short = 'e', long = "engine", default_value = "docker")]
         container_engine: ContainerEngine,
 
+        #[arg(short = 'm', long, default_value = "store")]
+        compression_method: CompressMethod,
+
+        #[arg(short = 'l', long)]
+        compression_level: Option<i32>,
+
         #[arg(short = 'S', long, default_value = "true")]
         follow_symlinks: bool,
 

src/cli/plugin/build.rs

@@ -14,10 +14,10 @@ use std::{
     path::{Path, PathBuf},
 };
 use walkdir::WalkDir;
-use zip::{write::FileOptions, ZipWriter};
+use zip::{write::FileOptions, CompressionMethod, ZipWriter};
 
 use crate::{
-    cli::{FilenameSource, ContainerEngine},
+    cli::{CompressMethod, ContainerEngine, FilenameSource},
     container_engine,
     plugin::{CustomBackend, Plugin},
 };
@@ -35,6 +35,8 @@ pub struct Builder {
     pub follow_symlinks: bool,
     pub output_filename_source: FilenameSource,
     pub container_engine: ContainerEngine,
+    pub compression_method: CompressMethod,
+    pub compression_level: Option<i32>,
 }
 
 impl Builder {
@@ -216,7 +218,7 @@ impl Builder {
         filename: &str,
         path: PathBuf,
         zip: &mut ZipWriter<File>,
-        perms: FileOptions,
+        opts: FileOptions,
     ) -> Result<()> {
         let name = path
             .strip_prefix(&self.tmp_build_root)
@@ -233,11 +235,22 @@ impl Builder {
         if path.is_file() {
             let bytes = std::fs::read(&path).unwrap();
 
-            zip.start_file(name.to_str().unwrap(), perms)?;
+            let method = match self.compression_method {
+                CompressMethod::Deflate => CompressionMethod::Deflated,
+                CompressMethod::Store => CompressionMethod::Stored,
+            };
+
+            let mut opts = opts.compression_method(method);
+
+            if method == CompressionMethod::Deflated && self.compression_level.is_some() {
+                opts = opts.compression_level(Some(self.compression_level.unwrap()));
+            }
+
+            zip.start_file(name.to_str().unwrap(), opts)?;
 
             zip.write_all(&bytes)?;
         } else if !name.as_os_str().is_empty() {
-            zip.add_directory(name.to_str().unwrap(), perms)?;
+            zip.add_directory(name.to_str().unwrap(), opts)?;
         }
 
         Ok(())
@@ -395,6 +408,8 @@ impl Builder {
         follow_symlinks: bool,
         output_filename_source: FilenameSource,
         container_engine: ContainerEngine,
+        compression_method: CompressMethod,
+        compression_level: Option<i32>,
     ) -> Result<Self> {
         if !output_root.exists() {
             std::fs::create_dir(&output_root)?;
@@ -421,6 +436,8 @@ impl Builder {
             follow_symlinks,
             output_filename_source,
             container_engine,
+            compression_method,
+            compression_level,
         })
     }
 }

src/cli/plugin/deploy.rs

@@ -7,6 +7,7 @@ use log::info;
 use rand::distributions::{Alphanumeric, DistString};
 
 use crate::cli::plugin::build::Builder;
+use crate::cli::CompressMethod;
 use crate::plugin::DeckFile;
 use crate::{cli::FilenameSource, cli::ContainerEngine, plugin::Plugin};
 
@@ -231,6 +232,8 @@ impl Deployer {
         follow_symlinks: bool,
         output_filename_source: FilenameSource,
         container_engine: ContainerEngine,
+        compression_method: CompressMethod,
+        compression_level: Option<i32>,
         deck_ip: Option<String>,
         deck_port: Option<String>,
         deck_pass: Option<String>,
@@ -248,6 +251,8 @@ impl Deployer {
             follow_symlinks,
             output_filename_source,
             container_engine,
+            compression_method,
+            compression_level,
         )
         .expect("Could not create builder");
 

src/cli/plugin/mod.rs

@@ -14,7 +14,9 @@ pub async fn parse(args: &PluginCLI) -> Result<()> {
             build_with_dev,
             follow_symlinks,
             output_filename_source,
-            container_engine
+            container_engine,
+            compression_method,
+            compression_level,
         } => {
             build::Builder::new(
                 plugin_path.into(),
@@ -25,6 +27,8 @@ pub async fn parse(args: &PluginCLI) -> Result<()> {
                 follow_symlinks.clone(),
                 output_filename_source.clone(),
                 container_engine.clone(),
+                compression_method.clone(),
+                compression_level.clone(),
             )?
             .run()
             .await
@@ -44,6 +48,8 @@ pub async fn parse(args: &PluginCLI) -> Result<()> {
             deck_pass,
             deck_key,
             deck_dir,
+            compression_method,
+            compression_level,
         } => {
             deploy::Deployer::new(
                 plugin_path.into(),
@@ -54,6 +60,8 @@ pub async fn parse(args: &PluginCLI) -> Result<()> {
                 follow_symlinks.clone(),
                 output_filename_source.clone(),
                 container_engine.clone(),
+                compression_method.clone(),
+                compression_level.clone(),
                 deck_ip.clone(),
                 deck_port.clone(),
                 deck_pass.clone(),