1use std::collections::HashMap;
2use std::path::Path;
3
4use crate::parser_warn as warn;
5use crate::parsers::utils::{
6 MAX_ITERATION_COUNT, RecursionGuard, read_file_to_string, truncate_field,
7};
8use packageurl::PackageUrl;
9use serde_json::Value as JsonValue;
10
11use crate::models::{
12 DatasourceId, Dependency, PackageData, PackageType, ResolvedPackage, Sha256Digest,
13};
14
15use super::PackageParser;
16
17pub struct HexLockParser;
18
19#[derive(Clone, Debug)]
20enum Term {
21 Map(Vec<(Term, Term)>),
22 Tuple(Vec<Term>),
23 List(Vec<Term>),
24 KeywordList(Vec<(String, Term)>),
25 String(String),
26 Atom(String),
27 Bool(bool),
28 Integer(i64),
29}
30
31struct Parser<'a> {
32 chars: Vec<char>,
33 pos: usize,
34 source: &'a str,
35 guard: RecursionGuard<()>,
36}
37
38impl PackageParser for HexLockParser {
39 const PACKAGE_TYPE: PackageType = PackageType::Hex;
40
41 fn is_match(path: &Path) -> bool {
42 path.file_name().and_then(|name| name.to_str()) == Some("mix.lock")
43 }
44
45 fn extract_packages(path: &Path) -> Vec<PackageData> {
46 let content = match read_file_to_string(path, None) {
47 Ok(content) => content,
48 Err(e) => {
49 warn!("Failed to read mix.lock at {:?}: {}", path, e);
50 return vec![default_package_data()];
51 }
52 };
53
54 match parse_mix_lock(&content) {
55 Ok(package_data) => vec![package_data],
56 Err(e) => {
57 warn!("Failed to parse mix.lock at {:?}: {}", path, e);
58 vec![default_package_data()]
59 }
60 }
61 }
62}
63
64fn default_package_data() -> PackageData {
65 PackageData {
66 package_type: Some(PackageType::Hex),
67 primary_language: Some("Elixir".to_string()),
68 datasource_id: Some(DatasourceId::HexMixLock),
69 ..Default::default()
70 }
71}
72
73fn parse_mix_lock(content: &str) -> Result<PackageData, String> {
74 let mut parser = Parser::new(content);
75 let term = parser.parse_term()?;
76 parser.skip_ws();
77 if !parser.is_eof() {
78 return Err("Unexpected trailing content in mix.lock".to_string());
79 }
80
81 let entries = match term {
82 Term::Map(entries) => entries,
83 _ => return Err("mix.lock root must be a map".to_string()),
84 };
85
86 let mut dependencies = Vec::new();
87 for (key, value) in entries.into_iter().take(MAX_ITERATION_COUNT) {
88 if let Some(dep) = build_dependency_from_lock_entry(&key, &value)? {
89 dependencies.push(dep);
90 }
91 }
92
93 let mut package = default_package_data();
94 package.dependencies = dependencies;
95 Ok(package)
96}
97
98fn build_dependency_from_lock_entry(
99 key: &Term,
100 value: &Term,
101) -> Result<Option<Dependency>, String> {
102 let app_name = truncate_field(term_to_string(key)?);
103
104 let tuple = match value {
105 Term::Tuple(items) => items,
106 _ => return Ok(None),
107 };
108
109 if tuple.len() < 8 {
110 return Ok(None);
111 }
112
113 let kind = term_to_atom(&tuple[0])?;
114 if kind != "hex" {
115 return Ok(None);
116 }
117
118 let package_name = truncate_field(term_to_atom(&tuple[1])?);
119 let version = truncate_field(term_to_string(&tuple[2])?);
120 let inner_checksum = truncate_field(term_to_string(&tuple[3])?);
121 let managers = term_to_atom_list(&tuple[4])?;
122 let nested_dependencies = term_to_dependency_tuples(&tuple[5])?;
123 let repo = truncate_field(term_to_string(&tuple[6])?);
124 let outer_checksum = truncate_field(term_to_string(&tuple[7])?);
125
126 let purl = build_hex_purl(&package_name, Some(&version), Some(&repo));
127 let resolved_package = ResolvedPackage {
128 primary_language: Some("Elixir".to_string()),
129 download_url: None,
130 sha1: None,
131 sha256: Sha256Digest::from_hex(&inner_checksum).ok(),
132 sha512: None,
133 md5: None,
134 is_virtual: true,
135 extra_data: Some(HashMap::from([
136 (
137 "repo".to_string(),
138 JsonValue::String(truncate_field(repo.clone())),
139 ),
140 (
141 "outer_checksum".to_string(),
142 JsonValue::String(truncate_field(outer_checksum.clone())),
143 ),
144 (
145 "managers".to_string(),
146 JsonValue::Array(
147 managers
148 .into_iter()
149 .map(|m| JsonValue::String(truncate_field(m)))
150 .collect(),
151 ),
152 ),
153 ])),
154 dependencies: nested_dependencies
155 .into_iter()
156 .map(build_nested_dependency)
157 .collect::<Result<Vec<_>, _>>()?,
158 repository_homepage_url: Some(truncate_field(build_hexdocs_homepage(&package_name, &repo))),
159 repository_download_url: None,
160 api_data_url: Some(truncate_field(build_hex_api_url(&package_name, &repo))),
161 datasource_id: Some(DatasourceId::HexMixLock),
162 purl: build_hex_purl(&package_name, Some(&version), Some(&repo)).map(truncate_field),
163 ..ResolvedPackage::new(
164 PackageType::Hex,
165 if repo == "hexpm" {
166 String::new()
167 } else {
168 repo.clone()
169 },
170 package_name.clone(),
171 version.clone(),
172 )
173 };
174
175 Ok(Some(Dependency {
176 purl: purl.map(truncate_field),
177 extracted_requirement: Some(truncate_field(version)),
178 scope: Some("dependencies".to_string()),
179 is_runtime: None,
180 is_optional: None,
181 is_pinned: Some(true),
182 is_direct: None,
183 resolved_package: Some(Box::new(resolved_package)),
184 extra_data: Some(HashMap::from([(
185 "app".to_string(),
186 JsonValue::String(truncate_field(app_name)),
187 )])),
188 }))
189}
190
191fn build_nested_dependency(tuple: DependencyTuple) -> Result<Dependency, String> {
192 let package_name = truncate_field(
193 tuple
194 .hex_name
195 .clone()
196 .unwrap_or_else(|| tuple.app_name.clone()),
197 );
198 Ok(Dependency {
199 purl: build_hex_purl(&package_name, None, tuple.repo.as_deref()).map(truncate_field),
200 extracted_requirement: Some(truncate_field(tuple.requirement)),
201 scope: Some("dependencies".to_string()),
202 is_runtime: Some(!tuple.optional),
203 is_optional: Some(tuple.optional),
204 is_pinned: Some(false),
205 is_direct: Some(true),
206 resolved_package: None,
207 extra_data: None,
208 })
209}
210
211crate::register_parser!(
212 "Hex mix.lock lockfile",
213 &["**/mix.lock"],
214 "hex",
215 "Elixir",
216 Some("https://hexdocs.pm/mix/Mix.Tasks.Deps.html"),
217);
218
219#[derive(Debug)]
220struct DependencyTuple {
221 app_name: String,
222 requirement: String,
223 hex_name: Option<String>,
224 repo: Option<String>,
225 optional: bool,
226}
227
228fn term_to_dependency_tuples(term: &Term) -> Result<Vec<DependencyTuple>, String> {
229 let items = match term {
230 Term::List(items) => items,
231 _ => return Ok(Vec::new()),
232 };
233
234 let mut result = Vec::new();
235 for item in items.iter().take(MAX_ITERATION_COUNT) {
236 let tuple = match item {
237 Term::Tuple(items) if items.len() == 3 => items,
238 _ => continue,
239 };
240
241 let app_name = truncate_field(term_to_atom(&tuple[0])?);
242 let requirement = truncate_field(term_to_string(&tuple[1])?);
243 let opts = term_to_keyword_map(&tuple[2])?;
244 let hex_name = opts
245 .get("hex")
246 .map(term_to_atom)
247 .transpose()?
248 .map(truncate_field);
249 let repo = opts
250 .get("repo")
251 .map(term_to_string)
252 .transpose()?
253 .map(truncate_field);
254 let optional = opts
255 .get("optional")
256 .and_then(|term| match term {
257 Term::Bool(value) => Some(*value),
258 _ => None,
259 })
260 .unwrap_or(false);
261
262 result.push(DependencyTuple {
263 app_name,
264 requirement,
265 hex_name,
266 repo,
267 optional,
268 });
269 }
270
271 Ok(result)
272}
273
274fn term_to_keyword_map(term: &Term) -> Result<HashMap<String, Term>, String> {
275 match term {
276 Term::KeywordList(entries) => Ok(entries.iter().cloned().collect()),
277 Term::List(entries) => {
278 let mut map = HashMap::new();
279 for entry in entries {
280 if let Term::Tuple(items) = entry
281 && items.len() == 2
282 {
283 map.insert(term_to_atom(&items[0])?, items[1].clone());
284 }
285 }
286 Ok(map)
287 }
288 _ => Ok(HashMap::new()),
289 }
290}
291
292fn build_hex_purl(name: &str, version: Option<&str>, repo: Option<&str>) -> Option<String> {
293 let mut purl = PackageUrl::new("hex", name).ok()?;
294 if let Some(repo) = repo
295 && repo != "hexpm"
296 {
297 purl.with_namespace(repo).ok()?;
298 }
299 if let Some(version) = version {
300 purl.with_version(version).ok()?;
301 }
302 Some(purl.to_string())
303}
304
305fn build_hexdocs_homepage(name: &str, repo: &str) -> String {
306 if repo == "hexpm" {
307 format!("https://hex.pm/packages/{}", name)
308 } else {
309 format!("https://hex.pm/packages/{}?repo={}", name, repo)
310 }
311}
312
313fn build_hex_api_url(name: &str, repo: &str) -> String {
314 if repo == "hexpm" {
315 format!("https://hex.pm/api/packages/{}", name)
316 } else {
317 format!("https://hex.pm/api/repos/{}/packages/{}", repo, name)
318 }
319}
320
321fn term_to_string(term: &Term) -> Result<String, String> {
322 match term {
323 Term::String(value) => Ok(value.clone()),
324 Term::Atom(value) => Ok(value.clone()),
325 Term::Integer(value) => Ok(value.to_string()),
326 _ => Err("Expected string-like term".to_string()),
327 }
328}
329
330fn term_to_atom(term: &Term) -> Result<String, String> {
331 match term {
332 Term::Atom(value) => Ok(value.clone()),
333 _ => Err("Expected atom".to_string()),
334 }
335}
336
337fn term_to_atom_list(term: &Term) -> Result<Vec<String>, String> {
338 let items = match term {
339 Term::List(items) => items,
340 _ => return Ok(Vec::new()),
341 };
342 items.iter().map(term_to_atom).collect()
343}
344
345impl<'a> Parser<'a> {
346 fn new(source: &'a str) -> Self {
347 Self {
348 chars: source.chars().collect(),
349 pos: 0,
350 source,
351 guard: RecursionGuard::depth_only(),
352 }
353 }
354
355 fn parse_term(&mut self) -> Result<Term, String> {
356 if self.guard.descend() {
357 return Err("recursion depth exceeded".to_string());
358 }
359 self.skip_ws();
360 let result = match self.peek() {
361 Some('%') => self.parse_map(),
362 Some('{') => self.parse_tuple(),
363 Some('[') => self.parse_list(),
364 Some('"') => self.parse_string().map(Term::String),
365 Some(':') => self.parse_atom().map(Term::Atom),
366 Some(c) if c.is_ascii_digit() || c == '-' => self.parse_integer().map(Term::Integer),
367 Some('t') | Some('f') => self.parse_bool().map(Term::Bool),
368 Some(other) => Err(format!("Unexpected character '{}' at {}", other, self.pos)),
369 None => Err("Unexpected end of mix.lock".to_string()),
370 };
371 self.guard.ascend();
372 result
373 }
374
375 fn parse_map(&mut self) -> Result<Term, String> {
376 self.expect('%')?;
377 self.expect('{')?;
378 let mut entries = Vec::new();
379 let mut count = 0usize;
380 loop {
381 self.skip_ws();
382 if self.peek() == Some('}') {
383 self.pos += 1;
384 break;
385 }
386 if count >= MAX_ITERATION_COUNT {
387 warn!("map entry count exceeded MAX_ITERATION_COUNT in mix.lock");
388 break;
389 }
390 let key = self.parse_term()?;
391 self.skip_ws();
392 if self.starts_with("=>") {
393 self.expect_sequence("=>")?;
394 } else {
395 self.expect(':')?;
396 }
397 let value = self.parse_term()?;
398 entries.push((key, value));
399 count += 1;
400 self.skip_ws();
401 if self.peek() == Some(',') {
402 self.pos += 1;
403 }
404 }
405 Ok(Term::Map(entries))
406 }
407
408 fn parse_tuple(&mut self) -> Result<Term, String> {
409 self.expect('{')?;
410 let mut items = Vec::new();
411 let mut count = 0usize;
412 loop {
413 self.skip_ws();
414 if self.peek() == Some('}') {
415 self.pos += 1;
416 break;
417 }
418 if count >= MAX_ITERATION_COUNT {
419 warn!("tuple item count exceeded MAX_ITERATION_COUNT in mix.lock");
420 break;
421 }
422 items.push(self.parse_term()?);
423 count += 1;
424 self.skip_ws();
425 if self.peek() == Some(',') {
426 self.pos += 1;
427 }
428 }
429 Ok(Term::Tuple(items))
430 }
431
432 fn parse_list(&mut self) -> Result<Term, String> {
433 self.expect('[')?;
434 let mut keyword_entries = Vec::new();
435 let mut items = Vec::new();
436 let mut saw_keyword = false;
437 let mut count = 0usize;
438
439 loop {
440 self.skip_ws();
441 if self.peek() == Some(']') {
442 self.pos += 1;
443 break;
444 }
445 if count >= MAX_ITERATION_COUNT {
446 warn!("list item count exceeded MAX_ITERATION_COUNT in mix.lock");
447 break;
448 }
449
450 if let Some(keyword) = self.try_parse_keyword_key() {
451 saw_keyword = true;
452 let value = self.parse_term()?;
453 keyword_entries.push((keyword, value));
454 } else {
455 items.push(self.parse_term()?);
456 }
457
458 count += 1;
459 self.skip_ws();
460 if self.peek() == Some(',') {
461 self.pos += 1;
462 }
463 }
464
465 if saw_keyword && items.is_empty() {
466 Ok(Term::KeywordList(keyword_entries))
467 } else if saw_keyword {
468 let mut merged = items;
469 merged.extend(
470 keyword_entries
471 .into_iter()
472 .map(|(k, v)| Term::Tuple(vec![Term::Atom(k), v])),
473 );
474 Ok(Term::List(merged))
475 } else {
476 Ok(Term::List(items))
477 }
478 }
479
480 fn try_parse_keyword_key(&mut self) -> Option<String> {
481 let saved = self.pos;
482 self.skip_ws();
483 let start = self.pos;
484 while let Some(c) = self.peek() {
485 if c.is_ascii_alphanumeric() || c == '_' || c == '?' || c == '!' {
486 self.pos += 1;
487 } else {
488 break;
489 }
490 }
491 if self.pos == start || self.peek() != Some(':') || self.peek_n(1) == Some(':') {
492 self.pos = saved;
493 return None;
494 }
495 let key: String = self.chars[start..self.pos].iter().collect();
496 self.pos += 1;
497 Some(key)
498 }
499
500 fn parse_string(&mut self) -> Result<String, String> {
501 self.expect('"')?;
502 let mut out = String::new();
503 while let Some(c) = self.peek() {
504 self.pos += 1;
505 match c {
506 '"' => return Ok(out),
507 '\\' => {
508 let escaped = self
509 .peek()
510 .ok_or_else(|| "Unterminated string escape".to_string())?;
511 self.pos += 1;
512 out.push(match escaped {
513 'n' => '\n',
514 'r' => '\r',
515 't' => '\t',
516 '"' => '"',
517 '\\' => '\\',
518 other => other,
519 });
520 }
521 other => out.push(other),
522 }
523 }
524 Err("Unterminated string literal".to_string())
525 }
526
527 fn parse_atom(&mut self) -> Result<String, String> {
528 self.expect(':')?;
529 let start = self.pos;
530 while let Some(c) = self.peek() {
531 if c.is_ascii_alphanumeric() || c == '_' || c == '?' || c == '!' || c == '@' {
532 self.pos += 1;
533 } else {
534 break;
535 }
536 }
537 if self.pos == start {
538 return Err("Expected atom after ':'".to_string());
539 }
540 Ok(self.chars[start..self.pos].iter().collect())
541 }
542
543 fn parse_integer(&mut self) -> Result<i64, String> {
544 let start = self.pos;
545 if self.peek() == Some('-') {
546 self.pos += 1;
547 }
548 while let Some(c) = self.peek() {
549 if c.is_ascii_digit() {
550 self.pos += 1;
551 } else {
552 break;
553 }
554 }
555 self.source[start..self.byte_index(self.pos)]
556 .parse::<i64>()
557 .map_err(|e| format!("Invalid integer: {}", e))
558 }
559
560 fn parse_bool(&mut self) -> Result<bool, String> {
561 if self.starts_with("true") {
562 self.pos += 4;
563 Ok(true)
564 } else if self.starts_with("false") {
565 self.pos += 5;
566 Ok(false)
567 } else {
568 Err("Invalid boolean".to_string())
569 }
570 }
571
572 fn skip_ws(&mut self) {
573 while let Some(c) = self.peek() {
574 if c.is_whitespace() {
575 self.pos += 1;
576 } else {
577 break;
578 }
579 }
580 }
581
582 fn expect(&mut self, expected: char) -> Result<(), String> {
583 match self.peek() {
584 Some(c) if c == expected => {
585 self.pos += 1;
586 Ok(())
587 }
588 Some(c) => Err(format!("Expected '{}' but found '{}'", expected, c)),
589 None => Err(format!("Expected '{}' but reached end of input", expected)),
590 }
591 }
592
593 fn expect_sequence(&mut self, expected: &str) -> Result<(), String> {
594 if self.starts_with(expected) {
595 self.pos += expected.chars().count();
596 Ok(())
597 } else {
598 Err(format!("Expected '{}' at {}", expected, self.pos))
599 }
600 }
601
602 fn starts_with(&self, s: &str) -> bool {
603 self.chars[self.pos..]
604 .iter()
605 .collect::<String>()
606 .starts_with(s)
607 }
608
609 fn peek(&self) -> Option<char> {
610 self.chars.get(self.pos).copied()
611 }
612
613 fn peek_n(&self, n: usize) -> Option<char> {
614 self.chars.get(self.pos + n).copied()
615 }
616
617 fn is_eof(&self) -> bool {
618 self.pos >= self.chars.len()
619 }
620
621 fn byte_index(&self, char_pos: usize) -> usize {
622 self.chars.iter().take(char_pos).map(|c| c.len_utf8()).sum()
623 }
624}