Skip to content

Commit

Permalink
refactor: Move validation into util_schemas
Browse files Browse the repository at this point in the history
  • Loading branch information
@epage
epage committed Dec 13, 2023
1 parent bb40714 commit 3f011a7
Show file tree
Hide file tree
Showing 5 changed files with 218 additions and 215 deletions.
1 change: 0 additions & 1 deletion src/cargo/util/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ pub(crate) use self::io::LimitErrorReader;
pub use self::lockserver::{LockServer, LockServerClient, LockServerStarted};
pub use self::progress::{Progress, ProgressStyle};
pub use self::queue::Queue;
pub use self::restricted_names::validate_package_name;
pub use self::rustc::Rustc;
pub use self::semver_ext::OptVersionReq;
pub use self::vcs::{existing_vcs_repo, FossilRepo, GitRepo, HgRepo, PijulRepo};
Expand Down
213 changes: 0 additions & 213 deletions src/cargo/util/restricted_names.rs
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! Helpers for validating and checking names like package and crate names.

use crate::util::CargoResult;
use anyhow::bail;
use std::path::Path;

/// Returns `true` if the name contains non-ASCII characters.
Expand Down Expand Up @@ -36,80 +34,6 @@ pub fn is_conflicting_artifact_name(name: &str) -> bool {
["deps", "examples", "build", "incremental"].contains(&name)
}

/// Check the base requirements for a package name.
///
/// This can be used for other things than package names, to enforce some
/// level of sanity. Note that package names have other restrictions
/// elsewhere. `cargo new` has a few restrictions, such as checking for
/// reserved names. crates.io has even more restrictions.
pub fn validate_package_name(name: &str, what: &str, help: &str) -> CargoResult<()> {
if name.is_empty() {
bail!("{what} cannot be empty");
}

let mut chars = name.chars();
if let Some(ch) = chars.next() {
if ch.is_digit(10) {
// A specific error for a potentially common case.
bail!(
"the name `{}` cannot be used as a {}, \
the name cannot start with a digit{}",
name,
what,
help
);
}
if !(unicode_xid::UnicodeXID::is_xid_start(ch) || ch == '_') {
bail!(
"invalid character `{}` in {}: `{}`, \
the first character must be a Unicode XID start character \
(most letters or `_`){}",
ch,
what,
name,
help
);
}
}
for ch in chars {
if !(unicode_xid::UnicodeXID::is_xid_continue(ch) || ch == '-') {
bail!(
"invalid character `{}` in {}: `{}`, \
characters must be Unicode XID characters \
(numbers, `-`, `_`, or most letters){}",
ch,
what,
name,
help
);
}
}
Ok(())
}

/// Ensure a package name is [valid][validate_package_name]
pub fn sanitize_package_name(name: &str, placeholder: char) -> String {
let mut slug = String::new();
let mut chars = name.chars();
while let Some(ch) = chars.next() {
if (unicode_xid::UnicodeXID::is_xid_start(ch) || ch == '_') && !ch.is_digit(10) {
slug.push(ch);
break;
}
}
while let Some(ch) = chars.next() {
if unicode_xid::UnicodeXID::is_xid_continue(ch) || ch == '-' {
slug.push(ch);
} else {
slug.push(placeholder);
}
}
if slug.is_empty() {
slug.push_str("package");
}
slug
}

/// Check the entire path for names reserved in Windows.
pub fn is_windows_reserved_path(path: &Path) -> bool {
path.iter()
Expand All @@ -124,140 +48,3 @@ pub fn is_windows_reserved_path(path: &Path) -> bool {
pub fn is_glob_pattern<T: AsRef<str>>(name: T) -> bool {
name.as_ref().contains(&['*', '?', '[', ']'][..])
}

/// Validate dir-names and profile names according to RFC 2678.
pub fn validate_profile_name(name: &str) -> CargoResult<()> {
if let Some(ch) = name
.chars()
.find(|ch| !ch.is_alphanumeric() && *ch != '_' && *ch != '-')
{
bail!(
"invalid character `{}` in profile name `{}`\n\
Allowed characters are letters, numbers, underscore, and hyphen.",
ch,
name
);
}

const SEE_DOCS: &str = "See https://doc.rust-lang.org/cargo/reference/profiles.html \
for more on configuring profiles.";

let lower_name = name.to_lowercase();
if lower_name == "debug" {
bail!(
"profile name `{}` is reserved\n\
To configure the default development profile, use the name `dev` \
as in [profile.dev]\n\
{}",
name,
SEE_DOCS
);
}
if lower_name == "build-override" {
bail!(
"profile name `{}` is reserved\n\
To configure build dependency settings, use [profile.dev.build-override] \
and [profile.release.build-override]\n\
{}",
name,
SEE_DOCS
);
}

// These are some arbitrary reservations. We have no plans to use
// these, but it seems safer to reserve a few just in case we want to
// add more built-in profiles in the future. We can also uses special
// syntax like cargo:foo if needed. But it is unlikely these will ever
// be used.
if matches!(
lower_name.as_str(),
"build"
| "check"
| "clean"
| "config"
| "fetch"
| "fix"
| "install"
| "metadata"
| "package"
| "publish"
| "report"
| "root"
| "run"
| "rust"
| "rustc"
| "rustdoc"
| "target"
| "tmp"
| "uninstall"
) || lower_name.starts_with("cargo")
{
bail!(
"profile name `{}` is reserved\n\
Please choose a different name.\n\
{}",
name,
SEE_DOCS
);
}

Ok(())
}

pub fn validate_feature_name(name: &str) -> CargoResult<()> {
if name.is_empty() {
bail!("feature name cannot be empty");
}

if name.starts_with("dep:") {
bail!("feature named `{name}` is not allowed to start with `dep:`",);
}
if name.contains('/') {
bail!("feature named `{name}` is not allowed to contain slashes",);
}
let mut chars = name.chars();
if let Some(ch) = chars.next() {
if !(unicode_xid::UnicodeXID::is_xid_start(ch) || ch == '_' || ch.is_digit(10)) {
bail!(
"invalid character `{ch}` in feature `{name}`, \
the first character must be a Unicode XID start character or digit \
(most letters or `_` or `0` to `9`)",
);
}
}
for ch in chars {
if !(unicode_xid::UnicodeXID::is_xid_continue(ch) || ch == '-' || ch == '+' || ch == '.') {
bail!(
"invalid character `{ch}` in feature `{name}`, \
characters must be Unicode XID characters, '-', `+`, or `.` \
(numbers, `+`, `-`, `_`, `.`, or most letters)",
);
}
}
Ok(())
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn valid_feature_names() {
assert!(validate_feature_name("c++17").is_ok());
assert!(validate_feature_name("128bit").is_ok());
assert!(validate_feature_name("_foo").is_ok());
assert!(validate_feature_name("feat-name").is_ok());
assert!(validate_feature_name("feat_name").is_ok());
assert!(validate_feature_name("foo.bar").is_ok());

assert!(validate_feature_name("+foo").is_err());
assert!(validate_feature_name("-foo").is_err());
assert!(validate_feature_name(".foo").is_err());
assert!(validate_feature_name("foo:bar").is_err());
assert!(validate_feature_name("foo?").is_err());
assert!(validate_feature_name("?foo").is_err());
assert!(validate_feature_name("ⒶⒷⒸ").is_err());
assert!(validate_feature_name("a¼").is_err());
assert!(validate_feature_name("").is_err());
}
}
2 changes: 1 addition & 1 deletion src/cargo/util_schemas/manifest.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ use serde::ser;
use serde::{Deserialize, Serialize};
use serde_untagged::UntaggedEnumVisitor;

use crate::util::restricted_names;
use crate::util_schemas::core::PackageIdSpec;
use crate::util_schemas::restricted_names;
use crate::util_semver::PartialVersion;

/// This type is used to deserialize `Cargo.toml` files.
Expand Down
2 changes: 2 additions & 0 deletions src/cargo/util_schemas/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@

pub mod core;
pub mod manifest;

mod restricted_names;
Loading

0 comments on commit 3f011a7

Please sign in to comment.