fj~ d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m
Z
ddl m Z
m Z ddlmZmZmZ ddlZddlmZ ddlmZmZ ddlmZmZ dd lmZ dd
l m Z dd l m Z dd l m!Z" d
dl#m$Z$ d
dl%m&Z& d
dl'm(Z( d
dl)m*Z*m+Z+m,Z,m-Z-m.Z. d
dl/m0Z0 d
dl1m2Z2 d
dl3m4Z4 d
dl5m6Z6m7Z7m8Z8 d
dl9m:Z: d
dl;mZ>m?Z?m@Z@ d
dlAmBZBmCZCmDZDmEZEmFZFmGZG d
dlHmIZImJZJmKZKmLZLmMZM ejN rd
dlOmPZP G d d ZQdS ) zX
This module contains classes implementing X-Ray Manager behaviour
and helper functions
N)datetime timedelta)escapeglob)IteratorOptionalTuple)Feature)is_panel_feature_supportedget_installed_php_versions)php_get_vhost_versionsis_wpos_supported)is_litespeed_running)drop_privileges)
disable_quota)gettext ) ClWposGetter)
get_client)ContinuousManager) XRayAPIError XRayErrorXRayMissingDomainXRayManagerExit XRayManagerExitPHPUnsupported)FPMReloadController)open_local_storage)NginxUserCache)
DomainInfoTask url_split)ManageUserAgent)AdvancedMetrics)get_xray_exec_useruser_mode_restrictednginx_user_cache)no_active_tasksswitch_schedstats ssa_disabled_cagefsctl_remountset_privilegesis_file_recently_modified)create_ini_filesremove_ini_filesis_global_ini_mode remove_global_ini_mode_marker create_global_ini_mode_marker) APIClientc e Zd ZdZdZddddddd d
d d d
ddddZd`dedefdZde e
fdZ de fdZ
dedefdZdedefd Zdedefd Zdedefd Zdedefd Zdedd fd!Zd" Zd#edefd$Zed%edeej fd& Z d'edd fd(Z d)edefd*Z d+edefd,Z dedefd-Z d.edefd/Z!d.edd fd0Z"ed#ede#ee
f fd1 Z$d2edd fd3Z%edefd4 Z&dad6Z'e(ddd7d)ed8ed9ed:e
d;edZ*d?d@d)ed:e
dd5fdAZ+dBedd5fdCZ,dD Z-e(dBedd5fdE Z.dBedd5fdFZ/edGe defdH Z0dadIZ1edJe2dKdLfdM Z3dBedd5fdNZ4d)edOedd5fdPZ5d)edd5fdQZ6d)edd5fdRZ7d)edd5fdSZ8dadTZ9dadUZ:dVedd5fdWZ;dVedXe
dd5fdYZdad\Z?dad]Z@dad^ZAdad_ZBd S )b BaseManagerz
Basic manager abstract class.
Implements methods common for all managers.
Requires managers to implement their custom methods.
z/var/run/xray-agent.pidz/opt/alt/php54/link/confz/opt/alt/php55/link/confz/opt/alt/php56/link/confz/opt/alt/php70/link/confz/opt/alt/php71/link/confz/opt/alt/php72/link/confz/opt/alt/php73/link/confz/opt/alt/php74/link/confz/opt/alt/php80/link/confz/opt/alt/php81/link/confz/opt/alt/php82/link/confz/opt/alt/php83/link/confz/opt/alt/php84/link/confz/opt/alt/php85/link/conf)z alt-php54z alt-php55z alt-php56z alt-php70z alt-php71z alt-php72z alt-php73z alt-php74z alt-php80z alt-php81z alt-php82z alt-php83z alt-php84z alt-php85F system_id phpinfo_modec t | _ || _ t j d | _ t
| _ t | _ || _
t d | j | _ d S )Nmanagerlistsr5 ) r api_client_classsys_idlogging getLoggerloggerr continuous_monitoringr" manage_user_agentr6
ui_api_client)selfr5 r6 s H/opt/cloudlinux/venv/lib64/python3.11/site-packages/xray/manager/base.py__init__zBaseManager.__init__c sr 2< ' 22 %6%8%8"!0!2!2 ( 0Z 0 04; G G G returnc t | j 5 }t | cd d d S # 1 swxY w Y d S # t t
f$ r t
j d Y d S w xY w)Nz'Unable to read daemon pid from pidfile.)openDAEMON_PIDFILEintreadOSErrorIOErrorr= warning)rC fs rD _get_daemon_pidzBaseManager._get_daemon_pidn s Gd)**
%a16688}}
%
%
%
%
%
%
%
%
%
%
%
%
%
%
%
%
%
%! G G G O E F F F F F F Gs3 A !A A AA A A %A:9A:c | j S )z\
Get supported PHP versions
:return: a dict with supported versions
)VERSIONSrC s rD supported_versionsz BaseManager.supported_versionsu s
} rF php_versionc . || v S )z
Check if given PHP version is supported
:param php_version: PHP version, e.g. 'alt-phpXY'
:return: True if version is supported, False otherwise
)rU )rC rV s rD is_version_supportedz BaseManager.is_version_supported| s d 5 5 7 777rF domain_infoc Z | |j S )zh
Get a path to directory for additional ini file for based on
panel-set version
)rU getpanel_php_versionrC rY s rD _ini_pathzBaseManager._ini_path s'
&&((,,[-JKKKrF c | | } |j r|j }n&| | r|j }n |j p|}n# t
$ r Y nw xY w| j d| |S )z
Resolve a path to directory for additional ini file
It depends on version set for domain and on selector
:param domain_info: a DomainInfo object
:return: path to directory for ini files
zIni path resolved as %s)r^ php_ini_scan_diris_selector_enabledselector_ini_pathphpd_location_ini_path
ValueErrorr? info)rC rY ini_paths rD get_ini_pathzBaseManager.get_ini_path s >>+.. +
J&7))+66
J&8&=I D
2H===s 5A
AAc |j s=| | r(| j d|j |j }n|j }| j d| |S )a
Get PHP version which serves given domain
:param domain_info: a DomainInfo object, including user of domain
and PHP version set in control panel environment
:return: real php version of domain (selector or panel one)
z Selector is enabled for user %szPHP version detected as %s)is_selector_appliedra r? re userselector_php_versionr\ )rC rY current_versions rD get_php_versionzBaseManager.get_php_version sy . <((55 < K > ( -
/
/
/ ) >OO ) ;O 5GGG rF c t t t j sdS |j dS | | S )a
Is selector enabled for given domain
:param domain_info: a DomainInfo object, including user of domain
and PHP version set in control panel
:return: True if selector is enabled for domain, False otherwise
F)r r
PHP_SELECTORrk panel_specific_selector_enabledr] s rD ra z BaseManager.is_selector_enabled s> *'*>?? 5 + 3533K@@@rF Nc | |j |j r| | dS t r | |j dS | |j dS )z
Reload FPM service or kill all *php* processes of user
:param domain_info: a ready-to-use DomainInfo object
N)reset_criu_imgsname panel_fpmrestart_fpm_servicer gracefully_restart_litespeedrj
kill_user_phpr] s rD php_procs_reloadz BaseManager.php_procs_reload s
[ -... 1 $ $[ 1 1 1 1 1
!
#
# 1 - -k.> ? ? ? ? ? { / 0 0 0 0 0rF c t | 5 t 5 t j | } t t
j |j d d n3# t t f$ r | j
dd Y nw xY wddd n # 1 swxY w Y ddd dS # 1 swxY w Y dS )z
Litespeed's graceful restart.
https://www.litespeedtech.com/support/wiki/doku.php/litespeed_wiki:php:detached_mode#for_a_user
z.lsphp_restart.txtwz$Unable to restart lsws after changesT)exc_infoN)r r pwdgetpwnamrI ospathjoinpw_dircloseFileNotFoundErrorPermissionErrorr? rO )rC usernamepws rD rv z(BaseManager.gracefully_restart_litespeed s
X
&
& [ [
[ [ h''B
[RW\\")-ABBCHHNNPPPP%7
[
[
[ ##$JUY#ZZZZZ
[ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [sX CB:AA;:B:;-B+(B:*B++B:. C:B> >CB> CCCr c t }| | D ]P}d|j d v r?| t j | |j d Q|S )z
Kill all PHP processes, which belong to given username
:param username: name of user
:return: list of pids of successfully killed processes
phprs pid)list
user_procsre send_signalsignalSIGHUPappend)rC r killed_procsprocs rD rw zBaseManager.kill_user_php sr vv OOH-- 6 6D &))) /// ##DIe$4555rF user_namec # K t j | j }g d}t j | D ],}||j d j |j d j fv r|V -dS )z
Generator yields processes, which belong to given user_name.
Processes are checked using UID, not user_name
:param user_name: user name
:return: a generator object
)rs r uidsr N)r| r} pw_uidpsutil process_iterre real effective)r uid_by_nameattrsps rD r zBaseManager.user_procs su l9--4 '''$U++ Aqvf~ 2AF6N4L MMM rF domainc |sdS t dt | d }|r=t j |d | j d|d dS dS )zt
Reset criu images if any found for given domain in order to
enable/disable X Ray correctly
Nz/var/run/mod_lsapi/*
_criu_imgsr zcriu images in %s dropped)r glob_escapeshutilrmtreer? re )rC r
criu_imgs_dirs rD rr zBaseManager.reset_criu_imgs s
F SK4G4G S S STT
L M-* + + + K 8-:J K K K K K L LrF urlc P t | \ }}| | S )z4
DomainInfo retrieving based on url
)r! get_domain_inforC r domain_name_s rD _domain_info_by_urlz BaseManager._domain_info_by_url s' #3 Q##K000rF r c : t t d )z
Retrieve information about given domain from control panel environment
Required to be implemented by child classes
:param domain_name: name of domain
:return: a DomainInfo object
z0Manager should implement retrieving domain info!NotImplementedErrorr )rC r s rD r zBaseManager.get_domain_info s% "
@ A AC C CrF c : t t d )z
Check if selector is enabled specifically for panel
Required to be implemented by child classes
:param domain_info: a DomainInfo object
:return: True if yes, False otherwise
zCManager should implement specific panel check for selector enabled!r r] s rD rp z+BaseManager.panel_specific_selector_enabled s% "
S T TV V VrF dom_infoc : t t d )z
Get FPM service name for particular panel
:param dom_info: DomainInfo object
:return: name of FPM service
z5Manager should implement FPM service name retrieving!r )rC r s rD fpm_service_namez BaseManager.fpm_service_name s% "
E F FH H HrF c | | } t j d|dgddd | j d| t | d S # t t t j f$ r7}| j
dt | |d Y d }~d S d }~ww xY w)
zg
Restart FPM service for particular version
:param dom_info: DomainInfo object
z
/sbin/servicereloadT)capture_outputtextcheckzService %s reloadedz Failed to reload FPM service)errre extraN) r
subprocessrunr? re r save_latest_reloadrM rd SubprocessErrorerrorstr)rC r fpm_serves rD ru z BaseManager.restart_fpm_service% s
((22 ? N (H5 #
K 2H = = =
) ) < < > > > > > Z%?@ 8 8 8 K <,/FF-5%7 %7
8
8
8
8
8
8
8
8
8 8s 6A0 0 C ,B>>Cc J t j | }d|j d}t j t j | s@t j t j | t | ||j fS )z5Resolve path for user and prepare directory if neededz/var/clwpos/uids/z
/info.json)
r| r} r r~ r isdirdirnamemakedirsr* pw_gid)r _upwd_paths rD prepare_wpos_info_pathz"BaseManager.prepare_wpos_info_path9 s X&& > >rF )r c 8 | |dd|dd S )a6
Start monitoring of given URL (autotracing task).
Note, user is overridden as *autotracing*
Arguments are only allowed by keyword
:param url: URL to monitor
:param tracing_count: count of requests to capture
:return: JSON encoded result of start action
r request_qtyT)r r r r r r r )rC r r s rD start_autotracingz BaseManager.start_autotracing s- zzcS](5&* , , ,rF r c | | j | }| }| t |j 5 }| |j ddd n # 1 swxY w Y g d}|j |vr1t t d t |j z | |j
}| |j nm# t $ r | j d d}Y nEt& $ r9}t) |dd r | j d d}n Y d}~nd}~ww xY w| | | }|d k r| | n| || |;t5 |j | | t; r t= rt? d
| d |j! S )
z
Stop monitoring of given task ID
:param tracing_task_id: an ID of task to stop
:return: JSON encoded result of stop action
r5 r )next_request_idN)runningstopped completedholdz!Cannot stop task with status '%s'z+Stopping task for an already deleted domain_internal_missing_domainFr r stopr )"r; r< get_task _request_daemon_storage_flushr fake_idupdate_with_local_datar statusr r r r r set_domain_ownerrj r r? re r getattrremove drop_cronjobrecalculate_countsr _completer restorerx r' r) r( r r ) rC r r r storagetry_to_complete_statusesrY r remaining_counts rD r zBaseManager.stop s &&7F ' H H (( **,,,
4
5
5 Y / /@W / X X X Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y $O#N#N &> > >!566\=P9Q9QQS S
S 22<3CDDK ) )+*: ; ; ; ; K J K K K KKK q4e<<
!NOOO " $ !!### '99;; Q KK ( ( ( ( NN< 0 0 0 " ;+ , , 4 4 6 6 6 ! !+ . . . - - e , , , ,}}F-9-A C C Cs0 BBB 4D &E*( E*1/E%%E*c t j t j t j h | }|rK t j |t j n*# t $ r | j d Y nw xY w| j
d t j t j hd }|t j d t j t j
t j h dS )z
Request daemon to flush it's in-memory storage on disk using SIGUSR2
and wait for getting SIGUSR2 back that daemon sends when it successfully
flushed data on disk and we are ready to proceed.
zVUnable to send daemon signal. Some stats will not be flushed. Maybe daemon is stopped?z2Waiting for daemon to signal back about flush end.g .@NzUDaemon did not signal back in given timeout. Some stats may not be flushed. Continue.)r pthread_sigmask SIG_BLOCKSIGUSR2rQ r~ killrM r? rO re sigtimedwaitr= SIG_DFL)rC
daemon_pidsiginfos rD r z)BaseManager._request_daemon_storage_flush s v /&.1ABBB))++
@
@
FN3333
@
@
@ ## %? @ @ @ @ @
@
MNNN%v~&6== ? O G
H
H
H v~/?@@@@@s A" "$B B c | | j | }| }|j dv r1t t d t
|j z | |j }| |j
d| v r| | }nd}|
| | | j | |j t# |j
| | t) d | d
|j S ) z
Continue monitoring of given task ID
:param tracing_task_id: an ID of task to continue
:return: JSON encoded result of continue action
r r r z%Cannot continue task with status '%s'54Nr r: Tr continuer )r; r< r r r r r r r r rj rU rm r r r r r r rx r( r r )rC r r r rY r s rD continue_zBaseManager.continue_' s &&7F ' H H (( ": : :!9::S AT=U=UUW W
W ..|/?@@ %%k&6777 4**,, , , # 3 3K @ @ $ %5666 4; 777
l,---{'((00222 k***$''''}}J-9-A C C CrF c : | | j | }| }|j dv r1t t d t
|j z | || | d|j S )z
Complete given tak ID
:param tracing_task_id: an ID of task to complete
:return: JSON encoded result of complete action
r r1 z%Cannot complete task with status '%s'completer )
r; r< r r r r r r" r r rC r r r s rD r6 zBaseManager.completeM s &&7F ' H H (( ": : :!9::S AT=U=UUW W
W |V,,,}}J-9-A C C CrF taskc t j }| d }| d p| d }t j | }|dk r|t d z |k rdS |dk r |t | d
z |k rdS d S ) zT
Returns True if task should be completed.
False otherwise.
r r
createtimer
r )daysTr r )minutesF)r now
fromtimestampr )r8 r= r inceptiontask_start_times rD _is_to_completezBaseManager._is_to_complete] s lnn,'
%;l); "0;; & &?YA=N=N=N+NQT+T+T4 Oi_H]6^6^6^$^ad$d$d4urF c | j dg }| j dt | |D ][}| | st j dt |d | |d \| d S )z
Gets all server tasks and complete those which match following criteria:
- traced_by requests_qty: if task started 2 days ago - complete
- traced_by time: if task runs longer than start time + tracing time - complete
r z#Check tasks for autocompleting...%sz"Going to complete task with id: %sr zautocomplete-tasksr )
rB
get_task_listr[ r? re r rA r= r r )rC all_server_tasks task_items rD autocomplete_tasksz BaseManager.autocomplete_tasksm s -;;==AA(BOO >DT@U@UVVV) 4 4I'' 22
L=s9M^C_?`?` a a a IIi 12 3 3 3 3}}$8}999rF t_taskr r2 c | | | | j r| dS dS )z
Common complete actions:
- delete cron job,
- erase request id file
- send 'complete' status to mongo
:param t_task: a tracing task object
:param client: an APIClient object
N)r erase_request_id_storager6 r share)rH r s rD r" zBaseManager._complete| s^ ''))) LLNNNNN rF c : | | j | }| }|j dk r1t t d t
|j z | | d|j S )z
Delete given task ID
:param tracing_task_id: an ID of task to delete
:return: JSON encoded result of delete action
r r z#Cannot delete task with status '%s'deleter )
r; r< r r r r r rM r r r7 s rD rM zBaseManager.delete s &&7F ' H H (( ) + +!7883|?R;S;SSU U
U
}}H-9-A C C CrF emailc | | }| j |j || | d| S )z
Enable continuous monitoring for given URL
:param url: URL to monitor
:param email: email to send reports to
:return: JSON encoded result of enable action
enabler r )r r@ rP rs r )rC r rN d_infos rD enable_continuousz BaseManager.enable_continuous sM ))#.. "))&+sEBBB''xS'AAArF c t | \ }}| j | | d| S )z
Disable continuous monitoring for given URL
:param url: URL to monitor
:return: JSON encoded result of disable action
r rQ )r! r@ r r r s rD disable_continuousz BaseManager.disable_continuous sC #3 Q "**;777''yc'BBBrF c t | \ }}| j | | d| S )z
Start continuous monitoring for given URL
:param url: URL to monitor
:return: JSON encoded result of start action
r rQ )r! r@ r r r s rD start_continuousz BaseManager.start_continuous sC #3 Q "((555''wC'@@@rF c t | \ }}| j | | d| S )z
Stop continuous monitoring for given URL
:param url: URL to monitor
:return: JSON encoded result of stop action
r rQ )r! r@ r r r s rD stop_continuouszBaseManager.stop_continuous sC #3 Q "'' 444''v3'???rF c b | j }| d| S )zq
Get list of continuous monitoring tasks
:return: JSON encoded result of get list action
zget continuous listr data)r@ get_tracing_listr )rC tracing_lists rD continuous_tracing_listz#BaseManager.continuous_tracing_list s9
1BBDD }}$9". 0 0 0rF c ^ | d| j S )z#
Get list of tasks
z
tasks-listr[ )r rB rD rT s rD
tasks_listzBaseManager.tasks_list s6 }}L"&"4"B"B"D"D F F FrF r c | | j | }| }| d| j | S )z@
Get list of requests for given tracing task id
r z
requests-listr[ )r; r< r r rB get_request_list)rC r r r s rD
requests_listzBaseManager.requests_list sj
&&7> ' @ @ OO }}O"&"4"E"Eg"N"N P P PrF
request_idc | | j | }| }| d| j || S )zO
Get collected statistics for request ID of given tracing task
r z request-datar[ )r; r< r r rB get_request_data)rC r re r r s rD request_datazBaseManager.request_data sn
&&7> ' @ @ OO }}N"&"4"E"E!(*#6 #6 7 7 7rF c ` | j | d S )a
Enable X-Ray User Agent:
start or restart service if it is accidentally already running
For systemd systems -- start socket unit only
For SysV -- start the entire service
:return: JSON encoded result of enable action
zenable-user-agentrC )rA rP r rT s rD enable_user_agentz BaseManager.enable_user_agent s.
%%'''}}$7}888rF c ` | j | d S )a7
Disable X-Ray User Agent:
stop the entire service
or do nothing if it is accidentally not running
For systemd systems -- also check if socket unit is running
and stop it too
:return: JSON encoded result of disable action
zdisable-user-agentrC )rA r r rT s rD disable_user_agentz BaseManager.disable_user_agent s.
&&(((}}$8}999rF c | | j }| d|t S )zn
Get status of X-Ray User Agent service
:return: JSON encoded result of status action
zuser-agent-status)r r user_nginx_cache)rA r r r& )rC agent_statuss rD user_agent_statusz BaseManager.user_agent_status sD
-4466 }}$7 .>.@.@ B B BrF c * t }|d du r| nS|d du r| n4|d du r*| }| | S | S )]
Advanced metrics tool
:return: JSON encoded result of status action
rP Tr r )r )r# rP r r r )rC argsamr s rD advanced_metricsz BaseManager.advanced_metrics s
>T ! ! IIKKKK
)_
$
$ JJLLLL
(^t
#
#YY[[F===// /}} rF c b t t | S rr )r1 r- r rC rs s rD enable_serverwide_modez"BaseManager.enable_serverwide_mode s*
&'''}} rF c b t t | S rw )r. r0 r rx s rD disable_serverwide_modez#BaseManager.disable_serverwide_mode( s*
%'''}} rF )F)rG r )C__name__
__module__ __qualname____doc__rJ rS r boolrE r rK rQ r rU rX r r^ rg rm ra rx rv r rw staticmethodr r Processr rr r r rp r ru r r r r r r% r r
r r r r4 r6 rA rG r r" rM rS rU rW rY r_ ra rd rh rj rl rp ru ry r{ r rF rD r4 r4 J s1
/N 0///////////// H" H H# HT H H H HG# G G G G D 8 8 8 8 8 8LZ LC L L L L
s * : # " Az Ad A A A A 1J 14 1 1 1 1 [ [ [ c d c hv~&> \
Lc
Ld
L
L
L
L1s 1z 1 1 1 1C3 C: C C C CV: V$ V V V VH H H H H H?J ?4 ? ? ? ?( # #sCx # # # \#*C *D * * * *8 9c 9 9 9 \ 9' ' ' ' !&"'<C <C <CC <CC <C <C.1<C <C <C -7<C <C <C <C|> > > > > > 02 , , , ,), ,6@ , , , , @CC @CJ @C @C @C @CDA A A2 #C #C #C #C #C #CJC C
C C C C
d
t
\
:
:
:
:
$
\
Cc Cj C C C C BS B B B B B BCc Cj C C C CAC AJ A A A A@3 @: @ @ @ @0 0 0 0F F F F PS PZ P P P P
7C
7S
7Z
7
7
7
7 9 9 9 9
:
:
:
:B B B B rF r4 )Rr r r= r~ r| r r r typingr r r r r r r r r clcommon.constr
clcommon.cpapir r !xray.internal.clwpos_safe_importsr
r clcommon.utilsr clcommon.clpwdr secureior xrayr r adviser.clwpos_getr apiclientr continuous.managerr internal.exceptionsr r r r r internal.fpm_utilsr internal.local_countersr internal.nginx_utilsr internal.typesr r r! internal.user_managerr" internal.advanced_metricsr# internal.user_plugin_utilsr$ r% r& internal.utilsr' r( r) r* r+ r, reconfiguration.global_inir- r. r/ r0 r1
TYPE_CHECKINGapiclient.api_clientr2 r4 r rF rD r si
( ( ( ( ( ( ( ( , , , , , , , , , , , , , , , , , ,
" " " " " " X W W W W W W W / / / / / / * * * * * * " " " " " " - - - - - - " " " " " " 2 2 2 2 2 2 5 4 4 4 4 4 8 8 8 8 8 8 1 1 1 1 1 1 8 8 8 8 8 8 8 8 8 8 3 3 3 3 3 3 7 7 7 7 7 7
1000000f f f f f f f f f f rF