U
    QeH>                     @  s  d Z ddl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
Z
ddlmZ ddlmZ ddlmZmZmZ erddlmZ zddlmZ d	d
ddZW nB ek
r   zddlmZ W n ek
r   eZY nX dZY nX ddlmZ dZdZG dd dZ ddd	dddZ!d(ddddddZ"G dd dZ#G d d! d!e#Z$G d"d# d#e%Z&G d$d% d%e#Z'G d&d' d'e#Z(dS ))zMTerminal management for exposing terminals to a web interface using Tornado.
    )annotationsN)deque)futures)TYPE_CHECKINGAny	Coroutine)
TermSocket)PtyProcessUnicodeNonereturnc                   C  s   t  t jt j dS )z-A prexec function to set up a signal handler.N)signalSIGPIPESIG_DFL r   r   3lib/python3.8/site-packages/terminado/management.py
preexec_fn   s    r   )
PtyProcess)IOLoopZPYXTERM_zxterm-256colorc                   @  sz   e Zd ZU dZded< ddddddd	Zd
dddZejfdd
dddZ	ejfdddddZ
ddddddZdS )PtyWithClientsz%A pty object with associated clients.
str | None	term_nameNr   zdict[str, str] | Noneargvenvcwdc                 C  sZ   g | _ tg dd| _||pg |d}tdk	r4t|d< tjf || _tddd| j_	dS )	zInitialize the pty.  )maxlenr   Nr   zutf-8replace)errors)
clientsr   read_bufferr   r	   Zspawnptyproccodecsgetincrementaldecoderdecoder)selfr   r   r   kwargsr   r   r   __init__2   s    zPtyWithClients.__init__r
   r   c                 C  s   d }}| j D ]6}|j\}}|dk	r0||k r0|}|dk	r||k r|}q|dksV|dkrZdS | j \}}||f||fkr| j|| dS )a  Set the terminal size to that of the smallest client dimensions.

        A terminal not using the full space available is much nicer than a
        terminal trying to use more than the available space, so we keep it
        sized to the smallest client.
        i'  N)r    sizer"   Z
getwinsizeZ
setwinsize)r&   ZminrowsZmincolsclientZrowsZcolsr   r   r   resize_to_smallest@   s    

z!PtyWithClients.resize_to_smallestint)sigr   c                 C  s   | j | dS )z'Send a signal to the process in the ptyN)r"   kill)r&   r-   r   r   r   r.   V   s    zPtyWithClients.killc                 C  s4   t jdkr| j|S t | jj}t || dS )z<Send a signal to the process group of the process in the ptyntN)osnamer"   r.   getpgidpidkillpg)r&   r-   Zpgidr   r   r   r4   Z   s    
zPtyWithClients.killpgFbool)forcer   c                   s   t jdkrtjtjg}ntjtjtjtjg}t }dd fdd} j	
 sTdS zf|D ],} | | I dH   j	
 sZ W dS qZ|r tj | I dH  t j	
  W S W dS  tk
r   | I dH  t j	
   Y S X dS )	zThis 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.r/   zCoroutine[Any, Any, None]r   c                     s   t  jjS )z/Sleep to allow the terminal to exit gracefully.)asynciosleepr"   Zdelayafterterminater   r&   r   r   r8   m   s    z'PtyWithClients.terminate.<locals>.sleepTNF)r0   r1   r   SIGINTSIGTERMSIGHUPSIGCONTr   currentr"   Zisaliver.   SIGKILLr5   OSError)r&   r6   Zsignals_r8   r-   r   r9   r   	terminatea   s*    




zPtyWithClients.terminate)NN)F)__name__
__module____qualname____doc____annotations__r(   r+   r   r;   r.   r4   rB   r   r   r   r   r   -   s   
r   r   )targetchangesr   c                 C  s4   |  D ]&\}}|dkr&| |d q|| |< qdS )z<Like dict.update(), but remove keys where the value is None.N)itemspop)rH   rI   kvr   r   r   _update_removing   s    rN   皙?r,   floatzlist[tuple[int, int]])fdtimeoutr   c                 C  s`   t jdkr@t }|| tjtjB tjB tjB  ||d S t| gg g |\}}}|S dS )zIPoll using poll() on posix systems and select() elsewhere (e.g., Windows)posixr   N)	r0   r1   selectZpollregisterZPOLLINZPOLLPRIZPOLLHUPZPOLLERR)rQ   rR   ZpollerrrA   r   r   r   _poll   s    
 rW   c                   @  s   e Zd ZdZd+dddddddddZd,dddddddddZdddddZdddddZdddddZd-ddddddZ	dddddZ
d.ddd d!d"Zddd#d$d%Zdd&d'd(Zdd&d)d*ZdS )/TermManagerBasez"Base class for a terminal manager. Nstrr   )shell_command
server_urlterm_settings	extra_envioloopblocking_io_executorc                 C  s   || _ || _|pi | _|| _tt| _i | _|dkrLd| _	t
jdd| _nd| _	|| _|dk	r|tjd| jj dtdd	 dS )
Initialize the manager.NF   )max_workersTzSetting z!.ioloop is deprecated and ignored   )
stacklevel)r[   r\   r]   r^   loggingZ	getLoggerrC   log
ptys_by_fd!_blocking_io_executor_is_externalr   ZThreadPoolExecutorr`   warningswarn	__class__DeprecationWarning)r&   r[   r\   r]   r^   r_   r`   r   r   r   r(      s"    

zTermManagerBase.__init__   P   r   r,   zdict[str, str])heightwidth	winheightwinwidthr'   r   c           	      K  s   t j }| jdt|d< d||f }|r@|r@|d||f 7 }||td < t||d< t||d< | jrx| j|td < | j	rt
|| j	 |d	i }|rt|trt
|| |S )
z@Build the environment variables for the process in the terminal.typeZTERMz%dx%dz;%dx%dZ
DIMENSIONSCOLUMNSLINESZURLr^   )r0   environcopyr]   getDEFAULT_TERM_TYPE
ENV_PREFIXrZ   r\   r^   rN   
isinstancedict)	r&   rp   rq   rr   rs   r'   r   Z
dimensionsZterm_envr   r   r   make_term_env   s     	

zTermManagerBase.make_term_envr   r'   r   c                 K  sJ   | j  }| j|d< || |d }| jf |}|dd}t|||S )z?Make a new terminal, return a :class:`PtyWithClients` instance.r[   r   N)r]   rx   r[   updater~   ry   r   )r&   r'   optionsr   r   r   r   r   r   new_terminal   s    


zTermManagerBase.new_terminalr
   ptywclientsr   c                 C  s0   |j j}|| j|< t }||| j|j dS )zBConnect a terminal to the tornado event loop to read data from it.N)r"   rQ   rh   r   r>   Zadd_handlerpty_readZREAD)r&   r   rQ   Zloopr   r   r   start_reading   s    
zTermManagerBase.start_readingc                 C  s:   |j j}| jd| | j|= t | |j   dS )zCalled when the pty has closed.zEOF on FD %d; stopping readingN)	r"   rQ   rg   inforh   r   r>   Zremove_handlerclose)r&   r   rQ   r   r   r   on_eof   s
    zTermManagerBase.on_eof)rQ   eventsr   c                 C  s   t |dds"| jd|  dS | j| }z<| | |jd}|j| |j	D ]}|
| qVW n2 tk
r   | | |j	D ]}|  qY nX dS )z>Called by the event loop when there is pty data ready to read.rO   )rR   zSpurious pty_read() on fd Ni   )rW   rg   debugrh   pre_pty_read_hookr"   readr!   appendr    Zon_pty_readEOFErrorr   Zon_pty_died)r&   rQ   r   r   sr*   r   r   r   r      s    




zTermManagerBase.pty_readc                 C  s   dS )zQHook before pty read, subclass can patch something into ptywclients when pty_readNr   )r&   r   r   r   r   r     s    z!TermManagerBase.pre_pty_read_hookurl_componentr   c                 C  s   t dS )a7  Override in a subclass to give a terminal to a new websocket connection

        The :class:`TermSocket` handler works with zero or one URL components
        (capturing groups in the URL spec regex). If it receives one, it is
        passed as the ``url_component`` parameter; otherwise, this is None.
        N)NotImplementedErrorr&   r   r   r   r   get_terminal  s    zTermManagerBase.get_terminal	websocketr   c                 C  s   dS )z=Override this to e.g. kill terminals on client disconnection.Nr   r&   r   r   r   r   client_disconnected  s    z#TermManagerBase.client_disconnectedr   c                   s(   |   I dH  | js$| jjddd dS )zShutdown the manager.NFT)waitZcancel_futures)kill_allri   r`   shutdownr9   r   r   r   r     s    zTermManagerBase.shutdownc                   s>   g }| j  D ]}||jdd q|r:tj| I dH  dS )Kill all terminals.Tr6   N)rh   valuesr   rB   r7   Zgather)r&   r   termr   r   r   r   %  s
    zTermManagerBase.kill_all)rY   NNNN)rn   ro   r   r   )N)N)rC   rD   rE   rF   r(   r~   r   r   r   r   r   r   r   r   r   r   r   r   r   rX      s*        "     
	rX   c                      sL   e Zd ZdZddd fddZdddd	d
dZdd fddZ  ZS )SingleTermManagerz9All connections to the websocket share a common terminal.r   r
   r   c                   s   t  jf | d| _dS ra   N)superr(   terminal)r&   r'   rl   r   r   r(   2  s    zSingleTermManager.__init__Nr   r   c                 C  s&   | j dkr |  | _ | | j  | j S )z "Get the singleton terminal.N)r   r   r   r   r   r   r   r   7  s    

zSingleTermManager.get_terminalr   c                   s   t   I dH  d| _dS )zKill the singletone terminal.N)r   r   r   r9   r   r   r   r   >  s    zSingleTermManager.kill_all)N)rC   rD   rE   rF   r(   r   r   __classcell__r   r   r   r   r   /  s   r   c                   @  s.   e Zd ZdZdddddZddd	d
ZdS )MaxTerminalsReachedz;An error raised when we exceed the max number of terminals.r,   r
   )max_terminalsr   c                 C  s
   || _ dS )zInitialize the error.Nr   )r&   r   r   r   r   r(   G  s    zMaxTerminalsReached.__init__rZ   r   c                 C  s
   d| j  S )z'The string representation of the error.z$Cannot create more than %d terminalsr   r9   r   r   r   __str__K  s    zMaxTerminalsReached.__str__N)rC   rD   rE   rF   r(   r   r   r   r   r   r   D  s   r   c                      sN   e Zd ZdZddddd fddZddd	d
ddZdddddZ  ZS )UniqueTermManagerz-Give each websocket a unique terminal to use.Nz
int | Noner   r
   r   r'   r   c                   s   t  jf | || _dS r   )r   r(   r   r&   r   r'   r   r   r   r(   S  s    zUniqueTermManager.__init__r   r   c                 C  s6   | j r t| j| j kr t| j |  }| | |S )z Get a terminal from the manager.)r   lenrh   r   r   r   )r&   r   r   r   r   r   r   X  s
    

zUniqueTermManager.get_terminalr   r   c                 C  sL   | j d |jrHtjdkr:|j  | |jjj dS |j	t
j dS )z-Send terminal SIGHUP when client disconnects.z-Websocket closed, sending SIGHUP to terminal.r/   N)rg   r   r   r0   r1   r.   r   r"   rQ   r4   r   r<   r   r   r   r   r   a  s    

z%UniqueTermManager.client_disconnected)N)N)rC   rD   rE   rF   r(   r   r   r   r   r   r   r   r   P  s   	r   c                      s   e Zd ZdZd$dddd fddZdd	d
ddZdZddddZdddddZe	j
fddddddZd%ddddddZd	dd fd d!Zdd fd"d#Z  ZS )&NamedTermManagerzBShare terminals between websockets connected to the same endpoint.Nr   r
   r   c                   s   t  jf | || _i | _dS r   )r   r(   r   	terminalsr   r   r   r   r(   q  s    zNamedTermManager.__init__rZ   r   )r   r   c                 C  st   |dk	st || jkr | j| S | jr@t| j| jkr@t| j| jd| |  }||_|| j|< | 	| |S )z!Get or create a terminal by name.Nz$New terminal with specified name: %s)
AssertionErrorr   r   r   r   rg   r   r   r   r   )r&   r   r   r   r   r   r   w  s    




zNamedTermManager.get_terminalz%dr   r   c                 C  s2   t jddD ] }| j| }|| jkr|  S qd S )Nrb   )start)	itertoolscountname_templater   )r&   nr1   r   r   r   _next_available_name  s
    


z%NamedTermManager._next_available_nameztuple[str, PtyWithClients]r   c                 K  sT   d|kr|d n|   }| jf |}| jd| ||_|| j|< | | ||fS )z3Create a new named terminal with an automatic name.r1   z$New terminal with automatic name: %s)r   r   rg   r   r   r   r   )r&   r'   r1   r   r   r   r   new_named_terminal  s    

z#NamedTermManager.new_named_terminalr,   )r1   r-   r   c                 C  s   | j | }|| dS )zKill a terminal by name.N)r   r.   )r&   r1   r-   r   r   r   r   r.     s    
zNamedTermManager.killFr5   )r1   r6   r   c                   s    | j | }|j|dI dH  dS )zTerminate a terminal by name.r   N)r   rB   )r&   r1   r6   r   r   r   r   rB     s    
zNamedTermManager.terminater   c                   s>   t  | |j}| jd| |dk	s,t| j|d dS )z*Handle end of file for a pty with clients.zTerminal %s closedN)r   r   r   rg   r   r   r   rK   )r&   r   r1   r   r   r   r     s
    zNamedTermManager.on_eofc                   s   t   I dH  i | _dS )r   N)r   r   r   r9   r   r   r   r     s    zNamedTermManager.kill_all)N)F)rC   rD   rE   rF   r(   r   r   r   r   r   r;   r.   rB   r   r   r   r   r   r   r   r   n  s   
r   )rO   ))rF   Z
__future__r   r7   r#   r   rf   r0   rT   r   rj   collectionsr   Z
concurrentr   typingr   r   r   Zterminado.websocketr   Z
ptyprocessr	   r   ImportErrorZwinptyr   objectZtornado.ioloopr   r{   rz   r   rN   rW   rX   r   	Exceptionr   r   r   r   r   r   r   <module>   sF   

Z	 