fj{ d Z ddlZddlZddlZddlZddlmZ ddlm Z ddl
m Z ddl m
Z ddlmZmZ dd lmZ dd
lmZ ej d Z G d d
e Ze G d d Ze G d d ZdS )zL
This module contains utilities for ea-nginx cache disabling during tracing
N) dataclass)Enum)Optional)gettext )nginx_cache_stat_storageallow_disable_nginx_cache) XRayError) dbm_storage nginx_utilsc e Zd ZdZdZdZdS )CachezCache statuses enumr r N)__name__
__module__ __qualname____doc__ENABLEDDISABLED P/opt/cloudlinux/venv/lib64/python3.11/site-packages/xray/internal/nginx_utils.pyr r s GHHHr r c , e Zd ZU dZeed< dZeed< dS )
SavedState initialr active_tasksN)r r r r r __annotations__r intr r r r r " s0
F
NNNL#r r c
e Zd ZU dZeed< edefd Zede fd Z
ede fd Z e j
de ddfd Z e j dd
Z d eddfd Zed
edee fd ZddZddZdS )NginxUserCachezc
Class which implements reading/writing the user's cache status
from the local storage
usernamereturnc ` d}d| j d}t j | s t j S t j | r&| | }|t | S | | }|t | S t j S )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.json)r! ospathisfiler r get_cache_status_from_filer )self global_file user_file user_settingglobal_settings r current_statusz NginxUserCache.current_status1 s 7 LDMLLL w~~k** " > !
7>>) $ $ + ::9EEL' \*** 88EE % (( (} r c ( | j t j u S )z"Check if cache is enabled for user)r- r r )r( s r
is_enabledzNginxUserCache.is_enabledL s "em33r c l t t d 5 }|| j cddd S # 1 swxY w Y n_# t $ r%}t d| Y d}~n5d}~wt $ r% t d| j Y nw xY wt t 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! RuntimeErrorloggerwarningKeyErrorinfor r r r( _nginx_cache_states r saved_statezNginxUserCache.saved_stateQ s+ K 5'+- - -
80A( 7
8
8
8
8
8
8
8
8
8
8
8
8
8
8
8
8
8 NNN
K K K KKI$-II J J J J J K %.)))s3 >
2 > 6> 6>
BA((/BBvalueNc t t d 5 }||| j < ddd dS # 1 swxY w Y dS # t $ r&}t d| Y d}~dS d}~ww xY w)zq
Save state of nginx cache manipulations -- initial cache setting
and active tasks count
Tr1 Nz+Failed to save state of nginx cache with %sr r r! r3 r4 r5 )r( r< r9 r: s r r; zNginxUserCache.saved_stated s M 5'+- - -
90A38!$-0
9
9
9
9
9
9
9
9
9
9
9
9
9
9
9
9
9
9 M M M NNH! L L L L L L L L L Ms- = 0 = 4= 4=
A-A((A-c t t d 5 }|| j = ddd dS # 1 swxY w Y dS # t $ r&}t d| Y d}~dS d}~ww xY w)z
Delete the record of state of nginx cache manipulations --
initial cache setting and active tasks count
Tr1 Nz-Failed to delete state of nginx cache with %sr> r8 s r r; zNginxUserCache.saved_stateq s O 5'+- - -
50A%dm4
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5 O O O NNJA N N N N N N N N N Os- ; . ; 2; 2;
A+A&&A+ enum_memberc ( dd| j d|j g} t j |ddd d
S # t j $ rc}t
d|j |j |j |j
t t | d|j |j
d d
}~wt t t j f$ rV}t t! d t |j t | d d
}~ww xY w)
z Enable or disable cache for userz"/usr/local/cpanel/scripts/ea-nginxcachez
--enabled=T)checktextcapture_outputz;+< > >@ N3d*.
0
0
0
0
0
0, F F F KKN ah
:
:
: CFF*+(18"D"DF F F
FZ%?@ ;BB3{GWCXCXZ]^_Z`Z`aabb
s" / DA B D;AD Dfilenamec
t | 5 } t j | }| d cddd S # t j $ rI}t
d| t | d| i Y d}~nd}~ww xY w ddd dS # 1 swxY w Y dS # t t f$ r4}t
d| t | Y d}~dS d}~ww xY w)z%Get the 'enabled' key from given fileenabledNzInvalid JSON from %s: %scontents)rI z Failed to read file %s with %s) openjsonloadgetJSONDecodeErrorr4 errorrQ readIOErrorrR )rZ _fdatar: s r r' z)NginxUserCache.get_cache_status_from_file s +h
/2/ 9R==D 88I..
/
/
/
/
/
/
/
/ + @ @ @LL!;!)3q66(2BGGII'> ! @ @ @ @ @ @ @ @@@
/
/
/
/
/
/
/
/
/
/
/
/
/
/
/
/
/
/ ! + + + LL9!3q66
+
+
+
+
+
+
+
+
+ +sg B> B1AB1 B> B ?BB1B B1$ B> 1B55B> 8B59B> >D)C>>Dc t sdS | j }| j rB | t j t j |_ n# t $ r Y nw xY w|j t j u r|xj dz
c_ || _ 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/ rY r r r r r
r r( _states r disablezNginxUserCache.disable s ) F! ? /
/ ((( "'
>U] * * 1 $ !s A
AAc | j }|j t j u rP|xj dz c_ |j dk r5 | t j n# t $ r Y nw xY w| ` 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 rY r
ri s r restorezNginxUserCache.restore s ! >U] * * 1 $ "a''HHU]++++ D$!s A
A$#A$)r" N)r r r r rQ r propertyr r- boolr/ r r; setterdeleterrY staticmethodr r' rk rm r r r r r ) sz MMM
X 4 4D 4 4 4 X4 *Z * * * X*$
M
M
M
M
M
M
O
O
O
O u $ +S +Xd^ + + + \+ " " " "4" " " " " "r r )r r_ loggingos.pathr$ rJ dataclassesr enumr typingr xrayr rU constantsr r
exceptionsr
utilsr getLoggerr4 r r r r r r r} st ! ! ! ! ! ! J J J J J J J J ! ! ! ! ! ! = ) ) D h" h" h" h" h" h" h" h" h" h"r