prepare for release v3.0.3

Author: javaLux

CHANGELOG.md

@@ -4,17 +4,31 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Released]
 
+## [3.0.3] - 2024-12-16
+- Performance optimizations
+- Refactoring
+- Update dependencies
+
+### Changed
+- Validation improvements of download command options
+  - filename validation => option `[-r, --rename]`
+  - output target validation => option `[-o, --output]`
+<br>
+
+
 ## [3.0.2] - 2024-12-11
 
-- optimization binary size => disable dependency default features
+- Optimized binary size => disable dependency default features
 - Bug fixing when comparing hash sums
+- Update dependencies
 
 ### Changed
 - Improve error messages
-- Update dependencies
 
 ### Added
 - Validation of a given hash sum, only a valid hexadecimal digit is accepted for the comparison
+<br>
+
 
 ## [3.0.1] - 2024-12-08
 
@@ -25,70 +39,85 @@ All notable changes to this project will be documented in this file. The format
 - Refactoring
 <br>
 
+
 ## [3.0.0] - 2024-11-08
 
+- Update dependencies
+
 ### Changed
 - the ``local`` subcommand now provides two options [`--file`, `--buffer`], the file path no longer needs to be specified via a separate argument
   - `--file` calculate a hash sum from a local file
   - `--buffer` calculate a hash sum from any given byte-buffer (e.g. String)
 - Refactoring
-- Update dependencies
 
 ### Added
 - Now the following hash algorithms are available:
   - SHA2-224
   - SHA2-384
 <br>
 
+
 ## [2.0.5] - 2024-08-22
 
+- Refactoring
+- Update dependencies
+
 ### Changed
 - Improve user and log error messages
 - Now ``chunked`` file downloads are supported
-- Refactoring
-- Update dependencies
 <br>
 
+
 ## [2.0.4] - 2024-06-11
 
+- Update dependencies
+
 ### Changed
 - Improvement of the URL validation for the ``download`` command, e.g. only the protocols ``http`` and ``https`` are supported
-- Update dependencies
 <br>
 
+
 ## [2.0.3] - 2024-05-13
 
+- Refactoring
+- Update dependencies
+
 ### Fixed
 - Bug fix for extracting filename from a specified URL if the ``Content-Disposition`` header not present
   - In the case that the specified URL contains query parameters (URL parameters) the filename could not extract correctly
   - This bug is fixed in this version
+<br>
+
+
+## [2.0.2] - 2024-05-02
 
-### Changed
 - Refactoring
 - Update dependencies
-<br>
 
-## [2.0.2] - 2024-05-02
 ### Added
 - Add a Signal handler for ``Ctrl_C``
 
 ### Changed
 - Improve user error messages
 - Improve debug log messages
-- Refactoring
-- Update dependencies
 <br>
 
+
 ## [2.0.1] - 2024-04-23
+
+- Update dependencies
+
 ### Security
 - Bump rustls from 0.22.2 to 0.22.4
   - ``rustls::ConnectionCommon::complete_io`` could fall into an infinite loop based on network input.
-
-### Changed
-- Update dependencies
 <br>
 
+
 ## [2.0.0] - 2024-03-02
+
+- Update dependencies
+- Refactoring
+
 ### Added
 - Implemented a panic handler to create a `Crash-Report.log` file in case of application crashes. This file contains information about the OS metadata and the crash, aiding in debugging and issue resolution.
 
@@ -102,14 +131,10 @@ All notable changes to this project will be documented in this file. The format
 - Bug fix that sometimes the correct file name could not be extracted when executing the ``Download`` command
   - Correctly extract filenames from redirect URLs
   - using the ``Content-Disposition`` HTTP-Header to extract filename
-
-### Changed
-- Update dependencies
-- Refactoring
 <br>
 
+
 ## [1.0.8] - 2023-12-12
-### Added
 
 ### Fixed
 - Bug fix that the absolute path was not displayed correctly under Windows
@@ -119,16 +144,20 @@ All notable changes to this project will be documented in this file. The format
 - improvement of error messages
 <br>
 
+
 ## [1.0.7] - 2023-12-10
-### Changed
+
 - Update dependencies
 - Refactoring
+
+### Changed
 - Improvement of the code base
 - Improvement of the user messages
 - Improvement of error handling - use [color-eyre](https://crates.io/crates/color-eyre) as error report handler
 - Add a new CLI-Option [-r, --rename] for the ``download`` command -> you can now specify a new file name for the file to be downloaded
 <br>
 
+
 ## [Unreleased]
 
 ## [1.0.6] - 2023-10-18

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "hashguard"
-version = "3.0.2"
+version = "3.0.3"
 edition = "2021"
 description = "Command-Line tool for ensuring the integrity of files using hash sums"
 authors = ["javaLux"]
@@ -20,7 +20,6 @@ clap = { version = "4.5.23", features = ["derive", "cargo", "string"] }
 color-eyre = "0.6.3"
 ctrlc = "3.4.5"
 indicatif = "0.17.9"
-lazy_static = "1.5.0"
 log = "0.4.22"
 os_info = { version = "3.9.0", default-features = false }
 output-coloring = "0.1.0"

Cargo.toml

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 javaLux
+Copyright (c) 2025 javaLux
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,12 +1,6 @@
 use clap::ValueEnum;
 use color_eyre::eyre::Result;
-use std::{
-    path::PathBuf,
-    sync::{
-        atomic::{AtomicBool, Ordering},
-        Arc,
-    },
-};
+use std::path::PathBuf;
 
 use crate::{panic_handling::PanicReport, utils};
 
@@ -18,11 +12,6 @@ pub const APP_INTERRUPTED_MSG: &str = concat!(
     " was interrupted by user..."
 );
 
-// App state -> controlled by the CtrlC-Handler
-lazy_static! {
-    pub static ref APP_SHOULD_RUN: Arc<AtomicBool> = Arc::new(AtomicBool::new(true));
-}
-
 /// Represents the possible application log level
 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum)]
 pub enum LogLevel {
@@ -112,14 +101,26 @@ pub fn initialize_logging(log_level: Option<LogLevel>) -> Result<()> {
     Ok(())
 }
 
-/// Register the application signal handler for Ctrl-C
+/// Register the application signal handler.<br>
+/// Listens for a termination signal (e.g., `Ctrl+C`) in a background thread to handle user-initiated<br>
+/// interruptions gracefully. If interrupted, the application will log the interruption and exit.
 pub fn set_ctrl_c_handler() -> Result<()> {
-    let ctr_c_command = || APP_SHOULD_RUN.store(false, Ordering::SeqCst);
-    match ctrlc::set_handler(ctr_c_command) {
+    let exit_cmd = || {
+        log::debug!("{} was interrupted by user...", APP_NAME);
+        println!("{}", APP_INTERRUPTED_MSG);
+        // terminate app
+        std::process::exit(1);
+    };
+
+    match ctrlc::set_handler(exit_cmd) {
         Ok(_) => Ok(()),
-        Err(handler_err) => Err(color_eyre::eyre::eyre!(handler_err)),
+        Err(handler_err) => Err(color_eyre::eyre::eyre!(format!(
+            "Failed to set Ctrl-C signal handler - {:?}",
+            handler_err
+        ))),
     }
 }
+
 /// Initializes the verbosity level for the Rust log output based on the specified LogLevel.
 ///
 /// If the provided log level is `LogLevel::Debug`, this function sets the environment

src/app.rs

@@ -4,6 +4,7 @@ use clap::{Args, Parser, Subcommand};
 
 use crate::{
     app::{version, LogLevel},
+    commands, filename_handling, os_specifics, utils,
     verify::Algorithm,
 };
 
@@ -35,7 +36,7 @@ pub struct DownloadArgs {
     /// URL to be used for download the file [required]
     pub url: String,
 
-    /// Origin hash sum of the file [optional]
+    /// Origin hash sum [optional]
     pub hash_sum: Option<String>,
 
     #[arg(
@@ -51,15 +52,17 @@ pub struct DownloadArgs {
         short,
         long,
         help = "A custom path for the file to be saved (Default is the user download folder)",
-        value_name = "DIR"
+        value_name = "DIR",
+        value_parser = validate_output_target
     )]
     pub output: Option<PathBuf>,
 
     #[arg(
         short,
         long,
         help = "Rename the file to be downloaded",
-        value_name = "FILE"
+        value_name = "FILE",
+        value_parser = check_file_name
     )]
     pub rename: Option<String>,
 }
@@ -71,7 +74,8 @@ pub struct LocalArgs {
         long,
         conflicts_with = "buffer",
         help = "Path to a file/dir for which the hash sum will be calculated",
-        value_name = "PATH"
+        value_name = "PATH",
+        value_parser = validate_hash_target
     )]
     pub path: Option<PathBuf>,
 
@@ -84,7 +88,7 @@ pub struct LocalArgs {
     )]
     pub buffer: Option<String>,
 
-    /// Origin hash sum of the file [optional]
+    /// Origin hash sum [optional]
     pub hash_sum: Option<String>,
 
     #[arg(
@@ -96,3 +100,41 @@ pub struct LocalArgs {
     )]
     pub algorithm: Algorithm,
 }
+
+/// Helper function to validate the option [-o, -output] of the download command
+fn validate_output_target(target: &str) -> Result<PathBuf, String> {
+    let path = PathBuf::from(target);
+    if !path.is_dir() {
+        let cmd_err = commands::CommandError::OutputTargetInvalid(utils::get_absolute_path(&path))
+            .to_string();
+        Err(cmd_err)
+    } else {
+        Ok(path)
+    }
+}
+
+/// Helper function to validate the option [-r, -rename] of the download command
+fn check_file_name(filename: &str) -> Result<String, String> {
+    // we can use safely `unwrap` because the os type was checked before parsing the cli arguments
+    let os_type = os_specifics::get_os().unwrap();
+    match filename_handling::validate_filename(&os_type, filename) {
+        Ok(_) => Ok(filename.to_string()),
+        Err(validate_err) => {
+            let cmd_err =
+                commands::CommandError::InvalidFilename(validate_err.to_string()).to_string();
+            Err(cmd_err)
+        }
+    }
+}
+
+/// Helper function to validate option [-p, -path] of the local command
+fn validate_hash_target(target: &str) -> Result<PathBuf, String> {
+    let path = PathBuf::from(target);
+    if !path.exists() {
+        let cmd_err =
+            commands::CommandError::PathNotExist(utils::get_absolute_path(&path)).to_string();
+        Err(cmd_err)
+    } else {
+        Ok(path)
+    }
+}

src/cli.rs

@@ -1,8 +1,6 @@
 use output_coloring::*;
 
 /// The templates for colored terminal output
-
-// These templates using a certain background color
 pub const INFO_TEMPLATE: ColoredTemplate = ColoredTemplate {
     ft_color: Color::White,
     bg_color: Some(Color::Green),