B
    .‹dA6  ã               @   sH  d 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 yddlmZ dd„ ZW nB ek
r¶   y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„ Zdeee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.
é    N)Údeque)Úfutures)ÚPtyProcessUnicodec               C   s   t   t jt j¡ d S )N)ÚsignalÚSIGPIPEÚSIG_DFL© r   r   úa/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/terminado/management.pyÚ
preexec_fn   s    r
   )Ú
PtyProcess)ÚIOLoopZPYXTERM_zxterm-256colorc               @   sD   e Zd Zddd„Zdd„ Zejfdd„Zejfdd	„Zddd„Z	dS )ÚPtyWithClientsNc             C   s\   g | _ tg dd| _t||pg |d}td k	r6t|d< tjf |Ž| _t 	d¡dd| j_
d S )Niè  )Úmaxlen)ÚargvÚenvÚcwdr
   zutf-8Úreplace)Úerrors)Úclientsr   Úread_bufferÚdictr
   r   ÚspawnÚptyprocÚcodecsÚgetincrementaldecoderÚdecoder)Úselfr   r   r   Úkwargsr   r   r	   Ú__init__)   s    zPtyWithClients.__init__c             C   sŽ   d }}x@| j D ]6}|j\}}|dk	r2||k r2|}|dk	r||k r|}qW |dksZ|dkr^d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ÚclientÚrowsÚcolsr   r   r	   Úresize_to_smallest6   s    
z!PtyWithClients.resize_to_smallestc             C   s   | j  |¡ dS )z'Send a signal to the process in the ptyN)r   Úkill)r   Úsigr   r   r	   r$   L   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	   r+   P   s    
zPtyWithClients.killpgFc             ƒ   sê   t jdkrtjtjg}ntjtjtjtjg}t ¡ }‡ fdd„}ˆ j	 
¡ sNdS ydx0|D ](}ˆ  |¡ |ƒ I dH  ˆ j	 
¡ sVdS qVW |r°ˆ  tj¡ |ƒ I dH  ˆ j	 
¡ s¬dS dS dS  tk
rä   |ƒ I dH  ˆ j	 
¡ sÜdS dS Y nX dS )zþ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.r&   c                  s   t  ˆ jj¡S )N)ÚasyncioÚsleepr   Zdelayafterterminater   )r   r   r	   r-   c   s    z'PtyWithClients.terminate.<locals>.sleepTNF)r'   r(   r   ÚSIGINTÚSIGTERMÚSIGHUPÚSIGCONTr   Úcurrentr   Zisaliver$   ÚSIGKILLÚOSError)r   ÚforceZsignalsÚ_r-   r%   r   )r   r	   Ú	terminateW   s2    






zPtyWithClients.terminate)NN)F)
Ú__name__Ú
__module__Ú__qualname__r   r#   r   r/   r$   r+   r7   r   r   r   r	   r   (   s
   
r   c             C   s8   x2|  ¡ D ]&\}}|dkr(|  |d¡ q
|| |< q
W dS )z<Like dict.update(), but remove keys where the value is None.N)ÚitemsÚpop)ÚtargetÚchangesÚkÚvr   r   r	   Ú_update_removing‚   s    rA   çš™™™™™¹?)ÚfdÚtimeoutÚreturnc             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)Úposixiè  N)	r'   r(   ÚselectÚpollÚregisterÚPOLLINÚPOLLPRIÚPOLLHUPÚPOLLERR)rC   rD   ZpollerÚrr6   r   r   r	   Ú_poll‹   s    
rO   c               @   sp   e Zd ZdZddd„Zdd	d
„Zdd„ Zdd„ Zdd„ Zddd„Z	dd„ Z
d dd„Zdd„ Zdd„ Zdd„ ZdS )!ÚTermManagerBasez"Base class for a terminal manager.Ú Nc             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 )	NFé   )Úmax_workersTzSetting z!.ioloop is deprecated and ignoredé   )Ú
stacklevel)Úshell_commandÚ
server_urlÚterm_settingsÚ	extra_envÚloggingÚ	getLoggerr8   ÚlogÚ
ptys_by_fdÚ!_blocking_io_executor_is_externalr   ÚThreadPoolExecutorÚblocking_io_executorÚwarningsÚwarnÚ	__class__ÚDeprecationWarning)r   rV   rW   rX   rY   Zioloopr`   r   r   r	   r   œ   s     	
zTermManagerBase.__init__é   éP   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	rŠt
|| j	ƒ | d	i ¡}|r®t|tƒr®t
||ƒ |S )
z@Build the environment variables for the process in the terminal.ÚtypeÚTERMz%dx%dz;%dx%dZ
DIMENSIONSÚCOLUMNSÚLINESÚURLrY   )r'   ÚenvironÚcopyrX   ÚgetÚDEFAULT_TERM_TYPEÚ
ENV_PREFIXÚstrrW   rY   rA   Ú
isinstancer   )	r   ÚheightÚwidthZ	winheightZwinwidthr   r   Ú
dimensionsZterm_envr   r   r	   Úmake_term_env»   s     

zTermManagerBase.make_term_envc             K   sJ   | j  ¡ }| j|d< | |¡ |d }| jf |Ž}| dd¡}t|||ƒS )z?Make a new terminal, return a :class:`PtyWithClients` instance.rV   r   N)rX   rm   rV   Úupdaterv   rn   r   )r   r   Úoptionsr   r   r   r   r   r	   Únew_terminalÔ   s    


zTermManagerBase.new_terminalc             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   rC   r]   r   r2   Úadd_handlerÚpty_readÚREAD)r   ÚptywclientsrC   Ú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   rC   r\   Úinfor]   r   r2   Zremove_handlerÚclose)r   r}   rC   r   r   r	   Úon_eofå   s
    zTermManagerBase.on_eofc             C   s¨   t |dds"| j d|› ¡ dS | j| }y@|  |¡ |j d¡}|j |¡ x|j	D ]}| 
|¡ qXW W n6 tk
r¢   |  |¡ x|j	D ]}| ¡  qŽW Y nX dS )z>Called by the event loop when there is pty data ready to read.gš™™™™™¹?)rD   zSpurious pty_read() on fd Ni   )rO   r\   Údebugr]   Úpre_pty_read_hookr   Úreadr   Úappendr   Zon_pty_readÚEOFErrorr‚   Zon_pty_died)r   rC   Úeventsr}   Ú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_hookc             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   Úurl_componentr   r   r	   Úget_terminal  s    zTermManagerBase.get_terminalc             C   s   dS )z=Override this to e.g. kill terminals on client disconnection.Nr   )r   Ú	websocketr   r   r	   Úclient_disconnected  s    z#TermManagerBase.client_disconnectedc             Ã   s(   |   ¡ I d H  | js$| jjddd d S )NFT)ÚwaitZcancel_futures)Úkill_allr^   r`   Úshutdown)r   r   r   r	   r‘     s    zTermManagerBase.shutdownc             Ã   sB   g }x$| j  ¡ D ]}| |jdd¡ qW |r>tj|Ž I d H  d S )NT)r5   )r]   Úvaluesr†   r7   r,   Úgather)r   r   Útermr   r   r	   r     s
    zTermManagerBase.kill_all)rQ   NNNN)re   rf   r   r   )N)N)r8   r9   r:   Ú__doc__r   rv   ry   r   r‚   r{   r„   rŒ   rŽ   r‘   r   r   r   r   r	   rP   ™   s        




	rP   c                   s6   e Zd ZdZ‡ fdd„Zd	dd„Z‡ fdd„Z‡  ZS )
ÚSingleTermManagerz9All connections to the websocket share a common terminal.c                s   t ƒ jf |Ž d | _d S )N)Úsuperr   Úterminal)r   r   )rc   r   r	   r   #  s    zSingleTermManager.__init__Nc             C   s&   | j d kr |  ¡ | _ |  | j ¡ | j S )N)r˜   ry   r   )r   r‹   r   r   r	   rŒ   '  s    

zSingleTermManager.get_terminalc             ƒ   s   t ƒ  ¡ I d H  d | _d S )N)r—   r   r˜   )r   )rc   r   r	   r   -  s    zSingleTermManager.kill_all)N)r8   r9   r:   r•   r   rŒ   r   Ú__classcell__r   r   )rc   r	   r–      s   
r–   c               @   s   e Zd Zdd„ Zdd„ ZdS )ÚMaxTerminalsReachedc             C   s
   || _ d S )N)Úmax_terminals)r   r›   r   r   r	   r   3  s    zMaxTerminalsReached.__init__c             C   s
   d| j  S )Nz$Cannot create more than %d terminals)r›   )r   r   r   r	   Ú__str__6  s    zMaxTerminalsReached.__str__N)r8   r9   r:   r   rœ   r   r   r   r	   rš   2  s   rš   c                   s4   e Zd ZdZd	‡ fdd„	Zd
dd„Zdd„ Z‡  ZS )ÚUniqueTermManagerz-Give each websocket a unique terminal to use.Nc                s   t ƒ jf |Ž || _d S )N)r—   r   r›   )r   r›   r   )rc   r   r	   r   =  s    zUniqueTermManager.__init__c             C   s6   | j r t| jƒ| j kr t| j ƒ‚|  ¡ }|  |¡ |S )N)r›   Úlenr]   rš   ry   r   )r   r‹   r”   r   r   r	   rŒ   A  s
    

zUniqueTermManager.get_terminalc             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)r\   r€   r˜   r'   r(   r$   r{   r   rC   r+   r   r0   )r   r   r   r   r	   rŽ   I  s    

z%UniqueTermManager.client_disconnected)N)N)r8   r9   r:   r•   r   rŒ   rŽ   r™   r   r   )rc   r	   r   :  s   
r   c                   sn   e Zd ZdZd‡ fdd„	Zdd„ ZdZdd	„ Zd
d„ Ze	j
fdd„Zddd„Z‡ fdd„Z‡ fdd„Z‡  ZS )ÚNamedTermManagerzBShare terminals between websockets connected to the same endpoint.Nc                s   t ƒ jf |Ž || _i | _d S )N)r—   r   r›   Ú	terminals)r   r›   r   )rc   r   r	   r   Y  s    zNamedTermManager.__init__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 )Nz$New terminal with specified name: %s)
ÚAssertionErrorr    r›   rž   rš   r\   r€   ry   Ú	term_namer   )r   r¢   r”   r   r   r	   rŒ   ^  s    




zNamedTermManager.get_terminalz%dc             C   s2   x,t jddD ]}| j| }|| jkr|S qW d S )NrR   )Ústart)Ú	itertoolsÚcountÚname_templater    )r   Únr(   r   r   r	   Ú_next_available_nameq  s    

z%NamedTermManager._next_available_namec             K   sV   d|kr|d }n|   ¡ }| jf |Ž}| j d|¡ ||_|| j|< |  |¡ ||fS )Nr(   z$New terminal with automatic name: %s)r¨   ry   r\   r€   r¢   r    r   )r   r   r(   r”   r   r   r	   Únew_named_terminalw  s    


z#NamedTermManager.new_named_terminalc             C   s   | j | }| |¡ d S )N)r    r$   )r   r(   r%   r”   r   r   r	   r$   ƒ  s    
zNamedTermManager.killFc             Ã   s    | j | }|j|dI d H  d S )N)r5   )r    r7   )r   r(   r5   r”   r   r   r	   r7   ‡  s    
zNamedTermManager.terminatec                s2   t ƒ  |¡ |j}| j d|¡ | j |d ¡ d S )NzTerminal %s closed)r—   r‚   r¢   r\   r€   r    r<   )r   r}   r(   )rc   r   r	   r‚   ‹  s    zNamedTermManager.on_eofc             ƒ   s   t ƒ  ¡ I d H  i | _d S )N)r—   r   r    )r   )rc   r   r	   r   ‘  s    zNamedTermManager.kill_all)N)F)r8   r9   r:   r•   r   rŒ   r¦   r¨   r©   r   r/   r$   r7   r‚   r   r™   r   r   )rc   r	   rŸ   V  s   
rŸ   )rB   )$r•   r,   r   r¤   rZ   r'   rG   r   ra   Úcollectionsr   Ú
concurrentr   Z
ptyprocessr   r
   ÚImportErrorZwinptyr   ÚobjectZtornado.ioloopr   rp   ro   r   rA   ÚintÚfloatÚlistrO   rP   r–   Ú	Exceptionrš   r   rŸ   r   r   r   r	   Ú<module>   s>   

Z	 