Source code for reemote.operations.filesystem.chown

# Copyright (c) 2025 Kim Jarvis TPF Software Services S.A. kim.jarvis@tpfsystems.com 
# This software is licensed under the MIT License. See the LICENSE file for details.
#
import asyncssh
from jinja2.filters import sync_do_reject

from reemote.command import Command
from reemote.result import Result




class Chown:
    """
    A class to implement chown operations on a directory in Unix-like operating systems.

    This class provides functionality to change the ownership of files or directories
    on remote systems. It handles both regular Unix systems and Alpine Linux specially.

    Attributes:
        path (str): The file or directory path to change ownership.
        owner (str): The new owner of the file or directory.
        group (str): The new group of the file or directory.
        sudo (bool): If `True`, the commands will be executed with sudo privileges.
        su (bool): If `True`, the commands will be executed with su privileges.

    **Examples:**

    .. code:: python

        # Change ownership of a directory
        r = yield Chown("/var/www", "www-data", "www-data", sudo=True)
        # The ownership change is applied on all hosts

    Usage:
        This class is designed to be used in a generator-based workflow where commands are yielded for execution.

    Notes:
        - Uses a temporary shell script approach to execute the chown command.
        - Handles Alpine Linux differently by using `sh -c` instead of `bash`.
        - Automatically cleans up the temporary script after execution.
        - Requires sftp capabilities for file operations.
    """

    def __init__(self,
                 path: str,
                 owner: str,
                 group: str,
                 sudo: bool = False,
                 su: bool = False,
                 ):
        self.path = path
        self.owner = owner
        self.group = group
        self.sudo = sudo
        self.su = su

    def __repr__(self):
        return (
            f"Chown(path={self.path!r}, "
            f"owner={self.owner!r}, "
            f"group={self.group!r}, "
            f"sudo={self.sudo!r}, "
            f"su={self.su!r}, "
            ")"
        )


    def execute(self):
        from reemote.operations.server.shell import Shell
        from reemote.operations.sftp.write_file import Write_file
        from reemote.operations.sftp.chmod import Chmod
        from reemote.operations.sftp.remove import Remove
        from reemote.facts.server.get_os import Get_OS

        r = yield Get_OS()
        os = r.cp.stdout
        yield Remove(
            path='/tmp/set_owner.sh',
        )
        yield Write_file(path='/tmp/set_owner.sh', text=f'chown {self.owner}:{self.group} {self.path}')
        yield Chmod(
            path='/tmp/set_owner.sh',
            mode=0o755,
        )
        if "Alpine" not in os:
            yield Shell("bash /tmp/set_owner.sh", sudo=self.sudo, su=self.su)
        else:
            yield Shell("sh -c '/tmp/set_owner.sh'", sudo=self.sudo, su=self.su)
        yield Remove(
            path='/tmp/set_owner.sh',
        )