2 x d dl mZ d dlmZ d dlmZ d dlmZ eZd Z d Z
d Z dd
Z dd Z
G d d
e ZdS ) )UNKNOWN_CP_NAME NotSupported)GeneralPanelPluginV1)Featurec dS )z
Retrieve panel name and it's version
:return: dict: { 'CPName': 'panel_name', 'CPVer': 'panel_version', 'CPAdd': 'add_info'}
or None if can't get info
N r /builddir/build/BUILDROOT/alt-python27-cllib-3.4.36-1.el9.cloudlinux.x86_64/opt/cloudlinux/venv/lib/python3.11/site-packages/clcommon/cpapi/plugins/nopanel.pyget_cp_descriptionr
s 4r
c t d Nz=Unable to receive data. Not supported without a control panelr r r
r db_accessr
V
W
WWr
c * t dddid )z_
return all users list registered on Control Panel
:return: tuple registered users
&%(action)s is not currently supported.action1Getting all users registered in the control panelmessagecontextr r r
r cpusersr s,
; QR r
NFc t d r r ) cplogin_lstwith_system_userss r dblogin_cplogin_pairsr " r r
c & ddl m} || S )zs
Gets admin email
:param str|None _hostname: for testing
:return: admin's email
:rtype: string
r get_admin_email) _hostname) clcommon.cpapi.plugins.universalr )r r s r r r & s* A@@@@@ ?Y / / //r
c e Zd Z fdZd Zd Zd Zd Zd Zd d Z d d
Z
d Z d d Z d dZ
d dZd Zd Zed Zd Zd Zd dZd dZd Zd Zdee fdZ xZ S ) PanelPluginc H t d S N)super__init__)self __class__s r r' zPanelPlugin.__init__2 s
r
c t S )z4
Return panel name
:return:
)
__cpname__r( s r getCPNamezPanelPlugin.getCPName5 s
r
c dS )z
Retrieve panel name and it's version
:return: dict: { 'CPName': 'panel_name', 'CPVer': 'panel_version', 'CPAdd': 'add_info'}
or None if can't get info
Nr r, s r r z PanelPlugin.get_cp_description< s tr
c t S )zR
Retrieve admin email address
:return: Host admin's email
r r, s r r zPanelPlugin.get_admin_emailD s
r
c t d r r r, s r r zPanelPlugin.db_accessK Z[[[r
c * t dddid )zk
return all users list registered on Control Panel
:return: tuple registered users
r r r r r r, s r r zPanelPlugin.cpusersN s,
? "UV
r
NFc t d r r )r( r r s r r z!PanelPlugin.dblogin_cplogin_pairsX r1 r
c g S )z
Return list of available admin's packages
:return: List of packages. For example
['BusinessPackage', 'Package2']
r r( raise_excs r admin_packageszPanelPlugin.admin_packages[ r
c dS )z
Retrieves reseller name and package name by uid
:param user_id: User id
:return: Cortege: (Reseller_name, Package_name)
r r )r( user_ids r reseller_package_by_uidz#PanelPlugin.reseller_package_by_uidc s rr
c g S )z
Retrieves uid list for package
:param package_name: Package name
:param reseller_name: Reseller name. None for admin's package
:return: List of uids
Example: ['1000', '1002', '1006', '1007', '1008']
r )r( package_name
reseller_names r get_uids_list_by_packagez$PanelPlugin.get_uids_list_by_packagek r
cploginpackagemailresellerdnslocaleTc dS )a
Retrives specified info about panel users
:param str|unicode|list|tuple|None cpuser: user login
:param keyls: List or cortege of data which is necessary to obtain the user,
values can 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
userid - uid
:param search_sys_users:
:return: returns a tuple of tuples of data in the same sequence as specified keys in keylst
Examples:
cpinfo('cltest1')
(('cltest1', 'default', '', 'root', 'cltest1.com', 'en'),)
cpinfo()
(('res1usr1', 'res1_pack1', '', 'res1', 'res1usr1.com', 'en'),
('res1', 'default', '', 'root', 'res1.com', 'en'),
('res2', 'default', '', 'res2', 'res2.com', 'en'),
('cltest1', 'default', '', 'root', 'cltest1.com', 'en'),
('system', 'undefined', None, 'root', '', 'en'))
:rtype: tuple
r r )r( cpuserkeylssearch_sys_userss r cpinfozPanelPlugin.cpinfou s 6 rr
c i S )a
Return dictionary, contains available resellers packages, grouped by resellers
:return: Dictionary.
Example:
{'res1': ['BusinessPackage', 'UltraPackage', 'Package'],
'res2': ['SimplePackage', 'Package'] }
r r5 s r resellers_packagesz PanelPlugin.resellers_packages r@ r
c g S )z|
Gets admin emails list
:rtype: List
:return: List: ['admin1@mail.com', 'admin2@mail.com' ]
r r, s r get_admin_emails_listz!PanelPlugin.get_admin_emails_list r8 r
c dS )zb
Return document root for domain
:return: Cortege: (document_root, owner)
) rR r r( domains r docrootzPanelPlugin.docroot s
vr
c g S )z
Return aliases from user domain
:param str|unicode cpuser: user login
:param str|unicode domain:
:return list of aliases
r )rI rT s r useraliaseszPanelPlugin.useraliases r@ r
c g 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 )r( rI s r userdomainszPanelPlugin.userdomains r@ r
c g 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 r, s r homedirszPanelPlugin.homedirs r8 r
c g S )z
Return reseller users
:param resellername: reseller name; autodetect name if None
:rtype: List
:return list[str]: user names list
r r( resellernames r reseller_userszPanelPlugin.reseller_users s r
c i S )z
Return reseller users and their main domains
:param resellername: reseller name; autodetect name if None
:return dict[str, str]: pairs user <==> domain
r r] s r reseller_domainsz PanelPlugin.reseller_domains r8 r
c dS )z
Get login url for current panel;
:type domain: str
:rtype: str
:return: Panel login URL
rR r rS s r get_user_login_urlz PanelPlugin.get_user_login_url s rr
c i S )z
Get dict reseller => id
Optional method for panels without hard
link reseller <=> system user
:rtype: dict[str,int] - {'res1': id1}
:return:
r r, s r get_reseller_id_pairsz!PanelPlugin.get_reseller_id_pairs r@ r
returnc x t j t j t j t j t j g}|S )zc
Return list of CloudLinux features that can be used on the current control panel.
)r
RUBY_SELECTORPYTHON_SELECTORNODEJS_SELECTORRESELLER_LIMITSWPOS)r( return_values r get_unsupported_cl_featuresz'PanelPlugin.get_unsupported_cl_features s0
! # # # L
r
NF)Fr% )NrA T) __name__
__module__ __qualname__r' r- r r r r r r7 r; r? rL rN rP rU staticmethodrW rY r[ r_ ra rc re listr rn
__classcell__)r) s @r r# r# 1 s ! ! !\ \ \ \ \ \ \ )d $ : \
T']
r
r# ro r% )clcommon.cpapi.constr clcommon.cpapi.cpapiexceptionsr clcommon.cpapi.GeneralPanelr clcommon.featuresr r+ r r r r r r# r r
r rz s 0 0 0 0 0 0 7 7 7 7 7 7 < < < < < < % % % % % %
X X X X X X X0 0 0 0G G G G G & G G G G G r