;jz+ d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
d dl m Z d dl
mZ e j d d
k Z G d d e ZdS )
N)Feature) exec_utility) defaultdict)ClPwd)lvectl_custompanel_script)GeneralPanelPluginV1)CPAPIExternalProgramFailed USE_ENCHANCED_CUSTOM_LONG_SCRIPT1c e Zd Z fdZd Zd Z ddZ d fd
Zd Zd fd Z d
Z
d Z d Z d Z
d Zd dZd dZd Zd Z fdZd dZdee fdZ xZS ) PanelPluginc | t t | _ d| _ d S )NUnknown)super__init__r _custom_script_name_cp_name)self __class__s /builddir/build/BUILDROOT/alt-python27-cllib-3.4.44-1.el8.cloudlinux.x86_64/opt/cloudlinux/venv/lib/python3.11/site-packages/clcommon/cpapi/plugins/backward_plugin.pyr zPanelPlugin.__init__ s2
#<#>#> !
c | j S )z4
Return panel name
:return:
)r r s r getCPNamezPanelPlugin.getCPName s
} r c * | j | j dddS dS )z
Retrieve panel name and it's version
:return: dict: { 'name': 'panel_name', 'version': 'panel_version', 'additional_info': 'add_info'}
or None if can't get info
N0)nameversionadditional_info)r r r s r get_cp_descriptionz PanelPlugin.get_cp_description s$ # / McdSS Str NcploginpackagemailresellerdnslocaleTc 2 | ||| S )N)keylssearch_sys_users)_cpinfo)r cpuserr) r* s r cpinfozPanelPlugin.cpinfo, s ||F%BR|SSSr r" r# r$ r% r& r' uidFc t r#t | }n| | }n+# t t
t t t f$ r i }Y nw xY wt }t t }| D ]\ }} |
| d }
n# t j $ r d| d}
Y nw xY wt | t r| d } | d } n| } d} |
| d| dd|d||
< v# t $ r Y w xY wg }
g }t |t" r|g}nOt |t$ t& f rt% | }n#|!t% | }|D ]S}
|
|vr||
}g }|D ] }| || |
t' | Tt' |
S ) 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:
:param raise_exc: hack for clquota that raises exception in case of exit code != 0
: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
raise_excr z::r# r% Nr. )r
r
list_userslist_allOSErrorIOError
IndexErrorAttributeErrorr r r dictitems get_namesNoSuchUserException
isinstance Exceptionstrlisttuplekeysappend)r r, r) r* r2 all_users_datacl_pwd
users_dictr/ value user_namer# r% out_listuser_name_list user_datauser_data_listdata_keyr s r r+ zPanelPlugin._cpinfo0 sb 8 /
D!&!3!3i!3!H!H "& !C!C*n>XY NNN &&
(..00 JC
) " , ,S 1 1! 4 ,
)
)
) )LLL
) %&&
* ,
4=4;155=043703
)+ )+
9%%
fc " " 5 $XNN
u
.
. 5 !&\\NN
^ !*//"3"3 4 4N' 3 3I
**"9-I N !
;
; %%i&9:::: OOE. 1 1 2 2 2 2X s6 A A %A,+A,+CC C
D
D('D(c d} t | j dt | z g \ }}| d d }n## t
t t t f$ r Y nw xY wd|fS )z
Retrieves reseller name and package name by uid
:param user_id: User id
:return: Cortege: (Reseller_name, Package_name)
r3 z --userid=
r ) r r r@ splitpopr6 r7 r8 r9 )r user_id package_name_stdouts r reseller_package_by_uidz#PanelPlugin.reseller_package_by_uid s $T%= CPWLL@X?YZZIAv!<<--11!44LL*n= D < s AA A65A6c t si S t | S # t t t
t t f$ r i cY S w xY w)a
Return dictionary, contains available resellers packages, grouped by resellers
:return: Dictionary.
Example:
{'res1': ['BusinessPackage', 'UltraPackage', 'Package'],
'res2': ['SimplePackage', 'Package'] }
r1 )r
r resellers_packagesr6 r7 r8 r9 r )r r2 r s r rY z PanelPlugin.resellers_packages sb 0 I 77-- -BB B*n>XY III s !. %AAc t st S d | D }t t | S )z
Generates a list of resellers in the control panel
:return: list/tuple of cpusers registered in the control panel
:rtype: tuple
:raise: NotSupported
c g | ]
}|d S )r% ).0rH s r
z)PanelPlugin.resellers.. s TTT%
+TTTr )r
rB r4 valuesset)r resellers_lists r resellerszPanelPlugin.resellers sT 0 77NTT 9J9J9Q9Q9S9STTTS (()))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 r c dS )zb
Return document root for domain
:return: Cortege: (document_root, owner)
r\ r\ r domains r docrootzPanelPlugin.docroot s
rr 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 r, s r userdomainszPanelPlugin.userdomains 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 re 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 r c i S )z
Return reseller users and their main domains
:param resellername: reseller name; autodetect name if None
:rtype: List
:return dict[str, str]: pairs user <==> domain
r\ rp s r reseller_domainsz PanelPlugin.reseller_domains rs r c dS )z
Get login url for current panel;
:type domain: str
:rtype: str
:return: Panel login URL
r3 r\ rg 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 rl r c t si S t | S # t t t
t t f$ r i cY S w xY wN)r
r get_reseller_usersr6 r7 r8 r9 r )r r% r s r r| z PanelPlugin.get_reseller_users s] / I 77--h77 7*n>XY III s - %AAc ~ t t }| dd }|D ]\ }}}||d||< |S )a
Return list of triples
:rtype: dict
:return: Dictionary. Example:
{1000: {'reseller': '', 'package': 'Package1'},
1001: {'reseller': '', 'package': 'BusinessPackage'},
}
)r/ r% r# T)r) r2 )r% r# )r r: r+ )r r2 packages_users
users_infor/ r% r# s r r4 zPanelPlugin.list_users s[ %T**\\(FRV\WW
&0 M M "C7/7G"L"LN3 r returnc g S )zg
Return list of cloudlinux features that can be used
on current control panel.
r\ r s r get_unsupported_cl_featuresz'PanelPlugin.get_unsupported_cl_features re r )Nr! T)Nr. TF)Fr{ )__name__
__module__ __qualname__r r r r- r+ rW rY rb rd ri rk rn rr ru rw ry r| r4 rA r r
__classcell__)r s @r r
r
s " " " " "
)d $T T T T *l16R R R R R R l &
(
*
*
*
T'] r r
)osclcommon.featuresr clcommon.utilsr collectionsr clcommonr clcommon.clcustomscriptr clcommon.cpapi.GeneralPanelr clcommon.cpapi.cpapiexceptionsr environgetr
r
r\ r r r s
% % % % % % ' ' ' ' ' ' # # # # # # = = = = = = < < < < < < E E E E E E
$&:>>2T#U#UY\#\ N N N N N& N N N N Nr