41 lines
4.2 KiB
Markdown
41 lines
4.2 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- DataPRO/Modules/DatabaseImporter/DatabaseImport/Utilities/DiskUtility.cs
|
||
|
|
generated_at: "2026-04-16T04:30:13.126152+00:00"
|
||
|
|
model: "Qwen/Qwen3-Coder-Next-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "f18ece9cd807d7b1"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Utilities
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
`DiskUtility` is a static utility class providing disk-related validation logic for file and path names within the `DatabaseImport` module. Its primary role is to enforce naming constraints on file and directory names used during database import operations—specifically, to reject names containing any characters deemed invalid by the .NET runtime *and* any period (`.`) characters, which are explicitly disallowed beyond standard OS restrictions. This helps prevent filesystem errors and potential security issues (e.g., path traversal, ambiguous extensions) during file I/O operations.
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
- **`bool ValidateFileAndPathNameChars(string nameToValidate)`**
|
||
|
|
Validates whether the input string is a permissible file or path name. Returns `false` if:
|
||
|
|
- The trimmed string is empty or whitespace-only,
|
||
|
|
- It contains *any* character returned by `Path.GetInvalidFileNameChars()`,
|
||
|
|
- It contains *any* character returned by `Path.GetInvalidPathChars()`,
|
||
|
|
- It contains a period (`.`) character anywhere in the string.
|
||
|
|
Returns `true` only if all checks pass.
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
- **Empty/whitespace rejection**: Any input that trims to zero length is invalid.
|
||
|
|
- **Strict character filtering**: The presence of *any* invalid filename *or* path character (as defined by `Path.GetInvalidFileNameChars()` and `Path.GetInvalidPathChars()` for the current platform) causes failure.
|
||
|
|
- **Period prohibition**: The literal `'.'` character is *always* invalid, regardless of context (e.g., even in otherwise valid names like `"file.txt"` or `"."`), per the explicit `Contains('.')` check.
|
||
|
|
- **No partial validation**: The method performs *all* checks and returns `false` on the *first* failure encountered (due to short-circuiting via `bValid = false` without early exit), but the logic ensures *all* invalid conditions are evaluated before returning.
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
- **Imports**: `System.IO` (for `Path.GetInvalidFileNameChars()`, `Path.GetInvalidPathChars()`), `System.Linq` (for `Contains()` extension method on `string`).
|
||
|
|
- **Usage context**: Inferred to be used by other components in the `DatabaseImport` namespace (e.g., import pipeline logic that constructs file paths from user input or metadata). No external dependencies beyond the .NET runtime.
|
||
|
|
- **Dependents**: Not specified in source; must be determined via codebase search for `DiskUtility.ValidateFileAndPathNameChars`.
|
||
|
|
|
||
|
|
## 5. Gotchas
|
||
|
|
- **Overly restrictive period check**: The explicit ban on `.` prevents valid names like `"data"` (if followed by an extension in practice) or `"."` (for current directory), but also blocks *all* extensions (e.g., `"file.csv"` fails). This may conflict with standard filesystem behavior where `.` is only invalid in *certain* positions (e.g., not at the start/end of a filename on Windows).
|
||
|
|
- **No early exit**: The method sets `bValid = false` but continues iterating through all invalid characters—even after failure—resulting in unnecessary work.
|
||
|
|
- **Case sensitivity**: `Contains()` is case-sensitive by default; if `nameToValidate` contains uppercase invalid characters (e.g., `':'` is invalid on Windows), it will still be caught, but this behavior is platform-dependent (e.g., `Path.GetInvalidFileNameChars()` returns platform-specific invalid chars).
|
||
|
|
- **No distinction between filename vs. path**: The method validates *both* filename and path characters in one pass, but a path like `"C:\folder\file"` contains `\` (valid in paths but *invalid* in filenames). This may cause false negatives for legitimate paths.
|
||
|
|
- **Commented-out base class**: The class declaration is `public class DiskUtility //: Exceptional`, suggesting past inheritance from an `Exceptional` type (possibly for error handling), but this is inactive. No exception-throwing behavior is present.
|
||
|
|
- **No localization or culture considerations**: Relies on `string.Contains(char)`, which is culture-invariant for `char`, but the underlying `Path.GetInvalid*Chars()` results depend on the OS/runtime environment.
|