Skip to content

Commit

Permalink
Normalize drive letters when resolving paths on Windows
Browse files Browse the repository at this point in the history
When it comes to resolving paths on Windows, even though the underlying
API expects drive letter prefixes to be uppercase, some sources (e.g.
environment variables like `=C:`) won't normalize components, instead
returning the value as-is. While this wouldn't be a problem normally as
NTFS is case-insensitive on Windows, this introduces duplicates in the
database when adding new entries via `zoxide add`:

```batchfile prompt
> zoxide query --list
D:\
d:\
D:\coding
d:\coding
D:\coding\.cloned
d:\coding\.cloned
```

This is a cherry-pick from #567; see also rust-lang/rust-analyzer#14683.

Signed-off-by: mataha <mataha@users.noreply.github.com>
  • Loading branch information
mataha committed Jun 11, 2024
1 parent dbe6f18 commit 8a19d52
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 12 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- zsh: better cd completions.
- elvish: `z -` now work as expected.
- Lazily delete excluded directories from the database.
- Normalize drive letters when resolving paths on Windows.

## [0.9.4] - 2024-02-21

Expand Down
55 changes: 43 additions & 12 deletions src/util.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use std::ffi::OsStr;
use std::fs::{self, File, OpenOptions};
use std::io::{self, Read, Write};
use std::path::{Component, Path, PathBuf};
use std::path::{Component, Path, PathBuf, Prefix};
use std::process::{Child, Command, Stdio};
use std::time::SystemTime;
use std::{env, mem};
Expand Down Expand Up @@ -263,6 +263,37 @@ pub fn path_to_str(path: &impl AsRef<Path>) -> Result<&str> {
path.to_str().with_context(|| format!("invalid unicode in path: {}", path.display()))
}

fn patch_path(path: PathBuf) -> PathBuf {
if cfg!(windows) {
fn patch_drive(drive_letter: u8) -> char {
drive_letter.to_ascii_uppercase() as char
}

let mut components = path.components();
match components.next() {
Some(Component::Prefix(prefix)) => {
let prefix = match prefix.kind() {
Prefix::Disk(drive_letter) => {
format!(r"{}:", patch_drive(drive_letter))
}
Prefix::VerbatimDisk(drive_letter) => {
format!(r"\\?\{}:", patch_drive(drive_letter))
}
_ => return path,
};

let mut path = PathBuf::default();
path.push(prefix);
path.extend(components);
path
}
_ => path,
}
} else {
path
}
}

/// Returns the absolute version of a path. Like
/// [`std::path::Path::canonicalize`], but doesn't resolve symlinks.
pub fn resolve_path(path: impl AsRef<Path>) -> Result<PathBuf> {
Expand All @@ -274,8 +305,6 @@ pub fn resolve_path(path: impl AsRef<Path>) -> Result<PathBuf> {

// initialize root
if cfg!(windows) {
use std::path::Prefix;

fn get_drive_letter(path: impl AsRef<Path>) -> Option<u8> {
let path = path.as_ref();
let mut components = path.components();
Expand All @@ -292,17 +321,17 @@ pub fn resolve_path(path: impl AsRef<Path>) -> Result<PathBuf> {
}

fn get_drive_path(drive_letter: u8) -> PathBuf {
format!(r"{}:\", drive_letter as char).into()
format!(r"{}:\", drive_letter.to_ascii_uppercase() as char).into()
}

fn get_drive_relative(drive_letter: u8) -> Result<PathBuf> {
let path = current_dir()?;
if Some(drive_letter) == get_drive_letter(&path) {
return Ok(path);
return Ok(patch_path(path));
}

if let Some(path) = env::var_os(format!("={}:", drive_letter as char)) {
return Ok(path.into());
return Ok(patch_path(path.into()));
}

let path = get_drive_path(drive_letter);
Expand All @@ -312,23 +341,25 @@ pub fn resolve_path(path: impl AsRef<Path>) -> Result<PathBuf> {
match components.peek() {
Some(Component::Prefix(prefix)) => match prefix.kind() {
Prefix::Disk(drive_letter) => {
let disk = components.next().unwrap();
components.next();
if components.peek() == Some(&Component::RootDir) {
let root = components.next().unwrap();
stack.push(disk);
stack.push(root);
components.next();
base_path = get_drive_path(drive_letter);
} else {
base_path = get_drive_relative(drive_letter)?;
stack.extend(base_path.components());
}

stack.extend(base_path.components());
}
Prefix::VerbatimDisk(drive_letter) => {
components.next();
if components.peek() == Some(&Component::RootDir) {
components.next();
base_path = get_drive_path(drive_letter);
} else {
bail!("illegal path: {}", path.display());
}

base_path = get_drive_path(drive_letter);
stack.extend(base_path.components());
}
_ => bail!("invalid path: {}", path.display()),
Expand Down

0 comments on commit 8a19d52

Please sign in to comment.