File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/__pycache__/cache.cpython-310.pyc
o
�N�g�- � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddl Zddl
Zddl Zddl Zddl
ZddlZddlZddlZddlmZ e�e�ZG dd� d�ZG dd� de�ZG dd � d e�ZG d
d � d �ZG d d
� d
�ZG dd� d�Z dd� Z dd� Z dS )z
In-memory caching used by Salt
� N)�zmqc @ s e Zd ZdZedd� �ZdS )� CacheFactoryz2
Cache which can use a number of backends
c O s\ t �d|� |dkrt|g|�R i |��S |dkr't||d g|�R i |��S t �d� d S )NzFactory backend: %sZmemoryZdiskZminion_cache_pathz-CacheFactory received unrecognized cache type)�log�debug� CacheDict� CacheDisk�error)�clsZbackend�ttl�args�kwargs� r
�D/opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/cache.py�factory s zCacheFactory.factoryN)�__name__�
__module__� __qualname__�__doc__� classmethodr r
r
r
r r s r c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
r zA
Subclass of dict that will lazily delete items past ttl
c O s( t j| g|�R i |�� || _i | _d S �N)�dict�__init__�_ttl�_key_cache_time)�selfr
r r r
r
r r / s
zCacheDict.__init__c C sB || j vrdS t�� | j | | jkr | j |= t�| |� dS dS �zK
Enforce the TTL to a specific key, delete if its past TTL
N)r �timer r � __delitem__�r �keyr
r
r �_enforce_ttl_key4 s
�zCacheDict._enforce_ttl_keyc C � | � |� t�| |�S �z?
Check if the key is ttld out, then do the get
)r r � __getitem__r r
r
r r# > �
zCacheDict.__getitem__c C s t � � | j|< t�| ||� dS �z8
Make sure to update the key cache time
N)r r r � __setitem__�r r �valr
r
r r& E s zCacheDict.__setitem__c C r! r )r r � __contains__r r
r
r r) L �
zCacheDict.__contains__N) r r r r r r r# r& r) r
r
r
r r * s
r c s` e Zd ZdZ� fdd�Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z � Z
S )r z�
Class that represents itself as a dictionary to a consumer
but uses a disk-based backend. Serialization and de-serialization
is done with msgpack
c s2 t � j|g|�R i |�� || _i | _| �� d S r )�superr �_path�_dict�_read)r r
�pathr r �� __class__r
r r X s zCacheDisk.__init__c C s> || j vrdS t�� | j | | jkr | j |= | j|= dS dS r )r r r r- r r
r
r r ^ s
�zCacheDisk._enforce_ttl_keyc C � | � |� | j�|�S r )r r- r) r r
r
r r) h r* zCacheDisk.__contains__c C r2 r" )r r- r# r r
r
r r# l r$ zCacheDisk.__getitem__c C s( t � � | j|< | j�||� | �� dS r% )r r r- r& �_writer' r
r
r r& s s zCacheDisk.__setitem__c C s | j |= | j�|� | �� dS )z8
Make sure to remove the key cache time
N)r r- r r3 r r
r
r r | s zCacheDisk.__delitem__c C s | j �� | j�� | �� dS �z!
Clear the cache
N)r �clearr- r3 �r r
r
r r5 � s
zCacheDisk.clearc
C sF t jjjr tj�| j�sdS dtj�| j�krdS z%t jj �
| jd��}t jjj |t dd�}W d � n1 s8w Y W n0 t
yH Y dS t jjjjtfyn } zt�tj�rct�d| j|� W Y d}~dS d}~ww d|v r~|d | _|d | _n|| _tj�| j�}| jD ]}|| j|< q�t�tj�r�t�d |� dS dS )
z#
Read in from disk
Nr �rbF)�encoding�rawz"Error reading cache file at %r: %s�CacheDisk_cachetime�CacheDisk_datazDisk cache retrieved: %s)�salt�utils�msgpack� HAS_MSGPACK�osr/ �existsr, �getsize�files�fopen�loadZ__salt_system_encoding__�FileNotFoundError�
exceptionsZUnpackException�
ValueErrorr � isEnabledFor�logging�DEBUGr r- r �getmtime)r �fp_�cache�exc� timestampr r
r
r r. � s: � �� ��
�zCacheDisk._readc C sd t jjjsdS t jj�| jd��}| j| jd�}t jj� ||� W d � dS 1 s+w Y dS )z#
Write out to disk
Nzwb+)r; r: )
r< r= r> r? Z
atomicfileZ atomic_openr, r- r �dump)r rM rN r
r
r r3 � s
�"�zCacheDisk._write)r r r r r r r) r# r& r r5 r. r3 �
__classcell__r
r
r0 r r Q s
$r c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �CacheCliz�
Connection client for the ConCache. Should be used by all
components that need the list of currently connected minions
c C s� || _ tj�| j d d�| _tj�| j d d�| _t�� }|�tj �| _
| j
� tj d� | j
�
d| j � |�tj�| _| j� tj d� | j�
d| j � dS )z<
Sets up the zmq-connection to the ConCache
Zsock_dirz
con_cache.ipcz con_upd.ipc�d zipc://� N)�optsr@ r/ �joinZ
cache_sockZcache_upd_sockr ZContext�socketZREQ�creq_out�
setsockoptZLINGER�connectZPUB�cupd_out)r rV �contextr
r
r r � s zCacheCli.__init__c C s | j jtj�|�dd� dS )z=
published the given minions to the ConCache
F�ZtrackN)r\ �sendr< �payload�dumps)r �minionsr
r
r � put_cache� s zCacheCli.put_cachec C s2 t j�d�}| jj|dd� t j�| j�� �}|S )zP
queries the ConCache for a list of currently connected minions
rb Fr^ )r< r` ra rY r_ �loads�recv)r �msgZmin_listr
r
r �
get_cached� s zCacheCli.get_cachedN)r r r r r rc rg r
r
r
r rS � s
rS c @ s4 e Zd ZdZ ddd�Zdd � Zd
d � Zd d
� ZdS )�
CacheRegexz�
Create a regular expression object cache for the most frequently
used patterns to minimize compilation of the same patterns over
and over again
� �� 皙�����?� c C sj || _ || _|| _t||| �| _| j|kr(t|d �d | _| j|kr(|| _|| _i | _t�� | _d S )N� rU ) �prepend�append�size�int�
clear_size�max_agerN r rP )r rn ro rp Z
keep_fractionrs r
r
r r � s
zCacheRegex.__init__c C s | j �� dS r4 )rN r5 r6 r
r
r r5 s zCacheRegex.clearc C sd | j t�� | j k r| �� t�� | _dS t| j�� �}|�� t| j �D ]
}| j|| d = q%dS )zb
Sweep the cache and remove the outdated or least frequently
used entries
rm N)
rs r rP r5 �listrN �values�sort�rangerr )r Zpaterns�idxr
r
r �sweep s �zCacheRegex.sweepc C s� z| j | d d7 < | j | d W S ty Y nw t| j �| jkr)| �� t�| j� |� | j� ��}d||t � � g| j |< |S )z�
Get a compiled regular expression object based on pattern and
cache it when it is not in the cache already
r rU )
rN �KeyError�lenrp ry �re�compilern ro r )r �patternZregexr
r
r �get s �zCacheRegex.getN)ri ri rj rk rl )r r r r r r5 ry r r
r
r
r rh � s
� rh c @ s$ e Zd Zdd� Zdd� Zdd� ZdS )� ContextCachec C s& || _ tj�|d d|� d��| _dS )z(
Create a context cache
Zcachedirr] z.pN)rV r@ r/ rW �
cache_path)r rV �namer
r
r r ( s zContextCache.__init__c C sp t j�t j�| j��st �t j�| j�� tjj� | jd��}tj
� ||� W d � dS 1 s1w Y dS )z1
Cache the given context to disk
zw+bN) r@ r/ �isdir�dirnamer� �mkdirr< r= rC rD r` rQ )r r] rN r
r
r �
cache_context/ s
"�zContextCache.cache_contextc C sL t jj�| jd��}t jj�t j�|��W d � S 1 s w Y dS )z4
Retrieve a context cache from disk
r7 N) r< r= rC rD r� �data�decoder` rE )r rN r
r
r �get_cache_context8 s $�z ContextCache.get_cache_contextN)r r r r r� r� r
r
r
r r� ' s r� c s t �� �� fdd��}|S )z�
A decorator to be used module functions which need to cache their
context.
To evaluate a __context__ and re-hydrate it if a given key
is empty or contains no items, pass a list of keys to evaulate.
c s� z � j d �� }W n ty � j d }Y nw z � j d �� }W n ty/ � j d }Y nw � j d }t||�}|sNtj�|j�rNtj j
� ||� � � n|�
|� � | i |��S )N� __context__Z__opts__r )� __globals__�value�AttributeErrorr� r@ r/ �isfiler� r< r= Z
dictupdate�updater� r� )r r Z func_contextZ func_optsZ func_name�
context_cache��funcr
r �context_cache_wrapI s$ � �
�
z)context_cache.<locals>.context_cache_wrap)� functools�wraps)r� r� r
r� r r� @ s r� c C s t j�| �s t �| � tjj�tjj�| d�d��^}|� d� d�|�
� �}|tj j krnt
�dt| �� |�d� |�tj j � t �| �D ] }|dkrdtjj�| |�}t j�|�r_t �|� qEt�|� qE W d � dS W d � dS 1 szw Y dS ) z�
Check that the cached version matches the Salt version.
If the cached version does not match the Salt version, wipe the cache.
:return: ``True`` if cache version matches, otherwise ``False``
Z
cache_versionza+r �
z#Cache version mismatch clearing: %sNFT)r@ r/ r� �makedirsr< r= rC rD rW �seek� readlines�version� __version__r �warning�repr�truncate�write�listdirr� �remove�shutil�rmtree)r� �filer� �itemZ item_pathr
r
r �verify_cache_versiona s.
�
��$�r� ) r r� rJ r@ r| r� r Z salt.configr< Z salt.payloadZsalt.utils.atomicfileZsalt.utils.dataZsalt.utils.dictupdateZsalt.utils.filesZsalt.utils.msgpackZsalt.utils.pathZ salt.versionZsalt.utils.zeromqr � getLoggerr r r r r r rS rh r� r� r� r
r
r
r �<module> s4
'q*; !