o
    fK                     @   s  U d Z ddlZddlZddlZddlmZmZmZmZm	Z	 ddl
mZ ddlmZ ddlmZ ddlmZ eeZeZdZd	Zg d
Zdddgdddddedgdddddedgddddddg ddddddg dddddZddddg dddddd d!id"didd d!d#d"did"did$dddd%idd&diidddd'd(dgddd)d*d+d,gd,d-d.d/d"didd d!d#d,i id"didddd0did1d"didddd0did1d"diddd%dd d!d1d"did"did$d"didddd0did1dd&diid2Zd3D ]	Zed4 ee< qd5D ]	Zed6 ee< qd7D ]	Zed8 ee< qd9eedgd:Zeed;< eg d<Zd=d> Z d?d@ Z!dRdAdBZ"dSdCdDZ#dEdF Z$								dTdGdHZ%dIdJ Z&dKe'dLedMedNe(dOdf
dPdQZ)dS )UzNTP: enable and configure ntp    N)subp
temp_utils	templater
type_utilsutil)Cloud)Config)
MetaSchema)PER_INSTANCEz/etc/ntp.conf   )	almalinuxalpineaosc
azurelinuxcentos
cloudlinuxcosdebian	eurolinuxfedorafreebsdmarinermiraclelinuxopenbsd	openeulerOpenCloudOSopenmandrivaopensuseopensuse-microosopensuse-tumbleweedopensuse-leapphotonrhelrockysle_hpc	sle-microsles	TencentOSubuntu	virtuozzochronydz/etc/chrony.confchronyzchrony.conf.{distro})	check_execonfpathpackagesservice_nametemplate_nametemplatentpdntpzntp.conf.{distro}ntpdatez/etc/ntpd.confzntpd.conf.{distro}z/lib/systemd/systemd-timesyncdz-/etc/systemd/timesyncd.conf.d/cloud-init.confsystemd-timesyncdztimesyncd.conf)r+   r3   r4   openntpdr5   z/etc/chrony/chrony.conf)r-   r/   )r-   r.   r/   )r+   r3   z"/usr/lib/systemd/systemd-timesyncdz/etc/systemd/timesyncd.conf)r,   r-   r/   )r+   r5   )r3   r+   )r/   r-   r-   )r-   r/   r0   z/usr/local/etc/chrony.conf)r-   r.   r/   r0   z/usr/local/sbin/ntpdz/usr/local/etc/ntp.confr6   zntpd.conf.openbsd)r,   r-   r.   r/   r0   )r3   r+   r6   r,   )r+   r3   r5   )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&   cc_ntp)iddistros	frequencyactivate_by_schema_keysmeta)r,   r-   r.   r/   c                 C   s0   t }tt}| |v rtj|||  gdd}|S )zConstruct a distro-specific ntp client config dictionary by merging
       distro specific changes into base config.

    @param distro: String providing the distro class name.
    @returns: Dict of distro configurations for ntp clients.
    Treverse)DISTRO_CLIENT_CONFIGcopyNTP_CLIENT_CONFIGr   mergemanydict)distrodcfgcfg rF   9/usr/lib/python3/dist-packages/cloudinit/config/cc_ntp.pydistro_ntp_client_configs  s
   
rH   c                 C   s   t |j}| r| dkrtd|  || i S |dd}i }|dkrT|jD ]}||}t|dr?td| |} nq&|sR|jd }td| ||}|S td| ||i }|S )	a  Determine which ntp client is to be used, consulting the distro
       for its preference.

    @param ntp_client: String name of the ntp client to use.
    @param distro: Distro class instance.
    @returns: Dict of the selected ntp client or {} if none selected.
    autoz4Selected NTP client "%s" via user-data configuration
ntp_clientr,   z+Selected NTP client "%s", already installedr   z<Selected distro preferred NTP client "%s", not yet installedz1Selected NTP client "%s" via distro system config)	rH   nameLOGdebugget
get_optionpreferred_ntp_clientsr   which)rJ   rC   
distro_cfgdistro_ntp_client	clientcfgclientrE   rF   rF   rG   select_ntp_client  s@   





rV   c                 C   s(   t |rdS |du rdg}| | dS )ah  Install ntp client package if not already installed.

    @param install_func: function.  This parameter is invoked with the contents
    of the packages parameter.
    @param packages: list.  This parameter defaults to ['ntp'].
    @param check_exe: string.  The name of a binary that indicates the package
    the specified package is already installed.
    Nr3   )r   rQ   )install_funcr.   r,   rF   rF   rG   install_ntp_clientL  s
   
	rX   c                 C   s$   t j| rt| | d  dS dS )zRename any existing ntp client config file

    @param confpath: string. Specify a path to an existing ntp client
    configuration file.
    z.distN)ospathexistsr   renamer-   rF   rF   rG   rename_ntp_conf]  s   r^   c                 C   sh   g }| }| dkrd}n
| dks| dkrd}t tD ]}|ddd t|g|g d	g D  q|S )
zGenerate a list of server names to populate an ntp client configuration
    file.

    @param distro: string.  Specify the distro name
    @returns: list: A list of strings representing ntp servers for this distro.
    r&   r   r   r    .c                 S   s   g | ]}|r|qS rF   rF   ).0nrF   rF   rG   
<listcomp>}  s    z)generate_server_names.<locals>.<listcomp>zpool.ntp.org)rangeNR_POOL_SERVERSappendjoinstr)rC   namespool_distroxrF   rF   rG   generate_server_namesg  s   rl   c	                 C   s$  |sg }|sg }|sg }|sg }t |dkr"t |dkr"| dkr"dS t |dkr>| dkr>|dkr>t| }tdd| nt |dkrWt |dkrWt| }tdd| |s]td	|se|setd
||||d}	|rtjddd}
|
d }tj	||d t
|||	 |rt| dS dS )a  Render a ntp client configuration for the specified client.

    @param distro_name: string.  The distro class name.
    @param service_name: string. The name of the NTP client service.
    @param servers: A list of strings specifying ntp servers. Defaults to empty
    list.
    @param pools: A list of strings specifying ntp pools. Defaults to empty
    list.
    @param allow: A list of strings specifying a network/CIDR. Defaults to
    empty list.
    @param peers: A list nodes that should peer with each other. Defaults to
    empty list.
    @param path: A string to specify where to write the rendered template.
    @param template_fn: A string to specify the template source file.
    @param template: A string specifying the contents of the template. This
    content will be written to a temporary file before being used to render
    the configuration file.

    @raises: ValueError when path is None.
    @raises: ValueError when template_fn is None and template is None.
    r   r   Nr   r2   z%Adding distro default ntp servers: %s,z*Adding distro default ntp pool servers: %sz Invalid value for path parameterz$Not template_fn or template provided)serverspoolsallowpeersztemplate_name-z.tmpl)prefixsuffix   )content)lenrl   rL   rM   rg   
ValueErrorr   mkstempr   
write_filer   render_to_filedel_file)distro_namer/   rn   ro   rp   rq   rZ   template_fnr1   paramstfilerF   rF   rG   write_ntp_config_template  sJ     
r   c                 C   sB  g }t t|  }|rdt|}|dj|d nt| 	d| 	dgs/|d t| 
 D ]\\}}d| }|dkrUt|t|tgsT|d	j||d
 q5|dkrit|tsh|dj||d
 q5|dv r|du rrq5t|ts|dj||d
 q5t|ts|dj||d
 q5|rtdjd|ddS )aO  Validate user-provided ntp:config option values.

    This function supplements flexible jsonschema validation with specific
    value checks to aid in triage of invalid user-provided configuration.

    @param ntp_config: Dictionary of configuration value under 'ntp'.

    @raises: ValueError describing invalid values provided.
    z, z(Missing required ntp:config keys: {keys})keysr1   r0   zJEither ntp:config:template or ntp:config:template_name values are requiredzntp:config:r-   z6Expected a config file path {keypath}. Found ({value}))keypathvaluer.   zHExpected a list of required package names for {keypath}. Found ({value}))r1   r0   Nz5Expected a string type for {keypath}. Found ({value})z$Invalid ntp configuration:\n{errors}
)errors)REQUIRED_NTP_CONFIG_KEYS
differencesetr   rg   sortedrf   formatanyrN   itemsall
isinstancerh   listrw   )
ntp_configr   missingr   keyr   r   rF   rF   rG   supplemental_schema_validation  sn   




r   rK   rE   cloudargsreturnc                 C   s  d|vrt d|  dS |d }|du ri }t|ts&tdjt|d|dd}t	
|r9t d|  dS t|d	|j}t	j||d
i gdd}t| t|dd d}|ds|dd|jj}||}|sd|d }	t|	t d|d t d|dg  t d|dg  t d|dg  t d|dg  t|jj|d|dg |dg |dg |dg |d||dd	 t|jj|d |d d t	 rH|dd kr&z	|jd!d  W n tjy   t d" Y nw z	|jd#d  W n tjy%   t d$ Y nw z|jd%|d W n tjyG }
 zt d&|
  d}
~
ww z|jd'|d W dS  tjyj }
 zt d(|
  d}
~
ww ))zEnable and configure ntp.r3   z8Skipping module named %s, not present or disabled by cfgNzL'ntp' key existed in config, but not a dictionary type, is a {_type} instead)_typeenabledTz)Skipping module named %s, disabled by cfgrJ   configr=   r-   r]   r1   r0   z{distro}z#No template found, not rendering %szservice_name: %sr/   zservers: %srn   z	pools: %sro   z	allow: %srp   z	peers: %srq   )r/   rn   ro   rp   rq   rZ   r}   r1   r.   r,   )r.   r,   r2   stopz Failed to stop base ntpd servicedisablez#Failed to disable base ntpd serviceenablez Failed to enable ntp service: %sreloadz&Failed to reload/start ntp service: %s)rL   rM   r   dictRuntimeErrorr   r   obj_namerN   r   is_falserV   rC   rB   r   r^   replacerK   get_template_filenamer   rX   install_packagesis_BSDmanage_servicer   ProcessExecutionErrorwarning	exception)rK   rE   r   r   ntp_cfgr   ntp_client_configr}   r0   msgerF   rF   rG   handle  s   













r   )Nr2   )N)NNNNNNNN)*__doc__r@   loggingrY   	cloudinitr   r   r   r   r   cloudinit.cloudr   cloudinit.configr   cloudinit.config.schemar	   cloudinit.settingsr
   	getLogger__name__rL   r:   NTP_CONFre   r9   rA   r?   rC   r<   __annotations__	frozensetr   rH   rV   rX   r^   rl   r   r   rh   r   r   rF   rF   rF   rG   <module>   sh  
#				/	

  	
2


Q"=