1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
#![feature(str_split_remainder)]
#![no_std]
extern crate alloc;
use alloc::{
borrow::Cow,
string::{String, ToString},
vec::Vec,
};
use core::fmt;
/// The name of a scheme
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct RedoxScheme<'a>(Cow<'a, str>);
impl<'a> RedoxScheme<'a> {
/// Create a new [`RedoxScheme`], ensuring there are no invalid characters
pub fn new<S: Into<Cow<'a, str>>>(scheme: S) -> Option<Self> {
let scheme = scheme.into();
// Scheme cannot have NUL, /, or :
if scheme.contains(&['\0', '/', ':']) {
return None;
}
Some(Self(scheme))
}
}
impl<'a> AsRef<str> for RedoxScheme<'a> {
fn as_ref(&self) -> &str {
self.0.as_ref()
}
}
/// The part of a path that is sent to each scheme
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct RedoxReference<'a>(Cow<'a, str>);
impl<'a> RedoxReference<'a> {
/// Create a new [`RedoxReference`], ensuring there are no invalid characters
pub fn new<S: Into<Cow<'a, str>>>(reference: S) -> Option<Self> {
let reference = reference.into();
// Reference cannot have NUL
if reference.contains(&['\0']) {
return None;
}
Some(Self(reference))
}
/// Join a [`RedoxReference`] with a path. Relative paths will be joined, absolute paths will
/// be returned as-is.
///
/// Returns `Some` on success and `None` if the path is not valid
pub fn join<S: Into<Cow<'a, str>>>(&self, path: S) -> Option<Self> {
let path = path.into();
if path.starts_with('/') {
// Absolute path, replaces reference
Self::new(path)
} else if path.is_empty() {
// Empty path, return prior reference
Self::new(self.0.clone())
} else {
// Relative path, append to reference
let mut reference = self.0.clone().into_owned();
if !reference.is_empty() && !reference.ends_with('/') {
reference.push('/');
}
reference.push_str(&path);
Self::new(reference)
}
}
/// Canonicalize [`RedoxReference`], removing . and ..
///
/// Returns `Some` on success and `None` if the path is not valid
pub fn canonical(&self) -> Option<Self> {
let canonical = {
let parts = self
.0
.split('/')
.rev()
.scan(0, |nskip, part| {
if part == "." {
Some(None)
} else if part == ".." {
*nskip += 1;
Some(None)
} else if *nskip > 0 {
*nskip -= 1;
Some(None)
} else {
Some(Some(part))
}
})
.filter_map(|x| x)
.filter(|x| !x.is_empty())
.collect::<Vec<_>>();
parts.iter().rev().fold(String::new(), |mut string, &part| {
if !string.is_empty() && !string.ends_with('/') {
string.push('/');
}
string.push_str(part);
string
})
};
Self::new(canonical)
}
/// Verify that the reference is canonicalized
pub fn is_canon(&self) -> bool {
self.0.is_empty()
|| self
.0
.split('/')
.all(|seg| seg != ".." && seg != "." && seg != "")
}
}
impl<'a> AsRef<str> for RedoxReference<'a> {
fn as_ref(&self) -> &str {
self.0.as_ref()
}
}
/// A fully qualified Redox path
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub enum RedoxPath<'a> {
/// Standard UNIX compatible format
Standard(RedoxReference<'a>),
/// Legacy URI format
Legacy(RedoxScheme<'a>, RedoxReference<'a>),
}
impl<'a> RedoxPath<'a> {
/// Create [`RedoxPath`] from absolute path
///
/// Returns `Some` on success and `None` if the path is not valid
pub fn from_absolute(path: &'a str) -> Option<Self> {
Some(if path.starts_with('/') {
// New /scheme/scheme_name/path format
Self::Standard(RedoxReference::new(&path[1..])?)
} else {
// Old scheme_name:path format
let mut parts = path.splitn(2, ':');
let scheme = RedoxScheme::new(parts.next()?)?;
let reference = RedoxReference::new(parts.next()?)?;
Self::Legacy(scheme, reference)
})
}
/// Join a [`RedoxPath`] with a path. Relative paths will be joined, absolute paths will be
/// returned as-is.
///
/// Returns `Some` on success and `None` if the path is not valid
pub fn join(&self, path: &'a str) -> Option<Self> {
if path.starts_with('/') {
Self::from_absolute(path)
} else {
Some(match self {
Self::Standard(reference) => Self::Standard(reference.join(path)?),
Self::Legacy(scheme, reference) => {
Self::Legacy(scheme.clone(), reference.join(path)?)
}
})
}
}
/// Canonicalize path, removing . and ..
///
/// Returns `Some` on success and `None` if the path is not valid
pub fn canonical(&self) -> Option<Self> {
Some(match self {
Self::Standard(reference) => Self::Standard(reference.canonical()?),
Self::Legacy(scheme, reference) => {
// We cannot canonicalize legacy paths since they may need to preserve dots and
// slashes
Self::Legacy(scheme.clone(), reference.clone())
}
})
}
/// Verify that the path is canonicalized.
///
/// Returns false if any segment is ".", ".." or "".
/// A path that is empty is allowed and is interpreted as "/".
pub fn is_canon(&self) -> bool {
match self {
Self::Standard(reference) => reference.is_canon(),
Self::Legacy(_scheme, _reference) => true,
}
}
/// Convert into a RedoxScheme and RedoxReference.
/// - Standard paths will parse `/scheme/scheme_name/reference`, and anything not starting
/// with `/scheme` will be parsed as being part of the `file` scheme
/// - Legacy paths can be instantly converted
pub fn as_parts(&'a self) -> Option<(RedoxScheme<'a>, RedoxReference<'a>)> {
if !self.is_canon() {
return None;
}
match self {
Self::Standard(reference) => {
//TODO: this does not use the RedoxScheme::new and RedoxReference::new functions
let mut parts = reference.0.split('/');
loop {
match parts.next() {
Some("") => {
// Ignore empty parts
}
Some("scheme") => match parts.next() {
Some(scheme_name) => {
// Path is in /scheme/scheme_name
let remainder = parts.remainder().unwrap_or("");
return Some((
RedoxScheme(Cow::from(scheme_name)),
RedoxReference(Cow::from(remainder)),
));
}
None => {
// Path is the root scheme
return Some((
RedoxScheme(Cow::from("")),
RedoxReference(Cow::from("")),
));
}
},
_ => {
// If path has no special processing, it is inside the file scheme
return Some((RedoxScheme(Cow::from("file")), reference.clone()));
}
}
}
}
Self::Legacy(scheme, reference) => {
// Legacy paths are already split
Some((scheme.clone(), reference.clone()))
}
}
}
}
impl<'a> fmt::Display for RedoxPath<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
RedoxPath::Standard(reference) => {
write!(f, "/{}", reference.0)
}
RedoxPath::Legacy(scheme, reference) => {
write!(f, "{}:{}", scheme.0, reference.0)
}
}
}
}
/// Make a relative path absolute using an optional current working directory.
///
/// Given a cwd of "/scheme/scheme_name/dir_name", this function will turn
/// path "foo" into /scheme/scheme_name/dir_name/foo".
/// "/foo" will be left as is, because it is already absolute.
/// "." and empty segments "//" will be removed.
/// ".." will be resolved by backing up one directory, except at the root,
/// where ".." will be ignored and removed.
///
/// For old format schemes,
/// given a cwd of "scheme:/path", this function will turn "foo" into "scheme:/path/foo".
/// "/foo" will turn into "file:/foo". "bar:/foo" will be used directly, as it is already
/// absolute.
pub fn canonicalize_using_cwd<'a>(cwd_opt: Option<&str>, path: &'a str) -> Option<String> {
let absolute = match RedoxPath::from_absolute(path) {
Some(absolute) => absolute,
None => {
let cwd = cwd_opt?;
let absolute = RedoxPath::from_absolute(cwd)?;
absolute.join(path)?
}
};
let canonical = absolute.canonical()?;
Some(canonical.to_string())
}
/// Make a path that is relative to the root of a scheme into a full path,
/// following the rules of [`canonicalize_using_cwd`].
pub fn canonicalize_using_scheme<'a>(scheme: &str, path: &'a str) -> Option<String> {
let scheme_path = RedoxPath::from_absolute("/scheme")?.join(scheme)?.to_string();
canonicalize_using_cwd(Some(&scheme_path), path)
}
#[cfg(test)]
mod tests {
use super::*;
use alloc::{format, string::ToString};
// Tests absolute paths without scheme
#[test]
fn test_absolute() {
let cwd_opt = None;
assert_eq!(canonicalize_using_cwd(cwd_opt, "/"), Some("/".to_string()));
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/file"),
Some("/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/folder/file"),
Some("/folder/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/folder/../file"),
Some("/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/folder/../.."),
Some("/".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/folder/../../../.."),
Some("/".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/.."),
Some("/".to_string())
);
}
// Test relative paths using new scheme
#[test]
fn test_new_relative() {
let cwd_opt = Some("/scheme/foo");
assert_eq!(
canonicalize_using_cwd(cwd_opt, "file"),
Some("/scheme/foo/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/file"),
Some("/scheme/foo/folder/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/../file"),
Some("/scheme/foo/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/../.."),
Some("/scheme".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/../../../.."),
Some("/".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, ".."),
Some("/scheme".to_string())
);
}
// Tests paths prefixed with /scheme/
#[test]
fn test_new_scheme() {
let cwd_opt = None;
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/scheme/bar/"),
Some("/scheme/bar".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/scheme/bar/file"),
Some("/scheme/bar/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/scheme/bar/folder/file"),
Some("/scheme/bar/folder/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/scheme/bar/folder/../file"),
Some("/scheme/bar/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/scheme/bar/folder/../.."),
Some("/scheme".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/scheme/bar/folder/../../../.."),
Some("/".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "/scheme/bar/.."),
Some("/scheme".to_string())
);
assert_eq!(
canonicalize_using_scheme("bar", ""),
Some("/scheme/bar".to_string())
);
assert_eq!(
canonicalize_using_scheme("bar", "foo"),
Some("/scheme/bar/foo".to_string())
);
assert_eq!(
canonicalize_using_scheme("bar", ".."),
Some("/scheme".to_string())
);
}
// Test relative paths using old scheme
#[test]
fn test_old_relative() {
let cwd_opt = Some("foo:");
assert_eq!(
canonicalize_using_cwd(cwd_opt, "file"),
Some("foo:file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/file"),
Some("foo:folder/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/../file"),
Some("foo:folder/../file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/../.."),
Some("foo:folder/../..".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "folder/../../../.."),
Some("foo:folder/../../../..".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, ".."),
Some("foo:..".to_string())
);
}
// Tests paths prefixed with scheme_name:
#[test]
fn test_old_scheme() {
let cwd_opt = None;
assert_eq!(
canonicalize_using_cwd(cwd_opt, "bar:"),
Some("bar:".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "bar:file"),
Some("bar:file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "bar:folder/file"),
Some("bar:folder/file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "bar:folder/../file"),
Some("bar:folder/../file".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "bar:folder/../.."),
Some("bar:folder/../..".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "bar:folder/../../../.."),
Some("bar:folder/../../../..".to_string())
);
assert_eq!(
canonicalize_using_cwd(cwd_opt, "bar:.."),
Some("bar:..".to_string())
);
}
// Tests paths that may be used with orbital:
#[test]
fn test_orbital_scheme() {
for flag_str in &["", "abflrtu"] {
for x in &[-1, 0, 1] {
for y in &[-1, 0, 1] {
for w in &[0, 1] {
for h in &[0, 1] {
for title in &[
"",
"title",
"title/with/slashes",
"title:with:colons",
"title/../with/../dots/..",
] {
let path = format!(
"orbital:{}/{}/{}/{}/{}/{}",
flag_str, x, y, w, h, title
);
assert_eq!(canonicalize_using_cwd(None, &path), Some(path));
}
}
}
}
}
}
}
// Tests path splitting to parts
#[test]
fn test_parts() {
for (path, scheme, reference) in &[
("/foo/bar/baz", "file", "foo/bar/baz"),
("/scheme/foo/bar/baz", "foo", "bar/baz"),
("/", "file", ""),
("/bar", "file", "bar"),
("/...", "file", "..."),
] {
let redox_path = RedoxPath::from_absolute(path).unwrap();
let parts = redox_path.as_parts();
assert_eq!(
(path, parts),
(
path,
Some((
RedoxScheme::new(*scheme).unwrap(),
RedoxReference::new(*reference).unwrap()
))
)
);
let to_string = format!("/scheme/{scheme}");
let joined_path = RedoxPath::from_absolute(&to_string)
.unwrap()
.join(reference)
.unwrap();
if path.starts_with("/scheme") {
assert_eq!(path, &format!("{joined_path}"));
} else {
assert_eq!(path, &format!("/{reference}"));
}
}
// fail if the path is not absolute
assert_eq!(RedoxPath::from_absolute("not/absolute"), None);
// fail if the scheme is not properly canonicalized
for path in [
"//double/slash",
"/ending/in/slash/",
"/contains/dot/.",
"/contains/dotdot/..",
] {
let redox_path = RedoxPath::from_absolute(path).unwrap();
let parts = redox_path.as_parts();
assert_eq!((path, parts), (path, None));
}
}
#[test]
fn test_old_scheme_parts() {
for (path, scheme, reference) in &[
("foo:bar/baz", "foo", "bar/baz"),
("emptyref:", "emptyref", ""),
(":emptyscheme", "", "emptyscheme"),
] {
let redox_path = RedoxPath::from_absolute(path).unwrap();
let parts = redox_path.as_parts();
assert_eq!(
(path, parts),
(
path,
Some((
RedoxScheme::new(*scheme).unwrap(),
RedoxReference::new(*reference).unwrap()
))
)
);
}
// slash is not allowed in scheme names
assert_eq!(RedoxPath::from_absolute("scheme/withslash:path"), None);
}
}