file: 增加 set_download_process 函数，可设置是否显示下载进度

Signed-off-by: Jia Chao <jiac13@chinaunicom.cn>

Cargo.toml

@@ -18,3 +18,4 @@ reqwest = { version = "0.12", features = ["stream"] }
 tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
 tracing = { version = "0.1" }
 tracing-subscriber = { version = "0.3", features = ["env-filter", "local-time"] }
+uuid = { version = "1", features = ["v4"] }

src/file.rs

@@ -1,13 +1,115 @@
+use std::env;
+use std::fs;
 use std::path::{Path, PathBuf};
-use tokio::fs::{File, OpenOptions};
-use tokio::io::{AsyncSeekExt, AsyncWriteExt, SeekFrom};
 
 use futures_util::StreamExt;
 use indicatif::{ProgressBar, ProgressStyle};
 use path_absolutize::Absolutize;
 use reqwest::Client;
+use tokio::fs::{File, OpenOptions};
+use tokio::io::{AsyncSeekExt, AsyncWriteExt, SeekFrom};
 use tracing::{debug, info};
 
+use crate::util::uuid;
+
+/// 返回一个临时目录路径，可指定是否立即创建其路径。
+///
+/// 该函数生成一个基于系统临时目录的新目录路径，并根据 `create` 参数决定是否创建该目录。
+/// 生成的路径包含一个唯一标识符，以确保每次调用都生成不同的目录。
+///
+/// # 参数
+/// - `create`: 一个布尔值，如果为 `true`，则创建目录。
+///
+/// # 返回值
+/// 返回一个包含生成路径的 `Result` 类型。如果 `create` 为 `true` 且目录创建失败，则返回错误信息。
+///
+/// # 示例
+/// ```rust
+/// let temp_dir_path = temp_dir(true)?;
+/// println!("Temporary directory path: {:?}", temp_dir_path);
+/// ```
+pub fn temp_dir(create: bool) -> crate::Result<PathBuf> {
+    // 获取系统临时目录路径并添加一个唯一标识符
+    let mut path = PathBuf::from(env::temp_dir());
+    path.push(uuid());
+    // 如果 `create` 为 `true`，则创建该目录
+    if create {
+        fs::create_dir(&path)?;
+        debug!("create temp_dir: {}", &path.to_str().unwrap());
+    }
+    // 返回生成的路径
+    Ok(path)
+}
+
+/// 遍历目录并返回包含所有文件路径的向量。
+///
+/// 该函数递归遍历给定路径下的所有文件和目录，并将其路径存储在一个向量中返回。
+/// 如果 `nodir` 参数为 `true`，则不会将目录路径添加到结果中。
+///
+/// # 参数
+/// - `path`: 要遍历的目录路径。
+/// - `nodir`: 一个布尔值，如果为 `true`，则不会将目录路径添加到结果中。
+///
+/// # 返回值
+/// 返回一个包含所有文件和（可选）目录路径的向量。
+///
+/// # 示例
+/// ```rust
+/// let files = walk_dir("/path/to/dir", true);
+/// for file in files {
+///     println!("{:?}", file);
+/// }
+/// ```
+pub fn walk_dir<P: AsRef<Path>>(path: P, nodir: bool) -> Vec<PathBuf> {
+    // 创建一个存储结果的向量
+    let mut res = vec![];
+    // 遍历给定路径下的所有条目
+    for entry in std::fs::read_dir(path).expect("read_dir call failed!") {
+        // 获取条目的路径
+        let entry = entry.unwrap().path();
+        // 如果条目是目录
+        if entry.is_dir() {
+            // 如果 `nodir` 为 `false`，则将目录路径添加到结果中
+            if !nodir {
+                res.push(entry.clone());
+            }
+            // 递归遍历目录并将结果添加到当前结果中
+            res.append(&mut walk_dir(entry, nodir));
+        } else {
+            // 如果条目是文件，则将其路径添加到结果中
+            res.push(entry);
+        }
+    }
+    // 返回包含所有文件和（可选）目录路径的向量
+    res
+}
+
+/// 设置或清除下载进程的环境变量 `CCUTIL_DOWNLOAD_PROCESS`。在使用 `download` 和 `async_download`
+/// 函数时，会根据是否设置此变量来显示或隐藏下载进度。
+///
+/// # 参数
+///
+/// - `with_process`: 一个布尔值，指示是否要设置下载进程环境变量。
+///
+/// # 示例
+///
+/// ```rust
+/// // 设置下载进程环境变量
+/// set_download_process(true);
+///
+/// // 清除下载进程环境变量
+/// set_download_process(false);
+/// ```
+pub fn set_download_process(with_process: bool) {
+    if with_process {
+        // 设置环境变量为字符串 "1"
+        env::set_var("CCUTIL_DOWNLOAD_PROCESS", "1");
+    } else {
+        // 清除环境变量
+        env::remove_var("CCUTIL_DOWNLOAD_PROCESS");
+    }
+}
+
 /// 从给定的 URL 下载文件并将其保存到指定的目标路径。
 ///
 /// 该函数初始化一个异步运行时，并阻塞在异步下载函数上，直到下载完成。
@@ -31,7 +133,7 @@ use tracing::{debug, info};
 ///
 /// # 备注
 /// `crate::async_runtime` 函数是一个辅助函数，用于返回一个异步运行时的引用。`async_download` 函数是执行实际异步下载过程的实现。
-pub fn download<P: AsRef<Path>>(url: &str, target: Option<P>) -> crate::Result<()> {
+pub fn download<P: AsRef<Path>>(url: String, target: Option<P>) -> crate::Result<()> {
     // 使用库中的辅助函数初始化异步运行时。
     let rt = crate::async_runtime()?;
     // 阻塞在异步下载函数上，直到下载完成。
@@ -63,12 +165,17 @@ pub fn download<P: AsRef<Path>>(url: &str, target: Option<P>) -> crate::Result<(
 ///
 /// # 备注
 /// 使用 `Client` 进行 HTTP 请求，`OpenOptions` 和 `File` 进行文件操作，支持断点续传。
-pub async fn async_download<P: AsRef<Path>>(url: &str, target: Option<P>) -> crate::Result<()> {
+pub async fn async_download<P: AsRef<Path>>(url: String, target: Option<P>) -> crate::Result<()> {
     debug!("Download url: {}", url);
     // 创建一个新的 HTTP 客户端
     let client = Client::new();
     // 发送 GET 请求获取响应
-    let response = client.get(url).send().await?;
+    let response = client.get(url.clone()).send().await?;
+
+    // 检查连接状态，失败会返回错误
+    if !response.status().is_success() {
+        return Err(format!("下载 {} 失败：{}", url, response.status()).into());
+    }
 
     // 确定下载文件的路径
     let download_file = match target {
@@ -82,7 +189,7 @@ pub async fn async_download<P: AsRef<Path>>(url: &str, target: Option<P>) -> cra
         }
         None => {
             // 如果未指定目标路径，则使用 URL 的文件名
-            let _remote = Path::new(url);
+            let _remote = Path::new(&url);
             let _local = match _remote.file_name() {
                 Some(file) => file,
                 None => return Err("无效的文件名！".into()),
@@ -127,11 +234,17 @@ pub async fn async_download<P: AsRef<Path>>(url: &str, target: Option<P>) -> cra
 
     // 设置下载进度条
     let pb = ProgressBar::new(total_size);
-    pb.set_style(
-        ProgressStyle::default_bar()
-            .template("{spinner:.green} [{elapsed_precise}] [{wide_bar:.cyan/blue}] {bytes}/{total_bytes} ({bytes_per_sec}, {eta_precise})").unwrap()
-            .progress_chars("#>-"),
-    );
+    let with_process = match env::var("CCUTIL_DOWNLOAD_PROCESS") {
+        Ok(_) => {
+            pb.set_style(
+                ProgressStyle::default_bar()
+                    .template("{spinner:.green} [{elapsed_precise}] [{wide_bar:.cyan/blue}] {bytes}/{total_bytes} ({bytes_per_sec}, {eta_precise})").unwrap()
+                    .progress_chars("#>-"),
+            );
+            true
+        }
+        Err(_) => false,
+    };
 
     // 读取响应数据并写入文件
     while let Some(chunk) = stream.next().await {
@@ -140,7 +253,9 @@ pub async fn async_download<P: AsRef<Path>>(url: &str, target: Option<P>) -> cra
         current_size += chunk.len() as u64;
 
         // 更新下载进度
-        pb.set_position(current_size);
+        if with_process {
+            pb.set_position(current_size);
+        }
     }
 
     Ok(())

src/lib.rs

@@ -1,6 +1,9 @@
 use tokio::runtime::Runtime;
 use tracing_subscriber::{fmt, EnvFilter};
 
+/// 放置了一些基础的函数集合
+pub mod util;
+
 /// 包含了一些常用的文件操作函数
 pub mod file;
 

src/util.rs

@@ -0,0 +1,20 @@
+use uuid::Uuid;
+
+/// 生成一个新的 UUID。
+///
+/// 该函数使用 `Uuid` 库生成一个新的版本 4 UUID，并将其转换为字符串格式返回。
+///
+/// # 返回值
+/// 返回一个包含生成的 UUID 的字符串。
+///
+/// # 示例
+/// ```rust
+/// let new_uuid = uuid();
+/// println!("Generated UUID: {}", new_uuid);
+/// ```
+pub fn uuid() -> String {
+    // 生成一个新的版本 4 UUID
+    let uuid = Uuid::new_v4();
+    // 将 UUID 转换为字符串并返回
+    uuid.to_string()
+}