Current File : //lib/python2.7/site-packages/salt/utils/vt.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z d d l m
Z
e j d k Z yZ d d l m Z m Z d d l m Z d d l Z d d l Z d d l Z d d l Z WnM e k
r>d d l Z d d l Z d d l Z d d l Z d d l Z n Xd d l Z d d l! Z d d l" Z d d l# m$ Z$ d d l% m& Z& e j' e( � Z) d
e* f d � � YZ+ g Z, d � Z- d
e. f d � � YZ/ d S( uh
: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-mirror/python/blob/3.3/Lib/pty.py
.. __: https://github.com/pexpect/pexpect
i ( t absolute_importt print_functiont unicode_literalsN( t sixu win32( t ReadFilet WriteFile( t
PeekNamedPipe( t string_types( t
LOG_LEVELSt TerminalExceptionc B@ s e Z d Z RS( u%
Terminal specific exception
( t __name__t
__module__t __doc__( ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR @ s c C@ sV xO t D]F } | j � } | t k r y t j | � WqN t k
rJ qN Xq q Wd S( uw
Make sure that any terminal processes still running when __del__ was called
to the waited and cleaned up.
N( t _ACTIVEt isalivet Truet removet
ValueError( t instt res( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt _cleanupN s
t Terminalc B@ s� e Z d Z d d e d d d d d d d d d d d d d d � Z d � Z e j d � Z d d � Z
e e d � Z e
d � � Z d � Z d � Z d
� Z e r� d � Z d � Z d
� Z d � Z d � Z d � Z e Z n� d � Z d � Z d � Z d � Z d � Z d � Z d � Z e j e j e j e j! e j" e j# e j$ e j% e& j' e( d �
Z) e d � Z d � Z* d � Z d � Z e+ j, e- d � Z. RS( u
I'm a virtual terminal
u debugc C@ s= t � | r$ | r$ t d � � n | | _ | | _ | | _ | | _ | | _ | | _ | d k r� | d k r� | j � \ } } nZ | d k r� | d k r� | j � \ } } n- | d k r� | d k r� | j � \ } } n | | _
| | _ d | _ d | _
d | _ d | _ d | _ d | _ t | _ t | _ t | _ t | _ d | _ d | _ d | _ d t j j � k | _ | t k r�t j | _ n� | t k r�d | _ nl | d k r
t | d � s�t | d � s�t | d � r�t d � � n | | _ n t d j! | � � � | t k r:t j | _" n� | t k rRd | _" nl | d k r�t | d � s�t | d � s�t | d � r�t d � � n | | _" n t d j! | � � � y | j# � WnA t$ k
r} t% j& d
| d t' j( �t d j! | � � � n Xt% j) d
| j | j | j � d j* | j � } d | k sYd | k ryt% j) d � t% j+ d | � n t% j) d | � t, j- |
|
� | _. | t k r�t' j/ d j! t0 | j1 j0 | j � � | _2 nB | d k rt3 | t' j4 � st5 d � � n | | _2 n d | _2 t, j- | | � | _6 | t k rgt' j/ d j! t0 | j1 j0 | j � � | _7 nB | d k r�t3 | t' j4 � s�t5 d � � n | | _7 n d | _7 t, j- | | � | _8 |
t k r�t' j/ d j! t0 | j1 j0 | j � � | _9 nB |
d k r0t3 |
t' j4 � s$t5 d � � n |
| _9 n d | _9 d S( Nu6 You need to pass at least one of "args", "executable" u irixu writeu flushu closeuU 'stream_stdout' needs to have at least 3 methods, 'write()', 'flush()' and 'close()'.uE Don't know how to handle '{0}' as the VT's 'stream_stdout' parameter.uU 'stream_stderr' needs to have at least 3 methods, 'write()', 'flush()' and 'close()'.uE Don't know how to handle '{0}' as the VT's 'stream_stderr' parameter.u Failed to spawn the VT: %st exc_info_on_loglevelu" Failed to spawn the VT. Error: {0}u3 Child Forked! PID: %s STDOUT_FD: %s STDERR_FD: %su u decode("base64")u base64.b64decode(u< VT: Salt-SSH SHIM Terminal Command executed. Logged to TRACEu Terminal Command: %su {0}.{1}.PID-{2}.STDINu. 'log_stdin' needs to subclass `logging.Logger`u {0}.{1}.PID-{2}.STDOUTu/ 'log_stdout' needs to subclass `logging.Logger`u {0}.{1}.PID-{2}.STDERRu/ 'log_stderr' needs to subclass `logging.Logger`(: R R t argst
executablet shellt cwdt envt
preexec_fnt Nonet& _Terminal__detect_parent_terminal_sizet rowst colst pidt stdint stdoutt stderrt child_fdt child_fdeR t closedt Falset flag_eof_stdoutt flag_eof_stderrt
terminatedt
exitstatust signalstatust statust syst platformt lowert _Terminal__irix_hackt
stream_stdoutt hasattrt formatt
stream_stderrt _spawnt Exceptiont logt warningt loggingt DEBUGt debugt joint traceR t gett stdin_logger_levelt getLoggerR
t __class__t stdin_loggert
isinstancet Loggert RuntimeErrort stdout_logger_levelt
stdout_loggert stderr_logger_levelt
stderr_logger( t selfR R R R R R R R t log_stdint log_stdin_levelt
log_stdoutt log_stdout_levelt
log_stderrt log_stderr_levelR3 R6 t _t errt terminal_command( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt __init__c s�
! ! ! c C@ s
| j | � S( ui
Send data to the terminal. You are responsible to send any required
line feeds.
( t _send( RL t data( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt send s c C@ s | j d j | | � � S( uO
Send the provided data to the terminal appending a line feed.
u {0}{1}( RY R5 ( RL RX t linesep( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt sendline' s c C@ s7 | d k r d } n | d k r* d } n | j | � S( u�
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.
i i N( R t _recv( RL t maxsize( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt recv- s
c C@ s� | j s� | j d k r4 t j | j � d | _ n | j d k r_ t j | j � d | _ n t j d � | r� | j | � s� t d � � q� n t
| _ n d S( u
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.
g�������?u" Failed to terminate child process.N( R' R% R t ost closeR& t timet sleept terminateR R ( RL Rc t kill( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR` 9 s
c C@ s | j t k p | j t k S( N( R* R( R) ( RL ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt has_unread_dataM s c C@ s* | d k s | r d S| j d t j � S( Nu
( R t replaceR_ RZ ( RL RX ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt _translate_newlinesT s c C@ s | S( N( ( RL ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt __enter__\ s c C@ s3 | j d t d t � | j � r/ | j � n d S( NRc Rd ( R` R R t wait( RL t exc_typet exc_valuet traceback( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt __exit___ s c C@ s
t � d S( N( t NotImplementedError( RL ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt _executei s c C@ s
t � d S( N( Rn ( RL ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR7 l s c C@ s
t � d S( N( Rn ( RL R] ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR\ o s c C@ s
t � d S( N( Rn ( RL RX ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyRW r s c C@ s� | t j k r | j � ne | t j k rD t j | j t j � n= | t j k rl t j | j t j � n t d j | � � � d S( u6
Send a signal to the process
u Unsupported signal: {0}N(
t signalt SIGTERMRc t CTRL_C_EVENTR_ Rd R! t CTRL_BREAK_EVENTR R5 ( RL t sig( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt send_signalu s
c C@ s_ y t j | j d � WnA t k
rZ t j | j � } | t j k rN � n | | _ n Xd S( u0
Terminates the process
i N( t win32apit TerminateProcesst _handlet OSErrort win32processt GetExitCodeProcesst win32cont STILL_ACTIVER, ( RL t ecode( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyRc � s
c C@ sx | j � \ | _ | _ | _ t | j t � r? | j g } n! | j rZ t | j � } n g } | j r� | j r� d d d j | � g | _ n! | j r� d g | _ n | | _ | j
r� | j
| j d <n | j
d k r� | j d | _
n | j d k rbt j
j � | _
t j j � | _ t j j � | _ | j
| _ t j | j � r�y | j | j | j � Wq�t k
r�} t j d | d t j �q�Xn t j t j � } y t j t j d | d � Wn t! k
r�n X| j" d k rt j# | j" � n | j$ r| j$ � n | j% d k rCt j& | j
| j � qbt j' | j
| j | j% � n t( | _) t( | _* d S( Nu /bin/shu -cu i u& Failed to set the VT terminal size: %sR i (+ t _Terminal__fork_ptysR! R% R& RE R R t listR R> R R R/ R" t filenoR# R$ R_ t isattyt
setwinsizeR R t IOErrorR9 R: R; R< t resourcet getrlimitt
RLIMIT_NOFILEt
closeranget ptyt
STDERR_FILENORy R t chdirR R t execvpt execvpeR( R' R+ ( RL R RT t max_fd( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR7 � sR
c C@ s� t j � \ } } | d k s* | d k r9 t d � � n t j � \ } } | d k sc | d k rr t d � � n t j � } | t j k r� t d � � n�| t j k rkt j | � t j | � t j j j
� t j | � } y< t j d t j
t j B� } | d k r t j | � n Wn t k
r3n Xt j � yH t j d t j
t j B� } | d k r�t j | � t d � � n Wn t k
r�n Xt j | t j
� } | d k r�t d j | � � � n
t j | � t j d k r/t j d t j � } | d k r t d � � q/t j | � n t j | t j � t j | t j � t j | t j � n* t j j j
� t j | � t j | � | | | f S(
u�
Fork the PTY
The major difference from the python source is that we separate the
stdout from stderr output.
i u Failed to open a TTY for stdoutu Failed to open a TTY for stderru Failed to forku /dev/ttyuQ Failed to disconnect from controlling tty. It is still possible to open /dev/tty.u Could not open child pty, {0}u posixu( Could not open controlling tty, /dev/tty( R� t openptyR R_ t forkt CHILDR` t saltt utilst cryptt
reinit_cryptot ttynamet opent O_RDWRt O_NOCTTYR8 t setsidR5 t namet O_WRONLYt dup2t STDIN_FILENOt
STDOUT_FILENOR� ( RL t stdout_parent_fdt stdout_child_fdt stderr_parent_fdt stderr_child_fdR! t
child_namet tty_fd( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt __fork_ptys� s^
c C@ s� | j d k r d St j g | j g g d � d s9 d Sye | j r^ | j j | j | � n t j r� t j | j | j
t � � } n t j | j | � } WnE t k
r� } | j
t
j k r� t j | j � d | _ d S� n X| S( Ni i ( R% R t selectRD R9 RA R t PY3R_ t writet encodet __salt_system_encoding__Ry t errnot EPIPER` ( RL RX t writtent why( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyRW 2 s" " ! c
C@ s� g } | j r" | j | j � n | j r> | j | j � n | j � s� | sT d St j | g g d � \ } } } | s� t | _ | _ t j
d � d SnT | j r� t j | g g d � \ } } } | s� t | _ | _ t j
d � d Sn d } d } | j r#t j | j t j
� } n | j rGt j | j t j
� } n | j rst j | j t j | t j B� n | j r�t j | j t j | t j B� n t j | g g d � \ } } } | s�| j � s�t | _ | _ t j
d � d
Sn | j | k rHzy� | j t j j j t j | j | � � � } | sPt | _ d } n� | j ry| j j | � | j j � n | j r�| j � } | j t j � r�| t t j � } n | r�| j j | j | � q�n Wn9 t k
rt j! | j � d | _ t | _ d } n XWd | j d k rDt j | j t j | � n Xn | j | k r�z y� | j t j j j t j | j | � � � } | s�t | _ d } n� | j" r�| j" j t j j j# | � � | j" j � n | j$ r9| j � } | j t j � r| t t j � } n | r9| j$ j | j% | � q9n Wn9 t k
rut j! | j � d | _ t | _ d } n XWd | j d k r�t j | j t j | � n Xn | | f S( Ni u& End of file(EOL). Brain-dead platform.i u End of file(EOL). Slow platform.u u% End of file(EOL). Very slow platform.( NN( NN( NN( NN(& R% t appendR& R R R� R R) R* R9 R= R2 t fcntlt F_GETFLt F_SETFLR_ t
O_NONBLOCKRg R� R� t stringutilst
to_unicodet readR6 R� t flushRK t rstript
startswithRZ t lenRJ Ry R` R3 t to_strRI RH (
RL R] t rfdst rlistRS R$ R# t fd_flagst fde_flagst stripped( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR\ H s� !
!
!
c C@ s yf t t d d � } t j d d d d d � } t j t j j � | | � } t j d | � d d !SWn t
k
rz d SXd S( Nu
TIOCGWINSZiht@t HHHHi i i iP ( i iP ( t getattrt termiost structt packR� t ioctlR/ R" R� t unpackR� ( RL t
TIOCGWINSZt packedR� ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt __detect_parent_terminal_size� s
c C@ sz | j d k r t d � � n t t d d � } t j d d d d d � } t j | j | | � } t j d | � d d !S( u�
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
uT Can't check the size of the terminal since we're not connected to the child process.u
TIOCGWINSZiht@R� i i N(
R% R R R� R� R� R� R� R� R� ( RL R� R� R� ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt
getwinsize� s c C@ s\ t t d d � } | d k r' d } n t j d | | d d � } t j | j | | � d S( u�
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
u
TIOCSWINSZigt�Igt� R� i N( R� R� R� R� R� R� R% ( RL R R t
TIOCSWINSZR� ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR� � s
c C@ s� | j r
t S| j t k r% d } n | } y | | j | � \ } }
WnE | k
r� t j � d } | j | k r� |
d � � q� | � n X| d k ry | | j | � \ } }
Wn4 | k
r� } | j | k r� |
d � � q� � n X| d k rt Sn | d k rt S| |
� rJ|
| _ | |
� | _ d | _ t | _ nT | |
� r�|
| _ d | _ | |
� | _ t | _ n | |
� r�|
d � � n t S( u�
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.
i i u� isalive() encountered condition where "terminated" is 0, but there was no child process. Did someone else call waitpid() on our process?u� isalive() encountered condition that should never happen. There was no child process. Did someone else call waitpid() on our process?u� isalive() encountered condition where child process is stopped. This is not supported. Is some other process attempting job control with our child pid?N( R+ R( Re R! R/ t exc_infoR� R R. R, R R- ( RL t _waitpidt _wnohangt
_wifexitedt _wexitstatust _wifsignaledt _wifstoppedt _wtermsigt _os_errort
_errno_echildt _terminal_exceptiont waitpid_optionsR! R. RT t exc( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR � sN
c C@ s. | j s | j d t � n | j � s, t Sy� | j t j � t j d � | j � s\ t S| j t j
� t j d � | j � s� t S| j t j � t j d � | j � s� t S| r� | j t j � t j d � | j � s� t St Sn t SWn2 t
k
r)t j d � | j � s"t St Sn Xd S( u$
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.
Rc g�������?N( R' R` R( R R Ru Rp t SIGHUPRa Rb t SIGCONTt SIGINTt SIGKILLRy ( RL t force( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyRc Z s:
c C@ sg | j � rT xQ | j � rP | j � \ } } | d k r= Pn | d k r Pq q Wn t d � � | j S( u�
This waits until the child exits internally consuming any remaining
output from the child, thus, no blocking forever because the child
has unread data.
u# Cannot wait for dead child process.N( R R^ R R R, ( RL R# R$ ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyRi � s c C@ s t j | j | � d S( u6
Send a signal to the process
N( R_ Rd R! ( RL Rt ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyRu � s c C@ s | j t j � d S( u7
Kill the process with SIGKILL
N( Ru Rp R� ( RL ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyRd � s c C@ s? | j d k r d S| j � r; t d k r; t j | � n d S( N( R! R R R
R� ( RL t _maxsizet _active( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt __del__� s N(/ R
R R R R( RV RY R_ RZ R[ R^ R R` t propertyRe Rg Rh Rm t mswindowsRo R7 R\ RW Ru Rc Rd R R R� R� t waitpidt WNOHANGt WIFEXITEDt WEXITSTATUSt WIFSIGNALEDt
WIFSTOPPEDt WTERMSIGt errorR� t ECHILDR R Ri R/ R] R
R� ( ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyR _ sn � A Z } R , (0 R t
__future__R R R R_ R/ Ra R� Rp R� R; t salt.extR R0 R� t win32fileR R t win32pipeR t msvcrtRv R| Rz t ImportErrorR� R� R� R� R� t salt.utils.cryptR� t salt.utils.datat salt.utils.stringutilst salt.ext.sixR t salt.log.setupR RB R
R9 R8 R R
R t objectR ( ( ( s1 /usr/lib/python2.7/site-packages/salt/utils/vt.pyt <module> sB
Mini Shell