File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/client/__pycache__/mixins.cpython-310.pyc
o
�N�g�V � @ s4 d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z m
Z
ddl Z ddl
Z ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddl Z ddl Z e� e �Z e!g d��Z"G dd� de
�Z#G dd� d�Z$G d d
� d
e$�Z%G d d � d e$�Z&dS )
zB
A collection of mixins useful for the various *Client interfaces
� N)�Mapping�MutableMapping)�client�cmdZeauth�fun�kwarg�match�token�__jid__�__tag__�__user__�username�password� full_return� print_eventc @ sH e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dS )�ClientFuncsDictzN
Class to make a read-only dict for accessing runner funcs "directly"
c C s
|| _ d S �N)r )�selfr � r �F/opt/saltstack/salt/lib/python3.10/site-packages/salt/client/mixins.py�__init__< s
zClientFuncsDict.__init__c C s t | jj|�S )z.
Provide access eg. to 'pack'
)�getattrr � functions)r �attrr r r � __getattr__? s zClientFuncsDict.__getattr__c C � t � �r ��NotImplementedError)r �key�valr r r � __setitem__E � zClientFuncsDict.__setitem__c C r r r )r r r r r � __delitem__H r! zClientFuncsDict.__delitem__c s" � �j jvrt�� �fdd�}|S )z�
Return a function that you can call with regular func params, but
will do all the _proc_function magic
c
s� � | |d�}i }t |�}|D ]}|�d�r |�|�||< q�j�|�d��}tjj� � }�jj
�j�jj � |||d |d dd�S )N)r �args�kwargsZ__pub_Z __pub_jid�tag�jidF)�instance�optsr �low�userr% r& � daemonize) �list�
startswith�popr �_gen_async_pub�get�salt�utilsr* Zget_specific_user�_proc_functionr( )r# r$ r) �pub_dataZ kwargs_keysZ
kwargs_key� async_pubr* �r r r r �wrapperS s, �
� �z,ClientFuncsDict.__getitem__.<locals>.wrapper)r r �KeyError)r r r7 r r6 r � __getitem__K s zClientFuncsDict.__getitem__c C � t | jj�S r )�lenr r �r r r r �__len__r � zClientFuncsDict.__len__c C r: r )�iterr r r< r r r �__iter__u r> zClientFuncsDict.__iter__N) �__name__�
__module__� __qualname__�__doc__r r r r" r9 r= r@ r r r r r 7 s ' r c @ s& e Zd Zddd�Zdd� Zdd� ZdS ) �ClientStateMixinNc C s || _ |d u r i }|| _d S r �r( �context)r r( rG r r r r z s
zClientStateMixin.__init__c C s | j | jpd d�S )NrF rF r< r r r � __getstate__� s �z ClientStateMixin.__getstate__c C s | j |d |d d� d S )Nr( rG )rG )r )r �stater r r � __setstate__� s z ClientStateMixin.__setstate__r )rA rB rC r rH rJ r r r r rE y s
rE c @ sn e Zd ZdZdZdd� Zdd� Zdd d
�Z dd d
�Ze dd� �Z
e dd� �Z ddd�Z ddd�Z
dS )�SyncClientMixinzN
A mixin for *Client interfaces to abstract common function execution
r c C s t | �S )z�
Return a dict that will mimic the "functions" dict used all over salt.
It creates a wrapper around the function allowing **kwargs, and if pub_data
is passed in as kwargs, will re-use the JID passed in
)r r< r r r �functions_dict� s z SyncClientMixin.functions_dictc K s� |}| j |d< tjj jj| jddd��$}|�|�}t|t�r.d|v r.tj j
j di |d �� |W d � S 1 s:w Y dS )zJ
Execute a function through the master network interface.
r �clear� master_call)Zcrypt�usage�errorNr ) r r1 �channelZ
ReqChannel�factoryr( �send�
isinstancer r2 rP Z raise_error)r r$ �loadrQ �retr r r rN � s
�
$�zSyncClientMixin.master_callNFc C s� t jjj| j| jd dd��L}| jdi |��}t jjjd|d d�}|du r-| j�dd �}|j|d|dd
�}|du rIt j j
d � |d �|d d
��|rM|n|d d W d � S 1 s]w Y dS )a�
Execute a runner function synchronously; eauth is respected
This function requires that :conf_master:`external_auth` is configured
and the user is authorized to execute runner functions: (``@runner``).
.. code-block:: python
runner.eauth_sync({
'fun': 'jobs.list_jobs',
'username': 'saltdev',
'password': 'saltdev',
'eauth': 'pam',
})
�sock_dirT)�listenrV r% )�baseNZ rest_timeouti, )r% �full�waitZauto_reconnectz RunnerClient job '{}' timed outr& )r& �data�returnr ) r1 r2 �eventZget_master_eventr( rN �tagifyr0 � get_event�
exceptionsZSaltClientTimeout�format)r r) �timeoutr r^ �jobZret_tagrV r r r �cmd_sync� s$ �� �$�zSyncClientMixin.cmd_syncTc C s� |du rt � }t|t�st|t �stj�d��|du r i }t|t�s(tj�d��|du r.i }t|t�s9tj�d��tjjj || j
� dg �d�}|rRd|d< |� |� tj
�| j| ||�\}} ||| d �}
d
|v ro|d
|
d < | j||
||d �S )
z$
Execute a function
Nz%arg must be formatted as a list/tuplez*pub_data must be formatted as a dictionaryz'kwarg must be formatted as a dictionary�no_parse)rf TZ __kwarg__)r �argr r* r )r r )�tuplerT r, r1 ra ZSaltInvocationError�dictr2 r# Z parse_inputr( r0 �append�minionZload_args_and_kwargsr r) ) r r rg r4 r r r Zarglistr# r$ r) r r r r � s> �
�
��
� zSyncClientMixin.cmdc C s& t | d�stjj| jddd�| _| jS )N�_mminionF)ZstatesZrend)�hasattrr1 rk Z MasterMinionr( rl r< r r r �mminion� s
�zSyncClientMixin.mminionc C s^ z| j j�� }W n ty tjdtjd� Y dS w z | j|� d� W S t y. Y dS w )z
Helper that allows us to turn off storing jobs for different classes
that may incorporate this mixin.
z Unable to determine class name)Zexc_info_on_loglevelTZ_returns)
� __class__rA �lower�AttributeError�log�warning�logging�DEBUGr( r8 )r �
class_namer r r � store_job s �� �zSyncClientMixin.store_jobc C s� | j |�dtjj�| j��}|�dtjjj|| j d��}| j
� d|� �||�dd�d�}|r:t | d�r7| j nd }nd }tjjj
tjjjd
| jd | jd d
�||d����} ||d |t�| �d�}
�zt�| j�} tjj�| |� g } | �� D ]*}
d|
vr~qw|
�dd�\}}|| v r�qw| �|� |
�� D ] \}}|| j|
j|< q�qwd|v r�d|v r�|d }|d }ntjjj| j| |t d�}|�dd�}|�di �}t |�|r�|gng |d< |
d � |d� tj j j!�"| jj#j$��m | j| }z ||i |��|d< W n t%�y } zd �&||j'�|d< W Y d }~nd }~ww z
| j(�d d �d k|d < W n t)�y5 d |d < Y nw t*|d t+��rRd!|d v �rRtjj,�-|d d! �|d < W d � n 1 �s]w Y W n8 t.t/f�y� } z)t*|tj0j1��r}t2|�|d< n d"�&| j
|t3�4� �|d< d |d < d|d < W Y d }~nd }~ww | j5�r�z tjj6j5| j| jd# | jd# |d$ |d%�d | j d&� W n tj0j7�y� t8�9d'� Y nw | � |d(� t8�:d)|d$ � |�r�|n|d W d � S 1 �s�w Y d S )*a�
Execute a function from low data
Low data includes:
required:
- fun: the name of the function to run
optional:
- arg: a list of args to pass to fun
- kwarg: kwargs for fun
- __user__: user who is running the command
- __jid__: jid to run under
- __tag__: tag to run under
r
r ��prefix�.r �UNKNOWN)r r& r* �print_async_eventNZmasterrW F)r( rX )�
print_funcr* )r
r r �
__jid_event__� rg r )Zexpected_extra_kwsr# r r$ Zfun_argsr~ �newr] z(
Passed invalid arguments: {}
Usage:
{}�retcoder �successTr\ z Exception occurred in {} {}: {}�idr& )r� Ztgtr& r] )r^ rn zLCould not store job cache info. Job details for this run may be unavailable.rV zRunner completed: %s);rn r0 r1 r2 r& �gen_jidr( r^ r_ �
tag_prefixr rm r| ZNamespacedEventr` �weakref�proxy�copyr ZlazyZ
verify_fun�keys�splitrj �items� __globals__r# Z format_call�CLIENT_INTERNAL_KEYWORDSr, Z
fire_event�extZtornadoZ
stack_contextZ StackContextZ context_dict�clone� TypeErrorrb rD rG rq rT ri rI Z check_result� Exception�
SystemExitra �NotImplemented�str� traceback�
format_excrw rd ZSaltCacheErrorrr rP �info)r r r) r r r& r% r\ r} Znamespaced_eventZ func_globalsZself_functionsZcompleted_funcs�mod_name�mod�_Z
global_key�valuer# r$ Zf_call�func�exc�exr r r r) s�
���� �
�
�
�
���� �
�� ����� �
� �� &�zSyncClientMixin.lowc s� � r8d� v r � �d}n
� � d�s� d n� �d}|r)�fdd�t��j��D �}n� ��fdd�t�j�D �}n �fdd�t�j�D �}t|�}tjj� |�S ) zX
Return a dictionary of functions and the inline documentation for each
�*Trz Fc � g | ]
}|� j | jf�qS r �r rD ��.0r r< r r �
<listcomp>� s ��z,SyncClientMixin.get_docs.<locals>.<listcomp>c s. g | ]}|� ks
|� ��r|�j| jf�qS r )r- r rD r� �rg r Z
target_modr r r� � s
�c r� r r� r� r< r r r� � s �)
�endswith�fnmatch�filterr �sortedri r1 r2 �docZ strip_rst)r rg Z _use_fnmatchZdocsr r� r �get_docs� s$
��
�zSyncClientMixin.get_docs)NF)NNNTF)TFr )rA rB rC rD r rL rN re r �propertyrn rw r) r� r r r r rK � s&
&
�/
#rK c @ sb e Zd ZdZdZdZedd�dd��Zeddd�d d
��Zd d � Z dd
d�Z
ddd�Z dd� Z dS )�AsyncClientMixinzW
A mixin for *Client interfaces to enable easy asynchronous function execution
NT)r+ c
C s� |r t jj�� s t j�� t jj�� t� � t jj
_ t j� � ||d< ||d< ||d< |du r3| |�}z|�
|�W S t jjyS } z t�| � W Y d} ~ dS d} ~ ww )z�
Run this method in a multiprocess target to execute the function on the
master and fire the return data on the event bus
r
r r N)r1 r2 �platform�spawning_platform�_logging�shutdown_logging�processr+ �os�getpid�in_mainprocess�__pid__�
setup_loggingre ra ZEauthAuthenticationErrorrr rP )
�clsr' r( r r) r* r% r& r+ r� r r r �_proc_function_remote� s
��z&AsyncClientMixin._proc_function_remoteF)r+ r c
C sv |r t jj�� s t j�� t jj�� t� � t jj
_ t j� � |du r'| |�}||d< ||d< ||d< |j
||| d�S )z�
Run this method in a multiprocess target to execute the function
locally and fire the return data on the event bus
Nr
r r )r )r1 r2 r� r� r� r� r� r+ r� r� r� r� r� r) )
r� r' r( r r) r* r% r& r+ r r r r r3 s
z AsyncClientMixin._proc_functionc C s | j di |��S )a
Execute a function asynchronously; eauth is respected
This function requires that :conf_master:`external_auth` is configured
and the user is authorized
.. code-block:: python
>>> wheel.cmd_async({
'fun': 'key.finger',
'match': 'jerry',
'eauth': 'auto',
'username': 'saltdev',
'password': 'saltdev',
})
{'jid': '20131219224744416681', 'tag': 'salt/wheel/20131219224744416681'}
Nr )rN )r r) r r r � cmd_async) s zAsyncClientMixin.cmd_asyncc C s6 |d u r t jj�| j�}t jjj|| jd�}||d�S )Nrx )r% r& )r1 r2 r& r� r( r^ r_ r� )r r& r% r r r r/ = s
z AsyncClientMixin._gen_async_pubr{ c
C s� |r| j }n| j}|dur|n| �� }tjj�� r d}n| }tjj�t j
t j ��, tjjj |d�
|j||d �t|| j||||d |d d�d�} | �� W d � n1 sWw Y | �� |S )zx
Execute the function in a multiprocess and return the event tag to use
to watch for the return
Nz ProcessFunc({}, fun={} jid={})r& r% )r' r( r r) r* r% r& )�target�namer$ )r3 r� r/ r1 r2 r� r� r� Zdefault_signals�signal�SIGINT�SIGTERMZSignalHandlingProcessrb rC ri r( �start�join)
r r r) r* Zpub�localZ proc_funcr5 r' �procr r r � asynchronousC s6 ���
�z AsyncClientMixin.asynchronousc C s� t |t�sdS | j�dd�rdS |dv rdS z| j�d|�dd�p(|�d��d��}W n ty6 d}Y nw |dkr_t |�d�t�rZt|d �d dhkrZ|d d }|d d }n
|d }n||d
�}tj�||| j� dS ) z?
Print all of the events with the prefix 'tag'
N�quietF)r� �output� outputterr] rV r\ )�suffixr^ ) rT ri r( r0 rq �setr1 r� Zdisplay_output)r r� r^ r� Z
event_datar r r r| e s0
� ��
z"AsyncClientMixin.print_async_eventr )r{ NT)
rA rB rC rD r r� � classmethodr� r3 r� r/ r� r| r r r r r� � s � �&
"r� )'rD r� r� rt r� r� r� r� �collections.abcr r Z
salt._loggingr1 Zsalt.channel.clientZsalt.exceptionsZ salt.ext.tornado.stack_contextZ salt.minionZ salt.outputZsalt.utils.argsZsalt.utils.docZsalt.utils.errorZsalt.utils.eventZsalt.utils.jidZsalt.utils.jobZsalt.utils.lazyZsalt.utils.platformZsalt.utils.processZsalt.utils.stateZsalt.utils.userZsalt.utils.versions� getLoggerrA rr � frozensetr� r rE rK r� r r r r �<module> sJ
�B P