aboutsummaryrefslogtreecommitdiffhomepage
path: root/crates/mozart-core/src/validation.rs
blob: c27eb91951170d85cf504fc04dab9093fecb162a (plain)
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
use regex::Regex;
use std::sync::LazyLock;

static PACKAGE_NAME_RE: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r"^[a-z0-9]([_.\-]?[a-z0-9]+)*/[a-z0-9](([_.]|\-{1,2})?[a-z0-9]+)*$").unwrap()
});

static AUTHOR_RE: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r"^(?P<name>[- .,\pL\pN\pM''\x{201C}\x{201D}()]+)(?:\s+<(?P<email>.+?)>)?$").unwrap()
});

static AUTOLOAD_PATH_RE: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"^[^/][A-Za-z0-9\-_/]+/$").unwrap());

static CAMEL_SPLIT_RE: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"(?:([a-z])([A-Z])|([A-Z])([A-Z][a-z]))").unwrap());

static SANITIZE_EDGES_RE: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"^[_.\-]+|[_.\-]+$|[^a-z0-9_.\-]").unwrap());

static SANITIZE_REPEATS_RE: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"([_.\-]){2,}").unwrap());

static NON_ALNUM_RE: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"[^a-zA-Z0-9]").unwrap());

const VALID_STABILITIES: &[&str] = &["dev", "alpha", "beta", "rc", "stable"];

pub fn validate_package_name(name: &str) -> bool {
    PACKAGE_NAME_RE.is_match(name)
}

pub struct ParsedAuthor {
    pub name: String,
    pub email: Option<String>,
}

pub fn parse_author(input: &str) -> Result<ParsedAuthor, String> {
    if let Some(caps) = AUTHOR_RE.captures(input) {
        let name = caps.name("name").unwrap().as_str().trim().to_string();
        let email = caps.name("email").map(|m| m.as_str().to_string());
        Ok(ParsedAuthor { name, email })
    } else {
        Err(
            "Invalid author string. Must be in the formats: Jane Doe or John Smith <john@example.com>"
                .to_string(),
        )
    }
}

pub fn validate_stability(s: &str) -> bool {
    VALID_STABILITIES.contains(&s.to_lowercase().as_str())
}

pub fn validate_license(s: &str) -> bool {
    mozart_spdx_licenses::spdx().validate(s)
}

pub fn validate_autoload_path(s: &str) -> bool {
    AUTOLOAD_PATH_RE.is_match(s)
}

pub fn namespace_from_package_name(package_name: &str) -> Option<String> {
    if package_name.is_empty() || !package_name.contains('/') {
        return None;
    }

    let parts: Vec<String> = package_name
        .split('/')
        .map(|part| {
            let replaced = NON_ALNUM_RE.replace_all(part, " ");
            let words: Vec<String> = replaced
                .split_whitespace()
                .map(|w| {
                    let mut chars = w.chars();
                    match chars.next() {
                        Some(c) => c.to_uppercase().to_string() + &chars.collect::<String>(),
                        None => String::new(),
                    }
                })
                .collect();
            words.join("")
        })
        .collect();

    Some(parts.join("\\"))
}

pub fn sanitize_package_name_component(name: &str) -> String {
    // CamelCase → kebab-case
    let name = CAMEL_SPLIT_RE.replace_all(name, "${1}${3}-${2}${4}");
    let name = name.to_lowercase();
    // Remove leading/trailing separators and non-alnum chars
    let name = SANITIZE_EDGES_RE.replace_all(&name, "");
    // Collapse repeated separators
    let name = SANITIZE_REPEATS_RE.replace_all(&name, "$1");
    name.to_string()
}

pub fn parse_require_string(s: &str) -> Result<(String, String), String> {
    // Formats: "foo/bar:^1.0", "foo/bar=^1.0", "foo/bar ^1.0"
    let s = s.trim();

    for sep in [':', '=', ' '] {
        if let Some(pos) = s.find(sep) {
            let name = s[..pos].trim();
            let version = s[pos + sep.len_utf8()..].trim();
            if !name.is_empty() && !version.is_empty() {
                return Ok((name.to_string(), version.to_string()));
            }
        }
    }

    Err(format!(
        "Could not parse requirement \"{s}\". Expected format: vendor/package:version"
    ))
}

/// Mirror of `Composer\Package\BasePackage::packageNameToRegexp`. Each
/// character of `pattern` is `regex::escape`d, then `\*` is rewritten
/// to `.*`, and the result is anchored and compiled case-insensitively.
/// Used by selection commands (`reinstall`, `remove`, `update`, …) to
/// expand `vendor/*`-style globs against installed/locked package names.
pub fn package_name_to_regexp(pattern: &str) -> Regex {
    let escaped = regex::escape(pattern).replace("\\*", ".*");
    // PHP wraps with `{^...$}i`; in Rust we anchor with `\A`/`\z` and
    // pass `(?i)` for case-insensitivity.
    Regex::new(&format!(r"(?i)\A{escaped}\z"))
        .expect("package_name_to_regexp pattern always compiles")
}

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

    #[test]
    fn test_valid_package_names() {
        assert!(validate_package_name("vendor/package"));
        assert!(validate_package_name("my-vendor/my-package"));
        assert!(validate_package_name("vendor/pkg123"));
        assert!(validate_package_name("a/b"));
        assert!(validate_package_name("vendor/my_package"));
        assert!(validate_package_name("vendor/my.package"));
        assert!(validate_package_name("vendor/my--package"));
    }

    #[test]
    fn test_invalid_package_names() {
        assert!(!validate_package_name("novendor"));
        assert!(!validate_package_name("/package"));
        assert!(!validate_package_name("vendor/"));
        assert!(!validate_package_name("Vendor/Package"));
        assert!(!validate_package_name("vendor/pack age"));
        assert!(!validate_package_name(""));
    }

    #[test]
    fn test_parse_author_name_and_email() {
        let a = parse_author("John Smith <john@example.com>").unwrap();
        assert_eq!(a.name, "John Smith");
        assert_eq!(a.email.as_deref(), Some("john@example.com"));
    }

    #[test]
    fn test_parse_author_name_only() {
        let a = parse_author("Jane Doe").unwrap();
        assert_eq!(a.name, "Jane Doe");
        assert!(a.email.is_none());
    }

    #[test]
    fn test_parse_author_invalid() {
        assert!(parse_author("").is_err());
    }

    #[test]
    fn test_validate_stability() {
        assert!(validate_stability("dev"));
        assert!(validate_stability("alpha"));
        assert!(validate_stability("beta"));
        assert!(validate_stability("rc"));
        assert!(validate_stability("stable"));
        assert!(validate_stability("Dev"));
        assert!(validate_stability("STABLE"));
        assert!(!validate_stability("invalid"));
        assert!(!validate_stability(""));
    }

    #[test]
    fn test_validate_autoload_path() {
        assert!(validate_autoload_path("src/"));
        assert!(validate_autoload_path("lib/src/"));
        assert!(!validate_autoload_path("/src/"));
        assert!(!validate_autoload_path("src"));
        assert!(!validate_autoload_path(""));
    }

    #[test]
    fn test_namespace_from_package_name() {
        assert_eq!(
            namespace_from_package_name("acme/my-pkg"),
            Some("Acme\\MyPkg".to_string())
        );
        assert_eq!(
            namespace_from_package_name("new_projects.acme-extra/package-name"),
            Some("NewProjectsAcmeExtra\\PackageName".to_string())
        );
        assert_eq!(namespace_from_package_name(""), None);
        assert_eq!(namespace_from_package_name("novendor"), None);
    }

    #[test]
    fn test_sanitize_package_name_component() {
        assert_eq!(sanitize_package_name_component("MyPackage"), "my-package");
        assert_eq!(
            sanitize_package_name_component("CamelCaseTest"),
            "camel-case-test"
        );
        assert_eq!(sanitize_package_name_component("already-ok"), "already-ok");
        assert_eq!(sanitize_package_name_component("__bad__"), "bad");
    }

    #[test]
    fn test_package_name_to_regexp_exact() {
        let re = package_name_to_regexp("monolog/monolog");
        assert!(re.is_match("monolog/monolog"));
        assert!(re.is_match("Monolog/Monolog"));
        assert!(!re.is_match("psr/log"));
        assert!(!re.is_match("monolog/monolog-extra"));
        assert!(!re.is_match("xmonolog/monolog"));
    }

    #[test]
    fn test_package_name_to_regexp_wildcard() {
        let re = package_name_to_regexp("psr/*");
        assert!(re.is_match("psr/log"));
        assert!(re.is_match("psr/container"));
        assert!(re.is_match("psr/log/sub"));
        assert!(!re.is_match("monolog/monolog"));

        let re = package_name_to_regexp("*/log");
        assert!(re.is_match("psr/log"));
        assert!(re.is_match("monolog/log"));
        assert!(!re.is_match("psr/container"));

        let re = package_name_to_regexp("symfony/*/bridge");
        assert!(re.is_match("symfony/http/bridge"));
        assert!(!re.is_match("symfony/bridge"));

        let re = package_name_to_regexp("*");
        assert!(re.is_match("anything/at/all"));
    }

    #[test]
    fn test_package_name_to_regexp_escapes_metacharacters() {
        // `.` must be literal, not "any character"
        let re = package_name_to_regexp("foo.bar/baz");
        assert!(re.is_match("foo.bar/baz"));
        assert!(!re.is_match("fooXbar/baz"));
    }

    #[test]
    fn test_parse_require_string() {
        let (name, ver) = parse_require_string("foo/bar:^1.0").unwrap();
        assert_eq!(name, "foo/bar");
        assert_eq!(ver, "^1.0");

        let (name, ver) = parse_require_string("foo/bar=^1.0").unwrap();
        assert_eq!(name, "foo/bar");
        assert_eq!(ver, "^1.0");

        let (name, ver) = parse_require_string("foo/bar ^1.0").unwrap();
        assert_eq!(name, "foo/bar");
        assert_eq!(ver, "^1.0");

        assert!(parse_require_string("invalid").is_err());
    }
}