1 use std
::collections
::{HashSet, HashMap}
;
2 use std
::ffi
::{CStr, CString, OsStr}
;
4 use std
::io
::{self, Read, Write}
;
5 use std
::os
::unix
::ffi
::OsStrExt
;
6 use std
::os
::unix
::io
::{AsRawFd, FromRawFd, IntoRawFd, RawFd}
;
7 use std
::path
::{Path, PathBuf}
;
9 use anyhow
::{bail, format_err, Error}
;
11 use nix
::errno
::Errno
;
12 use nix
::fcntl
::OFlag
;
13 use nix
::sys
::stat
::{FileStat, Mode}
;
15 use pathpatterns
::{MatchEntry, MatchFlag, MatchList, MatchType, PatternFlag}
;
17 use pxar
::encoder
::LinkOffset
;
20 use proxmox
::sys
::error
::SysError
;
21 use proxmox
::tools
::fd
::RawFdNum
;
22 use proxmox
::tools
::vec
;
24 use crate::pxar
::catalog
::BackupCatalogWriter
;
25 use crate::pxar
::metadata
::errno_is_unsupported
;
26 use crate::pxar
::Flags
;
27 use crate::pxar
::tools
::assert_single_path_component
;
28 use crate::tools
::{acl, fs, xattr, Fd}
;
30 fn detect_fs_type(fd
: RawFd
) -> Result
<i64, Error
> {
31 let mut fs_stat
= std
::mem
::MaybeUninit
::uninit();
32 let res
= unsafe { libc::fstatfs(fd, fs_stat.as_mut_ptr()) }
;
34 let fs_stat
= unsafe { fs_stat.assume_init() }
;
40 pub fn is_virtual_file_system(magic
: i64) -> bool
{
41 use proxmox
::sys
::linux
::magic
::*;
51 FUSE_CTL_SUPER_MAGIC
|
73 fn new(path
: PathBuf
, error
: Error
) -> Self {
78 impl std
::error
::Error
for ArchiveError {}
80 impl fmt
::Display
for ArchiveError
{
81 fn fmt(&self, f
: &mut fmt
::Formatter
) -> fmt
::Result
{
82 write
!(f
, "error at {:?}: {}", self.path
, self.error
)
86 #[derive(Eq, PartialEq, Hash)]
92 /// TODO: make a builder for the create_archive call for fewer parameters and add a method to add a
93 /// logger which does not write to stderr.
96 impl std
::io
::Write
for Logger
{
97 fn write(&mut self, data
: &[u8]) -> io
::Result
<usize> {
98 std
::io
::stderr().write(data
)
101 fn flush(&mut self) -> io
::Result
<()> {
102 std
::io
::stderr().flush()
106 /// And the error case.
107 struct ErrorReporter
;
109 impl std
::io
::Write
for ErrorReporter
{
110 fn write(&mut self, data
: &[u8]) -> io
::Result
<usize> {
111 std
::io
::stderr().write(data
)
114 fn flush(&mut self) -> io
::Result
<()> {
115 std
::io
::stderr().flush()
119 struct Archiver
<'a
, 'b
> {
120 feature_flags
: Flags
,
121 fs_feature_flags
: Flags
,
123 patterns
: Vec
<MatchEntry
>,
124 callback
: &'a
mut dyn FnMut(&Path
) -> Result
<(), Error
>,
125 catalog
: Option
<&'b
mut dyn BackupCatalogWriter
>,
127 entry_counter
: usize,
129 current_st_dev
: libc
::dev_t
,
130 device_set
: Option
<HashSet
<u64>>,
131 hardlinks
: HashMap
<HardLinkInfo
, (PathBuf
, LinkOffset
)>,
132 errors
: ErrorReporter
,
134 file_copy_buffer
: Vec
<u8>,
137 type Encoder
<'a
, 'b
> = pxar
::encoder
::Encoder
<'a
, &'b
mut dyn pxar
::encoder
::SeqWrite
>;
139 pub fn create_archive
<T
, F
>(
142 mut patterns
: Vec
<MatchEntry
>,
143 feature_flags
: Flags
,
144 mut device_set
: Option
<HashSet
<u64>>,
145 skip_lost_and_found
: bool
,
148 catalog
: Option
<&mut dyn BackupCatalogWriter
>,
149 ) -> Result
<(), Error
>
151 T
: pxar
::encoder
::SeqWrite
,
152 F
: FnMut(&Path
) -> Result
<(), Error
>,
154 let fs_magic
= detect_fs_type(source_dir
.as_raw_fd())?
;
155 if is_virtual_file_system(fs_magic
) {
156 bail
!("refusing to backup a virtual file system");
159 let fs_feature_flags
= Flags
::from_magic(fs_magic
);
161 let stat
= nix
::sys
::stat
::fstat(source_dir
.as_raw_fd())?
;
162 let metadata
= get_metadata(
163 source_dir
.as_raw_fd(),
165 feature_flags
& fs_feature_flags
,
168 .map_err(|err
| format_err
!("failed to get metadata for source directory: {}", err
))?
;
170 if let Some(ref mut set
) = device_set
{
171 set
.insert(stat
.st_dev
);
174 let writer
= &mut writer
as &mut dyn pxar
::encoder
::SeqWrite
;
175 let mut encoder
= Encoder
::new(writer
, &metadata
)?
;
177 if skip_lost_and_found
{
178 patterns
.push(MatchEntry
::parse_pattern(
180 PatternFlag
::PATH_NAME
,
185 let mut archiver
= Archiver
{
189 callback
: &mut callback
,
192 path
: PathBuf
::new(),
195 current_st_dev
: stat
.st_dev
,
197 hardlinks
: HashMap
::new(),
198 errors
: ErrorReporter
,
200 file_copy_buffer
: vec
::undefined(4 * 1024 * 1024),
203 archiver
.archive_dir_contents(&mut encoder
, source_dir
, true)?
;
208 struct FileListEntry
{
214 impl<'a
, 'b
> Archiver
<'a
, 'b
> {
215 /// Get the currently effective feature flags. (Requested flags masked by the file system
217 fn flags(&self) -> Flags
{
218 self.feature_flags
& self.fs_feature_flags
221 fn wrap_err(&self, err
: Error
) -> Error
{
222 if err
.downcast_ref
::<ArchiveError
>().is_some() {
225 ArchiveError
::new(self.path
.clone(), err
).into()
229 fn archive_dir_contents(
231 encoder
: &mut Encoder
,
234 ) -> Result
<(), Error
> {
235 let entry_counter
= self.entry_counter
;
237 let old_patterns_count
= self.patterns
.len();
238 self.read_pxar_excludes(dir
.as_raw_fd())?
;
240 let file_list
= self.generate_directory_file_list(&mut dir
, is_root
)?
;
242 let dir_fd
= dir
.as_raw_fd();
244 let old_path
= std
::mem
::take(&mut self.path
);
246 for file_entry
in file_list
{
247 let file_name
= file_entry
.name
.to_bytes();
249 if is_root
&& file_name
== b
".pxarexclude-cli" {
250 self.encode_pxarexclude_cli(encoder
, &file_entry
.name
)?
;
254 (self.callback
)(&file_entry
.path
)?
;
255 self.path
= file_entry
.path
;
256 self.add_entry(encoder
, dir_fd
, &file_entry
.name
, &file_entry
.stat
)
257 .map_err(|err
| self.wrap_err(err
))?
;
259 self.path
= old_path
;
260 self.entry_counter
= entry_counter
;
261 self.patterns
.truncate(old_patterns_count
);
266 /// openat() wrapper which allows but logs `EACCES` and turns `ENOENT` into `None`.
268 /// The `existed` flag is set when iterating through a directory to note that we know the file
269 /// is supposed to exist and we should warn if it doesnt'.
276 ) -> Result
<Option
<Fd
>, Error
> {
277 // common flags we always want to use:
278 let oflags
= oflags
| OFlag
::O_CLOEXEC
| OFlag
::O_NOCTTY
;
280 let mut noatime
= OFlag
::O_NOATIME
;
282 return match Fd
::openat(
283 &unsafe { RawFdNum::from_raw_fd(parent) }
,
288 Ok(fd
) => Ok(Some(fd
)),
289 Err(nix
::Error
::Sys(Errno
::ENOENT
)) => {
291 self.report_vanished_file()?
;
295 Err(nix
::Error
::Sys(Errno
::EACCES
)) => {
296 writeln
!(self.errors
, "failed to open file: {:?}: access denied", file_name
)?
;
299 Err(nix
::Error
::Sys(Errno
::EPERM
)) if !noatime
.is_empty() => {
300 // Retry without O_NOATIME:
301 noatime
= OFlag
::empty();
304 Err(other
) => Err(Error
::from(other
)),
309 fn read_pxar_excludes(&mut self, parent
: RawFd
) -> Result
<(), Error
> {
310 let fd
= match self.open_file(parent
, c_str
!(".pxarexclude"), OFlag
::O_RDONLY
, false)?
{
312 None
=> return Ok(()),
315 let old_pattern_count
= self.patterns
.len();
317 let path_bytes
= self.path
.as_os_str().as_bytes();
319 let file
= unsafe { std::fs::File::from_raw_fd(fd.into_raw_fd()) }
;
322 for line
in io
::BufReader
::new(file
).split(b'
\n'
) {
323 let line
= match line
{
328 "ignoring .pxarexclude after read error in {:?}: {}",
332 self.patterns
.truncate(old_pattern_count
);
337 let line
= crate::tools
::strip_ascii_whitespace(&line
);
339 if line
.is_empty() || line
[0] == b'
#' {
344 let (line
, mode
, anchored
) = if line
[0] == b'
/'
{
345 buf
= Vec
::with_capacity(path_bytes
.len() + 1 + line
.len());
346 buf
.extend(path_bytes
);
348 (&buf
[..], MatchType
::Exclude
, true)
349 } else if line
.starts_with(b
"!/") {
350 // inverted case with absolute path
351 buf
= Vec
::with_capacity(path_bytes
.len() + line
.len());
352 buf
.extend(path_bytes
);
353 buf
.extend(&line
[1..]); // without the '!'
354 (&buf
[..], MatchType
::Include
, true)
355 } else if line
.starts_with(b
"!") {
356 (&line
[1..], MatchType
::Include
, false)
358 (line
, MatchType
::Exclude
, false)
361 match MatchEntry
::parse_pattern(line
, PatternFlag
::PATH_NAME
, mode
) {
364 self.patterns
.push(pattern
.add_flags(MatchFlag
::ANCHORED
));
366 self.patterns
.push(pattern
);
370 let _
= writeln
!(self.errors
, "bad pattern in {:?}: {}", self.path
, err
);
378 fn encode_pxarexclude_cli(
380 encoder
: &mut Encoder
,
382 ) -> Result
<(), Error
> {
383 let content
= generate_pxar_excludes_cli(&self.patterns
);
385 if let Some(ref mut catalog
) = self.catalog
{
386 catalog
.add_file(file_name
, content
.len() as u64, 0)?
;
389 let mut metadata
= Metadata
::default();
390 metadata
.stat
.mode
= pxar
::format
::mode
::IFREG
| 0o600;
392 let mut file
= encoder
.create_file(&metadata
, ".pxarexclude-cli", content
.len() as u64)?
;
393 file
.write_all(&content
)?
;
398 fn generate_directory_file_list(
402 ) -> Result
<Vec
<FileListEntry
>, Error
> {
403 let dir_fd
= dir
.as_raw_fd();
405 let mut file_list
= Vec
::new();
407 if is_root
&& !self.patterns
.is_empty() {
408 file_list
.push(FileListEntry
{
409 name
: CString
::new(".pxarexclude-cli").unwrap(),
410 path
: PathBuf
::new(),
411 stat
: unsafe { std::mem::zeroed() }
,
415 for file
in dir
.iter() {
418 let file_name
= file
.file_name().to_owned();
419 let file_name_bytes
= file_name
.to_bytes();
420 if file_name_bytes
== b
"." || file_name_bytes
== b
".." {
424 if is_root
&& file_name_bytes
== b
".pxarexclude-cli" {
428 if file_name_bytes
== b
".pxarexclude" {
432 let os_file_name
= OsStr
::from_bytes(file_name_bytes
);
433 assert_single_path_component(os_file_name
)?
;
434 let full_path
= self.path
.join(os_file_name
);
436 let stat
= match nix
::sys
::stat
::fstatat(
438 file_name
.as_c_str(),
439 nix
::fcntl
::AtFlags
::AT_SYMLINK_NOFOLLOW
,
442 Err(ref err
) if err
.not_found() => continue,
443 Err(err
) => bail
!("stat failed on {:?}: {}", full_path
, err
),
448 .matches(full_path
.as_os_str().as_bytes(), Some(stat
.st_mode
as u32))
449 == Some(MatchType
::Exclude
)
454 self.entry_counter
+= 1;
455 if self.entry_counter
> self.entry_limit
{
456 bail
!("exceeded allowed number of file entries (> {})",self.entry_limit
);
459 file_list
.push(FileListEntry
{
466 file_list
.sort_unstable_by(|a
, b
| a
.name
.cmp(&b
.name
));
471 fn report_vanished_file(&mut self) -> Result
<(), Error
> {
472 writeln
!(self.errors
, "warning: file vanished while reading: {:?}", self.path
)?
;
476 fn report_file_shrunk_while_reading(&mut self) -> Result
<(), Error
> {
479 "warning: file size shrunk while reading: {:?}, file will be padded with zeros!",
485 fn report_file_grew_while_reading(&mut self) -> Result
<(), Error
> {
488 "warning: file size increased while reading: {:?}, file will be truncated!",
496 encoder
: &mut Encoder
,
500 ) -> Result
<(), Error
> {
501 use pxar
::format
::mode
;
503 let file_mode
= stat
.st_mode
& libc
::S_IFMT
;
504 let open_mode
= if file_mode
== libc
::S_IFREG
|| file_mode
== libc
::S_IFDIR
{
510 let fd
= self.open_file(
513 open_mode
| OFlag
::O_RDONLY
| OFlag
::O_NOFOLLOW
,
519 None
=> return Ok(()),
522 let metadata
= get_metadata(fd
.as_raw_fd(), &stat
, self.flags(), self.fs_magic
)?
;
526 .matches(self.path
.as_os_str().as_bytes(), Some(stat
.st_mode
as u32))
527 == Some(MatchType
::Exclude
)
532 let file_name
: &Path
= OsStr
::from_bytes(c_file_name
.to_bytes()).as_ref();
533 match metadata
.file_type() {
535 let link_info
= HardLinkInfo
{
540 if stat
.st_nlink
> 1 {
541 if let Some((path
, offset
)) = self.hardlinks
.get(&link_info
) {
542 if let Some(ref mut catalog
) = self.catalog
{
543 catalog
.add_hardlink(c_file_name
)?
;
546 encoder
.add_hardlink(file_name
, path
, *offset
)?
;
552 let file_size
= stat
.st_size
as u64;
553 if let Some(ref mut catalog
) = self.catalog
{
554 catalog
.add_file(c_file_name
, file_size
, stat
.st_mtime
)?
;
557 let offset
: LinkOffset
=
558 self.add_regular_file(encoder
, fd
, file_name
, &metadata
, file_size
)?
;
560 if stat
.st_nlink
> 1 {
561 self.hardlinks
.insert(link_info
, (self.path
.clone(), offset
));
567 let dir
= Dir
::from_fd(fd
.into_raw_fd())?
;
569 if let Some(ref mut catalog
) = self.catalog
{
570 catalog
.start_directory(c_file_name
)?
;
572 let result
= self.add_directory(encoder
, dir
, c_file_name
, &metadata
, stat
);
573 if let Some(ref mut catalog
) = self.catalog
{
574 catalog
.end_directory()?
;
579 if let Some(ref mut catalog
) = self.catalog
{
580 catalog
.add_socket(c_file_name
)?
;
583 Ok(encoder
.add_socket(&metadata
, file_name
)?
)
586 if let Some(ref mut catalog
) = self.catalog
{
587 catalog
.add_fifo(c_file_name
)?
;
590 Ok(encoder
.add_fifo(&metadata
, file_name
)?
)
593 if let Some(ref mut catalog
) = self.catalog
{
594 catalog
.add_symlink(c_file_name
)?
;
597 self.add_symlink(encoder
, fd
, file_name
, &metadata
)
600 if let Some(ref mut catalog
) = self.catalog
{
601 catalog
.add_block_device(c_file_name
)?
;
604 self.add_device(encoder
, file_name
, &metadata
, &stat
)
607 if let Some(ref mut catalog
) = self.catalog
{
608 catalog
.add_char_device(c_file_name
)?
;
611 self.add_device(encoder
, file_name
, &metadata
, &stat
)
614 "encountered unknown file type: 0x{:x} (0o{:o})",
623 encoder
: &mut Encoder
,
628 ) -> Result
<(), Error
> {
629 let dir_name
= OsStr
::from_bytes(dir_name
.to_bytes());
631 let mut encoder
= encoder
.create_directory(dir_name
, &metadata
)?
;
633 let old_fs_magic
= self.fs_magic
;
634 let old_fs_feature_flags
= self.fs_feature_flags
;
635 let old_st_dev
= self.current_st_dev
;
637 let mut skip_contents
= false;
638 if old_st_dev
!= stat
.st_dev
{
639 self.fs_magic
= detect_fs_type(dir
.as_raw_fd())?
;
640 self.fs_feature_flags
= Flags
::from_magic(self.fs_magic
);
641 self.current_st_dev
= stat
.st_dev
;
643 if is_virtual_file_system(self.fs_magic
) {
644 skip_contents
= true;
645 } else if let Some(set
) = &self.device_set
{
646 skip_contents
= !set
.contains(&stat
.st_dev
);
650 let result
= if skip_contents
{
651 writeln
!(self.logger
, "skipping mount point: {:?}", self.path
)?
;
654 self.archive_dir_contents(&mut encoder
, dir
, false)
657 self.fs_magic
= old_fs_magic
;
658 self.fs_feature_flags
= old_fs_feature_flags
;
659 self.current_st_dev
= old_st_dev
;
667 encoder
: &mut Encoder
,
672 ) -> Result
<LinkOffset
, Error
> {
673 let mut file
= unsafe { std::fs::File::from_raw_fd(fd.into_raw_fd()) }
;
674 let mut remaining
= file_size
;
675 let mut out
= encoder
.create_file(metadata
, file_name
, file_size
)?
;
676 while remaining
!= 0 {
677 let mut got
= match file
.read(&mut self.file_copy_buffer
[..]) {
680 Err(err
) if err
.kind() == std
::io
::ErrorKind
::Interrupted
=> continue,
681 Err(err
) => bail
!(err
),
683 if got
as u64 > remaining
{
684 self.report_file_grew_while_reading()?
;
685 got
= remaining
as usize;
687 out
.write_all(&self.file_copy_buffer
[..got
])?
;
688 remaining
-= got
as u64;
691 self.report_file_shrunk_while_reading()?
;
692 let to_zero
= remaining
.min(self.file_copy_buffer
.len() as u64) as usize;
693 vec
::clear(&mut self.file_copy_buffer
[..to_zero
]);
694 while remaining
!= 0 {
695 let fill
= remaining
.min(self.file_copy_buffer
.len() as u64) as usize;
696 out
.write_all(&self.file_copy_buffer
[..fill
])?
;
697 remaining
-= fill
as u64;
701 Ok(out
.file_offset())
706 encoder
: &mut Encoder
,
710 ) -> Result
<(), Error
> {
711 let dest
= nix
::fcntl
::readlinkat(fd
.as_raw_fd(), &b
""[..])?
;
712 encoder
.add_symlink(metadata
, file_name
, dest
)?
;
718 encoder
: &mut Encoder
,
722 ) -> Result
<(), Error
> {
723 Ok(encoder
.add_device(
726 pxar
::format
::Device
::from_dev_t(stat
.st_rdev
),
731 fn get_metadata(fd
: RawFd
, stat
: &FileStat
, flags
: Flags
, fs_magic
: i64) -> Result
<Metadata
, Error
> {
732 // required for some of these
733 let proc_path
= Path
::new("/proc/self/fd/").join(fd
.to_string());
735 let mut meta
= Metadata
{
737 mode
: u64::from(stat
.st_mode
),
741 mtime
: pxar
::format
::StatxTimestamp
{
743 nanos
: stat
.st_mtime_nsec
as u32,
749 get_xattr_fcaps_acl(&mut meta
, fd
, &proc_path
, flags
)?
;
750 get_chattr(&mut meta
, fd
)?
;
751 get_fat_attr(&mut meta
, fd
, fs_magic
)?
;
752 get_quota_project_id(&mut meta
, fd
, flags
, fs_magic
)?
;
756 fn get_fcaps(meta
: &mut Metadata
, fd
: RawFd
, flags
: Flags
) -> Result
<(), Error
> {
757 if flags
.contains(Flags
::WITH_FCAPS
) {
761 match xattr
::fgetxattr(fd
, xattr
::xattr_name_fcaps()) {
763 meta
.fcaps
= Some(pxar
::format
::FCaps { data }
);
766 Err(Errno
::ENODATA
) => Ok(()),
767 Err(Errno
::EOPNOTSUPP
) => Ok(()),
768 Err(Errno
::EBADF
) => Ok(()), // symlinks
769 Err(err
) => bail
!("failed to read file capabilities: {}", err
),
773 fn get_xattr_fcaps_acl(
778 ) -> Result
<(), Error
> {
779 if flags
.contains(Flags
::WITH_XATTRS
) {
783 let xattrs
= match xattr
::flistxattr(fd
) {
785 Err(Errno
::EOPNOTSUPP
) => return Ok(()),
786 Err(Errno
::EBADF
) => return Ok(()), // symlinks
787 Err(err
) => bail
!("failed to read xattrs: {}", err
),
790 for attr
in &xattrs
{
791 if xattr
::is_security_capability(&attr
) {
792 get_fcaps(meta
, fd
, flags
)?
;
796 if xattr
::is_acl(&attr
) {
797 get_acl(meta
, proc_path
, flags
)?
;
801 if !xattr
::is_valid_xattr_name(&attr
) {
805 match xattr
::fgetxattr(fd
, attr
) {
808 .push(pxar
::format
::XAttr
::new(attr
.to_bytes(), data
)),
809 Err(Errno
::ENODATA
) => (), // it got removed while we were iterating...
810 Err(Errno
::EOPNOTSUPP
) => (), // shouldn't be possible so just ignore this
811 Err(Errno
::EBADF
) => (), // symlinks, shouldn't be able to reach this either
812 Err(err
) => bail
!("error reading extended attribute {:?}: {}", attr
, err
),
819 fn get_chattr(metadata
: &mut Metadata
, fd
: RawFd
) -> Result
<(), Error
> {
820 let mut attr
: libc
::c_long
= 0;
822 match unsafe { fs::read_attr_fd(fd, &mut attr) }
{
824 Err(nix
::Error
::Sys(errno
)) if errno_is_unsupported(errno
) => {
827 Err(err
) => bail
!("failed to read file attributes: {}", err
),
830 metadata
.stat
.flags
|= Flags
::from_chattr(attr
).bits();
835 fn get_fat_attr(metadata
: &mut Metadata
, fd
: RawFd
, fs_magic
: i64) -> Result
<(), Error
> {
836 use proxmox
::sys
::linux
::magic
::*;
838 if fs_magic
!= MSDOS_SUPER_MAGIC
&& fs_magic
!= FUSE_SUPER_MAGIC
{
842 let mut attr
: u32 = 0;
844 match unsafe { fs::read_fat_attr_fd(fd, &mut attr) }
{
846 Err(nix
::Error
::Sys(errno
)) if errno_is_unsupported(errno
) => {
849 Err(err
) => bail
!("failed to read fat attributes: {}", err
),
852 metadata
.stat
.flags
|= Flags
::from_fat_attr(attr
).bits();
857 /// Read the quota project id for an inode, supported on ext4/XFS/FUSE/ZFS filesystems
858 fn get_quota_project_id(
859 metadata
: &mut Metadata
,
863 ) -> Result
<(), Error
> {
864 if !(metadata
.is_dir() || metadata
.is_regular_file()) {
868 if flags
.contains(Flags
::WITH_QUOTA_PROJID
) {
872 use proxmox
::sys
::linux
::magic
::*;
875 EXT4_SUPER_MAGIC
| XFS_SUPER_MAGIC
| FUSE_SUPER_MAGIC
| ZFS_SUPER_MAGIC
=> (),
879 let mut fsxattr
= fs
::FSXAttr
::default();
880 let res
= unsafe { fs::fs_ioc_fsgetxattr(fd, &mut fsxattr) }
;
882 // On some FUSE filesystems it can happen that ioctl is not supported.
883 // For these cases projid is set to 0 while the error is ignored.
884 if let Err(err
) = res
{
887 .ok_or_else(|| format_err
!("error while reading quota project id"))?
;
888 if errno_is_unsupported(errno
) {
891 bail
!("error while reading quota project id ({})", errno
);
895 let projid
= fsxattr
.fsx_projid
as u64;
897 metadata
.quota_project_id
= Some(pxar
::format
::QuotaProjectId { projid }
);
902 fn get_acl(metadata
: &mut Metadata
, proc_path
: &Path
, flags
: Flags
) -> Result
<(), Error
> {
903 if flags
.contains(Flags
::WITH_ACL
) {
907 if metadata
.is_symlink() {
911 get_acl_do(metadata
, proc_path
, acl
::ACL_TYPE_ACCESS
)?
;
913 if metadata
.is_dir() {
914 get_acl_do(metadata
, proc_path
, acl
::ACL_TYPE_DEFAULT
)?
;
921 metadata
: &mut Metadata
,
923 acl_type
: acl
::ACLType
,
924 ) -> Result
<(), Error
> {
925 // In order to be able to get ACLs with type ACL_TYPE_DEFAULT, we have
926 // to create a path for acl_get_file(). acl_get_fd() only allows to get
927 // ACL_TYPE_ACCESS attributes.
928 let acl
= match acl
::ACL
::get_file(&proc_path
, acl_type
) {
930 // Don't bail if underlying endpoint does not support acls
931 Err(Errno
::EOPNOTSUPP
) => return Ok(()),
932 // Don't bail if the endpoint cannot carry acls
933 Err(Errno
::EBADF
) => return Ok(()),
934 // Don't bail if there is no data
935 Err(Errno
::ENODATA
) => return Ok(()),
936 Err(err
) => bail
!("error while reading ACL - {}", err
),
939 process_acl(metadata
, acl
, acl_type
)
943 metadata
: &mut Metadata
,
945 acl_type
: acl
::ACLType
,
946 ) -> Result
<(), Error
> {
947 use pxar
::format
::acl
as pxar_acl
;
948 use pxar
::format
::acl
::{Group, GroupObject, Permissions, User}
;
950 let mut acl_user
= Vec
::new();
951 let mut acl_group
= Vec
::new();
952 let mut acl_group_obj
= None
;
953 let mut acl_default
= None
;
954 let mut user_obj_permissions
= None
;
955 let mut group_obj_permissions
= None
;
956 let mut other_permissions
= None
;
957 let mut mask_permissions
= None
;
959 for entry
in &mut acl
.entries() {
960 let tag
= entry
.get_tag_type()?
;
961 let permissions
= entry
.get_permissions()?
;
963 acl
::ACL_USER_OBJ
=> user_obj_permissions
= Some(Permissions(permissions
)),
964 acl
::ACL_GROUP_OBJ
=> group_obj_permissions
= Some(Permissions(permissions
)),
965 acl
::ACL_OTHER
=> other_permissions
= Some(Permissions(permissions
)),
966 acl
::ACL_MASK
=> mask_permissions
= Some(Permissions(permissions
)),
969 uid
: entry
.get_qualifier()?
,
970 permissions
: Permissions(permissions
),
974 acl_group
.push(Group
{
975 gid
: entry
.get_qualifier()?
,
976 permissions
: Permissions(permissions
),
979 _
=> bail
!("Unexpected ACL tag encountered!"),
987 acl
::ACL_TYPE_ACCESS
=> {
988 // The mask permissions are mapped to the stat group permissions
989 // in case that the ACL group permissions were set.
990 // Only in that case we need to store the group permissions,
991 // in the other cases they are identical to the stat group permissions.
992 if let (Some(gop
), true) = (group_obj_permissions
, mask_permissions
.is_some()) {
993 acl_group_obj
= Some(GroupObject { permissions: gop }
);
996 metadata
.acl
.users
= acl_user
;
997 metadata
.acl
.groups
= acl_group
;
999 acl
::ACL_TYPE_DEFAULT
=> {
1000 if user_obj_permissions
!= None
1001 || group_obj_permissions
!= None
1002 || other_permissions
!= None
1003 || mask_permissions
!= None
1005 acl_default
= Some(pxar_acl
::Default
{
1006 // The value is set to UINT64_MAX as placeholder if one
1007 // of the permissions is not set
1008 user_obj_permissions
: user_obj_permissions
.unwrap_or(Permissions
::NO_MASK
),
1009 group_obj_permissions
: group_obj_permissions
.unwrap_or(Permissions
::NO_MASK
),
1010 other_permissions
: other_permissions
.unwrap_or(Permissions
::NO_MASK
),
1011 mask_permissions
: mask_permissions
.unwrap_or(Permissions
::NO_MASK
),
1015 metadata
.acl
.default_users
= acl_user
;
1016 metadata
.acl
.default_groups
= acl_group
;
1018 _
=> bail
!("Unexpected ACL type encountered"),
1021 metadata
.acl
.group_obj
= acl_group_obj
;
1022 metadata
.acl
.default = acl_default
;
1027 /// Note that our pattern lists are "positive". `MatchType::Include` means the file is included.
1028 /// Since we are generating an *exclude* list, we need to invert this, so includes get a `'!'`
1030 fn generate_pxar_excludes_cli(patterns
: &[MatchEntry
]) -> Vec
<u8> {
1031 use pathpatterns
::MatchPattern
;
1033 let mut content
= Vec
::new();
1035 for pattern
in patterns
{
1036 match pattern
.match_type() {
1037 MatchType
::Include
=> content
.push(b'
!'
),
1038 MatchType
::Exclude
=> (),
1041 match pattern
.pattern() {
1042 MatchPattern
::Literal(lit
) => content
.extend(lit
),
1043 MatchPattern
::Pattern(pat
) => content
.extend(pat
.pattern().to_bytes()),
1046 if pattern
.match_flags() == MatchFlag
::MATCH_DIRECTORIES
&& content
.last() != Some(&b'
/'
) {
1050 content
.push(b'
\n'
);