o K&b@sddlZddlZddlZddlZddlZddlmZddlmZmZm Z m Z m Z m Z m Z ddlZddlmZmZmZmZmZmZmZddlmZddlmZmZmZmZmZmZm Z ddl!m"Z"m#Z#ddl$m%Z%d Z&e'Z(Gd d d Z)Gd d d ej*dZ+dS)N)datetime)AnyDictListOptionalTupleTypeUnion)configcontract event_logger exceptionsmessagesstatusutil)DEFAULT_HELP_FILE)ApplicabilityStatusCanDisableFailureCanDisableFailureReasonCanEnableFailureCanEnableFailureReasonContractStatusUserFacingStatus)MessagingOperationsDictStaticAffordance)is_config_value_truezZ(?P[\d]+)[.-](?P[\d]+)[.-](?P[\d]+\-[\d]+)-(?P[A-Za-z0-9_-]+)c@s$eZdZdeddejfddZdS)IncompatibleService entitlement UAEntitlement named_msgcCs||_||_dSN)rr)selfrrr"d?Z5e j d[d%e!de!fd@dAZ6d%e!dee!ee0j1ffdBdCZ7de!fdDdEZ8dFe ddfdGdHZ9 d[d%e!dee!ee(ffdIdJZ:de;fdKdLZj?fdOdPZ@ d[dQeAe eBfdReAe eBfdSe!de!fdTdUZCdeeDee0j1ffdVdWZEe j dee>j?ee0j1ffdXdYZFdS)\rNFr"returncCdS)z&The lowercase name of this entitlementNr"r!r"r"r#nameJzUAEntitlement.namecCs$|jg}|j|jkr||j|S)z1The list of names this entitlement may be called.)r,presentation_nameappend)r! valid_namesr"r"r#r0Ps  zUAEntitlement.valid_namescCr*)z,The human readable title of this entitlementNr"r+r"r"r#titleXr-zUAEntitlement.titlecCr*)z&A sentence describing this entitlementNr"r+r"r"r# description^r-zUAEntitlement.descriptioncCs,|jj|jididid|jS)z/The user-facing name shown for this entitlementr affordancesZ presentedAs)cfg entitlementsgetr,r+r"r"r#r.ds  zUAEntitlement.presentation_namecCsl|jdur3i}tjtr'ttd }t|}Wdn1s"wY||j idd|_|jS)z$Help information for the entitlementNrhelp) _help_infoospathexistsropenyamlZ safe_loadr6r,)r!Z help_dictfr"r"r# help_infons    zUAEntitlement.help_info.cCr*)Nr"r"r+r"r"r#static_affordancesz UAEntitlement.static_affordancescC|jS)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_servicesz#UAEntitlement.incompatible_servicescCrD)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_servicesrGzUAEntitlement.required_servicescCrD)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_servicess z UAEntitlement.dependent_servicescCsiSr r"r+r"r"r# messagingrCzUAEntitlement.messagingr9r4 assume_yes allow_beta called_namecCs.|st}||_||_||_||_d|_dS)z]Setup UAEntitlement instance @param config: Parsed configuration dictionary N)r UAConfigr4rMrNZ _called_name_valid_service)r!r4rMrNrOr"r"r#r$s  zUAEntitlement.__init__cCs.|jdur|j p|jpt|jjd|_|jS)z2Check if the service is marked as valid (non-beta)Nzfeatures.allow_beta)rQis_betarNrr4r+r"r"r# valid_services  zUAEntitlement.valid_servicesilentc Cs|jdg}t|sdS|\}}|sL|durdS|jtjkr2|\}}|s1||_ d|fSn|jtj krH| \}}|sG||_ d|fSnd|fS|j |d}|sVdS|jdg}t|sddSdS)aNEnable 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. Z pre_enableFNNFrTZ post_enableTN) rLr6rhandle_message_operations can_enablereasonrINCOMPATIBLE_SERVICEhandle_incompatible_servicesmessageINACTIVE_REQUIRED_SERVICES_enable_required_services_perform_enable) r!rTmsg_opsrYfailZ incompat_reterrorZreq_retretr"r"r#enables<       zUAEntitlement.enablecCr*)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!rTr"r"r#r`s zUAEntitlement._perform_enableignore_dependent_servicescCsZ|\}}|tjjkrdttjtjj|j ddfS|j r+|s+| r+dttj fSdS)zReport whether or not disabling is possible for the entitlement. :return: (True, None) if can disable (False, CanDisableFailure) if can't disable Fr1r]rW) application_statusrApplicationStatusDISABLEDrrZALREADY_DISABLEDrformatr1rKdetect_dependent_servicesACTIVE_DEPENDENT_SERVICES)r!rgrj_r"r"r# can_disables  zUAEntitlement.can_disablecCs|rtd|jt|j|tj ks'dt t j t jj|jddfS|\}}|tjjkrBdt t jt jj|jddfS|jsLdt t jfS|\}}|tjjkradt t j|dfS|jro|rodt t jfS|jr}|s}dt t j fSdS)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' expiryFrhrirW)!is_access_expiredloggingdebugr,r Zrequest_updated_contractr4contract_statusrENTITLEDrrZ NOT_ENTITLEDr UNENTITLEDrmr1rjrrkrlZALREADY_ENABLEDrSZIS_BETAapplicability_statusr INAPPLICABLErFdetect_incompatible_servicesr[rIcheck_required_services_activer^)r!rjrprxdetailsr"r"r#rY$sX      zUAEntitlement.can_enableservicesc Csbddlm}m}|D]$}z||}Wn |yYq w||j\}}|tjjkr.dSq dS)Nr)EntitlementNotFoundErrorentitlement_factoryTF)uaclient.entitlementsr~rr4rjrrkENABLED)r!r}r~rserviceent_cls ent_statusrpr"r"r#_check_any_service_is_activefs   z*UAEntitlement._check_any_service_is_activecCs|j|jdS)z Check for depedent services. :return: True if there are dependent services enabled False if there are no dependent services enabled )r})rrKr+r"r"r#rnwsz'UAEntitlement.detect_dependent_servicesc Csbddlm}|jD]%}z||}||j\}}|tjjkr#WdSWq tj y.Yq wdS)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 rrFT) rrrIr4rjrrkrr r~)r!rrequired_servicerrrpr"r"r#r{s   z,UAEntitlement.check_required_services_activecCs>g}|jD]}||j\}}|tjjkr||q|S)zI :return: List of incompatible services that are enabled )rFrr4rjrrkrr/)r!rdrrrpr"r"r#blocking_incompatible_servicess   z,UAEntitlement.blocking_incompatible_servicescCst|dkS)z Check for incompatible services. :return: True if there are incompatible services enabled False if there are no incompatible services enabled r)lenrr+r"r"r#rzsz*UAEntitlement.detect_incompatible_servicescCstj|jjdd}|D]I}||j}tjj|j|jd}tj j|j|jd}|r1d|fStj ||j ds?d|fSd|j}t ||}|sV|dfSq dS) 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_value)service_being_enabledZincompatible_serviceFmsgrMz"Disabling incompatible service: {}NrW)rrr4rrrr[rmr1Z!INCOMPATIBLE_SERVICE_STOPS_ENABLEprompt_for_confirmationrMeventinfodisable)r!Zcfg_block_disable_on_enablerentuser_msge_msgZ disable_msgrdr"r"r#r\s:      z*UAEntitlement.handle_incompatible_servicesc Cs$ddlm}|jD]}z||}Wntjy(tjj|d}d|fYSw||jdd}| dt j j k}|rtj j|j|jd}tjj|j|jd}tj||jds^d|fStd |j|jdd \} } | sd } | jr| jjrd | jj} tjj| |jd }| |fSq dS)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. rrrFT)rN)rrrzEnabling required service: {}rVr9 )rcrrW)rrrIr r~rZREQUIRED_SERVICE_NOT_FOUNDrmr4rjrrkrlZREQUIRED_SERVICEr1ZREQUIRED_SERVICE_STOPS_ENABLErrrMrrrer]rZERROR_ENABLING_REQUIRED_SERVICE) r!rrrrrZis_service_disabledrrrdrb error_msgr"r"r#r_sP      z'UAEntitlement._enable_required_servicescCs|jj|j}|stjtjfS|jD]\}}}||kr$tj |fSq|ddi}t }|dg}|rQ|d|vrQtj tj j |j|dd|dfS|dg}|rm|d|vrmtj tjj |j|dd fS|d } |d g} |d } tt| } | r| r| d | vrtj tjj |j| d| dfS| rtjj |j| | d} z| d\}}t|}t|}Wntytd| tj | fYSw| stj | fSt| d}t| d}||krtj | fS||kr||krtj | fStjdfS)aCheck 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. rr3Z architecturesarchz, )r1rZsupported_archesseriesversion)r1rkernelZ kernelFlavorsZminKernelVersionZflavor)r1rZsupported_kernels)r1rZ min_kernel.z$Could not parse minKernelVersion: %smajorminorN)r4r5r6r,r APPLICABLErZ"NO_ENTITLEMENT_AFFORDANCES_CHECKEDrBryrZget_platform_infoZINAPPLICABLE_ARCHrmr1joinZINAPPLICABLE_SERIESrematchRE_KERNEL_UNAMEgroupZINAPPLICABLE_KERNELZINAPPLICABLE_KERNEL_VERsplitint ValueErrorrswarning)r!entitlement_cfgZ error_messageZfunctorZexpected_resultr3platformZaffordance_archesZaffordance_seriesrZaffordance_kernelsZaffordance_min_kernelrZ invalid_msgZ kernel_majorZ kernel_minorZmin_kern_majorZmin_kern_minorr"r"r#rxs             z"UAEntitlement.applicability_statuscCr*)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"rfr"r"r#_perform_disablets zUAEntitlement._perform_disablec Cs:ddlm}|jD]}z||}Wn tjy1tjj|d}tj |j t j dd|fYSw||j }|dtjjk}|rtjj|j|jd}tjj|j|jd} tj||jdsed| fS|srt tjj|jd |jd d \} } | sd } | jr| jj rd | jj } tjj| |jd}d|fSq dS)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 rrr)Zinfo_msg file_typeF)dependent_serviceservice_being_disabled)rrr)rTrVr9r)rcrrW)rrrKr r~rZDEPENDENT_SERVICE_NOT_FOUNDrmrrrsysstderrr4rjrrkrZDEPENDENT_SERVICEr1ZDEPENDENT_SERVICE_STOPS_DISABLErrrMZDISABLING_DEPENDENT_SERVICErr]Z"FAILED_DISABLING_DEPENDENT_SERVICE) r!rTrrrrrZis_service_enabledrrrdrbrr"r"r#_disable_dependent_servicessX       z)UAEntitlement._disable_dependent_servicescCstS)z%Check if system needs to be rebooted.)rZ should_rebootr+r"r"r#_check_for_rebootszUAEntitlement._check_for_reboot operationcCs"|rttjj|ddSdS)zCheck if user should be alerted that a reboot must be performed. @param operation: The operation being executed. rN)rprintrZENABLE_REBOOT_REQUIRED_TMPLrm)r!rr"r"r#_check_for_reboot_msgsz#UAEntitlement._check_for_reboot_msgcCs|jdg}t|sdS|\}}|s8|durdS|jtjkr4|j|d\}}|s3||_ d|fSnd|fS|j |ds@dS|jdg}t|sNdS|j ddd S) aDisable 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_disablerUNrVFZ post_disablezdisable operationrrW) rLr6rrXrqrZrrorr]rr)r!rTrarqrbrdrr"r"r#rs0     zUAEntitlement.disablecCs>|jjstjS|jj|ji}|r|ddrtjStjS)z=Return whether the user is entitled to the entitlement or notrentitled)r4Z is_attachedrrwr5r6r,rv)r!rr"r"r#rus zUAEntitlement.contract_statuscCsD|jj|ji}|d}|sdSt|d}|tkr dSdS)zs$ $$ $