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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
//! Utility struct, methods for various operations
use crate::auth::{AuthState, AuthType};
use crate::common::{ProcessInput, RadResult, RelayTarget};
use crate::error::RadError;
use crate::logger::WarningType;
use crate::{Processor, WriteOption};
use lazy_static::lazy_static;
use regex::Regex;
use std::ffi::OsStr;
use std::io::BufRead;
use std::path::Path;
lazy_static! {
/// Regex for trimming newlines from start and end
pub static ref TRIM: Regex = Regex::new(r"^[ \t\r\n]+|[ \t\r\n]+$").unwrap();
}
/// Trim macro to trim a text
#[macro_export]
macro_rules! trim {
($e:expr) => {
$crate::utils::TRIM.replace_all($e, "")
};
}
#[cfg(feature = "color")]
use colored::*;
/// Utility relates struct
pub(crate) struct Utils;
impl Utils {
/// Create a local name from level and name
pub(crate) fn local_name(level: usize, name: &str) -> String {
format!("{}.{}", level, name)
}
// Shamelessly copied from
// https://stackoverflow.com/questions/64517785/read-full-lines-from-stdin-including-n-until-end-of-file
/// Read full lines of bufread iterator which doesn't chop new lines
pub fn full_lines(mut input: impl BufRead) -> impl Iterator<Item = std::io::Result<String>> {
std::iter::from_fn(move || {
let mut vec = String::new();
match input.read_line(&mut vec) {
Ok(0) => None,
Ok(_) => Some(Ok(vec)),
Err(e) => Some(Err(e)),
}
})
}
/// Check if a character is a blank chracter
pub(crate) fn is_blank_char(ch: char) -> bool {
ch == ' ' || ch == '\t' || ch == '\n' || ch == '\r'
}
/// Check if a character is true
///
/// In this contenxt, true and non zero number is 'true' while false and zero number is false
pub(crate) fn is_arg_true(arg: &str) -> RadResult<bool> {
let arg = trim!(arg);
if let Ok(value) = arg.parse::<usize>() {
if value == 0 {
return Ok(false);
} else {
return Ok(true);
}
} else if arg.to_lowercase() == "true" {
return Ok(true);
} else if arg.to_lowercase() == "false" {
return Ok(false);
}
Err(RadError::InvalidArgument(
"Neither true nor false".to_owned(),
))
}
/// Get a substring of utf8 encoded text.
pub(crate) fn utf8_substring(source: &str, min: Option<usize>, max: Option<usize>) -> String {
let mut result = String::new();
if let Some(min) = min {
if let Some(max) = max {
// Both
for (idx, ch) in source.chars().enumerate() {
if idx >= min && idx <= max {
result.push(ch);
}
}
} else {
// no max
for (idx, ch) in source.chars().enumerate() {
if idx >= min {
result.push(ch);
}
}
}
} else {
// No min
if let Some(max) = max {
// at least max
for (idx, ch) in source.chars().enumerate() {
if idx <= max {
result.push(ch);
}
}
} else {
// Nothing
return source.to_owned();
}
}
result
}
/// Print text as green if possible
#[allow(unused_variables)]
pub fn green(string: &str, to_file: bool) -> Box<dyn std::fmt::Display> {
if cfg!(feature = "color") {
#[cfg(feature = "color")]
if !to_file {
return Box::new(string.green());
}
}
Box::new(string.to_owned())
}
/// Print text as red if possible
#[allow(unused_variables)]
pub fn red(string: &str, to_file: bool) -> Box<dyn std::fmt::Display> {
if cfg!(feature = "color") {
#[cfg(feature = "color")]
if !to_file {
return Box::new(string.red());
}
}
Box::new(string.to_owned())
}
/// Print text as yellow if possible
#[allow(unused_variables)]
pub fn yellow(string: &str, to_file: bool) -> Box<dyn std::fmt::Display> {
if cfg!(feature = "color") {
#[cfg(feature = "color")]
if !to_file {
return Box::new(string.yellow());
}
}
Box::new(string.to_owned())
}
// Copied from
// https://llogiq.github.io/2016/09/24/newline.html
// Actually the source talks about how to make following function faster
// yet I don't want to use simd because r4d's logic is currently very synchronous
// and making it a asynchornous would take much more effort and time
// NOTE : Trailing single is necessary because this only checks newline chracter
// thus line without trailing newline doesn't count as 1
/// Count new lines
#[allow(dead_code)]
pub(crate) fn count_sentences(s: &str) -> usize {
s.as_bytes().iter().filter(|&&c| c == b'\n').count() + 1
}
#[cfg(feature = "debug")]
/// Clear terminal cells
pub fn clear_terminal() -> RadResult<()> {
use crossterm::{terminal::ClearType, ExecutableCommand};
std::io::stdout()
.execute(crossterm::terminal::Clear(ClearType::All))?
.execute(crossterm::cursor::MoveTo(0, 0))?;
Ok(())
}
/// Check if path is really in file system or not
pub fn is_real_path(path: &std::path::Path) -> RadResult<()> {
if !path.exists() {
return Err(RadError::InvalidFile(path.display().to_string()));
}
Ok(())
}
/// Pop only a single newline from a source
pub fn pop_newline(s: &mut String) {
if s.ends_with('\n') {
s.pop();
if s.ends_with('\r') {
s.pop();
}
}
}
/// Check file authority
pub(crate) fn is_granted(
name: &str,
auth_type: AuthType,
processor: &mut Processor,
) -> RadResult<bool> {
match processor.get_auth_state(&auth_type) {
AuthState::Restricted => Err(RadError::PermissionDenied(name.to_owned(), auth_type)),
AuthState::Warn => {
processor.log_warning(
&format!(
"\"{}\" was called with \"{:?}\" permission",
name, auth_type
),
WarningType::Security,
)?;
Ok(true)
}
AuthState::Open => Ok(true),
}
}
/// Execute a subprocess with given arguments
#[cfg(feature = "basic")]
pub(crate) fn subprocess(args: &[&str]) -> RadResult<()> {
use std::io::Write;
use std::process::Stdio;
#[cfg(target_os = "windows")]
let process = std::process::Command::new("cmd")
.arg("/C")
.args(&args[0..])
.stdin(Stdio::piped())
.spawn()
.map_err(|_| {
RadError::InvalidArgument(format!("Failed to execute command : \"{:?}\"", &args[0]))
})?;
#[cfg(not(target_os = "windows"))]
let process = std::process::Command::new("sh")
.arg("-c")
.arg(&args[0..].join(" ")) // TODO, is this correct?
.stdin(Stdio::piped())
.spawn()
.map_err(|_| {
RadError::InvalidArgument(format!("Failed to execute command : \"{:?}\"", &args[0]))
})?;
let output = process.wait_with_output()?;
let out_content = String::from_utf8_lossy(&output.stdout);
let err_content = String::from_utf8_lossy(&output.stderr);
if out_content.len() != 0 {
write!(std::io::stdout(), "{}", &out_content)?;
}
if err_content.len() != 0 {
write!(std::io::stderr(), "{}", &err_content)?;
}
Ok(())
}
/// This checks if a file is safely modifiable
///
/// File operation can be nested and somtimes logically implausible. Such as referencing self,
/// or referencing parent file is would cause infinite loop
///
/// Alos, opening processor's out option and err option would be impossible from the start,
/// while creating a hard to read error message.
///
/// Unallowed files are followed
///
/// - Current input
/// - Input that is saved in stack
/// - File that is being relayed to
/// - Processor's out option
/// - Processor's err option
///
/// # Argument
///
/// - processor : Processor to get multiple files from
/// - canoic : Real absolute path to evaluate ( If not this possibly panicks )
pub(crate) fn check_file_sanity(processor: &Processor, canonic: &Path) -> RadResult<()> {
// Rule 1
// You cannot include self
if let ProcessInput::File(path) = &processor.state.current_input {
if path.canonicalize()? == canonic {
return Err(RadError::UnallowedMacroExecution(format!(
"Processing self is not allowed : \"{}\"",
&path.display()
)));
}
}
// Rule 2
// Field is in input stack
// This unwraps is mostly ok ( I guess )
if processor.state.input_stack.contains(canonic) {
return Err(RadError::UnallowedMacroExecution(format!(
"Processing self is not allowed : \"{}\"",
&canonic
.file_name()
.unwrap_or_else(|| OsStr::new("input_file"))
.to_string_lossy()
)));
}
// Rule 3
// You cannot include file that is being relayed
#[cfg(not(feature = "wasm"))]
if let Some(RelayTarget::File(file)) = &processor.state.relay.last() {
if file.path() == canonic {
return Err(RadError::UnallowedMacroExecution(format!(
"Processing relay target while relaying to the file is not allowed : \"{}\"",
&file.name().display()
)));
}
}
// Rule 4
// You cannot include processor's out file
if let WriteOption::File(target) = &processor.write_option {
if target.path() == canonic {
return Err(RadError::UnallowedMacroExecution(format!(
"Cannot process an out file : \"{}\"",
&target.name().display()
)));
}
}
// Rule 5
// You cannot include processor's error file
#[cfg(not(feature = "wasm"))]
if let Some(WriteOption::File(target)) = &processor.get_logger_write_option() {
if target.path() == canonic {
return Err(RadError::UnallowedMacroExecution(format!(
"Cannot process an error file : \"{}\"",
&target.name().display()
)));
}
}
Ok(())
}
}