File: //opt/alt/python37/lib/python3.7/site-packages/xray/adviser/__pycache__/cli_api.cpython-37.pyc
B
�*Ud
� � @ s� d Z ddlZddlZddlZddlZddlZddlZddlmZ ddl m
Z
m Z ddl m
Z
mZmZmZ ddlmZ ddlmZ ddlmZmZ dd lmZmZmZm Z m Z m Z m Z dd
l m!Z!m"Z"m#Z#m$Z$m%Z%m&Z& dd l'm(Z( dd l)m*Z* d
dl+m,Z, d
dl-m.Z. d
dl/m0Z0 d
dl1m2Z2m3Z3m4Z4 ddl5m6Z6 ddl7m8Z8m9Z9m:Z:m;Z; ddl<m=Z=m>Z>m?Z? ddl@mAZAmBZBmCZC ddlDmEZEmFZFmGZGmHZH dZIG dd� de�ZJe G dd � d ��ZKG d d � d �ZLdS ) zB
This module contains X Ray Smart Advice local utility main class
� N)�contextmanager)�asdict� dataclass)�Any�Tuple�Optional�List)�Enum)�LicenseApproveStatus)�Schema� SchemaError)�is_feature_visible�is_feature_allowed�is_subscription_pending� get_subscription_upgrade_url�get_license_approve_status�approve_license_agreement�get_license_agreement_text)�docroot�is_panel_feature_supported�get_user_emails_list�panel_login_link� getCPName� userdomains)�drop_privileges)�Feature� )�advice_mapping)�WPOSModuleApply)�SmartAdviceProgress)�advice_list_schema�detailed_advice_schema�user_sites_info_schema� )�
get_client)�advice_pending_storage�advice_processed_storage�advice_list_cache�advice_reason_max_len)� XRayAPIError� XRayError�SmartAdvicePluginError)� user_mode_advice_verification�username_verification�get_xray_exec_user)� timestamp� safe_move�get_user_php_version�filelock�;c @ s e Zd ZdZdZdS )�
AdviceActions�apply�rollbackN)�__name__�
__module__� __qualname__�APPLY�ROLLBACK� r< r< �E/opt/alt/python37/lib/python3.7/site-packages/xray/adviser/cli_api.pyr4 < s r4 c @ s6 e Zd ZU eed< eed< eed< eed< eed< dS )�SmartAdviceOptions�
panel_type� panel_url� panel_emails� upgrade_url�upgrade_url_cdnN)r7 r8 r9 �str�__annotations__r< r< r< r= r> @ s
r> c
@ s� e Zd ZdZdd� Zeedd�dd��Zeed�d d
��Zee ed �d d
��Z
e e e d �dd�Z ee ed �dd��Z
e ed�dd�Ze ed �dd�Zdd� Zeeed�dd��Zeeed �d d �Zee eeef d�d d ��Zeddeeedd"�d#d$��Z e e e d%�d&d'�Z e eeeeef d(�d)d*�Z deed�d+d,�Z e!ed�d-d.��Z"d/d0� Z#dfd1d2�Z$d3d4� Z%e ed�d5d6�Z&dge eeeeee e d8�d9d:�Z'dhee eeeeee e d;�d<d=�Z(ed�d>d?�Z)e ed�d@dA�Z*dBdC� Z+e!dDdE� �Z,didFdG�Z-djdHdI�Z.edJdK� �Z/dLdM� Z0edNdO� �Z1edPdQ� �Z2dRdS� Z3edTdU� �Z4dVdW� Z5dkdXdY�Z6e7e ee7e dZ�d[d\�Z8eee7e e7e d]�d^d_��Z9d`da� Z:dbdc� Z;dS )l�SmartAdviceUtilz%Main Smart Advice local utility classc C s< t �d�| _xttfD ]}| �|� qW td�}|� | _d S )NZ smart_advice�adviser)�loggingZ getLogger�loggerr% r& �
create_dirr$ �adviser_client)�selfZstorZadviser_client_objectr< r< r= �__init__K s
zSmartAdviceUtil.__init__N)�dpath�returnc C s t j�| �st �| � dS )zCreate dir if missingN)�os�path�isdir�mkdir)rN r< r< r= rJ T s zSmartAdviceUtil.create_dir)rO c K s0 dt � d�}| r|�| � t�tt|�� ���S )z�
Create JSON response message with result field == success
and given keyword arguments in other fields
:return: json packed string
�success)�resultr/ )r/ �update�json�dumps�dict�sorted�items)�kwargsZinitialr< r< r= �responseZ s
zSmartAdviceUtil.response)�a_idrO c C s t � d| � �S )z%Per-advice file with results of apply�/)r& )r^ r< r< r= �_apply_datafilef s z SmartAdviceUtil._apply_datafilec C s� | � |�}tj�|�r�zpy"t|��}t�|�}W dQ R X W nH tk
rR d}Y n2 tjk
r� t|��}|� � }W dQ R X Y nX W dt�
|� X |S dS )z=Retrieve data stored in per-advice file with results of applyN) r` rP rQ �isfile�openrW �load�OSError�JSONDecodeError�read�unlink)rL r^ Zdatafile�_f�datar< r< r= �_apply_resultsk s
z SmartAdviceUtil._apply_resultsc C s t � d| � �S )zPer-advice pending flagr_ )r% )r^ r< r< r= �
_pending_flag{ s z SmartAdviceUtil._pending_flag)� advice_idrO c C s t j�| �|��S )zIs advice in pending state)rP rQ �existsrk )rL rl r< r< r= �is_advice_pending� s z!SmartAdviceUtil.is_advice_pendingc C s | � |�d S )zPer-advice progress storagez .progress)rk )rL r^ r< r< r= �_progress_file� s z SmartAdviceUtil._progress_filec C s. yt |�S tk
r( | j�d� dS X d S )Nz#Error while getting user login link� )r � ExceptionrI � exception)rL �usernamer< r< r= �_get_user_login_link� s
z$SmartAdviceUtil._get_user_login_link)� advice_typerO c C s t | S )z>Get appropriate instance of Apply actions class by advice type)r )ru r< r< r= �get_advice_instance� s z#SmartAdviceUtil.get_advice_instance)ri �schemarO c
C sb y
|� |�S tk
r\ } z4| j�d|� |jd p<|jd }td|� ���W dd}~X Y nX dS )z&Validate given data using given schemaz#Failed to validate API response: %s���zMalformed API response: N)Zvalidater rI �error�errorsZautosr) )rL ri rw �e�msgr< r< r= � _validate� s
zSmartAdviceUtil._validatec C s, | j | j�|�td�}|| �|d d �fS )zu
Get advice details from API along with an
appropriate Advice object by obtained advice type
)ri rw �advice�type)r} rK �advice_detailsr! rv )rL rl Z _responser< r< r= �get_detailed_advice� s
z#SmartAdviceUtil.get_detailed_adviceF)�dstri �as_jsonrO c C sl | d }t |d��F}|rJyt�||� W qT tk
rF |�|� Y qTX n
|�|� W dQ R X t|| � dS )z8Dump data inside given dst using .bkp file and then movez.bkp�wN)rb rW �dump� TypeError�writer0 )r� ri r� Z_tmp_dstrh r< r< r= � dump_to_file� s z SmartAdviceUtil.dump_to_file)rl �currentrO c s t td�� ��fdd� �}|� S )a
Smart Advice apply own progress,
based on current and previous results of 'clwpos get-progress'.
Returns the maximum progress values among current and previous.
Previous (latest) is stored inside a pending file-flag.
)rO c
3 s� �j �d�� ��� �} y(t| ��}tf t�|��}W dQ R X W n@ ttjfk
r� } z �j �dt |�� t� }W dd}~X Y nX �j �d|� �|kr��n|V ��
� �rֈ|krֈj �d�� �j | t ��dd� dS )z}
Get progress stored in file and return the maximum one among
current and stored results
zCurrent progress value: %sNz%Error during reading stored value: %szStored progress value: %sz Updating stored progress: %sT)r� )
rI �debugro rb r rW rc rd re rD rn r� r )Z progress_dstZprevZ prev_stagesr{ )rl r� rL r< r= �resolve_progress� s
z2SmartAdviceUtil.progress.<locals>.resolve_progress)r r )rL rl r� r� r< )rl r� rL r= �progress� s zSmartAdviceUtil.progress)�_id�
advice_obj� advice_datarO c C sX | � |�r:d}| �||�|d d ���
}|}W dQ R X n|d d }t� }|t|�fS )z�
Resolve if advice is in pending status.
Progress is retrieved for pending advice only.
Dummy result (0, 0) is returned for other advice states.
�pending�metadatars Nr~ �status)rn r� Z get_progressr r )rL r� r� r� r� �p�stagesr< r< r= �get_current_status� s
z"SmartAdviceUtil.get_current_statusc C s` | j | j�� td�}| j||d�}y| j|d� W n tk
rR | j�d� Y nX | j |d�S )z9Load validated advice list and update it before returning)ri rw )�extended)�current_adviceszDUnable to sync cl-smart-advice plugin during getting list of advices)ri )
r} rK � advice_listr �prepare_advices_response� sync_advices_wordpress_pluginrq rI rr r] )rL r� � api_responseZresponse_advice_listr< r< r= r� � s zSmartAdviceUtil.advice_listc C s� | j | j�|�td�}i }xP|D ]H}|d }||kr<g ||< || �|d t|d �| �|d �d�� q W dd� |�� D �}| j|d �S )
N)ri rw �domain�websiteZurls�advices)r� Z urls_scannedr� c S s g | ]\}}||d ��qS ))r� �websitesr< )�.0r� r� r< r< r= �
<listcomp> s z5SmartAdviceUtil.get_site_statuses.<locals>.<listcomp>)ri ) r} rK Z site_infor" �append�lenr� r[ r] )rL rs r� Zsite_statuses_datar� r� rU r< r< r= �get_site_statuses� s
z!SmartAdviceUtil.get_site_statusesc C s2 yt �|� dS tk
r, t�d� dS X d S )NTzGUser %s does not exist anymore on this server, skipping advices for himF)�pwd�getpwnam�KeyErrorrH �info)rL rs r< r< r= �_does_user_exist_on_server s
z*SmartAdviceUtil._does_user_exist_on_serverc
C s4 |� � }g }�x |D �]}| �|d d �s.q|d }|d }| �|�} | j|d< |rj|d }
ddd�} n| �|d | |�\}
} |r�| j|d
< |
|d< | j|d < | j|d < t| j|d d �j |d
< |d �r| �
| j|d d �} t | t | j|d d �d�|d< |�
| � t| j|d d �r|�|� qW |S )Nr� rs r~ r � descriptionr� r )Z total_stagesZcompleted_stages�id�detailed_descriptionZ
is_premium� module_nameZlicense_status)r� rB � subscription)�copyr� rv �short_descriptionr� r� Zis_premium_featurer� r �name�_get_subscription_statusrY r rV r
r� )
rL Zfrom_api�status_from_microservicer� r� Zvisible_advices�item�
advice_itselfru �advice_instancer� r� �subscription_statusr< r< r= r� sB
z(SmartAdviceUtil.prepare_advices_responsec C s$ d}t ||�rd}t||�r d}|S )zQ
Determines current subscription status based on feature status.
ZnoZactiver� )r r )rL r� rs r� r< r< r= r� B s
z(SmartAdviceUtil._get_subscription_statusc C s@ | � |�\}}|d }|j|d< |j|d< |j|d< | j|d�S )z<Load validated advice details and update it before returningr~ r� r� Z
fix_action)ri )r� r� r� Zapply_button_textr] )rL rl r� r� r� r< r< r= r� M s
z SmartAdviceUtil.advice_details�
ACCELERATE_WP)rl �
ignore_errors�
async_mode�source�reason� accept_termsrO c C sD t | �|�d��� |r.t�� }|r.| �|�S | �|||||||�S )Nr� )rb rk �closerP �fork�manage_advice_status�_exec_advice_managing) rL �actionrl r� r� r� r� r� Zchildr< r< r= �
manage_adviceY s
z SmartAdviceUtil.manage_advice)r� rl r� r� r� r� r� rO c C s� �z�| � |�\}} |tjjkr�|r6t| j|d d � t| j|d d �tjkr`t �
ddd��S | j f |d d|i��\}
} |
r�| j �
d� | jj|d|d � y*| �|d d |d d
|d d � W n tk
r� | j �d � Y nX n�|tjjk�r�| jf |d �\}
} |
�r�| j �
d
� |�rD| jj|d||dt� d� n| jj|d|d � y*| �|d d |d d
|d d � W n" tk
�r� | j �d� Y nX ntd|� ���W dt�| �|�� X |�r�| �| �|�| � n| S dS )z:Execute managing advice with passed action: apply/rollbackr� rs Z LICENCE_TERMS_APPROVE_REQUIREDz�License approve required to use this feature. Open AccelerateWP plugin in your control panel, apply advice and accept terms and conditions to proceed with installation.)rU �textr� zApplied successfully�applied)rl r� r� r� r� z:Error while syncing cl-smart-advice plugin on advice applyzRollback successfullyZreviewN)rl r� r� r� z=Error while syncing cl-smart-advice plugin on advice rollbackz/Unsupported action with advice, passed action: ) r� r4 r: �valuer r� r r
Z NOT_APPROVEDrW rX r5 rI r� rK Z
update_advice� _sync_advicerq rr r; r6 r( �
ValueErrorrP rg rk r� r` ) rL r� rl r� r� r� r� r� r� r� Z
action_result�outputr< r< r= r� h sb
z%SmartAdviceUtil._exec_advice_managingc C sh y| j | j�� td�}W n$ tk
r< t�ddgd�}Y n X tt|�tdd� |D ��d�}| j|d�S ) z#Return advice counters for a server)ri rw �totalr� Nc S s g | ]}|d d dkr|�qS )r~ r� r� r< )r� r~ r< r< r= r� � s z3SmartAdviceUtil.advice_counters.<locals>.<listcomp>)r� r� )ri ) r} rK r� r r* rY �fromkeysr� r] )rL r� rU r< r< r= �advice_counters� s z SmartAdviceUtil.advice_countersc C s� | � |�\}}| �|||�\}}| �|j|d d �}|dkr�| �|�}| �|�}tj�|�rht� |� |r�| j
f |t |d�t |j|d d �d�|d|i��S | j
f |t |d�t |j|d d �d�|��S )zS
Return current status and progress of managing particular advice.
r� rs r� )� object_cache)r� r� rB ri )
r� r� r� r� rj ro rP rQ ra rg r] rY r ) rL rl r� r� r� r� r� rU Z _progressr< r< r= r� � s8
z$SmartAdviceUtil.manage_advice_statusc
C s� | j | j�� td�}| �|�}y | �|||| j|ddd�� W n& tk
rd | j� dt
|�� d S X | � � }|� t � |� t � |� �}||kr�i ||< || ||< | �
|� d S )N)ri rw T)r� r� z/Smart Advice plugin sync failed for website: %s)r} rK r� r �!group_alive_advice_ids_by_website�_run_smart_advice_scriptr� rq rI rr rD �_read_advices_cache�advice_cache_separator�_update_advices_cache)rL rs r� r� r� �current_advices_by_site�cached_advices_by_site�keyr< r< r= r� � s
z SmartAdviceUtil._sync_advicec C sv y t |�d d }t||�}W n$ tk
rB | j�d� d}Y nX | jf ttt� | � |�|t
d|�t
d|�d���S )a'
gets options:
"panel_type": "cpanel",
"panel_url": "https:/cpanel-foo.com/", # or https://plesk-bar.com/
"panel_emails": "root@hosting.com,manager@hostring.com,foo@bar.com",
"upgrade_url": "https://...",
"upgrade_url_cdn": "https://...",
r zUnable to get user emailsrp r� Zcdn)r? r@ rA rB rC ) r r rq rI rr r] r r> r rt r )rL rs r� �emailr< r< r= � get_options� s
zSmartAdviceUtil.get_optionsc C sj |s| j | j�� td�}| �|�}|s2| jdd�S | �� }| j||| j|dd�d�}| � |� | jdd�S )N)ri rw z No advices found on the server)ri T)r� )�current_advices_jsonzPlugin installed)
r} rK r� r r� r] r� �_sync_sa_pluginr� r� )rL r� r� r� Z
updated_cacher< r< r= r� s
z-SmartAdviceUtil.sync_advices_wordpress_pluginc
s� d }i }x�|� � D ]�\}}|�t�\}� } | �||�|��sF|||< q|r\� fdd�|D �}y| �� | ||� W n( tk
r� | j�dt | �� wY nX |||< qW |S )Nc s& g | ] }|� d i �� d�� kr|�qS )r� rs )�get)r� r~ )rs r< r= r� 2 s z3SmartAdviceUtil._sync_sa_plugin.<locals>.<listcomp>z/Smart advice plugin sync failed for website: %s)
r[ �splitr� �_should_sync_websiter� r� rq rI rr rD )
rL r� Zcached_advicesr� Zfiltered_advices_by_userZupdated_advicesr� Zid_status_hashr� r� r< )rs r= r� ' s z SmartAdviceUtil._sync_sa_pluginc C sZ t t� d�d��@}t|��, t td��}tj| |dd� W d Q R X W d Q R X W d Q R X d S )Nz.lockza+r� r# )Zindent)rb r' r2 rW r� )Znew_cached_advicesZlock_fd�fr< r< r= r� > s
z%SmartAdviceUtil._update_advices_cachec C s\ i }t j�t�rXy"tt��}t�|�}W d Q R X W n$ tk
rV | j� d� i }Y nX |S )Nz!Unable to read advices cache json)
rP rQ rm r' rb rW rc rq rI rr )rL r� r� r< r< r= r� E s
z#SmartAdviceUtil._read_advices_cachec C s | |kS )Nr< )Z current_hashZ cached_hashr< r< r= r� P s z$SmartAdviceUtil._should_sync_websitec C sB t �� }x0| D ](\}}|�t|��� � |�|�� � qW |�� S )N)�hashlibZmd5rV rD �encodeZ hexdigest)�id_status_pairs�hrl r� r< r< r= � make_hashT s
zSmartAdviceUtil.make_hashc s� i }xj|D ]b}|d }|d }|d � t � |d � t � |d � �}||krRg ||< || �|d |d f� q
W � fdd �|�� D �S )
Nr� r~ r� rs r� r� r� c s, i | ]$\}}� � tt|d d� d���|�qS )c S s | d S )Nr r< )r� r< r< r= �<lambda>h � zNSmartAdviceUtil.group_alive_advice_ids_by_website.<locals>.<dictcomp>.<lambda>)r� )r� �tuplerZ )r� r� r� )rL r< r= �
<dictcomp>g s zESmartAdviceUtil.group_alive_advice_ids_by_website.<locals>.<dictcomp>)r� r� r[ )rL r� r� r~ r� r� r� r< )rL r= r� \ s
$
z1SmartAdviceUtil.group_alive_advice_ids_by_websitec C s$ t | d��}|�|� W dQ R X dS )z"
For easy mocking
r� N)rb r� )rQ Zcontentr� r< r< r= �_save_custom_phpl s z SmartAdviceUtil._save_custom_phpc
C s0 t �|�j� d�}d}tj�||�}d}d }tj�|�r<d S tjd|� d�dddd�}| j �
dt |j �� |j r�||j kr�|j �
� � d |� �}n|j s�||j kr�d
|� �}|�r,| j �
d ||� t|��, tj�|�s�tj|d d
� | �||� W d Q R X tjdddd|d|gddd�} | j �
dt | j �� d S )Nz/.clwposz.php-iniz/opt/alt/php-xray/z-/usr/sbin/plesk bin site --show-php-settings z | /usr/bin/grep open_basedirT)r� �capture_output�shellz!Current open_basedir settings: %s�:zopen_basedir = z/Updated open_basedir setting: %s for domain: %si� )�modez/usr/sbin/plesk�binZsitez--update-php-settingsz -settings)r� r� z Plesk settings update result: %s)r� r� �pw_dirrP rQ �joinrm �
subprocess�runrI r� rD �stdout�stripr rR rS r� )
rL rs r� Z
clwpos_dirZ
custom_phpZcustom_php_fullZsa_lineZupdated_settingZopen_basedir_settingrU r< r< r= �_prepare_php_for_pleskt s0
z&SmartAdviceUtil._prepare_php_for_pleskc C s� |d kr| j g d�}n | j |d�}| �||||�}| �||�}tj|ddd�}|jdkr�| j�dt|j�t|j �t|j
�� t d��d S )N)ri T)r� r� r zESmart advice plugin failed with exit code: %s, stdout: %s, stderr: %sz'Smart Advice plugin installation failed) r] �!_prepare_smart_advice_script_args� _get_smart_advice_script_cmdr� r� �
returncoderI ry rD r� �stderrr+ ) rL rs r� r� � advices_jsonZ json_string�attrs�commandrU r< r< r= r� � s
z(SmartAdviceUtil._run_smart_advice_script)r� r� rO c C sB d}d|� �}| � |�}t� }|� d|� �} | j�d| � yt||�}
W n$ tk
rl | j�d� d}
Y nX t|�d | } t|�} xH| D ] }
|
� d�|kr�|
� d �}P q�W | j�
d
|t | �� t d |� ���|s�| j�
d |� t d
|� ���|dk�r.y| �
||� W n" tk
�r, | j�d� Y nX ||| ||
| g}|S )Nzrun.shz*/opt/alt/php-xray/php/smart-advice-plugin/�|zPANEL LOGIN LINK %szUnable to get user emailsrp r ZvhostZ
php_binaryz*Php data for domain %s was not found in %sz%Unable to get php version for domain z)Php version for user: %s was not obtainedz)Php binary was not identified for domain ZPleskz-Setting up php for Plesk for SA plugin failed)rt r rI r� r rq rr r r1 r� ry rD r+ r� )rL rs r� r� r� Z script_nameZ script_pathZuser_login_linkZpanelZpanel_user_login_linkr� Zfull_website_pathZphp_infoZphp_dataZphp_binary_path�resr< r< r= r� � sF
z1SmartAdviceUtil._prepare_smart_advice_script_args)rs r� rO c C sX t tj�r d| dg}|�|� n4d|d d |d< dd�|� }dd| d dd
|g}|S ) Nz/sbin/cagefs_enter_userz /bin/bash�'� z
/bin/bash � Zsudoz-uz-sz-c)r r ZCAGEFS�extendr� )rs r� r� Z command_strr< r< r= r� � s
z,SmartAdviceUtil._get_smart_advice_script_cmdc C s, t � }|std��t�dt� t||�d��S )z;
Method with handles work with agreements.
z)This command can only be executed as userrT )rU r/ r� )r. r+ rW rX r/ r )rL �feature� user_contextr< r< r= �get_agreement_text� s z"SmartAdviceUtil.get_agreement_textc
C s� t � }|std��| �|�\}}tjddt|�dddt|�d|jg ddd �}|jd
kr�| j� d t|j�t|j
�t|j �� td |j ��d
S )z�
Proxy method to AWP which creates subscription
listening for the status of module and automatic advice appy.
z)This command can only be executed as userzcloudlinux-awp-userz--userr� z--listenz --advice-idz --featureT)r� r� r zESmart advice plugin failed with exit code: %s, stdout: %s, stderr: %sz"cloudlinux-awp-user call failed %sN) r. r+ r� r� r� rD r� r� rI ry r� r� )rL rl r �_r� rU r< r< r= �create_subscription� s$
z#SmartAdviceUtil.create_subscription)F)F)FF)FFr� NF)FFr� NF)N)N)N)<r7 r8 r9 �__doc__rM � staticmethodrD rJ r] �intr` r rj rk �boolrn ro rt r rv r r r} r, r rY �objectr� r� r r� r� r� r- r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r� r� r r r< r< r< r= rF H sp
%
.
"F*
/
rF )Mr rW rH rP r� r� r� Z
contextlibr Z dataclassesr r Ztypingr r r r Zenumr Zclwpos.user.configr
rw r r Z clwpos.papir
r r r r r r Zclcommon.cpapir r r r r r Zclcommon.clpwdr Zclcommon.constr Z advice_typesr Zadvice_types.wpos_baser r� r Zschemasr r! r" Z apiclientr$ Zinternal.constantsr% r& r' r( Zinternal.exceptionsr) r* r+ Zinternal.user_plugin_utilsr, r- r. Zinternal.utilsr/ r0 r1 r2 r� r4 r> rF r< r< r< r= �<module>
s: $