A;?B
BBc t S )z
Getting root access to mysql database.
For example {'login': 'root', 'db': 'mysql', 'host': 'localhost', 'pass': '9pJUv38sAqqW'}
:return: root access to mysql database
:rtype: dict
:raises: NoDBAccessData
)rO r s r* rO zPanelPlugin.db_access s {{r) c t S )z
Generates a list of cpusers registered in the control panel
:return: list of cpusers registered in the control panel
:rtype: tuple
)rf r s r* rf zPanelPlugin.cpusers s yyr) c t S )z
Generates a list of resellers in the control panel
:return: list of cpusers registered in the control panel
:rtype: tuple
)rk r s r* rk zPanelPlugin.resellers s {{r) c t | S )zc
Check if given user is reseller;
:type username: str
:rtype: bool
)ru )r! rr s r* ru zPanelPlugin.is_reseller s 8$$$r) NFc " t || S )a
Get mapping between system and DB users
@param cplogin_lst :list: list with usernames for generate mapping
@param with_system_users :bool: add system users to result list or no.
default: False
)r )r! r r s r* r z!PanelPlugin.dblogin_cplogin_pairs s %[2CDDDr) r6 Tc & t ||| S )a
Retrieves info about panel user(s)
:param str|unicode|list|tuple|None cpuser: user login
:param keyls: list of data which is necessary to obtain the user,
the valuescan be:
cplogin - name/login user control panel
mail - Email users
reseller - name reseller/owner users
locale - localization of the user account
package - User name of the package
dns - domain of the user
:param bool search_sys_users: search for cpuser in sys_users or in control panel users (e.g. for Plesk)
:return: returns a tuple of tuples of data in the same sequence as specified keys in keylst
:rtype: tuple
)r )r )r! r r r s r* r zPanelPlugin.cpinfo
s " fe6FGGGGr) c t S )zR
Retrieve admin email address
:return: Host admin's email
r r s r* r zPanelPlugin.get_admin_email s
r) c " t | | S )z
Return aliases from user domain
:param str|unicode cpuser: user login
:param str|unicode domain:
:return list of aliases
)r )r r s r* r zPanelPlugin.useraliases' s 66***r) c t | S )z
Return document root for domain
:param str|unicode domain:
:return Cortege: (document_root, owner)
)r r! r s r* r zPanelPlugin.docroot1 s v r) c t | S )z
Return domain and document root pairs for control panel user
first domain is main domain
:param str|unicode cpuser: user login
:return list of tuples (domain_name, documen_root)
)r r! r s r* r zPanelPlugin.userdomains9 s 6"""r) c t | S )z
Return addon domain and mountpoint domain pairs for control panel user
:param str|unicode cpuser: user login
:return: mapping of addon domain names to their server names
:rtype: dict
)r r s r* r z PanelPlugin.useraddondomainsB s '''r) c t S )z
Detects and returns list of folders contained the home dirs of users of the cPanel
:return: list of folders, which are parent of home dirs of users of the panel
)r0 r s r* r0 zPanelPlugin.homedirsL s
zzr) c t | S )z
Return reseller users
:param resellername: reseller name; autodetect name if None
:return list[str]: user names list
)rZ r! rW s r* rZ zPanelPlugin.reseller_usersS s l+++r) c t | S )a
Get dict[user, domain]
Attention!! This function may work unstable. See PTCLLIB-95 for details.
:param reseller_name: reseller's name
:rtype: dict[str, str|None]
:raises DomainException: if cannot obtain domains
)r_ r s r* r_ z PanelPlugin.reseller_domains[ s ---r) c t | S )z`
Get login url for current panel;
:type domain: str
:rtype: str
)ra r s r* ra z PanelPlugin.get_user_login_urle s "&)))r) c t | S )z
Return domain's owner
:param domain: Domain/sub-domain/add-domain name
:rtype: str
:return: user name or None if domain not found
)r r s r* r zPanelPlugin.domain_ownerm s F###r) c t d d }n"# t $ r}t | |d }~ww xY wd|iS )N php_get_system_default_versionr default_version_idr rd r r )r! default_versionr s r* get_system_php_infoz PanelPlugin.get_system_php_infov sl 7 +0 2 226$&& DOO 7 7 7,Q//Q 6 7
!/
s '*
A AA c j | }| }i }|D ]}|d }|t | vr$t d||||d d}n|d rdn|| }t
|d ||| ||d
< |S ) a
Returns info about domains: username, php_version, handler_type
For each domain we detect handler and php_version
_get_php_version_id_to_handler_map() returns data of installed versions,
so if the version of some domain was removed we can`t detect the handler.
In such case we set handler_type to None.
Otherwise we detect handler and set it to handler_type
:rtype dict
r z*Unable to find php %s in handlers map %s. )php_version_idphp_version_to_handler_mapextraNphp_fpmfpmaccount)rr r handler_typedisplay_versionvhost)rn rp r keysloggerr} r )r! r php_settings_per_vhostdomains_php_info domain_infor r s r* get_domains_php_infoz PanelPlugin.get_domains_php_info s &*%L%L%N%N"!%!>!>!@!@ 1 K ( 3N T*D*I*I*K*K%L%LLL I +-G3A?Y$ $ $ (3I(> Duu3NC 5F$Y/ - ) . 6 6 6 [ 1 2 2 r) c P t d d } g }| D ]}| d rd| dd d}| t ||d d|d t j | t j |t t j |d
t j |d | d
rd| d}| t ||d d|d t j |d t j | t j |d
t j |d |S # t t f$ r'}t
d| g cY d}~S d}~ww xY w)zV
Get the list of PHP version installed in panel
:return: list
rc versionszalt-z/opt/-r r r( z usr/bin/phpzlink/conf/default.ini)
identifierr r# modules_dirbininizea-z /opt/cpanel/z/root/zusr/lib64/php/modules/z etc/php.ini)r r r r# r r z7CPAPI: Could not get list of installed PHP versions: %sN)r rd rY r r} r r% r& r r r r r r} ) php_versionsphp_descriptionphp_name php_root_dirr s r* get_installed_php_versionsz&PanelPlugin.get_installed_php_versions s! " #()EFFKKMMjYL !O (
&&v.. #H8+;+;C+E+E#H#H#HL#**>#+#+B< @ @(2, @ @ GLL 6 6$&GLL ?Z?\?\$]$] GLL } E E GLL 7N O O
, , , ((//
#B(#B#B#BL#**>#+#+B< @ @(2, @ @$&GLL ?W$X$X GLL 6 6 GLL } E E GLL } E E
, , , " "? +& LLRTU V V VIIIIII s 'G- -H%> H H% H%rq ro ) panel_parkerc t d d S # t $ r} t | | d} ~ ww xY w)z
See https://documentation.cpanel.net/display/DD/WHM+API+1+Functions+-+php_get_vhost_versions
:rtype: dict
php_get_vhost_versionsr Nr )r s r* rp z$PanelPlugin._get_vhosts_php_versions sV 7 !9::??AA*M M 7 7 7,Q//Q 6 7s &)
AAAc t d d } nZ# t $ rM}t d||j |j d t } Y d}~nd}~ww xY wd | D S )a
Returns dict with info about php version and it`s current handler:
{'ea-php56': 'cgi', 'ea-php72': 'suphp', 'alt-php51': 'suphp', 'alt-php52': 'suphp' ...}
Using cpanel whmapi request
Tries to get all handlers or if there is problem with some handler - gets handlers one by one
As a result information could be incomplete if some handlers are not available
See https://documentation.cpanel.net/display/DD/WHM+API+1+Functions+-+php_get_handlers
:rtype: dict
php_get_handlersversion_handlerszlUnable to get information about php handlers, falling back to per-handler data gathering. Error happened: %s)
error_message
error_contextr Nc , i | ]}|d |d S )r current_handlerr( )r^ phps r*
>2XXXXr) c t dd 5 }| cd d d S # 1 swxY w Y d S # t $ r}t d |d }~ww xY w)Nz/var/cpanel/mainiprQ rR zZUnable to detect main ip for this server. Contact CloudLinux support and report the issue.)ra rE rH FileNotFoundErrorr )r! r r s r*
get_server_ipzPanelPlugin.get_server_ip s *W===
(vvxx~~''
(
(
(
(
(
(
(
(
(
(
(
(
(
(
(
(
(
( C
s9 A &A A A
A
A
A
A2 A--A2c h t d d }d |D S )N
listsuspendedr c g | ]
}|d S r9 r( r: s r* r` z4PanelPlugin.suspended_users_list.