File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/win_file.cpython-310.pyc
Back
o ;j7 � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZ ddl Z ddl Z ddl Z ddl mZmZ ddlmZmZmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;m<Z<m=Z=m>Z> ddlm?Z@ ddlmAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZImJZJmKZKmLZLmMZMmNZNmOZOmPZPmQZQmRZRmSZSmTZT ddlUmVZV dZWz"e jXjY�Z� r�ddl[Z[ddl\Z\ddl]Z]ddl^Z^ddl_Z_ddl`Z d ZWW n eay� dZWY nw dZbze jXjY�Z� �rddlcZ d ZbW n ea�y dZbY nw e jXjY�Z� �r�eW�r�eVeJed� �ZJeVeMed� �ZMeVeed� �ZeVeed� �ZeVe ed� �Z eVeed� �ZeVeed� �ZeVe;ed� �Z;eVeKed� �ZKeVe.ed� �Z.eVe1ed� �Z1eVe ed� �Z eVe6ed� �Z6eVe&ed� �Z&eVe'ed� �Z'eVe$ed� �Z$eVe>ed� �Z>eVePed� �ZPeVe2ed� �Z2eVeed� �ZeVe/ed� �Z/eVeQed� �ZQeVe*ed� �Z*eVe,ed� �Z,eVe+ed� �Z+eVe7ed� �Z7eVe3ed� �Z3eVeEed� �ZEeVe8ed� �Z8eVe%ed� �Z%eVe5ed� �Z5eVe4ed� �Z4eVe:ed� �Z:eVe ed� �Z eVe-ed� �Z-eVeGed� �ZGeVeHed� �ZHeVeFed� �ZFeVeLed� �ZLeVeRed� �ZReVe#ed� �Z#eVeDed� �ZDeVeNed� �ZNeVeOed� �ZOeVeIed� �ZIeVe=ed� �Z=eVeCed� �ZCeVeTed� �ZTeVeAed� �ZAeVe9ed� �Z9eVe(ed� �Z(eVeSed� �ZSeVe)ed� �Z)eVeed� �ZeVeed� �ZeVe ed� �Z eVe ed� �Z eVeed� �ZeVeed� �ZeVeed� �ZeVe!ed� �Z!eVe0ed� �Z0eVe"ed� �Z"eVe<ed� �Z<eVe@ed� �Z@eVeed� �ZeVeBed� �ZBe�eef�Zgd Zhd d � Zid d d�Zjddd�ZkdVdd�Zldd� Zmdd� ZndWdd�ZodWdd �ZpdWd d �ZqdWd d �Zrd!d"� Zsd#d$� ZtdWd%d&�ZudWd'd(�Zvd)d*� ZwdXd+d,�ZxdYd-d.�Zyd/d0� Zzd1d2� Z{dZd4d5�Z|d6d7� Z}d8d9� Z~d[d:d;�Zd<d=� Z�d>d?� Z�d@dA� Z� d\dBdC�Z�dDdE� Z�d]dFdG�Z�d^dHdI�Z�dJdK� Z� d_dLdM�Z� d_dNdO�Z� d`dPdQ�Z� dadRdS�Z�dbdTdU�Z�dS )cz� Manage information about files on the minion, set/read user, group data, modify the ACL of files/directories :depends: - win32api - win32file - win32con - salt.utils.win_dacl � N)�CommandExecutionError�SaltInvocationError).� __clean_tmp� _add_flags�_assert_occurrence�_binary_replace�_error� _get_bkroot�_get_eol� _get_flags� _mkstemp_copy�_regex_to_static� _set_line� _set_line_eol�_set_line_indent�'_splitlines_preserving_trailing_newline�access�append�apply_template_on_contents�basename� blockreplace�check_file_meta� check_hash� check_managed�check_managed_changes�comment� comment_line�contains� contains_glob�contains_regex�copy� delete_backup�directory_exists�dirname� extract_hash� file_exists�find�get_diff�get_hash� get_managed�get_source_sum�get_sum�join�line� list_backups�list_backups_dir�lstat� manage_file)�normpath)�pardir�patch�path_exists_glob�prepend�psed�read�readdir�readlink�rename�replace�restore_backup�rmdir�search� seek_read� seek_write� source_list�touch�truncate� uncomment�write)�namespaced_functionFT�filec C s t jj�� rts dS tsdS tS )z' Only works on Windows systems )Fz&Module win_file: Missing Win32 modules)Fz3Module win_file: Unable to load salt.utils.win_dacl)�salt�utils�platform� is_windows�HAS_WINDOWS_MODULES� HAS_WIN_DACL�__virtualname__� rP rP �I/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/win_file.py� __virtual__� s rR �txt)rC r �makedirsr2 )� makedirs_� normpath_�@ c C sn t �� jdk r td��| h}d}t| �r5t| �} | |v r td��|�| � |d7 }||kr1td��t| �s| S )z� Resolves the given symlink path to its real path, up to a maximum of the `max_depth` parameter which defaults to 64. If the path is not a symlink path, it is simply returned. � �6Symlinks are only supported on Windows Vista or later.r z-The given path is involved in a symlink loop.� z"Too many levels of symbolic links.)�sys�getwindowsversion�majorr �is_linkr: r �add)�pathZ max_depthZ paths_seenZ cur_depthrP rP rQ �_resolve_symlink� s � � ra c C s t � d�}t�d|� t| �S )a� Convert the group id to the group name on this system Under Windows, because groups are just another ACL entity, this function behaves the same as uid_to_user. For maintaining Windows systems, this function is superfluous and only exists for API compatibility with Unix. Use the uid_to_user function instead; an info level log entry will be generated if this function is used directly. Args: gid (str): The gid of the group Returns: str: The name of the group CLI Example: .. code-block:: bash salt '*' file.gid_to_group 'S-1-5-21-626487655-2533044672-482107328-1010' z .gid_to_group�UThe function %s should not be used on Windows systems; see function docs for details.)rO �log�info� uid_to_user)�gid� func_namerP rP rQ � gid_to_group� s �rh c C s0 t � d�}t�d|� | du rdS tjj�| �S )a� Convert the group to the gid on this system Under Windows, because groups are just another ACL entity, this function behaves the same as user_to_uid, except if None is given, '' is returned. For maintaining Windows systems, this function is superfluous and only exists for API compatibility with Unix. Use the user_to_uid function instead; an info level log entry will be generated if this function is used directly. Args: group (str): The name of the group Returns: str: The gid of the group CLI Example: .. code-block:: bash salt '*' file.group_to_gid 'administrators' z .group_to_gidrb N� )rO rc rd rI rJ �win_dacl�get_sid_string)�grouprg rP rP rQ � group_to_gid s �rm c C �P t j�| �s td| � ���|rt�� jdkrt| �} tj j � | �}tj j � |�S )aN Return the id of the primary group that owns a given file (Windows only) This function will return the rarely used primary group of a file. This generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services). Ensure you know what you are doing before using this function. Args: path (str): The path to the file or directory follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: str: The gid of the primary group CLI Example: .. code-block:: bash salt '*' file.get_pgid 'c:\temp\test.txt' �Path not found: rX ) �osr` �existsr r[ r\ r] ra rI rJ rj Zget_primary_grouprk )r` �follow_symlinksZ group_namerP rP rQ �get_pgidB s rs c C s t t| |��S )a� Return the name of the primary group that owns a given file (Windows only) This function will return the rarely used primary group of a file. This generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services). Ensure you know what you are doing before using this function. The return value may be 'None', e.g. if the user is not on a domain. This is a valid group - do not confuse this with the Salt/Python value of None which means no value was returned. To be certain, use the `get_pgid` function which will return the SID, including for the system 'None' group. Args: path (str): The path to the file or directory follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: str: The name of the primary group CLI Example: .. code-block:: bash salt '*' file.get_pgroup 'c:\temp\test.txt' )re rs �r` rr rP rP rQ � get_pgroupn s "ru c C � t � d�}t�d|� t| |�S )a� Return the id of the group that owns a given file Under Windows, this will return the uid of the file. While a file in Windows does have a 'primary group', this rarely used attribute generally has no bearing on permissions unless intentionally configured and is only used to support Unix compatibility features (e.g. Services For Unix, NFS services). Salt, therefore, remaps this function to provide functionality that somewhat resembles Unix behavior for API compatibility reasons. When managing Windows systems, this function is superfluous and will generate an info level log entry if used directly. If you do actually want to access the 'primary group' of a file, use `file.get_pgid`. Args: path (str): The path to the file or directory follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: str: The gid of the owner CLI Example: .. code-block:: bash salt '*' file.get_gid 'c:\temp\test.txt' z.get_gidztThe function %s should not be used on Windows systems; see function docs for details. The value returned is the uid.)rO rc rd �get_uid�r` rr rg rP rP rQ �get_gid� � %� ry c C rv )a� Return the group that owns a given file Under Windows, this will return the user (owner) of the file. While a file in Windows does have a 'primary group', this rarely used attribute generally has no bearing on permissions unless intentionally configured and is only used to support Unix compatibility features (e.g. Services For Unix, NFS services). Salt, therefore, remaps this function to provide functionality that somewhat resembles Unix behavior for API compatibility reasons. When managing Windows systems, this function is superfluous and will generate an info level log entry if used directly. If you do actually want to access the 'primary group' of a file, use `file.get_pgroup`. Args: path (str): The path to the file or directory follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: str: The name of the owner CLI Example: .. code-block:: bash salt '*' file.get_group 'c:\temp\test.txt' z .get_groupz}The function %s should not be used on Windows systems; see function docs for details. The value returned is the user (owner).)rO rc rd �get_userrx rP rP rQ � get_group� rz r| c C s" | du s| dkr dS t jj�| �S )ac Convert a User ID (uid) to a username Args: uid (str): The user id to lookup Returns: str: The name of the user. The ``uid`` will be returned if there is no corresponding username CLI Example: .. code-block:: bash salt '*' file.uid_to_user 'S-1-5-21-626487655-2533044672-482107328-1010' Nri )rI rJ rj �get_name)�uidrP rP rQ re � s re c C s" | du r t jj�� } t jj�| �S )z� Convert user name to a uid Args: user (str): The user to lookup Returns: str: The user id of the user CLI Example: .. code-block:: bash salt '*' file.user_to_uid 'myusername' N)rI rJ �userr{ rj rk )r rP rP rQ � user_to_uid s r� c C rn )a� Return the id of the user that owns a given file Symlinks are followed by default to mimic Unix behavior. Specify `follow_symlinks=False` to turn off this behavior. Args: path (str): The path to the file or directory follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: str: The uid of the owner CLI Example: .. code-block:: bash salt '*' file.get_uid 'c:\temp\test.txt' salt '*' file.get_uid 'c:\temp\test.txt' follow_symlinks=False ro rX ) rp r` rq r r[ r\ r] ra rI rJ rj � get_ownerrk )r` rr Z owner_sidrP rP rQ rw s rw c C sB t j�| �s td| � ���|rt�� jdkrt| �} tj j � | �S )a� Return the user that owns a given file Symlinks are followed by default to mimic Unix behavior. Specify `follow_symlinks=False` to turn off this behavior. Args: path (str): The path to the file or directory follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: str: The name of the owner CLI Example: .. code-block:: bash salt '*' file.get_user 'c:\temp\test.txt' salt '*' file.get_user 'c:\temp\test.txt' follow_symlinks=False ro rX ) rp r` rq r r[ r\ r] ra rI rJ rj r� rt rP rP rQ r{ I s r{ c C s4 t j�| �s td| � ���t� d�}t�d|� dS )a5 Return the mode of a file Right now we're just returning None because Windows' doesn't have a mode like Linux Args: path (str): The path to the file or directory Returns: None CLI Example: .. code-block:: bash salt '*' file.get_mode /etc/passwd ro z .get_modezxThe function %s should not be used on Windows systems; see function docs for details. The value returned is always None.N)rp r` rq r rO rc rd )r` rg rP rP rQ �get_modeq s �r� c C s> |rt � d�}t�d|� t�d|| � d}t| |||dd�S )a� Chown a file, pass the file the desired user and group without following any symlinks. Under Windows, the group parameter will be ignored. This is because while files in Windows do have a 'primary group' property, this is rarely used. It generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services). If you do want to change the 'primary group' property and understand the implications, pass the Windows only parameter, pgroup, instead. To set the primary group to 'None', it must be specified in quotes. Otherwise, Salt will interpret it as the Python value of None and no primary group changes will occur. See the example below. Args: path (str): The path to the file or directory user (str): The name of the user to own the file group (:obj:`str`, optional): The group (not used). Default is ``None``. pgroup (:obj:`str`, optional): The primary group to assign. Default is ``None``. Returns: bool: True if successful, otherwise error CLI Example: .. code-block:: bash salt '*' file.lchown 'c:\temp\test.txt' myusername salt '*' file.lchown 'c:\temp\test.txt' myusername pgroup=Administrators salt '*' file.lchown 'c:\temp\test.txt' myusername "pgroup='None'" z.lchown�bThe group parameter has no effect when using %s on Windows systems; see function docs for details.�2win_file.py %s Ignoring the group parameter for %sNF�rr )rO rc rd �debug�chown)r` r rl �pgrouprg rP rP rQ �lchown� s , �r� c C s� |durt � d�}t�d|� t�d|| � |r#t�� jdkr#t| �} tj � | �s0t d| � ���t j j�| |� |rBt j j�| |� dS )a� Chown a file, pass the file the desired user and group Under Windows, the group parameter will be ignored. This is because while files in Windows do have a 'primary group' property, this is rarely used. It generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services). If you do want to change the 'primary group' property and understand the implications, pass the Windows only parameter, pgroup, instead. Args: path (str): The path to the file or directory user (str): The name of the user to own the file group (:obj:`str`, optional): The group (not used). Default is ``None``. pgroup (:obj:`str`, optional): The primary group to assign. Default is ``None``. follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: bool: ``True`` if successful Raises: CommandExecutionError: Path not found CommandExecutionError: Failed to change ownership CLI Example: .. code-block:: bash salt '*' file.chown 'c:\temp\test.txt' 'myusername' salt '*' file.chown 'c:\temp\test.txt' 'myusername' pgroup=Administrators salt '*' file.chown 'c:\temp\test.txt' 'myusername' pgroup=None Nz.chownr� r� rX ro T)rO rc rd r� r[ r\ r] ra rp r` rq r rI rJ rj � set_owner�set_primary_group)r` r rl r� rr rg rP rP rQ r� � s 0 � r� c C s t jj�| |�S )a� Change the group of a file Under Windows, this will set the rarely used primary group of a file. This generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services). Ensure you know what you are doing before using this function. Args: path (str): The path to the file or directory pgroup (str): The primary group to assign Returns: bool: ``True`` if successful Raises: CommandExecutionError: Failed to change group CLI Example: .. code-block:: bash salt '*' file.chpgrp 'c:\temp\test.txt' Administrators salt '*' file.chpgrp 'c:\temp\test.txt' None )rI rJ rj r� )r` rl rP rP rQ �chpgrp s r� c C s( t � d�}t�d|� t�d|| � dS )a� Change the group of a file Under Windows, this will do nothing. While a file in Windows does have a 'primary group', this rarely used attribute generally has no bearing on permissions unless intentionally configured and is only used to support Unix compatibility features (e.g. Services For Unix, NFS services). Salt, therefore, remaps this function to do nothing while still being compatible with Unix behavior. When managing Windows systems, this function is superfluous and will generate an info level log entry if used directly. If you do actually want to set the 'primary group' of a file, use ``file.chpgrp``. To set group permissions use ``file.set_perms``. Args: path (str): The path to the file or directory group (str): The group (unused) Returns: None CLI Example: .. code-block:: bash salt '*' file.chgrp 'c:\temp\test.txt' administrators z.chgrprb z#win_file.py %s Doing nothing for %sN)rO rc rd r� )r` rl rg rP rP rQ �chgrp2 s #�r� �sha256c C s� t j�| �s td| � ���|rt�� jdkrt| �} t �| �}i }|j |d< t | dd�|d< |d |d< t |d �|d< |d |d < t | |�|d < t |d �|d < |j|d < |j|d < |j|d< |j|d< tjj�tt�|j���|d< |r}t| |�|d< d|d< t�|j�r�d|d< t�|j�r�d|d< t� |j�r�d|d< t� |j�r�d|d< t� |j�r�d|d< t� |j�r�d|d< t� |j�r�d|d< t j�!| �|d< |S )a� Return a dict containing the stats about a given file Under Windows, `gid` will equal `uid` and `group` will equal `user`. While a file in Windows does have a 'primary group', this rarely used attribute generally has no bearing on permissions unless intentionally configured and is only used to support Unix compatibility features (e.g. Services For Unix, NFS services). Salt, therefore, remaps these properties to keep some kind of compatibility with Unix behavior. If the 'primary group' is required, it can be accessed in the `pgroup` and `pgid` properties. Args: path (str): The path to the file or directory hash_type (:obj:`str`, optional): The type of hash to return. Default is``sha256``. follow_symlinks (:obj:`bool`, optional): If the object specified by ``path`` is a symlink, get attributes of the linked file instead of the symlink itself. Default is ``True``. Returns: dict: A dictionary of file/directory stats CLI Example: .. code-block:: bash salt '*' file.stats /etc/passwd ro rX �inodeFr� r~ rf r rl Zpgidr� �atime�mtime�ctime�size�mode�sumrH �type�dir�char�block�link�pipe�socket�target)"rp r` rq r r[ r\ r] ra �stat�st_inorw re rs rh �st_atime�st_mtime�st_ctime�st_sizerI rJ �filesZnormalize_mode�oct�S_IMODE�st_moder+ �S_ISDIR�S_ISCHR�S_ISBLK�S_ISREG�S_ISLNK�S_ISFIFO�S_ISSOCK�realpath)r` Z hash_typerr Zpstat�retrP rP rQ �stats` sJ ' r� c C sB g }ddddddddd �}|D ]}|| @ |kr |� || � q|S ) z� Helper function to parse the OS data Args: flags: The flags as returned by the GetFileVersionInfo function Returns: list: A list of Operating system properties found in the flag z16-bit Windowsz16-bit Presentation Managerz32-bit Presentation Managerz32-bit WindowszMS-DOSz 16-bit OS/2z 32-bit OS/2z Windows NT)rZ � � � i i i i )r )�flagsZfile_osZ file_os_flags�itemrP rP rQ �_get_version_os� s � �r� c C s� d }ddddddd�}dd d d d d dddddd� }dddd�}| |v r'|| }|dkr6||v r6|| � d�}|dkrE||v rE|| � d�}|dkrNd|� �}|S )NZ ApplicationZDLLZDriverZFontzVirtual DevicezStatic Link Library)rZ r� r� r� � � ZPrinterZKeyboardZLanguageZDisplayZMouseZNetwork�SystemZ InstallableZSoundZCommunicationszVersioned Printer) rZ r� r� r� r� rX r� � � � � ZRasterZVectorZTrueType)rZ r� r� z Driverz FontzVirtual Device: rP )Z file_typeZ file_subtypeZret_typeZ file_typesZdriver_subtypesZ font_subtypesrP rP rQ �_get_version_type� sF � �� r� c C sp |s zt �| d�}W n tjy t�d| � Y dS w d�t �|d �t �|d �t �|d �t �|d ��S )a` Get the version of the file passed in path or the fixed_info object if passed. Args: path (str): The path to the file fixed_info (:obj:`obj`, optional): The fixed info object returned by the GetFileVersionInfo function. Default is ``None``. Returns: str: The version of the file �\�No version info found: %sri z {}.{}.{}.{}Z FileVersionMSZ FileVersionLS) �win32api�GetFileVersionInfo� pywintypes�errorrc r� �formatZHIWORDZLOWORD)r` � fixed_inforP rP rQ � _get_version� s � �r� c C s< t j�| �s td| � ���t j�| �rtd| � ���t| �S )a� .. versionadded:: 3005 Get the version of a file. .. note:: Not all files have version information. The following are common file types that contain version information: - .exe - .dll - .sys Args: path (str): The path to the file. Returns: str: The version of the file if the file contains it. Otherwise, an empty string will be returned. Raises: CommandExecutionError: If the file does not exist CommandExecutionError: If the path is not a file CLI Example: .. code-block:: bash salt '*' file.version 'C:\Windows\notepad.exe' �File not found: � Not a file: )rp r` rq r �isdirr� )r` rP rP rQ �version s ! r� c C s( t j�| �s td| � ���t j�| �rtd| � ���i }zt�| d�}W n tjy6 t � d| � | Y S w t | |�|d< t |d �|d< t |d |d �|d< z t�| d �d \}}W n tjyo t � d | � | Y S w d }|D ] }d�|||�}z t�| |�||< W qt tjy� Y qtw |S )a .. versionadded:: 3005 Get file details for a file. Similar to what's in the details tab on the file properties. .. note:: Not all files have version information. The following are common file types that contain version information: - .exe - .dll - .sys Args: path (str): The path to the file. Returns: dict: A dictionary containing details about the file related to version. An empty dictionary if the file contains no version information. Raises: CommandExecutionError: If the file does not exist CommandExecutionError: If the path is not a file CLI Example: .. code-block:: bash salt '*' file.version_details 'C:\Windows\notepad.exe' r� r� r� r� �VersionZFileOSZOperatingSystem�FileTypeZ FileSubtypez\VarFileInfo\Translationr z"No extended version info found: %s) ZCommentsZ CompanyNameZFileDescriptionZ FileVersionZ InternalNameZLegalCopyrightZLegalTrademarksZOriginalFilenameZ PrivateBuildZ ProductName�ProductVersionZ SpecialBuildz \StringFileInfo\{:04X}{:04X}\{})rp r` rq r r� r� r� r� r� rc r� r� r� r� r� )r` r� r� �languageZcodepageZproperty_namesZ prop_nameZ str_info_pathrP rP rQ �version_detailsC sJ ! � �� � ���r� c C sl t j�| �s td| � ���i }t�| �}|d@ dk|d< |d@ dk|d< |d@ dk|d< |d@ dk|d < |d @ d k|d < |d @ d k|d < |d@ dk|d< |d@ dk|d< |d@ dk|d< |d@ dk|d< |d@ dk|d< |d@ dk|d< d|d< |d d u r�|d d u r�t�| �}t|�}|d d kr�d |d< d|d < |d d u r�t�| �}t|�}|d d kr�d |d < |S )!a1 Return a dictionary object with the Windows file attributes for a file. Args: path (str): The path to the file or directory Returns: dict: A dictionary of file attributes CLI Example: .. code-block:: bash salt '*' file.get_attributes 'c:\temp\a.txt' ro � �archivei Z reparsePointi � compressed� � directoryi @ Z encryptedr� �hidden� �normal� � notIndexedi ZofflinerZ �readonlyr� �system� � temporaryFZ mountedVolumeTrX l @ Z symbolicLinkl @ )rp r` rq r � win32file�GetFileAttributesZFindFilesIterator�next)r` Z attributes� intAttributesZ fileIteratorZ findDataTuplerP rP rQ �get_attributes� s: r� c C s4 t j�| �s td| � ���|r-|s|s|s|s|s|r td��t�| d�}|du r+dS dS t�| �} |durA|r=| dO } n| dM } |durP|rL| d O } n| d M } |dur_|r[| d O } n| d M } |durn|rj| d O } n| dM } |dur}|ry| dO } n| dM } |dur�|r�| dO } n| dM } t�| | �}|du r�dS dS )aF Set file attributes for a file. Note that the normal attribute means that all others are false. So setting it will clear all others. Args: path (str): The path to the file or directory archive (:obj:`bool`, optional): Sets the archive attribute. Default is ``None``. hidden (:obj:`bool`, optional): Sets the hidden attribute. Default is ``None``. normal (:obj:`bool`, optional): Resets the file attributes. Cannot be used in conjunction with any other attribute. Default is ``None``. notIndexed (:obj:`bool`, optional): Sets the indexed attribute. Default is ``None``. readonly (:obj:`bool`, optional): Sets the readonly attribute. Default is ``None``. system (:obj:`bool`, optional): Sets the system attribute. Default is ``None``. temporary (:obj:`bool`, optional): Sets the temporary attribute. Default is ``None``. Returns: bool: ``True`` if successful, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' file.set_attributes 'c:\temp\a.txt' normal=True salt '*' file.set_attributes 'c:\temp\a.txt' readonly=True hidden=True ro z:Normal attribute may not be used with any other attributesr� NTFr� i� r� i�� r� i�� rZ i�� r� i�� r� i�� )rp r` rq r r� �SetFileAttributesr� ) r` r� r� r� r� r� r� r� r� r� rP rP rQ �set_attributes� sH 9� r� c C s t � d�}t�d|� t| �S )a^ Set the mode of a file This just calls get_mode, which returns None because we don't use mode on Windows Args: path (str): The path to the file or directory mode (str): The mode (not used) Returns: None CLI Example: .. code-block:: bash salt '*' file.set_mode /etc/passwd 0644 z .set_modez�The function %s should not be used on Windows systems; see function docs for details. The value returned is always None. Use set_perms instead.)rO rc rd r� )r` r� rg rP rP rQ �set_modeK s �r� c C s& t j�| �} t j�| �std| � ���t j�| �s$t| �s$td| � ���|r2t� | �}t� | t j � zBt j� | �rAt �| � W dS t| �rMt �| � W dS t j�| �}t j�| �}t �| �D ]}| � d|� �}t||� q^t �| � W dS ty� } z|r�t� | |� td| � d|� ���d}~ww )a� Remove the named file or directory Args: path (str): The path to the file or directory to remove. force (:obj:`bool`, optional): Remove even if marked Read-Only. Default is ``False``. Returns: bool: ``True`` if successful, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' file.remove 'C:\Temp' z File path must be absolute: ro r� zCould not remove 'z': NT)rp r` � expanduser�isabsr rq r^ r r� r� r� �win32con�FILE_ATTRIBUTE_NORMAL�isfile�remover> r� �listdir�OSError)r` �forceZfile_attributes�is_dirrq �namer� �excrP rP rQ r� k s8 � � � ��r� c C sD t �� jdk r td��tj�|�std|� ���tj�|�rRz tj�t j j� |��tj�| �kr:t � d|| � W dS W n tyD Y nw |sR|sRd|� �}t|��tj�|�re|se|sed|� �}t|��tj�| �} tj�|�}tj�| �}tjtjB }t�t�� |�}t jj�|� tj�|�s�tj�|�r�|r�|s�t�|� nV|r�tj� |�}d} | d k r�t j |d �} z t � | | t!|�� W n t j"y� | d 7 } Y nw | d k s�zt �#| |t j$t j%B � W dS t j"y� t�&| � td |� d ���w z t � || t!|�� W dS t j"�y! } ztd |� d| j'� d| j(� ���d} ~ ww )a% Create a symbolic link to a file This is only supported with Windows Vista or later and must be executed by a user with the SeCreateSymbolicLink privilege. The behavior of this function matches the Unix equivalent, with one exception - invalid symlinks cannot be created. The source path must exist. If it doesn't, an error will be raised. Args: src (str): The path to a file or directory link (str): The path to the link. Must be an absolute path force (:obj:`bool`, optional): Overwrite an existing symlink with the same name. Default is ``False``. .. versionadded:: 3005 atomic (:obj:`bool`, optional): Use atomic file operations to create the symlink. Default is ``False``. .. versionadded:: 3006.0 Returns: bool: ``True`` if successful Raises: SaltInvocationError: Unsupported version of Windows SaltInvocationError: Link path must be absolute CommandExecutionError: Existing symlink and force is False CommandExecutionError: Existing path is not a symlink CommandExecutionError: Failed to create symlink CLI Example: .. code-block:: bash salt '*' file.symlink /path/to/file /path/to/link rX rY z Link path must be absolute: z'link already in correct state: %s -> %sTzFound existing symlink: z Existing path is not a symlink: r r� )r� rZ zCould not create '�'z' - [z] N))r[ r\ r] r rp r` r� �islinkr2 rI rJ r: rc r� r� r rq r� � win32securityZ TOKEN_QUERYZTOKEN_ADJUST_PRIVILEGESZOpenProcessTokenr� ZGetCurrentProcessrK �winZ elevate_token�unlinkr# �tempfileZmktempr� ZCreateSymbolicLink�intr� Z MoveFileExZMOVEFILE_REPLACE_EXISTINGZMOVEFILE_WRITE_THROUGHr� �winerror�strerror) �srcr� r� Zatomic�msgr� Zdesired_access�thZlink_dirZretryZ temp_linkr� rP rP rQ �symlink� s~ /� �� � �� � ����r c C sH t �� jdk r td��ztjj�| �W S ty# } zt |��d}~ww )a� Check if the path is a symlink This is only supported on Windows Vista or later. Inline with Unix behavior, this function will raise an error if the path is not a symlink, however, the error raised will be a SaltInvocationError, not an OSError. Args: path (str): The path to a file or directory Returns: bool: ``True`` if path is a symlink, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' file.is_link /path/to/link rX rY N) r[ r\ r] r rI rJ r` r� � Exceptionr )r` r� rP rP rQ r^ # s ���r^ c C s� t j�| �d }t j�|�std|� d���t j�| �} t j�| �} t j�| �sYz t �| � |r9tj j j | |d� tj j j | d||||d� W dS t yX } zt|��d}~ww dS ) a� Ensure that the directory is available and permissions are set. Args: path (str): The full path to the directory. owner (:obj:`str`, optional): The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM. Default is ``None``. grant_perms (:obj:`dict`, optional): A dictionary containing the user/group and the basic permissions to grant, ie: ``{'user': {'perms': 'basic_permission'}}``. You can also set the ``applies_to`` setting here. The default is ``this_folder_subfolders_files``. Specify another ``applies_to`` setting like this: .. code-block:: yaml {'user': {'perms': 'full_control', 'applies_to': 'this_folder'}} To set advanced permissions use a list for the ``perms`` parameter, ie: .. code-block:: yaml {'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}} Default is ``None``. deny_perms (:obj:`dict`, optional): A dictionary containing the user/group and permissions to deny along with the ``applies_to`` setting. Use the same format used for the ``grant_perms`` parameter. Remember, deny permissions supersede grant permissions. Default is ``None``. inheritance (:obj:`bool`, optional): If ``True``, the object will inherit permissions from the parent. If ``False``, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created. Default is ``True``. reset (:obj:`bool`, optional): If ``True`` the existing DACL will be cleared and replaced with the settings defined in this function. If ``False``, new entries will be appended to the existing DACL. Default is ``False``. .. versionadded:: 2018.3.0 Returns: bool: ``True`` if successful Raises: CommandExecutionError: Failed to create directory CLI Example: .. code-block:: bash # To grant the 'Users' group 'read & execute' permissions. salt '*' file.mkdir 'C:\Temp\' Administrators '{"Users": {"perms": "read_execute"}}' # Locally using salt call salt-call file.mkdir 'C:\Temp\' Administrators '{"Users": {"perms": "read_execute", "applies_to": "this_folder_only"}}' # Specify advanced attributes with a list salt '*' file.mkdir 'C:\Temp\' Administrators '{"jsnuffy": {"perms": ["read_attributes", "read_ea"], "applies_to": "this_folder_only"}}' r zDrive z is not mapped)�obj_nameZ principalrH �r �obj_type� grant_perms� deny_perms� inheritance�resetNT)rp r` � splitdriver� r r� � expandvars�mkdirrI rJ rj r� � set_permsr� )r` �ownerr r r r �driver� rP rP rQ r E s0 M � ���r c C s� t j�| �} t j�t j�| ��}t j�|�r#d|� d�}t�|� |S t j�|�r6d|� d�}t�|� |S g } t j�|�r@n|� |� |} t j�|�}| |krXt d� |���q9|� � |D ]} t�d| � t | |||||d� q_dS ) a Ensure that the parent directory containing this path is available. Args: path (str): The full path to the directory. .. note:: The path must end with a trailing slash otherwise the directory(s) will be created up to the parent directory. For example if path is ``C:\temp\test``, then it would be treated as ``C:\temp\`` but if the path ends with a trailing slash like ``C:\temp\test\``, then it would be treated as ``C:\temp\test\``. owner (:obj:`str`, optional): The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM. Default is ``None``. grant_perms (:obj:`dict`, optional): A dictionary containing the user/group and the basic permissions to grant, ie: ``{'user': {'perms': 'basic_permission'}}``. You can also set the ``applies_to`` setting here. The default is ``this_folder_subfolders_files``. Specify another ``applies_to`` setting like this: .. code-block:: yaml {'user': {'perms': 'full_control', 'applies_to': 'this_folder'}} To set advanced permissions use a list for the ``perms`` parameter, ie: .. code-block:: yaml {'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}} Default is ``None``. deny_perms (:obj:`dict`, optional): A dictionary containing the user/group and permissions to deny along with the ``applies_to`` setting. Use the same format used for the ``grant_perms`` parameter. Remember, deny permissions supersede grant permissions. Default is ``None``. inheritance (:obj:`bool`, optional): If ``True``, the object will inherit permissions from the parent. If ``False``, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created. Default is ``True``. reset (:obj:`bool`, optional): If ``True``, the existing DACL will be cleared and replaced with the settings defined in this function. If ``False``, new entries will be appended to the existing DACL. Default is ``False``. .. versionadded:: 2018.3.0 Returns: bool: ``True`` if successful Raises: CommandExecutionError: Failed to create directories CLI Example: .. code-block:: bash # To grant the 'Users' group 'read & execute' permissions. salt '*' file.makedirs 'C:\Temp\' Administrators '{"Users": {"perms": "read_execute"}}' # Locally using salt call salt-call file.makedirs 'C:\Temp\' Administrators '{"Users": {"perms": "read_execute", "applies_to": "this_folder_only"}}' # Specify advanced attributes with a list salt '*' file.makedirs 'C:\Temp\' Administrators '{"jsnuffy": {"perms": ["read_attributes", "read_ea"], "applies_to": "this_folder_only"}}' z Directory 'z' already existsz The path 'z'' already exists and is not a directoryTz_Recursive creation for path '{}' would result in an infinite loop. Please use an absolute path.zCreating directory: %s�r` r r r r r )rp r` r� r2 r# r� rc r� rq r r r� �reverser ) r` r r r r r r# r� Zdirectories_to_createZcurrent_dirnameZdirectory_to_createrP rP rQ rU � sF U �� � rU c C s� t j�| �} t j�| �} t j�| �\}}|s t j�|�\}}|rU|rUt j�|�sUz t||||ddd� W n tyM } z |jtj krC� W Y d}~nd}~ww |t j krUi S t | |||||d� dS )a� Set owner and permissions for each directory created. Args: path (str): The full path to the directory. owner (:obj:`str`, optional): The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM. Default is ``None``. grant_perms (:obj:`dict`, optional): A dictionary containing the user/group and the basic permissions to grant, ie: ``{'user': {'perms': 'basic_permission'}}``. You can also set the ``applies_to`` setting here. The default is ``this_folder_subfolders_files``. Specify another ``applies_to`` setting like this: .. code-block:: yaml {'user': {'perms': 'full_control', 'applies_to': 'this_folder'}} To set advanced permissions use a list for the ``perms`` parameter, ie: .. code-block:: yaml {'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}} Default is ``None``. deny_perms (:obj:`dict`, optional): A dictionary containing the user/group and permissions to deny along with the ``applies_to`` setting. Use the same format used for the ``grant_perms`` parameter. Remember, deny permissions supersede grant permissions. Default is ``None``. inheritance (:obj:`bool`, optional): If ``True``, the object will inherit permissions from the parent. If ``False``, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created. Default is ``True``. reset (:obj:`bool`, optional): If ``True``, the existing DACL will be cleared and replaced with the settings defined in this function. If ``False``, new entries will be appended to the existing DACL. Default is ``False``. .. versionadded:: 2018.3.0 Returns: bool: ``True`` if successful Raises: OSError: Failed to create dirs and set perms CLI Example: .. code-block:: bash # To grant the 'Users' group 'read & execute' permissions. salt '*' file.makedirs_perms 'C:\Temp\' Administrators '{"Users": {"perms": "read_execute"}}' # Specify advanced attributes with a list salt '*' file.makedirs_perms 'C:\Temp\' Administrators '{"jsnuffy": {"perms": ["read_attributes", "read_ea"], "applies_to": "this_folder_files"}}' .. code-block:: bat # Locally using salt call salt-call file.makedirs_perms "C:\Temp\" Administrators "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}" TFr N) rp r` r� r �splitrq �makedirs_permsr� �errnoZEEXIST�curdirr ) r` r r r r r �head�tailr� rP rP rQ r 9 s@ N � ��� � r c C sJ t j�| �s td| � ���t j�| �} tjjj| d||||||t d d� S )a_ Check owner and permissions for the passed directory. This function checks the permissions and sets them, returning the changes made. Used by the file state to populate the return dict Args: path (str): The full path to the directory. ret (:obj:`dict`, optional): A dictionary to append changes to and return. If not passed, will create a new dictionary to return. Default is ``None``. owner (:obj:`str`, optional): The owner to set for the directory. Default is ``None``. grant_perms (:obj:`dict`, optional): A dictionary containing the user/group and the basic permissions to check/grant, ie: ``{'user': {'perms': 'basic_permission'}}``. Default is ``None``. deny_perms (:obj:`dict`, optional): A dictionary containing the user/group and permissions to check/deny. Default is ``None``. inheritance (:obj:`bool`, optional): ``True`` will check if inheritance is enabled and enable it. ``False`` will check if inheritance is disabled and disable it. Default is ``True``. reset (:obj:`bool`, optional): ``True`` will show what permissions will be removed by resetting the DACL. ``False`` will do nothing. Default is ``False``. Returns: dict: A dictionary of changes that have been made CLI Example: .. code-block:: bash # To see changes to C:\Temp if the 'Users' group is given 'read & execute' permissions. salt '*' file.check_perms 'C:\Temp\' '{}' Administrators '{"Users": {"perms": "read_execute"}}' # Specify advanced attributes with a list salt '*' file.check_perms 'C:\Temp\' '{}' Administrators '{"jsnuffy": {"perms": ["read_attributes", "read_ea"], "applies_to": "files_only"}}' .. code-block:: bat # Locally using salt call salt-call file.check_perms "C:\Temp\" {} Administrators "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}" ro rH �test) r r r� r r r r r Z test_mode) rp r` rq r r� rI rJ rj � check_permsZ__opts__)r` r� r r r r r rP rP rQ r � s C �r c C s t jjj| d||||d�S )aK Set permissions for the given path Args: path (str): The full path to the directory. grant_perms (:obj:`dict`, optional): A dictionary containing the user/group and the basic permissions to grant, ie: ``{'user': {'perms': 'basic_permission'}}``. You can also set the ``applies_to`` setting here for directories. The default for ``applies_to`` is ``this_folder_subfolders_files``. Specify another ``applies_to`` setting like this: .. code-block:: yaml {'user': {'perms': 'full_control', 'applies_to': 'this_folder'}} To set advanced permissions use a list for the ``perms`` parameter, ie: .. code-block:: yaml {'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}} To see a list of available attributes and applies to settings see the documentation for salt.utils.win_dacl. A value of ``None`` will make no changes to the ``grant`` portion of the DACL. Default is ``None``. deny_perms (:obj:`dict`, optional): A dictionary containing the user/group and permissions to deny along with the ``applies_to`` setting. Use the same format used for the ``grant_perms`` parameter. Remember, deny permissions supersede grant permissions. A value of ``None`` will make no changes to the ``deny`` portion of the DACL. Default is ``None``. inheritance (:obj:`bool`, optional): If ``True``, the object will inherit permissions from the parent. If ``False``, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created. Default is ``True``. reset (:obj:`bool`, optional): If ``True``, the existing DCL will be cleared and replaced with the settings defined in this function. If ``False``, new entries will be appended to the existing DACL. Default is ``False``. .. versionadded:: 2018.3.0 Returns: bool: ``True`` if successful Raises: CommandExecutionError: If unsuccessful CLI Example: .. code-block:: bash # To grant the 'Users' group 'read & execute' permissions. salt '*' file.set_perms 'C:\Temp\' '{"Users": {"perms": "read_execute"}}' # Specify advanced attributes with a list salt '*' file.set_perms 'C:\Temp\' '{"jsnuffy": {"perms": ["read_attributes", "read_ea"], "applies_to": "this_folder_only"}}' .. code-block:: bat # Locally using salt call salt-call file.set_perms "C:\Temp\" "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}" rH r )rI rJ rj r )r` r r r r rP rP rQ r s Q�r )rW )T)NN)NNT)r� T)N)NNNNNNN)F)FF)NNNTF)NNNTT)NNNNTF)NNTF)��__doc__r �loggingrp Zos.pathr� r[ r� Zsalt.utils.filesrI Zsalt.utils.pathZsalt.utils.platformZsalt.utils.userZsalt.exceptionsr r Zsalt.modules.filer r r r r r r r r r r r r r r r r r r r r r r r r r r r r r! r" r# r$ r% r& r' r( r) r* r+ r, r- r. r/ r0 r1 r2 rV r3 r4 r5 r6 r7 r8 r9 r: r; r< r= r> r? r@ rA rB rC rD rE rF Zsalt.utils.functoolsrG rM rJ rK rL r� r� r� r� r� Zsalt.platform.win� ImportErrorrN Zsalt.utils.win_dacl�globals� getLogger�__name__rc rO rR Z __outputter__Z__func_alias__ra rh rm rs ru ry r| re r� rw r{ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r^ r rU r r r rP rP rP rQ �<module> sX � 0X � ��� � � �� " % , % // )( ! 9F! .S +!(^A �k Dt# �o � �} �U
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings