File: //opt/alt/python37/lib/python3.7/site-packages/xray/internal/__pycache__/nginx_utils.cpython-37.pyc
B
�*Ud7 � @ s� d Z ddlZddlZddlZddlZddlmZ ddlm Z ddl
m Z ddl m
Z
mZ ddlmZ dd lmZ e�d
�ZG d d � d e �ZeG d
d� d��ZeG dd� d��ZdS )zL
This module contains utilities for ea-nginx cache disabling during tracing
� N)� dataclass)�Enum)�Optional� )�nginx_cache_stat_storage�allow_disable_nginx_cache)� XRayError)� dbm_storage� nginx_utilsc @ s e Zd ZdZdZdZdS )�CachezCache statuses enumr r N)�__name__�
__module__� __qualname__�__doc__�ENABLED�DISABLED� r r �J/opt/alt/python37/lib/python3.7/site-packages/xray/internal/nginx_utils.pyr s r c @ s& e Zd ZU dZeed< dZeed< dS )�
SavedState� �initialr � active_tasksN)r r
r r r �__annotations__r �intr r r r r s
r c @ s� e Zd ZU dZeed< eed�dd��Zee d�dd��Z
ee d�dd ��Z e j
e d
d �d d ��Z e jd
d�d
d ��Z ed
d�dd�Zeeee d�dd��Zd
d�dd�Zd
d�dd�Zd
S )�NginxUserCachezc
Class which implements reading/writing the user's cache status
from the local storage
�username)�returnc C sj d}d| j � d�}tj�|�s$tjS tj�|�rJ| �|�}|dk rJt|�S | �|�}|dk rdt|�S tjS )z�
Detect if cache is enabled or disabled for user
using cPanel's guidelines
https://docs.cpanel.net/knowledge-base/web-services/nginx-with-reverse-proxy/#third-party-integration
z /etc/nginx/ea-nginx/cache.jsonz/var/cpanel/userdata/z/nginx-cache.jsonN)r �os�path�isfiler r �get_cache_status_from_filer )�selfZ global_fileZ user_fileZ user_settingZglobal_settingr r r �current_status/ s
z NginxUserCache.current_statusc C s | j tjkS )z"Check if cache is enabled for user)r" r r )r! r r r �
is_enabledJ s zNginxUserCache.is_enabledc
C s� y"t tdd�� }|| j S Q R X W nR tk
rP } zt�d|� W dd}~X Y n& tk
rt t�d| j� �� Y nX tt j
�S )zu
Get saved state (initial cache setting and active tasks count)
of nginx cache manipulations
T)� is_shelveNz0Failed to get saved state of nginx cache with %sz No nginx cache entry found for ) r r r � RuntimeError�logger�warning�KeyError�infor r r )r! �_nginx_cache_stat�er r r � saved_stateO s
zNginxUserCache.saved_stateN)�valuer c
C sZ y&t tdd��}||| j< W dQ R X W n. tk
rT } zt�d|� W dd}~X Y nX dS )zq
Save state of nginx cache manipulations -- initial cache setting
and active tasks count
T)r$ Nz+Failed to save state of nginx cache with %s)r r r r% r& r' )r! r- r* r+ r r r r, b s
c
C sX y$t tdd��}|| j= W dQ R X W n. tk
rR } zt�d|� W dd}~X Y nX dS )z�
Delete the record of state of nginx cache manipulations --
initial cache setting and active tasks count
T)r$ Nz-Failed to delete state of nginx cache with %s)r r r r% r& r' )r! r* r+ r r r r, o s
)� enum_memberr c
C s� d| j � d|j� �}ytj|�� dddd� W n� tjk
r� } z:t�d|j|j |j
|j � t t
|�d|j
|j d�d��W d d }~X Y nD tttjfk
r� } z t d
|j� d |� �dd ��W d d }~X Y nX d S )
z Enable or disable cache for userz)/usr/local/cpanel/scripts/ea-nginx cache z --enabled=T)�check�text�capture_outputz<Failed command %s details: exitcode %i, stdout %s, stderr %sr' )�out�err)�flag�extraNz Failed to set nginx cache as z with )r4 )r r- �
subprocess�run�split�CalledProcessErrorr& r) �args�
returncode�stdout�stderrr �str�OSError�
ValueError�SubprocessError�name)r! r. �cmdr+ r r r �set| s
"zNginxUserCache.set)�filenamer c C s� ytt | ��b}yt�|�}W nB tjk
r\ } z"tjd| t|�d|�� id� W dd}~X Y n X |�d�S W dQ R X W n8 t t
fk
r� } zt�d| t|�� W dd}~X Y nX dS )z%Get the 'enabled' key from given filezInvalid JSON from %s: %s�contents)r5 N�enabledz Failed to read file %s with %s) �open�json�load�JSONDecodeErrorr& �errorr> �read�get�IOErrorr? )rE Z_f�datar+ r r r r � s
"z)NginxUserCache.get_cache_status_from_filec C sf t sdS | j}| jrBy| �tj� W n tk
r8 Y n
X tj|_|jtjkr\| j d7 _ || _dS )z�
If cache is enabled for user, disable it.
Save retrieved cache status.
For ENABLED initial status increment number of active tasks.
Skip disabling cache if it is disallowed in constants file
Nr )
r r, r# rD r r r r r r )r! �_stater r r �disable� s zNginxUserCache.disablec C sb | j }|jtjkrX| jd8 _|jdkrXy| �tj� W n tk
rN Y nX | ` dS || _ dS )a�
For ENABLED initial status decrement number of active tasks.
Restore the cache state according to saved status:
- enable if it was enabled and number of active tasks <= 0,
- do nothing if it was enabled, but number of active tasks > 0,
- do nothing if it was disabled.
Clear the record if enable has taken place.
Skip operation if cache disabling is disallowed in constants file
r r N)r, r r r r rD r )r! rQ r r r �restore� s
zNginxUserCache.restore)r r
r r r> r �propertyr r" �boolr# r r, �setter�deleterrD � staticmethodr r rR rS r r r r r ' s"
r )r rI �logging�os.pathr r6 � dataclassesr �enumr �typingr � constantsr r �
exceptionsr �utilsr � getLoggerr& r r r r r r r �<module>
s