armybox 0.3.0

A memory-safe #[no_std] BusyBox/Toybox clone in Rust - 299 Unix utilities in ~500KB
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
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
//! cp - copy files and directories
//!
//! POSIX.1-2017 compliant implementation.
//! Reference: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/cp.html

use crate::io;
use crate::sys;
use crate::applets::{get_arg, has_opt};

/// cp - copy files and directories
///
/// # Synopsis
/// ```text
/// cp [-fip] [-R [-H|-L|-P]] source_file target_file
/// cp [-fip] [-R [-H|-L|-P]] source_file... target
/// ```
///
/// # Description
/// Copies files. If target is a directory, copies source files into it.
/// If target is a file, source must be a single file.
///
/// # Options
/// - `-f`: Force - remove existing destination files if needed
/// - `-i`: Interactive - prompt before overwrite (not implemented)
/// - `-p`: Preserve - preserve file mode, ownership, and timestamps
/// - `-R`, `-r`: Recursive - copy directories recursively
///
/// # Exit Status
/// - 0: All files copied successfully
/// - >0: An error occurred
pub fn cp(argc: i32, argv: *const *const u8) -> i32 {
    let mut recursive = false;
    let mut force = false;
    let mut _interactive = false;
    let mut preserve = false;
    let mut files_start = 1;

    // Parse options
    for i in 1..argc {
        if let Some(arg) = unsafe { get_arg(argv, i) } {
            if arg.len() > 0 && arg[0] == b'-' {
                if has_opt(arg, b'r') || has_opt(arg, b'R') { recursive = true; }
                if has_opt(arg, b'f') { force = true; }
                if has_opt(arg, b'i') { _interactive = true; }
                if has_opt(arg, b'p') { preserve = true; }
                files_start = i + 1;
            } else {
                break;
            }
        }
    }

    let file_count = argc - files_start;
    if file_count < 2 {
        io::write_str(2, b"cp: missing operand\n");
        return 1;
    }

    let dest = match unsafe { get_arg(argv, argc - 1) } {
        Some(d) => d,
        None => {
            io::write_str(2, b"cp: missing destination\n");
            return 1;
        }
    };

    // Check if destination is a directory
    let dest_is_dir = is_directory(dest);

    // If multiple sources, destination must be a directory
    if file_count > 2 && !dest_is_dir {
        io::write_str(2, b"cp: target '");
        io::write_all(2, dest);
        io::write_str(2, b"' is not a directory\n");
        return 1;
    }

    let mut exit_code = 0;

    for i in files_start..(argc - 1) {
        if let Some(src) = unsafe { get_arg(argv, i) } {
            let result = if dest_is_dir {
                // Copy into directory
                let mut dest_path = [0u8; 4096];
                let dest_len = build_dest_path(dest, src, &mut dest_path);
                copy_item(src, &dest_path[..dest_len], recursive, force, preserve)
            } else {
                copy_item(src, dest, recursive, force, preserve)
            };

            if result != 0 {
                exit_code = 1;
            }
        }
    }

    exit_code
}

/// Check if path is a directory
fn is_directory(path: &[u8]) -> bool {
    let mut st: libc::stat = unsafe { core::mem::zeroed() };
    if io::stat(path, &mut st) < 0 {
        return false;
    }
    (st.st_mode & libc::S_IFMT) == libc::S_IFDIR
}

/// Build destination path by appending basename of source to dest directory
fn build_dest_path(dest_dir: &[u8], src: &[u8], buf: &mut [u8]) -> usize {
    let mut len = 0;

    // Copy destination directory
    for &c in dest_dir {
        if len < buf.len() - 1 {
            buf[len] = c;
            len += 1;
        }
    }

    // Add separator if needed
    if len > 0 && buf[len - 1] != b'/' {
        if len < buf.len() - 1 {
            buf[len] = b'/';
            len += 1;
        }
    }

    // Find basename of source
    let basename_start = src.iter().rposition(|&c| c == b'/').map(|p| p + 1).unwrap_or(0);

    // Append basename
    for &c in &src[basename_start..] {
        if len < buf.len() - 1 {
            buf[len] = c;
            len += 1;
        }
    }

    len
}

/// Copy a file or directory
fn copy_item(src: &[u8], dest: &[u8], recursive: bool, force: bool, preserve: bool) -> i32 {
    let mut st: libc::stat = unsafe { core::mem::zeroed() };
    if io::stat(src, &mut st) < 0 {
        sys::perror(src);
        return 1;
    }

    if (st.st_mode & libc::S_IFMT) == libc::S_IFDIR {
        if !recursive {
            io::write_str(2, b"cp: omitting directory '");
            io::write_all(2, src);
            io::write_str(2, b"'\n");
            return 1;
        }
        copy_directory(src, dest, force, preserve)
    } else {
        copy_file_opts(src, dest, force, preserve)
    }
}

/// Copy a single file
pub(crate) fn copy_file(src: &[u8], dest: &[u8], force: bool) -> i32 {
    copy_file_opts(src, dest, force, false)
}

/// Copy a single file with optional attribute preservation
fn copy_file_opts(src: &[u8], dest: &[u8], force: bool, preserve: bool) -> i32 {
    let src_fd = io::open(src, libc::O_RDONLY, 0);
    if src_fd < 0 {
        sys::perror(src);
        return 1;
    }

    // Get source stats for preserve mode
    let mut src_st: libc::stat = unsafe { core::mem::zeroed() };
    let has_stat = io::stat(src, &mut src_st) == 0;

    // If force and dest exists, try to remove it first
    if force {
        let _ = io::unlink(dest);
    }

    let create_mode = if preserve && has_stat {
        src_st.st_mode & 0o7777
    } else {
        0o644
    };

    let dest_fd = io::open(dest, libc::O_WRONLY | libc::O_CREAT | libc::O_TRUNC, create_mode);
    if dest_fd < 0 {
        io::close(src_fd);
        sys::perror(dest);
        return 1;
    }

    let mut buf = [0u8; 4096];
    loop {
        let n = io::read(src_fd, &mut buf);
        if n <= 0 { break; }
        if io::write_all(dest_fd, &buf[..n as usize]) < 0 {
            io::close(src_fd);
            io::close(dest_fd);
            sys::perror(dest);
            return 1;
        }
    }

    io::close(src_fd);
    io::close(dest_fd);

    // Preserve attributes
    if preserve && has_stat {
        // Preserve mode
        io::chmod(dest, src_st.st_mode & 0o7777);

        // Preserve ownership (may fail if not root)
        unsafe {
            libc::chown(
                dest.as_ptr() as *const i8,
                src_st.st_uid,
                src_st.st_gid,
            );
        }

        // Preserve timestamps
        let times = [
            libc::timeval {
                tv_sec: src_st.st_atime,
                tv_usec: 0,
            },
            libc::timeval {
                tv_sec: src_st.st_mtime,
                tv_usec: 0,
            },
        ];
        unsafe {
            libc::utimes(dest.as_ptr() as *const i8, times.as_ptr());
        }
    }

    0
}

/// Copy a directory recursively
fn copy_directory(src: &[u8], dest: &[u8], force: bool, preserve: bool) -> i32 {
    // Create destination directory
    if io::mkdir(dest, 0o755) < 0 {
        // Check if it already exists
        if !is_directory(dest) {
            sys::perror(dest);
            return 1;
        }
    }

    // Open source directory
    let fd = io::open(src, libc::O_RDONLY | libc::O_DIRECTORY, 0);
    if fd < 0 {
        sys::perror(src);
        return 1;
    }

    let mut exit_code = 0;
    let mut buf = [0u8; 4096];

    loop {
        let n = unsafe { libc::syscall(libc::SYS_getdents64, fd, buf.as_mut_ptr(), buf.len()) };
        if n <= 0 { break; }

        let mut offset = 0;
        while offset < n as usize {
            let dirent = unsafe { &*(buf.as_ptr().add(offset) as *const libc::dirent64) };
            let name = unsafe { io::cstr_to_slice(dirent.d_name.as_ptr() as *const u8) };

            if name != b"." && name != b".." {
                // Build full source path
                let mut src_path = [0u8; 4096];
                let mut src_len = 0;
                for &c in src { src_path[src_len] = c; src_len += 1; }
                src_path[src_len] = b'/'; src_len += 1;
                for &c in name { src_path[src_len] = c; src_len += 1; }

                // Build full dest path
                let mut dest_path = [0u8; 4096];
                let mut dest_len = 0;
                for &c in dest { dest_path[dest_len] = c; dest_len += 1; }
                dest_path[dest_len] = b'/'; dest_len += 1;
                for &c in name { dest_path[dest_len] = c; dest_len += 1; }

                if copy_item(&src_path[..src_len], &dest_path[..dest_len], true, force, preserve) != 0 {
                    exit_code = 1;
                }
            }

            offset += dirent.d_reclen as usize;
        }
    }

    io::close(fd);

    // Preserve directory attributes
    if preserve {
        let mut src_st: libc::stat = unsafe { core::mem::zeroed() };
        if io::stat(src, &mut src_st) == 0 {
            io::chmod(dest, src_st.st_mode & 0o7777);
            unsafe {
                libc::chown(dest.as_ptr() as *const i8, src_st.st_uid, src_st.st_gid);
            }
            let times = [
                libc::timeval { tv_sec: src_st.st_atime, tv_usec: 0 },
                libc::timeval { tv_sec: src_st.st_mtime, tv_usec: 0 },
            ];
            unsafe {
                libc::utimes(dest.as_ptr() as *const i8, times.as_ptr());
            }
        }
    }

    exit_code
}

#[cfg(test)]
mod tests {
    //! Unit tests for cp utility

    extern crate std;
    use std::sync::atomic::{AtomicUsize, Ordering};

    static TEST_COUNTER: AtomicUsize = AtomicUsize::new(0);
    use std::process::Command;
    use std::fs;
    use std::path::PathBuf;

    fn get_armybox_path() -> PathBuf {
        if let Ok(path) = std::env::var("ARMYBOX_PATH") {
            return PathBuf::from(path);
        }
        let release = PathBuf::from("target/release/armybox");
        if release.exists() { return release; }
        PathBuf::from("target/debug/armybox")
    }

    fn setup() -> PathBuf {
        let counter = TEST_COUNTER.fetch_add(1, Ordering::SeqCst);
        let dir = std::env::temp_dir().join(format!("armybox_cp_test_{}_{}",  std::process::id(), counter));
        let _ = fs::remove_dir_all(&dir);
        fs::create_dir_all(&dir).unwrap();
        dir
    }

    fn cleanup(dir: &std::path::Path) {
        let _ = fs::remove_dir_all(dir);
    }

    #[test]
    fn test_cp_single_file() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();
        fs::write(dir.join("source.txt"), "hello world").unwrap();

        let output = Command::new(&armybox)
            .args(["cp",
                dir.join("source.txt").to_str().unwrap(),
                dir.join("dest.txt").to_str().unwrap()])
            .output()
            .unwrap();

        assert_eq!(output.status.code(), Some(0));
        assert!(dir.join("dest.txt").exists());
        assert_eq!(fs::read_to_string(dir.join("dest.txt")).unwrap(), "hello world");
        cleanup(&dir);
    }

    #[test]
    fn test_cp_to_directory() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();
        fs::write(dir.join("source.txt"), "content").unwrap();
        fs::create_dir(dir.join("destdir")).unwrap();

        let output = Command::new(&armybox)
            .args(["cp",
                dir.join("source.txt").to_str().unwrap(),
                dir.join("destdir").to_str().unwrap()])
            .output()
            .unwrap();

        assert_eq!(output.status.code(), Some(0));
        assert!(dir.join("destdir/source.txt").exists());
        cleanup(&dir);
    }

    #[test]
    fn test_cp_multiple_files_to_directory() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();
        fs::write(dir.join("file1.txt"), "content1").unwrap();
        fs::write(dir.join("file2.txt"), "content2").unwrap();
        fs::create_dir(dir.join("destdir")).unwrap();

        let output = Command::new(&armybox)
            .args(["cp",
                dir.join("file1.txt").to_str().unwrap(),
                dir.join("file2.txt").to_str().unwrap(),
                dir.join("destdir").to_str().unwrap()])
            .output()
            .unwrap();

        assert_eq!(output.status.code(), Some(0));
        assert!(dir.join("destdir/file1.txt").exists());
        assert!(dir.join("destdir/file2.txt").exists());
        cleanup(&dir);
    }

    #[test]
    fn test_cp_nonexistent_source() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();

        let output = Command::new(&armybox)
            .args(["cp", "/nonexistent/file", dir.join("dest.txt").to_str().unwrap()])
            .output()
            .unwrap();

        assert_ne!(output.status.code(), Some(0));
        cleanup(&dir);
    }

    #[test]
    fn test_cp_recursive_directory() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();
        fs::create_dir_all(dir.join("srcdir/subdir")).unwrap();
        fs::write(dir.join("srcdir/file.txt"), "content").unwrap();
        fs::write(dir.join("srcdir/subdir/nested.txt"), "nested").unwrap();

        let output = Command::new(&armybox)
            .args(["cp", "-r",
                dir.join("srcdir").to_str().unwrap(),
                dir.join("destdir").to_str().unwrap()])
            .output()
            .unwrap();

        assert_eq!(output.status.code(), Some(0));
        assert!(dir.join("destdir/file.txt").exists());
        assert!(dir.join("destdir/subdir/nested.txt").exists());
        cleanup(&dir);
    }

    #[test]
    fn test_cp_directory_without_recursive() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();
        fs::create_dir(dir.join("srcdir")).unwrap();

        let output = Command::new(&armybox)
            .args(["cp",
                dir.join("srcdir").to_str().unwrap(),
                dir.join("destdir").to_str().unwrap()])
            .output()
            .unwrap();

        // Should fail - can't copy directory without -r
        assert_ne!(output.status.code(), Some(0));
        cleanup(&dir);
    }

    #[test]
    fn test_cp_missing_operand() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let output = Command::new(&armybox)
            .args(["cp"])
            .output()
            .unwrap();

        assert_ne!(output.status.code(), Some(0));
        assert!(std::string::String::from_utf8_lossy(&output.stderr).contains("missing operand"));
    }

    #[test]
    fn test_cp_force_overwrite() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();
        fs::write(dir.join("source.txt"), "new content").unwrap();
        fs::write(dir.join("dest.txt"), "old content").unwrap();

        let output = Command::new(&armybox)
            .args(["cp", "-f",
                dir.join("source.txt").to_str().unwrap(),
                dir.join("dest.txt").to_str().unwrap()])
            .output()
            .unwrap();

        assert_eq!(output.status.code(), Some(0));
        assert_eq!(fs::read_to_string(dir.join("dest.txt")).unwrap(), "new content");
        cleanup(&dir);
    }

    #[test]
    fn test_cp_preserves_content() {
        let armybox = get_armybox_path();
        if !armybox.exists() { return; }

        let dir = setup();
        let binary_data: Vec<u8> = (0..=255).collect();
        fs::write(dir.join("binary.bin"), &binary_data).unwrap();

        let output = Command::new(&armybox)
            .args(["cp",
                dir.join("binary.bin").to_str().unwrap(),
                dir.join("copy.bin").to_str().unwrap()])
            .output()
            .unwrap();

        assert_eq!(output.status.code(), Some(0));
        assert_eq!(fs::read(dir.join("copy.bin")).unwrap(), binary_data);
        cleanup(&dir);
    }
}