Current File : //usr/lib/python2.7/site-packages/salt/modules/cp.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 m Z d d l m Z d d l m Z e j e � Z d g Z d � Z d � Z! d
� Z" e# e$ d d � Z& d � Z' d
� Z( d � Z) d e# d d d � Z* d � Z+ d d e# d � Z, d d d d � Z- d d e# d d � Z. d d � Z/ d d d � Z0 d d � Z1 d e# d d d � Z2 d d � Z3 d � Z4 d d � Z5 d d d � Z6 d d d � Z7 d d d � Z8 d d! � Z9 d d" � Z: d d# � Z; d e$ d$ � Z< e# d e# d% � Z= d d d& � Z> d S(' u#
Minion side functions for salt-cp
i ( t absolute_importt print_functiont unicode_literalsN( t CommandExecutionError( t urlparse( t sixu *c C@ s- d t k r% t j j t � t d <n t d S( u
Return the auth object
u auth( t __context__t saltt cryptt SAutht __opts__( ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt _auth$ s c C@ sd t j j t t t d t d d | d | �} | j � } | r` t | t � r` | j | � n | S( uC
Whenever a state run starts, gather the pillar data fresh
u idu saltenvt pillar_overridet pillarenv( R t pillart
get_pillarR
t
__grains__t compile_pillart
isinstancet dictt update( R
R R t ret( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt _gather_pillar- s
c C@ s% i } xt j | � D]\ } } t j j | � t j j | � k rb t j j | � rb | } na t j j | � r� t j j | t j j | � � } n+ t j j t j j | � � r� | } n d Sy< t j j
j | d � � } | j | � Wd QXt
| | <Wq t k
r t | | <q Xq W| S( u�
Used with salt-cp, pass the files dict, and the destination.
This function receives small fast copy files from the master via salt-cp.
It does not work via the CLI.
u Destination unavailableu w+N( R t iteritemst ost patht basenamet isdirt joint dirnameR t utilst filest fopent writet Truet IOErrort False( R t destR R t datat finalt fp_( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt recv? s" $ $
c
C@ sR d t k r d t d <n d � } | d k r� y t j | � WnN t k
r� } | j t j k r| t j j | � r� d Sq� | | j � � Sn Xt
St j | � } | r� d n d } y t
j j j | | � } Wn� t t f k
rl} | j t j k r | | j � � Sy t j t j j | � � Wn& t t f k
rP} | | j � � SXt
j j j | | � } n Xz� y, | j | r�t
j j j | � n | � Wn& t t f k
r�} | | j � � SX| r#| d k r#t j d | | � y t j | | � Wq#t k
r | | j � � SXn t
SWd y | j � Wn t k
rLn XXd S( u�
This function receives files copied to the minion using ``salt-cp`` and is
not intended to be used directly on the CLI.
u retcodei c S@ s d t d <| S( Ni u retcode( R ( t msg( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt _errord s
u Path exists and is a fileu abu wbu Setting mode for %s to %sN( R t NoneR t makedirst OSErrort errnot EEXISTR t isfilet __str__R" t base64t b64decodeR R R R R# t ENOENTR R! t gzip_utilt
uncompresst logt debugt chmodt closet AttributeError(
R% t chunkt appendt
compressedt modeR+ t exct open_modet fh_t makedirs_exc( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt recv_chunked\ sR
!
c C@ sG d j t t � � t k rC t j j t � t d j t t � � <n d S( u�
Create a file client and add it to the context.
Each file client needs to correspond to a unique copy
of the opts dictionary, therefore it's hashed by the
id of the __opts__ dict
u cp.fileclient_{0}N( t formatt idR
R R t
fileclientt get_file_client( ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt
_mk_client� s c C@ s t � t d j t t � � S( u8
Return a client, hashed by the list of masters
u cp.fileclient_{0}( RJ R RF RG R
( ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt _client� s c @ s� � s | | f S� t j j j k r= t d j � � � � n i � t � d <d | k se d | k r� | j d t j d � � } t | | j d � � � d <n
t
� d <t � d <t � d <| � d <� � f d � } | | � } | | � } | | f S( u�
Process markup in the :param:`path` and :param:`dest` variables (NOT the
files under the paths they ultimately point to) according to the markup
format provided by :param:`template`.
u: Attempted to render file paths with unavailable engine {0}u saltu pillarenvu pillaru grainsu optsu saltenvc @ s� t j j j � } t j j j | d � �# } | j t j j j | � � Wd QXt j j j � | d t
� �} t j j j | � | d s� t d j
| d � � � n | d Sd S( u�
Render :param:`contents` into a literal pathname by writing it to a
temp file, rendering that file, and returning the result.
u w+Nt to_stru resultu* Failed to render file path with error: {0}u data( R R R t mkstempR R! t stringutilsRL t templatest TEMPLATE_REGISTRYR" t safe_rmR RF ( t contentst tmp_path_fnR( R& ( t kwargst template( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt _render� s "
( R R RO RP R RF t __salt__t getR
R t
__pillar__R ( R R% t saltenvRU t kwR
RV ( ( RT RU s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt _render_filenames� s&
u basec K@ s{ t | | | | | � \ } } t j j j | � \ } } | rH | } n t | | � s[ d St � j | | | | | � Sd S( u�
.. versionchanged:: 2018.3.0
``dest`` can now be a directory
Used to get a single file from the salt master
CLI Example:
.. code-block:: bash
salt '*' cp.get_file salt://path/to/file /minion/dest
Template rendering can be enabled on both the source and destination file
names like so:
.. code-block:: bash
salt '*' cp.get_file "salt://{{grains.os}}/vimrc" /etc/vimrc template=jinja
This example would instruct all Salt minions to download the vimrc from a
directory with the same name as their os grain and copy it to /etc/vimrc
For larger files, the cp.get_file module also supports gzip compression.
Because gzip is CPU-intensive, this should only be used in scenarios where
the compression ratio is very high (e.g. pretty-printed JSON or YAML
files).
Use the *gzip* named argument to enable it. Valid values are 1..9, where 1
is the lightest compression and 9 the heaviest. 1 uses the least CPU on
the master (and minion), 9 uses the most.
There are two ways of defining the fileserver environment (a.k.a.
``saltenv``) from which to retrieve the file. One is to use the ``saltenv``
parameter, and the other is to use a querystring syntax in the ``salt://``
URL. The below two examples are equivalent:
.. code-block:: bash
salt '*' cp.get_file salt://foo/bar.conf /etc/foo/bar.conf saltenv=config
salt '*' cp.get_file salt://foo/bar.conf?saltenv=config /etc/foo/bar.conf
.. note::
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.
u N( R\ R R t urlt split_envt hash_fileRK t get_file( R R% RZ R- RU t gzipRT t senv( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyR` � s 4 c C@ s
t � j � S( uy
List available environments for fileserver
CLI Example
.. code-block:: bash
salt '*' cp.envs
( RK t envs( ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyRc 0 s
u jinjac K@ s� d | k r t | d <n d | k r2 t | d <n d | k rK t | d <n d | k rd t | d <n t � j | | | | | | � S( u
Render a file as a template before setting it down.
Warning, order is not the same as in fileclient.cp for
non breaking old API.
CLI Example:
.. code-block:: bash
salt '*' cp.get_template salt://path/to/template /minion/dest
u saltu pillaru grainsu opts( RW RY R R
RK t get_template( R R% RU RZ R- RT ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyRd = s
c K@ s7 t | | | | | � \ } } t � j | | | | � S( u�
Used to recursively copy a directory from the salt master
CLI Example:
.. code-block:: bash
salt '*' cp.get_dir salt://path/to/dir/ /minion/dest
get_dir supports the same template and gzip arguments as get_file.
( R\ RK t get_dir( R R% RZ RU Ra RT ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyRe _ s u c C@ s� t | t j � r6 t � j | | | | d | �} n' t � j | d | | d t d | �} | s� t j d t j
j j | � | � n | S( u/
.. versionchanged:: 2018.3.0
``dest`` can now be a directory
Used to get a single file from a URL.
path
A URL to download a file from. Supported URL schemes are: ``salt://``,
``http://``, ``https://``, ``ftp://``, ``s3://``, ``swift://`` and
``file://`` (local filesystem). If no scheme was specified, this is
equivalent of using ``file://``.
If a ``file://`` URL is given, the function just returns absolute path
to that file on a local filesystem.
The function returns ``False`` if Salt was unable to fetch a file from
a ``salt://`` URL.
dest
The default behaviour is to write the fetched file to the given
destination path. If this parameter is omitted or set as empty string
(``''``), the function places the remote file on the local filesystem
inside the Minion cache directory and returns the path to that file.
.. note::
To simply return the file contents instead, set destination to
``None``. This works with ``salt://``, ``http://``, ``https://``
and ``file://`` URLs. The files fetched by ``http://`` and
``https://`` will not be cached.
saltenv : base
Salt fileserver envrionment from which to retrieve the file. Ignored if
``path`` is not a ``salt://`` URL.
source_hash
If ``path`` is an http(s) or 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 file if the cached copy matches the specified hash.
.. versionadded:: 2018.3.0
CLI Example:
.. code-block:: bash
salt '*' cp.get_url salt://my/file /tmp/this_file_is_mine
salt '*' cp.get_url http://www.slashdot.org /tmp/index.html
t source_hasht no_cacheu( Unable to fetch file %s from saltenv %s.N(
R R t string_typesRK t get_urlR, R" R8 t errorR R R] t redact_http_basic_auth( R R% RZ R- Rf t result( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyRi p s 0
c C@ sl t | | � } t | t j � rh y/ t j j j | d � � } | j � SWd QXWqh t k
rd t
SXn | S( u
Download a file from a URL to the Minion cache directory and return the
contents of that file
Returns ``False`` if Salt was unable to cache a file from a URL.
CLI Example:
.. code-block:: bash
salt '*' cp.get_file_str salt://my/file
u rN( t
cache_fileR R Rh R R R R t readR# R$ ( R RZ t fn_R( ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt get_file_str� s
c C@ s$ t j j j | � } t j j j | � } d j d | | � } t | � j d k } yD | r� | t k r� t j j
t | � r� t | St j | � n Wn t k
r� n Xt j j
j | � \ } } | r� | } n t � j | | d | �} | s
t j d | | � n | r | t | <n | S( u�
Used to cache a single file on the Minion
Returns the location of the new cached file on the Minion
source_hash
If ``name`` is an http(s) or 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 file if the cached copy matches the specified hash.
.. versionadded:: 2018.3.0
CLI Example:
.. code-block:: bash
salt '*' cp.cache_file salt://path/to/file
There are two ways of defining the fileserver environment (a.k.a.
``saltenv``) from which to cache the file. One is to use the ``saltenv``
parameter, and the other is to use a querystring syntax in the ``salt://``
URL. The below two examples are equivalent:
.. code-block:: bash
salt '*' cp.cache_file salt://foo/bar.conf saltenv=config
salt '*' cp.cache_file salt://foo/bar.conf?saltenv=config
If the path being cached is a ``salt://`` URI, and the path does not exist,
then ``False`` will be returned.
.. note::
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.
u {0}_|-{1}_|-{2}u
cp.cache_fileu httpu httpsu ftpRf u, Unable to cache file '%s' from saltenv '%s'.( u httpu httpsu ftp( R R R& t decodeRF t _urlparset schemeR R R R1 t popR< R] R^ RK Rm R8 Rj ( R RZ Rf t
contextkeyt path_is_remoteRb Rl ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyRm � s, $
c C@ s t � j | | � S( u�
Used to gather many files from the Master, the gathered files will be
saved in the minion cachedir reflective to the paths retrieved from the
Master
CLI Example:
.. code-block:: bash
salt '*' cp.cache_files salt://pathto/file1,salt://pathto/file1
There are two ways of defining the fileserver environment (a.k.a.
``saltenv``) from which to cache the files. One is to use the ``saltenv``
parameter, and the other is to use a querystring syntax in the ``salt://``
URL. The below two examples are equivalent:
.. code-block:: bash
salt '*' cp.cache_files salt://foo/bar.conf,salt://foo/baz.conf saltenv=config
salt '*' cp.cache_files salt://foo/bar.conf?saltenv=config,salt://foo/baz.conf?saltenv=config
The querystring method is less useful when all files are being cached from
the same environment, but is a good way of caching files from multiple
different environments in the same command. For example, the below command
will cache the first file from the ``config1`` environment, and the second
one from the ``config2`` environment.
.. code-block:: bash
salt '*' cp.cache_files salt://foo/bar.conf?saltenv=config1,salt://foo/bar.conf?saltenv=config2
.. note::
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.
( RK t cache_files( t pathsRZ ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyRw s $c C@ s t � j | | | | | � S( u�
Download and cache everything under a directory from the master
include_pat : None
Glob or regex to narrow down the files cached from the given path. If
matching with a regex, the regex must be prefixed with ``E@``,
otherwise the expression will be interpreted as a glob.
.. versionadded:: 2014.7.0
exclude_pat : None
Glob or regex to exclude certain files from being cached from the given
path. If matching with a regex, the regex must be prefixed with ``E@``,
otherwise the expression will be interpreted as a glob.
.. note::
If used with ``include_pat``, files matching this pattern will be
excluded from the subset of files defined by ``include_pat``.
.. versionadded:: 2014.7.0
CLI Examples:
.. code-block:: bash
salt '*' cp.cache_dir salt://path/to/dir
salt '*' cp.cache_dir salt://path/to/dir include_pat='E@*.py$'
( RK t cache_dir( R RZ t
include_emptyt include_patt exclude_pat( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyRy 7 s ! c C@ s t � j | � S( u�
Retrieve all of the files on the master and cache them locally
CLI Example:
.. code-block:: bash
salt '*' cp.cache_master
( RK t cache_master( RZ ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyR} ] s
c C@ sk t j j | � s d St | � } | r[ t | � } t | � } | d | d k r[ | Sn t � j | � S( u�
Cache a local file on the minion in the localfiles cache
CLI Example:
.. code-block:: bash
salt '*' cp.cache_local_file /etc/hosts
u u hsum( R R t existst is_cachedR_ RK t cache_local_file( R t path_cachedt path_hasht path_cached_hash( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyR� j s
c C@ s t � j | � S( u�
List all of the available state modules in an environment
CLI Example:
.. code-block:: bash
salt '*' cp.list_states
( RK t list_states( RZ ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyR� � s
c C@ s t � j | | � S( u�
List all of the files stored on the master
CLI Example:
.. code-block:: bash
salt '*' cp.list_master
( RK t file_list( RZ t prefix( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt list_master� s
c C@ s t � j | | � S( u�
List all of the directories stored on the master
CLI Example:
.. code-block:: bash
salt '*' cp.list_master_dirs
( RK t dir_list( RZ R� ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt list_master_dirs� s
c C@ s t � j | | � S( u�
List all of the symlinks stored on the master
CLI Example:
.. code-block:: bash
salt '*' cp.list_master_symlinks
( RK t symlink_list( RZ R� ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt list_master_symlinks� s
c C@ s t � j | � S( u�
List all of the files cached on the minion
CLI Example:
.. code-block:: bash
salt '*' cp.list_minion
( RK t file_local_list( RZ ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt list_minion� s
c C@ s t � j | | � S( u�
Return a boolean if the given path on the master has been cached on the
minion
CLI Example:
.. code-block:: bash
salt '*' cp.is_cached salt://path/to/file
( RK R ( R RZ ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyR � s c C@ s= t j j j | � \ } } | r* | } n t � j | | � S( u'
Return the hash of a file, to get the hash of a file on the
salt master file server prepend the path with salt://<file on server>
otherwise, prepend the file with / for a local file.
CLI Example:
.. code-block:: bash
salt '*' cp.hash_file salt://path/to/file
( R R R] R^ RK R_ ( R RZ Rb ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyR_ � s c C@ s~ t j j j | � \ } } | r* | } n t � j | | � d } | d k rS | S| t k rv t j j j | d � S| d S( u5
Return the permissions of a file, to get the permissions of a file on the
salt master file server prepend the path with salt://<file on server>
otherwise, prepend the file with / for a local file.
CLI Example:
.. code-block:: bash
salt '*' cp.stat_file salt://path/to/file
i i N(
R R R] R^ RK t hash_and_stat_fileR, R" R t st_mode_to_octal( R RZ t octalRb t stat( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt stat_file� s c C@ s� t j d | � d | k s/ t j j | � r@ t j d � t S| s[ t j j | � } n t j j | � s~ t j d � t St � } | r� d | k r� t j d � t j d | � t S| j t j
� } n | j t j
� } t j j | � } t j j | � d } g | j
t j
� D] } | r | ^ q } i d d 6t d d 6| d
6t j j | � d 6| j d � d
6}
t j j j j t � } z� t j j j | d � �� } t }
x� t r{| j � |
d <| j t d � |
d <|
d rL|
rL| rHy' t j j j | � t j d | � WqHt k
rDt j d | � t SXn t S| j |
� } | srt j d � | St }
q�WWd QXWd | j � Xd S( u,
WARNING Files pushed to the master will have global read permissions..
Push a file from the minion up to the master, the file will be saved to
the salt master in the master's minion files cachedir
(defaults to ``/var/cache/salt/master/minions/minion-id/files``)
Since this feature allows a minion to push a file up to the master server
it is disabled by default for security purposes. To enable, set
``file_recv`` to ``True`` in the master configuration file, and restart the
master.
keep_symlinks
Keep the path value without resolving its canonical form
upload_path
Provide a different path inside the master's minion files cachedir
remove_source
Remove the source file on the minion
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' cp.push /etc/fstab
salt '*' cp.push /etc/system-release keep_symlinks=True
salt '*' cp.push /etc/fstab upload_path='/new/path/fstab'
salt '*' cp.push /tmp/filename remove_source=True
u Trying to copy '%s' to masteru ../u& Path must be absolute, returning Falseu1 Path failed os.path.isfile check, returning Falseu Bad path: %si u
_file_recvu cmdu idu pathu sizeR u toku rbu locu file_buffer_sizeu datau Removing source file '%s'u" cp.push failed to remove file '%s'u� cp.push Failed transfer failed. Ensure master has 'file_recv' set to 'True' and that the file is not larger than the 'file_recv_size_max' setting on the master.N(! R8 R9 R R t isabsR$ t realpathR1 R t lstript sept normpatht
splitdrivet splitR
t getsizet gen_tokenR t transportt clientt
ReqChannelt factoryR R R R" t tellRn t rm_rfR# Rj t sendR; ( R t
keep_symlinkst upload_patht
remove_sourcet autht load_patht load_path_normalt load_path_split_drivet _ft load_path_listt loadt channelR( t init_sendR ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt push� s^ !
+
c C@ s� d | k s t j j | � r# t S| } t j j | � } t j j | � r] t | d | �Sg } xR t j j j | � D]; \ } } } | g | D] } t j j
| | � ^ q� 7} qy W| d k r� g | D]* } t j t j j
| � | � r� | ^ q� } n | st Sx� | D]� } | ru| j | � rut j j
t j j | j t j j � | j | d � j t j j � � } n t | d | �}
|
s|
SqWt S( ur
Push a directory from the minion up to the master, the files will be saved
to the salt master in the master's minion files cachedir (defaults to
``/var/cache/salt/master/minions/minion-id/files``). It also has a glob
for matching specific files using globbing.
.. versionadded:: 2014.7.0
Since this feature allows a minion to push files up to the master server it
is disabled by default for security purposes. To enable, set ``file_recv``
to ``True`` in the master configuration file, and restart the master.
upload_path
Provide a different path and directory name inside the master's minion
files cachedir
CLI Example:
.. code-block:: bash
salt '*' cp.push /usr/lib/mysql
salt '*' cp.push /usr/lib/mysql upload_path='/newmysql/path'
salt '*' cp.push_dir /etc/modprobe.d/ glob='*.conf'
u ../R� u N( R R R� R$ R� R1 R� R R t os_walkR R, t fnmatchR t
startswithR� t stript replaceR" ( R t globR� t tmpupload_patht filelistt roott _R t tmpfilet fiR ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt push_dir\ s. %0 :
(? t __doc__t
__future__R R R R3 R/ R t loggingR� t salt.minionR t salt.fileclientt salt.utils.datat salt.utils.filest salt.utils.gzip_utilt salt.utils.patht salt.utils.templatest salt.utils.urlt
salt.cryptt salt.transport.clientt salt.exceptionsR t salt.ext.six.moves.urllib.parseR Rr t salt.extR t getLoggert __name__R8 t __proxyenabled__R R R) R$ R" R, RE RJ RK R\ R` Rc Rd Re Ri Rp Rm Rw Ry R} R� R� R� R� R� R� R R_ R� R� R� ( ( ( s3 /usr/lib/python2.7/site-packages/salt/modules/cp.pyt <module> sn A
; @ = L ' %
_
Mini Shell