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
//! Execution support for shell.
use std::{io::Read, path::Path};
use crate::{
ExecutionControlFlow, ExecutionParameters, ExecutionResult, arithmetic::Evaluatable as _,
callstack, error, interp::Execute as _, openfiles, trace_categories,
};
impl<SE: crate::extensions::ShellExtensions> crate::Shell<SE> {
/// Returns the default execution parameters for this shell.
pub fn default_exec_params(&self) -> ExecutionParameters {
ExecutionParameters::default()
}
pub(super) async fn source_if_exists(
&mut self,
path: impl AsRef<Path>,
params: &ExecutionParameters,
) -> Result<bool, error::Error> {
let path = path.as_ref();
if path.exists() {
self.source_script(path, std::iter::empty::<String>(), params)
.await?;
Ok(true)
} else {
tracing::debug!("skipping non-existent file: {}", path.display());
Ok(false)
}
}
/// Source the given file as a shell script, returning the execution result.
///
/// # Arguments
///
/// * `path` - The path to the file to source.
/// * `args` - The arguments to pass to the script as positional parameters.
/// * `params` - Execution parameters.
pub async fn source_script<S: Into<String>, P: AsRef<Path>, I: Iterator<Item = S>>(
&mut self,
path: P,
args: I,
params: &ExecutionParameters,
) -> Result<ExecutionResult, error::Error> {
self.parse_and_execute_script_file(
path.as_ref(),
args,
params,
callstack::ScriptCallType::Source,
)
.await
}
/// Parse and execute the given file as a shell script, returning the execution result.
///
/// # Arguments
///
/// * `path` - The path to the file to source.
/// * `args` - The arguments to pass to the script as positional parameters.
/// * `params` - Execution parameters.
/// * `call_type` - The type of script call being made.
async fn parse_and_execute_script_file<
S: Into<String>,
P: AsRef<Path>,
I: Iterator<Item = S>,
>(
&mut self,
path: P,
args: I,
params: &ExecutionParameters,
call_type: callstack::ScriptCallType,
) -> Result<ExecutionResult, error::Error> {
let path = path.as_ref();
tracing::debug!("sourcing: {}", path.display());
let mut options = std::fs::File::options();
options.read(true);
let opened_file: openfiles::OpenFile = self
.open_file(&options, path, params)
.map_err(|e| error::ErrorKind::FailedSourcingFile(path.to_owned(), e))?;
if opened_file.is_dir() {
return Err(error::ErrorKind::FailedSourcingFile(
path.to_owned(),
std::io::Error::from(std::io::ErrorKind::IsADirectory),
)
.into());
}
let source_info = crate::SourceInfo::from(path.to_owned());
let mut result = self
.source_file(opened_file, &source_info, args, params, call_type)
.await?;
// Handle control flow at script execution boundary. If execution completed
// with a `return`, we need to clear it since it's already been "used". All
// other control flow types are preserved.
if matches!(
result.next_control_flow,
ExecutionControlFlow::ReturnFromFunctionOrScript
) {
result.next_control_flow = ExecutionControlFlow::Normal;
}
Ok(result)
}
/// Source the given file as a shell script, returning the execution result.
///
/// # Arguments
///
/// * `file` - The file to source.
/// * `source_info` - Information about the source of the script.
/// * `args` - The arguments to pass to the script as positional parameters.
/// * `params` - Execution parameters.
/// * `call_type` - The type of script call being made.
async fn source_file<F: Read, S: Into<String>, I: Iterator<Item = S>>(
&mut self,
file: F,
source_info: &crate::SourceInfo,
args: I,
params: &ExecutionParameters,
call_type: callstack::ScriptCallType,
) -> Result<ExecutionResult, error::Error> {
let mut reader = std::io::BufReader::new(file);
let mut parser = brush_parser::Parser::new(&mut reader, &self.parser_options());
tracing::debug!(target: trace_categories::PARSE, "Parsing sourced file: {}", source_info.source);
let parse_result = parser.parse_program();
let script_positional_args = args.map(Into::into);
self.call_stack
.push_script(call_type, source_info, script_positional_args);
let result = self
.run_parsed_result(parse_result, source_info, params)
.await;
self.call_stack.pop();
result
}
/// Executes the given string as a shell program, returning the resulting exit status.
///
/// # Arguments
///
/// * `command` - The command to execute.
/// * `source_info` - Information about the source of the command text.
/// * `params` - Execution parameters.
pub async fn run_string<S: Into<String>>(
&mut self,
command: S,
source_info: &crate::SourceInfo,
params: &ExecutionParameters,
) -> Result<ExecutionResult, error::Error> {
let parse_result = self.parse_string(command);
self.run_parsed_result(parse_result, source_info, params)
.await
}
/// Executes the given script file, returning the resulting exit status.
///
/// # Arguments
///
/// * `script_path` - The path to the script file to execute.
/// * `args` - The arguments to pass to the script as positional parameters.
pub async fn run_script<S: Into<String>, P: AsRef<Path>, I: Iterator<Item = S>>(
&mut self,
script_path: P,
args: I,
) -> Result<ExecutionResult, error::Error> {
let params = self.default_exec_params();
let result = self
.parse_and_execute_script_file(
script_path.as_ref(),
args,
¶ms,
callstack::ScriptCallType::Run,
)
.await?;
let _ = self.on_exit().await;
Ok(result)
}
pub(crate) async fn run_parsed_result(
&mut self,
parse_result: Result<brush_parser::ast::Program, brush_parser::ParseError>,
source_info: &crate::SourceInfo,
params: &ExecutionParameters,
) -> Result<ExecutionResult, error::Error> {
// If parsing succeeded, run the program. If there's a parse error, it's fatal (per spec).
let result = match parse_result {
Ok(prog) => self.run_program(prog, params).await,
Err(parse_err) => Err(error::Error::from(error::ErrorKind::ParseError(
parse_err,
source_info.clone(),
))
.into_fatal()),
};
// Report any errors.
match result {
Ok(result) => Ok(result),
Err(err) => {
let _ = self.display_error(&mut params.stderr(self), &err);
let result = err.into_result(self);
self.set_last_exit_status(result.exit_code.into());
Ok(result)
}
}
}
/// Executes the given parsed shell program, returning the resulting exit status.
///
/// # Arguments
///
/// * `program` - The program to execute.
/// * `params` - Execution parameters.
pub async fn run_program(
&mut self,
program: brush_parser::ast::Program,
params: &ExecutionParameters,
) -> Result<ExecutionResult, error::Error> {
program.execute(self, params).await
}
/// Evaluate the given arithmetic expression, returning the result.
pub fn eval_arithmetic(
&mut self,
expr: &brush_parser::ast::ArithmeticExpr,
) -> Result<i64, error::Error> {
Ok(expr.eval(self)?)
}
}