File: //opt/alt/python37/lib/python3.7/site-packages/clcommon/cpapi/__pycache__/__init__.cpython-37.pyc
B
좵C��� � @ s� d Z ddlmZ ddlmZ ddlmZ ddlZddlmZ ddlm Z m
Z
dd l m Z m
Z
mZ dd
lmZmZmZmZmZmZmZmZmZ dd lmZmZ dd l m Z m Z m Z e� \Z Z!d
d� Z"dgdd�Z#dhdd�Z$dd� Z%dd� Z&dd� Z'dd� Z(d d � Z)d d � Z*did d!�Z+djd$d%�Z,d&d'� Z-d(d)� Z.d*d+� Z/d,d-� Z0d.d/� Z1d0d1� Z2d2d3� Z3d4d5� Z4dkd6d7�Z5d8d9� Z6d:d;� Z7d<d=� Z8d>d?� Z9d@dA� Z:dBdC� Z;e e<dD�dEdF�Z=dGdH� Z>dIdJ� Z?dKdL� Z@eAeBdM�dNdO�ZCdPdQ� ZDdRdS� ZEdTdU� ZFdVdW� ZGe� dXdY� �ZHdZd[� ZIeAd\�d]d^�ZJd_d`� ZKdadb� ZLdcdd� ZMe<d\�dedf�ZNee!�ZOeO�P� ZQe%� ZReQjSZSeQjTZTeQjUZUeQjVZVeQjWZWeQjXZXeQjYZYeQjZZZeQj[Z[eQj\Z\eQj]Z]eQj^Z^eQj_Z_dS )lz<
CloudLinux control panel API
API for Hosting control panel
� )�absolute_import)�division)�print_functionN)� lru_cache� )� CACHE_CPNAME�UNKNOWN_CP_NAME)�Feature�get_cl_feature_status_map�get_hosting_accounts_limit) �get_cp_plugin_module�detect_panel_fast� CPANEL_NAME�DIRECTADMIN_NAME�
PLESK_NAME�ISPMANAGER_NAME�INTERWORX_NAME�INTEGRATED_NAME�OFFICIAL_PLUGINS)� NotSupported� NoPanelUser)�is_cl_solo_edition�CLEditionDetectionError� is_containerc C s t tttttgkS )zH
Is current panel has native CL support
:return: True/False
)�_CP_NAMEr r r r r � r r ��/builddir/build/BUILDROOT/alt-python27-cllib-3.4.1-1.el9.cloudlinux.x86_64/opt/alt/python37/lib/python3.7/site-packages/clcommon/cpapi/__init__.py�is_cl_supported_panel6 s r Fc C s
t �| �S )z�
Return list of available admin's packages
:param raise_exc: hack for lvemanager
:rtype: list
:return: List of packages. For example
['BusinessPackage', 'Package2']
)� _panel_class�admin_packages)� raise_excr r r r D s r c C s t �� S )a
Return dictionary, contains available resellers packages, grouped by resellers
:rtype: dict
:return: Dictionary.
Example:
{'res1': ['BusinessPackage', 'UltraPackage', 'Package'],
'res2': ['SimplePackage', 'Package'] }
)r �resellers_packages)r r r r r! O s r! c C sh t �� dkrt�� S tt tkr(t�� S tdk r4tS t} t j �
t �rdt t ��}|�
� �� } W dQ R X | S )zC
Return panel name
:rtype: str
:return: Panel name
r N)�os�getegidr � getCPNamer r �_CP_PLUGIN_NAMEr r �path�isfiler �open�readline�strip)ZcontrolpanelnameZ cache_streamr r r r$ [ s
r$ c C s t �� S )z�
Retrieve panel name and it's version
:rtype: dict
:return: dict: { 'name': 'panel_name', 'version': 'panel_version', 'additional_info': 'add_info'}
or None if can't get info
)r �get_cp_descriptionr r r r r+ u s r+ c C s0 t � rt�� S tjdd�} dd� | D �}t|�S )z�
Generates a list of cpusers registered in the control panel
:return: list of cpusers registered in the control panel
:rtype: tuple
)�cplogin)�keylsc S s g | ] }|d �qS )r r )�.0Zuser_r r r �
<listcomp>� s zcpusers.<locals>.<listcomp>)r r �cpusers�cpinfo�tuple)Z
users_infoZ _list_usersr r r r0 s
r0 c C s t �� S )z�
Generates a list of resellers in the control panel
:return: list of cpusers registered in the control panel
:rtype: tuple
)r � resellersr r r r r3 � s r3 c C s t �� S )z�
Generates a set of admins in the control panel
:return: set of cpusers registered in the control panel
:rtype: set
:raise: NotSupported
)r �adminsr r r r r4 � s r4 c C s 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
)r � db_accessr r r r r5 � s r5 c C s t �| |�S )a�
Returs a list of pairs, the database user login - user login control panel
For example:
(('nata2_someuse', 'nata2'), ('testsome_dfrtbus', 'testsome'))
:param list|tuple|None cplogin_lst: list of control panel users
:param bool with_system_users: add system users to dbmapping
:return: list of pairs, the database user login - user login control panel
:rtype: tuple
:raises: NotSupported, NoPackage
)r �dblogin_cplogin_pairs)Z cplogin_lstZwith_system_usersr r r r6 � s r6 �r, �packageZmailZresellerZdnsTc C s t j| ||d�S )u�
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
)�search_sys_users)r r1 )�cpuserr- r9 r r r r1 � s r1 c C s4 t � rt�� S y t�� d S tk
r. dS X dS )z�
Gets admin email
Note: be careful when modifying this method.
It is used in SSA, ask @dkavchuk or someone else from C-Projects team
for details
:rtype: string
:return: string - admin email
r � N)r r �get_admin_emailZget_admin_emails_list�
IndexErrorr r r r r< � s r< c C s, d} t � r(yt�� S tk
r& | S X | S )NZen)r r �get_admin_localer )ZDEFAULT_LOCALEr r r r> � s r> c C s
t �| �S )z�
Return document root for domain
:param str|unicode domain:
:rtype tuple
:return Tuple: (document_root, owner)
)r �docroot)�domainr r r r? � s r? c C s t �| |�S )z�
Return domain and document root pairs for control panel user
first domain is main domain
:param str|unicode cpuser: user login
:rtype: list
:return list of tuples (domain_name, documen_root)
)r � useraliases)r: r@ r r r rA � s rA c C s
t �| �S )z�
Return domain and document root pairs for control panel user
first domain is main domain
:param str|unicode cpuser: user login
:rtype: list
:return list of tuples (domain_name, documen_root)
)r � userdomains)r: r r r rB � s rB c C s t �� S )z�
Detects and returns list of folders contained the home dirs of users of the cPanel
:rtype: list
:return: list of folders, which are parent of home dirs of users of the panel
)r �homedirsr r r r rC
s rC c C s t � rt�| �S 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 � domain_ownerr? )r@ �_Z
_domain_ownerr r r rD s
rD c C s
t �| �S )z�
Return reseller users
:param resellername: reseller name; return empty list if None
:rtype list
:return list[str]: user names list
)r �reseller_users)� resellernamer r r rF s rF c C s
t �| �S )z�
Return reseller users and their main domains
:param resellername: reseller name; autodetect name if None
:rtype disct
:return dict[str, str]: pairs user <==> domain
)r �reseller_domains)rG r r r rH * s rH c C s
t �| �S )zM
Check if user is reseller;
:type username: str
:rtype: bool
)r � is_reseller)�usernamer r r rI 4 s rI c C s
t �| �S )zP
Get login url for current panel;
:type domain: str
:rtype: str
)r �get_user_login_url)r@ r r r rK = s rK c C s
t �| �S )z�
Return True if username is in admin names
:param str username: user to check
:rtype bool
:return: True if user is admin
)r �is_admin)rJ r r r rL F s rL c C s* t � } y
| tj S tk
r$ dS X dS )z{
Return True if panel supports reseller limits (LVE10+)
:return: bool - True - yes, False - no
:rtype bool
FN)r
r ZRESELLER_LIMITS�KeyError)Zpanel_featuresr r r � is_reseller_limits_supportedP s
rN c C s t �� S )z�
Get dict reseller => id
Optional method for panels without hard
link reseller <=> system user
:rtype: dict[str,int] - {'res1': id1}
)r �get_reseller_id_pairsr r r r rO ` s rO c C s t �� S )zY
Retrive encoding name, used for package/reseller names, from panel
:return:
)r �get_encoding_namer r r r rP l s rP )�feature�returnc C s4 yt � }|dkp|�| d�S tk
r. dS X dS )z�
Get if feature is supported by control panel.
:param
feature: constant from Feature class
:return:
boolean
NF)�get_supported_cl_features�getr )rQ Zfeaturesr r r �is_panel_feature_supportedt s
rU c C s t �� S )zL
Retrieves Apache's connections number (from mod_status)
For CM
)r � get_apache_connections_numberr r r r rV � s rV c C s t �� S )z`
Retrieves active httpd's ports from httpd's config
:return: list of apache's ports
)r �get_apache_ports_listr r r r rW � s rW c C s t �� S )z�
Get current maximum request apache workers from httpd's config
:return: tuple (max_req_num, message)
max_req_num - Maximum request apache workers number or 0 if error
message - OK/Trace
)r � get_apache_max_request_workersr r r r rX � s rX )�uidrR c C s
t �| �S )zT
Get "main" panel username by uid.
:param uid: uid
:return Username
)r �get_main_username_by_uid)rY r r r rZ � s rZ c C s t �| |�S )N)r �get_user_emails_list)rJ r@ r r r r[ � s r[ c C s
t �| �S )N)r �panel_login_link)rJ r r r r\ � s r\ c C s
t �| �S )N)r �panel_awp_link)rJ r r r r] � s r] c C s t �� p
i S )zK
Returns features that are not supported on current control panel.
)r Zget_unsupported_cl_featuresr r r r �get_unsupported_features� s r^ c C s t � S )zd
Left here mostly for backwards compatibility.
See get_cl_feature_status_map docstring.
)r
r r r r rS � s rS c C s t dd�st� rdS dS )NT)Zskip_jwt_checkF)r r r r r r �is_throttling_supported� s r_ )rR c C s t �� S )zY
Get panel users count, admin accounts are not counted
:return: Users count.
)r �get_hosting_accounts_countr r r r r` � s r` c C s t � } | sdS t�� }|| kS )zB
Check if customer hitting max accounts count per edition
F)r r r` )Zmax_accounts_limitZcurrent_accounts_countr r r � is_hitting_max_accounts_limit� s
ra c C s t � S )N)r r r r r �get_max_accounts_limit� s rb c sD y
t � } W n tk
r& td��Y nX t� � t� fdd�| D ��S )z|
Retrieve users count and admins count,
substract the last value from the first one and dump the result on disk
z cpusers() method not supportedc 3 s | ]}|� krd V qdS )r Nr )r. �user)�admins_collectionr r � <genexpr>� s z)count_hosting_accounts.<locals>.<genexpr>)r0 r r4 �sum)Z
users_listr )rd r �count_hosting_accounts� s
rg c C s< d} t j�| �sdS yt �d�dkS tk
r6 dS X dS )z@
They have symlink /usr/local/cpanel/server.type -> wp2
z /usr/local/cpanel/server.typeFZwp2N)r" r& �islink�readlink� Exception)Z
wp2_markerr r r �is_wp2_environment� s rk )F)F)NF)Nr7 T)N)`�__doc__Z
__future__r r r r" � functoolsr Zconstr r Zclcommon.featuresr r
r Z pluginlibr r
r r r r r r r Zcpapiexceptionsr r Zclcommon.lib.cleditionr r r r r% r r r! r$ r+ r0 r3 r4 r5 r6 r1 r< r> r? rA rB rC rD rF rH rI rK rL rN rO rP �boolrU rV rW rX �int�strrZ r[ r\ r] r^ rS r_ r` ra rb rg rk Z
_apipluginZ PanelPluginr ZCP_NAMEZget_domains_php_infoZget_system_php_infoZlist_allZ
list_usersZget_reseller_usersZreseller_package_by_uidZget_uids_list_by_packageZget_installed_php_versionsZget_customer_loginZget_domain_loginZ
get_server_ipZinvalidate_cpapi_cacheZsuspended_users_listr r r r �<module>
s� ,