File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/file.cpython-310.pyc
o
�N�g\� � @ sZ d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlZddlZddlZddlmZ ddlmZmZ ddlZddlZddlZddl Zddl Zddl Zddl Zddl Zddl!Zddl"Zddl#Zddl$Zddl%Zddl&Zddl'Zddl(Zddl)m*Z*m+Z+m,Z, ddl)m-Z. ddl m/Z/m0Z0 ddl1m2Z2 z
ddl3Z3ddl4Z4W n e5y� Y nw e�6e7�Z8d d
iZ9ed d �Z:d
d� Z;dd� Z<dd� Z=dd� Z>dd� Z?dd� Z@dd� ZAdd � ZBd d � ZCd d � ZD�d
d"d#�ZE�d
d$d%�ZFd&d'� ZGd(d)� ZH�d
d*d+�ZI�d
d,d-�ZJ�d
d.d/�ZKd0d1� ZLd2d3� ZMd4d5� ZNd6d7� ZOd8d9� ZPd:d;� ZQd<d=� ZR�d d?d@�ZS�d dBdC�ZT D D E !�d
dFdG�ZUdHdI� ZVdJdK� ZW�ddMdN�ZX D O P Q L L�ddRdS�ZY�ddTdU�ZZ D O V L L�ddWdX�Z[e
j\e
j]e
j^e
j_e
j`e
jadY�ZbdZd[� Zc�dd]d^�Zd�dd_d`�Ze�ddadb�Zfdcdd� Zgdedf� Zh�d
dgdh�Zididj� Zj�ddldm�Zkdndo� Zldpdq� Zmdrds� Zn !�ddtdu�Zo ! L L !�ddvdw�Zp x k L L O L L ! L ! L�ddydz�Zq { | D L L O L ! L �dd}d~�Zr�ddd��Zs�dd�d��Ztd�d�� Zu�dd�d��Zvd�d�� Zwd�d�� Zxd�d�� Zyd�d�� Zz�d d�d��Z{d�d�� Z|d�d�� Z}d�d�� Z~d�d�� Zd�d�� Z�d�d�� Z��d d�d��Z�d�d�� Z��d d�d��Z�d�d�� Z�d�d�� Z��dd�d��Z��dd�d��Z�d�d�� Z�d�d�� Z��d d�d��Z��d d�d��Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z��dd�d��Z�d�d�� Z� L�d d�d��Z�d�d Z�d�dĄ Z� L ! L�d!d�dƄZ� �d"d�dȄZ� L �d#d�dʄZ� L L�d$d�d̄Z� L L ! L�d%d�d΄Z� ! L�d&d�dЄZ� E ! ! L �d'd�d҄Z� L ! ! L L � ! L�d(d�dՄZ��d)d�dׄZ��d)d�d �Z��d*d�dۄZ�d�d݄ Z�d�d߄ Z��d+d�d�Z�d�d� Z��d+d�d�Z�d�d� Z��d+d�d�Z��d,d�d�Z��d-d�d�Z�ej�j���e�d�Z��d-d�d�Z�d�d� Z�d�d�� Z�ej�j���e�d��Z�d�d�� Z��dd�d��Z�d�d�� Z�d�d�� Z��d �d� Z��d�d� Z��d�d� Z��d�d�d�Z��d�d � Z�dS (. z|
Manage information about regular files, directories,
and special files on the minion, set/read user,
group, mode, and data
� N)�
namedtuple)�Iterable�Mapping)�CommandExecutionError� MinionError�SaltInvocationError)�get_error_message)�HASHES�
HASHES_REVMAP)�Version� makedirs_�makedirs� AttrChangesz
added,removedc C s t jj�� rdS dS )z)
Only work on POSIX-like systems
)FziThe file execution module cannot be loaded: only available on non-Windows systems - use win_file instead.T)�salt�utils�platform�
is_windows� r r �E/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/file.py� __virtual__C s r c sr � � tj�t�� tjjj ��r3t
j � t
d �� �}t� fdd�|D ��}tj�� �r5|s7t�� � dS dS dS dS )z(
Clean out a template temp file
Z
file_rootsc 3 s � | ]}� � |�V qd S �N)�
startswith)�.0�root��sfnr r � <genexpr>Z s � z __clean_tmp.<locals>.<genexpr>N)r �os�path�join�tempfile�
gettempdirr r �files�TEMPFILE_PREFIX� itertools�chain�
from_iterable�__opts__�values�any�exists�remove)r Z all_rootsZin_rootsr r r � __clean_tmpQ s ��r, c C s d| d< || d< | S )zH
Common function for setting error information for return dicts
F�result�commentr )�ret�err_msgr r r �_error` s r1 c C sL t d | � }t d |� }t||f�r$t||f�r dS |r dS |r$dS dS )ac
This function does NOT do any diffing, it just checks the old and new files
to see if either is binary, and provides an appropriate string noting the
difference between the two files. If neither file is binary, an empty
string is returned.
This function should only be run AFTER it has been determined that the
files differ.
�
files.is_textzReplace binary filez"Replace binary file with text filez"Replace text file with binary file� )� __utils__r) �all)�old�newZ old_isbinZ new_isbinr r r �_binary_replacei s
r8 c C s t j�td d�d�S )z@
Get the location of the backup dir in the minion cache
z
config.get�cachedirZ file_backup)r r r �__salt__r r r r � _get_bkroot s r; c C s* | � � }| �d�s| �d�r|�d� |S )a�
Returns a list of the lines in the string, breaking at line boundaries and
preserving a trailing newline (if present).
Essentially, this works like ``str.striplines(False)`` but preserves an
empty line at the end. This is equivalent to the following code:
.. code-block:: python
lines = str.splitlines()
if str.endswith('
') or str.endswith('
'):
lines.append('')
�
�
r3 )�
splitlines�endswith�append)�str�linesr r r �'_splitlines_preserving_trailing_newline� s
rC c C sn t jj�d�} | rt jj�� rdS | g}td |ddd�}t�dt jj �
|��}|du r0d}|S |� d�}|S ) z0
Return the version of chattr installed
�tune2fsN�cmd.runTF�Zignore_retcode� python_shellz tune2fs (?P<version>[0-9\.]+)�version) r r r �whichr �is_aixr: �re�search� stringutils�to_str�group)rD �cmdr- �matchrH r r r �_chattr_version� s �
�rR c C s* t � } | du r dS td�}t| �}||kS )z|
Return ``True`` if chattr supports extended attributes, that is,
the version is >1.41.22. Otherwise, ``False``
NFz1.41.12)rR r )�verZneeded_versionZchattr_versionr r r �_chattr_has_extended_attrs� s rT c C s^ zt | �} W n
ty t| �} Y nw | dkrdS zt�| �jW S ttfy. | Y S w )z�
Convert the group id to the group name on this system
gid
gid to convert to a group name
CLI Example:
.. code-block:: bash
salt '*' file.gid_to_group 0
r3 )�int�
ValueError� group_to_gid�grp�getgrgid�gr_name�KeyError� NameError)�gidr r r � gid_to_group� s
��r^ c C s@ | du rdS zt | t�r| W S t�| �jW S ty Y dS w )z�
Convert the group to the gid on this system
group
group to convert to its gid
CLI Example:
.. code-block:: bash
salt '*' file.group_to_gid root
Nr3 )�
isinstancerU rX �getgrnam�gr_gidr[ )rO r r r rW � s
�rW Tc C � t tj�| �|d��dd�S )a]
Return the id of the group that owns a given file
path
file or directory of which to get the gid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_gid /etc/passwd
.. versionchanged:: 0.16.4
``follow_symlinks`` option added
��follow_symlinksr] �����statsr r �
expanduser�get�r rd r r r �get_gid� � �rk c C rb )aW
Return the group that owns a given file
path
file or directory of which to get the group
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_group /etc/passwd
.. versionchanged:: 0.16.4
``follow_symlinks`` option added
rc rO Frf rj r r r � get_group rl rm c C s* zt �| �jW S ttfy | Y S w )z�
Convert a uid to a user name
uid
uid to convert to a username
CLI Example:
.. code-block:: bash
salt '*' file.uid_to_user 0
)�pwd�getpwuid�pw_namer[ r\ )�uidr r r � uid_to_user- s
�rr c C sH | du r
t jj�� } zt| t�r| W S t�| �jW S t y# Y dS w )z�
Convert user name to a uid
user
user name to convert to its uid
CLI Example:
.. code-block:: bash
salt '*' file.user_to_uid root
Nr3 )
r r �user�get_userr_ rU rn �getpwnam�pw_uidr[ )rs r r r � user_to_uidA s
�rw c C rb )a\
Return the id of the user that owns a given file
path
file or directory of which to get the uid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_uid /etc/passwd
.. versionchanged:: 0.16.4
``follow_symlinks`` option added
rc rq re rf rj r r r �get_uidX rl rx c C rb )aT
Return the user that owns a given file
path
file or directory of which to get the user
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_user /etc/passwd
.. versionchanged:: 0.16.4
``follow_symlinks`` option added
rc rs Frf rj r r r rt p rl rt c C rb )aI
Return the mode of a file
path
file or directory of which to get the mode
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_mode /etc/passwd
.. versionchanged:: 2014.1.0
``follow_symlinks`` option added
rc �moder3 rf rj r r r �get_mode� rl rz c C st t j�| �} t|��d�}|sd}t j�| �s t| � d���zt �| t|d�� W t
| �S t y9 d| Y S w )z�
Set the mode of a file
path
file or directory of which to set the mode
mode
mode to set the path to
CLI Example:
.. code-block:: bash
salt '*' file.set_mode /etc/passwd 0644
�0Oo�0z: File not found� z
Invalid Mode ) r r rh rA �lstripr* r �chmodrU � Exceptionrz )r ry r r r �set_mode� s � �r� c C sb t j�| �} t|�}t|�}d}|dkr |r|d7 }nd}|dkr*|r(|d7 }nd}t �| ||�S )a+
Chown a file, pass the file the desired user and group without following
symlinks.
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/passwd root root
r3 �User does not exist
re �Group does not exist
)r r rh rw rW �lchown�r rs rO rq r] �errr r r r� � s
r� c C s� t j�| �} t|�}t|�}d}|dkr |r|d7 }nd}|dkr*|r(|d7 }nd}t j�| �sFzt �| ||�W S tyA Y nw |d7 }|rJ|S t �| ||�S )a
Chown a file, pass the file the desired user and group
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/passwd root root
r3 r� re r� �File not found) r r rh rw rW r* r� �OSError�chownr� r r r r� � s,
�r� c C s t j�| �} t| �}t| ||�S )z�
Change the group of a file
path
path to the file or directory
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chgrp /etc/passwd root
)r r rh rt r� )r rO rs r r r �chgrp s r� c C s� t jj�� rdS z
t| ��| d�}W n
ty Y dS w t|�}t|�}d|v r.|�d� t d�
|| �p7dd�
|| �p?dd�S )a�
.. versionadded:: 2018.3.0
Compare attributes of a given file to given attributes.
Returns a pair (list) where first item are attributes to
add and second item are to be removed.
Please take into account when using this function that some minions will
not have lsattr installed.
path
path to file to compare attributes with.
attrs
string of attributes to compare against a given file
Nr3 �e)�added�removed) r r r rJ �lsattrri �AttributeError�set�addr r )r �attrsZlattrsr7 r6 r r r �
_cmp_attrs) s �
�r� c C s� t jj�d�r
t jj�� rdS tj�| �std| ��d| g}t d |ddd�}i }|�
� D ] }|� d�sM|� dd �\}}t
� rCd
}nd }t�||�||< q.|S ) aV
.. versionadded:: 2018.3.0
.. versionchanged:: 2018.3.1
If ``lsattr`` is not installed on the system, ``None`` is returned.
.. versionchanged:: 2018.3.4
If on ``AIX``, ``None`` is returned even if in filesystem as lsattr on ``AIX``
is not the same thing as the linux version.
Obtain the modifiable attributes of the given file. If path
is to a directory, an empty list is returned.
path
path to file to obtain attributes of. File/directory must exist.
CLI Example:
.. code-block:: bash
salt '*' file.lsattr foo1.txt
r� Nz"File or directory does not exist: rE TFrF zlsattr: � z[aAcCdDeijPsStTu]z[acdijstuADST])r r r rI r rJ r r* r r: r> r �splitrT rK �findall)r rP r- �results�liner� �file�patternr r r r� R s
�r� c O s� |� dd�}|� dd�}|� dd�}|� dd�}|du s |dvr$td��|du r,td��d g}|d
kr9d |� �}n |d krBd
|� �}|�|� |durS|�d
|� �� |dur^|�d|g� |�| � td |dd�}t|�rqdS dS )aI
.. versionadded:: 2018.3.0
Change the attributes of files. This function accepts one or more files and
the following options:
operator
Can be wither ``add`` or ``remove``. Determines whether attributes
should be added or removed from files
attributes
One or more of the following characters: ``aAcCdDeijPsStTu``,
representing attributes to add to/remove from files
version
a version number to assign to the file(s)
flags
One or more of the following characters: ``RVf``, representing
flags to assign to chattr (recurse, verbose, suppress most errors)
CLI Example:
.. code-block:: bash
salt '*' file.chattr foo1.txt foo2.txt operator=add attributes=ai
salt '*' file.chattr foo3.txt operator=remove attributes=i version=2
�operatorN�
attributes�flagsrH )r� r+ z9Need an operator: 'add' or 'remove' to modify attributes.z"Need attributes: [aAcCdDeijPsStTu]�chattrr� �+r+ �-z-vrE F�rG T)�popr r@ �extendr: �bool) r" �kwargsr� r� r� rH rP r� r- r r r r� } s2 �
r� �sha256c C s. t j�| �} t j�| �sdS tjj�| |d�S )aq
Return the checksum for the given file. The following checksum algorithms
are supported:
* md5
* sha1
* sha224
* sha256 **(default)**
* sha384
* sha512
path
path to the file or directory
form
desired sum format
CLI Example:
.. code-block:: bash
salt '*' file.get_sum /etc/passwd sha512
r� i )r r rh �isfiler r � hashutils�get_hash)r �formr r r �get_sum� s r� � c C s t jj�tj�| �||�S )aT
Get the hash sum of a file
This is better than ``get_sum`` for the following reasons:
- It does not read the entire file into memory.
- It does not return a string on error. The returned value of
``get_sum`` cannot really be trusted since it is vulnerable to
collisions: ``get_sum(..., 'xyz') == 'Hash xyz not supported'``
path
path to the file or directory
form
desired sum format
chunk_size
amount to sum at once
CLI Example:
.. code-block:: bash
salt '*' file.get_hash /etc/shadow
)r r r� r� r r rh )r r� Z
chunk_sizer r r r� � s r� r3 �basec s� � fdd�}d}t j�� �r� }n:z+tj�� �j}|tjj j
v r4t d � ||d�}|s3t d� � d���n|dkr;|� W n t
tfyJ |� Y nw |durht|d| ||�} | du r^|� | d �� | d < | S i } zd
d � � �d d
�D �\| d< | d < W n8 t
y� |� Y n- ty� t�dtj� d�� �s�|� � | d < t� �}
|
tv r�t|
| d< n|� Y nw | d tvr�t d�| d d�t�| d ���t| d �} | tvr�|� n| t| d kr�t d�| | d | d t| ���| d �� | d < | S )a#
.. versionadded:: 2016.11.0
Used by :py:func:`file.get_managed <salt.modules.file.get_managed>` to
obtain the hash and hash type from the parameters specified below.
file_name
Optional file name being managed, for matching with
:py:func:`file.extract_hash <salt.modules.file.extract_hash>`.
source
Source file, as used in :py:mod:`file <salt.states.file>` and other
states. If ``source_hash`` refers to a file containing hashes, then
this filename will be used to match a filename in that file. If the
``source_hash`` is a hash expression, then this argument will be
ignored.
source_hash
Hash file/expression, as used in :py:mod:`file <salt.states.file>` and
other states. If this value refers to a remote URL or absolute path to
a local file, it will be cached and :py:func:`file.extract_hash
<salt.modules.file.extract_hash>` will be used to obtain a hash from
it.
source_hash_name
Specific file name to look for when ``source_hash`` refers to a remote
file, used to disambiguate ambiguous matches.
saltenv: base
Salt fileserver environment from which to retrieve the source_hash. This
value will only be used when ``source_hash`` refers to a file on the
Salt fileserver (i.e. one beginning with ``salt://``).
verify_ssl
If ``False``, remote https file sources (``https://``) and source_hash
will not attempt to validate the servers certificate. Default is True.
.. versionadded:: 3002
CLI Example:
.. code-block:: bash
salt '*' file.get_source_sum /tmp/foo.tar.gz source=http://mydomain.tld/foo.tar.gz source_hash=499ae16dcae71eeb7c3a30c75ea7a1a6
salt '*' file.get_source_sum /tmp/foo.tar.gz source=http://mydomain.tld/foo.tar.gz source_hash=https://mydomain.tld/hashes.md5
salt '*' file.get_source_sum /tmp/foo.tar.gz source=http://mydomain.tld/foo.tar.gz source_hash=https://mydomain.tld/hashes.md5 source_hash_name=./dir2/foo.tar.gz
c
s2 t d�� d�tjjj�d�dd� tt�D �����)zD
DRY helper for reporting invalid source_hash input
ah Source hash {} format is invalid. The supported formats are: 1) a hash, 2) an expression in the format <hash_type>=<hash>, or 3) either a path to a local file containing hashes, or a URI of a remote hash file. Supported protocols for remote hash files are: {}. The hash may also not be of a valid length, the following are supported hash types and lengths: {}.�, c S � g | ] }t | � d |� d��qS �z (�)�r
�r �xr r r �
<listcomp>? � zGget_source_sum.<locals>._invalid_source_hash_format.<locals>.<listcomp>) r �formatr r r r" � VALID_PROTOS�sortedr
r �� source_hashr r �_invalid_source_hash_format2 s ��z3get_source_sum.<locals>._invalid_source_hash_formatN�
cp.cache_file��
verify_sslzSource hash file z
not foundr3 �hsumc s s � | ]}|� � V qd S r )�stripr� r r r r f s �
�z!get_source_sum.<locals>.<genexpr>�=r� � hash_typez^[z]+$z�Invalid hash type '{}'. Supported hash types are: {}. Either remove the hash type and simply use '{}' as the source_hash, or change the hash type to a supported type.r� z�Invalid length ({}) for hash type '{}'. Either remove the hash type and simply use '{}' as the source_hash, or change the hash type to '{}') r r �isabs�urllib�parse�urlparse�schemer r r" r� r: r r� � TypeError� extract_hash�lowerr� rV rK rQ �string� hexdigits�lenr
r r� r ) � file_name�sourcer� �source_hash_name�saltenvr� r� �hash_fn�protor/ Zsource_hash_lenZhsum_lenr r� r �get_source_sum� s� 8 �
���
�
�
�� �� �� r� c
C s� t j�| �} t|t�std��dD ]}||v r!|�|d�\}} n#q|}t|�}t� |�}|du rDtd�
||d� dd� t t�D �����t
| |�|kS ) aI
Check if a file matches the given hash string
Returns ``True`` if the hash matches, otherwise ``False``.
path
Path to a file local to the minion.
hash
The hash to check against the file specified in the ``path`` argument.
.. versionchanged:: 2016.11.4
For this and newer versions the hash can be specified without an
accompanying hash type (e.g. ``e138491e9d5b97023cea823fe17bac22``),
but for earlier releases it is necessary to also specify the hash type
in the format ``<hash_type>=<hash_value>`` (e.g.
``md5=e138491e9d5b97023cea823fe17bac22``).
CLI Example:
.. code-block:: bash
salt '*' file.check_hash /etc/fstab e138491e9d5b97023cea823fe17bac22
salt '*' file.check_hash /etc/fstab md5=e138491e9d5b97023cea823fe17bac22
zhash must be a string)�:r� r� NzpHash {} (length: {}) could not be matched to a supported hash type. The supported hash types and lengths are: {}r� c S r� r� r� r� r r r r� � r� z check_hash.<locals>.<listcomp>)r r rh r_ rA r r� r� r
ri r� r r� r� )r Z file_hash�sepr� Z
hash_value�hash_lenr r r �
check_hash� s.
�
��� r� c
s� d|v r d|d< nd|v rd|d< z t jj�|�� W n ty1 } z d|� �W Y d}~S d}~ww dd� � fd d�t�tj�| ��D �D �}|� � |S )
a�
Approximate the Unix ``find(1)`` command and return a list of paths that
meet the specified criteria.
The options include match criteria:
.. code-block:: text
name = path-glob # case sensitive
iname = path-glob # case insensitive
regex = path-regex # case sensitive
iregex = path-regex # case insensitive
type = file-types # match any listed type
user = users # match any listed user
group = groups # match any listed group
size = [+-]number[size-unit] # default unit = byte
mtime = interval # modified since date
grep = regex # search file contents
and/or actions:
.. code-block:: text
delete [= file-types] # default type = 'f'
exec = command [arg ...] # where {} is replaced by pathname
print [= print-opts]
and/or depth criteria:
.. code-block:: text
maxdepth = maximum depth to transverse in path
mindepth = minimum depth to transverse before checking files or directories
The default action is ``print=path``
``path-glob``:
.. code-block:: text
* = match zero or more chars
? = match any char
[abc] = match a, b, or c
[!abc] or [^abc] = match anything except a, b, and c
[x-y] = match chars x through y
[!x-y] or [^x-y] = match anything except chars x through y
{a,b,c} = match a or b or c
``path-regex``: a Python Regex (regular expression) pattern to match pathnames
``file-types``: a string of one or more of the following:
.. code-block:: text
a: all file types
b: block device
c: character device
d: directory
p: FIFO (named pipe)
f: plain file
l: symlink
s: socket
``users``: a space and/or comma separated list of user names and/or uids
``groups``: a space and/or comma separated list of group names and/or gids
``size-unit``:
.. code-block:: text
b: bytes
k: kilobytes
m: megabytes
g: gigabytes
t: terabytes
interval:
.. code-block:: text
[<num>w] [<num>d] [<num>h] [<num>m] [<num>s]
where:
w: week
d: day
h: hour
m: minute
s: second
print-opts: a comma and/or space separated list of one or more of the
following:
.. code-block:: text
group: group name
md5: MD5 digest of file contents
mode: file permissions (as integer)
mtime: last modification time (as time_t)
name: file basename
path: file absolute path
size: file size in bytes
type: file type
user: user name
CLI Examples:
.. code-block:: bash
salt '*' file.find / type=f name=\*.bak size=+10m
salt '*' file.find /var mtime=+30d size=+10m print=path,size,mtime
salt '*' file.find /var/log name=\*.[0-9] mtime=+30d size=+10m delete
�delete�f�printr zerror: Nc S s g | ] }|D ]}|�qqS r r �r �i�itemr r r r� F s ���zfind.<locals>.<listcomp>c s g | ]}� � |��qS r )�find)r �p��finderr r r� H s )
r r r� ZFinderrV �globr r rh �sort)r �argsr� �exr/ r r� r r� � s r
�� �r� Fc C s> d}| � dd�� dd�} |du r |D ]
}| � |d| �} q| S )z2
Escape single quotes and forward slashes
z ^.[$()|*+?{�'z'"'"'�/z\/T�\)�replace)r� �
escape_allZ
special_chars�charr r r �_sed_escO s r� �.bak�-r -e�gc
C s� t j�| �} t j�| �sdS t|�}t|�}t||�}t||�}t||�}tjdkr0|�dd�}dg} | � |r<d|� �nd� | �
t j j
�|�� | � dj|rUd|� d �nd
|rZd nd
|||d �� | � | � td
| dd�S )a�
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file
Equivalent to:
.. code-block:: bash
sed <backup> <options> "/<limit>/ s/<before>/<after>/<flags> <file>"
path
The full path to the file to be edited
before
A pattern to find in order to replace with ``after``
after
Text that will replace ``before``
limit: ``''``
An initial pattern to search for before searching for ``before``
backup: ``.bak``
The file will be backed up before edit with this file extension;
**WARNING:** each time ``sed``/``comment``/``uncomment`` is called will
overwrite this backup
options: ``-r -e``
Options to pass to sed
flags: ``g``
Flags to modify the sed search; e.g., ``i`` for case-insensitive pattern
matching
negate_match: False
Negate the search command (``!``)
.. versionadded:: 0.17.0
Forward slashes and single quotes will be escaped automatically in the
``before`` and ``after`` patterns.
CLI Example:
.. code-block:: bash
salt '*' file.sed /etc/httpd/httpd.conf 'LogLevel warn' 'LogLevel info'
F�darwin�-r�-E�sed�-iz/{limit}{negate_match}s/{before}/{after}/{flags}r� �/ r3 �!)�limit� negate_match�before�afterr� � cmd.run_allr� )r r rh r* rA r� �sysr r� r@ r� r r r� � shlex_splitr� r: )
r r� r� r� �backup�optionsr� r� r� rP r r r r� [ s0 9
��
r� c C s� t j�| �} t j�| �sdS tt|�d�}tt|�d�}d}tjdkr)|�dd�}dg}|� t
j j �
|�� |�dj|rBd|� d �nd
|d |� �d �� |�| � td
|dd�}t|�S )ah
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the file at ``path`` contains ``text``. Utilizes sed to
perform the search (line-wise search).
Note: the ``p`` flag will be added to any flags you pass in.
CLI Example:
.. code-block:: bash
salt '*' file.contains /etc/crontab 'mymaintenance.sh'
Fz-n -r -er� r� r� r� z{limit}s/{before}/$/{flags}r� r� r3 r� )r� r� r� rE r� )r r rh r* r� rA r� r r� r� r r r� r� r@ r� r: r� )r �textr� r� r� r rP r- r r r � sed_contains� s(
��
r �gMSc
C s: t j�| �} t|�}t|�}t|�}t||�}t||�}t�| | � |� �� tj j
� | d��e}tj j
� | � |� �d��@} |du r]| � � D ]}
|�
tj j�ttj j�|
�||||��� qDn|�
tj j�ttj j�| �� �||||��� W d � n1 s~w Y W d � dS W d � dS 1 s�w Y dS )a~
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file (pure Python version)
Equivalent to:
.. code-block:: bash
sed <backup> <options> "/<limit>/ s/<before>/<after>/<flags> <file>"
path
The full path to the file to be edited
before
A pattern to find in order to replace with ``after``
after
Text that will replace ``before``
limit: ``''``
An initial pattern to search for before searching for ``before``
backup: ``.bak``
The file will be backed up before edit with this file extension;
**WARNING:** each time ``sed``/``comment``/``uncomment`` is called will
overwrite this backup
flags: ``gMS``
Flags to modify the search. Valid values are:
- ``g``: Replace all occurrences of the pattern, not just the first.
- ``I``: Ignore case.
- ``L``: Make ``\w``, ``\W``, ``\b``, ``\B``, ``\s`` and ``\S``
dependent on the locale.
- ``M``: Treat multiple lines as a single line.
- ``S``: Make `.` match all characters, including newlines.
- ``U``: Make ``\w``, ``\W``, ``\b``, ``\B``, ``\d``, ``\D``,
``\s`` and ``\S`` dependent on Unicode.
- ``X``: Verbose (whitespace is ignored).
multi: ``False``
If True, treat the entire file as a single line
Forward slashes and single quotes will be escaped automatically in the
``before`` and ``after`` patterns.
CLI Example:
.. code-block:: bash
salt '*' file.sed /etc/httpd/httpd.conf 'LogLevel warn' 'LogLevel info'
�w�rTN)r r rh r� rA r� �shutil�copy2r r r" �fopen�readline�writerM rN �_psed�
to_unicode�read) r r� r� r� r r� r� Zmulti�ofileZifiler� r r r �psed� sN =
����
���� ��"�r )�I�L�M�S�U�Xc
C s� | }|rt �|�}| �|�}d�|dd� �}d}d|v r%d}|�dd�}d}|D ]} |t| O }q)t j||d�}t j||||d�} | S )zS
Does the actual work for file.psed, so that single lines can be passed in
r3 r� Nr� r �r� )�count)rK �compiler� r r� �
RE_FLAG_TABLE�sub)
r r� r� r� r� Zatext�compsr Zaflags�flagr r r r H s
r �#c C � t | ||d|d�S )ah
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Uncomment specified commented lines in a file
path
The full path to the file to be edited
regex
A regular expression used to find the lines that are to be uncommented.
This regex should not include the comment character. A leading ``^``
character will be stripped for convenience (for easily switching
between comment() and uncomment()).
char: ``#``
The character to remove in order to uncomment a line
backup: ``.bak``
The file will be backed up before edit with this file extension;
**WARNING:** each time ``sed``/``comment``/``uncomment`` is called will
overwrite this backup
CLI Example:
.. code-block:: bash
salt '*' file.uncomment /etc/hosts.deny 'ALL: PARANOID'
F�r �regexr� �cmntr �� comment_line�r r! r� r r r r � uncommenta s r& c C r )a�
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Comment out specified lines in a file
path
The full path to the file to be edited
regex
A regular expression used to find the lines that are to be commented;
this pattern will be wrapped in parenthesis and will move any
preceding/trailing ``^`` or ``$`` characters outside the parenthesis
(e.g., the pattern ``^foo$`` will be rewritten as ``^(foo)$``)
char: ``#``
The character to be inserted at the beginning of a line in order to
comment it out
backup: ``.bak``
The file will be backed up before edit with this file extension
.. warning::
This backup will be overwritten each time ``sed`` / ``comment`` /
``uncomment`` is called. Meaning the backup will only be useful
after the first invocation.
CLI Example:
.. code-block:: bash
salt '*' file.comment /etc/modules pcspkr
Tr r# r% r r r r. s r. c
C s� |r d� |�d�r dnd|�d��d�|�d�rdnd�}nd� ||�d��d�|�d�r/dnd�}tj�tj�| ��} tj� | �sIt
d| � ���t d | �sVt
d| � ���d }g }g }tj� | �}zIt
jjj| d
|d ��5} | D ]*}
t
jj�|
�}
t�||
�r�|�|
� |r�|�|� |
� �� n|�|
�|�� d }qpW d
� n1 s�w Y W n ty� } z
td| � d| � ���d
} ~ ww |s�d S t
jj�� s�t| �} t| �}
t
jj� t | ��}zt | d d�}W n ty� } ztd| � ���d
} ~ ww z�d}t
jjj| ||d ���}zgt
jjj|d
|d ��R} | D ]G}
t
jj�|
�}
z(t�||
��r6|�r0|� |
� �}n|
�|�}n|
}t
jj� |�}|� |� W �q t�y\ } z td� | || ���d
} ~ ww W d
� n 1 �shw Y W n t�y� } ztd| � ���d
} ~ ww W d
� n 1 �s�w Y W n t�y� } ztd| � ���d
} ~ ww |�r�| � |� �}zt!�"||� W n t�y� } z td� | || ���d
} ~ ww t�#|� t
jj�� �s�t$| d
| |
|� t d ||�S )a�
Comment or Uncomment a line in a text file.
:param path: string
The full path to the text file.
:param regex: string
A regex expression that begins with ``^`` that will find the line you wish
to comment. Can be as simple as ``^color =``
:param char: string
The character used to comment a line in the type of file you're referencing.
Default is ``#``
:param cmnt: boolean
True to comment the line. False to uncomment the line. Default is True.
:param backup: string
The file extension to give the backup file. Default is ``.bak``
Set to False/None to not keep a backup.
:return: boolean
Returns True if successful, False if not
CLI Example:
The following example will comment out the ``pcspkr`` line in the
``/etc/modules`` file using the default ``#`` character and create a backup
file named ``modules.bak``
.. code-block:: bash
salt '*' file.comment_line '/etc/modules' '^pcspkr'
CLI Example:
The following example will uncomment the ``log_level`` setting in ``minion``
config file if it is set to either ``warning``, ``info``, or ``debug`` using
the ``#`` character and create a backup file named ``minion.bk``
.. code-block:: bash
salt '*' file.comment_line 'C:\salt\conf\minion' '^log_level: (warning|info|debug)' '#' False '.bk'
z{}({}){}�^r3 �$z ^{}\s*({}){}�File not found: r2 �5Cannot perform string replacements on a binary file: F�rb�ry � bufferingTN�Unable to open file '�'. Exception: �r �preserve_inode� Exception: r �iUnable to write file '{}'. Contents may be truncated. Temporary file contains copy at '{}'. Exception: {}�HUnable to move the temp file '{}' to the backup file '{}'. Exception: {}�stringutils.get_diff)%r� r r~ �rstripr? r r �realpathrh r� r r4 �getsizer r r" r rM r
rK rQ r@ r� r r r rt rm �normalize_moderz �
_mkstemp_copyrN r r �mover+ � check_perms)r r! r� r" r �found� orig_file�new_file�bufsize�r_filer� �exc�pre_user� pre_group�pre_mode� temp_filery �w_fileZwline� backup_namer r r r$ � s� .� � �
�� ��
�� ���
���� ����� �� ��
���
r$ c C s� t | tj�r| S t | t�rt�| �S t | t�r| g} t | t�rHt | t�sHt�d�}| D ]}ttjt|��� d�}|sAt d|� ���||O }q+|S t d| � d���)a^
Return the names of the Regex flags that correspond to flags
.. code-block:: python
>>> _get_flags(['IGNORECASE', 'MULTILINE'])
re.IGNORECASE|re.MULTILINE
>>> _get_flags('MULTILINE')
re.MULTILINE
>>> _get_flags(8)
re.MULTILINE
>>> _get_flags(re.IGNORECASE)
re.IGNORECASE
r NzInvalid re flag given: zInvalid re flags: "zc", must be given either as a single flag string, a list of strings, as an integer, or as an re flag)
r_ rK � RegexFlagrU rA r r �getattr�upperr )r� Z_flagsr �_flagr r r �
_get_flagsK s"
�rM c C s t | �} t |�}| |B S )z-
Combine ``flags`` and ``new_flags``
)rM )r� Z new_flagsr r r �
_add_flagsp s rN c
C s� d}z
t jjjt jjjd�}W n ty" } ztd|� ���d}~ww |rDz t�| |� W |S tyC } z td� | ||���d}~ww z t�
| |� W |S tyb } z td� | ||���d}~ww )aZ
Create a temp file and move/copy the contents of ``path`` to the temp file.
Return the path to the temp file.
path
The full path to the file whose contents will be moved/copied to a temp file.
Whether it's moved or copied depends on the value of ``preserve_inode``.
preserve_inode
Preserve the inode of the file, so that any hard links continue to share the
inode with the original filename. This works by *copying* the file, reading
from the copy, and writing to the file at the original inode. If ``False``, the
file will be *moved* rather than copied, and a new file will be written to a
new inode, but using the original filename. Hard links will then share an inode
with the backup, instead (if using ``backup`` to create a backup copy).
Default is ``True``.
N)�prefixz'Unable to create temp file. Exception: z=Unable to copy file '{}' to the temp file '{}'. Exception: {}z=Unable to move file '{}' to the temp file '{}'. Exception: {}) r r r" �mkstempr# r� r r r r� r; )r r1 rF rB r r r r: y s< ������������r: c
sf | r�sdS zt ��t j�� � �fdd�| D �} W | S ty2 } z tt|�� d�� d���d}~ww )z4
Expand regular expression to static match.
Nc s$ g | ]}� � |�s|���r|�qS r )rL r �r r� �Zcompiledr! r r r� � s $ z$_regex_to_static.<locals>.<listcomp>z: 'r� )rK r �DOTALLr� r �_get_error_message)�srcr! r� r rR r �_regex_to_static� s ���rV r� c C sP t | �}||kr d}n||k rd}n|sd}nd}|r&td|� d|� d���|S )z\
Raise an exception, if there are different amount of specified occurrences in src.
z more thanz less than�noNzFound z expected occurrences in "z " expression)r� r )Zprobe�target�amountZocc�msgr r r �_assert_occurrence� s �r[ c C s> |s|S g }| D ]
}|dvr n|� |� qd�|�|�� S )z/
Indent the line with the source line.
)� � r3 )r@ r r~ )rU r� �indentZidt�cr r r �_set_line_indent� s r` c C s t �d| �}|r |�� p
dS )Nz((?<!
)
|
(?!
)|
)$r3 )rK rL rO )r� rQ r r r �_get_eol� s ra c C s t | �ptj}|�� | S )z
Add line ending
)ra r �linesepr6 )rU r� Z line_endingr r r �
_set_line_eol� s rc c sl |dvr|du r t d��t d|� ���|dkr � du r t d���s+|du r+|du r+� �t| |�}t| |�}t| ���| sJ|dv rJt�d|� g } | S |dkr[�r[�fd d
�| D �} | S |d kry�ry| ��d �}| �|�} | �|t| � |�� | S |d
k�ra|du r�|du r�|du r�t d��|r�|dkr�| r�| �t| d � |�� | S | �� � | S |dkr�| r�| �d t | d � �� | S � t
j g} | S |r�|r�t |d� t |d� | �|d �}
| �|d �} | �| t| | � |�� | S |�r/t |d� | �|d �}|d t
| �k�r dn| |d } | du �s | �d�� �d�k�r-| �|d t| | � |�� | S |�r]t |d� | �|d �}| |d }
|
�d�� �d�k�r[| �|t| | � |�� | S t d��|dk�r4|�r�|�r�t |d� t |d� | �|d �}| �|d �}t� fdd�| D ��}|�s�|d |k�r�| �|d t| | � |�� | S |d |k�r�t| | � |�| |d < | S t d��| S |�r�t |d� | �|d �}|d k�s�| |d �d�� �d�k�r�| �|t| |d � |�� | S |�r0t |d� | �|d �}|d t
| �k}|�s | |d �d�� �d�k�r.| �|d t| | � |�� | S t d ��| S ) a
Take ``lines`` and insert ``content`` and the correct place. If
``mode`` is ``'delete'`` then delete the ``content`` line instead.
Returns a list of modified lines.
lines
The original file lines to modify.
content
Content of the line. Allowed to be empty if ``mode='delete'``.
match
The regex or contents to seek for on the line.
mode
What to do with the matching line. One of the following options
is required:
- ensure
If ``content`` does not exist, it will be added.
- replace
If the line already exists, it will be replaced(???? TODO WHAT DOES THIS MEAN?)
- delete
Delete the line, if found.
- insert
Insert a line if it does not already exist.
.. note::
If ``mode=insert`` is used, at least one of the following
options must also be defined: ``location``, ``before``, or
``after``. If ``location`` is used, it takes precedence
over the other two options
location
``start`` or ``end``. Defines where to place the content in the
lines. **Note** this option is only used when ``mode='insert`` is
specified. If a location is passed in, it takes precedence over
both the ``before`` and ``after`` kwargs.
- start
Place the ``content`` at the beginning of the lines.
- end
Place the ``content`` at the end of the lines.
before
Regular expression or an exact, case-sensitive fragment of the
line to place the ``content`` before. This option is only used
when either ``ensure`` or ``insert`` mode is specified.
after
Regular expression or an exact, case-sensitive fragment of the
line to plaece the ``content`` after. This option is only used
when either ``ensure`` or ``insert`` mode is specified.
indent
Keep indentation to match the previous line. Ignored when
``mode='delete'`` is specified.
��insert�ensurer� r� N�.Mode was not defined. How to process the file?zUnknown mode: r� z+Content can only be empty if mode is delete�r� r� z&Cannot find text to %s. File is empty.c s g | ]
}|� d kr|�qS )r r rQ )rQ r r r� J s z _set_line.<locals>.<listcomp>r� r re zFOn insert either "location" or "before/after" conditions are required.�endre �startr� r� r� �
z)Neither before or after was found in filerf c 3 s � | ] }|� � � kV qd S r )r~ rQ )�contentr r r � s � z _set_line.<locals>.<genexpr>� zAFound more than one line between boundaries "before" and "after".z\Wrong conditions? Unable to ensure line without knowing where to put it before and/or after.)r rV �log�warning�indexr� re r` r@ rc r rb r[ r� r6 r) )rB rl rQ ry �locationr� r� r^ �idxZ
original_line�first�lastZ next_line� prev_lineZ after_indexZ before_indexZ
already_thereZ is_last_liner )rl rQ r � _set_line� s� F�
e �c �
_
��T
�R�O �M�
F�
"� >�
8�
�*�
�#�� �
����
��
��rv c C sN t j�t j�| ��} t j�| �s | std| � d���dS |r"|�� p#|}|dvr8|du r0td��td|� d���d g} || vrM|du rMtd
�d �| ����~ |du rZ|du rZ|sZ|}t j
j j | d d
��} t j
j
�| �� �}
W d � n1 sww Y t�t j
j�d�|
����� }|
r�t|
d �r�|
�d� t �| �jdkr�|dv r�t�d|| � g }
t|
|||||||
d�}
|
r�t |
�D ]!\}}t|�s�|d t |
�k r�|r�|d p�d}t |
| |�|
|< q�d|
d kr�|
� � |t�t j
j�d�|
����� k}|�r7|�r7t d du �r7zt!| dd�}t"�#|d�| t$�%dt$�&� ��� W n t'�y6 } ztd�| |���d}~ww d}|�r�|�rkt j
j � | d ��} t j
j
�| �(� �)d��}W d � n 1 �s_w Y t*d ||
�}t d du �r�d}z!d }t j
j
j|
dd �}
t j
j+�,| |�}|�-|
� W |�r�|�.� n |�r�|�.� w w |�r�|�p�|S ) a�
.. versionadded:: 2015.8.0
Line-focused editing of a file.
.. note::
``file.line`` exists for historic reasons, and is not
generally recommended. It has a lot of quirks. You may find
``file.replace`` to be more suitable.
``file.line`` is most useful if you have single lines in a file
(potentially a config file) that you would like to manage. It can
remove, add, and replace a single line at a time.
path
Filesystem path to the file to be edited.
content
Content of the line. Allowed to be empty if ``mode='delete'``.
match
Match the target line for an action by
a fragment of a string or regular expression.
If neither ``before`` nor ``after`` are provided, and ``match``
is also ``None``, match falls back to the ``content`` value.
mode
Defines how to edit a line. One of the following options is
required:
- ensure
If line does not exist, it will be added. If ``before``
and ``after`` are specified either zero lines, or lines
that contain the ``content`` line are allowed to be in between
``before`` and ``after``. If there are lines, and none of
them match then it will produce an error.
- replace
If line already exists, the entire line will be replaced.
- delete
Delete the line, if found.
- insert
Nearly identical to ``ensure``. If a line does not exist,
it will be added.
The differences are that multiple (and non-matching) lines are
alloweed between ``before`` and ``after``, if they are
specified. The line will always be inserted right before
``before``. ``insert`` also allows the use of ``location`` to
specify that the line should be added at the beginning or end of
the file.
.. note::
If ``mode='insert'`` is used, at least one of ``location``,
``before``, or ``after`` is required. If ``location`` is used,
``before`` and ``after`` are ignored.
location
In ``mode='insert'`` only, whether to place the ``content`` at the
beginning or end of a the file. If ``location`` is provided,
``before`` and ``after`` are ignored. Valid locations:
- start
Place the content at the beginning of the file.
- end
Place the content at the end of the file.
before
Regular expression or an exact case-sensitive fragment of the string.
Will be tried as **both** a regex **and** a part of the line. Must
match **exactly** one line in the file. This value is only used in
``ensure`` and ``insert`` modes. The ``content`` will be inserted just
before this line, with matching indentation unless ``indent=False``.
after
Regular expression or an exact case-sensitive fragment of the string.
Will be tried as **both** a regex **and** a part of the line. Must
match **exactly** one line in the file. This value is only used in
``ensure`` and ``insert`` modes. The ``content`` will be inserted
directly after this line, unless ``before`` is also provided. If
``before`` is not provided, indentation will match this line, unless
``indent=False``.
show_changes
Output a unified diff of the old file and the new file.
If ``False`` return a boolean if any changes were made.
Default is ``True``
.. note::
Using this option will store two copies of the file in-memory
(the original version and the edited version) in order to generate the diff.
backup
Create a backup of the original file with the extension:
"Year-Month-Day-Hour-Minutes-Seconds".
quiet
Do not raise any exceptions. E.g. ignore the fact that the file that is
tried to be edited does not exist and nothing really happened.
indent
Keep indentation with the previous line. This option is not considered when
the ``delete`` mode is specified. Default is ``True``
CLI Example:
.. code-block:: bash
salt '*' file.line /etc/nsswitch.conf "networks: files dns" after="hosts:.*?" mode='ensure'
.. note::
If an equal sign (``=``) appears in an argument to a Salt command, it is
interpreted as a keyword argument in the format of ``key=val``. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.. code-block:: bash
salt '*' file.line /path/to/file content="CREATEMAIL_SPOOL=no" match="CREATE_MAIL_SPOOL=yes" mode="replace"
**Examples:**
Here's a simple config file.
.. code-block:: ini
[some_config]
# Some config file
# this line will go away
here=False
away=True
goodybe=away
.. code-block:: bash
salt \* file.line /some/file.conf mode=delete match=away
This will produce:
.. code-block:: ini
[some_config]
# Some config file
here=False
away=True
goodbye=away
If that command is executed 2 more times, this will be the result:
.. code-block:: ini
[some_config]
# Some config file
here=False
If we reset the file to its original state and run
.. code-block:: bash
salt \* file.line /some/file.conf mode=replace match=away content=here
Three passes will this state will result in this file:
.. code-block:: ini
[some_config]
# Some config file
here
here=False
here
here
Each pass replacing the first line found.
Given this file:
.. code-block:: text
insert after me
something
insert before me
The following command
.. code-block:: bash
salt \* file.line /some/file.txt mode=insert after="insert after me" before="insert before me" content=thrice
If that command is executed 3 times, the result will be:
.. code-block:: text
insert after me
something
thrice
thrice
thrice
insert before me
If the mode is ``ensure`` instead, it will fail each time. To succeed, we
need to remove the incorrect line between before and after:
.. code-block:: text
insert after me
insert before me
With an ensure mode, this will insert ``thrice`` the first time and
make no changes for subsequent calls. For something simple this is
fine, but if you have instead blocks like this:
.. code-block:: text
Begin SomeBlock
foo = bar
End
Begin AnotherBlock
another = value
End
And you try to use ensure this way:
.. code-block:: bash
salt \* file.line /tmp/fun.txt mode="ensure" content="this = should be my content" after="Begin SomeBlock" before="End"
This will fail because there are multiple ``End`` lines. Without that
problem, it still would fail because there is a non-matching line,
``foo = bar``. Ensure **only** allows either zero, or the matching
line present to be present in between ``before`` and ``after``.
zFile "z#" does not exists or is not a file.Frd Nrg zUnknown mode: "�"r� z)Content can only be empty if mode is "{}"r� r )ry r3 re r rh z+Cannot find text to %s. File '%s' is empty.)rB rl rQ ry rq r� r� r^ r� �testTr0 z{}.{}z%Y-%m-%d-%H-%M-%Sz5Unable to create the backup file of {}. Exception: {}r5 r )rN )/r r r7 rh r� r r� r� r r r r" r �dataZ decode_list� readlines�hashlibr� rM �to_bytes� hexdigestra r@ �stat�st_sizern ro rv � enumerater� rc r� r' r: r r; �time�strftime� localtimer� r r> r4 �
atomicfile� atomic_open�
writelines�close)r rl rQ ry rq r� r� � show_changesr �quietr^ Zempty_content_modes�fp_�bodyZ body_beforerr r� �prev�changedrF rB Z changes_diffZ path_content�fh_r r r r� � s�
���� ���
� � �� ������ � ��
�r� r} c + C s d}t | �rd}tjj�| �}tj�| �}tj�tj�| ��} tj�| �s0|
r)dS t d| � ���t
d | �s=t d| � ���| rG|sC|rGt d��|rO|rOt d��t |�}t �
tjj�|�|�}tj�| �}|dkrj|}d}g }g }tjj�� s�t| �}t| �}tjj�t| ��}tjj�t|��}|r�tjj�|�}d} d } |r�|s�|r�tjj�|�ntjj�|�} �z z�d } tjjj| d
|d ���} z
tj| � � d tj d
�} W n t t fy� d� | �} Y nw | �r#t �!|| ��r W d � W W | �rt"| tj��r| �#� dS dS dS W d � W W | �r t"| tj��r!| �#� dS dS dS t �$||�r/|�%dd�n|| |�\}!}"|"d k�rFd} ||k�rDdn|}|�sL|�rct j!tjj�dt �&| �� d��| |d��rcd} t"| tj��rr| �'|��(d�n| �(d�}|!�(d�}||k�r�d}W d � n 1 �s�w Y W n t �y� }# z
t)d| � d|#� ���d }#~#ww W | �r�t"| tj��r�| �#� n| �r�t"| tj��r�| �#� w w w |�r�|
�s�zt*| |d�} W n t �y� }# zt)d|#� ���d }#~#ww d } z�tjjj| d|d ���}$z�z^tjjj| d|d ��I} tj| � � d tj d
�} t �$||�r"|�%dd�n|| |�\}!}"z |$�+tjj�,|!�� W n t �yK }# z t)d�-| | |#���d }#~#ww W d � n 1 �sWw Y W n t �yq }# zt)d|#� ���d }#~#ww W | �r�t"| tj��r�| �#� n| �r�t"| tj��r�| �#� w w w W d � n 1 �s�w Y W n t �y� }# zt)d|#� ���d }#~#ww | �sQ|�s�|�rQ|d u �r�|}|�r�|�.d |tjj�tj/� � n0d t0|�k�r�|d �1tjj�tj/���s�|d tjj�tj/�7 < |�2|tjj�tj/� � d}|
�sQzt*| |d�} W n t �y, }# zt)d|#� ���d }#~#ww z tjj3�4| d �}%|D ]
}&|%�+tjj�|&�� �q8W |%�#� n|%�#� w | �r�|�r�|
�s�| � | � �}'zt5�6| |'� W n t �y~ }# z t)d �-| | |#���d }#~#ww |�r�|� | � �}(|� | � �})zt�7|)|(� W nH t �y� t�8|(� t�7|)|(� Y n4 t9�y� t)d �-|(|)|#���w n"| �r�zt�8| � W n t �y� }# z
t)d | � d|#� ���d }#~#ww |
�s�tjj�� �s�t:| d |||� t
d ||�}*| �r�|*S |*�sd}|S )!a~
.. versionadded:: 0.17.0
Replace occurrences of a pattern in a file. If ``show_changes`` is
``True``, then a diff of what changed will be returned, otherwise a
``True`` will be returned when changes are made, and ``False`` when
no changes are made.
This is a pure Python implementation that wraps Python's :py:func:`~re.sub`.
path
Filesystem path to the file to be edited. If a symlink is specified, it
will be resolved to its target.
pattern
A regular expression, to be matched using Python's
:py:func:`~re.search`.
repl
The replacement text
count: 0
Maximum number of pattern occurrences to be replaced. If count is a
positive integer ``n``, only ``n`` occurrences will be replaced,
otherwise all occurrences will be replaced.
flags (list or int)
A list of flags defined in the ``re`` module documentation from the
Python standard library. Each list item should be a string that will
correlate to the human-friendly flag name. E.g., ``['IGNORECASE',
'MULTILINE']``. Optionally, ``flags`` may be an int, with a value
corresponding to the XOR (``|``) of all the desired flags. Defaults to
8 (which supports 'MULTILINE').
bufsize (int or str)
How much of the file to buffer into memory at once. The
default value ``1`` processes one line at a time. The special value
``file`` may be specified which will read the entire file into memory
before processing.
append_if_not_found: False
.. versionadded:: 2014.7.0
If set to ``True``, and pattern is not found, then the content will be
appended to the file.
prepend_if_not_found: False
.. versionadded:: 2014.7.0
If set to ``True`` and pattern is not found, then the content will be
prepended to the file.
not_found_content
.. versionadded:: 2014.7.0
Content to use for append/prepend if not found. If None (default), uses
``repl``. Useful when ``repl`` uses references to group in pattern.
backup: .bak
The file extension to use for a backup of the file before editing. Set
to ``False`` to skip making a backup.
dry_run: False
If set to ``True``, no changes will be made to the file, the function
will just return the changes that would have been made (or a
``True``/``False`` value if ``show_changes`` is set to ``False``).
search_only: False
If set to true, this no changes will be performed on the file, and this
function will simply return ``True`` if the pattern was matched, and
``False`` if not.
show_changes: True
If ``True``, return a diff of changes made. Otherwise, return ``True``
if changes were made, and ``False`` if not.
.. note::
Using this option will store two copies of the file in memory (the
original version and the edited version) in order to generate the
diff. This may not normally be a concern, but could impact
performance if used with large files.
ignore_if_missing: False
.. versionadded:: 2015.8.0
If set to ``True``, this function will simply return ``False``
if the file doesn't exist. Otherwise, an error will be thrown.
preserve_inode: True
.. versionadded:: 2015.8.0
Preserve the inode of the file, so that any hard links continue to
share the inode with the original filename. This works by *copying* the
file, reading from the copy, and writing to the file at the original
inode. If ``False``, the file will be *moved* rather than copied, and a
new file will be written to a new inode, but using the original
filename. Hard links will then share an inode with the backup, instead
(if using ``backup`` to create a backup copy).
backslash_literal: False
.. versionadded:: 2016.11.7
Interpret backslashes as literal backslashes for the repl and not
escape characters. This will help when using append/prepend so that
the backslashes are not interpreted for the repl on the second run of
the state.
If an equal sign (``=``) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format ``key=val``. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.. code-block:: bash
salt '*' file.replace /path/to/file pattern='=' repl=':'
salt '*' file.replace /path/to/file pattern="bind-address\s*=" repl='bind-address:'
CLI Examples:
.. code-block:: bash
salt '*' file.replace /etc/httpd/httpd.conf pattern='LogLevel warn' repl='LogLevel info'
salt '*' file.replace /some/file pattern='before' repl='after' flags='[MULTILINE, IGNORECASE]'
FTr) r2 r* z;search_only cannot be used with append/prepend_if_not_foundz8Only one of append and prepend_if_not_found is permittedr� Nr+ r, r )�access� � \s \\r' z
($|(?=
))r r. r/ r0 r2 r r r3 re �wbr4 zAUnable create backup symlink '{}'. Target was '{}'. Exception: {}z Unable to delete temp file 'r5 );�is_linkr r r �readlinkr rh r7 r* r r4 rM rK r rM r| r8 r r rt rm r" r9 rz rA r
r �mmap�filenoZ ACCESS_READrV r� r rL r_ r� �subnr� �escaper r> r r: r rN r� re rb r� r? r@ r� r� r r; �symlinkr+ r� r< )+r r� �replr r� r@ �append_if_not_found�prepend_if_not_foundZnot_found_contentr �dry_run� search_onlyr� �ignore_if_missingr1 Zbackslash_literalr� � target_pathZ
given_path�re_flagsZcpatternZfilesize� has_changesr> r? rC rD rE r= rF rl Zr_datarA r- ZnreplrB rG r� r� rH Zsymlink_backupZ
target_backup� differencesr r r r� s� � �� ��� ���4 ���4 ���
��
��
� ��1�����
� ����
���� �������
�� ����
�� ����
���
������r� �#-- start managed zone --�#-- end managed zone --c " s� ||t |
�t | �g} t| �dkrtd��tj�| �} tj�| �s'td| � ���ztd | �}
W n ty: d}
Y nw td | �rJ|
sJtd| � ���|
sN| re|
rZt |
t
�sYtd��n | ret | t
�setd ��� du rs|� tj d
f�ssd � g �|�
d �D ]}|�
d
�D ]}��|� q�qzt���d
}g }g }d
}d
}d}d%� ����fdd� }z�zmtjjj| d|
dd��W}|D ]L}d }|du r�|� d �r�d }n |� d
�r�d
}ntj }�|v r�d }n |r�d
}|���}|dkr�d
}d }|||d
||d� d� |�|� |�r|�|� q�W d � n 1 �s
w Y W n t�y* } z
td| � d|� ���d}~ww W |du �r4tj }z|�� W n# t�yD Y nw |du �rMtj }z|�� W w t�y] Y w w |�retd��|�s�|�ry||�} | �|� | }d }n_|�r�|�r�|d � |��s�|d |7 < |||d� d }n@|
�s�| �r�|
�p�| ��fdd�t|�D �} | �r�| d } ||�D ]}| �r�| d7 } |�| |� |
�r�| d7 } �q�d }ntd ��|�r6td ||�} | dk}|�r6|�s6i } t| �| d < t | �| d < tjj� t | ��| d < |d
u�r6| � |� �} t � | | � tjj!�"� �r't#| d| d d!� nt#| d| d | d | d d"� |�s=td ��td ||�} | dk}|�r�|�s�i } t| �| d < t | �| d < tjj� t | ��| d < |d
u�r�| � |� �} t � | | � tjj!�"� �r�t#| d| d d!� nt#| d| d | d | d � z tjj$�%| d#�}!|D ]}|!�&tjj'j(||
d$�� �q�W |!�� n|!�� w tjj!�"� �r�t#| d| d d!� nt#| d| d | d | d � |�r�| S |S )&a�
.. versionadded:: 2014.1.0
Replace content of a text block in a file, delimited by line markers
A block of content delimited by comments can help you manage several lines
entries without worrying about old entries removal.
.. note::
This function will store two copies of the file in-memory (the original
version and the edited version) in order to detect changes and only
edit the targeted file if necessary.
path
Filesystem path to the file to be edited
marker_start
The line content identifying a line as the start of the content block.
Note that the whole line containing this marker will be considered, so
whitespace or extra content before or after the marker is included in
final output
marker_end
The line content identifying the end of the content block. As of
versions 2017.7.5 and 2018.3.1, everything up to the text matching the
marker will be replaced, so it's important to ensure that your marker
includes the beginning of the text you wish to replace.
content
The content to be used between the two lines identified by marker_start
and marker_stop.
append_if_not_found: False
If markers are not found and set to ``True`` then, the markers and
content will be appended to the file.
prepend_if_not_found: False
If markers are not found and set to ``True`` then, the markers and
content will be prepended to the file.
insert_before_match
If markers are not found, this parameter can be set to a regex which will
insert the block before the first found occurrence in the file.
.. versionadded:: 3001
insert_after_match
If markers are not found, this parameter can be set to a regex which will
insert the block after the first found occurrence in the file.
.. versionadded:: 3001
backup
The file extension to use for a backup of the file if any edit is made.
Set to ``False`` to skip making a backup.
dry_run: False
If ``True``, do not make any edits to the file and simply return the
changes that *would* be made.
show_changes: True
Controls how changes are presented. If ``True``, this function will
return a unified diff of the changes made. If False, then it will
return a boolean (``True`` if any changes were made, otherwise
``False``).
append_newline: False
Controls whether or not a newline is appended to the content block. If
the value of this argument is ``True`` then a newline will be added to
the content block. If it is ``False``, then a newline will *not* be
added to the content block. If it is ``None`` then a newline will only
be added to the content block if it does not already end in a newline.
.. versionadded:: 2016.3.4
.. versionchanged:: 2017.7.5,2018.3.1
New behavior added when value is ``None``.
.. versionchanged:: 2019.2.0
The default value of this argument will change to ``None`` to match
the behavior of the :py:func:`file.blockreplace state
<salt.states.file.blockreplace>`
CLI Example:
.. code-block:: bash
salt '*' file.blockreplace /etc/hosts '#-- start managed zone foobar : DO NOT EDIT --' \
'#-- end managed zone foobar --' $'10.0.1.1 foo.foobar\n10.0.1.2 bar.foobar' True
r� zoOnly one of append_if_not_found, prepend_if_not_found, insert_before_match, and insert_after_match is permittedr) zfiles.get_encodingNzfiles.is_binaryr* z0RegEx expected in insert_before_match parameter.z/RegEx expected in insert_after_match parameter.r< Trk Fc s� |d u rg }d}|d u r�}|� d�| }|r |��| � �rNt�d�D ]&\}}|�kr5|�|| � q%� rD|�|| � |�|� q%|�|| � q%|S |�|� |S )NTrk r� )r6 r@ r� )rb rB �include_marker_start�end_linerp � content_line)�append_newline�
line_count�
marker_end� marker_start�
split_contentr r � _add_contentB s&
�z"blockreplace.<locals>._add_contentr r3 )�encoding�newlinere )rB r� r� zFailed to read from �: zAUnterminated marked block. End of file reached before marker_end.)rB c s g | ] \}}t �� |�r|�qS r )rK rL r� )� match_regexr r r� � s
��z blockreplace.<locals>.<listcomp>r z9Cannot edit marked block. Markers were not found in file.r5 rs rO ry )r r/ �owner)�namer/ rs rO ry r� )r� )NTN))r� �sumr r r rh r* r4 r r_ rA r? rb r� r@ r� r r r" r r� r� r� r� r� r� re rt rm r9 rz r r r r r< r� r� r rM r| )"r r� r� rl r� r� r r� r� r� Zinsert_before_matchZinsert_after_matchZexclusive_params�
file_encodingZwin_liner� r� r> r? Zin_blockZ block_foundrb r� Zfi_filer� Zwrite_line_to_new_fileZmarker_end_posrB Zprepended_contentZ match_idx�diff�permsZ backup_pathr� r )r� r� r� r� r� r� r � blockreplace�
sx i� � � �
��
� � �
�
�� ��,���
�
� ��
� ���
��
� � r� c C sB |rt |d�}nt|�}tjj|v rd}t| |d||ddd|d� S )a�
.. versionadded:: 0.17.0
Search for occurrences of a pattern in a file
Except for multiline, params are identical to
:py:func:`~salt.modules.file.replace`.
multiline
If true, inserts 'MULTILINE' into ``flags`` and sets ``bufsize`` to
'file'.
.. versionadded:: 2015.8.0
CLI Example:
.. code-block:: bash
salt '*' file.search /etc/crontab 'mymaintenance.sh'
� MULTILINEr� r3 TF)r� r@ r� r� r� r� )rN rM rK rI r� r� )r r� r� r@ r� Z multiliner� r r r rL s �rL c C s0 t jj�d�}|s
td��|g}|�t jj�|�� |r-td dv r(|� d� n|� d� d|vr:d|vr:|� d� d }|D ]}|d
ksN|�
d �sN|�
d �rRd
} nq>|sZ|� d� |�d|g� t j� | �r�|�d| g� d }|D ]}|�
d�s~|�
d�r�d
} nqr|s�|� d� n|� | � t
d |d d�S )a!
.. versionadded:: 0.10.4
Apply a patch to a file or directory.
Equivalent to:
.. code-block:: bash
patch <options> -i <patchfile> <originalfile>
Or, when a directory is patched:
.. code-block:: bash
patch <options> -i <patchfile> -d <originalfile> -p0
originalfile
The full path to the file or directory to be patched
patchfile
A patch file to apply to ``originalfile``
options
Options to pass to patch.
.. note::
Windows now supports using patch as of 3004.
In order to use this function in Windows, please install the
patch binary through your own means and ensure it's found
in the system Path. If installing through git-for-windows,
please select the optional "Use Git and optional Unix tools
from the Command Prompt" option when installing Git.
CLI Example:
.. code-block:: bash
salt '*' file.patch /opt/file.txt /tmp/file.txt.patch
salt '*' file.patch C:\file1.txt C:\file3.patch
�patchzJpatch executable not found. Is the distribution's patch package installed?Zkernel)ZFreeBSDZOpenBSDz-Cz --dry-runz-Nz --forwardFr� z-r z
--reject-fileTz--reject-file=-r� z-dz-pz--strip=z --strip=0r� r� )r r r rI r r� r� r� Z
__grains__r@ r r �isdirr: ) Z originalfileZ patchfiler r� Z patchpathrP Zhas_rejectfile_option�optionZhas_strip_optionr r r r� F sN *�
���
�
�
r� c C s� t j�| �} t j�| �sdS t|��� }z/tjj� | �� }|D ]}||v r/ W d � W dS q W d � W dS 1 s<w Y W dS t
yM Y dS w )z�
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the file at ``path`` contains ``text``
CLI Example:
.. code-block:: bash
salt '*' file.contains /etc/crontab 'mymaintenance.sh'
FNT) r r rh r* rA r� r r �
filebuffer�BufferedReaderr� )r r Z
stripped_text�breader�chunkr r r �contains� s&
��
�� �r� c C s� t j�| �} t j�| �sdS zAtjj�| d��.}|D ] }tjj� |�}|r*|�
|�}t � ||�r: W d � W dS q W d � W dS 1 sHw Y W dS t
yY Y dS w )a�
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the given regular expression matches on any line in the text
of a given file.
If the lchar argument (leading char) is specified, it
will strip `lchar` from the left side of each line before trying to match
CLI Example:
.. code-block:: bash
salt '*' file.contains_regex /etc/crontab
Fr NT)r r rh r* r r r" r rM r
r~ rK rL r� )r r! ZlcharrX r� r r r �contains_regex� s$
�(� �r� c C s� t j�| �} t j�| �sdS z2tjj�| �� }|D ]}t�||�r+ W d � W dS q W d � W dS 1 s9w Y W dS t yJ Y dS w )z�
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the given glob matches a string in the named file
CLI Example:
.. code-block:: bash
salt '*' file.contains_glob /etc/foobar '*cheese*'
FNT)
r r rh r* r r r� r� �fnmatchr� )r Z glob_exprr� r� r r r �
contains_glob� s
�(� �r� c O sb t j�| �} d|v rt|d t�r|d }n|d g}tjj�| d��O}tjj �
t j �}z |� t
|� t j� W n tyU } z|jtjtjfv rJn� W Y d}~nd}~ww |�t
|��|krk|� dt j� |�|� W d � n1 suw Y tjj�| d�� }|D ]}|�tjj �|� t j � ��� q�W d � n1 s�w Y dt
|�� d| � d�S ) a�
.. versionadded:: 0.9.5
Append text to the end of a file
path
path to file
`*args`
strings to append to file
CLI Example:
.. code-block:: bash
salt '*' file.append /etc/motd \
"With all thine offerings thou shalt offer salt." \
"Salt is what makes things taste bad when it isn't in them."
.. admonition:: Attention
If you need to pass a string to append and that string contains
an equal sign, you **must** include the argument name, args.
For example:
.. code-block:: bash
salt '*' file.append /etc/motd args='cheese=spam'
salt '*' file.append /etc/motd args="['cheese=spam','spam=cheese']"
r� �rb+Nr �a�Wrote � lines to "rw )r r rh r_ �listr r r" r rM r| rb �seekr� �SEEK_ENDr� �errno�EINVALZESPIPEr r rN )r r� r� r rb rB Znew_liner r r r@
s6 !
���
� � � �r@ c O s t j�| �} d|v rt|d t�r|d }n|d g}z"tjj�| ��}dd� |� � D �}W d � n1 s7w Y W n t
yH g }Y nw g }|D ]
}|� |� d�� qMtjj�| d��}|| }|� tjj
�d�|��� W d � n1 s|w Y dt|�� d | � d
�S ) a�
.. versionadded:: 2014.7.0
Prepend text to the beginning of a file
path
path to file
`*args`
strings to prepend to the file
CLI Example:
.. code-block:: bash
salt '*' file.prepend /etc/motd \
"With all thine offerings thou shalt offer salt." \
"Salt is what makes things taste bad when it isn't in them."
.. admonition:: Attention
If you need to pass a string to append and that string contains
an equal sign, you **must** include the argument name, args.
For example:
.. code-block:: bash
salt '*' file.prepend /etc/motd args='cheese=spam'
salt '*' file.prepend /etc/motd args="['cheese=spam','spam=cheese']"
r� c S s g | ] }t jj�|��qS r )r r rM r
rQ r r r r� p
s �zprepend.<locals>.<listcomp>Nr< r r3 z
Prepended r� rw )r r rh r_ r� r r r" r rz r� r@ r rM rN r r� )r r� r� Zfhr�contentsZprefacer� r r r r �prependE
s. !
� �� � �r� c O s� t j�| �} d|v rt|d t�r|d }n|d g}g }|D ]
}|�|� d�� q tjj� | d��}|�
tjj � d�
|��� W d � n1 sJw Y dt|�� d| � d�S ) a�
.. versionadded:: 2014.7.0
Write text to a file, overwriting any existing contents.
path
path to file
`*args`
strings to write to the file
CLI Example:
.. code-block:: bash
salt '*' file.write /etc/motd \
"With all thine offerings thou shalt offer salt."
.. admonition:: Attention
If you need to pass a string to append and that string contains
an equal sign, you **must** include the argument name, args.
For example:
.. code-block:: bash
salt '*' file.write /etc/motd args='cheese=spam'
salt '*' file.write /etc/motd args="['cheese=spam','spam=cheese']"
r� r< r r3 Nr� r� rw )r r rh r_ r� r@ r r r" r r rM rN r r� )r r� r� r� r� r r r r r �
s
�r c
C s& t j�| �} |rt|��� rt|�}|r t|��� r t|�}zSt j�| �s=tjj �
| d�� W d � n1 s8w Y |du rH|du rHd}n"|du rW|durW|t � � f}n|du rf|durft � � |f}n||f}t � | |� W n t
y| td�� ty� } zt|j��d}~ww t j�| �S )a�
.. versionadded:: 0.9.5
Just like the ``touch`` command, create a file if it doesn't exist or
simply update the atime and mtime if it already does.
atime:
Access time in Unix epoch time. Set it to 0 to set atime of the
file with Unix date of birth. If this parameter isn't set, atime
will be set with current time.
mtime:
Last modification in Unix epoch time. Set it to 0 to set mtime of
the file with Unix date of birth. If this parameter isn't set,
mtime will be set with current time.
CLI Example:
.. code-block:: bash
salt '*' file.touch /var/log/emptyfile
r� Nz atime and mtime must be integers)r r rh rA �isdigitrU r* r r r" r r� �utimer� r r� r �strerror)r� �atime�mtime�timesrB r r r �touch�
s2 �
�� r� c C sZ t j�| �} t �| t j�}zt �|t|�d� t �|t|��}W t �|� |S t �|� w )a.
.. versionadded:: 2014.1.0
Seek to a position on a file and read it
path
path to file
seek
amount to read at once
offset
offset to start into the file
CLI Example:
.. code-block:: bash
salt '*' file.seek_read /path/to/file 4096 0
r ) r r rh �open�O_RDONLY�lseekrU r r� )r �size�offset�seek_fhry r r r � seek_read�
s
�r� c C s` t j�| �} t �| t j�}z t �|t|�d� t �||�}t �|� W t � |� |S t � |� w )a@
.. versionadded:: 2014.1.0
Seek to a position on a file and write to it
path
path to file
data
data to write to file
offset
position in file to start writing
CLI Example:
.. code-block:: bash
salt '*' file.seek_write /path/to/file 'some data' 4096
r )
r r rh r� �O_WRONLYr� rU r �fsyncr� )r ry r� r� r/ r r r �
seek_write s
�r� c C sP t j�| �} tjj�| d��}|�t|�� W d � dS 1 s!w Y dS )a
.. versionadded:: 2014.1.0
Seek to a position on a file and delete everything after that point
path
path to file
length
offset into file to truncate
CLI Example:
.. code-block:: bash
salt '*' file.truncate /path/to/file 512
r� N) r r rh r r r" r �truncaterU )r �lengthr� r r r r� " s "�r� c
C s` t j�| �} t j�| �std��z t �| |� W dS ty/ } z
td|� d|� ���d}~ww )z�
.. versionadded:: 2014.1.0
Create a hard link to a file
CLI Example:
.. code-block:: bash
salt '*' file.link /path/to/file /path/to/link
�File path must be absolute.T�Could not create '�': N)r r rh r� r �linkr� r )rU r �Er r r r� 9 s ��r� c C s t tj�| ��}|o|d dkS )z�
Check if the path is a hard link by verifying that the number of links
is larger than 1
CLI Example:
.. code-block:: bash
salt '*' file.is_hardlink /path/to/link
�st_nlinkr� )�lstatr r rh )r �resr r r � is_hardlinkR s r� c C � t j�t j�| ��S )z�
Check if the path is a symbolic link
CLI Example:
.. code-block:: bash
salt '*' file.is_link /path/to/link
)r r �islinkrh �r r r r r� d s r� c C s� t j�|�}t j�|�std|� ���t j�|�rMz t j�tjj� |��t j�| �kr5t
� d|| � W dS W n t y? Y nw |sM|sMd|� �}t
|��t j�|�r`|s`|s`d|� �}t
|��t j�|�slt j�|�rv|rv|svt �|� nL|r�t j�|�}d}|dk r�tj|d�}zt �| |� W n ty� |d 7 }Y nw |dk s�z t �||� W dS t y� t �|� t
d
|� d ���w z t �| |� W dS t y� t
d
|� d ���w ) ay
Create a symbolic link (symlink, soft link) to a file
Args:
src (str): The path to a file or directory
path (str): The path to the link. Must be an absolute path
force (bool):
Overwrite an existing symlink with the same name
.. versionadded:: 3005
atomic (bool):
Use atomic file operations to create the symlink
.. versionadded:: 3006.0
Returns:
bool: ``True`` if successful, otherwise raises ``CommandExecutionError``
CLI Example:
.. code-block:: bash
salt '*' file.symlink /path/to/file /path/to/link
z Link path must be absolute: z'link already in correct state: %s -> %sTzFound existing symlink: z Existing path is not a symlink: r � )�dirr� r� r� )r r rh r� r r� �normpathr r r� rn �debugr� r r* �unlink�dirnamer Zmktempr� �FileExistsErrorr� r+ )rU r �forceZatomicrZ Zlink_dirZretryZ temp_linkr r r r� v s^ �� �
��
� �r� c C sd t j�| �} t j�|�}t j�| �std��z t �| |� W dS ty1 td| � d|� d���w )z�
Rename a file or directory
CLI Example:
.. code-block:: bash
salt '*' file.rename /path/to/src /path/to/dst
r� TzCould not rename '�' to 'r� )r r rh r� r �renamer� r )rU �dstr r r r� � s
�r� c C s6 t j�| �} t j�|�}t j�| �std��t j�| �s$td| � d���tjj �
� s;t | �}t | �}tjj
�t| ��}z=t j�|�rHt j�|�sNt j�| �rq|sTtd��|rht j�|�rat�|� t�| |� ntjj
�| |� nt�| |� W n ty� td| � d|� d���w tjj �
� s�t|d|||� dS ) a�
Copy a file or directory from source to dst
In order to copy a directory, the recurse flag is required, and
will by default overwrite files in the destination with the same path,
and retain all other existing files. (similar to cp -r on unix)
remove_existing will remove all files in the target directory,
and then copy files from the source.
.. note::
The copy function accepts paths that are local to the Salt minion.
This function does not support salt://, http://, or the other
additional file paths that are supported by :mod:`states.file.managed
<salt.states.file.managed>` and :mod:`states.file.recurse
<salt.states.file.recurse>`.
CLI Example:
.. code-block:: bash
salt '*' file.copy /path/to/src /path/to/dst
salt '*' file.copy /path/to/src_dir /path/to/dst_dir recurse=True
salt '*' file.copy /path/to/src_dir /path/to/dst_dir recurse=True remove_existing=True
r� zNo such file or directory 'r� zECannot copy overwriting a directory without recurse flag set to true!zCould not copy 'r� NT)r r rh r� r r* r r r r r rt rm r" r9 rz r� r �rmtree�copytreeZrecursive_copy�copyfiler� r< )rU r� �recurseZremove_existingrC rD rE r r r �copy� s: $�
� � r� c sV t j�| �} t j�| �std��zt �| �� � fdd�dD �W S ty* i Y S w )z�
.. versionadded:: 2014.1.0
Returns the lstat attributes for the given file or dir. Does not support
symbolic links.
CLI Example:
.. code-block:: bash
salt '*' file.lstat /path/to/file
z Path to file must be absolute.c � i | ]}|t � |��qS r �rJ �r �key��lstr r �
<dictcomp>. �
��zlstat.<locals>.<dictcomp>)�st_atime�st_ctime�st_gid�st_mode�st_mtimer� r �st_uid)r r rh r� r r� r� r� r r r r� s
�
�r� c C sn t j�| �} t j�| �std��t jt jt jt jd�}||v r't � | || �S ||�
� v r3t � | |�S td��)a�
.. versionadded:: 2014.1.0
Test whether the Salt process has the specified access to the file. One of
the following modes must be specified:
.. code-block:: text
f: Test the existence of the path
r: Test the readability of the path
w: Test the writability of the path
x: Test whether the path can be executed
CLI Example:
.. code-block:: bash
salt '*' file.access /path/to/file f
salt '*' file.access /path/to/file x
z Path to link must be absolute.)r� r r r� zInvalid mode specified.) r r rh r� r �F_OK�R_OK�W_OK�X_OKr� r( )r ry �modesr r r r� ? s r� c C sx d}|du r
|d7 }t jj�| |�� }|du r"|�� W d � S t jj�|�� �W d � S 1 s5w Y dS )z�
.. versionadded:: 2017.7.0
Return the content of the file.
:param bool binary:
Whether to read and return binary data
CLI Example:
.. code-block:: bash
salt '*' file.read /path/to/file
r T�bN)r r r" r r rM r
)r �binaryZ access_modeZfile_objr r r r c s �$�r c
C s� t j�| �} t j�| �} t j�| �std| � ���t j�| �s&td| � ���|r.t j�| �S ztj j�
| �W S t yU } z|j t j
krKtd| � ���tt|���d}~ww )ae
.. versionadded:: 2014.1.0
Return the path that a symlink points to
Args:
path (str):
The path to the symlink
canonicalize (bool):
Get the canonical path eliminating any symbolic links encountered in
the path
Returns:
str: The path that the symlink points to
Raises:
SaltInvocationError: path is not absolute
SaltInvocationError: path is not a link
CommandExecutionError: error reading the symbolic link
CLI Example:
.. code-block:: bash
salt '*' file.readlink /path/to/link
z Path to link must be absolute: z A valid link was not specified: zNot a symbolic link: N)r r rh �
expandvarsr� r r� r7 r r r� r� r� r� r rA )r Z canonicalizerB r r r r� | s ! ��r� c C sP t j�| �} t j�| �std��t j�| �std��ddg}|�t �| �� |S )z�
.. versionadded:: 2014.1.0
Return a list containing the contents of a directory
CLI Example:
.. code-block:: bash
salt '*' file.readdir /path/to/dir/
zDir path must be absolute.�$A valid directory was not specified.�.z..)r r rh r� r r� r� �listdir)r Zdirentsr r r �readdir� s r c s^ t j�| �} t j�| �std��zt �| �� � fdd�dD �W S ty. td| � d���w )z�
.. versionadded:: 2014.1.0
Perform a statvfs call against the filesystem that the file resides on
CLI Example:
.. code-block:: bash
salt '*' file.statvfs /path/to/file
r� c r r r r �Zstvr r r � r zstatvfs.<locals>.<dictcomp>)
�f_bavail�f_bfree�f_blocks�f_bsize�f_favail�f_ffree�f_files�f_flag�f_frsize� f_namemaxzCould not statvfs 'r� )r r rh r� r �statvfsr� r r� r r r r% � s
� �r% c C s� t j�| �} i }t j�| �s$zt �| �}W n ty# td| � ���w |r,t �| �}nt �| �}|j|d< |j |d< |j
|d< t |j
�|d< t |j �|d< |j
|d< |j|d< |j|d < |j|d
< tjj�tt�|j���|d < |rzt| |�|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 )z�
Return a dict containing the stats for a given file
CLI Example:
.. code-block:: bash
salt '*' file.stats /etc/passwd
zPath not found: �inoderq r] rO rs r� r� �ctimer� ry r� r� �typer� r� �blockr� �pipe�socketrX )!r r rh r* r� r� r r~ �st_inor
r
r^ rr r r r r r r r" r9 �oct�S_IMODEr r� �S_ISDIR�S_ISCHR�S_ISBLK�S_ISREG�S_ISLNK�S_ISFIFO�S_ISSOCKr7 )r r� rd r/ Zpstatr r r rg � sP
�
rg c C s d}g }g }t j�| �} t j�| �std��t j�| �s td��|rTt�� }z|t|�d }t� d||� W n t
t fyS } zd}t� d|� W Y d}~nd}~ww |r�t j
| dd �D ]R\} }
} |
D ]J} t j�| | �}
|rwt j�|
�|k sy|s�zt� d
|
� t �|
� |�|
� W qd ty� } z|�|
t|�g� t� d |
|� W Y d}~qdd}~ww qdq]| }|r�t j�| �|k s�|s�zt� d
| � t �| � |�| � |s�|s�d nd}W n$ ty� } zd}|�| t|�g� t� d | |� W Y d}~nd}~ww |�r|||d
�S |S )a�
.. versionadded:: 2014.1.0
.. versionchanged:: 3006.0
Changed return value for failure to a boolean.
Remove the specified directory. Fails if a directory is not empty.
recurse
When ``recurse`` is set to ``True``, all empty directories
within the path are pruned.
.. versionadded:: 3006.0
verbose
When ``verbose`` is set to ``True``, a dictionary is returned
which contains more information about the removal process.
.. versionadded:: 3006.0
older_than
When ``older_than`` is set to a number, it is used to determine the
**number of days** which must have passed since the last modification
timestamp before a directory will be allowed to be removed. Setting
the value to 0 is equivalent to leaving it at the default of ``None``.
.. versionadded:: 3006.0
CLI Example:
.. code-block:: bash
salt '*' file.rmdir /tmp/foo/
Fr� r i�Q z.Now (%s) looking for directories older than %sr z6Unable to set 'older_than'. Defaulting to 0 days. (%s)N)�topdownz
Removing '%s'zCould not remove '%s': %sT)�deleted�errorsr- )r r rh r� r r� r� rU rn r� r� rV �error�walkr �getmtime�rmdirr@ r� rA )r r� �verboseZ
older_thanr/ r7 r8 �nowrB r �dirs�_ZsubdirZ subdir_pathr r r r< . sl " ����
����
�� r< c
K s� t j�| �} t j�| �std| � ���z+t j�| �s&t j�| �r.t j�| �s.t �| � W dS t j�| �r<t �
| � W dS W dS t yT } z
t d| � d|� ���d}~ww )aE
Remove the named file. If a directory is supplied, it will be recursively
deleted.
CLI Example:
.. code-block:: bash
salt '*' file.remove /tmp/foo
.. versionchanged:: 3000
The method now works on all types of file system entries, not just
files, directories and symlinks.
z File path must be absolute: TzCould not remove 'r� NF)
r r rh r� r r� r* r� r+ r r� r� r )r r� rB r r r r+ � s $
����r+ c C r� )z�
Tests to see if path is a valid directory. Returns True/False.
CLI Example:
.. code-block:: bash
salt '*' file.directory_exists /etc
)r r r� rh r� r r r �directory_exists� � rA c C r� )z�
Tests to see if path is a valid file. Returns True/False.
CLI Example:
.. code-block:: bash
salt '*' file.file_exists /etc/passwd
)r r r� rh r� r r r � file_exists� rB rC c C s t � tj�| ��r dS dS )aM
Tests to see if path after expansion is a valid path (file or directory).
Expansion allows usage of ? * and character ranges []. Tilde expansion
is not supported. Returns True/False.
.. versionadded:: 2014.7.0
CLI Example:
.. code-block:: bash
salt '*' file.path_exists_glob /etc/pam*/pass*
TF)r� r r rh r� r r r �path_exists_glob� s rD c C s, |rdd| g}ndd| g}t d |dd� S )z�
Reset the SELinux context on a given path
CLI Example:
.. code-block:: bash
salt '*' file.restorecon /home/user/.ssh/authorized_keys
�
restoreconz-FRz-F� cmd.retcodeFr� �r: )r � recursiverP r r r rE � s
rE c C s> t d ddd| gdd�}|d dkr|d }|S d
| � �}|S ) z�
Get an SELinux context from a given path
CLI Example:
.. code-block:: bash
salt '*' file.get_selinux_context /etc/hosts
r� r~ z-cz%CFr� �retcoder �stdoutz0No selinux context information is available for rG )r Zcmd_retr/ r r r �get_selinux_context� s
�rK c C s� t ||||f�s
dS |r%td | |||d�}|�dd�dkr%td|� ���dg}|r1|�d |g� |r:|�d
|g� |rC|�d |g� |rL|�d |g� |�| � td
|dd� }|r`t| �S |S )aS
.. versionchanged:: 3001
Added persist option
Set a specific SELinux label on a given path
CLI Example:
.. code-block:: bash
salt '*' file.set_selinux_context path <user> <role> <type> <range>
salt '*' file.set_selinux_context /etc/yum.repos.d/epel.repo system_u object_r system_conf_t s0
Fzselinux.fcontext_add_policy)Zsel_typeZsel_userZ sel_levelrI Nr zProblem setting fcontext: Zchconz-ur� z-tz-lrF r� )r) r: ri r r� r@ rK ) r rs �roler( �range�persistZfcontext_resultrP r/ r r r �set_selinux_context� s, �
rO c s� | � d|� d� � �}|t v rt | S t| t��r� fdd�td � �D �}� fdd�td � �D �}| D ]6}t|t�rAtt|��}tjj �
|�\}��rj|�fdd�td ��D �7 }|�fdd�td ��D �7 }q4d }| D �]f}t|t��r/t |�d
krqott|��} || r�|| n|}
t j
�
| �} tjj�� r�| j�� tjv r�t j
�
d | �} | j} | d kr�tjj �
| �\}��s�� �|� f|v s�|� f|v r�| |
f} �nqo| �d
�s�| dkr�tjjj| ddd�}
d|
vr�| |
f} n�qo| dk�rtj�| j��stj�| j��stj�tj�| j| j���r| |
f} n�| �tj ��r.tj�| ��r.| |
f} n�qot|t ��r�tjj �
|�\}���sC� �|�f|v �sQ|�f|v �rW||f} n�t j
�
|�}tjj�� �ru|j�� tjv �rut j
�
d | �}|j} | dk�r�tj�|j��s�tj�|j��s�tj�tj�|j|j���r�||f} n6| �d
��s�| dk�r�tjjj|ddd�}
d|
v�r�||f} nqo|�tj ��r�tj�|��r�||f} nqo|d u �r�t d��n| |f}|t |< |S )z�
Check the source list and return the source to use
CLI Example:
.. code-block:: bash
salt '*' file.source_list salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' base
z_|-c � g | ]}|� f�qS r r �r r� �r� r r r� ; � z source_list.<locals>.<listcomp>zcp.list_masterc rP r r �r �drR r r r� < rS zcp.list_master_dirsc rP r r rQ ��senvr r r� C rS c rP r r rT rV r r r� D rS Nr� zfile://r �http�ftp�HEADF)�methodZ decode_bodyr9 r� z(none of the specified sources were found) � __context__r_ r� r: �dict�next�iterr r �urlr� r� r� r� r r r� r� r� �ascii_lowercaser rX �queryr r r* �netlocr r� rA r )r� r� r� Z
contextkeyZmfilesZmdirsZsingler r/ Z
single_srcZ single_hashZurlparsed_single_srcr� Z query_resZ
urlparsed_srcr )r� rW r � source_list+ s�
�
����
� ���� �
� ����
� �
�rd c C s� |t jjjv r6|r |ni }|r|�|� t jjj| | dd||td tttd� d } t| t �r4| �
d�} | S i }d|d< d� |�|d < |S )
a(
Return the contents after applying the templating engine
contents
template string
template
template format
context
Overrides default context variables passed to the template.
defaults
Default context passed to the template.
CLI Example:
.. code-block:: bash
salt '*' file.apply_template_on_contents \
contents='This is a {{ template }} string.' \
template=jinja \
"context={}" "defaults={'template': 'cool'}" \
saltenv=base
T�grains)Zfrom_strrN �contextr� re �pillarr �optsry zutf-8Fr- z-Specified template format {} is not supportedr. ) r r � templates�TEMPLATE_REGISTRY�updater' �
__pillar__r: r_ �bytes�decoder� )r� �templaterf �defaultsr� � context_dictr/ r r r �apply_template_on_contents� s4
�
�
��rr c ! K s� d}i }dd� }|r�t j�|�}|jtjjjv r |j}nd}tj �
|j |j �� tj
�}|dv }|dkrI| }}tj �|�sHd|� d�}di |fS n|dkr`|}tj �|�s`d|� d�}di |fS |rr|�� tjv rrd�
||g�}d}|d kr�td
|| �}|s�di d |� d | � d
�fS nP|s�|r�||�}nG|s�|�tj
�r�||�}n:| s�|r�z t| |||| |
d�}W n) ty� } z di |jfW Y d}~S d}~ww |s�d�tjj�|��}di |fS |�r�|s�|tjjjv �r�d}td || �}|�r&|s�| s�|�r&|�dd�}t ||d�} | �r|}| |d�}n|�s!| |�dt d �k�r$d}n|}|�r,|�rbztd || |�d�|
|d�}W n% t �ya } ztjj�|�} di d| � d |� �fW Y d}~S d}~ww |�rltj �|��s|tjj�|�} |i d | � d �fS || k�r�t d ��|�r�|tjj j!v �r�| �r�| ni } |
�r�| �"|
� tjj j!| |f| |||||| | tt#t d t d!� |��} n |i d"|� d#�fS | d$ �r�| d% }t |dd�} d| d&�}n t$|� |i | d% fS ||dfS )'a�
Return the managed file data for file.managed
name
location where the file lives on the server
template
template format
source
managed source file
source_hash
hash of the source file
source_hash_name
When ``source_hash`` refers to a remote file, this specifies the
filename to look for in that file.
.. versionadded:: 2016.3.5
user
Owner of file
group
Group owner of file
mode
Permissions of file
attrs
Attributes of file
.. versionadded:: 2018.3.0
context
Variables to add to the template context
defaults
Default values of for context_dict
skip_verify
If ``True``, hash verification of remote file sources (``http://``,
``https://``, ``ftp://``) will be skipped, and the ``source_hash``
argument will be ignored.
.. versionadded:: 2016.3.0
verify_ssl
If ``False``, remote https file sources (``https://``) and source_hash
will not attempt to validate the servers certificate. Default is True.
.. versionadded:: 3002
use_etag
If ``True``, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the ``source_hash`` parameter.
.. versionadded:: 3005
CLI Example:
.. code-block:: bash
salt '*' file.get_managed /etc/httpd/conf.d/httpd.conf jinja salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' None root root '755' base None None
r3 c S s t | dd�dd�S )za
DRY helper for getting the source_sum value from a locally cached
path.
r� �r� �r� r� )r� r� r r r �_get_local_file_source_sum7 s z/get_managed.<locals>._get_local_file_source_sum)r� r3 zLocal file source z does not existr� r� r z cp.hash_filez Source file z not found in saltenv 'r� r� NzcUnable to verify upstream hash of source file {}, please set source_hash or set skip_verify to TrueFz cp.is_cachedr� r� rs rt r� Tr� )r� r� �use_etagzFailed to cache r� �
Source file '� ' not foundz-Source file cannot be the same as destinationre ) r� r� rs rO ry r� r� rf r rg re rh zSpecified template format z is not supportedr- ry �r� r� )%r� r� r� r� r r r" r� r r r rc r6 r� r* r� r� ra r: r r� r r� r� r` Zredact_http_basic_authZ
REMOTE_PROTOSri r� r' r� r ri rj rk rl r, )!r� ro r� r� r� rs rO ry r� r� rf rp � skip_verifyr� rv r� r �
source_sumru �urlparsed_sourceZ
parsed_schemeZ parsed_pathZunix_local_sourcerZ rB Z
cache_refetchZ cached_dest�htypeZ
cached_sumZ_sourcerq ry r� r r r � get_managed� s X ��
�
��
��� ��
�
�"��
���
�
r~ c C s� t �|�}|du r |rt�d|� d}tt�� dtt�� �}nt|�}tj d }|rFt
|t�s3t|�}t |�d d }t� d|sBd n||� |r_t
|t�sQt|�}t
j�|�} t | �d d }
|r�t
|t�sjt|�}tj�|�} t
j�| jpx| j�} t | �d d }
d
d � ||fD �}|r�t� d |r�d
nd|s�d n|t |�dkr�dndd�|�� d}i }tjj�| d���*}|D �] }tjj�|�� �}d| d }t � ||�}d}|r�|� d�}|dur�t�t |��}|du r�d}n||d�}|du �rt� d||s�dn|d � q�|du �r |}dd� }d}|�rO|� |��r9z|| tj v �r-|||d||� d}W n t �y8 Y nw t �!t �"|�d |��rO|||d||� d}|�r�|� | ��rvz||
|v �rj|||d ||� d}W n t �yu Y nw t �!t �"|�d |��r�|||d ||� d}|�r�|� | ��r�z||
|v �r�|||d ||� d}W n t �y� Y nw t �!t �"|�d |��r�|||d ||� d}|�s�t� d ||d |d! � q�W d � n 1 �s�w Y d|fd |fd |ffD ];\}}||v �r.t || �dk�rt� d"||d�d#d � || D ��� || d$ } t� d%| d | d! |� | S �q�|�r@t� d&|d |d! � |S t� d'� dS )(a0
.. versionchanged:: 2016.3.5
Prior to this version, only the ``file_name`` argument was considered
for filename matches in the hash file. This would be problematic for
cases in which the user was relying on a remote checksum file that they
do not control, and they wished to use a different name for that file
on the minion from the filename on the remote server (and in the
checksum file). For example, managing ``/tmp/myfile.tar.gz`` when the
remote file was at ``https://mydomain.tld/different_name.tar.gz``. The
:py:func:`file.managed <salt.states.file.managed>` state now also
passes this function the source URI as well as the ``source_hash_name``
(if specified). In cases where ``source_hash_name`` is specified, it
takes precedence over both the ``file_name`` and ``source``. When it is
not specified, ``file_name`` takes precedence over ``source``. This
allows for better capability for matching hashes.
.. versionchanged:: 2016.11.0
File name and source URI matches are no longer disregarded when
``source_hash_name`` is specified. They will be used as fallback
matches if there is no match to the ``source_hash_name`` value.
This routine is called from the :mod:`file.managed
<salt.states.file.managed>` state to pull a hash from a remote file.
Regular expressions are used line by line on the ``source_hash`` file, to
find a potential candidate of the indicated hash type. This avoids many
problems of arbitrary file layout rules. It specifically permits pulling
hash codes from debian ``*.dsc`` files.
If no exact match of a hash and filename are found, then the first hash
found (if any) will be returned. If no hashes at all are found, then
``None`` will be returned.
For example:
.. code-block:: yaml
openerp_7.0-latest-1.tar.gz:
file.managed:
- name: /tmp/openerp_7.0-20121227-075624-1_all.deb
- source: http://nightly.openerp.com/7.0/nightly/deb/openerp_7.0-20121227-075624-1.tar.gz
- source_hash: http://nightly.openerp.com/7.0/nightly/deb/openerp_7.0-20121227-075624-1.dsc
CLI Example:
.. code-block:: bash
salt '*' file.extract_hash /path/to/hash/file sha512 /etc/foo
Nz_file.extract_hash: Unsupported hash_type '%s', falling back to matching any supported hash_typer3 �,z\/*r� re zMfile.extract_hash: Extracting %s hash for file matching source_hash_name '%s'z
any supportedc S s g | ]}|r|�qS r r r� r r r r� ) rS z extract_hash.<locals>.<listcomp>z5file.extract_hash: %s %s hash for file matching%s: %sz0If no source_hash_name match found, will extractZ
Extractingz either of the followingr� r z(?i)(?<![a-z0-9])([a-f0-9]{z})(?![a-z0-9])rt z0file.extract_hash: In line '%s', no %shash foundr] c S s& t �d|||� | �|g ��|� d S )Nz,file.extract_hash: Line '%s' matches %s '%s')rn r� �
setdefaultr@ )r= r� Z
match_type�value�matchedr r r �_add_to_matchesV s �z%extract_hash.<locals>._add_to_matchesFr� Tz\s+r� r� z]file.extract_hash: Line '%s' contains %s hash '%s', but line did not meet the search criteriar� r� z1file.extract_hash: Multiple %s matches for %s: %sc S s g | ] }d � |d |d ��qS )z{} ({})r� r� )r� r� r r r r� � s ��r z:file.extract_hash: Returning %s hash '%s' as a match of %szBfile.extract_hash: Returning the partially identified %s hash '%s'z-file.extract_hash: No matches, returning None)#r ri rn ro �minr
�maxrA r� �
whitespacer_ r� r� r r �basenamer� r� r� rc r r r r" r rM r
r� rK rL rO r? �
IndexErrorrQ r� ) r� r� r� r� r� r� Z
hash_len_exprZfilename_separatorsZsource_hash_name_idxZfile_name_basenameZ
file_name_idxr| Zsource_basenameZ
source_idxZbasename_searches�partialr= r� r� Zhash_reZ
hash_matchr� Z matched_hsumZ matched_typer� Z hash_matchedZ
found_typeZ found_strr/ r r r r� � sF
2�
�
��
�
�
���
�
��� ����� �e �
��� ���
r� c " C s� t j�| �} tjj�|�}|s| i g dd�}d} n|d } g |d< t| |d�} i }
t|t �r2| d n| d |
d< t|t �rA| d n| d
|
d < | d |
d
< t j�
| �}t j� | �}|rtjj �
� rit|�| d kr{tjj �
� s|| d ks|| d ks||
d< |r�tjj �
� r�t|�| d kr�tjj �
� s�|| d
ks�|| d ks�||
d< d|
v s�d|
v r�td s�|r�|s�t}nt}|du r�| d }|du r�| d
}z || ||�}|r�d|d< |d �|� n |s�t| | d � W n
ty� d|d< Y nw |du�rtd du�r|�r |�r|| d k�s||
d< t| |� t| |d�}|�rotjj �
� �r2t|�|d k�rGtjj �
� �sd||d k�sd||d k�sdtd du �rU||d d< nd|d< |d �d|� �� n d|
v �ro||d d< |�r�tjj �
� �r�t|�|d k�r�tjj �
� �s�||d
k�s�||d k�s�td du �r�||d d
< nd|d< |d �d|� �� n d|
v �r�||d d
< |du�r�|�r�|�r�||d k�s�td du �r�||d d < nd|d< |d �d|� �� n d|
v �r�||d d < |du�r�|�s�|�r|�r�t| |�}|�r�tdd� |D ���r�d�t| �| �dd�}td du �r1||d < nE|j�r=t| d |jd � |j �rIt| d |j d � t| |�}td d� |D ���rrd|d< |d �d!|� �� d�t| �| �|d < n||d < |d" |d k�r�||d d#< tjj � � �r'|�s�|�s�| �s�|
�r'd}zt | �� d$�\}}}}t �!d%||||� W n t"�y� t �#d&� d|d< |d �d'� d}Y nw |�s'd}d} d} d} |�r�||k�r�|}|�r�||k�r�|} | �r�| |k�r�| } |
�r |
|k�r |
} |�s | �s | �s | �r'd} d} |�r#| d(|� d)�7 } | d(|� d)�7 } | �r6| d*| � d)�7 } | d*|� d)�7 } | �rI| d+| � d)�7 } | d+|� d)�7 } | �r\| d,| � d)�7 } | d,|� d)�7 } td �rzd-�$| �|d< d|d< | �%� | �%� d.�|d d/< n�z)|�s�| �s�| �r�| �s�|} t&| || | | dd0�}!t �!d1|!� |!� d$�\}}}}W n t"�y� t �#d2� d|d< |d �d3� d}Y nw |�s'|d �d4| � d5�� |�r�||k�r�|d �d6� d|d< | �r�|| k�r�|d �d7� d|d< | �r|| k�r|d �d8� d|d< | �r|| k�r|d �d9� d|d< | �%� | �%� d.�|d d/< t| t'��rA| �r8|d �(d:| � d;�|d �|d< td du �rQ|d �rQd|d< ||
fS )<a�
.. versionchanged:: 3001
Added selinux options
Check the permissions on files, modify attributes and chown if needed. File
attributes are only verified if lsattr(1) is installed.
CLI Example:
.. code-block:: bash
salt '*' file.check_perms /etc/sudoers '{}' root root 400 ai
.. versionchanged:: 2014.1.3
``follow_symlinks`` option added
T�r� �changesr. r- r3 r. rc rq rs Zluserr] rO Zlgroupry ZlmodeZcuserZcgrouprx NFr- Zcmoder� zFailed to change user to zFailed to change group to zFailed to change mode to c s � � | ]}|V qd S r r �r �attrr r r r d � � z check_perms.<locals>.<genexpr>)r6 r7 r7 r� )r� r� r+ c s r� r r r� r r r r y r� z Failed to change attributes to r6 r� r� �8Current selinux context user:%s role:%s type:%s range:%s�(Unable to get current selinux attributesz Failed to get selinux attributeszUser: r] zRole: zType: zRange: z%File {} selinux context to be updated)ZOldZNew�selinux)rs rL r( rM rN zselinux set result: %sz(Unable to set current selinux attributesz Failed to set selinux attributes� The file z is set to be changedz Unable to update seuser contextz Unable to update serole contextz Unable to update setype contextz Unable to update serange contextr z; ))r r rh r r r" r9 rg r_ rU r� r� r r rw rW r' r� r� r@ r� r� r� r) r r� r� r� r� Zis_linuxrK r� rn r� rV r9 r� r� rO rA re )"r� r/ rs rO ry r� rd �seuser�serole�setype�serangeZ orig_commentZcurr� �is_dirr� Z
chown_funcr� Zpost�
diff_attrsr� Z cmp_attrsZ
selinux_error�current_seuser�current_serole�current_setype�current_serangeZrequested_seuserZrequested_seroleZrequested_setypeZrequested_serangeZselinux_change_newZselinux_change_origr- r r r r< � s�
�
�
�
� � �
�
�
�
�
�
��
& ��
�����
������� �
�
�� r< c K s� t ||| �\}}d}d}| du r1t| ||||||||| | |
|
f
i |��\}}}|r1t|� d|fS t| |||||||| | |||||d�}| �t�� �rVdD ]}|�|d� qMt|� |rwt� |� dg}|�
dd� |� � D �� dd� |�fS d d
| � d �fS ) a�
Check to see what changes need to be made for a file
follow_symlinks
If the desired path is a symlink, follow it and check the permissions
of the file to which the symlink points.
.. versionadded:: 3005
CLI Example:
.. code-block:: bash
salt '*' file.check_managed /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root, root, '755' jinja True None None base
r3 NF�r� r� r� r� rd �rs rO ry z,The following values are set to be changed:
c s s$ � | ]
\}}|� d |� d�V qdS )r� r< Nr )r r �valr r r r h s �" z check_managed.<locals>.<genexpr>Tr� � is in the correct state)
rd r~ r, �check_file_metar r r! r� rn �infor� �itemsr )r� r� r� r� rs rO ry r� ro rf rp r� r� rz r� r� r� r� rd r� r r{ �commentsr� r r r r �
check_managed sj &�� ��
r� c K s& t ||| �\}}d}d}| du rzt| ||||||||| | |
|
f
d|i|��\}}}|r7d|v r7|d �� |d< |rAt|� d|fS |rz|rz|rztj�|�jdv sU|�d�rzz t d || d d
�}W n t
yy } z
t � d ||� W Y d}~nd}~ww t
| |||||||| | |||||d �}t|� |S )
a�
Return a dictionary of what changes need to be made for a file
.. versionchanged:: 3001
selinux attributes added
verify_ssl
If ``False``, remote https file sources (``https://``) and source_hash
will not attempt to validate the servers certificate. Default is True.
.. versionadded:: 3002
follow_symlinks
If the desired path is a symlink, follow it and check the permissions
of the file to which the symlink points.
.. versionadded:: 3005
CLI Example:
.. code-block:: bash
salt '*' file.check_managed_changes /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root, root, '755' jinja True None None base
r3 Nr� r� F)r r� r� � cp.stat_fileT�r� Zoctal�Unable to stat %s: %sr� )rd r~ r� r, r� r� r� r� r r: r� rn ro r� )r� r� r� r� rs rO ry r� ro rf rp r� r� rz � keep_moder� r� r� r� r� rd r� r r{ r� rB r� r r r �check_managed_changesm sv 2��� � ����r� c
C s i }|st � }z
t| |�dd�|d�}W n ty i }Y nw |s(| |d< |S d|v rn|d |d krn|sD|rDtd |||d |d�}|rjz t| |d d
d �|d < W n tyi } z |j|d < W Y d}~n d}~ww d
|d< | du�rt| t�r�t j
j j t j
j j
d
d�}t j
j �|d��
}|�| � W d � n1 s�w Y n<t j
j j t j
j j
d d�}t j
j�� r�tj�t| ��} t j
j �|d��}|�t j
j�| �� W d � n1 s�w Y z t| |d
d�}W n t�y } zt�d|� |j}W Y d}~nd}~ww t|� |�rtd d��rd|d < n||d < t j
j�� �s
|du�r9||d k�r9||d k�r9||d< |du�rP||d k�rP||d k�rP||d< t j
j �|d �}t j
j �|�}|du�rn||k�rn||d< |�r�t | |�}|du�r�|du�r�|d du�s�|d du�r�||d < |
�s�| �s�| �s�|
�r
zt | �� d �\}}}}t� d ||||� W n t �y� } zt�d � |j|d!< W Y d}~nd}~ww |
�r�|
|k�r�d|
i|d!< | �r�| |k�r�d"| i|d!< | �r�| |k�r�d#| i|d!< |
�r
|
|k�r
d$|
i|d!< |S )%as
Check for the changes in the file metadata.
CLI Example:
.. code-block:: bash
salt '*' file.check_file_meta /etc/httpd/conf.d/httpd.conf None salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root root '755' None base
.. note::
Supported hash types include sha512, sha384, sha256, sha224, sha1, and
md5.
name
Path to file destination
sfn
Template-processed source file contents
source
URL to file source
source_sum
File checksum information as a dictionary
.. code-block:: yaml
{hash_type: md5, hsum: <md5sum>}
user
Destination file user owner
group
Destination file group owner
mode
Destination file permissions mode
attrs
Destination file attributes
.. versionadded:: 2018.3.0
saltenv
Salt environment used to resolve source files
contents
File contents
seuser
selinux user attribute
.. versionadded:: 3001
serole
selinux role attribute
.. versionadded:: 3001
setype
selinux type attribute
.. versionadded:: 3001
serange
selinux range attribute
.. versionadded:: 3001
verify_ssl
If ``False``, remote https file sources (``https://``)
will not attempt to validate the servers certificate. Default is True.
.. versionadded:: 3002
follow_symlinks
If the desired path is a symlink, follow it and check the permissions
of the file to which the symlink points.
.. versionadded:: 3005
r� N)r� rd Znewfiler� r� r� )r� r� TF)ro �show_filenamesr� zChecksum differs�rO r r� r �r� zFailed to diff files: %s�
config.option�obfuscate_templates�<Obfuscated Template>rs rq rO r] ry r r� r� r� r� r� r� rL r( rM )!r] rg ri r r: �get_diffr� r_ rm r r r" rP r# r r r r r rb r rC rM rN rn r9 r, r9 r� rK r� r� rV ) r� r r� r{ rs rO ry r� r� r� r� r� r� r� r� rd r� ZlstatsrB �tmp�tmp_r� Zsmoder� r� r� r� r� r r r r� � s� d
� �����
� ��
� � � ��
&&
��
�� r� c C s� | |f}||f} g }
g } t || �D ]E\} }
z#td | ||
d�}|du r2| �d�tjj�| ��� W q|
�|� W q tyV } z| �tjj�t |��� W Y d}~qd}~ww | r_t
d| d��g }|
D ]=} z!tjj � | d��}|�|�
� � W d � n1 s�w Y W qc ty� } zt
d �tjj�| �|j���d}~ww |d
|d kr�|r�td d
�r�d}|S |s�d}|S t|
� }|r�|}|S |r�|�|
� td |� }|S dS )aU
Return unified diff of two files
file1
The first file to feed into the diff utility
.. versionchanged:: 2018.3.0
Can now be either a local or remote file. In earlier releases,
thuis had to be a file local to the minion.
file2
The second file to feed into the diff utility
.. versionchanged:: 2018.3.0
Can now be either a local or remote file. In earlier releases, this
had to be a file on the salt fileserver (i.e.
``salt://somefile.txt``)
show_filenames: True
Set to ``False`` to hide the filenames in the top two lines of the
diff.
show_changes: True
If set to ``False``, and there are differences, then instead of a diff
a simple message stating that show_changes is set to ``False`` will be
returned.
template: False
Set to ``True`` if two templates are being compared. This is not useful
except for within states, with the ``obfuscate_templates`` option set
to ``True``.
.. versionadded:: 2018.3.0
source_hash_file1
If ``file1`` is an http(s)/ftp URL and the file exists in the minion's
file cache, this option can be passed to keep the minion from
re-downloading the archive if the cached copy matches the specified
hash.
.. versionadded:: 2018.3.0
source_hash_file2
If ``file2`` is an http(s)/ftp URL and the file exists in the minion's
file cache, this option can be passed to keep the minion from
re-downloading the archive if the cached copy matches the specified
hash.
.. versionadded:: 2018.3.0
CLI Examples:
.. code-block:: bash
salt '*' file.get_diff /home/fred/.vimrc salt://users/fred/.vimrc
salt '*' file.get_diff /tmp/foo.txt /tmp/bar.txt
r� r� FzFile {} not foundNz!Failed to cache one or more files)r� r+ zFailed to read {}: {}r r� r� r� r� �<show_changes=False>r5 r3 )�zipr: r@ r� r r rM r
r rA r r" r rz r� r� r8 r� r4 )Zfile1Zfile2r� r� r� ro Zsource_hash_file1Zsource_hash_file2r" Z
source_hashes�pathsr8 �filenamer� Z cached_pathrB r� r� r/ Zbdiffr r r r� � sn C� �� �� ������ � ��
r� �strictc +
s~
t j�| �} t|otj�|�jdko| o| �} �s"| i ddd��|r0d|v r0|d �� |d< |r��sYt d || |d���sHt
�d|� d ��S |� d
t d
�} | t
�| d �d �}|r�tj�|�jd
v r�z t d || dd�}W n ty� } z
t�d�| � W Y d} ~ nd} ~ ww t j�| �s�t j�| ��r.t j�| �r�|r�t j�| �} n| } |r�|s�t j�| �s�t
| |� d
t d
��} nd} |�r�| du s�|� dt d
�| k�r��s�t d || ||d���s�t
�d|� d ��S | �r
t
�|d
�}!|!|d k�r
d�|d
||d |!��d< d�d< �S t d d��rd�d d< n7|
�s%d �d d< n-zt| �dd �}"|"�r6|"�d d< W n t�yQ } z
| j�d d< W Y d} ~ nd} ~ ww ztjj��| t d |
�t d � W n t �y� }# zt �� t
�d |#� ��W Y d}#~#S d}#~#ww |du�rHtjjj tjjj dd!�}$tjj� |$d"��5}%|�r�tjj!�"� �r�t j#�$t%|��}t�&d#|� |%�'|j(||d$�� n
|%�'tjj)�*|�� W d � n 1 �s�w Y z t| |$d|
dd%�}&W n" t�y } z��+d&g ��,d'| j� �� d}&W Y d} ~ nd} ~ ww |&�rD|&�d d< ztjj�|$| t d |
�t d � W n t �yC }# zt |$� t
�d |#� ��W Y d}#~#S d}#~#ww t |$� t j�| ��r�|�sLj�s^t d || |d����sjt
�d|� d ��S | �r�t
�|d
�}!|!|d k�r�d(�|d
| |d |!��d< d�d< �S ztjj��| t d |
�t d � W n t �y� }# zt �� t
�d |#� ��W Y d}#~#S d}#~#ww d)�d d< tjj!�"� �r�t-| �� � d*�� � d+�� � d,�� � d-d�� � d.d�d/��nt-| �|||||||||d0� \�}'�d �rd1tjj.�/| �� d2��d< n�d �s%�d �r%d3�tjj.�/| ���d< ��r,t �� �S t j�0| �}(� ��fd4d5�})|�r���sKt d || |d����sWt
�d|� d ��S | �r|t
�|d
�}!|!|d k�r|d(�|d
| |d |!��d< d�d< �S d6�d d< t j�1|(��s�| �r�|)| ||||� n�t �� �d �2dd� t
�d7�S n�t j�1|(��s�| �r�|)| ||||� nt �� �d �2dd� t
�d7�S tjj�3|�r�d8nd��X |du �rt d9 �st4| ��r�d:| � d;��d d<< d=�d< n2t
�d>| � d?��W d � S n!t d9 �s(t4| ��rd6�d d< nt
�d1| � d?��W d � S W d � n 1 �s3w Y |du�r�tjjj tjjj dd!�}$tjj� |$d"��5}%|�rutjj!�"� �rdt j#�$t%|��}t�&d#|� |%�'|j(||d$�� n
|%�'tjj)�*|�� W d � n 1 �s�w Y tjj�|$| t d |
�t d � t |$� n��r�tjj��| t d |
�t d � t �� |du �r�tjj!�"� �s�tjj�5� }*t6d@|*A dA@ �}tjj!�"� �r�t-| �� � d*�� � d+�� � d,�� � d-d�� � d.d�d/��nt-| �||||||||d0�
\�}'�d �sd1| d2 �d< t d9 �r$d1| dB �d< n�d �s6�d �r6d1| dC �d< ��r=t �� �S )Da&
Checks the destination against what was retrieved with get_managed and
makes the appropriate modifications (if necessary).
name
location to place the file
sfn
location of cached file on the minion
This is the path to the file stored on the minion. This file is placed
on the minion using cp.cache_file. If the hash sum of that file
matches the source_sum, we do not transfer the file to the minion
again.
This file is then grabbed and if it has template set, it renders the
file to be placed into the correct place on the system using
salt.files.utils.copyfile()
ret
The initial state return data structure. Pass in ``None`` to use the
default structure.
source
file reference on the master
source_sum
sum hash for source
user
user owner
group
group owner
backup
backup_mode
attrs
attributes to be set on file: '' means remove all of them
.. versionadded:: 2018.3.0
makedirs
make directories if they do not exist
template
format of templating
show_changes
Include diff in state return
contents:
contents to be placed in the file
dir_mode
mode for directories created with makedirs
skip_verify: False
If ``True``, hash verification of remote file sources (``http://``,
``https://``, ``ftp://``) will be skipped, and the ``source_hash``
argument will be ignored.
.. versionadded:: 2016.3.0
keep_mode: False
If ``True``, and the ``source`` is a file from the Salt fileserver (or
a local file on the minion), the mode of the destination file will be
set to the mode of the source file.
.. note:: keep_mode does not work with salt-ssh.
As a consequence of how the files are transferred to the minion, and
the inability to connect back to the master with salt-ssh, salt is
unable to stat the file as it exists on the fileserver and thus
cannot mirror the mode on the salt-ssh minion
encoding
If specified, then the specified encoding will be used. Otherwise, the
file will be encoded using the system locale (usually UTF-8). See
https://docs.python.org/3/library/codecs.html#standard-encodings for
the list of available encodings.
.. versionadded:: 2017.7.0
encoding_errors: 'strict'
Default is ```'strict'```.
See https://docs.python.org/2/library/codecs.html#codec-base-classes
for the error handling schemes.
.. versionadded:: 2017.7.0
seuser
selinux user attribute
.. versionadded:: 3001
serange
selinux range attribute
.. versionadded:: 3001
setype
selinux type attribute
.. versionadded:: 3001
serange
selinux range attribute
.. versionadded:: 3001
verify_ssl
If ``False``, remote https file sources (``https://``)
will not attempt to validate the servers certificate. Default is True.
.. versionadded:: 3002
use_etag
If ``True``, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the ``source_hash`` parameter.
.. versionadded:: 3005
CLI Example:
.. code-block:: bash
salt '*' file.manage_file /etc/httpd/conf.d/httpd.conf '' '{}' salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root root '755' '' base ''
.. versionchanged:: 2014.7.0
``follow_symlinks`` option added
r r3 Tr� r� r� r� rw rx r� rs ry )r r� r3 r� r� r� N)r� rv z�Specified {} checksum for {} ({}) does not match actual checksum ({}). If the 'source_hash' value refers to a remote file with multiple possible matches, then it may be necessary to set 'source_hash_name'.r. Fr- r� r� r� r� r� r� r� zconfig.backup_moder9 zFailed to commit change: r� r� z File will be encoded with %s)r� r8 )r� r� ro �warningsz"Failed to detect changes to file: zESpecified {} checksum for {} ({}) does not match actual checksum ({})z'Replace symbolic link with regular file� win_owner� win_perms�win_deny_perms�win_inheritance�win_perms_reset)r r/ r� � grant_perms�
deny_perms� inheritance�reset)r� r� r� r� �File z updatedz File {} is in the correct statec
s t jj�� r"tj�| �\}}|r"tj�|�s"t�� t �|� d��S |d u rS|d urSdd� t
|�D �dd � }t |�D ]\}} | dkrMt
t | �dB �||< q;d�
|�}t jj�� rvt| � �d�� �d �� �d
�� �d d �� �d
d�d� d S t| |||d� d S )Nz drive not presentc S s g | ]}|�qS r r r� r r r r� � s z@manage_file.<locals>._set_mode_and_make_dirs.<locals>.<listcomp>���r| r� r3 r� r� r� r� Tr� F)r r� r� r� r� r� r� )r r r r r r �
splitdriver* r, r1 rA r� rU r r ri )
r� �dir_modery rs rO �driver@ Z mode_listrr �part�r� r/ r r r �_set_mode_and_make_dirs� s, �
�
z,manage_file.<locals>._set_mode_and_make_dirszNew filez Parent directory not present�? rx zfile z createdr7 z
Empty filez Empty file z not createdi� i� z not updatedr� )7r r rh r� r� r� r� r� r� r: r1 ri r' r� r� rn ro r� r� r7 r� r� r r� r r r" r� r� r, rP r# r r r rb r rC r� r �encoderM r| r� r@ r< ry rn r� r� r� Z set_umaskr� Z get_umaskr- )+r� r r/ r� r{ rs rO ry r� r� r r
ro r� r� r� rd rz r� r� Zencoding_errorsr� r� r� r� r� rv r� Zcheck_web_source_hashr} rB Z real_nameZname_sumZdl_sumZ file_diffZio_errorr� r� r� r@ Z contain_dirr� �maskr r� r � manage_file8 sP (��� ������ ���
� ��
�� �� �
�
���
� ����
� ��
�
�
� "��
�
�
��
�� �� ��
�
�
�
r� c C s6 t j�| �} t j�| �}t j�|�st||||� dS )z�
Ensure that a directory is available.
CLI Example:
.. code-block:: bash
salt '*' file.mkdir /opt/jetty/context
T)r r rh r� r� �makedirs_perms)Zdir_pathrs rO ry � directoryr r r �mkdiri s
r� c C s� t j�| �} |rtjj�|�}t j�t j�| ��}t j� |�r,d|� d�}t
� |� |S t j� |�r?d|� d�}t
� |� |S g } t j� |�rIn|�
|� |}t j�|�}||kratd�|���qB|�� |D ]}t
� d|� t||||d� qhd S )
a
Ensure that the directory containing this path is available.
.. note::
The path must end with a trailing slash otherwise the directory/directories
will be created up to the parent directory. For example if path is
``/opt/code``, then it would be treated as ``/opt/`` but if the path
ends with a trailing slash like ``/opt/code/``, then it would be
treated as ``/opt/code/``.
CLI Example:
.. code-block:: bash
salt '*' file.makedirs /opt/code/
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: %sr� N)r r rh r r r" r9 r� r� r� rn r� r* r@ r r� �reverser� ) r rs rO ry r� rZ Zdirectories_to_createZcurrent_dirnameZdirectory_to_creater r r r � s<
�� ��0755c
C s� t j�| �} t j}|�| �\}}|s|�|�\}}|rL|rL|�|�sLz t||||� W n tyD } z
|jtjkr:� W Y d}~nd}~ww |t j krLdS t �
| � t | d|||r`t |� �� dS d� dS )z�
Taken and modified from os.makedirs to set user, group and mode for each
directory created.
CLI Example:
.. code-block:: bash
salt '*' file.makedirs_perms /opt/code
N)
r r rh r� r* r� r� r� �EEXIST�curdirr� r< rU )r� rs rO ry r �head�tailrB r r r r� � s$ ���
(r� c C sB t j�| �} t| �st| �r t �| �}t �|j�t �|j�fS dS )z�
Get major/minor info from a device
CLI Example:
.. code-block:: bash
salt '*' file.get_devmm /dev/chr
)r r ) r r rh � is_chrdev� is_blkdevr~ �major�st_rdev�minor)r� �stat_structurer r r � get_devmm� s
r� c
C �` t j�| �} d}zt �| �}W n ty) } z|jtjkr$W Y d}~dS � d}~ww t�|j�S )z�
Check if a file exists and is a character device.
CLI Example:
.. code-block:: bash
salt '*' file.is_chrdev /dev/chr
NF) r r rh r~ r� r� �ENOENTr0 r �r� r� rB r r r r� � �
�� r� �0660c
C � t j�| �} | i ddd�}t�d| |||� z;td r*dd| � d�i|d < d
|d < n&t �| tt|�� d �d
�t
j B t � ||��d
u rPdd| � d�i|d < d|d < W n! t
yr } z|jtjkr`� d| � d�|d< W Y d
}~nd
}~ww t| d
|||r�t|� �� |S d
� |S )z�
.. versionadded:: 0.17.0
Create a character device.
CLI Example:
.. code-block:: bash
salt '*' file.mknod_chrdev /dev/chr 180 31
r3 Fr� z;Creating character device name:%s major:%s minor:%s mode:%srx r7 zCharacter device � created.r� Nr- r{ r} Tr� �! exists and cannot be overwrittenr. )r r rh rn r� r' �mknodrU rA r~ r~ �S_IFCHR�makedevr� r� r� r< �r� r� r� rs rO ry r/ rB r r r � mknod_chrdev �B �
��� ���r� c
C r� )z�
Check if a file exists and is a block device.
CLI Example:
.. code-block:: bash
salt '*' file.is_blkdev /dev/blk
NF) r r rh r~ r� r� r� r1 r r� r r r r� 7 r� r� c
C r� )z�
.. versionadded:: 0.17.0
Create a block device.
CLI Example:
.. code-block:: bash
salt '*' file.mknod_blkdev /dev/blk 8 999
r3 Fr� z7Creating block device name:%s major:%s minor:%s mode:%srx r7 z
Block device r� r� Nr- r{ r} Tr� r� r. )r r rh rn r� r' r� rU rA r~ r~ �S_IFBLKr� r� r� r� r< r� r r r � mknod_blkdevO r� r� c
C r� )z�
Check if a file exists and is a FIFO.
CLI Example:
.. code-block:: bash
salt '*' file.is_fifo /dev/fifo
NF) r r rh r~ r� r� r� r4 r r� r r r �is_fifo� r� r� c
C s� t j�| �} | i ddd�}t�d| � z3td r'dd| � d�i|d < d
|d < n t �| tt|�� d �d
��d
u rEdd| � d�i|d < d|d < W n! t
yg } z|j t j krU� d| � d�|d< W Y d
}~nd
}~ww t
| d
|||rwt|� �� |S d
� |S )z�
.. versionadded:: 0.17.0
Create a FIFO pipe.
CLI Example:
.. code-block:: bash
salt '*' file.mknod_fifo /dev/fifo
r3 Fr� zCreating FIFO name: %srx r7 z
Fifo pipe r� r� Nr- r{ r} Tr� r� r. )r r rh rn r� r' �mkfiforU rA r~ r� r� r� r< )r� rs rO ry r/ rB r r r �
mknod_fifo� s*
� ���r� �0600c C st d}t | ||� |dkrt| |||||�}|S |dkr&t| |||||�}|S |dkr3t| |||�}|S td�|���)a/
.. versionadded:: 0.17.0
Create a block device, character device, or fifo pipe.
Identical to the gnu mknod.
CLI Examples:
.. code-block:: bash
salt '*' file.mknod /dev/chr c 180 31
salt '*' file.mknod /dev/blk b 8 999
salt '*' file.nknod /dev/fifo p
Fr_ r r� zcNode type unavailable: '{}'. Available node types are character ('c'), block ('b'), and pipe ('p').)r r� r� r� r r� )r� Zntyper� r� rs rO ry r/ r r r r� � s
����r� c s� t j�| �} zt|�}W n ty Y n ty$ t�d� d}Y nw t� }t j� | �\}}t
j j �
� r=|�dd�}n|dd� }t j�||�� t j�� �sRi S i �� fdd�t �� �D �D ]S}t
j j �
� rn|� d�}n|� d �}z tj�||�}W n ty� Y q`w t
j j �
� r�d
} nd } |�| ���|i �d < t j�� |�}
t �|
�j�| d
< |
�| d< q`tttttt �����fdd�t �dd�d|� D ����S )a�
.. versionadded:: 0.17.0
Lists the previous versions of a file backed up using Salt's :ref:`file
state backup <file-state-backups>` system.
path
The path on the minion to check for backups
limit
Limit the number of results to the most recent N backups
CLI Example:
.. code-block:: bash
salt '*' file.list_backups /foo/bar/baz.txt
z0file.list_backups: 'limit' value must be numericNr� r@ r� c s& g | ]}t j�t j�� |��r|�qS r )r r r� r r� )�bkdirr r r� s
��z list_backups.<locals>.<listcomp>z_%a_%b_%d_%H-%M-%S_%f_%Y�_%a_%b_%d_%H:%M:%S_%f_%Yz%a %b %d %Y %H-%M-%S.%f�%a %b %d %Y %H:%M:%S.%f� Backup Time�Size�Locationc � g | ]}� | �qS r r r� )r" r r r� rS T�r� ) r r rh rU r� rV rn r9 r; r� r r r r r� r r� r �datetime�strptimer� r� r~ r r] r� r� rM r� r� ) r r� �bkroot�
parent_dirr� Zsrc_dir�fname�strpfmt� timestampZ
str_formatrq r )r� r" r � list_backups� sX
�
�
� ���r � list_backupc
s� t j�| �} zt|�}W n ty Y n ty$ t�d� d}Y nw t� }t j� | �\}}t j�
||dd� �}t j� |�sCi S i }dd� t �
dd� tt �|��D ��D �}t �|�}|�� D ]w\} }
i � t|�D ]G} | � d�d }| |kr�|� d
�} z tj�| | �}
W n ty� Y qlw |
�d �� �|
i �d < t j�
|| �}t �|�j� |
d
< |� |
d< qlttttt|
��� fdd�t� dd�d|� D ����}| |i}|�|� qb|S )au
Lists the previous versions of a directory backed up using Salt's :ref:`file
state backup <file-state-backups>` system.
path
The directory on the minion to check for backups
limit
Limit the number of results to the most recent N backups
CLI Example:
.. code-block:: bash
salt '*' file.list_backups_dir /foo/bar/baz/
z4file.list_backups_dir: 'limit' value must be numericNr� c S s i | ] \}}|t t|���qS r )r� r� )r r� �nr r r r K s ��z$list_backups_dir.<locals>.<dictcomp>c S s g | ] }|� d �d �qS )r@ r )r� r� r r r r� N s z$list_backups_dir.<locals>.<listcomp>r@ r r� r� r� r� r� c r� r r r� �Zssfiler r r� i rS Tr� ) r r rh rU r� rV rn r9 r; r� r r� r$ �groupbyr� r r� r� r� r� r� r~ r r] r� r� rM rk )r r� r� r� r� r� r" r� Zffr� r r� r r rq ZsfilesZsefilesr r r �list_backups_dir( sd
� ��
�� �
��� r c
C sn t j�| �} dd|� d�d�}z tt|��ttt|���kr't| �t|� }n|W S W n ty6 | Y S tyJ d|� d| � �|d< | Y S w t j
j � | t
� � z
t�|d | � W n ty} } zd �|d | |�|d< |W Y d
}~S d
}~ww d |d < d
�|d | �|d< t j
j�� s�zt �| �}W n ty� |d d7 < Y |S w t �| |j|j� |S )a�
.. versionadded:: 0.17.0
Restore a previous version of a file that was backed up using Salt's
:ref:`file state backup <file-state-backups>` system.
path
The path on the minion to check for backups
backup_id
The numeric id for the backup you wish to restore, as found using
:mod:`file.list_backups <salt.modules.file.list_backups>`
CLI Example:
.. code-block:: bash
salt '*' file.restore_backup /foo/bar/baz.txt 0
F�Invalid backup_id 'r� �r- r. � backup_id '�' does not exist for r. r� z Unable to restore {} to {}: {}NTr- z Successfully restored {} to {}z!, but was unable to set ownership)r r rh r� rA rU r rV r[ r r r" Z
backup_minionr; r r� r� r� r r r~ r� r
r
)r � backup_idr/ r rB �fstatr r r �restore_backupr sH � �
���� �r c
C s t j�| �} dd|� d�d�}z tt|��ttt|���kr't| �t|� }n|W S W n ty6 | Y S tyJ d|� d| � �|d< | Y S w z t � |d � W n t
yq } zd � |d |�|d< W Y d
}~|S d
}~ww d |d < d
� |d �|d< |S )a
.. versionadded:: 0.17.0
Delete a previous version of a file that was backed up using Salt's
:ref:`file state backup <file-state-backups>` system.
path
The path on the minion to check for backups
backup_id
The numeric id for the backup you wish to delete, as found using
:mod:`file.list_backups <salt.modules.file.list_backups>`
CLI Example:
.. code-block:: bash
salt '*' file.delete_backup /var/cache/salt/minion/file_backup/home/foo/bar/baz.txt 0
Fr r� r
r r r. r� zUnable to remove {}: {}NTr- zSuccessfully removed {}) r r rh r� rA rU r rV r[ r+ r� r� )r r
r/ r rB r r r �
delete_backup� s. � � ��r �
remove_backupc
G s� t j�| �} | }t�| �} | s|} g }|D ]0}z tjj�|�}W n ty2 tjj�t |��}Y nw t
|�dkr@t d� |���|�
|� qt| t�rVdg| |g | }n dg| || g }z td |dd�}W |S ty{ } zt| j��d} ~ ww )a�
Grep for a string in the specified file
.. note::
This function's return value is slated for refinement in future
versions of Salt
Windows does not support the ``grep`` functionality.
path
Path to the file to be searched
.. note::
Globbing is supported (i.e. ``/var/log/foo/*.log``, but if globbing
is being used then the path should be quoted to keep the shell from
attempting to expand the glob expression.
pattern
Pattern to match. For example: ``test``, or ``a[0-5]``
opts
Additional command-line flags to pass to the grep command. For example:
``-v``, or ``-i -B2``
.. note::
The options should come after a double-dash (as shown in the
examples below) to keep Salt's own argument parser from
interpreting them.
CLI Example:
.. code-block:: bash
salt '*' file.grep /etc/passwd nobody
salt '*' file.grep /etc/sysconfig/network-scripts/ifcfg-eth0 ipaddr -- -i
salt '*' file.grep /etc/sysconfig/network-scripts/ifcfg-eth0 ipaddr -- -i -B2
salt '*' file.grep "/etc/sysconfig/network-scripts/*" ipaddr -- -i -l
r� zPassing multiple command line arguments in a single string is not supported, please pass the following arguments separately: {}�grepr� Fr� N)r r rh r� r r r� r� r� rA r� r r� r� r_ r� r: r� r r� )
r r� rh �_pathZ
split_opts�optr� rP r/ rB r r r r � s8 '
� �
�
��r c
C s� i }t �d�}|D ]}zg |t|�< W q ty Y q w i }|D ]�}d|� �}z
t �|� d��}W n ty; Y q!w g }t �|� d��D ] } |�|� d| � �� qF|D ]8}
z|�t j�|� d|
� d��� W n tyq Y qUw t �|� d|
� d��D ]} |�|� d|
� d| � �� q}qUtt |��}|D ]E} z
t j�| �}
t �
|
� W n ty� Y q�w |
|vr�|g||
< n||
�|� tt ||
��||
< || �|
� tt || ��||< q�q!| r�|S |S )z�
Return a list of all physical open files on the system.
CLI Examples:
.. code-block:: bash
salt '*' file.open_files
salt '*' file.open_files by_pid=True
z/proc/z/taskz/fdz/fd/z/task/z/exe) r r rU rV r� r@ r r7 r� r� r~ )Zby_pidZpidsZprocfsZpfiler" �pidZppathZtidsZfd_Zfpath�tidZtpathZfdpathr� r r r �
open_files+ s\
�
�" � � � �r c C s t jjS )a�
Return the relative parent directory path symbol for underlying OS
.. versionadded:: 2014.7.0
This can be useful when constructing Salt Formulas.
.. code-block:: jinja
{% set pardir = salt['file.pardir']() %}
{% set final_path = salt['file.join']('subdir', pardir, 'confdir') %}
CLI Example:
.. code-block:: bash
salt '*' file.pardir
)r r �pardirr r r r r y s r c C � t j�| �S )ay
Returns Normalize path, eliminating double slashes, etc.
.. versionadded:: 2015.5.0
This can be useful at the CLI but is frequently useful when scripting.
.. code-block:: jinja
{%- from salt['file.normpath'](tpldir + '/../vars.jinja') import parent_vars %}
CLI Example:
.. code-block:: bash
salt '*' file.normpath 'a/b/c/..'
)r r r� r� r r r r� � � r� c C r )a[
Returns the final component of a pathname
.. versionadded:: 2015.5.0
This can be useful at the CLI but is frequently useful when scripting.
.. code-block:: jinja
{%- set filename = salt['file.basename'](source_file) %}
CLI Example:
.. code-block:: bash
salt '*' file.basename 'test/test.config'
)r r r� r� r r r r� � r r� c C r )az
Returns the directory component of a pathname
.. versionadded:: 2015.5.0
This can be useful at the CLI but is frequently useful when scripting.
.. code-block:: jinja
{%- from salt['file.dirname'](tpldir) + '/vars.jinja' import parent_vars %}
CLI Example:
.. code-block:: bash
salt '*' file.dirname 'test/path/filename.config'
)r r r� r� r r r r� � r r� c G s t jj| � S )a
Return a normalized file system path for the underlying OS
.. versionadded:: 2014.7.0
This can be useful at the CLI but is frequently useful when scripting
combining path variables:
.. code-block:: jinja
{% set www_root = '/var' %}
{% set app_dir = 'myapp' %}
myapp_config:
file:
- managed
- name: {{ salt['file.join'](www_root, app_dir, 'config.yaml') }}
CLI Example:
.. code-block:: bash
salt '*' file.join '/' 'usr' 'local' 'bin'
)r r r )r� r r r r � s r c
C s� |rt | |�S tj�| �} tj�|�}tj�| �s td��tj�|�s'td��dd| � d|� d�d�}z t�| |� W |S tyU } z
t d| � d|� d |� ���d
}~ww ) al
Move a file or directory
disallow_copy_and_unlink
If ``True``, the operation is offloaded to the ``file.rename`` execution
module function. This will use ``os.rename`` underneath, which will fail
in the event that ``src`` and ``dst`` are on different filesystems. If
``False`` (the default), ``shutil.move`` will be used in order to fall
back on a "copy then unlink" approach, which is required for moving
across filesystems.
.. versionadded:: 3006.0
CLI Example:
.. code-block:: bash
salt '*' file.move /path/to/src /path/to/dst
z Source path must be absolute.z"Destination path must be absolute.Tr� z ' moved to 'r
zUnable to move 'r� r� N)
r� r r rh r� r r r; r� r )rU r� Zdisallow_copy_and_unlinkr/ rB r r r r; � s$
����r; c
C s� d}t � }tj�| �rt�| �}|j}|S tjj�| �D ]3\}}}|D ]+}tj� ||�} zt�| �}W n t
y< Y q#w |j |v rCq#|� |j � ||j7 }q#q |}|S )z�
Recursively calculate disk usage of path and return it
in bytes
CLI Example:
.. code-block:: bash
salt '*' file.diskusage /path/to/check
r )
r� r r r� r~ r r r Zos_walkr r� r, r� )
r Z
total_size�seenr� r/ �dirpath�dirnames� filenamesr� �fpr r r � diskusage s*
�
�r )T)r� )r� r� )r3 r3 NNr� T)F)r3 r� r� r� FF)r3 r� )r3 r� r FF)r r� )r Tr� )r� )NNNNNNT)
NNNNNNTFFT)
r r} r� FFNr� FFTFTF) r� r� r3 FFr� FTFNN)r} r� FF)r3 F)r3 )NN)FF)NT)FFN)NNNNF)FTF)r� r3 r3 N)NFNNNN)NFNNNNF) NFFNNNNTF)NNNNNTF)r� TTFNN)FNTNNTFFNr� NNNNTF)NNN)NNr� )NNr� )r r NNr� r )��__doc__r� r� r� r� r{ r$ �loggingr� r rK r r~ r� r� r r� � urllib.parser� � collectionsr �collections.abcr r Zsalt.utils.argsr Zsalt.utils.atomicfileZsalt.utils.dataZsalt.utils.filebufferZsalt.utils.filesZsalt.utils.findZsalt.utils.functoolsZsalt.utils.hashutilsZsalt.utils.httpZsalt.utils.itertoolsZsalt.utils.pathZsalt.utils.platformZsalt.utils.stringutilsZsalt.utils.templatesZsalt.utils.urlZsalt.utils.userZsalt.exceptionsr r r r rT r r
Zsalt.utils.versionsr rX rn � ImportError� getLogger�__name__rn Z__func_alias__r r r, r1 r8 r; rC rR rT r^ rW rk rm rr rw rx rt rz 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$ rM rN r: rV r[ r` ra rc rv r� r� r� rL r� r� r� r� r@ r� r r� r� r� r� r� r� r� r� r� r� r� r� r r� r r% rg r< r+ rA rC rD rE rK rO rd rr r~ r� r< r� r� r� r� r� r� r r� r� r� r� r� r� r� r� r� r r � functoolsZalias_functionr r r r r r r r r� r� r� r r; r r r r r �<module> sf
�
'.)+ B � 8 � X0 � f # *% 2
� E � q � � } -_ # D; 03 L @% $ 5 ' =W �3zD � v � | � V �n �| � b � � 5 = 1 1 # K J=, MN -