-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
lib.rs
377 lines (337 loc) · 13.2 KB
/
lib.rs
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
use anyhow::Result;
use log::debug;
use regex::Regex;
use std::fmt;
use std::str::FromStr;
use strum_macros::{Display, EnumString, EnumVariantNames};
use url::Url;
/// Supported uri schemes for parsing
#[derive(Debug, PartialEq, EnumString, EnumVariantNames, Clone, Display, Copy)]
#[strum(serialize_all = "kebab_case")]
pub enum Scheme {
/// Represents `file://` url scheme
File,
/// Represents `ftp://` url scheme
Ftp,
/// Represents `ftps://` url scheme
Ftps,
/// Represents `git://` url scheme
Git,
/// Represents `git+ssh://` url scheme
#[strum(serialize = "git+ssh")]
GitSsh,
/// Represents `http://` url scheme
Http,
/// Represents `https://` url scheme
Https,
/// Represents `ssh://` url scheme
Ssh,
/// Represents No url scheme
Unspecified,
}
/// GitUrl represents an input url that is a url used by git
/// Internally during parsing the url is sanitized and uses the `url` crate to perform
/// the majority of the parsing effort, and with some extra handling to expose
/// metadata used my many git hosting services
#[derive(Debug, PartialEq, Clone)]
pub struct GitUrl {
/// The fully qualified domain name (FQDN) or IP of the repo
pub host: Option<String>,
/// The name of the repo
pub name: String,
/// The owner/account/project name
pub owner: Option<String>,
/// The organization name. Supported by Azure DevOps
pub organization: Option<String>,
/// The full name of the repo, formatted as "owner/name"
pub fullname: String,
/// The git url scheme
pub scheme: Scheme,
/// The authentication user
pub user: Option<String>,
/// The oauth token (could appear in the https urls)
pub token: Option<String>,
/// The non-conventional port where git service is hosted
pub port: Option<u16>,
/// The path to repo w/ respect to user + hostname
pub path: String,
/// Indicate if url uses the .git suffix
pub git_suffix: bool,
/// Indicate if url explicitly uses its scheme
pub scheme_prefix: bool,
}
/// Build the printable GitUrl from its components
impl fmt::Display for GitUrl {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let scheme_prefix = match self.scheme_prefix {
true => format!("{}://", self.scheme),
false => format!(""),
};
let auth_info = match self.scheme {
Scheme::Ssh | Scheme::Git | Scheme::GitSsh => {
if let Some(user) = &self.user {
format!("{}@", user)
} else {
format!("")
}
}
Scheme::Http | Scheme::Https => match (&self.user, &self.token) {
(Some(user), Some(token)) => format!("{}:{}@", user, token),
(Some(user), None) => format!("{}@", user),
(None, Some(token)) => format!("{}@", token),
(None, None) => format!(""),
},
_ => format!(""),
};
let host = match &self.host {
Some(host) => format!("{}", host),
None => format!(""),
};
let port = match &self.port {
Some(p) => format!(":{}", p),
None => format!(""),
};
let path = match &self.scheme {
Scheme::Ssh => {
if self.port.is_some() {
format!("/{}", &self.path)
} else {
format!(":{}", &self.path)
}
}
_ => format!("{}", &self.path),
};
let git_url_str = format!("{}{}{}{}{}", scheme_prefix, auth_info, host, port, path);
write!(f, "{}", git_url_str)
}
}
impl Default for GitUrl {
fn default() -> Self {
GitUrl {
host: None,
name: "".to_string(),
owner: None,
organization: None,
fullname: "".to_string(),
scheme: Scheme::Unspecified,
user: None,
token: None,
port: None,
path: "".to_string(),
git_suffix: false,
scheme_prefix: false,
}
}
}
impl GitUrl {
/// Returns `GitUrl` after removing `user` and `token` values
/// Intended use-case is for non-destructive printing GitUrl excluding any embedded auth info
pub fn trim_auth(&self) -> GitUrl {
let mut new_giturl = self.clone();
new_giturl.user = None;
new_giturl.token = None;
new_giturl
}
/// Returns a `Result<GitUrl>` after normalizing and parsing `url` for metadata
pub fn parse(url: &str) -> Result<GitUrl> {
// Normalize the url so we can use Url crate to process ssh urls
let normalized = normalize_url(url).expect("Url normalization failed");
// Some pre-processing for paths
let scheme = Scheme::from_str(normalized.scheme())
.expect(&format!("Scheme unsupported: {:?}", normalized.scheme()));
// Normalized ssh urls can always have their first '/' removed
let urlpath = match &scheme {
Scheme::Ssh => {
// At the moment, we're relying on url::Url's parse() behavior to not duplicate
// the leading '/' when we normalize
normalized.path()[1..].to_string()
}
_ => normalized.path().to_string(),
};
let git_suffix_check = &urlpath.ends_with(".git");
// Parse through path for name,owner,organization
// Support organizations for Azure Devops
debug!("The urlpath: {:?}", &urlpath);
// Most git services use the path for metadata in the same way, so we're going to separate
// the metadata
// ex. github.com/accountname/reponame
// owner = accountname
// name = reponame
//
// organizations are going to be supported on a per-host basis
let splitpath = &urlpath.rsplit_terminator("/").collect::<Vec<&str>>();
debug!("rsplit results for metadata: {:?}", splitpath);
let name = splitpath[0].trim_end_matches(".git").to_string();
let (owner, organization, fullname) = match &scheme {
// We're not going to assume anything about metadata from a filepath
Scheme::File => (None::<String>, None::<String>, name.clone()),
_ => {
let mut fullname: Vec<&str> = Vec::new();
// TODO: Add support for parsing out orgs from these urls
let hosts_w_organization_in_path = vec!["dev.azure.com", "ssh.dev.azure.com"];
//vec!["dev.azure.com", "ssh.dev.azure.com", "visualstudio.com"];
match hosts_w_organization_in_path.contains(&normalized.clone().host_str().unwrap())
{
true => {
debug!("Found a git provider with an org");
// The path differs between git:// and https:// schemes
match &scheme {
// Example: "[email protected]:v3/CompanyName/ProjectName/RepoName",
Scheme::Ssh => {
// Organization
fullname.push(splitpath[2].clone());
// Project/Owner name
fullname.push(splitpath[1].clone());
// Repo name
fullname.push(splitpath[0].clone());
(
Some(splitpath[1].to_string()),
Some(splitpath[2].to_string()),
fullname.join("/").to_string(),
)
}
// Example: "https://[email protected]/CompanyName/ProjectName/_git/RepoName",
Scheme::Https => {
// Organization
fullname.push(splitpath[3].clone());
// Project/Owner name
fullname.push(splitpath[2].clone());
// Repo name
fullname.push(splitpath[0].clone());
(
Some(splitpath[2].to_string()),
Some(splitpath[3].to_string()),
fullname.join("/").to_string(),
)
}
_ => panic!("Scheme not supported for host"),
}
}
false => {
// push owner
fullname.push(splitpath[1]);
// push name
fullname.push(name.as_str());
(
Some(splitpath[1].to_string()),
None::<String>,
fullname.join("/").to_string(),
)
}
}
}
};
let final_scheme = Scheme::from_str(normalized.scheme()).expect("Scheme unsupported");
let final_host = match final_scheme {
Scheme::File => None,
_ => match normalized.host_str() {
Some(h) => Some(h.to_string()),
None => None,
},
};
let final_path = match final_scheme {
Scheme::File => {
if let Some(host) = normalized.host_str() {
format!("{}{}", host, urlpath)
} else {
urlpath
}
},
_ => urlpath,
};
Ok(GitUrl {
host: final_host,
name: name,
owner: owner,
organization: organization,
fullname: fullname,
scheme: final_scheme,
user: match normalized.username().to_string().len() {
0 => None,
_ => Some(normalized.username().to_string()),
},
token: match normalized.password() {
Some(p) => Some(p.to_string()),
None => None,
},
port: normalized.port(),
path: final_path,
git_suffix: *git_suffix_check,
scheme_prefix: url.contains("://"),
..Default::default()
})
}
}
/// `normalize_ssh_url` takes in an ssh url that separates the login info
/// from the path into with a `:` and replaces it with `/`.
///
/// Prepends `ssh://` to url
///
/// Supports absolute and relative paths
fn normalize_ssh_url(url: &str) -> Result<Url> {
let u = url.split(":").collect::<Vec<&str>>();
match u.len() {
2 => {
debug!("Normalizing ssh url: {:?}", u);
normalize_url(&format!("ssh://{}/{}", u[0], u[1]))
}
3 => {
debug!("Normalizing ssh url with ports: {:?}", u);
normalize_url(&format!("ssh://{}:{}/{}", u[0], u[1], u[2]))
}
_default => {
panic!("SSH normalization pattern not covered for: {:?}", u);
}
}
}
/// `normalize_file_path` takes in a filepath and uses `Url::from_file_path()` to parse
///
/// Prepends `file://` to url
fn normalize_file_path(filepath: &str) -> Result<Url> {
let fp = Url::from_file_path(filepath);
match fp {
Ok(path) => Ok(path),
Err(_e) => {
Ok(normalize_url(&format!("file://{}", filepath))
.expect("file:// normalization failed"))
}
}
}
/// `normalize_url` takes in url as `&str` and takes an opinionated approach to identify
/// `ssh://` or `file://` urls that require more information to be added so that
/// they can be parsed more effectively by `url::Url::parse()`
pub fn normalize_url(url: &str) -> Result<Url> {
debug!("Processing: {:?}", &url);
// We're going to remove any trailing slash before running through Url::parse
let trim_url = url.trim_end_matches("/");
let url_parse = Url::parse(&trim_url);
Ok(match url_parse {
Ok(u) => {
match Scheme::from_str(u.scheme()) {
Ok(_p) => u,
Err(_e) => {
// Catch case when an ssh url is given w/o a user
debug!("Scheme parse fail. Assuming a userless ssh url");
normalize_ssh_url(trim_url)?
}
}
}
Err(_e) => {
// e will most likely be url::ParseError::RelativeUrlWithoutBase
// If we're here, we're only looking for Scheme::Ssh or Scheme::File
// Assuming we have found Scheme::Ssh if we can find an "@" before ":"
// Otherwise we have Scheme::File
let re = Regex::new(r"^\S+(@)\S+(:).*$")?;
match re.is_match(&trim_url) {
true => {
debug!("Scheme::SSH match for normalization");
normalize_ssh_url(trim_url)?
}
false => {
debug!("Scheme::File match for normalization");
normalize_file_path(&format!("{}", trim_url))?
}
}
}
})
}