Edit File: whmapi_lib.cpython-311.pyc
� � e� � �� � d Z ddlmZ ddlmZ ddlmZ ddlZddlmZ ddlm Z ddl m Z d Z G d � d e� � Z G d � d e � � Z G d� de � � Z G d� d� � ZdS )z, Everything that is related to whmapi calls � )�print_function)�absolute_import)�divisionN)�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)�message�context)r �__init__)�selfr r s ��/builddir/build/BUILDROOT/alt-python27-cllib-3.3.5-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.N�r r r r r r r r r % s � � � � � �3�3��Dr 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--output�json)�_command�_filters�_args� _extra_args)r �commands r r zWhmApiRequest.__init__= s* � � �� ��� ��� � '��1����r c �N � 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 |� � � �w xY w| � |� � |S ) NT)�return_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% �exitcoder, �_�responses r � _run_whmapizWhmApiRequest._run_whmapiC s� � � )� �� .� .� .���&�!� �q�=�=� �2� �� � � � ��z�&�)�)�H� �h�&�&�!�X�j�%9�9�9�!�*�-�h�7�?�13���$�X�.����:�&� � � � �A� �� � � � ���� ���x� � � ��s �;A* �*#B c �~ � | � |� � rt d|d �� � �| � |� � r t d|d d �� � � |d d |d d }}n # t $ r t d|�� � �w xY w|t j k rt d |� � � �d S ) z) Check response metadata z"whmapi license error: %(response)s� statusmsg�r3 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)�clsr3 r8 r* s r r0 zWhmApiRequest._validate_ s � � � � �� *� *� �!�4�x� �?T�� � � � � (� (�� 2� 2� �'�2�X�j�=Q�RZ�=[�� � � � ���$�X�.���0D�X�0N� �F�F��� � � � �I�!�� � � � ���� �]�0� 0� 0� �F� �� � � � 1� 0s � A= �= Bc �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' r6 �statusr �license)�lowerr7 s r r9 z WhmApiRequest._is_license_error| sA � � �x�'� ;���"�a�'�;��X�k� 2� 8� 8� :� :�:� <r c �> � 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 r7 s r r: z'WhmApiRequest._is_no_php_binaries_error� s> � � �h�&� ]��H�Z� 0�0�]�:�h�z�>R�S[�>\�\� ^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� isinstance�bool�intr �append�extendr$ r4 )r �cmd�k�v�argumentr8 s r �callzWhmApiRequest.call� s� � � �K� �M� �� ���)�)�+�+�,�,� !� !�D�A�q��!�T�"�"� � ��F�F�� �!�Q��(�(�H� �J�J�x� � � � � � � �4�#�$�$�$��!�!�#�&�&�� �V� � ��&�>� !� �� � ��(�#� #��Mr N)r r r r rI r< r r4 � classmethodr0 � staticmethodr9 r: rF rU r r r r r 1 s� � � � � � �� � "�F��M�2� 2� 2� � � �8 �� � �[��8 � <� <� �\� <� �^� ^� �\�^�� � �($� $� $� $� $r r )r � __future__r r r r �clcommonr �clcommon.utilsr � urllib.parser �__all__r r r r r r r �<module>r] sF ��� � &� %� %� %� %� %� &� &� &� &� &� &� � � � � � � � � � � '� '� '� '� '� '� &� &� &� &� &� &� "� "� "� "� "� "� *�� � � � � �$� � � � � � � � �k� � � � � � � � �K� � � �Y� Y� Y� Y� Y� Y� Y� Y� Y� Yr