1use noodles::sam;
2use noodles::sam::header::record::value::{
3 Map,
4 map::{Program as SamProgram, program::tag},
5};
6use rsomics_common::{Result, RsomicsError};
7
8pub(crate) fn command_line() -> String {
9 std::env::args_os()
10 .map(|argument| argument.to_string_lossy().replace(['\t', '\r', '\n'], " "))
11 .collect::<Vec<_>>()
12 .join(" ")
13}
14
15#[derive(Clone, Copy, Debug, Eq, PartialEq)]
16pub struct Program<'a> {
17 name: &'a str,
18 version: &'a str,
19 command_line: &'a str,
20}
21
22impl<'a> Program<'a> {
23 pub fn new(name: &'a str, version: &'a str, command_line: &'a str) -> Result<Self> {
24 if name.is_empty() || version.is_empty() {
25 return Err(RsomicsError::InvalidInput(
26 "program name and version cannot be empty".to_owned(),
27 ));
28 }
29 if [name, version, command_line]
30 .iter()
31 .any(|value| value.contains(['\t', '\r', '\n']))
32 {
33 return Err(RsomicsError::InvalidInput(
34 "program header fields cannot contain tabs or line breaks".to_owned(),
35 ));
36 }
37 Ok(Self {
38 name,
39 version,
40 command_line,
41 })
42 }
43
44 pub(crate) fn add_to(self, header: &mut sam::Header) -> Result<Vec<u8>> {
45 let programs = header.programs_mut().as_mut();
46 let previous = programs.last().map(|(id, _)| id.clone());
47 let mut id = self.name.to_owned();
48 let mut suffix = 0u64;
49
50 while programs.contains_key(id.as_bytes()) {
51 suffix = suffix.checked_add(1).ok_or_else(|| {
52 RsomicsError::InvalidInput("program ID suffix exceeds u64".to_owned())
53 })?;
54 id = format!("{}.{}", self.name, suffix);
55 }
56
57 let mut builder = Map::<SamProgram>::builder()
58 .insert(tag::NAME, self.name)
59 .insert(tag::VERSION, self.version)
60 .insert(tag::COMMAND_LINE, self.command_line);
61 if let Some(previous) = previous {
62 builder = builder.insert(tag::PREVIOUS_PROGRAM_ID, previous);
63 }
64 let map = builder.build().map_err(|error| {
65 RsomicsError::InvalidInput(format!("building program record: {error}"))
66 })?;
67 let id = id.into_bytes();
68 programs.insert(id.clone().into(), map);
69 Ok(id)
70 }
71}
72
73#[cfg(test)]
74mod tests {
75 use noodles::sam::header::record::value::map::program::tag;
76
77 use super::*;
78
79 #[test]
80 fn adds_after_the_last_existing_record_with_a_unique_id() {
81 let mut header = sam::Header::builder()
82 .add_program("rsomics-bam", Map::default())
83 .add_program("aligner", Map::default())
84 .build();
85 Program::new("rsomics-bam", "1.2.3", "rsomics-bam view input.bam")
86 .unwrap()
87 .add_to(&mut header)
88 .unwrap();
89
90 let program = &header.programs().as_ref()[b"rsomics-bam.1".as_slice()];
91 assert_eq!(
92 program
93 .other_fields()
94 .get(&tag::PREVIOUS_PROGRAM_ID)
95 .map(|value| value.as_ref()),
96 Some(b"aligner".as_slice())
97 );
98 assert_eq!(
99 program
100 .other_fields()
101 .get(&tag::NAME)
102 .map(|value| value.as_ref()),
103 Some(b"rsomics-bam".as_slice())
104 );
105 assert_eq!(
106 program
107 .other_fields()
108 .get(&tag::VERSION)
109 .map(|value| value.as_ref()),
110 Some(b"1.2.3".as_slice())
111 );
112 }
113
114 #[test]
115 fn fields_cannot_create_header_fields_or_lines() {
116 assert!(Program::new("rsomics-bam", "1.2.3", "view\tinput.bam").is_err());
117 assert!(Program::new("", "1.2.3", "view input.bam").is_err());
118 }
119}