tui-file-explorer 4.0.1

Embeddable keyboard-driven multi-pane file explorer for Ratatui
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
//! Clipboard and file operations: yank, paste, and delete.
//!
//! Split out of `app.rs`; owns the copy/cut/paste/delete workflows and
//! their interaction with [`super::Modal`] confirmation dialogs and
//! [`super::CopyProgress`] tracking.

use super::*;

impl App {
    // ── File operations ───────────────────────────────────────────────────────

    /// Yank (copy or cut) into the clipboard.
    ///
    /// Marks are checked in priority order:
    /// 1. Active pane marks — the normal single-pane workflow.
    /// 2. Inactive pane marks — handles the common dual-pane workflow where
    ///    the user marks files in the source pane, tabs to the destination
    ///    pane, and then presses `p` or `x`.
    /// 3. Active pane cursor entry — fallback when nothing is marked.
    ///
    /// Marks on whichever pane was used are cleared after the yank.
    ///
    /// Note: for copy operations, `paste()` calls this automatically when
    /// marks exist but the clipboard is empty — the user can simply mark
    /// files with Space and press `p` directly.
    pub fn yank(&mut self, op: ClipOp) {
        let active_marks: Vec<PathBuf> = self.active_pane().marked.iter().cloned().collect();
        // Search other panes (in order) for the first one with marks.
        let inactive_pane_idx = self
            .panes
            .iter()
            .enumerate()
            .find(|(i, p)| *i != self.active_idx && !p.marked.is_empty())
            .map(|(i, _)| i);
        let inactive_marks: Vec<PathBuf> = inactive_pane_idx
            .map(|i| self.panes[i].marked.iter().cloned().collect())
            .unwrap_or_default();

        // Determine which set of paths to use and which pane to clear marks from.
        enum Source {
            ActiveMarks,
            InactiveMarks,
            Cursor,
        }

        let source = if !active_marks.is_empty() {
            Source::ActiveMarks
        } else if !inactive_marks.is_empty() {
            Source::InactiveMarks
        } else {
            Source::Cursor
        };

        let paths: Vec<PathBuf> = match source {
            Source::ActiveMarks => {
                let mut sorted = active_marks;
                sorted.sort();
                sorted
            }
            Source::InactiveMarks => {
                let mut sorted = inactive_marks;
                sorted.sort();
                sorted
            }
            Source::Cursor => {
                if let Some(entry) = self.active_pane().current_entry() {
                    vec![entry.path.clone()]
                } else {
                    return;
                }
            }
        };

        let count = paths.len();
        let (verb, hint) = if op == ClipOp::Copy {
            ("Copied", "paste a copy")
        } else {
            ("Cut", "move")
        };

        let label = if count == 1 {
            format!(
                "'{}'",
                paths[0].file_name().unwrap_or_default().to_string_lossy()
            )
        } else {
            format!("{count} items")
        };

        self.clipboard = Some(ClipboardItem { paths, op });

        // Clear marks from whichever pane was the source.
        match source {
            Source::ActiveMarks | Source::Cursor => self.active_pane_mut().clear_marks(),
            Source::InactiveMarks => {
                if let Some(i) = inactive_pane_idx {
                    self.panes[i].clear_marks();
                }
            }
        }

        self.status_msg = format!("{verb} {label} — press p to {hint}");
    }

    /// Paste the clipboard item into the active pane's current directory.
    ///
    /// If the destination already exists, a [`Modal::Overwrite`] is
    /// raised instead of overwriting silently.
    pub fn paste(&mut self) {
        // If no clipboard exists but files are marked (Space), automatically
        // treat the marks as a copy source — the user can mark with Space
        // and paste with p directly, without a separate y step.
        if self.clipboard.is_none() {
            let has_marks = self.panes.iter().any(|p| !p.marked.is_empty());
            if has_marks {
                self.yank(ClipOp::Copy);
            }
        }

        let Some(clip) = self.clipboard.clone() else {
            self.status_msg = "Nothing in clipboard — mark files with Space first.".into();
            return;
        };

        let dst_dir = self.active_pane().current_dir.clone();

        // For a single-item clipboard check for same-dir cut and overwrite modal.
        if clip.paths.len() == 1 {
            let src = &clip.paths[0];
            let file_name = if let Some(n) = src.file_name() {
                n.to_owned()
            } else {
                self.status_msg = "Cannot paste: clipboard path has no filename.".into();
                return;
            };
            let dst = dst_dir.join(&file_name);

            if clip.op == ClipOp::Cut && src.parent() == Some(&dst_dir) {
                self.status_msg = "Source and destination are the same — skipped.".into();
                return;
            }

            if self.active_pane().filesystem.exists(&dst) {
                self.modal = Some(Modal::Overwrite {
                    src: src.clone(),
                    dst,
                    is_cut: clip.op == ClipOp::Cut,
                });
                return;
            }
        }

        // Multi-item (or single with no conflict): paste all paths.
        if self.operation_mode == OperationMode::Deferred {
            let operation = if clip.op == ClipOp::Cut {
                FileOperation::Move {
                    sources: clip.paths,
                    destination: dst_dir,
                    overwrite: false,
                }
            } else {
                FileOperation::Copy {
                    sources: clip.paths,
                    destination: dst_dir,
                    overwrite: false,
                }
            };
            self.queue_operation(operation);
        } else {
            self.do_paste_all(&clip.paths, &dst_dir, clip.op == ClipOp::Cut);
        }
    }

    /// Perform the actual copy/move for a single src→dst pair.
    ///
    /// Used by the overwrite-confirmation modal path (single file only).
    /// For multi-file paste use [`App::do_paste_all`].
    pub fn do_paste(&mut self, src: &Path, dst: &Path, is_cut: bool) {
        if self.operation_mode == OperationMode::Deferred {
            let destination = dst.parent().unwrap_or_else(|| Path::new("")).to_path_buf();
            let operation = if is_cut {
                FileOperation::Move {
                    sources: vec![src.to_path_buf()],
                    destination,
                    overwrite: true,
                }
            } else {
                FileOperation::Copy {
                    sources: vec![src.to_path_buf()],
                    destination,
                    overwrite: true,
                }
            };
            self.queue_operation(operation);
            return;
        }

        let filesystem = self.active_pane().filesystem.clone();
        let result = if filesystem.is_dir(src) {
            filesystem.copy_dir(src, dst)
        } else {
            filesystem.copy_file(src, dst)
        };

        match result {
            Ok(()) => {
                if is_cut {
                    let _ = if filesystem.is_dir(src) {
                        filesystem.remove_dir_all(src)
                    } else {
                        filesystem.remove_file(src)
                    };
                    self.clipboard = None;
                }
                for p in &mut self.panes {
                    p.reload();
                    p.clear_dir_size_cache();
                }
                let msg = format!(
                    "{} '{}'",
                    if is_cut { "Moved" } else { "Pasted" },
                    dst.file_name().unwrap_or_default().to_string_lossy()
                );
                self.status_msg = msg.clone();
                self.notify(msg);
            }
            Err(e) => {
                let msg = format!("Paste failed: {e}");
                self.status_msg = format!("Error: {msg}");
                self.notify_error(msg);
            }
        }
    }

    /// Paste all `srcs` into `dst_dir`, performing copy or move for each.
    ///
    /// Errors are collected and reported in the status message alongside the
    /// success count.  On a fully successful cut the clipboard is cleared.
    pub fn do_paste_all(&mut self, srcs: &[PathBuf], dst_dir: &Path, is_cut: bool) {
        if self.operation_mode == OperationMode::Deferred {
            let operation = if is_cut {
                FileOperation::Move {
                    sources: srcs.to_vec(),
                    destination: dst_dir.to_path_buf(),
                    overwrite: false,
                }
            } else {
                FileOperation::Copy {
                    sources: srcs.to_vec(),
                    destination: dst_dir.to_path_buf(),
                    overwrite: false,
                }
            };
            self.queue_operation(operation);
            return;
        }

        let filesystem = self.active_pane().filesystem.clone();
        let mut errors: Vec<String> = Vec::new();
        let mut succeeded: usize = 0;
        // (source, destination) of every item that was pasted, for undo.
        let mut pasted: Vec<(PathBuf, PathBuf)> = Vec::new();
        let total = srcs.len();
        let verb_label = if is_cut { "Moving" } else { "Copying" };

        // Initialise progress — visible immediately on the next render.
        self.copy_progress = Some(CopyProgress::new(
            format!("{verb_label} {total} item(s)…"),
            total,
        ));

        for src in srcs {
            let file_name = if let Some(n) = src.file_name() {
                n
            } else {
                errors.push(format!("skipped (no filename): {}", src.display()));
                if let Some(p) = &mut self.copy_progress {
                    p.done += 1;
                }
                continue;
            };

            // Update the "currently processing" label before the (potentially
            // slow) copy so the UI reflects what is happening right now.
            if let Some(p) = &mut self.copy_progress {
                p.current_item = file_name.to_string_lossy().into_owned();
            }

            let dst = dst_dir.join(file_name);

            // Skip same-dir cut silently.
            if is_cut && src.parent() == Some(dst_dir) {
                if let Some(p) = &mut self.copy_progress {
                    p.done += 1;
                }
                continue;
            }

            let result = if filesystem.is_dir(src) {
                filesystem.copy_dir(src, &dst)
            } else {
                filesystem.copy_file(src, &dst)
            };

            match result {
                Ok(()) => {
                    if is_cut {
                        let _ = if filesystem.is_dir(src) {
                            filesystem.remove_dir_all(src)
                        } else {
                            filesystem.remove_file(src)
                        };
                    }
                    succeeded += 1;
                    pasted.push((src.clone(), dst.clone()));
                }
                Err(e) => {
                    errors.push(format!(
                        "'{}': {e}",
                        src.file_name().unwrap_or_default().to_string_lossy()
                    ));
                }
            }

            if let Some(p) = &mut self.copy_progress {
                p.done += 1;
            }
        }

        if !pasted.is_empty() {
            self.record_undo(if is_cut {
                UndoEntry::Move { pairs: pasted }
            } else {
                UndoEntry::Copy { pairs: pasted }
            });
        }

        // Clear progress now that the operation has finished.
        self.copy_progress = None;

        if is_cut && errors.is_empty() {
            self.clipboard = None;
        }

        for p in &mut self.panes {
            p.reload();
            p.clear_dir_size_cache();
        }

        if errors.is_empty() {
            let verb = if is_cut { "Moved" } else { "Pasted" };
            let msg = format!("{verb} {succeeded} item(s).");
            self.status_msg = msg.clone();
            self.notify(msg);
        } else {
            let verb = if is_cut { "Moved" } else { "Pasted" };
            let msg = format!(
                "{verb} {succeeded}, {} error(s): {}",
                errors.len(),
                errors.join("; ")
            );
            self.status_msg = format!("Error: {msg}");
            self.notify_error(msg);
        }
    }

    /// Raise a [`Modal::Delete`] for the currently highlighted entry,
    /// or a [`Modal::MultiDelete`] when there are space-marked entries
    /// in the active pane.
    pub fn prompt_delete(&mut self) {
        let marked: Vec<PathBuf> = self.active_pane().marked.iter().cloned().collect();
        if !marked.is_empty() {
            let mut sorted = marked;
            sorted.sort();
            self.modal = Some(Modal::MultiDelete { paths: sorted });
        } else if let Some(entry) = self.active_pane().current_entry() {
            self.modal = Some(Modal::Delete {
                path: entry.path.clone(),
            });
        }
    }

    /// Execute a confirmed multi-deletion and reload both panes.
    pub fn confirm_delete_many(&mut self, paths: &[PathBuf]) {
        if self.operation_mode == OperationMode::Deferred {
            self.queue_operation(FileOperation::Delete {
                paths: paths.to_vec(),
            });
            return;
        }

        let filesystem = self.active_pane().filesystem.clone();
        let mut errors: Vec<String> = Vec::new();
        let mut deleted: usize = 0;
        let mut removed: Vec<PathBuf> = Vec::new();

        for path in paths {
            let result = if filesystem.is_dir(path) {
                filesystem.remove_dir_all(path)
            } else {
                filesystem.remove_file(path)
            };
            match result {
                Ok(()) => {
                    deleted += 1;
                    removed.push(path.clone());
                }
                Err(e) => errors.push(format!(
                    "'{}': {e}",
                    path.file_name().unwrap_or_default().to_string_lossy()
                )),
            }
        }
        // Only trashed items can come back.
        if self.use_trash && !removed.is_empty() {
            self.record_undo(UndoEntry::Delete { paths: removed });
        }

        for p in &mut self.panes {
            p.clear_marks();
            p.reload();
            p.clear_dir_size_cache();
        }

        if errors.is_empty() {
            self.status_msg = format!("Deleted {deleted} item(s).");
        } else {
            self.status_msg = format!(
                "Deleted {deleted}, {} error(s): {}",
                errors.len(),
                errors.join("; ")
            );
        }
    }

    /// Execute a confirmed deletion and reload both panes.
    pub fn confirm_delete(&mut self, path: &Path) {
        if self.operation_mode == OperationMode::Deferred {
            self.queue_operation(FileOperation::Delete {
                paths: vec![path.to_path_buf()],
            });
            return;
        }

        let name = path
            .file_name()
            .unwrap_or_default()
            .to_string_lossy()
            .to_string();
        let filesystem = self.active_pane().filesystem.clone();
        let result = if filesystem.is_dir(path) {
            filesystem.remove_dir_all(path)
        } else {
            filesystem.remove_file(path)
        };
        match result {
            Ok(()) => {
                if self.use_trash {
                    self.record_undo(UndoEntry::Delete {
                        paths: vec![path.to_path_buf()],
                    });
                }
                for p in &mut self.panes {
                    p.reload();
                    p.clear_dir_size_cache();
                }
                self.status_msg = format!("Deleted '{name}'");
            }
            Err(e) => {
                self.status_msg = format!("Delete failed: {e}");
            }
        }
    }
}