Your IP : 216.73.216.52
U
8�-d� � @ s� d dl Z d dlZd dlZd dlZd dlmZ d dlmZmZmZm Z m
Z
m Z m Z d dl
mZmZmZmZmZmZ d dlmZ d dlmZmZmZmZmZm Z m Z m Z d dl m Z m!Z! d dl"m#Z# d d l$m%Z% e�&� Z'G d
d � d �Z(G d d
� d
e j)d�Z*dS )� N)�datetime)�Any�Dict�List�Optional�Tuple�Type�Union)�config�contract� event_logger�messages�system�util)�DEFAULT_HELP_FILE)�ApplicabilityStatus�ApplicationStatus�CanDisableFailure�CanDisableFailureReason�CanEnableFailure�CanEnableFailureReason�ContractStatus�UserFacingStatus)�MessagingOperationsDict�StaticAffordance)�is_config_value_true)� safe_loadc @ s" e Zd Zed ejd�dd�ZdS )�IncompatibleService�
UAEntitlement�� entitlement� named_msgc C s || _ || _d S �Nr )�selfr r! � r$ �</usr/lib/python3/dist-packages/uaclient/entitlements/base.py�__init__ s z IncompatibleService.__init__N)�__name__�
__module__� __qualname__r r
� NamedMessager& r$ r$ r$ r% r s �r c @ s� e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ dZ
dZeejed�dd���Zeee d�dd ��Zeejed�d
d ���Zeejed�d d
���Zeed�dd��Zeed�dd��Zeeedf d�dd��Z eee df d�dd��Z eee d df d�dd��Z eee d df d�dd��Z!ee"d�dd ��Z#dWe$e%j& e'e'ee'dd �d d �Z(ed!d"� �Z)ee'e$e* f d�d#d$�Z+dXe'ee'e,de*f f d%�d&d'�Z-ejdYe'e'd%�d(d)��Z.e'd�d*d+�Z/d,d-� Z0ee d�d.d/�Z1e'd�d0d1�Z2ee'e$e3j4 f d�d2d3�Z5ee'e$e3j4 f d�d4d5�Z6dZe'ee'e$e7 f d6�d7d8�Z8d[e'ee'e$e7 f d%�d9d:�Z9ejd\e'e'd%�d;d<��Z:e'ee'e$e3j4 f d%�d=d>�Z;e'd�d?d@�Z<d]ee'ddA�dBdC�Z=ee>e$e3j4 f d�dDdE�Z?e@d�dFdG�ZAeeBe$e3j4 f d�dHdI�ZCejeeDe$e3j4 f d�dJdK��ZEee'e$e3j4 f d�dLdM�ZFe$e d�dNdO�ZGe'd�dPdQ�ZHeDd�dRdS�ZId^eJeeKf eJeeKf e'e'dT�dUdV�ZLdS )_r NFr$ T)�returnc C s dS )z&The lowercase name of this entitlementNr$ �r# r$ r$ r% �nameD s zUAEntitlement.namec C s$ | j g}| j| j kr |�| j� |S )z1The list of names this entitlement may be called.)r- �presentation_name�append)r# � valid_namesr$ r$ r% r0 J s zUAEntitlement.valid_namesc C s dS )z,The human readable title of this entitlementNr$ r, r$ r$ r% �titleR s zUAEntitlement.titlec C s dS )z&A sentence describing this entitlementNr$ r, r$ r$ r% � descriptionX s zUAEntitlement.descriptionc C sB | j jjr8| j jj�| ji ��di ��di ��d| j�S | jS dS )z/The user-facing name shown for this entitlementr � affordancesZ presentedAsN)�cfg�machine_token_fileZ
is_present� entitlements�getr- r, r$ r$ r% r. ^ s
� � ��z UAEntitlement.presentation_namec C sV | j dkrPi }tj�t�r8ttd��}t|�}W 5 Q R X |�| ji ��dd�| _ | j S )z$Help information for the entitlementN�r�help� ) �
_help_info�os�path�existsr �openr r7 r- )r# Z help_dict�fr$ r$ r% � help_infok s
zUAEntitlement.help_info.c C s dS )Nr$ r$ r, r$ r$ r% �static_affordances| s z UAEntitlement.static_affordancesc C s | j S )a
Return a list of packages that aren't compatible with the entitlement.
When we are enabling the entitlement we can directly ask the user
if those entitlements can be disabled before proceding.
Overridden in livepatch and fips
)�_incompatible_servicesr, r$ r$ r% �incompatible_services� s z#UAEntitlement.incompatible_servicesc C s | j S )a
Return a list of packages that must be active before enabling this
service. When we are enabling the entitlement we can directly ask
the user if those entitlements can be enabled before proceding.
Overridden in ros and ros-updates.
)�_required_servicesr, r$ r$ r% �required_services� s z UAEntitlement.required_servicesc C s | j S )a
Return a list of packages that depend on this service.
We will use that list during disable operations, where
a disable operation will also disable all of the services
required by the original service
Overriden in esm-apps and esm-infra
)�_dependent_servicesr, r$ r$ r% �dependent_services� s z UAEntitlement.dependent_servicesc C s i S r" r$ r, r$ r$ r% � messaging� s zUAEntitlement.messagingr: )r4 �
assume_yes�
allow_beta� called_name� access_onlyr+ c C s4 |s t �� }|| _|| _|| _|| _|| _d| _dS )z]Setup UAEntitlement instance
@param config: Parsed configuration dictionary
N)r
�UAConfigr4 rJ rK rM Z _called_name�_valid_service)r# r4 rJ rK rL rM r$ r$ r% r& � s zUAEntitlement.__init__c C s. | j dkr(| j p$| jp$t| jjd�| _ | j S )z2Check if the service is marked as valid (non-beta)Nzfeatures.allow_beta)rO �is_betarK r r4 r, r$ r$ r% �
valid_service� s
� �zUAEntitlement.valid_servicec C s& | � � r"t�d| j� t�| j� | �� tj ksNdt
t j t
jj| jd�d�fS | �� \}}|tjkr�dt
t jt
jj| jd�d�fS | js�dt
t j�fS | �� \}}|tjkr�dt
t j|d�fS | jr�| �� r�dt
t j �fS | j r�| � � s�dt
t j �fS | j �s"| j!�r"dt
t j"t
j#j| jd��fS dS )z�
Report whether or not enabling is possible for the entitlement.
:return:
(True, None) if can enable
(False, CanEnableFailure) if can't enable
z(Updating contract on service '%s' expiryF�r1 ��message�TN)$�is_access_expired�logging�debugr- r Zrequest_updated_contractr4 �contract_statusr �ENTITLEDr r Z NOT_ENTITLEDr
�
UNENTITLED�formatr1 �application_statusr �DISABLEDZALREADY_ENABLEDrQ ZIS_BETA�applicability_statusr � INAPPLICABLErD � detect_incompatible_services�INCOMPATIBLE_SERVICErF � check_required_services_active�INACTIVE_REQUIRED_SERVICES�supports_access_onlyrM ZACCESS_ONLY_NOT_SUPPORTEDZ ENABLE_ACCESS_ONLY_NOT_SUPPORTED)r# r] �_r_ �detailsr$ r$ r% �
can_enable� sn � ��
��
���������
zUAEntitlement.can_enable)�silentr+ c C s� | j �dg �}t�|�s dS | �� \}}|s�|dkr8dS |jtjkrd| �� \}}|s�||_ d|fS n4|jtj
kr�| � � \}}|s�||_ d|fS nd|fS | j �dg �}t�|�s�dS | j |d�}|s�dS | j �dg �}t�|�s�dS dS ) aN Enable specific entitlement.
@return: tuple of (success, optional reason)
(True, None) on success.
(False, reason) otherwise. reason is only non-None if it is a
populated CanEnableFailure reason. This may expand to
include other types of reasons in the future.
Zpre_can_enable�FNNFZ
pre_enable�ri Z post_enablerU )
rI r7 r �handle_message_operationsrh �reasonr rb � handle_incompatible_servicesrT rd �_enable_required_services�_perform_enable) r# ri �msg_opsrh �failZ incompat_ret�errorZreq_ret�retr$ r$ r% �enable s>
��
zUAEntitlement.enablec C s dS )a
Enable specific entitlement. This should be implemented by subclasses.
This method does the actual enablement, and does not check can_enable
or handle pre_enable or post_enable messaging.
@return: True on success, False otherwise.
Nr$ �r# ri r$ r$ r% rp L s z UAEntitlement._perform_enablec C s2 | j D ]&}|| j��� \}}|tjkr dS qdS )z�
Check for depedent services.
:return:
True if there are dependent services enabled
False if there are no dependent services enabled
TF)rH r4 r] r �ENABLED)r# �dependent_service_cls�
ent_statusrf r$ r$ r% �detect_dependent_servicesW s
�
z'UAEntitlement.detect_dependent_servicesc C s2 | j D ]&}|| j��� \}}|tjkr dS qdS )z�
Check if all required services are active
:return:
True if all required services are active
False is at least one of the required services is disabled
FT)rF r4 r] r rw )r# �required_service_clsry rf r$ r$ r% rc h s
z,UAEntitlement.check_required_services_activec C s< g }| j D ],}|�| j��� \}}|tjkr
|�|� q
|S )zI
:return: List of incompatible services that are enabled
)rD r r4 r] r rw r/ )r# rt �servicery rf r$ r$ r% � blocking_incompatible_servicesw s
z,UAEntitlement.blocking_incompatible_servicesc C s t | �� �dkS )z�
Check for incompatible services.
:return:
True if there are incompatible services enabled
False if there are no incompatible services enabled
r )�lenr} r, r$ r$ r% ra � s z*UAEntitlement.detect_incompatible_servicesc C s� t j| jjdd�}| �� D ]�}|j| jdd�}tjj| j|jd�}tj j| j|jd�}|rfd|f S t j
|| j d�s�d|f S d�|j�}t �
|� |jdd �}|s|d
f S qd S ) a)
Prompt user when incompatible services are found during enable.
When enabling a service, we may find that there is an incompatible
service already enable. In that situation, we can ask the user
if the incompatible service should be disabled before proceeding.
There are also different ways to configure that behavior:
We can disable removing incompatible service during enable by
adding the following lines into uaclient.conf:
features:
block_disable_on_enable: true
z features.block_disable_on_enable)r
Z
path_to_valueT)rJ )�service_being_enabledZincompatible_serviceF��msgrJ z"Disabling incompatible service: {}rk NrU )r r r4 r} r r
rb r\ r1 Z!INCOMPATIBLE_SERVICE_STOPS_ENABLE�prompt_for_confirmationrJ �event�info�disable)r# Zcfg_block_disable_on_enabler| �ent�user_msg�e_msgZ disable_msgrt r$ r$ r% rn � s: � �� � �
z*UAEntitlement.handle_incompatible_servicesc
C s� | j D ]�}|| jdd�}|�� d tjk}|rtjj| j|jd�}tj j| j|jd�}t
j || j d�srd|f S t
�d�|j�� |jdd�\}}|sd }|r�|jr�|jjr�d
|jj }tjj||jd �} || f S qd S )
a,
Prompt user when required services are found during enable.
When enabling a service, we may find that there are required services
that must be enabled first. In that situation, we can ask the user
if the required service should be enabled before proceeding.
T)rK r )r �required_servicer� Fz Enabling required service: {}rk r: �
)rs r| rU )rF r4 r] r r^ r
ZREQUIRED_SERVICEr\ r1 Z REQUIRED_SERVICE_STOPS_ENABLEr r� rJ r� r� ru rT r� Z ERROR_ENABLING_REQUIRED_SERVICE)
r# r{ r� Zis_service_disabledr� r� rt rr � error_msgr� r$ r$ r% ro � s<
��� � �z'UAEntitlement._enable_required_services)�ignore_dependent_servicesr+ c C sX | � � \}}|tjkr4dttjtjj| jd�d�fS | j rT|sT| �
� rTdttj �fS dS )z�Report whether or not disabling is possible for the entitlement.
:return:
(True, None) if can disable
(False, CanDisableFailure) if can't disable
FrR rS rU ) r] r r^ r r ZALREADY_DISABLEDr
r\ r1 rH rz �ACTIVE_DEPENDENT_SERVICES)r# r� r] rf r$ r$ r% � can_disable� s
��
��zUAEntitlement.can_disablec C s� | j �dg �}t�|�s dS | �� \}}|sp|dkr8dS |jtjkrh| j|d�\}}|sp||_ d|fS nd|fS | j
|d�s�dS | j �dg �}t�|�s�dS | j d|d� d S )
a� Disable specific entitlement
@param silent: Boolean set True to silence print/log of messages
@return: tuple of (success, optional reason)
(True, None) on success.
(False, reason) otherwise. reason is only non-None if it is a
populated CanDisableFailure reason. This may expand to
include other types of reasons in the future.
Z pre_disablerj Nrk FZ post_disablezdisable operation)� operationri rU ) rI r7 r rl r� rm r r� �_disable_dependent_servicesrT �_perform_disable�_check_for_reboot_msg)r# ri rq r� rr rt r� r$ r$ r% r� s4
��
�zUAEntitlement.disablec C s dS )a\
Disable specific entitlement. This should be implemented by subclasses.
This method does the actual disable, and does not check can_disable
or handle pre_disable or post_disable messaging.
@param silent: Boolean set True to silence print/log of messages
@return: True on success, False otherwise.
Nr$ rv r$ r$ r% r� > s z UAEntitlement._perform_disablec C s� | j D ]�}|| jdd�}|�� d tjk}|rtjj|j| jd�}tj j| j|jd�}t
j || j d�srd|f S |s�t
�tjj|jd�� |jdd �\}}|sd
} |r�|jr�|jjr�d |jj } tjj| |jd �}
d|
f S qd
S )ay
Disable dependent services
When performing a disable operation, we might have
other services that depend on the original services.
If that is true, we will alert the user about this
and prompt for confirmation to disable these services
as well.
@param silent: Boolean set True to silence print/log of messages
T)r4 rJ r )�dependent_service�service_being_disabled)r� r� r� F)r� rk r: r� )rs r� rU )rH r4 r] r rw r
ZDEPENDENT_SERVICEr\ r1 Z DEPENDENT_SERVICE_STOPS_DISABLEr r� rJ r� r� ZDISABLING_DEPENDENT_SERVICEr� rT r� Z"FAILED_DISABLING_DEPENDENT_SERVICE) r# ri rx r� Zis_service_enabledr� r� rt rr r� r� r$ r$ r% r� K sF
��� � �� �z)UAEntitlement._disable_dependent_servicesc C s t �� S )z%Check if system needs to be rebooted.)r Z
should_rebootr, r$ r$ r% �_check_for_reboot� s z UAEntitlement._check_for_reboot)r� ri r+ c C s$ | � � r |s t�tjj|d�� dS )z�Check if user should be alerted that a reboot must be performed.
@param operation: The operation being executed.
@param silent: Boolean set True to silence print/log of messages
)r� N)r� r� r� r
ZENABLE_REBOOT_REQUIRED_TMPLr\ )r# r� ri r$ r$ r% r� � s ��z#UAEntitlement._check_for_reboot_msgc C s( | j jj�| j�}|s"tjtjfS | j D ]"\}}}|� |kr(tj
|f S q(|d �di �}t � � }|�dd�}| j
r�|dk r�|d |kr�t�|�}tj
tjj| j|d d�|�d�fS |�dd�} | jr�| dk r�|d | kr�tj
tjj| j|d d
�fS t �� }
|�d d�} |�d d�} | j�rZ| dk �rZ|
j| k�rZtj
tjj| j|
jd�| �d
�fS | j�r | �r |
j dk �r |
j dk �r tj j| j|
j| d�}
z"| � d�\}}t |�}t |�}W n, t!k
�r� t"�#d| � tj
|
f Y S X |
j |k �r�tj
|
fS |
j |k�r |
j |k �r tj
|
fS tjdfS )a� Check all contract affordances to vet current platform
Affordances are a list of support constraints for the entitlement.
Examples include a list of supported series, architectures for kernel
revisions.
:return:
tuple of (ApplicabilityStatus, NamedMessage). APPLICABLE if
platform passes all defined affordances, INAPPLICABLE if it doesn't
meet all of the provided constraints.
r r3 Z
architecturesN�archz, )r1 r� Zsupported_arches�series�version)r1 r� Z
kernelFlavorsZminKernelVersion)r1 �kernelZsupported_kernels)r1 r� Z
min_kernel�.z$Could not parse minKernelVersion: %s)$r4 r5 r6 r7 r- r �
APPLICABLEr
Z"NO_ENTITLEMENT_AFFORDANCES_CHECKEDrB r` r Zget_platform_info�affordance_check_archr Zdeduplicate_archesZINAPPLICABLE_ARCHr\ r1 �join�affordance_check_seriesZINAPPLICABLE_SERIESZget_kernel_info� affordance_check_kernel_flavorZflavorZINAPPLICABLE_KERNELZ
uname_release�#affordance_check_kernel_min_version�major�minorZINAPPLICABLE_KERNEL_VER�split�int�
ValueErrorrW �warning)r# �entitlement_cfgZ
error_messageZfunctorZexpected_resultr3 �platformZaffordance_archesZdeduplicated_archesZaffordance_seriesZ kernel_infoZaffordance_kernelsZaffordance_min_kernelZ invalid_msgZ kernel_majorZ kernel_minorZmin_kern_majorZmin_kern_minorr$ r$ r% r_ � s�
��
��
�
�� ��
� �� �� �� ����� �
��
z"UAEntitlement.applicability_statusc C s@ | j jstjS | j jj�| ji �}|r:|d �d�r:tjS tjS )z=Return whether the user is entitled to the entitlement or notr �entitled) r4 Z is_attachedr r[ r5 r6 r7 r- rZ )r# r� r$ r$ r% rY � s
�z UAEntitlement.contract_statusc C s� | � � \}}|tjkr tj|fS | jjj�| j �}|sLtj
t j j
| jd�fS |d �dd�dkrvtj
t j j
| jd�fS | �� \}}|tjkr�tj|fS | �� \}}|r�tj|fS tj|fS )z4Return (user-facing status, details) for entitlementrR r r� F)r_ r r� r r` r4 r5 r6 r7 r- Z UNAVAILABLEr
ZSERVICE_NOT_ENTITLEDr\ r1 r] r r^ ZINACTIVE�enabled_warning_statusZWARNINGZACTIVE)r# Z
applicabilityrg r� r] Z explanationr� Zwarn_msgr$ r$ r% �user_facing_status s*
���
z UAEntitlement.user_facing_statusc C s dS )z�
The current status of application of this entitlement
:return:
A tuple of (ApplicationStatus, human-friendly reason)
Nr$ r, r$ r$ r% r] ( s
z UAEntitlement.application_statusc C s dS )z�
If the entitlment is enabled, are there any warnings?
The message is displayed as a Warning Notice in status output
:return:
A tuple of (warning bool, human-friendly reason)
rj r$ r, r$ r$ r% r� 4 s
z$UAEntitlement.enabled_warning_statusc C s d S r" r$ r, r$ r$ r% �status_description_override@ s z)UAEntitlement.status_description_overridec C sF | j jj�| ji �}|�d�}|s&dS t�|d�}|t�� krBdS dS )z<Return entitlement access info as stale and needing refresh.ZexpiresFz%Y-%m-%dT%H:%M:%S.%fZT)r4 r5 r6 r7 r- r �strptimeZutcnow)r# Zentitlement_contractZ
expire_strZexpiryr$ r$ r% rV E s
�
z UAEntitlement.is_access_expiredc C sl | j �d�}|dkrtjS |�dg �}|D ]:}|�d�| jkr*|�d�}|dkrZtj S tj S q*tjS )z6Check on the state of application on the status cache.� status-cacheN�servicesr- Zstatus�enabled)r4 �
read_cacher r^ r7 r- rw )r# � status_cacheZservices_status_listr| Zservice_statusr$ r$ r% �"_check_application_status_on_cacheS s
z0UAEntitlement._check_application_status_on_cache)� orig_access�deltas� allow_enabler+ c C s� |sdS |� di �}|� di �}| j�d�}t|tjk�}|sr|rTt�|� |d }|rrd|krr|d dtjfk}|r�|r�|r�| �� }n | � � \}} |t
j kr�| � � r�| �
� t�d| j� nt�d| j� | j�d �| j�� dS |� d
�}
|
s�|� d
�}
|� d i �} t| � d ��o|
�} | �r(d| _| �� \}
} |
�r�| �r�|�rptjj| jd
�}tj|tjd� | �� n tj j| jd
�}tj|tjd� dS dS )av Process any contract access deltas for this entitlement.
:param orig_access: Dictionary containing the original
resourceEntitlement access details.
:param deltas: Dictionary which contains only the changed access keys
and values.
:param allow_enable: Boolean set True if allowed to perform the enable
operation. When False, a message will be logged to inform the user
about the recommended enabled service.
:return: True when delta operations are processed; False when noop.
:raise: UserFacingError when auto-enable fails unexpectedly.
Tr Z
directivesr� r� Fz.Due to contract refresh, '%s' is now disabled.zhUnable to disable '%s' as recommended during contract refresh. Service is still active. See `pro status`zmachine-access-{}�
resourceTokenZ obligationsZenableByDefault)r- )Z file_type) r7 r4 r� �boolr Z DROPPED_KEYr Zapply_contract_overridesr� r] r r^ r� r� rW r� r- r� Zdelete_cache_keyr\ rK rh r
ZENABLE_BY_DEFAULT_TMPLr� �sys�stderrru Z ENABLE_BY_DEFAULT_MANUAL_TMPL)r# r� r� r� Zdelta_entitlementZdelta_directivesr� Ztransition_to_unentitledr] rf r� Zdelta_obligationsZenable_by_defaultrh r� r$ r$ r% �process_contract_deltasg sj
�
��
�
�z%UAEntitlement.process_contract_deltas)NFFr: F)F)F)F)F)F)F)F)Mr' r( r) Z help_doc_urlrJ rP re r; rC rE rG r� r� r� r� �property�abc�abstractmethod�strr- r r0 r1 r2 r. rA r r rB r rD r rF rH r rI r r
rN r� r& rQ r rh r ru rp rz rc r} ra r
r* rn ro r r� r� r� r� r� r� r r_ r rY r r� r r] r� r� rV r� r r r� r$ r$ r$ r% r % s� ��
Q �� 7
� 7� 0 �� �� .
� 9 � � � e
� !�
� � �
�r )� metaclass)+r� rW r< r� r �typingr r r r r r r Zuaclientr
r r r
r r Zuaclient.defaultsr Z(uaclient.entitlements.entitlement_statusr r r r r r r r Zuaclient.typesr r Z
uaclient.utilr Z
uaclient.yamlr Zget_event_loggerr� r �ABCMetar r$ r$ r$ r% �<module> s $ (