File: //opt/alt/python37/lib/python3.7/site-packages/clcommon/lib/__pycache__/whmapi_lib.cpython-37.pyc
B
A]#�W��� @ s� d Z ddlmZ ddlmZ ddlmZ ddlZddlmZ ddlm Z ddl
m Z d Z G d
d � d e�Z
G d d
� d
e
�ZG dd� de
�ZG dd� d�ZdS )z,
Everything that is related to whmapi calls
� )�print_function)�absolute_import)�divisionN)�FormattedException)� run_command)� urlencode)�
WhmApiRequest� WhmApiErrorc @ s e Zd ZdZdd� ZdS )r zW
An error that is raised in case of an error
in communication with whmapi.
c K s t �| ||d�� d S )N)�message�context)r �__init__)�selfr
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/lib/whmapi_lib.pyr s zWhmApiError.__init__N)�__name__�
__module__� __qualname__�__doc__r r r r r r s r c @ s e Zd ZdZdS )�WhmLicenseErrorz)A license-related error raised by whmapi.N)r r r r r r r r r % s r c @ s e Zd ZdZdS )�WhmNoPhpBinariesErrorz;
An error when there are no installed php binaries
N)r r r r r r r r r * s r c @ s\ e Zd ZdZdZdZdd� Zdd� Zedd � �Z e
d
d � �Z e
d d
� �Z dd� Z
dd� ZdS )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 C s || _ i | _i | _ddg| _d S )Nz--output�json)�_command�_filters�_args� _extra_args)r
�commandr r r r = s zWhmApiRequest.__init__c C s� t |dd�\}}}|dkr&td|d��y>t�|�}d|krbd|d krb|d d d krbd|d d< W n$ ttfk
r� td |d
��Y nX | �|� |S ) NT)Zreturn_full_outputr z whmapi exited with code %(code)i)�code�metadata�reason� zTwhmapi returned invalid response that cannot be parsed with json, output: %(output)s)�output)r r r �loads� TypeError�
ValueError� _validate)r
r Zexitcoder! �_�responser r r � _run_whmapiC s$
zWhmApiRequest._run_whmapic C s� | � |�rtd|d d��| �|�r8td|d d d��y |d d |d d }}W n tk
rv td|d��Y nX |tjkr�td |d
��d S ) z)
Check response metadata
z"whmapi license error: %(response)s� statusmsg)r' z Php binaries error: %(response)sr r �resultz7whmapi metadata section is broken, output: %(response)sz4whmapi failed to execute request, reason: %(reason)s)r N)�_is_license_errorr �_is_no_php_binaries_errorr �KeyErrorr r �
API_RESULT_OK)�clsr' r* r r r r r% _ s
zWhmApiRequest._validatec C s$ d| ko"| d dko"d| d � � kS )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'
r) Zstatusr �license)�lower)r' r r r r+ | s z WhmApiRequest._is_license_errorc C s$ d| ko"d| d ko"d| d d kS )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 )r' r r r r, � s z'WhmApiRequest._is_no_php_binaries_errorc K s | 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
�kwargsr r r �with_arguments� s z WhmApiRequest.with_argumentsc C s� | j | jg}xBt| j�� �D ]0\}}t|t�r6t|�}t||i�}|� |� q W |�
| j � | � |�}d|krv|d S d|kr�|d S |S dS )zp
Run subprocess, run output validation and
return json-loaded response
:return:
�datar! N)
�WHMAPIr �listr �items�
isinstance�bool�intr �append�extendr r( )r
�cmd�k�vZargumentr* r r r �call� s
zWhmApiRequest.callN)r r r r r6 r. r r( � classmethodr% � staticmethodr+ r, r4 rA r r r r r 1 s
r )r Z
__future__r r r r Zclcommonr Zclcommon.utilsr Z urllib.parser �__all__r r r r r r r r �<module> s