Edit File: general_panel.cpython-37.pyc
B � e�C � @ s� d dl mZ d dl mZ d dl mZ d dlZd dlZd dlZd dlZd dlm Z d dl m Z d dl m Z mZmZmZmZ d dlmZmZ d d lmZmZmZmZ d d lmZ d d � Z d Z dZ dZ G dd� d�Z dS )� )�absolute_import)�division)�print_functionN)�getpwuid)�Dict)�ALL_CL_FEATURES�SOLO_CL_FEATURES�ADMIN_CL_FEATURES�UBUNTU_CL_FEATURES�CONTAINER_CL_FEATURES)� NotSupported�CPAPIExternalProgramFailed)�is_cl_solo_edition�is_cl_admin_edition� is_container� is_ubuntu)� acquire_lockc s � fdd�}|S )Nc s t d� j ��d S )Nz"%s" api not supported)r �__name__)�a�kw)�func� ��/builddir/build/BUILDROOT/alt-python27-cllib-3.3.5-1.el8.cloudlinux.x86_64/opt/alt/python37/lib/python3.7/site-packages/clcommon/cpapi/GeneralPanel/general_panel.py� _exception+ s z"_not_supported.<locals>._exceptionr )r r r )r r �_not_supported* s r z%/usr/bin/getcontrolpaneluserspackagesz/var/lve/panel_users_countz /var/clcpapic @ s, e Zd Zdd� Zdd� Zedd� �Zedd� �Zed d � �Zd d � Z d d� Z dddd�Z dd� Z dedd�Z dfdd�Zdgdd�Zdhdd �Zd d � Zd d � Zd!d"� Zed#d$� �Zed%d&� �Zed'd(� �Zed)d*� �Zedid+d,��Zedjd/d0��Zed1d2� �Zed3d4� �Z ed5d6� �Z ed7d8� �Z edkd9d:��Z edld;d<��Z ed=d>� �Z!ed?d@� �Z"edAdB� �Z#edCdD� �Z$edEdF� �Z%edGdH� �Z&eedIdJ� ��Z'e(e)e*f dK�dLdM�Z+edNdO� �Z,edPdQ� �Z-edRdS� �Z.ee/e)dT�dUdV��Z0ee)e)e)dW�dXdY��Z1edZd[� �Z2ee/dK�d\d]��Z3d^d_� Z4d`da� Z5dbdc� Z6dS )m�GeneralPanelPluginV1c C s t | _d S )N)�GET_CP_PACKAGE_SCRIPT�_custom_script_name)�selfr r r �__init__8 s z GeneralPanelPluginV1.__init__c C s d S )Nr )r r r r �invalidate_cpapi_cache< s z+GeneralPanelPluginV1.invalidate_cpapi_cachec C s\ x |D ]}t j�|�sdS qW t j�| �s.dS x(|D ] }t j�|�t j�| �kr4dS q4W dS )NFT)�os�path�exists�getmtime)Z cpapi_cacheZ panel_markersZmarkerr r r �is_cache_valid? s z#GeneralPanelPluginV1.is_cache_validc C sJ t |d ��4 t|ddd��}tjd| i|dd� W d Q R X W d Q R X d S )Nz.lock�w�surrogateescape)�errors�data� )�indent)r �open�json�dump)Z actual_data� cache_file�fr r r �rewrite_cpapi_cacheM s z(GeneralPanelPluginV1.rewrite_cpapi_cachec s � fdd�}|S )Nc s �� fdd�}|S )Nc s� t j�t�jd �}t�|� d �}t j�|�r�|r�y,t|ddd��}t � |�d }W d Q R X W q� t k r� �| |�}t� ||� Y q�X n�| |�}t� ||� |S )Nz.cacheZ panel_parker�rr' )r( r) ) r! r" �join�CPAPI_CACHE_STORAGEr r r% r# r, r- �load� Exceptionr1 )�args�kwargsr/ Z cache_validr0 r) )�decorator_kwargsr r r �wrapperV s zCGeneralPanelPluginV1.cache_call.<locals>.decorator.<locals>.wrapperr )r r: )r9 )r r � decoratorU s z2GeneralPanelPluginV1.cache_call.<locals>.decoratorr )r9 r; r )r9 r � cache_callS s z GeneralPanelPluginV1.cache_callc C s dS )zV Return panel name :rtype: str :return: Name of panel Z GeneralPanelr )r r r r � getCPNameh s z GeneralPanelPluginV1.getCPNamec C s4 t j| jg| t jt jdd�}|�� \}}|||fS )zv Just wraps long script calls. :param args: arguments to pass :return: stdout, stderr T)�stdout�stderr�text)� subprocess�Popenr �PIPEZ communicate)r r7 �p�out�errr r r �_run_long_scriptp s z%GeneralPanelPluginV1._run_long_scriptFc C sb g }| � dg�\}}}|r4|jdkr4t|p0d| ��x(|�� �d�D ]}|dkrD|�|� qDW |S )z� Return list of available admin's packages :param raise_exc: raise exception on exit code != 0 :return: List of packages. For example ['BusinessPackage', 'Package2'] z--list-packagesr z,Failed to get information about packages: %s� � )rG � returncoder �strip�split�append)r � raise_excZ packages_listr> r? rD �liner r r �admin_packages| s z#GeneralPanelPluginV1.admin_packagesc C sh i }| � dt|� g�\}}}xD|�� �d�D ]2}d|kr<q.|�d�}|d |d�|t|d �< q.W |S )Nz--list-reseller-users=rH �,� )�package�resellerr )rG �strrK rL �int)r rT �reseller_usersrE �_rO r r r �get_reseller_users� s z'GeneralPanelPluginV1.get_reseller_usersNc C sz t � }yTdt|� g}|dk r0|�dt|� � | �|�\}}}|�d�}|t|�d = W n tttfk rt Y nX |S )a Retrieves uid list for package :param package_name: Package name :param reseller_name: Reseller name. None for admin's package :rtype: List :return: List of uids Example: [1000, 1002, 1006, 1007, 1008] z --package=Nz --reseller=rH rR ) �listrU rM rG rL �len�OSError�IOError�AttributeError)r Z package_nameZ reseller_nameZuid_listr7 r> rX r r r �get_uids_list_by_package� s z-GeneralPanelPluginV1.get_uids_list_by_packagec C s| i }| � dg�\}}}|r0|jdkr0td| ��d|krxx>|�d�D ]0}|�dd�}t|�dkrD|d |t|d �< qDW |S ) Nz --list-allr z2Failed to get list of users and their packages: %szerror:rH � rR � )rG rJ r rL r[ rV )r rN Zuid_package_maprE rX rD rO r r r �list_all� s z GeneralPanelPluginV1.list_allc C s� i }| � dg�\}}}|r4|jdkr4t|p0d| ��xH|�� �d�D ]6}d|krRqD|�d�}|d |d d�|t|d �< qDW |S ) Nz --list-usersr z)Failed to get information about users: %srH rQ rR ra )rS rT )rG rJ r rK rL rV )r rN ZusersrE rF rD rO r r r � list_users� s "z GeneralPanelPluginV1.list_usersc C s� t �t�}| �dg�\}}}|r:|jdkr:t|p6d| ��|�d�}xT|D ]L}|�� }|s\qJ|�dd�}t|�dkrvqJ|d |d } } || � | � qJW |S )a Return dictionary, contains available resellers packages, grouped by resellers :return: Dictionary. Example: {'res1': ['BusinessPackage', 'UltraPackage', 'Package'], 'res2': ['SimplePackage', 'Package'] } z--list-resellers-packagesr z4Failed to get information about reseller package: %srH r` rR ra ) � collections� defaultdictrZ rG rJ r rL rK r[ rM ) r rN �resellers_packagesrE rF rD �linesrO Z line_partsZres_nameZ pack_namer r r rf � s z'GeneralPanelPluginV1.resellers_packagesc C s\ | � dt|� g�\}}}|�d��d�}| � dt|� g�\}}}|�d��d�}||fS )Nz --userid=rH r z--get-user-reseller=)rG rU rL �pop)r Zuser_idrE rX rD rS rT r r r �reseller_package_by_uid� s z,GeneralPanelPluginV1.reseller_package_by_uidc C s dgS )zt List all admins names in given control panel :rtype: List :return: list of strings �rootr )r r r r �admins� s zGeneralPanelPluginV1.adminsc C s || � � kS )z| Return True if username is in admin names :param str username: user to check :return: bool )rk )r �usernamer r r �is_admin� s z GeneralPanelPluginV1.is_adminc C s 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 Nr )r r r r �get_cp_description� s z'GeneralPanelPluginV1.get_cp_descriptionc C s dS )z� Generates a list of resellers in the control panel :return: tuple of cpusers registered in the control panel :rtype: tuple :raise: NotSupported Nr )r r r r � resellers s z GeneralPanelPluginV1.resellersc C s dS )z] Check if user is reseller; :type username: str :rtype: bool Nr )r rl r r r � is_reseller s z GeneralPanelPluginV1.is_resellerc C s dS )a Getting root access to mysql database. For example {'login': 'root', 'db': 'mysql', 'host': 'localhost', 'pass': '9pJUv38sAqqW'} :return: root access to mysql database :rtype: dict :raises: NoDBAccessData, NotSupported Nr )r r r r � db_access s z GeneralPanelPluginV1.db_accessc C s dS )a� Returs a list of pairs, the database user login - user login control panel For example: (('nata2_someuse', 'nata2'), ('testsome_dfrtbus', 'testsome')) :param list|tuple|None cplogin_lst: list of control panel users :param bool with_system_users: add system users to dbmapping :return: list of pairs, the database user login - user login control panel :rtype: tuple :raises: NotSupported, NoPackage Nr )r Z cplogin_lstZwith_system_usersr r r �dblogin_cplogin_pairs$ s z*GeneralPanelPluginV1.dblogin_cplogin_pairs�ZcploginrS ZmailrT ZdnsTc C s dS )a� Retrives information aboutv panel users :param str|unicode|list|tuple|None cpuser: user login :param keyls: - list of data which is necessary to obtain the user, the 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 - user's uid :param search_sys_users: :return: returns a tuple of tuples of data in the same sequence as specified keys in keylst :rtype: tuple Nr )r �cpuserZkeylsZsearch_sys_usersr r r �cpinfo2 s zGeneralPanelPluginV1.cpinfoc C s dS )z| Gets admin emails list :rtype: List :return: List: ['admin1@mail.com', 'admin2@mail.com' ] Nr )r r r r �get_admin_emails_listF s z*GeneralPanelPluginV1.get_admin_emails_listc C s dS )zb Return document root for domain :return: Cortege: (document_root, owner) Nr )r �domainr r r �docrootO s z GeneralPanelPluginV1.docrootc C s dS )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) Nr )r rt r r r � userdomainsW s z GeneralPanelPluginV1.userdomainsc C s dS )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 Nr )r r r r �homedirsb s z GeneralPanelPluginV1.homedirsc C s dS )z� Return reseller users :param resellername: reseller name; autodetect name if None :rtype: List :return list[str]: user names list Nr )r � resellernamer r r rW k s z#GeneralPanelPluginV1.reseller_usersc C s dS )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 Nr )r r{ r r r �reseller_domainsu s z%GeneralPanelPluginV1.reseller_domainsc C s dS )z� Get login url for current panel; :type domain: str :rtype: str :return: Panel login URL Nr )r rw r r r �get_user_login_url s z'GeneralPanelPluginV1.get_user_login_urlc C s dS )z� Get dict reseller => id Optional method for panels without hard link reseller <=> system user :rtype: dict[str,int] - {'res1': id1} :return: Nr )r r r r �get_reseller_id_pairs� s z*GeneralPanelPluginV1.get_reseller_id_pairsc C s dS )a Retrives dictionary information about php versions for each domain { 'domain.com': { 'php_version_id': 'ea-php70' 'php_handler': lsapi | fpm | cgi | fastcgi }} :rtype: dict Nr )r r r r �get_domains_php_info� s z)GeneralPanelPluginV1.get_domains_php_infoc C s dS )zW Retrives list of php versions installed in panel :rtype: list Nr )r r r r �get_installed_php_versions� s z/GeneralPanelPluginV1.get_installed_php_versionsc C s dS )z\ Retrives dictionary with system information about php :rtype: dict Nr )r r r r �get_system_php_info� s z(GeneralPanelPluginV1.get_system_php_infoc C s dS )z :rtype: str Nr )r r r r �get_admin_locale� s z%GeneralPanelPluginV1.get_admin_localec C s dS )ze Retrive encoding name, used for package/reseller names, from panel :return: Nr r r r r �get_encoding_name� s z&GeneralPanelPluginV1.get_encoding_name)�returnc C s4 t � r tS t� rtS tdd�r"tS tdd�r0tS tS )zg Return list of cloudlinux features that can be used on current control panel. T)�skip_jwt_check) r r r r r r r r r )r r r r �get_supported_cl_features� s z.GeneralPanelPluginV1.get_supported_cl_featuresc C s dgS )zl Retrieves active httpd's ports from httpd's config :return: list of apache's ports �P r r r r r �get_apache_ports_list� s z*GeneralPanelPluginV1.get_apache_ports_listc C s dS )zX Retrieves Apache's connections number (from mod_status) For CM )r �OKr r r r r � get_apache_connections_number� s z2GeneralPanelPluginV1.get_apache_connections_numberc C s dS )z� Get current maximum request apache workers from httpd's config :return: tuple (max_req_num, message) max_req_num - Maximum request apache workers number or 0 if error message - OK/Trace )r r� r r r r r � get_apache_max_request_workers� s z3GeneralPanelPluginV1.get_apache_max_request_workers)�uidr� c C s$ y t | �jS tk r Y nX dS )zd Get "main" panel username by uid. :param uid: uid :return Username zN/A)r Zpw_name�KeyError)r� r r r �get_main_username_by_uid� s z-GeneralPanelPluginV1.get_main_username_by_uid)rl rw r� c C s dS )NrI r )rl rw r r r �get_user_emails_list� s z)GeneralPanelPluginV1.get_user_emails_listc C s dS )NrI r )rl r r r �panel_login_link s z%GeneralPanelPluginV1.panel_login_linkc C s: t j�t�r6ttd��} | �� }W dQ R X |r6t|�S dS )zB Get users count :return: number of users r2 Nr )r! r" �isfile�PANEL_USERS_COUNT_FILEr, �readrV )r0 �countr r r �get_hosting_accounts_count s z/GeneralPanelPluginV1.get_hosting_accounts_countc C s& t j�d�}t|t� tdd� g�S )Nz/usr/sbin/lvectlT)r� )r! r" r# �allr r )r Zis_binary_existsr r r �is_feature_lve_supported s z-GeneralPanelPluginV1.is_feature_lve_supportedc C s |S )zs 99% of control panels log-in user with same username as system user has, except for Plesk r )r rl r r r �get_customer_login s z'GeneralPanelPluginV1.get_customer_loginc C s t d��dS )zX Get ip of the server that is configured in control panel to be "main". zZUnable to detect main ip for this server. Contact CloudLinux support and report the issue.N)r )r r r r � get_server_ip s z"GeneralPanelPluginV1.get_server_ip)F)N)F)F)F)NF)Nrs T)N)N)7r � __module__� __qualname__r r � staticmethodr% r1 r< r= rG rP rY r_ rb rc rf ri rk rm r rn ro rp rq rr ru rv rx ry rz rW r| r} r~ r r� r� r� r� r rU �boolr� r� r� r� rV r� r� r� r� r� r� r� r r r r r 6 sn r )!Z __future__r r r r- r! rA rd �pwdr �typingr Zclcommon.constr r r r r Z clcommon.cpapi.cpapiexceptionsr r Zclcommon.lib.cleditionr r r r Z clcommon.lockr r r r� r4 r r r r r �<module> s"