-
Notifications
You must be signed in to change notification settings - Fork 29
/
freedesktop.rs
1037 lines (971 loc) · 39.7 KB
/
freedesktop.rs
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! This implementation will manage the trash according to the Freedesktop Trash specification,
//! version 1.0 found at https://specifications.freedesktop.org/trash-spec/trashspec-1.0.html
//!
//! Most -if not all- Linux based desktop operating systems implement the Trash according to this specification.
//! In other words: I looked, but I could not find any Linux based desktop OS that used anything else than the
//! Freedesktop Trash specification.
//!
use std::{
collections::HashSet,
fs::{create_dir_all, File, OpenOptions},
io::{BufRead, BufReader, Write},
os::unix::fs::PermissionsExt,
path::{Path, PathBuf},
};
use log::{debug, warn};
use crate::{Error, TrashContext, TrashItem};
#[derive(Clone, Default, Debug)]
pub struct PlatformTrashContext;
impl PlatformTrashContext {
pub const fn new() -> Self {
PlatformTrashContext
}
}
impl TrashContext {
pub(crate) fn delete_all_canonicalized(&self, full_paths: Vec<PathBuf>) -> Result<(), Error> {
let home_trash = home_trash()?;
let mount_points = get_mount_points()?;
let home_topdir = home_topdir(&mount_points)?;
debug!("The home topdir is {:?}", home_topdir);
let uid = unsafe { libc::getuid() };
for path in full_paths {
debug!("Deleting {:?}", path);
let topdir = get_topdir_for_path(&path, &mount_points);
debug!("The topdir of this file is {:?}", topdir);
if topdir == home_topdir {
debug!("The topdir was identical to the home topdir, so moving to the home trash.");
// Note that the following function creates the trash folder
// and its required subfolders in case they don't exist.
move_to_trash(path, &home_trash, topdir)?;
} else {
execute_on_mounted_trash_folders(uid, topdir, true, true, |trash_path| {
move_to_trash(&path, trash_path, topdir)
})?;
}
}
Ok(())
}
}
pub fn list() -> Result<Vec<TrashItem>, Error> {
let mut trash_folders = HashSet::new();
// Get home trash folder and add it to the set of trash folders.
// It may not exist and that's completely fine as long as there are other trash folders.
let home_error;
match home_trash() {
Ok(home_trash) => {
if !home_trash.is_dir() {
home_error = Some(Error::Unknown {
description: "The 'home trash' either does not exist or is not a directory (or a link pointing to a dir)".into()
});
} else {
trash_folders.insert(home_trash);
home_error = None;
}
}
Err(e) => {
home_error = Some(e);
}
}
// Get all mount-points and attempt to find a trash folder in each adding them to the SET of
// trash folders when found one.
let uid = unsafe { libc::getuid() };
let mount_points = get_mount_points()?;
for mount in &mount_points {
execute_on_mounted_trash_folders(uid, &mount.mnt_dir, false, false, |trash_path| {
trash_folders.insert(trash_path);
Ok(())
})?;
}
if trash_folders.is_empty() {
warn!(
"No trash folder was found. The error when looking for the 'home trash' was: {:?}",
home_error
);
return Ok(vec![]);
}
// List all items from the set of trash folders
let mut result = Vec::new();
for folder in trash_folders.iter() {
// Read the info files for every file
let top_dir = get_topdir_for_path(folder, &mount_points);
let info_folder = folder.join("info");
if !info_folder.is_dir() {
warn!(
"The path {:?} did not point to a directory, skipping this trash folder.",
info_folder
);
continue;
}
let read_dir = match std::fs::read_dir(&info_folder) {
Ok(d) => d,
Err(e) => {
// After all the earlier checks, it's still possible that the directory does not exist at this point (or is not readable)
// because another process may have deleted it or modified its access rights in the meantime.
// So let's just pring a warning and continue to the rest of the folders
warn!(
"The trash info folder {:?} could not be read. Error was {:?}",
info_folder, e
);
continue;
}
};
#[cfg_attr(not(feature = "chrono"), allow(unused_labels))]
'trash_item: for entry in read_dir {
let info_entry = match entry {
Ok(entry) => entry,
Err(e) => {
// Another thread or process may have removed that entry by now
debug!("Tried resolving the trash info `DirEntry` but it failed with: '{}'", e);
continue;
}
};
// Entrty should really be an info file but better safe than sorry
let file_type = match info_entry.file_type() {
Ok(f_type) => f_type,
Err(e) => {
// Another thread or process may have removed that entry by now
debug!("Tried getting the file type of the trash info `DirEntry` but failed with: {}", e);
continue;
}
};
let info_path = info_entry.path();
if !file_type.is_file() {
warn!("Found an item that's not a file, among the trash info files. This is unexpected. The path to the item is: '{:?}'", info_path);
continue;
}
let info_file = match File::open(&info_path) {
Ok(file) => file,
Err(e) => {
// Another thread or process may have removed that entry by now
debug!("Tried opening the trash info '{:?}' but failed with: {}", info_path, e);
continue;
}
};
let id = info_path.clone().into();
let mut name = None;
let mut original_parent: Option<PathBuf> = None;
#[cfg_attr(not(feature = "chrono"), allow(unused_mut))]
let mut time_deleted = None;
let info_reader = BufReader::new(info_file);
// Skip 1 because the first line must be "[Trash Info]"
'info_lines: for line_result in info_reader.lines().skip(1) {
// Another thread or process may have removed the infofile by now
let line = if let Ok(line) = line_result {
line
} else {
break 'info_lines;
};
let mut split = line.split('=');
// Just unwraping here because the system is assumed to follow the specification.
let key = split.next().unwrap().trim();
let value = split.next().unwrap().trim();
if key == "Path" {
let mut value_path = Path::new(value).to_owned();
if value_path.is_relative() {
value_path = top_dir.join(value_path);
}
let full_path_utf8 = PathBuf::from(parse_uri_path(&value_path));
name = Some(full_path_utf8.file_name().unwrap().to_str().unwrap().to_owned());
let parent = full_path_utf8.parent().unwrap();
original_parent = Some(parent.into());
} else if key == "DeletionDate" {
#[cfg(feature = "chrono")]
{
use chrono::{NaiveDateTime, TimeZone};
let parsed_time = NaiveDateTime::parse_from_str(value, "%Y-%m-%dT%H:%M:%S");
let naive_local = match parsed_time {
Ok(t) => t,
Err(e) => {
log::error!("Failed to parse the deletion date of the trash item {:?}. The deletion date was '{}'. Parse error was: {:?}", name, value, e);
continue 'trash_item;
}
};
let time = chrono::Local.from_local_datetime(&naive_local).earliest();
match time {
Some(time) => time_deleted = Some(time.timestamp()),
None => {
log::error!("Failed to convert the local time to a UTC time. Local time was {:?}", naive_local);
continue 'trash_item;
}
}
}
}
}
if let Some(name) = name {
if let Some(original_parent) = original_parent {
if time_deleted.is_none() {
warn!("Could not determine the deletion time of the trash item. (The `DeletionDate` field is probably missing from the info file.) The info file path is: '{:?}'", info_path);
}
result.push(TrashItem {
id,
name,
original_parent,
time_deleted: time_deleted.unwrap_or(-1),
});
} else {
warn!("Could not determine the original parent folder of the trash item. (The `Path` field is probably missing from the info file.) The info file path is: '{:?}'", info_path);
}
} else {
warn!("Could not determine the name of the trash item. (The `Path` field is probably missing from the info file.) The info file path is: '{:?}'", info_path);
}
}
}
Ok(result)
}
pub fn purge_all<I>(items: I) -> Result<(), Error>
where
I: IntoIterator<Item = TrashItem>,
{
for item in items.into_iter() {
// When purging an item the "in-trash" filename must be parsed from the trashinfo filename
// which is the filename in the `id` field.
let info_file = &item.id;
// A bunch of unwraps here. This is fine because if any of these fail that means
// that either there's a bug in this code or the target system didn't follow
// the specification.
let file = restorable_file_in_trash_from_info_file(info_file);
assert!(file.exists());
if file.is_dir() {
std::fs::remove_dir_all(&file).map_err(|e| fsys_err_to_unknown(&file, e))?;
// TODO Update directory size cache if there's one.
} else {
std::fs::remove_file(&file).map_err(|e| fsys_err_to_unknown(&file, e))?;
}
std::fs::remove_file(info_file).map_err(|e| fsys_err_to_unknown(&info_file, e))?;
}
Ok(())
}
fn restorable_file_in_trash_from_info_file(info_file: impl AsRef<std::ffi::OsStr>) -> PathBuf {
let info_file = info_file.as_ref();
let trash_folder = Path::new(info_file).parent().unwrap().parent().unwrap();
let name_in_trash = Path::new(info_file).file_stem().unwrap();
trash_folder.join("files").join(&name_in_trash)
}
pub fn restore_all<I>(items: I) -> Result<(), Error>
where
I: IntoIterator<Item = TrashItem>,
{
// Simply read the items' original location from the infofile and attemp to move the items there
// and delete the infofile if the move operation was sucessful.
let mut iter = items.into_iter();
while let Some(item) = iter.next() {
// The "in-trash" filename must be parsed from the trashinfo filename
// which is the filename in the `id` field.
let info_file = &item.id;
// A bunch of unwraps here. This is fine because if any of these fail that means
// that either there's a bug in this code or the target system didn't follow
// the specification.
let file = restorable_file_in_trash_from_info_file(info_file);
assert!(file.exists());
// TODO add option to forcefully replace any target at the restore location
// if it already exists.
let original_path = item.original_path();
// Make sure the parent exists so that `create_dir` doesn't faile due to that.
create_dir_all(&item.original_parent)
.map_err(|e| fsys_err_to_unknown(&item.original_parent, e))?;
let mut collision = false;
if file.is_dir() {
// NOTE create_dir_all succeeds when the path already exist but create_dir
// fails with `std::io::ErrorKind::AlreadyExists`.
if let Err(e) = std::fs::create_dir(&original_path) {
if e.kind() == std::io::ErrorKind::AlreadyExists {
collision = true;
} else {
return Err(fsys_err_to_unknown(&original_path, e));
}
}
} else {
// File or symlink
if let Err(e) = OpenOptions::new().create_new(true).write(true).open(&original_path) {
if e.kind() == std::io::ErrorKind::AlreadyExists {
collision = true;
} else {
return Err(fsys_err_to_unknown(&original_path, e));
}
}
}
if collision {
let remaining: Vec<_> = std::iter::once(item).chain(iter).collect();
return Err(Error::RestoreCollision {
path: original_path,
remaining_items: remaining,
});
}
std::fs::rename(&file, &original_path).map_err(|e| fsys_err_to_unknown(&file, e))?;
std::fs::remove_file(info_file).map_err(|e| fsys_err_to_unknown(&info_file, e))?;
}
Ok(())
}
/// According to the specification (see at the top of the file) there are two kinds of
/// trash-folders for a mounted drive or partition.
/// 1, .Trash/uid
/// 2, .Trash-uid
///
/// This function executes `op` providing it with a
/// trash-folder path that's associated with the partition mounted at `topdir`.
///
fn execute_on_mounted_trash_folders<F: FnMut(PathBuf) -> Result<(), Error>>(
uid: u32,
topdir: impl AsRef<Path>,
first_only: bool,
create_folder: bool,
mut op: F,
) -> Result<(), Error> {
let topdir = topdir.as_ref();
// See if there's a ".Trash" directory at the mounted location
let trash_path = topdir.join(".Trash");
if trash_path.is_dir() {
let validity = folder_validity(&trash_path)?;
if validity == TrashValidity::Valid {
let users_trash_path = trash_path.join(uid.to_string());
if users_trash_path.exists() && users_trash_path.is_dir() {
op(users_trash_path)?;
if first_only {
return Ok(());
}
}
} else {
warn!(
"A Trash folder was found at '{:?}', but it's invalid because it's {:?}",
trash_path, validity
);
}
}
// See if there's a ".Trash-$UID" directory at the mounted location
let trash_path = topdir.join(format!(".Trash-{}", uid));
let should_execute;
if !trash_path.exists() || !trash_path.is_dir() {
if create_folder {
std::fs::create_dir(&trash_path).map_err(|e| fsys_err_to_unknown(&trash_path, e))?;
should_execute = true;
} else {
should_execute = false;
}
} else {
should_execute = true;
}
if should_execute {
op(trash_path)?;
}
Ok(())
}
fn move_to_trash(
src: impl AsRef<Path>,
trash_folder: impl AsRef<Path>,
_topdir: impl AsRef<Path>,
) -> Result<(), Error> {
let src = src.as_ref();
let trash_folder = trash_folder.as_ref();
let files_folder = trash_folder.join("files");
let info_folder = trash_folder.join("info");
// Ensure the `files` and `info` folders exist
create_dir_all(&files_folder).map_err(|e| fsys_err_to_unknown(&files_folder, e))?;
create_dir_all(&info_folder).map_err(|e| fsys_err_to_unknown(&info_folder, e))?;
// This kind of validity must only apply ot administrator style trash folders
// See Trash directories, (1) at https://specifications.freedesktop.org/trash-spec/trashspec-1.0.html
//assert_eq!(folder_validity(trash_folder)?, TrashValidity::Valid);
// When trashing a file one must make sure that every trashed item is uniquely named.
// However the `rename` function -that is used in *nix systems to move files- by default
// overwrites the destination. Therefore when multiple threads are removing items with identical
// names, an implementation might accidently overwrite an item that was just put into the trash
// if it's not careful enough.
//
// The strategy here is to use the `create_new` parameter of `OpenOptions` to
// try creating a placeholder file in the trash but don't do so if one with an identical name
// already exist. This newly created empty file can then be safely overwritten by the src file
// using the `rename` function.
let filename = src.file_name().unwrap();
let mut appendage = 0;
loop {
use std::io;
appendage += 1;
let in_trash_name = if appendage > 1 {
format!("{}.{}", filename.to_str().unwrap(), appendage)
} else {
filename.to_str().unwrap().into()
};
let info_name = format!("{}.trashinfo", in_trash_name);
let info_file_path = info_folder.join(&info_name);
let info_result = OpenOptions::new().create_new(true).write(true).open(&info_file_path);
match info_result {
Err(error) => {
if error.kind() == io::ErrorKind::AlreadyExists {
continue;
} else {
debug!("Failed to create the new file {:?}", info_file_path);
return Err(fsys_err_to_unknown(info_file_path, error));
}
}
Ok(mut file) => {
debug!("Successfully created {:?}", info_file_path);
// Write the info file before actually moving anything
writeln!(file, "[Trash Info]")
.and_then(|_| {
let absolute_uri = encode_uri_path(src);
writeln!(file, "Path={}", absolute_uri).and_then(|_| {
#[cfg(feature = "chrono")]
{
let now = chrono::Local::now();
writeln!(file, "DeletionDate={}", now.format("%Y-%m-%dT%H:%M:%S"))
}
#[cfg(not(feature = "chrono"))]
{
Ok(())
}
})
})
.map_err(|e| fsys_err_to_unknown(&info_file_path, e))?;
}
}
let path = files_folder.join(&in_trash_name);
match move_items_no_replace(src, &path) {
Err(error) => {
debug!("Failed moving item to the trash (this is usually OK). {:?}", error);
// Try to delete the info file
if let Err(info_err) = std::fs::remove_file(info_file_path) {
warn!("Created the trash info file, then failed to move the item to the trash. So far it's OK, but then failed remove the initial info file. There's either a bug in this program or another faulty program is manupulating the Trash. The error was: {:?}", info_err);
}
if error.kind() == io::ErrorKind::AlreadyExists {
continue;
} else {
return Err(fsys_err_to_unknown(path, error));
}
}
Ok(_) => {
// We did it!
break;
}
}
}
Ok(())
}
fn execute_src_to_dst_operation<S1, D1>(
src: S1,
dst: D1,
dir: &'static dyn Fn(&Path) -> Result<(), std::io::Error>,
file: &'static dyn Fn(&Path, &Path) -> Result<(), std::io::Error>,
) -> Result<(), std::io::Error>
where
S1: AsRef<Path>,
D1: AsRef<Path>,
{
let src = src.as_ref();
let dst = dst.as_ref();
let metadata = src.symlink_metadata()?;
if metadata.is_dir() {
dir(dst)?;
let dir_entries = std::fs::read_dir(src)?;
for entry in dir_entries {
// Forward the error because it's not okay if something is happening
// to the files while we are trying to move them.
let entry = entry?;
let entry_src = entry.path();
let entry_dst = dst.join(entry.file_name());
execute_src_to_dst_operation(entry_src, entry_dst, dir, file)?;
}
} else {
// Symlink or file
file(src, dst)?;
}
Ok(())
}
/// An error may mean that a collision was found.
fn move_items_no_replace(
src: impl AsRef<Path>,
dst: impl AsRef<Path>,
) -> Result<(), std::io::Error> {
let src = src.as_ref();
let dst = dst.as_ref();
try_creating_placeholders(src, dst)?;
// All placeholders are in place. LET'S OVERWRITE
execute_src_to_dst_operation(src, dst, &|_| Ok(()), &|src, dst| {
if let Some(parent) = dst.parent() {
if let Err(err) = std::fs::create_dir_all(parent) {
warn!(
"Failed to create destination directory. It probably already exists. {:?}",
err
);
}
}
std::fs::rename(src, dst)
})?;
// Once everything is moved, lets recursively remove the directory
if src.is_dir() {
std::fs::remove_dir_all(src)?;
}
Ok(())
}
fn try_creating_placeholders(
src: impl AsRef<Path>,
dst: impl AsRef<Path>,
) -> Result<(), std::io::Error> {
let src = src.as_ref();
let dst = dst.as_ref();
let metadata = src.symlink_metadata()?;
if metadata.is_dir() {
// NOTE create_dir fails if the directory already exists
std::fs::create_dir(dst)?;
} else {
// Symlink or file
OpenOptions::new().create_new(true).write(true).open(dst)?;
}
Ok(())
}
fn parse_uri_path(absolute_file_path: impl AsRef<Path>) -> String {
let file_path_chars = absolute_file_path.as_ref().to_str().unwrap().chars();
let url: String = "file://".chars().chain(file_path_chars).collect();
return url::Url::parse(&url).unwrap().to_file_path().unwrap().to_str().unwrap().into();
}
fn encode_uri_path(absolute_file_path: impl AsRef<Path>) -> String {
let url = url::Url::from_file_path(absolute_file_path.as_ref()).unwrap();
url.path().to_owned()
}
#[derive(Eq, PartialEq, Debug)]
enum TrashValidity {
Valid,
InvalidSymlink,
InvalidNotSticky,
}
fn folder_validity(path: impl AsRef<Path>) -> Result<TrashValidity, Error> {
/// Mask for the sticky bit
/// Taken from: http://man7.org/linux/man-pages/man7/inode.7.html
const S_ISVTX: u32 = 0x1000;
let metadata = path.as_ref().symlink_metadata().map_err(|e| fsys_err_to_unknown(path, e))?;
if metadata.file_type().is_symlink() {
return Ok(TrashValidity::InvalidSymlink);
}
let mode = metadata.permissions().mode();
let no_sticky_bit = (mode & S_ISVTX) == 0;
if no_sticky_bit {
return Ok(TrashValidity::InvalidNotSticky);
}
Ok(TrashValidity::Valid)
}
/// Corresponds to the definition of "home_trash" from
/// https://specifications.freedesktop.org/trash-spec/trashspec-1.0.html
fn home_trash() -> Result<PathBuf, Error> {
if let Some(data_home) = std::env::var_os("XDG_DATA_HOME") {
if data_home.len() > 0 {
let data_home_path = AsRef::<Path>::as_ref(data_home.as_os_str());
return Ok(data_home_path.join("Trash"));
}
}
if let Some(home) = std::env::var_os("HOME") {
if home.len() > 0 {
let home_path = AsRef::<Path>::as_ref(home.as_os_str());
return Ok(home_path.join(".local/share/Trash"));
}
}
Err(Error::Unknown {
description: "Neither the XDG_DATA_HOME nor the HOME environment variable was found".into(),
})
}
fn home_topdir(mnt_points: &[MountPoint]) -> Result<PathBuf, Error> {
if let Some(data_home) = std::env::var_os("XDG_DATA_HOME") {
if data_home.len() > 0 {
let data_home_path = AsRef::<Path>::as_ref(data_home.as_os_str());
return Ok(get_topdir_for_path(data_home_path, mnt_points).to_owned());
}
}
if let Some(home) = std::env::var_os("HOME") {
if home.len() > 0 {
let home_path = AsRef::<Path>::as_ref(home.as_os_str());
return Ok(get_topdir_for_path(home_path, mnt_points).to_owned());
}
}
Err(Error::Unknown {
description: "Neither the XDG_DATA_HOME nor the HOME environment variable was found".into(),
})
}
fn get_topdir_for_path<'a>(path: &Path, mnt_points: &'a [MountPoint]) -> &'a Path {
let root: &'static Path = Path::new("/");
let mut topdir = None;
for mount_point in mnt_points.iter() {
if mount_point.mnt_dir == root {
continue;
}
if path.starts_with(&mount_point.mnt_dir) {
topdir = Some(&mount_point.mnt_dir);
break;
}
}
if let Some(t) = topdir {
t
} else {
root
}
}
struct MountPoint {
mnt_dir: PathBuf,
_mnt_type: String,
_mnt_fsname: String,
}
#[cfg(target_os = "linux")]
fn get_mount_points() -> Result<Vec<MountPoint>, Error> {
use once_cell::sync::Lazy;
use scopeguard::defer;
use std::ffi::{CStr, CString};
use std::sync::Mutex;
// The getmntinfo() function writes the array of structures to an internal
// static object and returns a pointer to that object. Subsequent calls to
// getmntent() will modify the same object. This means that the function is
// not threadsafe. To help prevent multiple threads using it concurrently
// via get_mount_points a Mutex is used.
// We understand that threads can still call `libc::getmntent(…)` directly
// to bypass the lock and trigger UB.
static LOCK: Lazy<Mutex<()>> = Lazy::new(|| Mutex::new(()));
let _lock = LOCK.lock().unwrap();
//let file;
let read_arg = CString::new("r").unwrap();
let mounts_path = CString::new("/proc/mounts").unwrap();
let mut file =
unsafe { libc::fopen(mounts_path.as_c_str().as_ptr(), read_arg.as_c_str().as_ptr()) };
if file.is_null() {
let mtab_path = CString::new("/etc/mtab").unwrap();
file = unsafe { libc::fopen(mtab_path.as_c_str().as_ptr(), read_arg.as_c_str().as_ptr()) };
}
if file.is_null() {
return Err(Error::Unknown {
description: "Neither '/proc/mounts' nor '/etc/mtab' could be opened.".into(),
});
}
defer! { unsafe { libc::fclose(file); } }
let mut result = Vec::new();
loop {
let mntent = unsafe { libc::getmntent(file) };
if mntent.is_null() {
break;
}
let dir = unsafe { CStr::from_ptr((*mntent).mnt_dir).to_str().unwrap() };
if dir.bytes().len() == 0 {
continue;
}
let mount_point = unsafe {
MountPoint {
mnt_dir: dir.into(),
_mnt_fsname: CStr::from_ptr((*mntent).mnt_fsname).to_str().unwrap().into(),
_mnt_type: CStr::from_ptr((*mntent).mnt_type).to_str().unwrap().into(),
}
};
result.push(mount_point);
}
if result.is_empty() {
return Err(Error::Unknown {
description:
"A mount points file could be opened, but the call to `getmntent` returned NULL."
.into(),
});
}
Ok(result)
}
#[cfg(any(target_os = "freebsd", target_os = "openbsd", target_os = "netbsd"))]
fn get_mount_points() -> Result<Vec<MountPoint>, Error> {
use once_cell::sync::Lazy;
use std::sync::Mutex;
// The getmntinfo() function writes the array of structures to an internal
// static object and returns a pointer to that object. Subsequent calls to
// getmntinfo() will modify the same object. This means that the function is
// not threadsafe. To help prevent multiple threads using it concurrently
// via get_mount_points a Mutex is used.
// We understand that threads can still call `libc::getmntinfo(…)` directly
// to bypass the lock and trigger UB.
static LOCK: Lazy<Mutex<()>> = Lazy::new(|| Mutex::new(()));
let _lock = LOCK.lock().unwrap();
fn c_buf_to_str(buf: &[libc::c_char]) -> Option<&str> {
let buf: &[u8] = unsafe { std::slice::from_raw_parts(buf.as_ptr() as _, buf.len()) };
if let Some(pos) = buf.iter().position(|x| *x == 0) {
// Shrink buffer to omit the null bytes
std::str::from_utf8(&buf[..pos]).ok()
} else {
std::str::from_utf8(buf).ok()
}
}
let mut fs_infos: *mut libc::statfs = std::ptr::null_mut();
let count = unsafe { libc::getmntinfo(&mut fs_infos, libc::MNT_WAIT) };
if count < 1 {
return Ok(Vec::new());
}
let fs_infos: &[libc::statfs] =
unsafe { std::slice::from_raw_parts(fs_infos as _, count as _) };
let mut result = Vec::new();
for fs_info in fs_infos {
if fs_info.f_mntfromname[0] == 0 || fs_info.f_mntonname[0] == 0 {
// If we have missing information, no need to look any further...
continue;
}
let fs_type = c_buf_to_str(&fs_info.f_fstypename).unwrap_or_default();
let mount_to = match c_buf_to_str(&fs_info.f_mntonname) {
Some(m) => m,
None => {
debug!("Cannot get disk mount point, ignoring it.");
continue;
}
};
let mount_from = c_buf_to_str(&fs_info.f_mntfromname).unwrap_or_default();
let mount_point = MountPoint {
mnt_dir: mount_to.into(),
_mnt_fsname: mount_from.into(),
_mnt_type: fs_type.into(),
};
result.push(mount_point);
}
Ok(result)
}
#[cfg(test)]
mod tests {
use serial_test::serial;
use std::{
collections::{hash_map::Entry, HashMap},
env,
ffi::OsString,
fmt,
fs::File,
path::{Path, PathBuf},
process::Command,
};
use log::warn;
use crate::{
canonicalize_paths, delete_all,
os_limited::{list, purge_all},
tests::get_unique_name,
Error,
};
#[test]
#[serial]
fn test_list() {
crate::tests::init_logging();
let file_name_prefix = get_unique_name();
let batches: usize = 2;
let files_per_batch: usize = 3;
let names: Vec<_> =
(0..files_per_batch).map(|i| format!("{}#{}", file_name_prefix, i)).collect();
for _ in 0..batches {
for path in names.iter() {
File::create(path).unwrap();
}
// eprintln!("Deleting {:?}", names);
let result = delete_all_using_system_program(&names);
if let Err(SystemTrashError::NoTrashProgram) = &result {
// For example may be the case on build systems that don't have a destop environment
warn!(
"No system default trashing utility was found, using this crate's implementation"
);
delete_all(&names).unwrap();
} else {
result.unwrap();
}
}
let items = list().unwrap();
let items: HashMap<_, Vec<_>> = items
.into_iter()
.filter(|x| x.name.starts_with(&file_name_prefix))
.fold(HashMap::new(), |mut map, x| {
match map.entry(x.name.clone()) {
Entry::Occupied(mut entry) => {
entry.get_mut().push(x);
}
Entry::Vacant(entry) => {
entry.insert(vec![x]);
}
}
map
});
for name in names {
match items.get(&name) {
Some(items) => assert_eq!(items.len(), batches),
None => panic!("ERROR Could not find '{}' in {:#?}", name, items),
}
}
// Let's try to purge all the items we just created but ignore any errors
// as this test should succeed as long as `list` works properly.
let _ = purge_all(items.into_iter().map(|(_name, item)| item).flatten());
}
//////////////////////////////////////////////////////////////////////////////////////
/// System
//////////////////////////////////////////////////////////////////////////////////////
#[derive(Debug)]
pub enum SystemTrashError {
NoTrashProgram,
Other(Error),
}
impl fmt::Display for SystemTrashError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "SystemTrashError during a `trash` operation: {:?}", self)
}
}
impl std::error::Error for SystemTrashError {}
fn is_program_in_path(program: &str) -> bool {
if let Some(path_vars) = std::env::var_os("PATH") {
for path in std::env::split_paths(&path_vars) {
let full_path = path.join(program);
if full_path.is_file() {
return true;
}
}
}
false
}
/// This is based on the electron library's implementation.
/// See: https://github.com/electron/electron/blob/34c4c8d5088fa183f56baea28809de6f2a427e02/shell/common/platform_util_linux.cc#L96
pub fn delete_all_canonicalized_using_system_program(
full_paths: Vec<PathBuf>,
) -> Result<(), SystemTrashError> {
static DEFAULT_TRASH: &str = "gio";
let trash = {
// Determine desktop environment and set accordingly.
let desktop_env = get_desktop_environment();
if desktop_env == DesktopEnvironment::Kde4 || desktop_env == DesktopEnvironment::Kde5 {
"kioclient5"
} else if desktop_env == DesktopEnvironment::Kde3 {
"kioclient"
} else {
DEFAULT_TRASH
}
};
let mut argv = Vec::<OsString>::with_capacity(full_paths.len() + 2);
if trash == "kioclient5" || trash == "kioclient" {
//argv.push(trash.into());
argv.push("move".into());
for full_path in full_paths.iter() {
argv.push(full_path.into());
}
argv.push("trash:/".into());
} else {
//argv.push_back(ELECTRON_DEFAULT_TRASH);
argv.push("trash".into());
for full_path in full_paths.iter() {
argv.push(full_path.into());
}
}
if !is_program_in_path(trash) {
return Err(SystemTrashError::NoTrashProgram);
}
// Execute command
let mut command = Command::new(trash);
command.args(argv);
let result = command.output().map_err(|e| {
SystemTrashError::Other(Error::Unknown {
description: format!("Tried executing: {:?} - Error was: {}", command, e),
})
})?;
if !result.status.success() {
let stderr = String::from_utf8_lossy(&result.stderr);
return Err(SystemTrashError::Other(Error::Unknown {
description: format!("Used '{}', stderr: {}", trash, stderr),
}));
}
Ok(())
}
pub fn delete_all_using_system_program<I, T>(paths: I) -> Result<(), SystemTrashError>
where
I: IntoIterator<Item = T>,
T: AsRef<Path>,
{
let full_paths = canonicalize_paths(paths).map_err(SystemTrashError::Other)?;
delete_all_canonicalized_using_system_program(full_paths)
}
#[derive(PartialEq)]
enum DesktopEnvironment {
Other,
Cinnamon,
Gnome,
// KDE3, KDE4 and KDE5 are sufficiently different that we count
// them as different desktop environments here.
Kde3,
Kde4,
Kde5,
Pantheon,
Unity,
Xfce,
}
fn env_has_var(name: &str) -> bool {
env::var_os(name).is_some()
}
/// See: https://chromium.googlesource.com/chromium/src/+/dd407d416fa941c04e33d81f2b1d8cab8196b633/base/nix/xdg_util.cc#57
fn get_desktop_environment() -> DesktopEnvironment {
static KDE_SESSION_ENV_VAR: &str = "KDE_SESSION_VERSION";
// XDG_CURRENT_DESKTOP is the newest standard circa 2012.
if let Ok(xdg_current_desktop) = env::var("XDG_CURRENT_DESKTOP") {
// It could have multiple values separated by colon in priority order.
for value in xdg_current_desktop.split(':') {
let value = value.trim();
if value.is_empty() {
continue;
}
match value {
"Unity" => {
// gnome-fallback sessions set XDG_CURRENT_DESKTOP to Unity
// DESKTOP_SESSION can be gnome-fallback or gnome-fallback-compiz
if let Ok(desktop_session) = env::var("DESKTOP_SESSION") {
if desktop_session.contains("gnome-fallback") {
return DesktopEnvironment::Gnome;
}
}
return DesktopEnvironment::Unity;
}
"GNOME" => {
return DesktopEnvironment::Gnome;
}
"X-Cinnamon" => {
return DesktopEnvironment::Cinnamon;
}
"KDE" => {
if let Ok(kde_session) = env::var(KDE_SESSION_ENV_VAR) {
if kde_session == "5" {
return DesktopEnvironment::Kde5;
}
}
return DesktopEnvironment::Kde4;
}
"Pantheon" => {
return DesktopEnvironment::Pantheon;
}
"XFCE" => {
return DesktopEnvironment::Xfce;
}
_ => {}
}
}
}
// DESKTOP_SESSION was what everyone used in 2010.
if let Ok(desktop_session) = env::var("DESKTOP_SESSION") {
match desktop_session.as_str() {
"gnome" | "mate" => {
return DesktopEnvironment::Gnome;
}
"kde4" | "kde-plasma" => {
return DesktopEnvironment::Kde4;