;j2 d Z ddlZddlmZ ddlmZ ddlmZ dZ G d de Z G d d
e Z
G d d e Z G d
d Z dS )z,
Everything that is related to whmapi calls
N)FormattedException) run_command) urlencode)
WhmApiRequest WhmApiErrorc e Zd ZdZd ZdS )r zW
An error that is raised in case of an error
in communication with whmapi.
c 6 t j | ||d d S )N)messagecontext)r __init__)selfr
r s /builddir/build/BUILDROOT/alt-python27-cllib-3.4.44-1.el8.cloudlinux.x86_64/opt/cloudlinux/venv/lib/python3.11/site-packages/clcommon/lib/whmapi_lib.pyr zWhmApiError.__init__ s3 #D +
+
N)__name__
__module__ __qualname____doc__r r r r r s-
r r c e Zd ZdZdS )WhmLicenseErrorz)A license-related error raised by whmapi.Nr r r r r r r r r " s 33Dr r c e Zd ZdZdS )WhmNoPhpBinariesErrorz;
An error when there are no installed php binaries
Nr r r r r r ' s Dr r c t e Zd ZdZdZdZd Zd Zed Z e
d Z e
d Z d Z
d
Zd S ) r a
Wrapper over cpanel's whm command-line api tool
that allows us to easily build complex requests (filter, sorting, etc)
See details in the official cpanel docs (link below)
https://documentation.cpanel.net/display/DD/Guide+to+WHM+API+1
z/usr/sbin/whmapi1 c B || _ i | _ i | _ ddg| _ d S )Nz--outputjson)_command_filters_args _extra_args)r
commands r r zWhmApiRequest.__init__: s*
&/r c X t |d \ }}}|dk rt d| t j | }d|v r#d|d v r|d d d|d d< n+# t t
f$ r}t d |
|d }~ww xY w| | |S ) NT)return_full_outputr z whmapi exited with code %(code)i)codemetadatareason zTwhmapi returned invalid response that cannot be parsed with json, output: %(output)s)output)r r r loads TypeError
ValueError _validate)r
r" exitcoder) _responsees r _run_whmapizWhmApiRequest._run_whmapi@ s ) . . .&! q== 2
z&))H
h&&!Xj%999!*-h7?13$X.:& A
x s ;A* *B;B
Bc | | rt d|d | | r t d|d d |d d |d d }}n$# t $ r}t d| |d }~ww xY w|t j k rt d
| d S ) z)
Check response metadata
z"whmapi license error: %(response)s statusmsgr0 z Php binaries error: %(response)sr& r' resultz7whmapi metadata section is broken, output: %(response)sNz4whmapi failed to execute request, reason: %(reason)s)r' )_is_license_errorr _is_no_php_binaries_errorr KeyErrorr r
API_RESULT_OK)clsr0 r6 r' r1 s r r- zWhmApiRequest._validate\ s
* * !4x ?T
( ( 2 2 '2Xj=QRZ=[
$X.0DX0N FF I!
]0 0 0 F
1 0s A= =
B BB c Z d| v o'| d dk od| d v S )a#
Distinguish license-related WHM API errors from others.
License errors are on the client's side, and should not be logged to sentry.
An error is considered license-related if the API returns status 0
and the error message contains the word 'license'
r4 statusr license)lowerr5 s r r7 z WhmApiRequest._is_license_errory sA x' ;"a';Xk 2 8 8 : :: d| v od| d v od| d d v S )u
No binaries error can be detected by checking special message
'“PHP” is not installed on the system' whmapi output
r& r' u( “PHP” is not installed on the systemr r5 s r r8 z'WhmApiRequest._is_no_php_binaries_error s> h& ]HZ 00]:hz>RS[>\\ ^r c : | j | | S )z
Add some extra arguments to subprocess call
Useful for methods like createacct, removeacct
:param kwargs: arguments that will be added to cmd
:rtype: WhmApiRequest
)r update)r
kwargss r with_argumentsz WhmApiRequest.with_arguments s
&!!! r c | j | j g}t | j D ]O\ }}t |t rt | }t ||i }| | P|
| j | | }d|v r|d S d|v r|d S |S )zp
Run subprocess, run output validation and
return json-loaded response
:return:
datar) )
WHMAPIr listr items
isinstanceboolintr appendextendr! r2 )r
cmdkvargumentr6 s r callzWhmApiRequest.call s
K M
))++,, ! !DAq!T""
FF !Q((H JJx
4#$$$!!#&& V &> !
(# #Mr N)r r r r rG r: r r2 classmethodr- staticmethodr7 r8 rD rS r r r r r . s !FM0 0 0 8 [8 < < \ < ^ ^ \^ ($ $ $ $ $r r )
r r clcommonr clcommon.utilsr urllib.parser __all__r r r r r r r rZ s ' ' ' ' ' ' & & & & & & " " " " " "
*
$
k
K Y Y Y Y Y Y Y Y Y Yr