File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/__pycache__/vt.cpython-310.pyc
o
�N�g�} � @ s, d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z ddl Z ddl
Z ddlmZ ejdkZz ddlZddlZddlZddlZddlmZmZ ddlmZ W n eyv ddl Z ddl Z ddl Z ddl Z Y nw e� e!�Z"G dd� de#�Z$dd
d �Z%d d
� Z&G dd� d�Z'dS )ab
:codeauthor: Pedro Algarvio (pedro@algarvio.me)
salt.utils.vt
~~~~~~~~~~~~~
Virtual Terminal
This code has been heavily inspired by Python's subprocess code, the `non
blocking version of it`__, some minor online snippets about TTY handling
with python including `Python's own ``pty`` source code`__ and `Pexpect`__
which has already surpassed some of the pitfalls that some systems would
get us into.
.. __: http://code.activestate.com/recipes/440554/
.. __: https://github.com/python/cpython/blob/3.3/Lib/pty.py
.. __: https://github.com/pexpect/pexpect
� N)�
LOG_LEVELS�win32)�ReadFile� WriteFile)�
PeekNamedPipec @ s e Zd ZdZdS )�TerminalExceptionz%
Terminal specific exception
N)�__name__�
__module__� __qualname__�__doc__� r r �A/opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/vt.pyr < s r �P c C s< t tdd�}|dkr d}t�d||dd�}t�| ||� dS )a^
This sets the terminal window size of the child tty. This will
cause a SIGWINCH signal to be sent to the child. This does not
change the physical window size. It changes the size reported to
TTY-aware applications like vi or curses -- applications that
respond to the SIGWINCH signal.
Thank you for the shortcut PEXPECT
�
TIOCSWINSZigt�l gt � HHHHr N)�getattr�termios�struct�pack�fcntl�ioctl)�child�rows�colsr �packedr r r
�
setwinsizeB s
r c C s@ t tdd�}t�ddddd�}t�| ||�}t�d|�dd� S )z�
This returns the terminal window size of the child tty. The return
value is a tuple of (rows, cols).
Thank you for the shortcut PEXPECT
�
TIOCGWINSZ�ht@r r � )r r r r r r �unpack)r r r r r r r
�
getwinsizeV s r c @ s\ e Zd ZdZdddddddddddddddddefdd�Zdd� Zejfd d
�Z d8d d �Z
d9dd�Z e dd� �Z
dd� Zdd� Zdd� Zercdd� Zdd� Zd d � Zd d � Zd d!� Zd:d"d#�ZeZdS d$d� Zed;d&d'��Zd(d � Zd)d � Zd*d+� Zd,d-� Z d<d.d/�Z ej ej ej ej!ej"ej#ej$ej%e&j'e(f
d0d1�Z)d:d2d#�Zd3d4� Z*d5d!� Zd6d7� ZdS )=�Terminalz
I'm a virtual terminal
NF�debugc
C s� |s|st d��|| _|| _|| _|| _|| _|| _|| _|d u r,|d u r,| �� \}}n |d ur;|d u r;| �� \}}n|d u rI|d urI| �� \}}|| _ || _
d | _ d | _ d | _
d | _d | _d | _d| _d| _d| _d| _d| _d| _d | _d | _d | _|du r�tj
| _n*|du r�d | _n"|d ur�t |d�r�t |d�r�t |d�s�t d��|| _nt d � |���|du r�tj| _ n*|du r�d | _ n"|d ur�t |d�r�t |d�r�t |d�s�t d
��|| _ nt d � |���z| � � W n t �y } zt!j"d |t#j$d
� t d|� ���d }~ww t!�%d| j | j| j� |�r"t&|t'��s t(d��|| _)nd | _)d�*| j�}| j)�r6|�+| j)d�}d|v �s@d|v �rLt!�%d� t!�,d|� nt!�%d|� t-�.|
|
�| _/| du �rqt#�0t1� d| j2j1� d| j � d��| _3n| d u�r�t&| t#j4��s�t(d��| | _3nd | _3t-�.| | �| _5| du �r�t#�0d� t1| j2j1| j ��| _6n| d u�r�t&| t#j4��s�t(d ��| | _6nd | _6t-�.||�| _7|
du �r�t#�0d � t1| j2j1| j ��| _8d S |
d u�r�t&|
t#j4��s�t(d ��|
| _8d S d | _8d S ) Nz6You need to pass at least one of "args", "executable" � TF�write�flush�closezU'stream_stdout' needs to have at least 3 methods, 'write()', 'flush()' and 'close()'.zDDon't know how to handle '{}' as the VT's 'stream_stdout' parameter.zU'stream_stderr' needs to have at least 3 methods, 'write()', 'flush()' and 'close()'.zDDon't know how to handle '{}' as the VT's 'stream_stderr' parameter.zFailed to spawn the VT: %s)Zexc_info_on_loglevelz Failed to spawn the VT. Error: z3Child Forked! PID: %s STDOUT_FD: %s STDERR_FD: %sz%'log_sanitize' needs to be a str type� �******zdecode("base64")zbase64.b64decode(z<VT: Salt-SSH SHIM Terminal Command executed. Logged to TRACEzTerminal Command: %s�.z.PID-z.STDINz.'log_stdin' needs to subclass `logging.Logger`z{}.{}.PID-{}.STDOUTz/'log_stdout' needs to subclass `logging.Logger`z{}.{}.PID-{}.STDERRz/'log_stderr' needs to subclass `logging.Logger`)9r �args�
executable�shell�cwd�env�
preexec_fn�receive_encoding�&_Terminal__detect_parent_terminal_sizer r �pid�stdin�stdout�stderr�child_fd� child_fde�partial_data_stdout�partial_data_stderr�closed�flag_eof_stdout�flag_eof_stderr�
terminated�
exitstatus� signalstatus�status�sys�
stream_stdout�hasattr�format�
stream_stderr�_spawn� Exception�log�warning�logging�DEBUGr" �
isinstance�str� RuntimeError� log_sanitize�join�replaceZtracer �get�stdin_logger_level� getLoggerr � __class__� stdin_logger�Logger�stdout_logger_level�
stdout_logger�stderr_logger_level�
stderr_logger)�selfr* r+ r, r- r. r/ r r Z log_stdinZlog_stdin_levelZ
log_stdoutZlog_stdout_levelZ
log_stderrZlog_stderr_levelrO rB rE Zforce_receive_encoding�_�errZterminal_commandr r r
�__init__h s �
�����
����� ����
�
��
�
�
zTerminal.__init__c C s
| � |�S )zi
Send data to the terminal. You are responsible to send any required
line feeds.
)�_send�r\ �datar r r
�send s
z
Terminal.sendc C s | � |� |� ��S )zO
Send the provided data to the terminal appending a line feed.
)rc )r\ rb �linesepr r r
�sendline& � zTerminal.sendlinec C s$ |du rd}n|dk r
d}| � |�S )z�
Receive data from the terminal as a (``stdout``, ``stderr``) tuple. If
any of those is ``None`` we can no longer communicate with the
terminal's child process.
Ni � )�_recv�r\ �maxsizer r r
�recv, s
z
Terminal.recvTc C sl | j s4| jdurt�| j� d| _| jdur t�| j� d| _t�d� |r/| �|�s/td��d| _ dS dS )a
Close the communication with the terminal's child.
If ``terminate`` is ``True`` then additionally try to terminate the
terminal, and if ``kill`` is also ``True``, kill the terminal if
terminating it was not enough.
N皙�����?z"Failed to terminate child process.T) r: r6 �osr& r7 �time�sleep� terminater )r\ rp �killr r r
r& 8 s
�zTerminal.closec C s | j du p | jdu S )NF)r< r; �r\ r r r
�has_unread_dataL s zTerminal.has_unread_datac C s |d u s|sd S |� dtj�S )Nz
)rQ rm rd ra r r r
�_translate_newlinesP s z Terminal._translate_newlinesc C s | S �Nr rr r r r
� __enter__V � zTerminal.__enter__c C s& | j ddd� | �� r| �� d S d S )NT)rp rq )r& �isalive�wait)r\ �exc_type� exc_value� tracebackr r r
�__exit__Y s �zTerminal.__exit__c C � t �ru ��NotImplementedErrorrr r r r
�_executea rw zTerminal._executec C r~ ru r rr r r r
rF d rw zTerminal._spawnc C r~ ru r ri r r r
rh g rw zTerminal._recvc C r~ ru r ra r r r
r` j rw zTerminal._sendc C s` |t jkr | �� dS |t jkrt�| jt j� dS |t jkr)t�| jt j� dS td|� ���)�6
Send a signal to the process
zUnsupported signal: N) �signal�SIGTERMrp Z CTRL_C_EVENTrm rq r2 ZCTRL_BREAK_EVENT�
ValueError�r\ �sigr r r
� send_signalm s
zTerminal.send_signalc C sH z
t �| jd� W dS ty# t�| j�}|tjkr � || _Y dS w )z0
Terminates the process
rg N) �win32apiZTerminateProcess�_handle�OSError� win32processZGetExitCodeProcess�win32conZ STILL_ACTIVEr> )r\ �forceZecoder r r
rp | s
�zTerminal.terminatec C s� t | jt�s| jdu rd�| j�| _t�� \}}t�� \}}t� |�}t
j | jt �
| j|| j| j| j�| j| j| j|||| jdd�
}t�|� t�|� || _|| _|j| _|| _d| _d| _d S )NTr' ) r/ r, r+ r- r3 r4 r5 r. � close_fdsF) rL r* rM r, rP �pty�openptyrm �pipe�ttyname�
subprocess�Popen� functools�partial�_preexecr r r/ r+ r- r. r& r6 r7 r2 �procr: r= )r\ �parentr Z
err_parentZ err_child�
child_namer� r r r
rF � s6
��
r c C s, zt �dt jt jB �}|dkrt �|� W n ty Y nw zt �� W n ty. Y nw z t �dt jt jB �}|dkrJt �|� td| � ���W n tyT Y nw t �| t j�}t |||� |dk rmtd| � ���t �|� t j
dkr�t �dt j �}|dk r�td��t �|� |d ur�|� d S d S )Nz/dev/ttyr zCould not open child pty, �posixz(Could not open controlling tty, /dev/tty) rm �open�O_RDWR�O_NOCTTYr& rG �setsidr� r r �name�O_WRONLY)r� r r r/ Ztty_fdr r r
r� � sF
� � �
� �
�zTerminal._preexecc
C s� | j d u rd S t�g | j gg d�d sdS z| jr!| j�| j|� t�| j |�t��}W |S t yP } z|j
t
j krKt� | j � d | _ W Y d }~d S � d }~ww )Nr rg )
r6 �selectrV rH rS rm r$ �encode�__salt_system_encoding__r� �errnoZEPIPEr& )r\ rb Zwritten�whyr r r
r` � s"
� ��c s� g }� j r |�� j � � jr|�� j� � �� sX|s � �� dS t�|g g d�\}}}|sXd � _� _t� d� � j
s>� j rR� �� t j
j�� j
�t j
j�� j �fS � �� dS d}d}� j rgt�� j tj�}� jrrt�� jtj�}� j r�t�� j tj|tjB � � jr�t�� jtj|tjB � t�|g g d�\}}}|s�� �� s�d � _� _t� d� dS d � fdd� } � j|v �rK� j�sKzzzP| � j|d �\}}
|s�|
s�d� _d }n;� jr� j�|� � j�� � j�r|�� } � jr�| �� jd
�} | � tj ��r| t tj �d � } | �r� j�� j | � W n t �y( t�� j� d � _d� _d }Y nw W � jd u�r9t�� jtj|� n� jd u�rJt�� jtj|� w w � j |v �r� j�s�z�zY| � j |d �\}}
|�sl|
�sld� _d }nB� j!�r�� j!�t j
j�"|�� � j!�� � j#�r�|�� } � j�r�| �� jd
�} | � tj ��r�| t tj �d � } | �r�� j#�� j$| � W n t �y� t�� j � d � _ d� _d }Y nw W � j d u�r�t�� j tj|� ||fS � j d u�r�t�� j tj|� w w ||fS )
N)NNr Tz&End of file(EOL). Brain-dead platform.� z%End of file(EOL). Very slow platform.c
s� t � |d�}|t�| |s|nd�7 }z� �tjj�|� j��}|d ur)t � |d� |dfW S t
y_ } z&d}|j t |�| krZ|j
t |�krZ|d urRt � ||� n� W Y d }~dS � d }~ww )Nr# rg F� )r� T)r rm �readrt �salt�utils� stringutils�
to_unicoder0 �setattr�UnicodeDecodeError�start�len�end)�fdrj Zpartial_data_attrZ
bytes_readZ decoded_data�exZ max_multibyte_character_lengthrr r r
�read_and_decode_fd s0 ��
� ��z*Terminal._recv.<locals>.read_and_decode_fdr9 r( r8 ru )%r6 �appendr7 rx r& r� r; r< rH r" r8 r9 r� r� r� r� r �F_GETFL�F_SETFLrm �
O_NONBLOCKrE r$ r% r[ �rstriprO rQ �
startswithrd r� rZ r� rB Zto_strrY rX ) r\ rj ZrfdsZrlistr] r5 r4 Zfd_flagsZ fde_flagsr� Z partial_data�strippedr rr r
rh � s�
�
'�
��� �� � ��� �
��� �� ��c C s^ z$t tdd�}t�ddddd�}t�tj�� ||�}t� d|�dd� W S t
y. Y dS w )Nr r r r r )� r ) r r r r r r rA r3 �filenor r� )r\ r r r r r r
Z __detect_parent_terminal_size� s �z&Terminal.__detect_parent_terminal_sizec C s | j du r td��t| j �S )z�
This returns the terminal window size of the child tty. The return
value is a tuple of (rows, cols).
Thank you for the shortcut PEXPECT
NzTCan't check the size of the terminal since we're not connected to the child process.)r6 r r rr r r r
r � s
�
zTerminal.getwinsizec C s t | j||� d S ru )r r6 )r\ r r r r r r
r � s zTerminal.setwinsizec
C sZ | j rdS | jdu r
d} n|} z
|| j| �\} }
W n0 ty3 | j�� }|du r,Y dS | j} |}
Y n |yI t�� d }|j| krH|
d��� w | dkruz
|| j| �\} }
W n |yn } z
|j| kri|
d��� d}~ww | dkrudS | dkr{dS ||
�r�|
| _ ||
�| _
d| _ d| _ dS ||
�r�|
| _ d| _
||
�| _ d| _ dS ||
�r�|
d��dS ) a�
This tests if the child process is running or not. This is
non-blocking. If the child was terminated then this will read the
exitstatus or signalstatus of the child. This returns True if the
child process appears to be running or False if not. It can take
literally SECONDS for Solaris to return the right status.
Fr NTrg z�isalive() encountered condition where "terminated" is 0, but there was no child process. Did someone else call waitpid() on our process?z�isalive() encountered condition that should never happen. There was no child process. Did someone else call waitpid() on our process?z�isalive() encountered condition where child process is stopped. This is not supported. Is some other process attempting job control with our child pid?) r= rs r2 �ChildProcessErrorr� �pollrA �exc_infor� r@ r> r? )r\ �_waitpidZ_wnohangZ
_wifexitedZ _wexitstatusZ _wifsignaledZ _wifstoppedZ _wtermsigZ _os_errorZ
_errno_echildZ_terminal_exceptionZwaitpid_optionsr2 r@ Zpolledr^ �excr r r
rx � sj
��
���
�
��zTerminal.isalivec C s� | j s | jdd� | �� sdS zP| �tj� t�d� | �� s"W dS | �tj� t�d� | �� s4W dS | �tj � t�d� | �� sFW dS |r]| �tj
� t�d� | �� sZW dS W dS W dS t yu t�d� | �� srY dS Y dS w )a$
This forces a child process to terminate. It starts nicely with
SIGHUP and SIGINT. If "force" is True then moves onto SIGKILL. This
returns True if the child was terminated. This returns False if the
child could not be terminated.
F)rp Trl ) r: r& rx r� r� �SIGHUPrn ro �SIGCONT�SIGINT�SIGKILLr� )r\ r� r r r
rp
s<
�c C sR | � � r%| � � r"| �� \}}|du r | jS |du r | jS | � � s| jS td��)z�
This waits until the child exits internally consuming any remaining
output from the child, thus, no blocking forever because the child
has unread data.
Nz#Cannot wait for dead child process.)rx rk r r> )r\ r4 r5 r r r
ry 6 s ���z
Terminal.waitc C s t �| j|� dS )r� N)rm rq r2 r� r r r
r� G rf c C s | � tj� dS )z7
Kill the process with SIGKILL
N)r� r� r� rr r r r
rq M s z
Terminal.killru )TF)F)r r N�r r )+r r r
r r� r_ rc rm rd re rk r& �propertyrs rt rv r} � mswindowsr� rF rh r` r� rp rq � staticmethodr� r1 r r �waitpid�WNOHANG� WIFEXITED� WEXITSTATUS� WIFSIGNALED�
WIFSTOPPED�WTERMSIG�errorr� ZECHILDr rx ry r r r r
r! c s~
� 8
( !
�
f, r! r� )(r r� r� rJ rm r� r� r� rA rn Zsalt.utils.cryptr� Zsalt.utils.dataZsalt.utils.stringutilsZ
salt._loggingr �platformr� �msvcrtr� r� r� Z win32filer r Z win32piper � ImportErrorr r� r r rT r rH rG r r r r! r r r r
�<module> sB
�