o

�N�g.�@s�dZd
dl
Z
d
dlZd
dlmZ
dZdZdZdZ	e
�
e�
ZdZ
d	Zd-dd�
Zd
d�Zdd�Zd.dd�
Zd/dd�
Zd/dd�
Zdd�Zd0dd�
Zd1dd�
Zdd �Zd!d"�Zd#d$�Zd%d&�Zd'd(�Zd)d*�Zd+d,�ZdS)2a
Git Fileserver Backend

With this backend, branches and tags in a remote git repository are exposed to
salt as different environments.

To enable, add ``gitfs`` to the :conf_master:`fileserver_backend` option in the
Master config file.

.. code-block:: yaml

    fileserver_backend:
      - gitfs

.. note::
    ``git`` also works here. Prior to the 2018.3.0 release, *only* ``git``
    would work.

The Git fileserver backend supports both pygit2_ and GitPython_, to provide the
Python interface to git. If both are present, the order of preference for which
one will be chosen is the same as the order in which they were listed: pygit2,
then GitPython.

An optional master config parameter (:conf_master:`gitfs_provider`) can be used
to specify which provider should be used, in the event that compatible versions
of both pygit2_ and GitPython_ are installed.

More detailed information on how to use GitFS can be found in the :ref:`GitFS
Walkthrough <tutorial-gitfs>`.

.. note:: Minimum requirements

    To use pygit2_ for GitFS requires a minimum pygit2_ version of 0.20.3.
    pygit2_ 0.20.3 requires libgit2_ 0.20.0. pygit2_ and libgit2_ are developed
    alongside one another, so it is recommended to keep them both at the same
    major release to avoid unexpected behavior. For example, pygit2_ 0.21.x
    requires libgit2_ 0.21.x, pygit2_ 0.22.x will require libgit2_ 0.22.x, etc.

    To use GitPython_ for GitFS requires a minimum GitPython version of 0.3.0,
    as well as the git CLI utility. Instructions for installing GitPython can
    be found :ref:`here <gitfs-dependencies>`.

    To clear stale refs the git CLI utility must also be installed.

.. _pygit2: https://github.com/libgit2/pygit2
.. _libgit2: https://libgit2.github.com/
.. _GitPython: https://github.com/gitpython-developers/GitPython
�N)
�FileserverConfigError)�base�fallbackZ
mountpoint�rootZ
ssl_verifyZsaltenv_whitelistZsaltenv_blacklistZrefspecsZdisable_saltenv_mappingZ	ref_typesZupdate_interval)Zall_saltenvs�nameZsaltenv)
Zpygit2)�user�passwordZpubkeyZprivkeyZ
passphraseZ
insecure_auth�gitfs)
�gitTc

Cstj
jjttd
tt|d�S)NZ
gitfs_remotes)Zper_remote_overridesZper_remote_only�init_remotes)�salt�utilsr	ZGitFS�__opts__�PER_REMOTE_OVERRIDES�PER_REMOTE_ONLY�
r�r�I/opt/saltstack/salt/lib/python3.10/site-packages/salt/fileserver/gitfs.py�_gitfsRs





�rcCs6tt
d
v
rdSztdd�

tWSty


YdSw)zz
    Only load if the desired provider module is present and gitfs is enabled
    properly in the master config file.
    Zfileserver_backendFr)�__virtualname__rrrrrrr�__virtual__\s






�rcCstd
d�
�
�S)z&
    Completely clear gitfs cache
    Fr)r�clear_cacherrrrrm�r�updatecCst�j
||
d
�S)z
    Clear update.lk
    ��remoteZ	lock_type)r�
clear_lockrrrrrt�rc

C�t�j
|d
�
S)z�
    Place an update.lk

    ``remote`` can either be a dictionary containing repo configuration
    information, or a pattern. If the latter, then remotes for which the URL
    matches the pattern will be locked.
    �
r)r�lockrrrrr {sr c

Cst��
|�

d
S)z1
    Execute a git fetch on all of the repos
    N)rr)
Zremotesrrrr�rcCs
t��
�S)
zA
    Returns the update intervals for each configured remote
    )r�update_intervalsrrrrr!�s
r!Fc

Cr)z@
    Return a list of refs that can be used as environments
    �
Zignore_cache)r�envsr"rrrr#�rr#rcKst�j
|f
d
|
i
|�
�
S)z�
    Find the first file to match the path and ref, read the file out of git
    and send the path to the newly cached file
    �tgt_env)r�	find_file)�pathr$�kwargsrrrr%�sr%c
Cs
t�
d
S)zs
    Initialize remotes. This is only used by the master's pre-flight checks,
    and is not invoked by GitFS.
    N)
rrrrr�init�s
r(cC�t��
||
�S)
z?
    Return a chunk from a file based on the data received
    )r�
serve_file��loadZfndrrrr*�rr*cCr))
zL
    Return a file hash, the hash type is set in the master config file
    )r�	file_hashr+rrrr-�rr-c

C�t��
|�
S)
z�
    Return a list of all files on the file server in a specified
    environment (specified as a key within the load dict).
    )r�	file_list�
r,rrrr/�sr/c


CsgS)
z>
    Return a list of all empty directories on the master
    rr0rrr�file_list_emptydirs�sr1c

Cr.)
z8
    Return a list of all directories on the master
    )r�dir_listr0rrrr2��r2c

Cr.)
zI
    Return a dict of all symlinks based on a given path in the repo
    )r�symlink_listr0rrrr4�r3r4)
T)Nr)
N)
F)
r)�__doc__�loggingZsalt.utils.gitfsrZsalt.exceptionsrrrZAUTH_PROVIDERSZAUTH_PARAMS�	getLogger�__name__�logrZ__virtual_aliases__rrrrr rr!r#r%r(r*r-r/r1r2r4rrrr�<module>
s61