git.iko.soy/bat
on v0.18.0 help sign in
bat/src/input.rs
322 lines 9.5 kB history raw
1use std::convert::TryFrom;
2use std::ffi::{OsStr, OsString};
3use std::fs::File;
4use std::io::{self, BufRead, BufReader, Read};
6use clircle::{Clircle, Identifier};
7use content_inspector::{self, ContentType};
9use crate::error::*;
11/// A description of an Input source.
12/// This tells bat how to refer to the input.
13#[derive(Clone)]
14pub struct InputDescription {
15 pub(crate) name: String,
17 /// The input title.
18 /// This replaces the name if provided.
19 title: Option<String>,
21 /// The input kind.
22 kind: Option<String>,
24 /// A summary description of the input.
25 /// Defaults to "{kind} '{name}'"
26 summary: Option<String>,
29impl InputDescription {
30 /// Creates a description for an input.
31 pub fn new(name: impl Into<String>) -> Self {
32 InputDescription {
33 name: name.into(),
34 title: None,
35 kind: None,
36 summary: None,
37 }
38 }
40 pub fn set_kind(&mut self, kind: Option<String>) {
41 self.kind = kind;
42 }
44 pub fn set_summary(&mut self, summary: Option<String>) {
45 self.summary = summary;
46 }
48 pub fn set_title(&mut self, title: Option<String>) {
49 self.title = title;
50 }
52 pub fn title(&self) -> &String {
53 match self.title.as_ref() {
54 Some(ref title) => title,
55 None => &self.name,
56 }
57 }
59 pub fn kind(&self) -> Option<&String> {
60 self.kind.as_ref()
61 }
63 pub fn summary(&self) -> String {
64 self.summary.clone().unwrap_or_else(|| match &self.kind {
65 None => self.name.clone(),
66 Some(kind) => format!("{} '{}'", kind.to_lowercase(), self.name),
67 })
68 }
71pub(crate) enum InputKind<'a> {
72 OrdinaryFile(OsString),
73 StdIn,
74 CustomReader(Box<dyn Read + 'a>),
77impl<'a> InputKind<'a> {
78 pub fn description(&self) -> InputDescription {
79 match self {
80 InputKind::OrdinaryFile(ref path) => InputDescription::new(path.to_string_lossy()),
81 InputKind::StdIn => InputDescription::new("STDIN"),
82 InputKind::CustomReader(_) => InputDescription::new("READER"),
83 }
84 }
87#[derive(Clone, Default)]
88pub(crate) struct InputMetadata {
89 pub(crate) user_provided_name: Option<OsString>,
92pub struct Input<'a> {
93 pub(crate) kind: InputKind<'a>,
94 pub(crate) metadata: InputMetadata,
95 pub(crate) description: InputDescription,
98pub(crate) enum OpenedInputKind {
99 OrdinaryFile(OsString),
100 StdIn,
101 CustomReader,
104pub(crate) struct OpenedInput<'a> {
105 pub(crate) kind: OpenedInputKind,
106 pub(crate) metadata: InputMetadata,
107 pub(crate) reader: InputReader<'a>,
108 pub(crate) description: InputDescription,
111impl<'a> Input<'a> {
112 pub fn ordinary_file(path: &OsStr) -> Self {
113 let kind = InputKind::OrdinaryFile(path.to_os_string());
114 Input {
115 description: kind.description(),
116 metadata: InputMetadata::default(),
117 kind,
118 }
119 }
121 pub fn stdin() -> Self {
122 let kind = InputKind::StdIn;
123 Input {
124 description: kind.description(),
125 metadata: InputMetadata::default(),
126 kind,
127 }
128 }
130 pub fn from_reader(reader: Box<dyn Read + 'a>) -> Self {
131 let kind = InputKind::CustomReader(reader);
132 Input {
133 description: kind.description(),
134 metadata: InputMetadata::default(),
135 kind,
136 }
137 }
139 pub fn is_stdin(&self) -> bool {
140 matches!(self.kind, InputKind::StdIn)
141 }
143 pub fn with_name(mut self, provided_name: Option<&OsStr>) -> Self {
144 if let Some(name) = provided_name {
145 self.description.name = name.to_string_lossy().to_string()
146 }
148 self.metadata.user_provided_name = provided_name.map(|n| n.to_owned());
149 self
150 }
152 pub fn description(&self) -> &InputDescription {
153 &self.description
154 }
156 pub fn description_mut(&mut self) -> &mut InputDescription {
157 &mut self.description
158 }
160 pub(crate) fn open<R: BufRead + 'a>(
161 self,
162 stdin: R,
163 stdout_identifier: Option<&Identifier>,
164 ) -> Result<OpenedInput<'a>> {
165 let description = self.description().clone();
166 match self.kind {
167 InputKind::StdIn => {
168 if let Some(stdout) = stdout_identifier {
169 let input_identifier = Identifier::try_from(clircle::Stdio::Stdin)
170 .map_err(|e| format!("Stdin: Error identifying file: {}", e))?;
171 if stdout.surely_conflicts_with(&input_identifier) {
172 return Err("IO circle detected. The input from stdin is also an output. Aborting to avoid infinite loop.".into());
173 }
174 }
176 Ok(OpenedInput {
177 kind: OpenedInputKind::StdIn,
178 description,
179 metadata: self.metadata,
180 reader: InputReader::new(stdin),
181 })
182 }
184 InputKind::OrdinaryFile(path) => Ok(OpenedInput {
185 kind: OpenedInputKind::OrdinaryFile(path.clone()),
186 description,
187 metadata: self.metadata,
188 reader: {
189 let mut file = File::open(&path)
190 .map_err(|e| format!("'{}': {}", path.to_string_lossy(), e))?;
191 if file.metadata()?.is_dir() {
192 return Err(format!("'{}' is a directory.", path.to_string_lossy()).into());
193 }
195 if let Some(stdout) = stdout_identifier {
196 let input_identifier = Identifier::try_from(file).map_err(|e| {
197 format!("{}: Error identifying file: {}", path.to_string_lossy(), e)
198 })?;
199 if stdout.surely_conflicts_with(&input_identifier) {
200 return Err(format!(
201 "IO circle detected. The input from '{}' is also an output. Aborting to avoid infinite loop.",
202 path.to_string_lossy()
203 )
204 .into());
205 }
206 file = input_identifier.into_inner().expect("The file was lost in the clircle::Identifier, this should not have happended...");
207 }
209 InputReader::new(BufReader::new(file))
210 },
211 }),
212 InputKind::CustomReader(reader) => Ok(OpenedInput {
213 description,
214 kind: OpenedInputKind::CustomReader,
215 metadata: self.metadata,
216 reader: InputReader::new(BufReader::new(reader)),
217 }),
218 }
219 }
222pub(crate) struct InputReader<'a> {
223 inner: Box<dyn BufRead + 'a>,
224 pub(crate) first_line: Vec<u8>,
225 pub(crate) content_type: Option<ContentType>,
228impl<'a> InputReader<'a> {
229 fn new<R: BufRead + 'a>(mut reader: R) -> InputReader<'a> {
230 let mut first_line = vec![];
231 reader.read_until(b'\n', &mut first_line).ok();
233 let content_type = if first_line.is_empty() {
234 None
235 } else {
236 Some(content_inspector::inspect(&first_line[..]))
237 };
239 if content_type == Some(ContentType::UTF_16LE) {
240 reader.read_until(0x00, &mut first_line).ok();
241 }
243 InputReader {
244 inner: Box::new(reader),
245 first_line,
246 content_type,
247 }
248 }
250 pub(crate) fn read_line(&mut self, buf: &mut Vec<u8>) -> io::Result<bool> {
251 if self.first_line.is_empty() {
252 let res = self.inner.read_until(b'\n', buf).map(|size| size > 0)?;
254 if self.content_type == Some(ContentType::UTF_16LE) {
255 self.inner.read_until(0x00, buf).ok();
256 }
258 Ok(res)
259 } else {
260 buf.append(&mut self.first_line);
261 Ok(true)
262 }
263 }
266#[test]
267fn basic() {
268 let content = b"#!/bin/bash\necho hello";
269 let mut reader = InputReader::new(&content[..]);
271 assert_eq!(b"#!/bin/bash\n", &reader.first_line[..]);
273 let mut buffer = vec![];
275 let res = reader.read_line(&mut buffer);
276 assert!(res.is_ok());
277 assert_eq!(true, res.unwrap());
278 assert_eq!(b"#!/bin/bash\n", &buffer[..]);
280 buffer.clear();
282 let res = reader.read_line(&mut buffer);
283 assert!(res.is_ok());
284 assert_eq!(true, res.unwrap());
285 assert_eq!(b"echo hello", &buffer[..]);
287 buffer.clear();
289 let res = reader.read_line(&mut buffer);
290 assert!(res.is_ok());
291 assert_eq!(false, res.unwrap());
292 assert!(buffer.is_empty());
295#[test]
296fn utf16le() {
297 let content = b"\xFF\xFE\x73\x00\x0A\x00\x64\x00";
298 let mut reader = InputReader::new(&content[..]);
300 assert_eq!(b"\xFF\xFE\x73\x00\x0A\x00", &reader.first_line[..]);
302 let mut buffer = vec![];
304 let res = reader.read_line(&mut buffer);
305 assert!(res.is_ok());
306 assert_eq!(true, res.unwrap());
307 assert_eq!(b"\xFF\xFE\x73\x00\x0A\x00", &buffer[..]);
309 buffer.clear();
311 let res = reader.read_line(&mut buffer);
312 assert!(res.is_ok());
313 assert_eq!(true, res.unwrap());
314 assert_eq!(b"\x64\x00", &buffer[..]);
316 buffer.clear();
318 let res = reader.read_line(&mut buffer);
319 assert!(res.is_ok());
320 assert_eq!(false, res.unwrap());
321 assert!(buffer.is_empty());