Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2025-10-23 11:01
algorithms	[ DIR ]	drwxr-xr-x	2025-10-23 11:01
crypto	[ DIR ]	drwxr-xr-x	2025-10-23 11:01
helpers	[ DIR ]	drwxr-xr-x	2025-10-23 11:01
platform	[ DIR ]	drwxr-xr-x	2025-10-23 11:01
testsuite	[ DIR ]	drwxr-xr-x	2025-10-23 11:01
__init__.py	859 B	-rw-r--r--	2025-10-13 20:00
__main__.py	611 B	-rw-r--r--	2025-10-13 20:00
_version.py	32 B	-rw-r--r--	2025-10-13 20:00
archive.py	108.75 KB	-rw-r--r--	2025-10-13 20:00
archiver.py	295.71 KB	-rw-r--r--	2025-10-13 20:00
cache.py	56.11 KB	-rw-r--r--	2025-10-13 20:00
chunker.cpython-39-x86_64-linux-gnu.so	162.98 KB	-rwxr-xr-x	2025-10-13 20:00
compress.cpython-39-x86_64-linux-gnu.so	233.66 KB	-rwxr-xr-x	2025-10-13 20:00
constants.py	5.09 KB	-rw-r--r--	2025-10-13 20:00
fuse.py	32.59 KB	-rw-r--r--	2025-10-13 20:00
fuse_impl.py	866 B	-rw-r--r--	2025-10-13 20:00
hashindex.cpython-39-x86_64-linux-gnu.so	129.56 KB	-rwxr-xr-x	2025-10-13 20:00
item.cpython-39-x86_64-linux-gnu.so	322.43 KB	-rwxr-xr-x	2025-10-13 20:00
locking.py	16.05 KB	-rw-r--r--	2025-10-13 20:00
logger.py	8.91 KB	-rw-r--r--	2025-10-13 20:00
lrucache.py	1.71 KB	-rw-r--r--	2025-10-13 20:00
nanorst.py	6.81 KB	-rw-r--r--	2025-10-13 20:00
paperkey.html	64.48 KB	-rw-r--r--	2025-10-13 20:00
patterns.py	13.51 KB	-rw-r--r--	2025-10-13 20:00
platformflags.py	312 B	-rw-r--r--	2025-10-13 20:00
remote.py	55.39 KB	-rw-r--r--	2025-10-13 20:00
repository.py	80.89 KB	-rw-r--r--	2025-10-13 20:00
selftest.py	3.56 KB	-rw-r--r--	2025-10-13 20:00
shellpattern.py	2.25 KB	-rw-r--r--	2025-10-13 20:00
upgrader.py	13.24 KB	-rw-r--r--	2025-10-13 20:00
version.py	1.78 KB	-rw-r--r--	2025-10-13 20:00
xattr.py	5.85 KB	-rw-r--r--	2025-10-13 20:00

Rename

"""A basic extended attributes (xattr) implementation for Linux, FreeBSD and macOS."""

import errno
import os
import re
import subprocess
import sys
import tempfile

from packaging.version import parse as parse_version

from .helpers import prepare_subprocess_env

from .logger import create_logger

logger = create_logger()

from .platform import listxattr, getxattr, setxattr, ENOATTR

# If we are running with fakeroot on Linux, then use the xattr functions of fakeroot. This is needed by
# the 'test_extract_capabilities' test, but also allows xattrs to work with fakeroot on Linux in normal use.
# TODO: Check whether fakeroot supports xattrs on all platforms supported below.
# TODO: If that's the case then we can make Borg fakeroot-xattr-compatible on these as well.
XATTR_FAKEROOT = False
if sys.platform.startswith('linux'):
    LD_PRELOAD = os.environ.get('LD_PRELOAD', '')
    preloads = re.split("[ :]", LD_PRELOAD)
    for preload in preloads:
        if preload.startswith("libfakeroot"):
            env = prepare_subprocess_env(system=True)
            fakeroot_output = subprocess.check_output(['fakeroot', '-v'], env=env)
            fakeroot_version = parse_version(fakeroot_output.decode('ascii').split()[-1])
            if fakeroot_version >= parse_version("1.20.2"):
                # 1.20.2 has been confirmed to have xattr support
                # 1.18.2 has been confirmed not to have xattr support
                # Versions in-between are unknown
                XATTR_FAKEROOT = True
            break

def is_enabled(path=None):
    """Determine if xattr is enabled on the filesystem
    """
    with tempfile.NamedTemporaryFile(dir=path, prefix='borg-tmp') as f:
        fd = f.fileno()
        name, value = b'user.name', b'value'
        try:
            setxattr(fd, name, value)
        except OSError:
            return False
        try:
            names = listxattr(fd)
        except OSError:
            return False
        if name not in names:
            return False
        return getxattr(fd, name) == value

def get_all(path, follow_symlinks=False):
    """
    Return all extended attributes on *path* as a mapping.

The returned mapping maps xattr names (bytes) to values (bytes or None).
    None indicates, as a xattr value, an empty value, i.e. a value of length zero.
    """
    if isinstance(path, str):
        path = os.fsencode(path)
    result = {}
    try:
        names = listxattr(path, follow_symlinks=follow_symlinks)
        for name in names:
            try:
                # xattr name is a bytes object, we directly use it.
                # if we get an empty xattr value (b''), we store None into the result dict -
                # borg always did it like that...
                result[name] = getxattr(path, name, follow_symlinks=follow_symlinks) or None
            except OSError as e:
                # note: platform.xattr._check has already made a nice exception e with errno, msg, path/fd
                if e.errno in (ENOATTR, ):  # errors we just ignore silently
                    # ENOATTR: a race has happened: xattr names were deleted after list.
                    pass
                else:  # all others: warn, skip this single xattr name, continue processing other xattrs
                    # EPERM: we were not permitted to read this attribute
                    # EINVAL: maybe xattr name is invalid or other issue, #6988
                    logger.warning('when getting extended attribute %s: %s', name.decode(errors='replace'), str(e))
    except OSError as e:
        if e.errno in (errno.ENOTSUP, errno.EPERM):
            # if xattrs are not supported on the filesystem, we give up.
            # EPERM might be raised by listxattr.
            pass
        else:
            raise
    return result

def set_all(path, xattrs, follow_symlinks=False):
    """
    Set all extended attributes on *path* from a mapping.

*path* can either be a path (str or bytes) or an open file descriptor (int).
    *follow_symlinks* indicates whether symlinks should be followed
    and only applies when *path* is not an open file descriptor.
    *xattrs* is mapping maps xattr names (bytes) to values (bytes or None).
    None indicates, as a xattr value, an empty value, i.e. a value of length zero.

Return warning status (True means a non-fatal exception has happened and was dealt with).
    """
    if isinstance(path, str):
        path = os.fsencode(path)
    warning = False
    for k, v in xattrs.items():
        try:
            # the key k is a bytes object due to msgpack unpacking it as such.
            # if we have a None value, it means "empty", so give b'' to setxattr in that case:
            setxattr(path, k, v or b'', follow_symlinks=follow_symlinks)
        except OSError as e:
            # note: platform.xattr._check has already made a nice exception e with errno, msg, path/fd
            warning = True
            if e.errno == errno.E2BIG:
                err_str = 'too big for this filesystem (%s)' % str(e)
            elif e.errno == errno.ENOSPC:
                # ext4 reports ENOSPC when trying to set an xattr with >4kiB while ext4 can only support 4kiB xattrs
                # (in this case, this is NOT a "disk full" error, just a ext4 limitation).
                err_str = 'fs full or xattr too big? [xattr len = %d] (%s)' % (len(v), str(e))
            else:
                # generic handler
                # EACCES: permission denied to set this specific xattr (this may happen related to security.* keys)
                # EPERM: operation not permitted
                err_str = str(e)
            logger.warning('when setting extended attribute %s: %s', k.decode(errors='replace'), err_str)
    return warning