rcore 0.1.0

Core module for Rair
Documentation 
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

/*
 * files.rs: commands for opening, closing and listing files.
 * Copyright (C) 2019  Oddcoder
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

use core::*;
use helper::*;
use rair_io::*;
use std::io::Write;
use yansi::Paint;

#[derive(Default)]
pub struct ListFiles {}

impl ListFiles {
    pub fn new(core: &mut Core) -> Self {
        let env = core.env.clone();
        env.borrow_mut()
            .add_str_with_cb("files.headerColor", "color.6", "Color used in the header of `files` command", core, is_color)
            .unwrap();
        Default::default()
    }
}

impl Cmd for ListFiles {
    fn run(&mut self, core: &mut Core, args: &[String]) {
        if !args.is_empty() {
            expect(core, args.len() as u64, 0);
            return;
        }
        let env = core.env.borrow();
        let color = env.get_str("maps.headerColor").unwrap();
        let (r, g, b) = env.get_color(color).unwrap();

        writeln!(core.stdout, "{}", Paint::rgb(r, g, b, "Handle\tStart address\tsize\t\tPermissions\tURI")).unwrap();
        for file in core.io.uri_iter() {
            let perm = format!("{:?}", file.perm());
            write!(core.stdout, "{}\t0x{:08x}\t0x{:08x}\t{}", file.hndl(), file.paddr_base(), file.size(), perm).unwrap();
            if perm.len() < 6 {
                write!(core.stdout, "\t").unwrap();
            }
            writeln!(core.stdout, "\t{}", file.name()).unwrap();
        }
    }
    fn help(&self, core: &mut Core) {
        help(core, &"files", &"", vec![("", "List all open files.")]);
    }
}

#[derive(Default)]
pub struct OpenFile {}

impl OpenFile {
    pub fn new() -> Self {
        Default::default()
    }
}
fn parse_perm(p: &str) -> Result<IoMode, String> {
    let mut perm = Default::default();
    for c in p.to_lowercase().chars() {
        match c {
            'r' => perm |= IoMode::READ,
            'w' => perm |= IoMode::WRITE,
            'c' => perm |= IoMode::COW,
            _ => return Err(format!("Unknown Permission: `{}`", c)),
        }
    }
    return Ok(perm);
}
impl Cmd for OpenFile {
    fn run(&mut self, core: &mut Core, args: &[String]) {
        if args.len() > 3 || args.is_empty() {
            expect_range(core, args.len() as u64, 1, 2);
            return;
        }
        let uri;
        let mut perm = IoMode::READ;
        let mut addr = None;
        if args.len() == 3 {
            uri = &args[1];
            perm = match parse_perm(&args[0]) {
                Ok(perm) => perm,
                Err(e) => return error_msg(core, "Failed to parse permission", &e),
            };
            addr = match str_to_num(&args[2]) {
                Ok(addr) => Some(addr),
                Err(e) => {
                    let err_str = format!("{}", e);
                    error_msg(core, "Failed to parse address", &err_str);
                    return;
                }
            }
        } else if args.len() == 2 {
            if let Ok(a) = str_to_num(&args[1]) {
                addr = Some(a);
                uri = &args[0];
            } else {
                uri = &args[1];
                perm = match parse_perm(&args[0]) {
                    Ok(perm) => perm,
                    Err(e) => return error_msg(core, "Failed to parse permission", &e),
                };
            }
        } else {
            uri = &args[0];
        }

        let result = match addr {
            Some(addr) => core.io.open_at(uri, perm, addr),
            None => core.io.open(uri, perm),
        };
        if let Err(e) = result {
            let err_str = format!("{}", e);
            error_msg(core, "Failed to open file", &err_str);
        }
    }
    fn help(&self, core: &mut Core) {
        help(
            core,
            &"open",
            &"o",
            vec![("<Perm> [URI] <Addr>", "Open given URI using given optional permission (default to readonly) at given optional address.")],
        );
    }
}

#[derive(Default)]
pub struct CloseFile {}

impl CloseFile {
    pub fn new() -> Self {
        Default::default()
    }
}

impl Cmd for CloseFile {
    fn run(&mut self, core: &mut Core, args: &[String]) {
        if args.len() != 1 {
            expect(core, args.len() as u64, 1);
            return;
        }
        let hndl = match str_to_num(&args[0]) {
            Ok(hndl) => hndl,
            Err(e) => {
                let err_str = format!("{}", e);
                error_msg(core, "Invalid hndl", &err_str);
                return;
            }
        };
        if let Err(e) = core.io.close(hndl) {
            let err_str = format!("{}", e);
            error_msg(core, "Failed to close file", &err_str);
        }
    }
    fn help(&self, core: &mut Core) {
        help(core, &"close", &"", vec![("[hndl]", "Close file with given hndl.")]);
    }
}

#[cfg(test)]
mod test_files {
    use super::*;
    use writer::Writer;
    #[test]
    fn test_docs() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        core.stdout = Writer::new_buf();
        let open = OpenFile::new();
        let close = CloseFile::new();
        core.help("files");
        open.help(&mut core);
        close.help(&mut core);
        assert_eq!(
            core.stdout.utf8_string().unwrap(),
            "Command: [files]\n\n\
             Usage:\n\
             files\tList all open files.\n\
             Commands: [open | o]\n\n\
             Usage:\n\
             o <Perm> [URI] <Addr>\tOpen given URI using given optional permission (default to readonly) at given optional address.\n\
             Command: [close]\n\n\
             Usage:\n\
             close [hndl]\tClose file with given hndl.\n"
        );
        assert_eq!(core.stderr.utf8_string().unwrap(), "");
    }

    #[test]
    fn test_open_close_files() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        core.stdout = Writer::new_buf();
        let mut open = OpenFile::new();
        let mut close = CloseFile::new();
        open.run(&mut core, &["b64://../testing_binaries/rio/base64/no_padding.b64".to_string()]);
        open.run(&mut core, &["rw".to_string(), "malloc://0x50".to_string()]);
        open.run(&mut core, &["c".to_string(), "../testing_binaries/rio/base64/one_pad.b64".to_string(), "0x5000".to_string()]);
        open.run(&mut core, &["b64://../testing_binaries/rio/base64/no_padding.b64".to_string(), "0xa000".to_string()]);

        core.run("files", &[]);
        assert_eq!(
            core.stdout.utf8_string().unwrap(),
            "Handle\tStart address\tsize\t\tPermissions\tURI\n\
             0\t0x00000000\t0x0000002d\tREAD\t\tb64://../testing_binaries/rio/base64/no_padding.b64\n\
             1\t0x0000002d\t0x00000050\tWRITE | READ\tmalloc://0x50\n\
             2\t0x00005000\t0x00000005\tCOW\t\t../testing_binaries/rio/base64/one_pad.b64\n\
             3\t0x0000a000\t0x0000002d\tREAD\t\tb64://../testing_binaries/rio/base64/no_padding.b64\n"
        );
        assert_eq!(core.stderr.utf8_string().unwrap(), "");
        core.stderr = Writer::new_buf();
        core.stdout = Writer::new_buf();
        close.run(&mut core, &["1".to_string()]);
        core.run("files", &[]);
        assert_eq!(
            core.stdout.utf8_string().unwrap(),
            "Handle\tStart address\tsize\t\tPermissions\tURI\n\
             0\t0x00000000\t0x0000002d\tREAD\t\tb64://../testing_binaries/rio/base64/no_padding.b64\n\
             2\t0x00005000\t0x00000005\tCOW\t\t../testing_binaries/rio/base64/one_pad.b64\n\
             3\t0x0000a000\t0x0000002d\tREAD\t\tb64://../testing_binaries/rio/base64/no_padding.b64\n"
        );
        assert_eq!(core.stderr.utf8_string().unwrap(), "");
    }

    #[test]
    fn test_failing_parsing() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        core.stdout = Writer::new_buf();
        let mut open = OpenFile::new();
        open.run(&mut core, &["z".to_string(), "malloc://0x50".to_string()]);
        open.run(&mut core, &["z".to_string(), "malloc://0x50".to_string(), "0x500".to_string()]);
        open.run(&mut core, &["rw".to_string(), "malloc://0x50".to_string(), "0b500".to_string()]);

        assert_eq!(core.stdout.utf8_string().unwrap(), "");
        assert_eq!(
            core.stderr.utf8_string().unwrap(),
            "Error: Failed to parse permission\n\
             Unknown Permission: `z`\n\
             Error: Failed to parse permission\n\
             Unknown Permission: `z`\n\
             Error: Failed to parse address\n\
             invalid digit found in string\n"
        );
    }

    #[test]
    fn test_arguments_count() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        core.stdout = Writer::new_buf();
        let mut open = OpenFile::new();
        let mut close = CloseFile::new();
        open.run(&mut core, &[]);
        core.run("files", &["test".to_string()]);
        close.run(&mut core, &[]);
        assert_eq!(core.stdout.utf8_string().unwrap(), "");
        assert_eq!(
            core.stderr.utf8_string().unwrap(),
            "Arguments Error: Expected between 1 and 2 arguments, found 0.\n\
             Arguments Error: Expected 0 argument(s), found 1.\n\
             Arguments Error: Expected 1 argument(s), found 0.\n"
        );
    }

    #[test]
    fn test_failed_open_close() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        core.stdout = Writer::new_buf();
        let mut open = OpenFile::new();
        let mut close = CloseFile::new();
        open.run(&mut core, &["file_that_doesnt_exist".to_string()]);
        close.run(&mut core, &["5".to_string()]);
        assert_eq!(core.stdout.utf8_string().unwrap(), "");
        let err = core.stderr.utf8_string().unwrap();
        assert!(err.starts_with("Error: Failed to open file\n"));
        // what in between is different between Windows and *Nix
        assert!(err.ends_with("Error: Failed to close file\nHandle Does not exist.\n"));
    }
}