HEX

File: //usr/lib/python3.9/site-packages/ansible/modules/__pycache__/cron.cpython-39.pyc
a

�)gEf�@s�ddlmZmZmZeZdZdZdZddl	Z	ddl
Z
ddlZddlZddl
Z
ddlZddlmZddlmZmZddlmZGd	d
�d
e�ZGdd�de�Zd
d�Zedkr�e�dS)�)�absolute_import�division�print_functiona�
---
module: cron
short_description: Manage cron.d and crontab entries
description:
  - Use this module to manage crontab and environment variables entries. This module allows
    you to create environment variables and named crontab entries, update, or delete them.
  - 'When crontab jobs are managed: the module includes one line with the description of the
    crontab entry C("#Ansible: <name>") corresponding to the "name" passed to the module,
    which is used by future ansible/module calls to find/check the state. The "name"
    parameter should be unique, and changing the "name" value will result in a new cron
    task being created (or a different one being removed).'
  - When environment variables are managed, no comment line is added, but, when the module
    needs to find/check the state, it uses the "name" parameter to find the environment
    variable definition line.
  - When using symbols such as %, they must be properly escaped.
version_added: "0.9"
options:
  name:
    description:
      - Description of a crontab entry or, if env is set, the name of environment variable.
      - This parameter is always required as of ansible-core 2.12.
    type: str
    required: yes
  user:
    description:
      - The specific user whose crontab should be modified.
      - When unset, this parameter defaults to the current user.
    type: str
  job:
    description:
      - The command to execute or, if env is set, the value of environment variable.
      - The command should not contain line breaks.
      - Required if I(state=present).
    type: str
    aliases: [ value ]
  state:
    description:
      - Whether to ensure the job or environment variable is present or absent.
    type: str
    choices: [ absent, present ]
    default: present
  cron_file:
    description:
      - If specified, uses this file instead of an individual user's crontab.
        The assumption is that this file is exclusively managed by the module,
        do not use if the file contains multiple entries, NEVER use for /etc/crontab.
      - If this is a relative path, it is interpreted with respect to I(/etc/cron.d).
      - Many linux distros expect (and some require) the filename portion to consist solely
        of upper- and lower-case letters, digits, underscores, and hyphens.
      - Using this parameter requires you to specify the I(user) as well, unless I(state) is not I(present).
      - Either this parameter or I(name) is required
    type: path
  backup:
    description:
      - If set, create a backup of the crontab before it is modified.
        The location of the backup is returned in the C(backup_file) variable by this module.
    type: bool
    default: no
  minute:
    description:
      - Minute when the job should run (C(0-59), C(*), C(*/2), and so on).
    type: str
    default: "*"
  hour:
    description:
      - Hour when the job should run (C(0-23), C(*), C(*/2), and so on).
    type: str
    default: "*"
  day:
    description:
      - Day of the month the job should run (C(1-31), C(*), C(*/2), and so on).
    type: str
    default: "*"
    aliases: [ dom ]
  month:
    description:
      - Month of the year the job should run (C(1-12), C(*), C(*/2), and so on).
    type: str
    default: "*"
  weekday:
    description:
      - Day of the week that the job should run (C(0-6) for Sunday-Saturday, C(*), and so on).
    type: str
    default: "*"
    aliases: [ dow ]
  special_time:
    description:
      - Special time specification nickname.
    type: str
    choices: [ annually, daily, hourly, monthly, reboot, weekly, yearly ]
    version_added: "1.3"
  disabled:
    description:
      - If the job should be disabled (commented out) in the crontab.
      - Only has effect if I(state=present).
    type: bool
    default: no
    version_added: "2.0"
  env:
    description:
      - If set, manages a crontab's environment variable.
      - New variables are added on top of crontab.
      - I(name) and I(value) parameters are the name and the value of environment variable.
    type: bool
    default: false
    version_added: "2.1"
  insertafter:
    description:
      - Used with I(state=present) and I(env).
      - If specified, the environment variable will be inserted after the declaration of specified environment variable.
    type: str
    version_added: "2.1"
  insertbefore:
    description:
      - Used with I(state=present) and I(env).
      - If specified, the environment variable will be inserted before the declaration of specified environment variable.
    type: str
    version_added: "2.1"
requirements:
  - cron (any 'vixie cron' conformant variant, like cronie)
author:
  - Dane Summers (@dsummersl)
  - Mike Grozak (@rhaido)
  - Patrick Callahan (@dirtyharrycallahan)
  - Evan Kaufman (@EvanK)
  - Luca Berruti (@lberruti)
extends_documentation_fragment:
    - action_common_attributes
attributes:
    check_mode:
        support: full
    diff_mode:
        support: full
    platform:
        support: full
        platforms: posix
a�
- name: Ensure a job that runs at 2 and 5 exists. Creates an entry like "0 5,2 * * ls -alh > /dev/null"
  ansible.builtin.cron:
    name: "check dirs"
    minute: "0"
    hour: "5,2"
    job: "ls -alh > /dev/null"

- name: 'Ensure an old job is no longer present. Removes any job that is prefixed by "#Ansible: an old job" from the crontab'
  ansible.builtin.cron:
    name: "an old job"
    state: absent

- name: Creates an entry like "@reboot /some/job.sh"
  ansible.builtin.cron:
    name: "a job for reboot"
    special_time: reboot
    job: "/some/job.sh"

- name: Creates an entry like "PATH=/opt/bin" on top of crontab
  ansible.builtin.cron:
    name: PATH
    env: yes
    job: /opt/bin

- name: Creates an entry like "APP_HOME=/srv/app" and insert it after PATH declaration
  ansible.builtin.cron:
    name: APP_HOME
    env: yes
    job: /srv/app
    insertafter: PATH

- name: Creates a cron file under /etc/cron.d
  ansible.builtin.cron:
    name: yum autoupdate
    weekday: "2"
    minute: "0"
    hour: "12"
    user: root
    job: "YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate"
    cron_file: ansible_yum-autoupdate

- name: Removes a cron file from under /etc/cron.d
  ansible.builtin.cron:
    name: "yum autoupdate"
    cron_file: ansible_yum-autoupdate
    state: absent

- name: Removes "APP_HOME" environment variable from crontab
  ansible.builtin.cron:
    name: APP_HOME
    env: yes
    state: absent
�#N)�
AnsibleModule)�to_bytes�	to_native)�shlex_quotec@seZdZdS)�CronTabErrorN)�__name__�
__module__�__qualname__�rr�8/usr/lib/python3.9/site-packages/ansible/modules/cron.pyr
�sr
c@s�eZdZdZd7dd�Zdd�Zdd�Zd8d	d
�Zdd�Zd
d�Z	dd�Z
dd�Zdd�Zdd�Z
d9dd�Zdd�Zdd�Zdd�Zdd �Zd!d"�Zd:d#d$�Zd%d&�Zd'd(�Zd)d*�Zd+d,�Zd-d.�Zd/d0�Zd1d2�Zd3d4�Zd5d6�ZdS);�CronTabz�
        CronTab object to write time based crontab file

        user      - the user of the crontab (defaults to current user)
        cron_file - a cron file under /etc/cron.d, or an absolute path
    NcCs�||_||_t��dk|_d|_d|_d|_|jjddd�|_	|r�tj
�|�rd||_t
|dd�|_q�tj
�d	|�|_tj
�d
t
|dd��|_nd|_|��dS)Nrz
#Ansible: ��crontabT)�required�surrogate_or_strict��errorsz/etc/cron.ds/etc/cron.d)�module�user�os�getuid�root�lines�ansible�
n_existingZget_bin_path�cron_cmd�path�isabs�	cron_filer�b_cron_file�join�read)�selfrrr"rrr�__init__�szCronTab.__init__c	Cs8g|_|jr|z6t|jd�}t|��dd�|_|j��|_|��Wn6t	yVYdSt
yxtdt�
�d��Yn0n�|jj|��dd�\}}}|dkr�|dkr�td	��||_|��}d}|D]n}|d
ks�t�d|��st�d|��st�d
|��s|j�|�n"t�|�d}t�|d|jd�|_|d7}q�dS)N�rbrr�Unexpected error:rT�Zuse_unsafe_shell�zUnable to read crontab�z8# DO NOT EDIT THIS FILE - edit the master and reinstall.z# \(/tmp/.*installed on.*\)z# \(.*version.*\)z[
]?r)rr"�openr#rr%r�
splitlines�close�IOError�	Exceptionr
�sys�exc_infor�run_command�_read_user_execute�re�match�append�escape�sub)	r&�f�rc�out�errr�count�l�patternrrrr%s6
�
�zCronTab.readcCs4t|j�dkrdS|jD]}|��rdSqdSdS�NrTF)�lenr�strip)r&�linerrr�is_empty$s
zCronTab.is_emptycCs�|rt|d�}nB|jr$t|jd�}n.tjdd�\}}t�|tdd��t�|d�}|�	t
|����|��|rtdS|js�|j
j|�|�dd�\}}}t�|�|d	kr�|j
j|d
�|j
��r�|jr�|j
�|jd�dS)zI
        Write the crontab to the system. Saves all information.
        �wbr��prefixZ0644�NTr*r��msgF)r-r"r#�tempfile�mkstempr�chmod�int�fdopen�writer�renderr/rr4�_write_execute�unlink�	fail_jsonZselinux_enabledZset_default_selinux_context)r&�backup_fileZfilehZfiledr r<r=r>rrrrR-s$
z
CronTab.writecCsd|j|fS)Nz%s%s)r�r&�namerrr�
do_commentNszCronTab.do_commentcCs&|j�|�|��|j�d|�dS�N�%s)rr8rZ�r&rY�jobrrr�add_jobQszCronTab.add_jobcCs|�|||j�S�N)�_update_job�
do_add_jobr]rrr�
update_jobXszCronTab.update_jobcCs|�|�|�d|�dSr[�r8�r&r�commentr^rrrrb[s
zCronTab.do_add_jobcCs|�|d|j�S�Nr)ra�
do_remove_jobrXrrr�
remove_job`szCronTab.remove_jobcCsdSr`rrerrrrhcszCronTab.do_remove_jobcCs�|s|s|j�d|�dS|r$|}n|r,|}|�|�}t|�dkrr|rT|dd}n|r`|d}|j�||�dS|jjd|d�dS)Nrr+zVariable named '%s' not found.rK)r�insert�find_envrCrrV)r&�decl�insertafter�insertbeforeZ
other_nameZ
other_decl�indexrrr�add_envfs 
zCronTab.add_envcCs|�|||j�Sr`)�_update_env�
do_add_env)r&rYrlrrr�
update_envzszCronTab.update_envcCs|�|�dSr`rd�r&rrlrrrrr}szCronTab.do_add_envcCs|�|d|j�Srg)rq�
do_remove_envrXrrr�
remove_env�szCronTab.remove_envcCsdSr`rrtrrrru�szCronTab.do_remove_envcCsNzt�|j�WdSty&YdStyHtdt��d��Yn0dS)NTFr)r)rrUr"�OSErrorr1r
r2r3)r&rrr�remove_job_file�szCronTab.remove_job_filecCs
d}|jD]L}|dur0||kr*||gSd}q
t�d|j|�r
t�d|jd|�}q
|�rt|j�D]�\}}||krht�d|j|j|d�s�|j�||�|��|j||dgS|rh|j|d|�d�krh|�|�|j|d<|j|d|dgSqhgS)Nr\rr+T)rr6r7rr:�	enumeraterjrZ)r&rYr^rfr@�irrr�find_job�s$
zCronTab.find_jobcCs4t|j�D]$\}}t�d||�r
||gSq
gS�Nz^%s=)ryrr6r7)r&rYror@rrrrk�szCronTab.find_envc	
	Cs~|�d�}|rd}	nd}	|rD|jr4d|	||j|fSd|	||fSn6|jrdd|	||||||j|fSd|	||||||fSdS)N�
rrz%s@%s %s %sz%s@%s %sz%s%s %s %s %s %s %s %sz%s%s %s %s %s %s %s)rDr"r)
r&�minute�hour�day�month�weekdayr^Zspecial�disabledZdisable_prefixrrr�get_cron_job�s
zCronTab.get_cron_jobcCs@g}|jD]0}t�d|j|�r
|�t�d|jd|��q
|S)Nr\r)rr6r7rr8r:)r&Zjobnamesr@rrr�get_jobnames�s

zCronTab.get_jobnamescCs4g}|jD]$}t�d|�r
|�|�d�d�q
|S)Nz^\S+=�=r)rr6r7r8�split)r&Zenvnamesr@rrr�get_envnames�s

zCronTab.get_envnamescCsn|�|�}g}d}|jD]6}|dur6||||�d}q||krD|}q|�|�q||_t|�dkrfdSdSdSrB)rZrr8rC)r&rYr^ZaddlinesfunctionZansiblename�newlinesrfr@rrrra�s

zCronTab._update_jobcCs@g}|jD]*}t�d||�r*|||�q
|�|�q
||_dSr|)rr6r7r8)r&rYrlZaddenvfunctionr�r@rrrrq�s
zCronTab._update_envcCs:g}|jD]}|�|�q
d�|�}|r6|�d�d}|S)zD
        Render this crontab as it would be in the crontab.
        �
r})rr8r$�rstrip)r&ZcronsZcron�resultrrrrS�s

zCronTab.rendercCs�d}|jr�t��dkr.dt|j�t|j�fSt��dkrRdt|j�t|j�fSt��dkrtd|jdt|j�fSt�t���d	|jkr�d
t|j�}d|j|dfS)z@
        Returns the command line for reading a crontab
        r�SunOSzsu %s -c '%s -l'�AIXz%s -l %s�HP-UX�%s %s %sz-lr�-u %s�	r�platform�systemr	r�pwd�getpwuidrr)r&rrrrr5szCronTab._read_user_executecCsxd}|jrdt��dvr>dt|j�t|�t|j�|jt|�fSt�t���d|jkrddt|j�}d|j|t|�fS)z?
        Return the command line for writing a crontab
        r)r�r�r�z chown %s %s ; su '%s' -c '%s %s'rr�r�r�)r&r rrrrrTs �zCronTab._write_execute)NN)N)NN)N)rrr
�__doc__r'r%rFrRrZr_rcrbrirhrprsrrrvrurxr{rkr�r�r�rarqrSr5rTrrrrr�s6
$	
!


		
rcCs�tttddd�tdd�tddgd�tdd�tdddd	gd
�tddd
�tddd
�tddd
�tdddgd�tddd
�tdddgd�tdgd�d�tddd
�tddd
�tdd�tdd�d�dddggd�}|jd}|jd}|jd}|jd}|jd}|jd}|jd}|jd}|jd }	|jd!}
|jd"}|jd#}|jd$}
|jd%}|jd}|jd}|dk}d}t�}t�}|�r�|d&k�r�|jd'd(�tj�|�}t�	d)|tj
��s�|�d*|d+�t�t
d,d-��t|||�}|�d.|�|j�r>t�}|j|d/<|j�r|j|d0<n |j�r6d1|j|d0<nd2|d0<|�rndd3d4�|||	|
|fD�v�rn|jd5d(�|�r�t��d6k�r�|jd7d(�|�r�|�r�|�s�|jd8d(�|du�r�|jd9d(�|�s�|�r�|�s�|jd:d(�|�r|j�stjd2d;�\}}|�|�|�r�d<|v�r$|jd=d(�d>||f}|�|�}|�r�t|�d?k�r`|�|||�d}t|�d?k�r�|d@|k�r�|�||�d}nt|�d?k�r�|�|�d}�nJ|�rndAD]&}||�dB�v�r�|�dC��q�q�|� |||	|
||||
�}|�!||�}t|�d?k�r"|�"||�d}t|�d?k�rN|d@|k�rN|�#||�d}t|�dDk�r�|�#||�d}n�|�!|�}t|�d?k�r�|�$|�d}|j�r�|�%��r�|j�r�dE|dF<dG|dH<nt�}|j�r�tj�&|j�}n|�'�}|j(||||dI�|�s*|jdEk�r*|j�)dJ��s*|j�)dK��s*d}t|�*�|�+�||dL�}|�r�|j�sX|��|j�r�|�,�|dF<|j�r�|j|dH<n |j�r�d1|j|dH<nd2|dH<||dM<|�r�|j�s�|�r�||dN<n
t�-|�|�r�||d<|j(fi|��|j(dOd(�dS)PN�strT)�typer)r��value)r��aliasesr ZpresentZabsent)r��default�choices�boolF)r�r��*Zdom)r�r�r�Zdow)ZrebootZyearlyZannuallyZmonthlyZweeklyZdailyZhourly)r�r�)rYrr^r"�state�backupr~rr�r�r��special_timer��envrmrnrmrn)Z
argument_specZsupports_check_modeZmutually_exclusiverYrr^r"r�r�r~rr�r�r�r�r�r�z/etc/crontabz>Will not manage /etc/crontab via cron_file, see documentation.rKz
^[A-Z0-9_-]+$z3Filename portion of cron_file ("%s") should consistzJ solely of upper- and lower-case letters, digits, underscores, and hyphensZ022rJzcron instantiated - name: "%s"�beforeZ
before_headerzcrontab for user "%s"rcSsg|]}|dk�qS)r�r)�.0�xrrr�
<listcomp>��zmain.<locals>.<listcomp>z6You must specify time and date fields or special time.r�z4Solaris does not support special_time=... or @rebootz@To use cron_file=... parameter you must specify user=... as wellz<You must specify 'job' to install a new cron job or variablezCInsertafter and insertbefore parameters are valid only with env=yesrH� z%Invalid name for environment variablez%s="%s"rr+)�
r�r}z"Job should not contain line breaksr,rZafterz	/dev/nullZafter_header)�changedr"r��diffr�r�)ZjobsZenvs�warningsr�r�rWzUnable to execute cron task.).r�dict�params�listrVrr �basenamer6�search�Ir8�umaskrPr�debugZ_diffrr"rr�r�Z
check_moderMrNrRrkrCrprsrvrDr�r{r_rcrirF�isfilerxZ	exit_json�endswithr�r�rSrU)rrYrr^r"r�r�r~rr�r�r�r�r�r�rmrnZ
do_installr�Zres_argsr�Zcron_file_basenamerr�ZbackuphrWrlZold_decl�charZold_jobrrr�main#s,






���

















�
�









�

r��__main__)Z
__future__rrrr�Z
__metaclass__Z
DOCUMENTATIONZEXAMPLESZRETURNrr�r�r6r2rMZansible.module_utils.basicrZ+ansible.module_utils.common.text.convertersrrZansible.module_utils.six.movesr	r1r
�objectrr�rrrrr�<module>
s,7CZ