summaryrefslogtreecommitdiff
path: root/crates/vcs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/vcs')
-rw-r--r--crates/vcs/src/data/sheet.rs125
-rw-r--r--crates/vcs/src/data/vault.rs4
-rw-r--r--crates/vcs/src/data/vault/config.rs1
-rw-r--r--crates/vcs/src/data/vault/sheets.rs19
-rw-r--r--crates/vcs/src/data/vault/virtual_file.rs1
-rw-r--r--crates/vcs/src/lib.rs2
-rw-r--r--crates/vcs/src/service.rs2
-rw-r--r--crates/vcs/src/service/server_entry.rs0
-rw-r--r--crates/vcs/src/service/standard_handle.rs1
-rw-r--r--crates/vcs/vcs_test/Cargo.toml1
-rw-r--r--crates/vcs/vcs_test/src/test_sheet_creation_management_and_persistence.rs53
-rw-r--r--crates/vcs/vcs_test/src/test_virtual_file_creation_and_update.rs2
12 files changed, 174 insertions, 37 deletions
diff --git a/crates/vcs/src/data/sheet.rs b/crates/vcs/src/data/sheet.rs
index edf307a..95599ff 100644
--- a/crates/vcs/src/data/sheet.rs
+++ b/crates/vcs/src/data/sheet.rs
@@ -2,6 +2,7 @@ use std::{collections::HashMap, path::PathBuf};
use cfg_file::{ConfigFile, config::ConfigFile};
use serde::{Deserialize, Serialize};
+use string_proc::simple_processer::sanitize_file_path;
use crate::{
constants::SERVER_FILE_SHEET,
@@ -16,14 +17,24 @@ pub type SheetPathBuf = PathBuf;
pub type InputName = String;
pub type InputRelativePathBuf = PathBuf;
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, Eq)]
pub struct InputPackage {
/// Name of the input package
pub name: InputName,
+
+ /// The sheet from which this input package was created
+ pub from: SheetName,
+
/// Files in this input package with their relative paths and virtual file IDs
pub files: Vec<(InputRelativePathBuf, VirtualFileId)>,
}
+impl PartialEq for InputPackage {
+ fn eq(&self, other: &Self) -> bool {
+ self.name == other.name
+ }
+}
+
const SHEET_NAME: &str = "{sheet-name}";
pub struct Sheet<'a> {
@@ -60,21 +71,30 @@ impl<'a> Sheet<'a> {
&self.data.inputs
}
+ /// Get the names of the inputs of this sheet
+ pub fn input_names(&self) -> Vec<String> {
+ self.data
+ .inputs
+ .iter()
+ .map(|input| input.name.clone())
+ .collect()
+ }
+
/// Get the mapping of this sheet
pub fn mapping(&self) -> &HashMap<SheetPathBuf, VirtualFileId> {
&self.data.mapping
}
/// Add an input package to the sheet
- pub fn add_input(
- &mut self,
- input_name: InputName,
- files: Vec<(InputRelativePathBuf, VirtualFileId)>,
- ) {
- self.data.inputs.push(InputPackage {
- name: input_name,
- files,
- });
+ pub fn add_input(&mut self, input_package: InputPackage) -> Result<(), std::io::Error> {
+ if self.data.inputs.iter().any(|input| input == &input_package) {
+ return Err(std::io::Error::new(
+ std::io::ErrorKind::AlreadyExists,
+ format!("Input package '{}' already exists", input_package.name),
+ ));
+ }
+ self.data.inputs.push(input_package);
+ Ok(())
}
/// Remove an input package from the sheet
@@ -116,4 +136,89 @@ impl<'a> Sheet<'a> {
.vault_path()
.join(SERVER_FILE_SHEET.replace(SHEET_NAME, name.as_ref()))
}
+
+ /// Export files from the current sheet as an InputPackage for importing into other sheets
+ ///
+ /// This is the recommended way to create InputPackages. It takes a list of sheet paths
+ /// and generates an InputPackage with optimized relative paths by removing the longest
+ /// common prefix from all provided paths, then placing the files under a directory
+ /// named with the output_name.
+ ///
+ /// # Example
+ /// Given paths:
+ /// - `MyProject/Art/Character/Model/final.fbx`
+ /// - `MyProject/Art/Character/Texture/final.png`
+ /// - `MyProject/Art/Character/README.md`
+ ///
+ /// With output_name = "MyExport", the resulting package will contain:
+ /// - `MyExport/Model/final.fbx`
+ /// - `MyExport/Texture/final.png`
+ /// - `MyExport/README.md`
+ ///
+ /// # Arguments
+ /// * `output_name` - Name of the output package (will be used as the root directory)
+ /// * `paths` - List of sheet paths to include in the package
+ ///
+ /// # Returns
+ /// Returns an InputPackage containing the exported files with optimized paths,
+ /// or an error if paths are empty or files are not found in the sheet mapping
+ pub fn output_mappings(
+ &self,
+ output_name: InputName,
+ paths: &[SheetPathBuf],
+ ) -> Result<InputPackage, std::io::Error> {
+ let output_name = sanitize_file_path(output_name);
+
+ // Return error for empty paths since there's no need to generate an empty package
+ if paths.is_empty() {
+ return Err(std::io::Error::new(
+ std::io::ErrorKind::InvalidInput,
+ "Cannot generate output package with empty paths",
+ ));
+ }
+
+ // Find the longest common prefix among all paths
+ let common_prefix = paths.iter().skip(1).fold(paths[0].clone(), |prefix, path| {
+ Self::common_path_prefix(prefix, path)
+ });
+
+ // Create output files with optimized relative paths
+ let files = paths
+ .iter()
+ .map(|path| {
+ let relative_path = path.strip_prefix(&common_prefix).unwrap_or(path);
+ let output_path = PathBuf::from(&output_name).join(relative_path);
+
+ self.data
+ .mapping
+ .get(path)
+ .map(|vfid| (output_path, vfid.clone()))
+ .ok_or_else(|| {
+ std::io::Error::new(
+ std::io::ErrorKind::NotFound,
+ format!("File not found: {:?}", path),
+ )
+ })
+ })
+ .collect::<Result<Vec<_>, _>>()?;
+
+ Ok(InputPackage {
+ name: output_name,
+ from: self.name.clone(),
+ files,
+ })
+ }
+
+ /// Helper function to find common path prefix between two paths
+ fn common_path_prefix(path1: impl Into<PathBuf>, path2: impl Into<PathBuf>) -> PathBuf {
+ let path1 = path1.into();
+ let path2 = path2.into();
+
+ path1
+ .components()
+ .zip(path2.components())
+ .take_while(|(a, b)| a == b)
+ .map(|(comp, _)| comp)
+ .collect()
+ }
}
diff --git a/crates/vcs/src/data/vault.rs b/crates/vcs/src/data/vault.rs
index 5b34c6f..5d17a81 100644
--- a/crates/vcs/src/data/vault.rs
+++ b/crates/vcs/src/data/vault.rs
@@ -72,9 +72,7 @@ impl Vault {
create_dir_all(vault_path.join(SERVER_PATH_VF_ROOT))?;
let Some(vault) = Vault::init(config, &vault_path) else {
- return Err(std::io::Error::other(
- "Failed to initialize vault",
- ));
+ return Err(std::io::Error::other("Failed to initialize vault"));
};
// 6. Create host member
diff --git a/crates/vcs/src/data/vault/config.rs b/crates/vcs/src/data/vault/config.rs
index e879325..40ba09f 100644
--- a/crates/vcs/src/data/vault/config.rs
+++ b/crates/vcs/src/data/vault/config.rs
@@ -23,6 +23,7 @@ impl Default for VaultConfig {
}
}
+/// Vault Management
impl VaultConfig {
// Change name of the vault.
pub fn change_name(&mut self, name: impl Into<String>) {
diff --git a/crates/vcs/src/data/vault/sheets.rs b/crates/vcs/src/data/vault/sheets.rs
index bcd5779..0bba4f5 100644
--- a/crates/vcs/src/data/vault/sheets.rs
+++ b/crates/vcs/src/data/vault/sheets.rs
@@ -13,6 +13,7 @@ use crate::{
},
};
+/// Vault Sheets Management
impl Vault {
/// Load all sheets in the vault
///
@@ -153,6 +154,9 @@ impl Vault {
/// and will not be used in the future.
///
/// For a safer deletion method, consider using `delete_sheet_safety`.
+ ///
+ /// Note: This function is intended for server-side use only and should not be
+ /// arbitrarily called by other members to prevent unauthorized data deletion.
pub async fn delete_sheet(&self, sheet_name: &SheetName) -> Result<(), std::io::Error> {
let sheet_name = snake_case!(sheet_name.clone());
@@ -173,11 +177,18 @@ impl Vault {
/// Safely delete the sheet
///
- /// The sheet will be moved to the trash directory, ensuring it does not appear in the results of `sheets` and `sheet_names` methods.
- /// However, if the sheet's holder attempts to access the sheet through the `sheet` method, the system will automatically restore it from the trash directory.
- /// This means: the sheet will only permanently remain in the trash directory, waiting for manual cleanup by an administrator, when it is truly no longer in use.
+ /// The sheet will be moved to the trash directory, ensuring it does not appear in the
+ /// results of `sheets` and `sheet_names` methods.
+ /// However, if the sheet's holder attempts to access the sheet through the `sheet` method,
+ /// the system will automatically restore it from the trash directory.
+ /// This means: the sheet will only permanently remain in the trash directory,
+ /// waiting for manual cleanup by an administrator, when it is truly no longer in use.
+ ///
+ /// This is a safer deletion method because it provides the possibility of recovery,
+ /// avoiding irreversible data loss caused by accidental deletion.
///
- /// This is a safer deletion method because it provides the possibility of recovery, avoiding irreversible data loss caused by accidental deletion.
+ /// Note: This function is intended for server-side use only and should not be
+ /// arbitrarily called by other members to prevent unauthorized data deletion.
pub async fn delete_sheet_safely(&self, sheet_name: &SheetName) -> Result<(), std::io::Error> {
let sheet_name = snake_case!(sheet_name.clone());
diff --git a/crates/vcs/src/data/vault/virtual_file.rs b/crates/vcs/src/data/vault/virtual_file.rs
index 23e964a..83b1c82 100644
--- a/crates/vcs/src/data/vault/virtual_file.rs
+++ b/crates/vcs/src/data/vault/virtual_file.rs
@@ -70,6 +70,7 @@ impl VirtualFileVersionDescription {
}
}
+/// Virtual File Operations
impl Vault {
/// Generate a temporary path for receiving
pub fn virtual_file_temp_path(&self) -> PathBuf {
diff --git a/crates/vcs/src/lib.rs b/crates/vcs/src/lib.rs
index 1b41391..9a84b4d 100644
--- a/crates/vcs/src/lib.rs
+++ b/crates/vcs/src/lib.rs
@@ -3,3 +3,5 @@ pub mod current;
#[allow(dead_code)]
pub mod data;
+
+pub mod service;
diff --git a/crates/vcs/src/service.rs b/crates/vcs/src/service.rs
new file mode 100644
index 0000000..53365b8
--- /dev/null
+++ b/crates/vcs/src/service.rs
@@ -0,0 +1,2 @@
+pub mod server_entry;
+pub mod standard_handle;
diff --git a/crates/vcs/src/service/server_entry.rs b/crates/vcs/src/service/server_entry.rs
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/vcs/src/service/server_entry.rs
diff --git a/crates/vcs/src/service/standard_handle.rs b/crates/vcs/src/service/standard_handle.rs
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/crates/vcs/src/service/standard_handle.rs
@@ -0,0 +1 @@
+
diff --git a/crates/vcs/vcs_test/Cargo.toml b/crates/vcs/vcs_test/Cargo.toml
index 0ed51d8..1cc43ac 100644
--- a/crates/vcs/vcs_test/Cargo.toml
+++ b/crates/vcs/vcs_test/Cargo.toml
@@ -5,6 +5,7 @@ version.workspace = true
[dependencies]
tcp_connection = { path = "../../utils/tcp_connection" }
+tcp_connection_test = { path = "../../utils/tcp_connection/tcp_connection_test" }
cfg_file = { path = "../../utils/cfg_file", features = ["default"] }
vcs = { path = "../../vcs" }
diff --git a/crates/vcs/vcs_test/src/test_sheet_creation_management_and_persistence.rs b/crates/vcs/vcs_test/src/test_sheet_creation_management_and_persistence.rs
index 1c7182b..8abcc4d 100644
--- a/crates/vcs/vcs_test/src/test_sheet_creation_management_and_persistence.rs
+++ b/crates/vcs/vcs_test/src/test_sheet_creation_management_and_persistence.rs
@@ -48,20 +48,23 @@ async fn test_sheet_creation_management_and_persistence() -> Result<(), std::io:
// Test 2: Add input packages to the sheet
let input_name = "source_files".to_string();
- let files = vec![
- (
- InputRelativePathBuf::from("src/main.rs"),
- VirtualFileId::new(),
- ),
- (
- InputRelativePathBuf::from("src/lib.rs"),
- VirtualFileId::new(),
- ),
- ];
- // Need to get a mutable reference to the sheet
+ // First add mapping entries that will be used to generate the input package
let mut sheet = vault.sheet(&sheet_name).await?;
- sheet.add_input(input_name.clone(), files.clone());
+
+ // Add mapping entries for the files
+ let main_rs_path = vcs::data::sheet::SheetPathBuf::from("src/main.rs");
+ let lib_rs_path = vcs::data::sheet::SheetPathBuf::from("src/lib.rs");
+ let main_rs_id = VirtualFileId::new();
+ let lib_rs_id = VirtualFileId::new();
+
+ sheet.add_mapping(main_rs_path.clone(), main_rs_id.clone());
+ sheet.add_mapping(lib_rs_path.clone(), lib_rs_id.clone());
+
+ // Use output_mappings to generate the InputPackage
+ let paths = vec![main_rs_path, lib_rs_path];
+ let input_package = sheet.output_mappings(input_name.clone(), &paths)?;
+ sheet.add_input(input_package)?;
// Verify input was added
assert_eq!(sheet.inputs().len(), 1);
@@ -70,11 +73,11 @@ async fn test_sheet_creation_management_and_persistence() -> Result<(), std::io:
assert_eq!(added_input.files.len(), 2);
assert_eq!(
added_input.files[0].0,
- InputRelativePathBuf::from("src/main.rs")
+ InputRelativePathBuf::from("source_files/main.rs")
);
assert_eq!(
added_input.files[1].0,
- InputRelativePathBuf::from("src/lib.rs")
+ InputRelativePathBuf::from("source_files/lib.rs")
);
// Test 3: Add mapping entries
@@ -83,7 +86,7 @@ async fn test_sheet_creation_management_and_persistence() -> Result<(), std::io:
sheet.add_mapping(mapping_path.clone(), virtual_file_id.clone());
// Verify mapping was added
- assert_eq!(sheet.mapping().len(), 1);
+ assert_eq!(sheet.mapping().len(), 3);
assert_eq!(sheet.mapping().get(&mapping_path), Some(&virtual_file_id));
// Test 4: Persist sheet to disk
@@ -93,7 +96,7 @@ async fn test_sheet_creation_management_and_persistence() -> Result<(), std::io:
let reloaded_sheet = vault.sheet(&sheet_name).await?;
assert_eq!(reloaded_sheet.holder(), &member_id);
assert_eq!(reloaded_sheet.inputs().len(), 1);
- assert_eq!(reloaded_sheet.mapping().len(), 1);
+ assert_eq!(reloaded_sheet.mapping().len(), 3);
// Test 5: Remove input package
let mut sheet_for_removal = vault.sheet(&sheet_name).await?;
@@ -107,7 +110,7 @@ async fn test_sheet_creation_management_and_persistence() -> Result<(), std::io:
// Test 6: Remove mapping entry
let removed_virtual_file_id = sheet_for_removal.remove_mapping(&mapping_path);
assert_eq!(removed_virtual_file_id, Some(virtual_file_id));
- assert_eq!(sheet_for_removal.mapping().len(), 0);
+ assert_eq!(sheet_for_removal.mapping().len(), 2);
// Test 7: List all sheets in vault
let sheet_names = vault.sheet_names()?;
@@ -244,7 +247,7 @@ async fn test_sheet_data_serialization() -> Result<(), std::io::Error> {
// Add some inputs
let input_name = "source_files".to_string();
- let files = vec![
+ let _files = vec![
(
InputRelativePathBuf::from("src/main.rs"),
VirtualFileId::new(),
@@ -254,7 +257,19 @@ async fn test_sheet_data_serialization() -> Result<(), std::io::Error> {
VirtualFileId::new(),
),
];
- sheet.add_input(input_name, files);
+ // First add mapping entries
+ let main_rs_path = vcs::data::sheet::SheetPathBuf::from("src/main.rs");
+ let lib_rs_path = vcs::data::sheet::SheetPathBuf::from("src/lib.rs");
+ let main_rs_id = VirtualFileId::new();
+ let lib_rs_id = VirtualFileId::new();
+
+ sheet.add_mapping(main_rs_path.clone(), main_rs_id.clone());
+ sheet.add_mapping(lib_rs_path.clone(), lib_rs_id.clone());
+
+ // Use output_mappings to generate the InputPackage
+ let paths = vec![main_rs_path, lib_rs_path];
+ let input_package = sheet.output_mappings(input_name.clone(), &paths)?;
+ sheet.add_input(input_package)?;
// Add some mappings
sheet.add_mapping(
diff --git a/crates/vcs/vcs_test/src/test_virtual_file_creation_and_update.rs b/crates/vcs/vcs_test/src/test_virtual_file_creation_and_update.rs
index 598e7be..d86c13a 100644
--- a/crates/vcs/vcs_test/src/test_virtual_file_creation_and_update.rs
+++ b/crates/vcs/vcs_test/src/test_virtual_file_creation_and_update.rs
@@ -1,7 +1,7 @@
use std::time::Duration;
use cfg_file::config::ConfigFile;
-use tcp_connection::{
+use tcp_connection_test::{
handle::{ClientHandle, ServerHandle},
target::TcpServerTarget,
target_configure::ServerTargetConfig,
generated by cgit (git 2.34.1) at 2026-03-23 20:31:18 +0000