Current File : //usr/lib/python2.7/site-packages/salt/modules/file.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z d d l Z d d l
Z
d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z m Z m Z d d l m Z d d l m Z d d l m Z m! Z! d d l" m# Z$ y d d l% Z% d d l& Z& Wn e' k
r�n Xd d l( Z) d d l* Z) d d l+ Z) d d l, Z) d d l- Z) d d l. Z) d d l/ Z) d d l0 Z) d d l1 Z) d d l2 Z) d d l3 Z) d d l4 Z) d d l5 Z) d d l6 Z) d d l7 Z) d d l+ Z) d d l8 Z) d d l9 m: Z: m; Z; m< Z< m= Z> d d
l- m? Z? m@ Z@ e
jA eB � ZC i d d 6ZD e d
d � ZE d � ZF d � ZG d � ZH d � ZI d � ZJ d � ZK d � ZL d � ZM d � ZN d � ZO eP d � ZQ eP d � ZR d � ZS d � ZT eP d � ZU eP d � ZV eP d � ZW d � ZX d! � ZY d" � ZZ d# � Z[ d$ � Z\ d% � Z] d& � Z^ d' d( � Z_ d' d) d* � Z` d+ d+ ea ea d, d- � Zb d. � Zc d/ � Zd ee d0 � Zf d+ d1 d2 d3 ee ee d4 � Zg d+ d3 d5 � Zh d+ d1 d6 ee ee d7 � Zi i e
jj d8 6e
jk d9 6e
jl d: 6e
jm d; 6e
jn d< 6e
jo d= 6Zp d> � Zq d? d1 d@ � Zr d? d1 dA � Zs d? eP d1 dB � Zt dC � Zu dD � Zv eP dE � Zw eP dF � Zx dG � Zy dH dI � Zz dJ � Z{ dK � Z| dL � Z} dM � Z~ dN � Z ea ea ea ea ea ea eP ee ee eP dO �
Z� d dP dH ee ee ea d1 ee ee eP ee eP ee dQ �
Z� dR dS d+ ee ee d1 ee eP ee dT � Z� dP dH ee ee dU � Z� d+ ee dV � Z� dW � Z� d+ dX � Z� dY � Z� dZ � Z� d[ � Z� d\ � Z� ea ea d] � Z� d^ � Z� d_ � Z� d` � Z� da � Z� db � Z� dc � Z� dd � Z� ee ee de � Z� df � Z� dg � Z� ee dh � Z� ee di � Z� dj � Z� dk � Z� ea eP dl � Z� dm � Z� dn � Z� do � Z� dp � Z� dq � Z� ee dr � Z� ds � Z� ea ea ea ea dt � Z� du � Z� dv � Z� ee dw � Z� d' d+ d+ ea dx � Z� ea ee dy � Z� ea ee dz � Z� ea ee ee d{ � Z� ea d| � Z� d, eP eP ee ea ea d} � Z� ee ea eP ea ea eP ee ee ea d~ d �
Z� ea ea ea d� � Z� ea ea ea d� � Z� ea ea d� d� � Z� d� � Z� d� � Z� ea ea d� d� � Z� d� � Z� ea ea d� d� � Z� d� � Z� ea ea d� d� � Z� d d ea ea d� d� � Z� ea d� � Z� e) j� j j� e� d� � Z� ea d� � Z� d� � Z� d� � Z� e) j� j j� e� d� � Z� d� � Z� ee d� � Z� d� � Z� d� � Z� d� � Z� d� � Z� d� � Z� d� � Z� d� � Z� d S(� u|
Manage information about regular files, directories,
and special files on the minion, set/read user,
group, mode, and data
i ( t absolute_importt print_functiont unicode_literalsN( t Iterablet Mappingt
namedtuple( t reduce( t six( t ranget zip( t urlparse( t CommandExecutionErrort MinionErrort SaltInvocationErrort get_error_message( t HASHESt
HASHES_REVMAPu makedirsu makedirs_u AttrChangesu
added,removedc C@ s t j j j � r t d f St S( u)
Only work on POSIX-like systems
ui The file execution module cannot be loaded: only available on non-Windows systems - use win_file instead.( t saltt utilst platformt
is_windowst Falset True( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt __virtual__N s c @ s� � j t j j t j � t j j j � � r� t
j j t
j t d � � } t � f d � | D� � } t j j � � r� | r� t j � � q� n d S( u(
Clean out a template temp file
u
file_rootsc 3@ s | ] } � j | � Vq d S( N( t
startswith( t .0t root( t sfn( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pys <genexpr>e s N( R t ost patht joint tempfilet
gettempdirR R t filest TEMPFILE_PREFIXt itertoolst chaint
from_iterableR t
itervaluest __opts__t anyt existst remove( R t all_rootst in_roots( ( R s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt __clean_tmp\ s c C@ s t | d <| | d <| S( uH
Common function for setting error information for return dicts
u resultu comment( R ( t rett err_msg( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _errork s
c C@ se t d | � } t d | � } t | | f � ra t | | f � rJ d S| rT d S| ra d Sn d S( uc
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.
u
files.is_textu Replace binary fileu" Replace binary file with text fileu" Replace text file with binary fileu ( t __utils__R( t all( t oldt newt old_isbint new_isbin( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _binary_replacet s
c C@ s t j j t d d � d � S( u@
Get the location of the backup dir in the minion cache
u
config.getu cachediru file_backup( R R R t __salt__( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _get_bkroot� s c C@ s> | j � } | j d � s* | j d � r: | j d � n | S( u�
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('')
u
u
u ( t
splitlinest endswitht append( t strt lines( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt' _splitlines_preserving_trailing_newline� s c C@ s� t j j j d � } | s. t j j j � r2 d S| g } t d | d t d t �} t
j d t j j j
| � � } | d k r� d } n | j d � } | S( u0
Return the version of chattr installed
u tune2fsu cmd.runt ignore_retcodet python_shellu tune2fs (?P<version>[0-9\.]+)u versionN( R R R t whichR t is_aixt NoneR8 R R t ret searcht stringutilst to_strt group( t tune2fst cmdt resultt matcht version( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _chattr_version� s c C@ sM t � } | d k r t St j j j d � } t j j j | � } | | k S( u|
Return ``True`` if chattr supports extended attributes, that is,
the version is >1.41.22. Otherwise, ``False``
u 1.41.12N( RO RD R R R t versionst LooseVersion( t vert needed_versiont chattr_version( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _chattr_has_extended_attrs� s c C@ ss y t | � } Wn t k
r/ t | � } n X| d k r@ d Sy t j | � j SWn t t f k
rn | SXd S( u�
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
u N( t intt
ValueErrort group_to_gidt grpt getgrgidt gr_namet KeyErrort NameError( t gid( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt gid_to_group� s
c C@ sP | d k r d Sy' t | t � r& | St j | � j SWn t k
rK d SXd S( u�
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
u N( RD t
isinstanceRV RY t getgrnamt gr_gidR\ ( RI ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRX � s
c C@ s( t t j j | � d | �j d d � S( u^
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
t follow_symlinksu gidi����( t statsR R t
expandusert get( R Rc ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_gid s c C@ s( t t j j | � d | �j d t � S( uW
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 u group( Rd R R Re Rf R ( R Rc ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_group s c C@ s3 y t j | � j SWn t t f k
r. | SXd S( u�
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
N( t pwdt getpwuidt pw_nameR\ R] ( t uid( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt uid_to_user5 s
c C@ sa | d k r! t j j j � } n y' t | t � r7 | St j | � j SWn t
k
r\ d SXd S( u�
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
u N( RD R R t usert get_userR` RV Ri t getpwnamt pw_uidR\ ( Rn ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt user_to_uidI s
c C@ s( t t j j | � d | �j d d � S( u\
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 u uidi����( Rd R R Re Rf ( R Rc ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_uid` s c C@ s( t t j j | � d | �j d t � S( uT
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 u user( Rd R R Re Rf R ( R Rc ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRo v s c C@ s( t t j j | � d | �j d d � S( uI
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 u modeu ( Rd R R Re Rf ( R Rc ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_mode� s c C@ s� t j j | � } t j | � j d � } | s9 d } n t j j | � sc t d j | � � � n y t j | t
| d � � Wn t k
r� d | SXt | � S( u�
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
u 0Oou 0u {0}: File not foundi u
Invalid Mode (
R R Re R t text_typet lstripR) R t formatt chmodRV t ExceptionRt ( R t mode( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt set_mode� s
c C@ s� t j j | � } t | � } t | � } d } | d k rX | rO | d 7} qX d } n | d k r� | rw | d 7} q� d } n t j | | | � S( u+
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
u u User does not exist
i����u Group does not exist
( R R Re Rr RX t lchown( R Rn RI Rl R^ t err( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR| � s
c C@ s� t j j | � } t | � } t | � } d } | d k rX | rO | d 7} qX d } n | d k r� | rw | d 7} q� d } n t j j | � s� y t j | | | � SWn t k
r� n X| d 7} n | r� | St j | | | � S( u
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
u u User does not exist
i����u Group does not exist
u File not found( R R Re Rr RX R) R| t OSErrort chown( R Rn RI Rl R^ R} ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR � s*
c C@ s. t j j | � } t | � } t | | | � S( u�
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 Re Ro R ( R RI Rn ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt chgrp s c C@ s� t j j j � r d Sy t | � j | d � } Wn t k
rF d SXt | � } t | � } t d d j
| | � p{ d d d j
| | � p� d � S( u�
.. 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
u t addedt removedN( R R R RC RD t lsattrRf t AttributeErrort sett AttrChangesR ( R t attrst lattrsR4 R3 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
_cmp_attrs+ s
c C@ s� t j j j d � s( t j j j � r, d
St j j | � sM t d � � n d | g } t
d | d t d t �} i } xl | j
� D]^ } | j d � s� | j d
d � \ } } t � r� d } n d } t j | | � | | <q� q� W| S( uV
.. 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
u lsattru! File or directory does not exist.u cmd.runR@ RA u lsattr: i u [aAcCdDeijPsStTu]u [acdijstuADST]N( R R R RB R RC RD R R) R
R8 R R R: R t splitRU RE t findall( R RK RL t resultst lineR� t filet pattern( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� O s ( c O@ sZ | j d d � } | j d d � } | j d d � } | j d d � } | d k s` | d k ro t d � � n | d k r� t d � � n d g } | d k r� d
j | � } n | d k r� d j | � } n | j | � | d k r| j d j | � � n | d k r#| j d | g � n | j | � t d
| d t �} t | � rVt St S( uI
.. 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
u operatoru
attributesu flagsu versionu addu removeu9 Need an operator: 'add' or 'remove' to modify attributes.u" Need attributes: [aAcCdDeijPsStTu]u chattru +{0}u -{0}u -vu cmd.runRA N( u addu remove(
t popRD R
Rw R< t extendR8 R t boolR ( R! t kwargst operatort
attributest flagsRN RK R� RL ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt chattrz s0
u sha256c C@ sA t j j | � } t j j | � s( d St j j j | | d � S( uq
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
u File not foundi ( R R Re t isfileR R t hashutilst get_hash( R t form( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_sum� s i c C@ s% t j j j t j j | � | | � S( uT
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 Re ( R R� t
chunk_size( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s u u basec @ s� � f d � } d
} t j j � � r0 � } n� yr t � � j } | t j j j k r� t
d � | � } | s� t d j � � � � q� n | d k r� | � n Wn t
t f k
r� | � n X| d
k rt | d | | | � } | d
k r� | � n | d j � | d <| Si } y= g � j d d � D] } | j � ^ q1\ | d <| d <Wn� t
k
rr| � ns t k
r�t j d j t j � � � s�| � n � | d <t � � }
|
t k r�t |
| d <q�| � n X| d t k r$t d
j | d d j t � | d � � � ng t | d � } | t k rJ| � nA | t | d k r�t d j | | d | d t | � � � n | d j � | d <| Sd
S( uV
.. 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://``).
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
@ sc t d j � d j t j j j � d j g t t � D] } d j t | | � ^ q4 � � � � d S( uD
DRY helper for reporting invalid source_hash input
uk Source hash {0} 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: {1}. The hash may also not be of a valid length, the following are supported hash types and lengths: {2}.u , u {0} ({1})N( R Rw R R R R! t VALID_PROTOSt sortedR ( t x( t source_hash( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _invalid_source_hash_format$ s u
cp.cache_fileu Source hash file {0} not foundu u hsumu =i u hash_typeu ^[{0}]+$u� Invalid hash type '{0}'. Supported hash types are: {1}. Either remove the hash type and simply use '{2}' as the source_hash, or change the hash type to a supported type.u , u� Invalid length ({0}) for hash type '{1}'. Either remove the hash type and simply use '{2}' as the source_hash, or change the hash type to '{3}'N( RD R R t isabst _urlparset schemeR R R! R� R8 R Rw R� t TypeErrort extract_hasht lowerR� t stripRW RE RM t stringt hexdigitst lenR R R ( t file_namet sourceR� t source_hash_namet saltenvR� t hash_fnt protoR. R� t source_hash_lent hsum_len( ( R� s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_source_sum� sd .
=
&
c
C@ s� t j j | � } t | t j � s3 t d � � n x� d D]. } | | k r: | j | d � \ } } Pq: q: W| } t | � } t j
| � } | d k r� t d j | | d j
g t t � D] } d j t | | � ^ q� � � � � n t | | � | k S(
uI
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
u hash must be a stringu :u =i us Hash {0} (length: {1}) could not be matched to a supported hash type. The supported hash types and lengths are: {2}u , u {0} ({1})( u :u =N( R R Re R` R t string_typesR
R� R� R Rf RD Rw R R� R� ( R t file_hasht sept hash_typet
hash_valuet hash_lenR� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
check_hash� s&
8c O@ s� d | k r d | d <n d | k r2 d | d <n y t j j j | � } Wn t k
rj } d j | � SXg g t j t j j | � � D] } | j | � ^ q� D] } | D] } | ^ q� q� } | j
� | S( u�
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
u deleteu fu printu pathu
error: {0}( R R t findt FinderRW Rw t globR R Re t sort( R t argsR� t findert ext pt it itemR. ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s r
W
c C@ s^ d } | j d d � j d d � } | t k rZ x' | D] } | j | d | � } q7 Wn | S( u2
Escape single quotes and forward slashes
u ^.[$()|*+?{u 'u '"'"'u /u \/u \( t replaceR ( R� t
escape_allt
special_charst char( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _sed_esc= s
u .baku -r -eu gc
C@ sQ t j j | � } t j j | � s( t St j | � } t j | � } t | | � } t | | � } t | | � } t j d k r� | j
d d � } n d g } | j | r� d j | � n d � | j
t j j j | � � | j d j d | rd j | � n d
d | rd n d
d
| d | d | � � | j | � t d | d t �S( u�
.. 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'
u darwinu -ru -Eu sedu -i{0}u -iu/ {limit}{negate_match}s/{before}/{after}/{flags}t limitu /{0}/ u t negate_matchu !t beforet afterR� u cmd.run_allRA ( R R Re R) R R Ru R� t sysR R� R< Rw R� R R R� t shlex_splitR8 (
R R� R� R� t backupt optionsR� R� R� RK ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt sedI s, 7 "
c C@ s t j j | � } t j j | � s( t St t j | � t � } t t j | � t � } d } t j d k r� | j
d d � } n d g } | j t j
j j | � � | j d j d | r� d j | � n d d
| d d j | � � � | j | � t d
| d t �} t | � S( uh
.. 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'
u -n -r -eu darwinu -ru -Eu sedu {limit}s/{before}/$/{flags}R� u /{0}/ u R� R� u p{0}u cmd.runRA ( R R Re R) R R� R Ru R� R R� R� R R R� R� R< Rw R8 R� ( R t textR� R� R� R� RK RL ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt sed_contains� s$
u gMSc C@ sn t j j | � } t | � } t j | � } t j | � } t | | � } t | | � } t j | d j | | � � t
j j j
| d � �� } t
j j j
d j | | � d � �� } | t k rx� | j � D]C }
| j t
j j j t t
j j j |
� | | | | � � � q� WnC | j t
j j j t t
j j j | j � � | | | | � � � Wd QXWd QXd S( u�
.. 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'
u {0}{1}u wu rN( R R Re R� R Ru R� t shutilt copy2Rw R R R! t fopenR t readlinet writeRG RH t _psedt
to_unicodet read( R R� R� R� R� R� R� t multit ofilet ifileR� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt psed� s6 ; ' u Iu Lu Mu Su Uu Xc
C@ s� | } | r@ t j | � } | j | � } d j | d � } n d } d | k rm d } | j d d � } n d } x | D] } | t | O} qz Wt j | d | �} t j | | | d | �} | S( uS
Does the actual work for file.psed, so that single lines can be passed in
u i u gi R� t count( RE t compileR� R R� t
RE_FLAG_TABLEt sub(
R� R� R� R� R� t atextt compsR� t aflagst flag( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� ; s
u #c C@ s% t d | d | d | d t d | � S( uj
.. 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'
R t regexR� t cmntR� ( t comment_lineR ( R R� R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt uncommentX s
c C@ s% t d | d | d | d t d | � S( u�
.. 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
R R� R� R� R� ( R� R ( R R� R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt comment} s
# c C@ s: | rZ d j | j d � r! d n d | j d � j d � | j d � rN d n d � } n< d j | | j d � j d � | j d � r� d n d � } t j j t j j | � � } t j j | � s� t
d j | � � � n t d | � st
d j | � � � n t } g } g } t j j
| � } y� t j j j | d d
d | ��� } x� | D]{ }
t j j j |
� }
t j | |
� rX| j |
� | r�| j d j | |
� � n | j |
j | � � t } qXqXWWd
QXWn1 t t f k
r} t d j | | � � � n X| s t St j j j � sdt | � } t | � }
t j j j t | � � } n y t! d | d t � } Wn. t t f k
r�} t d j | � � � n Xy�t" j# r�t j j j � r�d n d } t j j j | d | d | ��^} y&t j j j | d d
d | ��� } x� | D]� }
t j j j |
� }
y� t j | |
� r�| rud j | |
� } q�|
j | � } n |
} t" j# r�t j j j � r�t j j j$ | � n t j j j% | � } | j& | � Wq*t t f k
r} t d j | | | � � � q*Xq*WWd
QXWn. t t f k
rR} t d j | � � � n XWd
QXWn. t t f k
r�} t d j | � � � n X| r�d j | | � } y t' j( | | � Wq�t t f k
r�} t d j | | | � � � q�Xn
t j) | � t j j j � s)t* | d
| |
| � n t d | | � S( u�
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'
u {0}({1}){2}u ^u u $u ^{0}\s*({1}){2}u File not found: {0}u
files.is_textu8 Cannot perform string replacements on a binary file: {0}Rz u rbt bufferingu {0}{1}Nu) Unable to open file '{0}'. Exception: {1}R t preserve_inodeu Exception: {0}u wbu wul Unable to write file '{0}'. Contents may be truncated. Temporary file contains copy at '{1}'. Exception: {2}uK Unable to move the temp file '{0}' to the backup file '{1}'. Exception: {2}u stringutils.get_diff(, Rw R Rv t rstripR; R R t realpathRe R� R
R1 R t getsizeR R R! R� RG R� RE RM R< R R~ t IOErrorR R R Ro Rh t normalize_modeRt t
_mkstemp_copyR t PY2t to_bytesRH R� R� t moveR* t check_permsRD ( R R� R� R� R� t foundt orig_filet new_filet bufsizet r_fileR� t exct pre_usert pre_groupt pre_modet temp_fileRz t w_filet wlinet backup_name( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s� 3!
'
0$#
c C@ s� t | t j � r | g } n t | t � r� t | t � r� g } xc | D][ } t t t j | � j � � } t | t j � s� t
d j | � � � n | j | � qJ Wt
t j | � St | t j � r� | St
d j | � � � d S( u#
Return an integer appropriate for use as a flag for the re module from a
list of human-readable strings
.. code-block:: python
>>> _get_flags(['MULTILINE', 'IGNORECASE'])
10
>>> _get_flags('MULTILINE')
8
>>> _get_flags(2)
2
u Invalid re flag given: {0}uj Invalid re flags: "{0}", must be given either as a single flag string, a list of strings, or as an integerN( R` R R� R R t getattrRE Ru t uppert
integer_typesR
Rw R< R R� t __or__( R� t
_flags_accR� t _flag( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
_get_flags] s
c C@ s t | � } t | � } | | BS( u-
Combine ``flags`` and ``new_flags``
( R ( R� t new_flags( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
_add_flags� s c C@ s� d } y% t j j j d t j j j � } Wn. t t f k
r[ } t d j | � � � n X| r� y t
j | | � Wq� t t f k
r� } t d j | | | � � � q� XnK y t
j | | � Wn4 t t f k
r� } t d j | | | � � � n X| S( uZ
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``.
t prefixu* Unable to create temp file. Exception: {0}u@ Unable to copy file '{0}' to the temp file '{1}'. Exception: {2}u@ Unable to move file '{0}' to the temp file '{1}'. Exception: {2}N(
RD R R R! t mkstempR" R~ R� R Rw R� R� R� ( R R� R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s* %c C@ s1 d � } d � } d } d } | s, | r0 | S| j d � } | j d � } | | k r^ | S| | rs | | � pv | � } | | r� | | � p� | � } t | � t | � k r� | | f p� | | f \ } } d j | � } xK t t | � � D]7 } d j | | d � }
|
r� | j |
� r� | Sq� W| S( uZ
Returns True if src and probe at least matches at the beginning till some point.
c S@ sH | j d d � } t | � d k rD t | d � d k rD | d pG | S( u�
Strip possible comments.
Usually comments are one or two symbols at the beginning of the line, separated with space
u i i i ( R� R� ( t txtt buff( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _strip_comments� s c S@ s> | r: g | j � j d � D] } | j � r | ^ q p= | S( u
Split by words
u ( R� R� ( R t w( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _to_words� s i����i u
u i ( R� R� R R R ( t srct probet strip_commentsR R t no_matcht equalt a_bufft b_bufft idxt prb( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _starts_till� s& 6c C@ s� | s | r d SyP t j | t j � } g | D]* } | j | � sU | j | � r1 | ^ q1 } Wn1 t k
r� } t d j t | � | � � � n X| r� | p� g S( u4
Expand regular expression to static match.
u
{0}: '{1}'N(
RD RE R� t DOTALLRF R� Ry R Rw t _get_error_message( R R� t compiledR� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _regex_to_static� s ;"i c C@ sp t | � } | | k r! d } n* | | k r6 d } n | sE d } n d } | rl t d j | | � � � n | S( u\
Raise an exception, if there are different amount of specified occurrences in src.
u more thanu less thanu nou2 Found {0} expected occurrences in "{1}" expressionN( R� RD R Rw ( R t targett amountt occt msg( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _assert_occurrence� s c C@ sU | s
| Sg } x+ | D]# } | d k r- Pn | j | � q Wd j | � | j � S( u/
Indent the line with the source line.
u u u ( u u ( R< R Rv ( R R� t indentt idtt c( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _set_line_indent s
c C@ s( t j d | � } | r$ | j � p' d S( Nu ((?<!
)
|
(?!
)|
)$u ( RE RF RI ( R� RM ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _get_eol s c C@ s# t | � p t j } | j � | S( u
Add line ending
( R0 R t linesepR� ( R R� t line_ending( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
_set_line_eol% s c C@ sW | s* | rS t | | d | � d k rS t | | | | � } | j | | � n | S( Ni i ( R" R/ t insert( R t bodyt contentR, t cnd( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _insert_line_before- s *c C@ s| | d t | � k r$ | | d p' d } | d k sK t | | � d k rx t | | | | � } | j | d | � n | S( Ni i ( R� RD R" R/ R4 ( R R5 R6 R, t next_lineR7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _insert_line_after4 s
*!c C@ s� t j j t j j | � � } t j j | � sR | sN t d j | � � � n t S| rd | j � pg | } | d# k r� | d k r� t d � � q� t d j | � � � n d g } | | k r� | d k r� t d j d j
| � � � � n ~ | d k r| d k r| r| } n t j j
j | d
d ��" } t j j j | j � � }
Wd QXt j t j j j d
j
|
� � � j � } |
r�t |
d � r�|
j d
� n t |
| � } t |
| � } t |
| � } t j | � j d k r| d$ k rt j d j | | � � g }
n| d k rY| rYg |
D] } | | d k r4| ^ q4}
n�| d k r�| r�|
j | d � } |
j | � } |
j | t! | | |
� � np| d k r�| r�| r�| r�t d � � n | s| r�| r�t" | d � t" | d � g } t } xl |
D]d } | | d k r:t# } n8 | | d k rr| rrt! | | |
� } | j | � n | j | � qW| }
n | r�| r�t" | d � |
j | d � } t$ | |
| |
� }
q�| r�| r�t" | d � |
j | d � } t% | |
| |
� }
q�q | d k rb|
rK|
j d t& |
d | � � q�|
j | t j' � q | d k r |
j |
r�t! |
d | |
� n | � q n| d k r | r�| r�t" | d � t" | d � t( g |
D] } | j) | � r�| ^ q�� } | s|
j | d � } | t* |
� d k rq|
| d | d k rqt! |
| | |
� } |
j | d | � q�t d � � qq | r�| r�t" | d � |
j | d � } t$ | |
| |
� }
q | r
| r
t" | d � |
j | d � } t% | |
| |
� }
q t d � � n |
r�xm t+ |
� D]_ \ } } t | � r/| d t* |
� k r/| rn| d pqd } t& |
| | � |
| <q/q/Wd
|
d k r�|
j � q�n | t j t j j j d
j
|
� � � j � k } | r| rt, d t k ryG t- d | d t# � } t. j/ | d j | t0 j1 d t0 j2 � � � � Wqt3 t4 f k
r{} t d j | | � � � qXn d } | r�| r�t j j
j | d � �+ } t j j j | j5 � j6 t# � � } Wd QXt7 d | |
� } n t, d t k r�d } z� t8 j9 r>t j j: j; � r>d } t j j j< |
� }
n! d! } t j j j |
d" t# �}
t j j= j> | | � } | j? |
� Wd | r�| j@ � n Xq�n | r�| p�| S(% uj
.. versionadded:: 2015.8.0
Edit a line in the configuration file. The ``path`` and ``content``
arguments are required, as well as passing in one of the ``mode``
options.
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 becomes 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. This is based on the
``content`` argument.
- replace
If line already exists, it will be replaced.
- delete
Delete the line, once found.
- insert
Insert a line.
.. 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
Defines where to place content in the line. 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. Valid
locations are:
- 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.
This option is only used when either the ``ensure`` or ``insert`` mode
is defined.
after
Regular expression or an exact case-sensitive fragment of the string.
This option is only used when either the ``ensure`` or ``insert`` mode
is defined.
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.
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"
u, File "{0}" does not exists or is not a file.u insertu ensureu deleteu replaceu. Mode was not defined. How to process the file?u Unknown mode: "{0}"u* Content can only be empty if mode is "{0}"u , Rz u rNu i����i u- Cannot find text to {0}. File '{1}' is empty.uI On insert must be defined either "location" or "before/after" conditions.u beforeu afteru startu endi uA Found more than one line between boundaries "before" and "after".u\ Wrong conditions? Unable to ensure line without knowing where to put it before and/or after.u testR R� u {0}.{1}u %Y-%m-%d-%H-%M-%Su7 Unable to create the backup file of {0}. Exception: {1}u stringutils.get_diffu wbu wRH ( u insertu ensureu deleteu replace( u deleteu replace(A R R R� Re R� R Rw R R� RD R R R R! R� t datat decode_listt readlinest hashlibt sha256RG R� t hexdigestR0 R< R& t statt st_sizet logt warningt indexR� R4 R/ R+ R R8 R: R3 R1 R� R� R� t enumerateR' R� R� R� t timet strftimet localtimeR~ R� R� R: R1 R R� R R t encode_listt
atomicfilet atomic_opent
writelinest close( R R6 RM Rz t locationR� R� t show_changesR� t quietR, t empty_content_modest fp_R5 t body_beforeR� R t file_linet outt in_rangeR7 t lt is_theret prevt changedR R t changes_difft path_contentt fh_( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� = s� g ! !-$ ,
/
..
# 3 2 *i c + C@ s~ t } t | � r< t } t j | � } t j j | � } n t j j t j j | � � } t j j | � s� |
rv t St d j
| � � � n t d | � s� t d j
| � � � n | r� | s� | r� t d � � n | r� | r� t d � � n t | � } t
j t j j j | � | � } t j j | � } | d k rF| } n t } g } g } t j j j � s�t | � } t | � } t j j j t | � � } n t j j j t j | � � } | r�t j j j | � } n t } d } | r| s�| rt j j j | � n t j j j | � } z�y�d } t j j j | d d d | ���} y% t j | j! � d
d t j" �} Wn8 t# t j$ f k
r�t j j j d j% | � � } n X| r�t
j& | | � r�t St Sn� t
j' | | r�| j( d
d � n | | | � \ }! }" |" d
k r:t } | | k r1t n | } n | sF| r�t
j& t j j j d j
t
j) | � � � | d | �r�t } q�n t* | t j � r�| j+ | � j, t � n | j, t � } |! j, t � } Wd QXWn1 t- t. f k
r
}# t/ d j
| |# � � � n XWd | r7t* | t j � r7| j0 � n X| r1|
r1y t1 d | d | � } Wn. t- t. f k
r�}# t/ d j
|# � � � n Xd } yht j j j | d d d | ��A}$ zy� t j j j | d d d | ��� } t j | j! � d
d t j" �} t
j' | | r(| j( d
d � n | | | � \ }! }" y |$ j2 t j j j3 |! � � Wn4 t- t. f k
r�}# t/ d j
| | |# � � � n XWd QXWn. t- t. f k
r�}# t/ d j
|# � � � n XWd | r�t* | t j � r�| j0 � n XWd QXWq1t- t. f k
r-}# t/ d j
|# � � � q1Xn | r�| sD| r�| d k rY| } n | r�| j4 d
| t j j j t j5 � � n� d
t6 | � k r�| d j7 t j j j t j5 � � s�| d c t j j j t j5 � 7<q�n | j8 | t j j j t j5 � � t } |
s�y t1 d | d | � } Wn. t- t. f k
r_}# t/ d j
|# � � � n XzI t j j9 j: | d � }% x* | D]" }& |% j2 t j j j |& � � q�WWd |% j0 � Xq�n | r�| r�|
r�d j
| | � }' y t; j< | |' � Wn4 t- t. f k
r,}# t/ d j
| | |# � � � n X| r d j
| | � }( d j
| | � }) y t j= |) |( � Wq�t- k
r�t j> |( � t j= |) |( � q�t? k
r�t/ d j
|( |) |# � � � q�Xq nN | r y t j> | � Wq t- t. f k
r }# t/ d j
| |# � � � q Xn |
rN t j j j � rN t@ | d | | | � n t d | | � }* | rk |* S|* sz t } n | S( u�
.. 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]'
u File not found: {0}u
files.is_textu8 Cannot perform string replacements on a binary file: {0}u; search_only cannot be used with append/prepend_if_not_foundu8 Only one of append and prepend_if_not_found is permittedu fileRz u rbR� i t accessu u \u \\u ^{0}($|(?=
))R� Nu) Unable to open file '{0}'. Exception: {1}R R� u Exception: {0}u wu rul Unable to write file '{0}'. Contents may be truncated. Temporary file contains copy at '{1}'. Exception: {2}i����u wbu {0}{1}uK Unable to move the temp file '{0}' to the backup file '{1}'. Exception: {2}uD Unable create backup symlink '{0}'. Target was '{1}'. Exception: {2}u0 Unable to delete temp file '{0}'. Exception: {1}u stringutils.get_diff(A R t is_linkR R t readlinkR Re R� R) R
Rw R1 R RE R� R R RG R� R� R R Ro Rh R! R� Rt R Ru RD R� R� t mmapt filenot ACCESS_READRW t errorR RF t subnR� t escapeR` R� R: R~ R� R RN R� R� RH R4 R1 R� R; R< RK RL R� R� t symlinkR* Ry R� (+ R R� t replR� R� R� t append_if_not_foundt prepend_if_not_foundt not_found_contentR� t dry_runt search_onlyRP t ignore_if_missingR� t backslash_literalRh t target_patht
given_patht flags_numt cpatternt filesizet has_changesR� R� R R R R� R R6 t r_dataR RL t nreplR R R^ R� R t symlink_backupt
target_backupt differences( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� G sP � ! ' " * *
)%(#
$
u #-- start managed zone --u #-- end managed zone --c
@ s� | r | r t d � � n t j j | � } t j j | � sW t d j | � � � n y t d | � }
Wn t k
r� d }
n Xt d | � r� |
s� t d j | � � � q� n � d k r� | j t j
d f � r� t � n g � x> | j d � D]- } x$ | j d � D] } � j
| � qWq� Wt � � � t }
g } g } t } t } d } d t d � � � � � f d � } zMyt j | d d
d |
d d
�} x� | D]� } t } | d k r| j d � r�d } q| j d � r�d } qt j
} n � | k rt } nY | rot } | j � � } | d k rot } t } | | d | d t d | | �qon | j
| � | r�| j
| � q�q�WWn1 t t f k
r�} t d j | | � � � n XWd | d k r�t j
} n y | j � Wn t k
rn XX| r t d � � n | s�| rS| | � } | j | � | } t } q�| r�d t | � k r�| d j | � s�| d c | 7<q�n | | d | �t } q�t d � � n | r�t d | | � } | d
k }
|
r�| r�i } t | � | d <t | � | d <t j j j t | � � | d <| t k r�d j | | � } t j | | � t j j! j" � r�t# d | d d d | d � q�t# d | d d d | d d! | d d | d � n zO t j j$ j% | d" � } x0 | D]( } | j& t j j' j( | d |
�� q�WWd | j � Xt j j! j" � rVt# d | d d d | d � q�t# | d d d | d d! | d d | d �n | r�| Sn |
S(# u
.. 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.
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
u8 Only one of append and prepend_if_not_found is permittedu File not found: {0}u files.get_encodingu files.is_binaryu8 Cannot perform string replacements on a binary file: {0}u
u
c @ s� | d k r g } t } n | d k r0 � } n | j d � | } | r] | j � | � n � r� x� t � d � D]d \ } } | � k r� | j | | � qs � r� | j | | � | j | � qs | j | | � qs Wn
| j | � | S( Nu
i ( RD R R� R< RF ( R1 R> t include_marker_startt end_lineRE t content_line( t append_newlinet
line_countt
marker_endt marker_startt
split_content( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _add_contentH
s$
Rz u rt encodingt newlineu i����R> R| R} u Failed to read from {0}: {1}NuA Unterminated marked block. End of file reached before marker_end.i u9 Cannot edit marked block. Markers were not found in file.u stringutils.get_diffu useru groupu modeu {0}{1}R R. t ownert nameRn RI u wb() R
R R Re R) Rw R1 R RD R; R1 R R� R< R� R t iot openR� R� R~ RN Ry R� Ro Rh R R R! R� Rt R� R� R R R� RK RL R� RG R� ( R R� R� R6 Rj Rk R� Rm RP R t
file_encodingt win_lineR~ Rv R� R� t in_blockt block_foundR1 R� t fi_fileR� t write_line_to_new_filet marker_end_posR t prepended_contentt difft permst backup_pathR^ ( ( R R� R� R� R� s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt blockreplace� s� Y
% !
*
c C@ sR | r t | d � } d } n t | | d d | d | d t d t d t d | �S(
u�
.. 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'
u MULTILINEu fileu R� R� Rm Rn RP Ro ( R R� R R ( R R� R� R� Ro t multiline( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRF �
s c C@ s� t j j j d � } | s* t d � � n | g } | j t j j j | � � | r� t d d k ru | j d � q� | j d � n d | k r� d | k r� | j d � n t
} xB | D]: } | d
k s� | j d � s� | j d � r� t } Pq� q� W| s| j d
� n | j d | g � t
j j | � r�| j d | g � t
} x6 | D]. } | j d � sw| j d � rSt } PqSqSW| s�| j d � q�n
| j | � t d | d t
�S( uX
.. 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.
CLI Example:
.. code-block:: bash
salt '*' file.patch /opt/file.txt /tmp/file.txt.patch
u patchuJ patch executable not found. Is the distribution's patch package installed?u kernelu FreeBSDu OpenBSDu -Cu --dry-runu -Nu --forwardu -ru -r u
--reject-fileu --reject-file=-u -iu -du -pu --strip=u --strip=0u cmd.run_allRA ( u FreeBSDu OpenBSD( R R R RB R R� R� R� t
__grains__R< R R R R t isdirR8 ( t originalfilet patchfileR� Rm t patchpathRK t has_rejectfile_optiont optiont has_strip_option( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt patch# s@
c C@ s� t j j | � } t j j | � s( t St j | � j � } yG t j j
j | � �( } x | D] } | | k r_ t Sq_ WWd QXt SWn t
t f k
r� t SXd S( u�
.. 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'
N( R R Re R) R R Ru R� R R t
filebuffert BufferedReaderR R� R~ ( R R� t
stripped_textt breadert chunk( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt containsu s
c C@ s� t j j | � } t j j | � s( t Sy} t j j j | d � �_ } xQ | D]I } t j j j
| � } | r� | j | � } n t j
| | � rM t SqM Wt SWd QXWn t t f k
r� t SXd S( u�
.. 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
u rN( R R Re R) R R R R! R� RG R� Rv RE RF R R� R~ ( R R� t lcharR' R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt contains_regex� s
c C@ s� t j j | � } t j j | � s( t SyM t j j j | � �2 } x$ | D] } t j | | � rJ t
SqJ Wt SWd QXWn t t f k
r� t SXd S( u�
.. 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*'
N(
R R Re R) R R R R� R� t fnmatchR R� R~ ( R t glob_exprR� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
contains_glob� s
c O@ s� t j j | � } d | k rN t | d t � r> | d } qN | d g } n t j j j | d � �� } t j j j
t j � } y | j t
| � t j � Wn4 t k
r� } | j t j t j f k r� q� n? X| j t
| � � | k r| j d t j � | j | � n Wd QXt j j j | d � �C } x9 | D]1 } | j t j j j d j | t j � � � q<WWd QXd j t
| � | � S( u�
.. 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']"
u argsu rb+i Nu au {0}{1}u Wrote {0} lines to "{1}"( R R Re R` t listR R R! R� RG R� R1 t seekR� t SEEK_ENDR� t errnot EINVALt ESPIPER� R� RH Rw ( R R� R� R� R1 R t new_line( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR< � s, !
#c O@ sK t j j | � } d | k rN t | d t � r> | d } qN | d g } n yP t j j j | � �5 } g | j � D] } t j j
j | � ^ qv } Wd QXWn t k
r� g } n Xg } x$ | D] } | j
d j | � � q� Wt j j j | d � �6 } | | } | j t j j
j d j | � � � Wd QXd j t | � | � S( u�
.. 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']"
u argsNu {0}
u wu u Prepended {0} lines to "{1}"( R R Re R` R� R R R! R� R= RG R� R� R< Rw R� RH R R� ( R R� R� t fhrR� t contentst prefaceR� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt prepend s$ !
5
+c O@ s� t j j | � } d | k rN t | d t � r> | d } qN | d g } n g } x$ | D] } | j d j | � � q[ Wt j j j
| d � �, } | j t j j j
d j | � � � Wd QXd j t | � | � S( u�
.. 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']"
u argsu {0}
u wu Nu Wrote {0} lines to "{1}"( R R Re R` R� R< Rw R R R! R� R� RG RH R R� ( R R� R� R� R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� S s
+c C@ sZ t j j | � } | r3 | j � r3 t | � } n | rT | j � rT t | � } n y� t j j | � s� t j j j | d � � Wd QXn | r� | r� d } nP | r� | r� | t j � f } n. | r� | r� t j � | f } n | | f } t j | | � WnD t
k
r"t d � � n( t t f k
rI} t | j � � n Xt j j | � S( um
.. 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
mtime:
Last modification in Unix epoch time
CLI Example:
.. code-block:: bash
salt '*' file.touch /var/log/emptyfile
u aNu atime and mtime must be integers( R R Re t isdigitRV R) R R R! R� RD RG t utimeR� R
R� R~ R t strerror( R� t atimet mtimet timesR ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt touch� s,
c C@ sq t j j | � } t j | t j � } z5 t j | t | � d � t j | t | � � } Wd t j | � X| S( u.
.. 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
i N( R R Re R� t O_RDONLYt lseekRV R� RN ( R t sizet offsett seek_fhR; ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt seek_read� s c C@ sx t j j | � } t j | t j � } z< t j | t | � d � t j | | � } t j | � Wd t j | � X| S( u@
.. 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
i N(
R R Re R� t O_WRONLYR� RV R� t fsyncRN ( R R; R� R� R. ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
seek_write� s c C@ sJ t j j | � } t j j j | d � � } | j t | � � Wd QXd S( u
.. 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
u rb+N( R R Re R R R! R� t truncateRV ( R t lengthR� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s c C@ s~ t j j | � } t j j | � s3 t d � � n y t j | | � t SWn, t t f k
ry t d j
| � � � n Xt S( u�
.. 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
u File path must be absolute.u Could not create '{0}'( R R Re R� R
t linkR R~ R� R Rw R ( R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR�
s c C@ s t j j t j j | � � S( u�
Check if the path is a symbolic link
CLI Example:
.. code-block:: bash
salt '*' file.is_link /path/to/link
( R R t islinkRe ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR` !
s c C@ s� t j j | � } yH t j j t j | � � t j j | � k rY t j d | | � t SWn t k
rm n Xt j j | � s� t
d � � n y t j | | � t SWn, t t f k
r� t
d j | � � � n Xt S( u�
Create a symbolic link (symlink, soft link) to a file
CLI Example:
.. code-block:: bash
salt '*' file.symlink /path/to/file /path/to/link
u' link already in correct state: %s -> %su File path must be absolute.u Could not create '{0}'( R R Re t normpathRa RC t debugR R~ R� R
Rh R� R Rw R ( R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRh 3
s
-
c C@ s� t j j | � } t j j | � } t j j | � sE t d � � n y t j | | � t SWn) t k
r� t d j | | � � � n Xt
S( u�
Rename a file or directory
CLI Example:
.. code-block:: bash
salt '*' file.rename /path/to/src /path/to/dst
u File path must be absolute.u Could not rename '{0}' to '{1}'( R R Re R� R
t renameR R~ R Rw R ( R t dst( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� Q
s
c C@ s� t j j | � } t j j | � } t j j | � sE t d � � n t j j | � so t d j | � � � n t j j
j � s� t | � } t
| � } t j j j t | � � } n y� t j j | � r� t j j | � s� t j j | � rY| st d � � n | r@t j j | � r-t j | � n t j | | � qit j j j | | � n t j | | � Wn) t k
r�t d j | | � � � n Xt j j
j � s�t | d | | | � n t S( u�
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
u File path must be absolute.u No such file or directory '{0}'uE Cannot copy overwriting a directory without recurse flag set to true!u Could not copy '{0}' to '{1}'N( R R Re R� R
R) R Rw R R R R Ro Rh R! R� Rt R� R� t rmtreet copytreet recursive_copyt copyfileR~ R� RD R ( R R� t recurset remove_existingR R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt copyk
s6 6
c
@ sy t j j | � } t j j | � s3 t d � � n y- t j | � � t � f d � d D� � SWn t k
rt i SXd S(
u�
.. 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
u Path to file must be absolute.c 3@ s$ | ] } | t � | � f Vq d S( N( R ( R t key( t lst( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pys <genexpr>�
s u st_atimeu st_ctimeu st_gidu st_modeu st_mtimeu st_nlinku st_sizeu st_uidN( u st_atimeu st_ctimeu st_gidu st_modeu st_mtimeu st_nlinku st_sizeu st_uid( R R Re R� R
t lstatt dictRy ( R ( ( R� s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� �
s
c C@ s� t j j | � } t j j | � s3 t d � � n i t j d 6t j d 6t j d 6t j d 6} | | k r� t j | | | � S| t
j | � k r� t j | | � St d � � d S( u�
.. 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
u Path to link must be absolute.u fu ru wu xu Invalid mode specified.N( R R Re R� R
t F_OKt R_OKt W_OKt X_OKR_ R R& ( R Rz t modes( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR_ �
s
c C@ s] d } | t k r | d 7} n t j j j | | � � } t j j j | j � � SWd QXd S( u�
.. versionadded:: 2017.7.0
Return the content of the file.
CLI Example:
.. code-block:: bash
salt '*' file.read /path/to/file
u ru bN( R R R R! R� RG R� R� ( R t binaryt access_modet file_obj( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� �
s
c C@ s{ t j j | � } t j j | � s3 t d � � n t j j | � sT t d � � n | rj t j j | � St j | � Sd S( u�
.. versionadded:: 2014.1.0
Return the path that a symlink points to
If canonicalize is set to True, then it return the final target
CLI Example:
.. code-block:: bash
salt '*' file.readlink /path/to/link
u Path to link must be absolute.u A valid link was not specified.N( R R Re R� R
R� R� Ra ( R t canonicalize( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRa �
s
c C@ sz t j j | � } t j j | � s3 t d � � n t j j | � sT t d � � n d d g } | j t j | � � | S( u�
.. versionadded:: 2014.1.0
Return a list containing the contents of a directory
CLI Example:
.. code-block:: bash
salt '*' file.readdir /path/to/dir/
u Dir path must be absolute.u$ A valid directory was not specified.u .u ..( R R Re R� R
R� R� t listdir( R t dirents( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt readdir s c @ s� t j j | � } t j j | � s3 t d � � n y- t j | � � t � f d � d D� � SWn, t t f k
r� t d
j
| � � � n Xt S( u�
.. 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
u File path must be absolute.c 3@ s$ | ] } | t � | � f Vq d S( N( R ( R R� ( t stv( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pys <genexpr>F s u f_bavailu f_bfreeu f_blocksu f_bsizeu f_favailu f_ffreeu f_filesu f_flagu f_frsizeu f_namemaxu Could not statvfs '{0}'(
u f_bavailu f_bfreeu f_blocksu f_bsizeu f_favailu f_ffreeu f_filesu f_flagu f_frsizeu f_namemax( R R Re R� R
t statvfsR� R~ R� R Rw R ( R ( ( R� s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� 3 s c C@ sU t j j | � } i } t j j | � si y t j | � } Wq� t k
re t d j | � � � q� Xn' | r� t j | � } n t j | � } | j | d <| j
| d <| j | d <t | j � | d <t
| j
� | d <| j | d <| j | d <| j | d <| j | d
<t j j j t t j | j � � � | d <| rXt | | � | d <n d
| d <t j | j � r�d | d <n t j | j � r�d | d <n t j | j � r�d | d <n t j | j � r�d
| d <n t j | j � r�d | d <n t j | j � r d | d <n t j | j � r;d | d <n t j j! | � | d <| S( u�
Return a dict containing the stats for a given file
CLI Example:
.. code-block:: bash
salt '*' file.stats /etc/passwd
u Path not found: {0}u inodeu uidu gidu groupu useru atimeu mtimeu ctimeu sizeu modeu sumu fileu typeu diru charu blocku linku pipeu socketu target(" R R Re R) R� R~ R Rw RA t st_inot st_uidt st_gidR_ Rm t st_atimet st_mtimet st_ctimeRB R R R! R� t octt S_IMODEt st_modeR� t S_ISDIRt S_ISCHRt S_ISBLKt S_ISREGt S_ISLNKt S_ISFIFOt S_ISSOCKR� ( R R� Rc R. t pstat( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRd N sN
+
c C@ s� t j j | � } t j j | � s3 t d � � n t j j | � sT t d � � n y t j | � t SWn t k
r� } | j SXd S( u�
.. versionadded:: 2014.1.0
Remove the specified directory. Fails if a directory is not empty.
CLI Example:
.. code-block:: bash
salt '*' file.rmdir /tmp/foo/
u File path must be absolute.u$ A valid directory was not specified.N(
R R Re R� R
R� t rmdirR R~ R� ( R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s
c C@ s� t j j | � } t j j | � s< t d j | � � � n y\ t j j | � sc t j j | � rt t j | � t St j j
| � r� t j | � t SWn1 t
t f k
r� } t d j | | � � � n Xt S( u�
Remove the named file. If a directory is supplied, it will be recursively
deleted.
CLI Example:
.. code-block:: bash
salt '*' file.remove /tmp/foo
u File path must be absolute: {0}u Could not remove '{0}': {1}( R R Re R� R
Rw R� R� R* R R� R� R� R~ R� R R ( R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR* � s $
c C@ s t j j t j j | � � S( u�
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� Re ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt directory_exists� s c C@ s t j j t j j | � � S( u�
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� Re ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt file_exists� s c C@ s# t j t j j | � � r t St S( uM
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*
( R� R R Re R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt path_exists_glob� s c C@ s< | r d d | g } n d d | g } t d | d t � S( u�
Reset the SELinux context on a given path
CLI Example:
.. code-block:: bash
salt '*' file.restorecon /home/user/.ssh/authorized_keys
u
restoreconu -FRu -Fu cmd.retcodeRA ( R8 R ( R t recursiveRK ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
restorecon� s
c C@ se t d d d | g d t �} y t j d | � j d � } Wn t k
r` d j | � } n X| S( u�
Get an SELinux context from a given path
CLI Example:
.. code-block:: bash
salt '*' file.get_selinux_context /etc/hosts
u cmd.runu lsu -ZRA u \w+:\w+:\w+:\w+i u3 No selinux context information is available for {0}( R8 R RE RF RI R� Rw ( R RV R. ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_selinux_context s
c C@ s� t | | | | f � s t Sd g } | rA | j d | g � n | r] | j d | g � n | ry | j d | g � n | r� | j d | g � n | j | � t d | d t � } | r� t | � S| Sd S( u
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
u chconu -uu -ru -tu -lu cmd.retcodeRA N( R( R R� R< R8 R� ( R Rn t rolet typeR RK R. ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt set_selinux_context s
c C@ s d j | | | � } | t k r) t | St | t � r�g t d | � D] } | | f ^ qI } g t d | � D] } | | f ^ qr } x� | D]� } t | t � r� t t | � � } n t j j
j | � \ } }
|
r� | g t d |
� D] } | |
f ^ q� 7} | g t d |
� D] } | |
f ^ q 7} q� q� Wd } x�| D]~} t | t � r4t
| � d k rwqJn t t | � � } | | r�| | n | }
t | � } t j j j � r�| j j � t j k r�t d | � } q�n | j } | d k ret j j
j | � \ } }
|
s.| }
n | | f | k sR| | f | k r1| |
f } Pq1q�| j d � s�| d k r�| |
f } Pq�| d k r�t j j | j � s�t j j | j � s�t j j t j j | j | j � � r�| |
f } Pq�| j t j � r�t j j | � r�| |
f } Pq�qJt | t j � rJt j j
j | � \ } }
|
sp| }
n | |
f | k s�| |
f | k r�| | f } Pn t | � } t j j j � r�| j j � t j k r�t d | � } q�n | j } | d k rft j j | j � sVt j j | j � sVt j j t j j | j | j � � rf| | f } Pq�| j d � s�| d k r�| | f } Pq�| j t j � r�t j j | � r�| | f } Pq�qJqJW| d k r�t d
� � q�n | | f } | t | <| S( u�
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
u {0}_|-{1}_|-{2}u cp.list_masteru cp.list_master_dirsi u file://u saltu httpu ftpu fileu( none of the specified sources were foundN( Rw t __context__R` R� R8 R� t nextt iterR R t urlt parseRD R� R� R R R� R� R� t ascii_lowercaseR R R R) t netlocR R� R R� R ( R� R� R� t
contextkeyt ft mfilest dt mdirst singleR t senvR. t
single_srct single_hasht urlparsed_single_srcR� t
urlparsed_src( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt source_list= s�
))
-4
$ $ $ $
c C@ s | t j j j k r� | r! | n i } | r= | j | � n t j j j | | d t d t d | d | d t d d t d t d t �d
} t j
r� | j d � } q� t j r� t
| t � r� | j d � } q� n' i } t | d <d
j | � | d <| S| S( u(
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 from_strRH t contextR� t grainsu grainst pillarR t optsu datau utf-8u resultu. Specified template format {0} is not supportedu comment( R R t templatest TEMPLATE_REGISTRYt updateR R' t
__pillar__R8 R R� t encodet PY3R` t bytest decodeR Rw ( R� t templateR t defaultsR� t context_dictR. ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt apply_template_on_contents� s0
c
$ K@ s d } i } d � } | rKt | � } | j t j j j k rK | j } n d } t j j | j | j � j
t j � } | d$ k } | d k r� | } } t j j | � sd j
| � } d i | f SnC | d k r| } t j j | � sd j
| � } d i | f Sn | rG| j � t j k rGd j | | g � } d } n | d k r�t d | | � } | sHd i d j
| | � f SqK| r�| r�| | � } qK| r�| j t j � r�| | � } qK| sK| ry t | | | | | � } WqEt k
r} d i | j f SXqHd j
t j j j | � � } d i | f SqKn | r| sl| t j j j k rt } t d
| | � } | r | s�| r | j d d � } t | d
| �} | r�| } i | d 6| d 6} q | | j d t d � k rt } q | } n | s| r�y& t d | | d | j d � �} Wq�t k
r} t j j j | � } d i d j
| | � f SXn | s�t j j | � r�t j j j | � } | i d j
| � f S| | k r�t d � � n | r| t j j j! k r�| r
| n i } |
r&| j" |
� n t j j j! | | d | d | d | d | d | d | d | d | d t d t# d t d d t |
� } n | i d! j
| � f S| d" r�| d# } t | d
d �} i d d 6| d 6} qt$ | � | i | d# f Sqn | | d f S(% u�
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
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
u c S@ s i t | d d �d 6d d 6S( ua
DRY helper for getting the source_sum value from a locally cached
path.
R� u sha256u hsumu hash_type( R� ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _get_local_file_source_sum0 s u fileu$ Local file source {0} does not existu :u saltu cp.hash_fileu* Source file {0} not found in saltenv '{1}'ud Unable to verify upstream hash of source file {0}, please set source_hash or set skip_verify to Trueu cp.is_cachedu hash_typeu sha256R� u hsumu
cp.cache_fileR� u Failed to cache {0}: {1}u Source file '{0}' not foundu- Source file cannot be the same as destinationR� R� Rn RI Rz R� R� R R R R u grainsR u. Specified template format {0} is not supportedu resultu data( u fileu (% R� R� R R R! R� R R R R R� R� R) Rw R� R� R R8 R R� R R� R t redact_http_basic_autht
REMOTE_PROTOSR Rf R� R' R Ry R
R R R R R- ( R� R# R� R� R� Rn RI Rz R� R� R R$ t skip_verifyR� R t
source_sumR' t urlparsed_sourcet
parsed_schemet parsed_patht unix_local_sourceR* R t
cache_refetcht cached_destt htypet
cached_sumt _sourceR% R; t hsum( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_managed� s� F
!
c C@ sc t j | � } | d k r[ | r: t j d | � d } n d j t t � t t � � } n t j
| � } t j d } | r� t
| t j � s� t j
| � } n t | � d d } t j d | s� d n | | � n | r*t
| t j � st j
| � } n t j j | � } t | � d d }
n | r�t
| t j � sTt j
| � } n t | � } t j j | j px| j � } t | � d d }
n g | | f D] } | r�| ^ q�} | rt j d | r�d
n d | s�d n | t | � d k r�d n d d
j | � � n d } i } t j j j | d � �!} x| D]} t j j j | j � � } d | d } t j | | � } d } | r�| j d � } | d k r�t j t | � � } | d k r�d } q�i | d 6| d 6} q�n | d k r$t j d | | sd n | d � qCn | d k r9| } n d � } t! } | r�| j" | � r�y6 | | t j k r�| | | d | | � t# } n Wq�t$ k
r�q�Xq�t j% t j& | � d | � r�| | | d | | � t# } q�n | r�| j" | � rJy3 | |
| k r2| | | d | | � t# } n Wq�t$ k
rFq�Xq�t j% t j& | � d | � r�| | | d | | � t# } q�n | r+| j" | � r�y3 | |
| k r�| | | d | | � t# } n Wq(t$ k
r�q(Xq+t j% t j& | � d | � r+| | | d | | � t# } q+n | sCt j d | | d | d � qCqCWWd QXx� d | f d | f d | f f D]� \ } } | | k r~t | | � d k r�t j d | | d
j g | | D] } d j | d | d � ^ q�� � n | | d } t j d | d | d | � | Sq~W| rRt j d | d | d � | St j d! � d S(" u0
.. 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
u_ file.extract_hash: Unsupported hash_type '%s', falling back to matching any supported hash_typeu u {0},{1}u \/i i����uM file.extract_hash: Extracting %s hash for file matching source_hash_name '%s'u
any supportedu5 file.extract_hash: %s %s hash for file matching%s: %su0 If no source_hash_name match found, will extractu
Extractingu either of the followingu , u ru (?i)(?<![a-z0-9])([a-f0-9]{u })(?![a-z0-9])u hsumu hash_typeu0 file.extract_hash: In line '%s', no %shash foundu c S@ s3 t j d | | | � | j | g � j | � d S( Nu, file.extract_hash: Line '%s' matches %s '%s'( RC R� t
setdefaultR< ( R� R� t
match_typet valuet matched( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _add_to_matches@ s
u source_hash_nameu \s+u file_nameu sourceu] file.extract_hash: Line '%s' contains %s hash '%s', but line did not meet the search criteriaNu1 file.extract_hash: Multiple %s matches for %s: %su {0} ({1})i u: file.extract_hash: Returning %s hash '%s' as a match of %suB file.extract_hash: Returning the partially identified %s hash '%s'u- file.extract_hash: No matches, returning None(' R Rf RD RC RD Rw t minR t maxR Ru R� t
whitespaceR` R� R� R� R R t basenameR� R R R R R! R� RG R� R� RE RF RI R R; R t
IndexErrorRM Rg ( R� R� R� R� R� R� t
hash_len_exprt filename_separatorst source_hash_name_idxt file_name_basenamet
file_name_idxR, t source_basenamet
source_idxR� t basename_searchest partialR� RS R� t hash_ret
hash_matchR: t matched_hsumt matched_typeR; t hash_matchedt
found_typet found_strR. ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s 4 !
%
" 5
c C@ s� t j j | � } | sC i | d 6i d 6g d 6t d 6} d } n | d } g | d <i } t | d | �} | d | d <| d | d
<t j j j | d � | d <t j j | � }
t j j
| � } | rQt | t � r� t
| � } n t j j j � r t | � t | d � k sAt j j j � rQ| | d k rQ| | d
<qQn | r�t | t � rut | � } n t j j j � r�t | � t | d
� k s�t j j j � r�| | d
k r�| | d <q�n d
| k s�d | k r�t d s�t j j
| � r| rt } n t } | d k r9| d } n | d k rR| d
} n y! | | | | � t | | � Wq�t k
r�t | d <q�Xq�n | r�t | t � r�t
| � } n t j j j � r�t | � t t | d | �� k r�| d k s4t j j j � r|| t | d | �k r|| d k r|t d t k rU| | d d <q�t | d <| d j d j | � � q�d
| k r�| d k r�| | d d <q�n | r�t | t � r�t | � } n t j j j � rt | � t t | d | �� k r| d k sEt j j j � r�| t | d | �k r�| d k r�t d t k rf| | d d <q�t | d <| d j d j | � � q�d | k r�| d k r�| | d d <q�n | d k r�t j j
| � r�| r�q�t j j j | � } | | d k r�t d t k r'| | d d <q�t | | � | t j j j t | � � k r|t | d <| d j d j | � � q�| | d d <q�n | d k r|
rt j j
| � r�| r�qt | | � }
|
rt d � |
D� � ri d j! t" | � | � d 6d d 6} t d t k r.| | d <n� |
j# rSt$ | d d d |
j# �n |
j% rxt$ | d d d |
j% �n t | | � } t d � | D� � r�t | d <| d j d j | � � d j! t" | � | � | d <n
| | d <| d | d k r| | d d <qqn t | t& j' � r_| rE| d j( d | � n d j! | d � | d <n t d t k r�| d r�d | d <n | | f S( uN
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
u nameu changesu commentu resultu Rc u useru luseru groupu lgroupu modeu lmodeu cuseru cgroupu testu Failed to change user to {0}u Failed to change group to {0}u Failed to change mode to {0}c s@ s | ] } | Vq d S( N( ( R t attr( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pys <genexpr>1 s u oldu newR� u addR� u removec s@ s | ] } | Vq d S( N( ( R RQ ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pys <genexpr>F s u" Failed to change attributes to {0}u attrsi u ; N() R R Re R Rd R R R! R� R� R� R` RV Rm R R Rr R_ RX R' R| R RD R{ R~ R Ro R< Rw Rh Rt R� R( R R� R� R� R� R R� R4 ( R� R. Rn RI Rz R� Rc t orig_commentR� t curt is_dirR` t
chown_funct
diff_attrst changest cmp_attrs( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s�
# #
!
c K@ s^ t | | | � \ } } d } d } | d k r� t | | | | | | | | | | | |
|
| �
\ } } } | r� t | � t | f Sn t | | | | | | | | | | �
} | j t j � � r� x* d d d g D] } | j | d � q� Wn t | � | rKt
j | � d g } | j d � t
j | � D� � d d j | � f St d j | � f S( u
Check to see what changes need to be made for a file
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
u u useru groupu modeu, The following values are set to be changed:
c s@ s' | ] \ } } d j | | � Vq d S( u {0}: {1}
N( Rw ( R R� t val( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pys <genexpr>� s u$ The file {0} is in the correct stateN( R RD R6 R- R t check_file_metaR R R R� RC t infoR� R t iteritemsR R Rw ( R� R� R� R� Rn RI Rz R� R# R R$ R� R� R* R� R R+ t commentsRW R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
check_managed` sJ
c K@ sl t | | | � \ } } d } d
} | d
k r7t | | | | | | | | | | | |
|
| �
\ } } } | r� d | k r� | d j � | d <n | r� t | � t | f S| r7| r7| r7t | � j d k s� | j d � r4y t d | d | d t
�} Wq1t k
r-} t j
d | | � q1Xq4q7n t | | | | | | | | | | �
} t | � | S( u(
Return a dictionary of what changes need to be made for a file
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
u u hsumu saltu fileu /u cp.stat_fileR� t octalu Unable to stat %s: %sN( u saltu file( R RD R6 R� R- R R� R� R R8 R Ry RC RD RZ ( R� R� R� R� Rn RI Rz R� R# R R$ R� R� R* t keep_modeR� R R+ R] R RW ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt check_managed_changes� sJ
c
C@ s� i }
| s t � } n y( t | d | j d d � d t �} Wn t k
rY i } n X| sn | |
d <|
Sd | k r| d | d k r| r� | r� t d | | d | d �} n | r
y# t | | d t d
t �|
d <Wqt k
r} | j |
d <qXqd |
d <qn | d k rBt
j j j
d
t
j j j d t � }
t
j j j � rzt j j t | � � } n t
j j j |
d � �# } | j t
j j j | � � Wd QXy t | |
d
t �} Wn2 t k
r} t j d j | � � | j } n Xt |
� | rBt d d � r2d |
d <q?| |
d <qBn t
j j j � s|| d k r�| | d k r�| | d k r�| |
d <n | d k r�| | d k r�| | d k r�| |
d <n t
j j j | d � } t
j j j | � } | d k r| | k r| |
d <n | r|t | | � } | d k ry| d k rv| d d k sf| d d k rv| |
d <qvqyq|n |
S( u�
Check for the changes in the file metadata.
CLI Example:
.. code-block:: bash
salt '*' file.check_file_meta /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root, root, '755' 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
R� u hash_typeRc u newfileu hsumu sumu
cp.cache_fileR� R# t show_filenamesu diffu Checksum differsR R� u wNu Failed to diff files: {0}u
config.optionu obfuscate_templatesu <Obfuscated Template>u useru uidu groupu gidu modei i u attrs( R� Rd Rf RD R R R8 t get_diffR R� R R R! R R" R R R R1 R R? R� R� RG RH RC Re Rw R- R� R� ( R� R R� R+ Rn RI Rz R� R� R� RW t lstatsR t tmpt tmp_R{ t smodeRV ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRZ � s� =
"
c C@ s | | f } | | f } g }
g } x� t | | � D]� \ } }
ya t d | | d |
�} | t k r� | j d j t j j j | � � � w4 n |
j | � Wq4 t k
r� } | j t j j j | j
� � � q4 q4 Xq4 W| r� t d d | �� n g } x� |
D]� } y8 t j j j
| d � � } | j | j � � Wd QXWqt t f k
r�} t d j t j j j | � | j � � � qXqW| d | d
k r| r�t d d � r�d
} nP | s�d } nA t |
� } | r�| } n& | r| j |
� n t d | � } | Sd S( uX
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
u
cp.cache_fileR� u File {0} not foundu! Failed to cache one or more filesR[ u rbNu Failed to read {0}: {1}i i u
config.optionu obfuscate_templatesu <Obfuscated Template>u <show_changes=False>u stringutils.get_diffu ( R R8 R R< Rw R R RG R� R t __str__R R! R� R= R� R~ R� R7 R� R1 ( t file1t file2R� Rb RP R# t source_hash_file1t source_hash_file2R! t
source_hashest pathst errorst filenameR� t cached_pathR R� RS R. t bdiff( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRc } sZ A
"
u strictc # @ s� t j j | � } � s= i | d 6i d 6d d 6t d 6� n | rf d | k rf | d j � | d <n | rG� s� t d | | � � � s� t � d j | � � S| j d t d � } i | d 6t
� d
| �d 6} n | rGt | � j dF k rDy t d
| d | d t �} WqAt
k
r=} t j d � | � qAXqDqGn t j j | � skt j j | � r�t j j | � r�| r�t j j | � } n | } | r�| o�t j j | � r�t
| | j d t d � � } n d! } | r�| d! k s| j d t d � | k r�� s0t d | | � � n � sLt � d j | � � S| r�t | � j d k r�t
� | d � } | | d k r�d j | d | | d | � � d <t � d <� Sn t d d � r�d � d d <n_ |
s�d � d d <nH y! t | � d t �� d d <Wn$ t k
r?} | j � d d <n Xy. t j j j � | t d |
� t d � Wq�t k
r�} t � � t � d j | � � SXn | d! k rdt j j j d t j j j d t � } t j j j! � rt j" j# t$ | � � } n t j j j% | d � �[ } | rWt j& d | � | j' | j( d | d | � � n | j' t j j) j* | � � Wd! QXy% t | | d t d" |
d# t �} Wn> t k
r�} � j+ d$ g � j, d% j | j � � d } n X| rW| � d d <y. t j j j | | t d |
� t d � WqWt k
rS} t | � t � d j | � � SXn t | � n t j j | � r�| r�� s�t d | | � � n � s�t � d j | � � S| r)t | � j d k r)t
� | d � } | | d k r)d& j | d | | d | � � d <t � d <� Sn y. t j j j � | t d |
� t d � Wn0 t k
r�} t � � t � d j | � � SXd' � d d <n t j j j! � rt- d( | d) � d* � j d+ � d, � j d- � d. � j d/ � d0 � j d1 t � d2 � j d3 t � � � n$ t- | � | | | | | � \ � } � d rid4 j t j j. j/ | � � � d <n: � d r�� d r�d5 j t j j. j/ | � � � d <n � r�t � � n � St j j0 | � } � � � f d6 � }! | r � st d | | � � n � s t � d j | � � S| r�t | � j d k r�t
� | d � } | | d k r�d& j | d | | d | � � d <t � d <� Sn d7 � d d <t j j1 | � s,
| r�|! | | | | | � q t � � � d j2 d d! � t � d8 � Sq,
n)t j j1 | � sb | r4 |! | | | | | � qb t � � � d j2 d d! � t � d8 � Sn t j j j3 | rz d9 n d! � �� | d! k r� t d: s&
t4 | � r� d; j | � � d d< <d= � d <q� t � d> j | � � Sq&
n@ t d: s&
t4 | � r
d7 � d d <q&
t � d? j | � � Sn Wd! QX| d! k r8 t j j j d t j j j d t � } t j j j% | d � �� } | r�
t j j j! � r�
t j" j# t$ | � � } n t j& d | � | j' | j( d | d | � � n | j' t j j) j* | � � Wd! QXt j j j | | t d |
� t d � t | � n= � ru t j j j � | t d |
� t d � t � � n | d! k r� t j j j! � r� t j j j5 � }" t6 d@ |" AdA @� } n t j j j! � r8 t- d( | d) � d* � j d+ � d, � j d- � d. � j d/ � d0 � j d1 t � d2 � j d3 t � � � n! t- | � | | | | � \ � } � d sx dB | dC � d <n t d: r� dB | dD � d <n* � d r� � d r� dB | dE � d <n � r� t � � n � Sd! S(G u�
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
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
u nameu changesu u commentu resultu hsumu
cp.cache_fileu Source file '{0}' not foundu hash_typeR� u saltu fileu cp.stat_fileR� R_ u Unable to stat %s: %su� Specified {0} checksum for {1} ({2}) does not match actual checksum ({3}). If the 'source_hash' value refers to a remote file with multiple possible matches, then it may be necessary to set 'source_hash_name'.u
config.optionu obfuscate_templatesu <Obfuscated Template>u diffu <show_changes=False>Rb u config.backup_modeu cachediru Failed to commit change: {0}R R� u wbu File will be encoded with %sR� Ro NRP R# u warningsu% Failed to detect changes to file: {0}uI Specified {0} checksum for {1} ({2}) does not match actual checksum ({3})u' Replace symbolic link with regular fileR R. R� u win_ownert grant_permsu win_permst
deny_permsu win_deny_permst inheritanceu win_inheritancet resetu win_perms_resetu File {0} updatedu File {0} is in the correct statec
@ s� t j j j � rf t j j | � \ } } | rf t j j | � rf t � � t � d j
| � � Sn | d k r| d k rg t j
| � D] } | ^ q� d } xN t t | � � D]: } | | d k r� t j
t | | � d B� | | <q� q� Wd j | � } n t j j j � rzt d | d � j d � d � j d
� d � j d � d
� j d t � d � j d t � � n t | d | d | d | �d S( Nu {0} drive not presenti����u 0i u R R� u win_ownerRs u win_permsRt u win_deny_permsRu u win_inheritanceRv u win_perms_resetRn RI Rz ( R R R R R R t
splitdriveR) R- R0 Rw RD R Ru R R� RV R t makedirs_Rf R R (
R� t dir_modeRz Rn RI t drivet _R� t mode_listR ( R� R. R ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt _set_mode_and_make_dirsC s*
&(u New fileu Parent directory not presenti? u testu file {0} createdu newu
Empty fileu Empty file {0} not createdu File {0} not createdi� i� u File u updatedu not updatedu is in the correct state( u saltu fileu (7 R R Re R R� R8 R0 Rw Rf R' R� R� R� Ry RC RD R� R� R� RD R Rc R R� R R R! R� R� R- R R" R R R1 R R? R� R� R� R RG R� R7 R< R� R; R" t dirnameR� R� t set_umaskR� t get_umaskR� (# R� R R. R� R+ Rn RI Rz R� R� R� t makedirsR# RP R� Ry Rc R* R` R� t encoding_errorsR� R2 R t real_namet name_sumt dl_sumt io_errorRe Rf R{ R{ t contain_dirR} t mask( ( R� R. R s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt manage_file� s� |
$ ".
""
$
"
"
""
!
c C@ sP t j j | � } t j j | � } t j j | � sL t | | | | � n t S( u�
Ensure that a directory is available.
CLI Example:
.. code-block:: bash
salt '*' file.mkdir /opt/jetty/context
( R R Re R� R� t makedirs_permsR ( t dir_pathRn RI Rz t directory( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt mkdir� s
c C@ so t j j | � } | r0 t j j j | � } n t j j t j j | � � } t j j | � r� d j
| � } t j | � | St j j
| � r� d j
| � } t j | � | Sg } xi t r#t j j | � r� Pn | j | � | } t j j | � } | | k r� t d j
| � � � q� q� W| j � x: | D]2 } t j d | � t | d | d | d | �q5Wd S( u
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/
u Directory '{0}' already existsu4 The path '{0}' already exists and is not a directoryu` Recursive creation for path '{0}' would result in an infinite loop. Please use an absolute path.u Creating directory: %sRn RI Rz N( R R Re R R R! R� R� R~ R� Rw RC R� R) R R< R
t reverseR� ( R Rn RI Rz R~ R* t directories_to_createt current_dirnamet directory_to_create( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyRx s8
u 0755c
C@ s t j j | � } t j } | j | � \ } } | sN | j | � \ } } n | r� | r� | j | � r� y t | | | | � Wn+ t k
r� } | j t j k r� � q� n X| t j k r� d Sn t j
| � t | d | | | r� t
d j | � � n d � d S( u�
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
Nu {0}( R R Re R� R) R� R~ R� t EEXISTt curdirR� R� RD RV Rw ( R� Rn RI Rz R t headt tailR ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� D s&
c C@ sc t j j | � } t | � s* t | � r[ t j | � } t j | j � t j | j � f Sd Sd S( u�
Get major/minor info from a device
CLI Example:
.. code-block:: bash
salt '*' file.get_devmm /dev/chr
i N( i i ( R R Re t is_chrdevt is_blkdevRA t majort st_rdevt minor( R� t stat_structure( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt get_devmmi s
c C@ sj t j j | � } d } y t j | � } Wn, t k
rY } | j t j k rS t S� n Xt j | j
� S( u�
Check if a file exists and is a character device.
CLI Example:
.. code-block:: bash
salt '*' file.is_chrdev /dev/chr
N( R R Re RD RA R~ R� t ENOENTR R� R� ( R� R� R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� ~ s
u 0660c C@ sn t j j | � } i | d 6i d 6d d 6t d 6} t j d j | | | | � � y� t d r� i d j | � d 6| d <d | d <np t j | t
t j | � j
d
� d � t j Bt j | | � � d k r� i d j | � d 6| d <t | d <n Wn> t k
r8} | j t j k r"� q9d j | � | d <n Xt | d | | | rct
d
j | � � n d � | S( u�
.. versionadded:: 0.17.0
Create a character device.
CLI Example:
.. code-block:: bash
salt '*' file.mknod_chrdev /dev/chr 180 31
u nameu changesu u commentu resultu? Creating character device name:{0} major:{1} minor:{2} mode:{3}u testu Character device {0} created.u newu 0Ooi u) File {0} exists and cannot be overwrittenu {0}N( R R Re R RC R� Rw R' RD t mknodRV R Ru Rv RA t S_IFCHRt makedevR R~ R� R� R� ( R� R� R� Rn RI Rz R. R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt mknod_chrdev� s4
%"c C@ sj t j j | � } d } y t j | � } Wn, t k
rY } | j t j k rS t S� n Xt j | j
� S( u�
Check if a file exists and is a block device.
CLI Example:
.. code-block:: bash
salt '*' file.is_blkdev /dev/blk
N( R R Re RD RA R~ R� R� R R� R� ( R� R� R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s
c C@ sn t j j | � } i | d 6i d 6d d 6t d 6} t j d j | | | | � � y� t d r� i d j | � d 6| d <d | d <np t j | t
t j | � j
d
� d � t j Bt j | | � � d k r� i d j | � d 6| d <t | d <n Wn> t k
r8} | j t j k r"� q9d j | � | d <n Xt | d | | | rct
d
j | � � n d � | S( u�
.. versionadded:: 0.17.0
Create a block device.
CLI Example:
.. code-block:: bash
salt '*' file.mknod_blkdev /dev/blk 8 999
u nameu changesu u commentu resultu; Creating block device name:{0} major:{1} minor:{2} mode:{3}u testu Block device {0} created.u newu 0Ooi u) File {0} exists and cannot be overwrittenu {0}N( R R Re R RC R� Rw R' RD R� RV R Ru Rv RA t S_IFBLKR� R R~ R� R� R� ( R� R� R� Rn RI Rz R. R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt mknod_blkdev� s4
%"c C@ sj t j j | � } d } y t j | � } Wn, t k
rY } | j t j k rS t S� n Xt j | j
� S( u�
Check if a file exists and is a FIFO.
CLI Example:
.. code-block:: bash
salt '*' file.is_fifo /dev/fifo
N( R R Re RD RA R~ R� R� R R� R� ( R� R� R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt is_fifo s
c C@ sO t j j | � } i | d 6i d 6d d 6t d 6} t j d j | � � y� t d r~ i d j | � d 6| d <d | d <nZ t j | t
t j | � j
d
� d � � d k r� i d j | � d 6| d <t | d <n Wn> t k
r} | j t j k r� qd j | � | d <n Xt | d | | | rDt
d
j | � � n d � | S( u�
.. versionadded:: 0.17.0
Create a FIFO pipe.
CLI Example:
.. code-block:: bash
salt '*' file.mknod_fifo /dev/fifo
u nameu changesu u commentu resultu Creating FIFO name: {0}u testu Fifo pipe {0} created.u newu 0Ooi u) File {0} exists and cannot be overwrittenu {0}N( R R Re R RC R� Rw R' RD t mkfifoRV R Ru Rv R R~ R� R� R� ( R� Rn RI Rz R. R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
mknod_fifo, s.
3"u 0600c C@ s� t } t | | | � | d k r@ t | | | | | | � } nc | d k rj t | | | | | | � } n9 | d k r� t | | | | � } n t d j | � � � | S( u/
.. 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
u cu bu pud Node type unavailable: '{0}'. Available node types are character ('c'), block ('b'), and pipe ('p').( R Rx R� R� R� R
Rw ( R� t ntypeR� R� Rn RI Rz R. ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� Y s c C@ s\ t j j | � } y t | � } Wn4 t k
r5 n$ t k
rX t j d � d
} n Xt � } t j j
| � \ } } t j j
j � r� | j d d � } n
| d } t j j | | � } t j j | � s� i Si } x+g t j | � D]- } t j j t j j | | � � r� | ^ q� D]� } t j j
j � rJd j | � }
n d j | � }
y t j j | |
� } Wn t k
r�q n Xt j j
j � r�d } n d } | j | � | j | i � d <t j j | | � }
t j |
� j | | d
<|
| | d <q Wt t t t t t | � � � g t | d t! �| D] } | | ^ q?� � � S( u�
.. 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
u0 file.list_backups: 'limit' value must be numericu :u _i u {0}_%a_%b_%d_%H-%M-%S_%f_%Yu {0}_%a_%b_%d_%H:%M:%S_%f_%Yu %a %b %d %Y %H-%M-%S.%fu %a %b %d %Y %H:%M:%S.%fu Backup Timeu Sizeu LocationR� N(" R R Re RV R� RW RC Re RD R9 R� R R R R R� R R� R� R� Rw t datetimet strptimeRH R7 RA RB R� R� R R R� R� R ( R R� t bkroott
parent_dirR? t src_dirt bkdirR! R� t fnamet strpfmtt timestampt
str_formatRO ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt list_backups~ sH
1
u list_backupc
C@ s� t j j | � } y t | � } Wn4 t k
r5 n$ t k
rX t j d � d } n Xt � } t j j
| � \ } } t j j | | d � } t j j | � s� i Si } t
g t j g t t j | � � D] } | j
d � d ^ q� � D]$ \ } } | t t | � � f ^ q� � }
t j | � } x_t j |
� D]N\ } } i } x� t | � D]� } | j
d � d } | | k r\d j | � }
y t j j | |
� } Wn t k
r�q\n X| j d � | j | i � d <t j j | | � } t j | � j | | d <| | | d <q\q\Wt
t t t t | � � g t | d
t �| D] } | | ^ qR� � � } i | | 6} | j | � q=W| S( uu
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/
u4 file.list_backups_dir: 'limit' value must be numerici u _i u {0}_%a_%b_%d_%H:%M:%S_%f_%Yu %a %b %d %Y %H:%M:%S.%fu Backup Timeu Sizeu LocationR� N(! R R Re RV R� RW RC Re RD R9 R� R R� R� R# t groupbyR� R� R� R� R R\ Rw R� R� RH R7 RA RB R R R R ( R R� R� R� R? R� R! R� R� t nR t fft ssfileR� R� RO t sfilest sefiles( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt list_backups_dir� sD
o
N
c C@ s� t j j | � } i t d 6d j | � d 6} yQ t t j | � � t t j t | � � � k r{ t | � t | � } n | SWn9 t
k
r� | St k
r� d j | | � | d <| SXt j
j j | t � � y t j | d | � Wn1 t k
r } d j | d | | � | d <| SXt | d <d j | d | � | d <t j
j j � s�y t j | � } Wn' t t f k
r�| d c d 7<q�Xt j | | j | j � n | S( u�
.. 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
u resultu Invalid backup_id '{0}'u commentu& backup_id '{0}' does not exist for {1}u Locationu! Unable to restore {0} to {1}: {2}u Successfully restored {0} to {1}u! , but was unable to set ownership( R R Re R Rw R� R Ru RV R� RW R\ R R R! t
backup_minionR9 R� R� R� R R R RA R~ R R� R� ( R t backup_idR. R� R t fstat( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt restore_backup s<
0
c C@ s& t j j | � } i t d 6d j | � d 6} yQ t t j | � � t t j t | � � � k r{ t | � t | � } n | SWn9 t
k
r� | St k
r� d j | | � | d <| SXy t j | d � Wn- t
k
r } d j | d | � | d <n" Xt | d <d j | d � | d <| S( u
.. 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
u resultu Invalid backup_id '{0}'u commentu& backup_id '{0}' does not exist for {1}u Locationu Unable to remove {0}: {1}u Successfully removed {0}( R R Re R Rw R� R Ru RV R� RW R\ R* R� R ( R R� R. R� R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
delete_backupC s*
0
u
remove_backupc
G@ sY t j j | � } | } t j | � } | s6 | } n g } x� | D]� } y t j j j | � } Wn/ t k
r� t j j j t j
| � � } n Xt | � d k r� t d j
| � � � n | j | � qC Wt | t � r� d g | | g | } n d g | | | g } y t d | d t �} Wn( t t f k
rT} t | j � � n X| S( u�
Grep for a string in the specified file
.. note::
This function's return value is slated for refinement in future
versions of Salt
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
i u� Passing multiple command line arguments in a single string is not supported, please pass the following arguments separately: {0}u grepu cmd.run_allRA ( R R Re R� R R R� R� R� R Ru R� R
Rw R� R` R� R8 R R� R~ R R� (
R R� R t _patht
split_optst optR� RK R. R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt grepu s0 '
"c C@ sY i } t j d � } x6 | D]. } y g | t | � <Wq t k
rI q Xq Wi } x�| D]�} d j | � } y t j d j | � � } Wn t k
r� q[ n Xg } x9 t j d j | � � D] } | j d j | | � � q� Wx� | D]� }
y) | j t j j d j | |
� � � Wn t k
r1q� n Xx? t j d j | |
� � D]" } | j d j | |
| � � qNWq� Wt t
| � � } x� | D]� } y# t j j | � }
t j |
� Wn t k
r�q�n X|
| k r�| g | |
<n+ | |
j | � t t
| |
� � | |
<| | j |
� t t
| | � � | | <q�Wq[ W| rU| S| S( u�
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
u /proc/u /proc/{0}u {0}/tasku {0}/fdu
{0}/fd/{1}u {0}/task/{1}/exeu {0}/task/{1}/fdu {0}/task/{1}/fd/{2}( R R� RV RW Rw R~ R< R R� R� R� RA ( t by_pidt pidst procfst pfileR! t pidt ppatht tidst fd_t fpatht tidt tpatht fdpathR� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt
open_files� sR
#
"$
"c C@ s
t j j S( u�
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 t pardir( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� s c C@ s t j j | � S( uy
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 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� ( s c C@ s t j j | � S( u[
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 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR? = s c C@ s t j j | � S( uz
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 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR~ R s c G@ s t j j | � S( u
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� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR g s c C@ s� t j j | � } t j j | � } t j j | � sE t d � � n t j j | � sf t d � � n i t d 6d j | | � d 6} y t j | | � Wn4 t t
f k
r� } t d j | | | � � � n X| S( u�
Move a file or directory
CLI Example:
.. code-block:: bash
salt '*' file.move /path/to/src /path/to/dst
u Source path must be absolute.u" Destination path must be absolute.u resultu '{0}' moved to '{1}'u commentu" Unable to move '{0}' to '{1}': {2}( R R Re R� R
R Rw R� R� R~ R� R ( R R� R. R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyR� � s
c
C@ s� d } t � } t j j | � r= t j | � } | j } | Sx� t j j j | � D]� \ } } } x | D]w } t j j | | � } y t j | � } Wn t
k
r� qi n X| j | k r� qi n | j | j � | | j 7} qi WqS W| } | S( u�
Recursively calculate disk usage of path and return it
in bytes
CLI Example:
.. code-block:: bash
salt '*' file.diskusage /path/to/check
i (
R� R R R� RA RB R R t os_walkR R~ R� t add(
R t
total_sizet seenR� R. t dirpatht dirnamest filenamesR t fp( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt diskusage� s& %
(� t __doc__t
__future__R R R R� R� R� R� R# t loggingR� R RE R� RA R� R� R RG R� R> Rb t collectionsR R R t functoolsR t salt.extR t salt.ext.six.movesR R t salt.ext.six.moves.urllib.parseR
R� RY Ri t ImportErrort salt.utils.argsR t salt.utils.atomicfilet salt.utils.datat salt.utils.filebuffert salt.utils.filest salt.utils.findt salt.utils.functoolst salt.utils.hashutilst salt.utils.itertoolst salt.utils.patht salt.utils.platformt salt.utils.stringutilst salt.utils.templatest salt.utils.urlt salt.utils.usert salt.utils.versionst salt.exceptionsR R R
R R$ R R t getLoggert __name__RC t __func_alias__R� R R- R0 R7 R9 R? RO RU R_ RX R Rg Rh Rm Rr Rs Ro Rt R{ R| R R� R� R� R� R� R� RD R� R� R� R R� R� R� R� t It Lt Mt St Ut XR� R� R� R� R� R R R� R" R& R+ R/ R0 R3 R8 R: R� R� R� RF R� R� R� R� R< R� R� R� R� R� R� R� R` Rh R� R� R� R_ R� Ra R� R� Rd R� R* R� R� R� R� R� R R R& R6 R� R� R^ Ra RZ Rc R� R� Rx R� R� R� R� R� R� R� R� R� R� R t alias_functiont list_backupR� R� R� t
remove_backupR� R� R� R� R? R~ R R� R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/file.pyt <module> s
"
' . $ + A � 9 � P / ^
$ ) � '
5 ) � � q � + (R # H : 0/ @ ' = n I � �� E C � � � � @ " . . , G = > / M P "
Mini Shell