git.iko.soy/bat
on v0.18.2 help sign in
bat/src/input.rs
330 lines 9.7 kB history raw
1use std::convert::TryFrom;
2use std::fs::File;
3use std::io::{self, BufRead, BufReader, Read};
4use std::path::{Path, PathBuf};
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(PathBuf),
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<PathBuf>,
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(PathBuf),
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: impl AsRef<Path>) -> Self {
113 Self::_ordinary_file(path.as_ref())
114 }
116 fn _ordinary_file(path: &Path) -> Self {
117 let kind = InputKind::OrdinaryFile(path.to_path_buf());
118 Input {
119 description: kind.description(),
120 metadata: InputMetadata::default(),
121 kind,
122 }
123 }
125 pub fn stdin() -> Self {
126 let kind = InputKind::StdIn;
127 Input {
128 description: kind.description(),
129 metadata: InputMetadata::default(),
130 kind,
131 }
132 }
134 pub fn from_reader(reader: Box<dyn Read + 'a>) -> Self {
135 let kind = InputKind::CustomReader(reader);
136 Input {
137 description: kind.description(),
138 metadata: InputMetadata::default(),
139 kind,
140 }
141 }
143 pub fn is_stdin(&self) -> bool {
144 matches!(self.kind, InputKind::StdIn)
145 }
147 pub fn with_name(self, provided_name: Option<impl AsRef<Path>>) -> Self {
148 self._with_name(provided_name.as_ref().map(|it| it.as_ref()))
149 }
151 fn _with_name(mut self, provided_name: Option<&Path>) -> Self {
152 if let Some(name) = provided_name {
153 self.description.name = name.to_string_lossy().to_string()
154 }
156 self.metadata.user_provided_name = provided_name.map(|n| n.to_owned());
157 self
158 }
160 pub fn description(&self) -> &InputDescription {
161 &self.description
162 }
164 pub fn description_mut(&mut self) -> &mut InputDescription {
165 &mut self.description
166 }
168 pub(crate) fn open<R: BufRead + 'a>(
169 self,
170 stdin: R,
171 stdout_identifier: Option<&Identifier>,
172 ) -> Result<OpenedInput<'a>> {
173 let description = self.description().clone();
174 match self.kind {
175 InputKind::StdIn => {
176 if let Some(stdout) = stdout_identifier {
177 let input_identifier = Identifier::try_from(clircle::Stdio::Stdin)
178 .map_err(|e| format!("Stdin: Error identifying file: {}", e))?;
179 if stdout.surely_conflicts_with(&input_identifier) {
180 return Err("IO circle detected. The input from stdin is also an output. Aborting to avoid infinite loop.".into());
181 }
182 }
184 Ok(OpenedInput {
185 kind: OpenedInputKind::StdIn,
186 description,
187 metadata: self.metadata,
188 reader: InputReader::new(stdin),
189 })
190 }
192 InputKind::OrdinaryFile(path) => Ok(OpenedInput {
193 kind: OpenedInputKind::OrdinaryFile(path.clone()),
194 description,
195 metadata: self.metadata,
196 reader: {
197 let mut file = File::open(&path)
198 .map_err(|e| format!("'{}': {}", path.to_string_lossy(), e))?;
199 if file.metadata()?.is_dir() {
200 return Err(format!("'{}' is a directory.", path.to_string_lossy()).into());
201 }
203 if let Some(stdout) = stdout_identifier {
204 let input_identifier = Identifier::try_from(file).map_err(|e| {
205 format!("{}: Error identifying file: {}", path.to_string_lossy(), e)
206 })?;
207 if stdout.surely_conflicts_with(&input_identifier) {
208 return Err(format!(
209 "IO circle detected. The input from '{}' is also an output. Aborting to avoid infinite loop.",
210 path.to_string_lossy()
211 )
212 .into());
213 }
214 file = input_identifier.into_inner().expect("The file was lost in the clircle::Identifier, this should not have happened...");
215 }
217 InputReader::new(BufReader::new(file))
218 },
219 }),
220 InputKind::CustomReader(reader) => Ok(OpenedInput {
221 description,
222 kind: OpenedInputKind::CustomReader,
223 metadata: self.metadata,
224 reader: InputReader::new(BufReader::new(reader)),
225 }),
226 }
227 }
230pub(crate) struct InputReader<'a> {
231 inner: Box<dyn BufRead + 'a>,
232 pub(crate) first_line: Vec<u8>,
233 pub(crate) content_type: Option<ContentType>,
236impl<'a> InputReader<'a> {
237 fn new<R: BufRead + 'a>(mut reader: R) -> InputReader<'a> {
238 let mut first_line = vec![];
239 reader.read_until(b'\n', &mut first_line).ok();
241 let content_type = if first_line.is_empty() {
242 None
243 } else {
244 Some(content_inspector::inspect(&first_line[..]))
245 };
247 if content_type == Some(ContentType::UTF_16LE) {
248 reader.read_until(0x00, &mut first_line).ok();
249 }
251 InputReader {
252 inner: Box::new(reader),
253 first_line,
254 content_type,
255 }
256 }
258 pub(crate) fn read_line(&mut self, buf: &mut Vec<u8>) -> io::Result<bool> {
259 if self.first_line.is_empty() {
260 let res = self.inner.read_until(b'\n', buf).map(|size| size > 0)?;
262 if self.content_type == Some(ContentType::UTF_16LE) {
263 self.inner.read_until(0x00, buf).ok();
264 }
266 Ok(res)
267 } else {
268 buf.append(&mut self.first_line);
269 Ok(true)
270 }
271 }
274#[test]
275fn basic() {
276 let content = b"#!/bin/bash\necho hello";
277 let mut reader = InputReader::new(&content[..]);
279 assert_eq!(b"#!/bin/bash\n", &reader.first_line[..]);
281 let mut buffer = vec![];
283 let res = reader.read_line(&mut buffer);
284 assert!(res.is_ok());
285 assert_eq!(true, res.unwrap());
286 assert_eq!(b"#!/bin/bash\n", &buffer[..]);
288 buffer.clear();
290 let res = reader.read_line(&mut buffer);
291 assert!(res.is_ok());
292 assert_eq!(true, res.unwrap());
293 assert_eq!(b"echo hello", &buffer[..]);
295 buffer.clear();
297 let res = reader.read_line(&mut buffer);
298 assert!(res.is_ok());
299 assert_eq!(false, res.unwrap());
300 assert!(buffer.is_empty());
303#[test]
304fn utf16le() {
305 let content = b"\xFF\xFE\x73\x00\x0A\x00\x64\x00";
306 let mut reader = InputReader::new(&content[..]);
308 assert_eq!(b"\xFF\xFE\x73\x00\x0A\x00", &reader.first_line[..]);
310 let mut buffer = vec![];
312 let res = reader.read_line(&mut buffer);
313 assert!(res.is_ok());
314 assert_eq!(true, res.unwrap());
315 assert_eq!(b"\xFF\xFE\x73\x00\x0A\x00", &buffer[..]);
317 buffer.clear();
319 let res = reader.read_line(&mut buffer);
320 assert!(res.is_ok());
321 assert_eq!(true, res.unwrap());
322 assert_eq!(b"\x64\x00", &buffer[..]);
324 buffer.clear();
326 let res = reader.read_line(&mut buffer);
327 assert!(res.is_ok());
328 assert_eq!(false, res.unwrap());
329 assert!(buffer.is_empty());