Current File : //lib/python3.9/site-packages/ansible/plugins/connection/__pycache__/__init__.cpython-39.pyc
a
�)g<@ � @ s� d dl mZmZmZ eZd dlZd dlZd dlZd dl Z
d dl m Z d dl
mZ d dlmZ d dlmZmZ d dlmZ d dlmZ d d lmZmZ d d
l m Z e� Z d d gZ d
Z dd � Z!G dd � d e�Z"G dd� de"�Z#dS )� )�absolute_import�division�print_functionN)�abstractmethod��wraps)� constants)�to_bytes�to_text)�
AnsiblePlugin)�Display)�connection_loader�get_shell_plugin)� unfrackpath�ConnectionBase�ensure_connecti c s t � �� fdd��}|S )Nc s$ | j s| �� � | g|�R i |��S �N)�
_connected�_connect)�self�args�kwargs��func� �G/usr/lib/python3.9/site-packages/ansible/plugins/connection/__init__.py�wrapped s z ensure_connect.<locals>.wrappedr )r r r r r r s c s� e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ d$� fdd� Z
dd � Zed
d � �Zed d
� �Zedd� �Zeedd� ��Zedd� �Zeed%dd���Zeedd� ��Zeedd� ��Zedd� �Zd d � Z d d � Z d d!� Z d"d#� Z � Z S )&r z>
A base class for connections to contain common code.
FT)� Nc s� t t| ��� t| d�s || _t| d�s.|| _t| d�s>t| _t| d�sNd| _d | _ d | _
d| _d | _ || _ | j s�|j
r~|j
n
t| dd �}t|| jjd�| _ d | _d S )N�
_play_context�
_new_stdin�_displayr FZ _shell_type)�
shell_type�
executable)�superr �__init__�hasattrr r �displayr r Z success_key�prompt� _socket_path�_shell�shell�getattrr r" �become)r � play_context� new_stdinr* r r r! �� __class__r r r$ > s$
zConnectionBase.__init__c C s
|| _ d S r )r, )r �pluginr r r �set_become_plugin] s z ConnectionBase.set_become_pluginc C s | j S )zYRead-only property holding whether the connection to the remote host is active or closed.)r �r r r r � connected` s zConnectionBase.connectedc C s | j S )zJRead-only property holding the connection socket path for this remote host)r( r3 r r r � socket_pathe s zConnectionBase.socket_pathc C s dd� t �| �D �S )z�
Takes a string like '-o Foo=1 -o Bar="foo bar"' and returns a
list ['-o', 'Foo=1', '-o', 'Bar=foo bar'] that can be added to
the argument list. The list will not contain any empty elements.
c S s g | ]}|� � rt|� � ��qS r )�stripr
)�.0�xr r r �
<listcomp>r � z2ConnectionBase._split_ssh_args.<locals>.<listcomp>)�shlex�split)Z argstringr r r �_split_ssh_argsj s z ConnectionBase._split_ssh_argsc C s dS )z@String used to identify this Connection class from other classesNr r3 r r r � transportt s zConnectionBase.transportc C s dS )z/Connect to the host we've been initialized withNr r3 r r r r z s zConnectionBase._connectc C s dS )at Run a command on the remote host.
:arg cmd: byte string containing the command
:kwarg in_data: If set, this data is passed to the command's stdin.
This is used to implement pipelining. Currently not all
connection plugins implement pipelining.
:kwarg sudoable: Tell the connection plugin if we're executing
a command via a privilege escalation mechanism. This may affect
how the connection plugin returns data. Note that not all
connections can handle privilege escalation.
:returns: a tuple of (return code, stdout, stderr) The return code is
an int while stdout and stderr are both byte strings.
When a command is executed, it goes through multiple commands to get
there. It looks approximately like this::
[LocalShell] ConnectionCommand [UsersLoginShell (*)] ANSIBLE_SHELL_EXECUTABLE [(BecomeCommand ANSIBLE_SHELL_EXECUTABLE)] Command
:LocalShell: Is optional. It is run locally to invoke the
``Connection Command``. In most instances, the
``ConnectionCommand`` can be invoked directly instead. The ssh
connection plugin which can have values that need expanding
locally specified via ssh_args is the sole known exception to
this. Shell metacharacters in the command itself should be
processed on the remote machine, not on the local machine so no
shell is needed on the local machine. (Example, ``/bin/sh``)
:ConnectionCommand: This is the command that connects us to the remote
machine to run the rest of the command. ``ansible_user``,
``ansible_ssh_host`` and so forth are fed to this piece of the
command to connect to the correct host (Examples ``ssh``,
``chroot``)
:UsersLoginShell: This shell may or may not be created depending on
the ConnectionCommand used by the connection plugin. This is the
shell that the ``ansible_user`` has configured as their login
shell. In traditional UNIX parlance, this is the last field of
a user's ``/etc/passwd`` entry We do not specifically try to run
the ``UsersLoginShell`` when we connect. Instead it is implicit
in the actions that the ``ConnectionCommand`` takes when it
connects to a remote machine. ``ansible_shell_type`` may be set
to inform ansible of differences in how the ``UsersLoginShell``
handles things like quoting if a shell has different semantics
than the Bourne shell.
:ANSIBLE_SHELL_EXECUTABLE: This is the shell set via the inventory var
``ansible_shell_executable`` or via
``constants.DEFAULT_EXECUTABLE`` if the inventory var is not set.
We explicitly invoke this shell so that we have predictable
quoting rules at this point. ``ANSIBLE_SHELL_EXECUTABLE`` is only
settable by the user because some sudo setups may only allow
invoking a specific shell. (For instance, ``/bin/bash`` may be
allowed but ``/bin/sh``, our default, may not). We invoke this
twice, once after the ``ConnectionCommand`` and once after the
``BecomeCommand``. After the ConnectionCommand, this is run by
the ``UsersLoginShell``. After the ``BecomeCommand`` we specify
that the ``ANSIBLE_SHELL_EXECUTABLE`` is being invoked directly.
:BecomeComand ANSIBLE_SHELL_EXECUTABLE: Is the command that performs
privilege escalation. Setting this up is performed by the action
plugin prior to running ``exec_command``. So we just get passed
:param:`cmd` which has the BecomeCommand already added.
(Examples: sudo, su) If we have a BecomeCommand then we will
invoke a ANSIBLE_SHELL_EXECUTABLE shell inside of it so that we
have a consistent view of quoting.
:Command: Is the command we're actually trying to run remotely.
(Examples: mkdir -p $HOME/.ansible, python $HOME/.ansible/tmp-script-file)
Nr �r �cmdZin_dataZsudoabler r r � exec_command~ s BzConnectionBase.exec_commandc C s dS )�$Transfer a file from local to remoteNr �r Zin_pathZout_pathr r r �put_file� s zConnectionBase.put_filec C s dS )zlFetch a file from remote to local; callers are expected to have pre-created the directory chain for out_pathNr rC r r r �
fetch_file� s zConnectionBase.fetch_filec C s dS )zTerminate the connectionNr r3 r r r �close� s zConnectionBase.closec C sV | j j}tjdt�� |f | j jd� t�|tj � tjdt�� |f | j jd� d S )Nz)CONNECTION: pid %d waiting for lock on %d��hostz&CONNECTION: pid %d acquired lock on %d)
r �connection_lockfdr& �vvvv�os�getpid� remote_addr�fcntl�lockfZLOCK_EX�r �fr r r �connection_lock� s z ConnectionBase.connection_lockc C s8 | j j}t�|tj� tjdt�� |f | j j d� d S )Nz&CONNECTION: pid %d released lock on %drG )
r rI rN rO ZLOCK_UNr& rJ rK rL rM rP r r r �connection_unlock� s z ConnectionBase.connection_unlockc C s t �d� d S )Nz,Reset is not implemented for this connection)r& �warningr3 r r r �reset� s zConnectionBase.resetc
C s� t jD ]�}d}||v rqn�d|v sd|v r.qn�|dkr>| j}n�|dkrP| jj}nxt j�d| j|�}|rv| �|d �}nRd|vr�t j�� D ]>\}}||v r�zt | j
|�}W q�W q� t y� Y q�Y q�0 q�|durt �
d �||�� |||< qdS )
z�
Adds 'magic' variables relating to connections to the variable dictionary provided.
In case users need to access from the play, this is a legacy from runner.
N�password�passwdZansible_connectionZansible_shell_type�
connectionr r, z Set connection var {0} to {1})�CZCOMMON_CONNECTION_VARSZ
_load_namer) ZconfigZget_plugin_options_from_var�
get_optionZMAGIC_VARIABLE_MAPPING�itemsr+ r �AttributeErrorr& �debug�format)r Z variablesZvarname�value�optionsZpropZvar_listr r r � update_vars� s0
zConnectionBase.update_vars)N)NT)!�__name__�
__module__� __qualname__�__doc__Zhas_pipeliningZhas_native_asyncZalways_pipeline_modulesZhas_ttyZ!module_implementation_preferencesZallow_executableZsupports_persistence�force_persistenceZ default_userr$ r2 �propertyr4 r5 � staticmethodr= r r> r r rA rD rE rF rR rS rU ra �
__classcell__r r r/ r r ( sL
B
c s� e Zd ZdZdZdZ� fdd�Zdd� Zd dd �Zd
d � Z d d
� Z
dd� Z dd� Z dd� Z
dd� Zd � fdd� Zdd� Zdd� Z� ZS ) �NetworkConnectionBasez5
A base class for network-style connections.
Tc st t t| �j||g|�R i |�� g | _d| _| jj| _t� d|d�| _
| j
� � i | _ d| _
|� d�| _| �� d S )NF�localz /dev/null)NNNZansible_playbook_pid)r# rj r$ � _messages� _conn_closedr Z
network_osZ _network_osr
�get�_local� set_options� _sub_pluginZ_cached_variables�_ansible_playbook_pid�_update_connection_state)r r- r. r r r/ r r r$ s
z NetworkConnectionBase.__init__c C sn z | j | W S tyh |�d�sP| j�d�}|rPt||d �}|d urP| Y S td| jj|f ��Y n0 d S )N�_�objz!'%s' object has no attribute '%s') �__dict__�KeyError�
startswithrq rn r+ r\ r0 rb )r �namer1 �methodr r r � __getattr__# s
z!NetworkConnectionBase.__getattr__Nc C s | j �|||�S r )ro rA r? r r r rA / s z"NetworkConnectionBase.exec_commandc C s | j �||f� dS )a�
Adds a message to the queue of messages waiting to be pushed back to the controller process.
:arg level: A string which can either be the name of a method in display, or 'log'. When
the messages are returned to task_executor, a value of log will correspond to
``display.display(message, log_only=True)``, while another value will call ``display.[level](message)``
N)rl �append)r �level�messager r r �
queue_message2 s z#NetworkConnectionBase.queue_messagec C s | j g }| _ |S r )rl )r �messagesr r r � pop_messages< s z"NetworkConnectionBase.pop_messagesc C s | j �||�S )rB )ro rD rC r r r rD @ s z NetworkConnectionBase.put_filec C s | j �||�S )z!Fetch a file from remote to local)ro rE rC r r r rE D s z NetworkConnectionBase.fetch_filec C s0 | j r | �dd| j � | �� | �dd� dS )z&
Reset the connection
rJ z2resetting persistent connection for socket_path %sz!reset call on connection instanceN)r( r rF r3 r r r rU H s zNetworkConnectionBase.resetc C s d| _ | jrd| _d S )NTF)rm r r3 r r r rF Q s zNetworkConnectionBase.closec s� t t| �j|||d� | �d�rZd| jj }ttd�}|d urJ|d| 7 }| �dd| � | j �
d�r�| j �
d �d
kr�z| j d j|||d� W n t y� Y n0 d S ) N)� task_keys� var_options�direct�persistent_log_messageszOPersistent connection logging is enabled for %s. This will log ALL interactionsZDEFAULT_LOG_PATHz to %srT zP%s and WILL NOT redact sensitive configuration like passwords. USE WITH CAUTION!ru �typeZexternal) r# rj rp rZ r rM r+ rY r rq rn r\ )r r� r� r� rT Zlogpathr/ r r rp V s
z!NetworkConnectionBase.set_optionsc C sj t jddd�}|�| jj| jj| jj| jj| j�}t t
j �}t |t |d� �}t
j�|�rfd| _|| _dS )ac
Reconstruct the connection socket_path and check if it exists
If the socket path exists then the connection is active and set
both the _socket_path value to the path and the _connected value
to True. If the socket path doesn't exist, leave the socket path
value to None and the _connected value to False
�sshT)Z
class_only)Z directoryN)r
rn Z_create_control_pathr rM �portZ remote_userrX rr r rY ZPERSISTENT_CONTROL_PATH_DIR�dictrK �path�existsr r( )r r� Z control_pathZtmp_pathr5 r r r rs e s �
z.NetworkConnectionBase._update_connection_statec C s | � d�r| �d|� d S )Nr� �log)rZ r )r r~ r r r �
_log_messages| s
z#NetworkConnectionBase._log_messages)NT)NNN)rb rc rd re rf Z_remote_is_localr$ r{ rA r r� rD rE rU rF rp rs r� ri r r r/ r rj s
rj )$Z
__future__r r r r� Z
__metaclass__rN rK r; �typing�t�abcr � functoolsr Zansibler rY Zansible.module_utils._textr r
Zansible.pluginsr Zansible.utils.displayr Zansible.plugins.loaderr
r Zansible.utils.pathr r& �__all__�BUFSIZEr r rj r r r r �<module> s( b
Mini Shell