관리-도구
편집 파일: lineinfile.cpython-39.pyc
a �)g�] � @ s� d dl mZmZmZ eZdZdZdZd dl Z d dl Z d dl Z d dl m Z d dlmZmZmZ dd � Zd d � Zd d � Zdd� Zdd� Zedkr�e� dS )� )�absolute_import�division�print_functiona� --- module: lineinfile short_description: Manage lines in text files description: - This module ensures a particular line is in a file, or replace an existing line using a back-referenced regular expression. - This is primarily useful when you want to change a single line in a file only. - See the M(ansible.builtin.replace) module if you want to change multiple, similar lines or check M(ansible.builtin.blockinfile) if you want to insert/update/remove a block of lines in a file. For other cases, see the M(ansible.builtin.copy) or M(ansible.builtin.template) modules. version_added: "0.7" options: path: description: - The file to modify. - Before Ansible 2.3 this option was only usable as I(dest), I(destfile) and I(name). type: path required: true aliases: [ dest, destfile, name ] regexp: description: - The regular expression to look for in every line of the file. - For C(state=present), the pattern to replace if found. Only the last line found will be replaced. - For C(state=absent), the pattern of the line(s) to remove. - If the regular expression is not matched, the line will be added to the file in keeping with C(insertbefore) or C(insertafter) settings. - When modifying a line the regexp should typically match both the initial state of the line as well as its state after replacement by C(line) to ensure idempotence. - Uses Python regular expressions. See U(https://docs.python.org/3/library/re.html). type: str aliases: [ regex ] version_added: '1.7' search_string: description: - The literal string to look for in every line of the file. This does not have to match the entire line. - For C(state=present), the line to replace if the string is found in the file. Only the last line found will be replaced. - For C(state=absent), the line(s) to remove if the string is in the line. - If the literal expression is not matched, the line will be added to the file in keeping with C(insertbefore) or C(insertafter) settings. - Mutually exclusive with C(backrefs) and C(regexp). type: str version_added: '2.11' state: description: - Whether the line should be there or not. type: str choices: [ absent, present ] default: present line: description: - The line to insert/replace into the file. - Required for C(state=present). - If C(backrefs) is set, may contain backreferences that will get expanded with the C(regexp) capture groups if the regexp matches. type: str aliases: [ value ] backrefs: description: - Used with C(state=present). - If set, C(line) can contain backreferences (both positional and named) that will get populated if the C(regexp) matches. - This parameter changes the operation of the module slightly; C(insertbefore) and C(insertafter) will be ignored, and if the C(regexp) does not match anywhere in the file, the file will be left unchanged. - If the C(regexp) does match, the last matching line will be replaced by the expanded line parameter. - Mutually exclusive with C(search_string). type: bool default: no version_added: "1.1" insertafter: description: - Used with C(state=present). - If specified, the line will be inserted after the last match of specified regular expression. - If the first match is required, use(firstmatch=yes). - A special value is available; C(EOF) for inserting the line at the end of the file. - If specified regular expression has no matches, EOF will be used instead. - If C(insertbefore) is set, default value C(EOF) will be ignored. - If regular expressions are passed to both C(regexp) and C(insertafter), C(insertafter) is only honored if no match for C(regexp) is found. - May not be used with C(backrefs) or C(insertbefore). type: str choices: [ EOF, '*regex*' ] default: EOF insertbefore: description: - Used with C(state=present). - If specified, the line will be inserted before the last match of specified regular expression. - If the first match is required, use C(firstmatch=yes). - A value is available; C(BOF) for inserting the line at the beginning of the file. - If specified regular expression has no matches, the line will be inserted at the end of the file. - If regular expressions are passed to both C(regexp) and C(insertbefore), C(insertbefore) is only honored if no match for C(regexp) is found. - May not be used with C(backrefs) or C(insertafter). type: str choices: [ BOF, '*regex*' ] version_added: "1.1" create: description: - Used with C(state=present). - If specified, the file will be created if it does not already exist. - By default it will fail if the file is missing. type: bool default: no backup: description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. type: bool default: no firstmatch: description: - Used with C(insertafter) or C(insertbefore). - If set, C(insertafter) and C(insertbefore) will work with the first line that matches the given regular expression. type: bool default: no version_added: "2.5" others: description: - All arguments accepted by the M(ansible.builtin.file) module also work here. type: str extends_documentation_fragment: - action_common_attributes - action_common_attributes.files - files - validate attributes: check_mode: support: full diff_mode: support: full platform: platforms: posix safe_file_operations: support: full vault: support: none notes: - As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well. seealso: - module: ansible.builtin.blockinfile - module: ansible.builtin.copy - module: ansible.builtin.file - module: ansible.builtin.replace - module: ansible.builtin.template - module: community.windows.win_lineinfile author: - Daniel Hokka Zakrissoni (@dhozac) - Ahti Kitsik (@ahtik) - Jose Angel Munoz (@imjoseangel) a6 # NOTE: Before 2.3, option 'dest', 'destfile' or 'name' was used instead of 'path' - name: Ensure SELinux is set to enforcing mode ansible.builtin.lineinfile: path: /etc/selinux/config regexp: '^SELINUX=' line: SELINUX=enforcing - name: Make sure group wheel is not in the sudoers configuration ansible.builtin.lineinfile: path: /etc/sudoers state: absent regexp: '^%wheel' - name: Replace a localhost entry with our own ansible.builtin.lineinfile: path: /etc/hosts regexp: '^127\.0\.0\.1' line: 127.0.0.1 localhost owner: root group: root mode: '0644' - name: Replace a localhost entry searching for a literal string to avoid escaping ansible.builtin.lineinfile: path: /etc/hosts search_string: '127.0.0.1' line: 127.0.0.1 localhost owner: root group: root mode: '0644' - name: Ensure the default Apache port is 8080 ansible.builtin.lineinfile: path: /etc/httpd/conf/httpd.conf regexp: '^Listen ' insertafter: '^#Listen ' line: Listen 8080 - name: Ensure php extension matches new pattern ansible.builtin.lineinfile: path: /etc/httpd/conf/httpd.conf search_string: '<FilesMatch ".php[45]?$">' insertafter: '^\t<Location \/>\n' line: ' <FilesMatch ".php[34]?$">' - name: Ensure we have our own comment added to /etc/services ansible.builtin.lineinfile: path: /etc/services regexp: '^# port for http' insertbefore: '^www.*80/tcp' line: '# port for http by default' - name: Add a line to a file if the file does not exist, without passing regexp ansible.builtin.lineinfile: path: /tmp/testfile line: 192.168.1.99 foo.lab.net foo create: yes # NOTE: Yaml requires escaping backslashes in double quotes but not in single quotes - name: Ensure the JBoss memory settings are exactly as needed ansible.builtin.lineinfile: path: /opt/jboss-as/bin/standalone.conf regexp: '^(.*)Xms(\d+)m(.*)$' line: '\1Xms${xms}m\3' backrefs: yes # NOTE: Fully quoted because of the ': ' on the line. See the Gotchas in the YAML docs. - name: Validate the sudoers file before saving ansible.builtin.lineinfile: path: /etc/sudoers state: present regexp: '^%ADMIN ALL=' line: '%ADMIN ALL=(ALL) NOPASSWD: ALL' validate: /usr/sbin/visudo -cf %s # See https://docs.python.org/3/library/re.html for further details on syntax - name: Use backrefs with alternative group syntax to avoid conflicts with variable values ansible.builtin.lineinfile: path: /tmp/config regexp: ^(host=).* line: \g<1>{{ hostname }} backrefs: yes �#N)� AnsibleModule)�to_bytes� to_native�to_textc C s� t j| jd�\}}t�|d��}|�|� W d � n1 s>0 Y | j�dd �}| }|r�d|vrx| jd| d� | � t || dd��\}} } |d k}|d kr�| jd || f d� |r�| j |t tj �t |dd��dd�| jd d � d S ) N)�dir�wb�validatez%sz validate must contain %%s: %s��msg�surrogate_or_strict��errorsr z"failed to validate: rc:%s error:%s� unsafe_writes)r )�tempfileZmkstempZtmpdir�os�fdopen� writelines�params�get� fail_jsonZ run_commandr Z atomic_mover �path�realpath) �module�b_lines�destZtmpfdZtmpfile�fr Zvalid�rc�out�err� r# �>/usr/lib/python3.9/site-packages/ansible/modules/lineinfile.py� write_changes s& ( ��r% c C s< | � | j�}| j|d|d�r4|r(|d7 }d}|d7 }||fS )NF)�diffz and Tz,ownership, perms or SE linux context changed)Zload_file_common_argumentsr Z set_fs_attributes_if_different)r �changed�messager& Z file_argsr# r# r$ �check_file_attrs s r) c ! C sx ddd| d| d�} t |dd�} tj�| �s�|sD| jdd| d� tj�| �} | r�tj�| �s�| js�zt�| � W n@ ty� } z(| jd t | �t |�f d � W Y d }~n d }~0 0 g }n2t | d ��}|� � }W d � n1 s�0 Y | j �rt d �|��| d < |d u�r$t�t |dd��}|dv�rBt�t |dd��}n"|dv�r`t�t |dd��}nd }ddg}d }d}t |dd�}|d u�r�t|�D ]2\}}|�|�}|�r�||d< |}| �r� �qƐq�|d u�rt|�D ]8\}}t |dd�|v }|�r�||d< |}| �r� �q�q�|�s�t|�D ]v\}}||�d�k�rF||d< d}nN|d u�r |�|��r |�rz|d |d< | �rz �q�|�r ||d< | �r �q��q d}d}t tjdd�} |d dk�rr| �r�|�r�|�|�} n|} | �| ��s�| | 7 } |||fdk�rH|�sH|�r�|dk�r�|�r>|d dd � dv�r>|d | |d< t|�|d k�r�||d d �d�|k�r�|�|| � d}d}n4||d �d�|k�rF|�|d || � d}d}n�|�rn|dk�rn|d dk�r||d �d�|k�rF|�|d || � d}d}n8||d d �d�|k�rn|�|d || � d}d}n&||d | k�r�| ||d < d}d}�n<| �r|�n2|dk�s�|dk�r�|�d|| � d}d}�n|dk�s�|d dk�r|�r�|d dd � dv�r�|�| � |�|| � d}d}n�|�r�|d dk�r�t|�|d k�r\||d d �d�|k�r�|�|| � d}d}n4|||d �d �k�r�|�|d || � d}d}n |�|d || � d}d}| j �r�t d �|��| d < d} |�r| j�s|�r�tj�| ��r�| �|�} t| ||� | j�r,tj�| ��s,| j ||| | d � i } t | ||| �\}}d | | d < d | | d!< | | g} | j ||| | d � d S )"N� � %s (content)��before�after� before_header� after_headerr r i z Destination %s does not exist !�r r zError creating %s (%s)r �rb� r- )N�BOF�EOF)Nr4 ���Fr � T� �NNNr5 )� � z line addedr4 z line replaceds r. )r' r �backupr& �%s (file attributes)r/ r0 ) r r r �existsr �dirname� check_mode�makedirs� Exceptionr �open� readlines�_diffr �join�re�compile� enumerate�search�rstrip�linesep�expand�endswith�len�append�insert� backup_localr% � exit_jsonr) )!r r �regexp� search_string�line� insertafter� insertbefore�creater< �backrefs� firstmatchr& �b_destZ b_destpath�er r Zbre_mZbre_ins�index�matchZexact_line_match�b_line�lineno� b_cur_line� match_foundr r' Z b_linesepZ b_new_line� backupdest� attr_diff�difflistr# r# r$ �present( s � 2 & rg c s� t |dd�}tj�|�s&| jddd� d}ddd| d| d�}t|d ��} | �� } W d � n1 sh0 Y | jr�td � | ��|d < �d ur�t � t �dd���g �t |dd�� � ����fd d ���fdd�| D �} t ��dk} | jr�td � | ��|d< d} | �r,| j �s,|�r | �|�} t| | |� | �r>dt �� }i } t| | || �\}} d| | d< d| | d< || g}| j| t ��|| |d� d S )Nr r Fzfile not present)r' r r* r+ r, r2 r3 r- c sP �d ur�� | �}n(�d ur.t�dd�| v }n� | �d�k}|rJ��| � | S )Nr r r7 )rJ r rK rP )rb rc )r` �bre_c�foundrT rU r# r$ �matcher s zabsent.<locals>.matcherc s g | ]}� |�r|�qS r# r# )�.0�l)rj r# r$ � <listcomp> r3 zabsent.<locals>.<listcomp>r r. z%s line(s) removedr= r/ r0 )r' ri r r< r& )r r r r> rS rC rD rE r rF rG rH rO r@ rR r% r) )r r rT rU rV r< r\ r r& r r r' rd re rf r# )r` rh ri rj rT rU r$ �absent� sF � & rn c C s t ttddg d�d�tddddgd�tdd gd �tdd �tdd gd �tdd �tdd �td dd�td dd�td dd�td dd�tdd �d� ddgddgddggddd�} | j}|d }|d }|d }|d }|d }|d }|d }|d } d||fv �r&d } d } |dk�rd } | d 7 } | �| | � t|d d!�} tj�| ��rR| jd"d#| d$� |d% dk�r�|�r||d u �r|| jd&d'� | d u �r�| jd(d'� |d |d } }| d u �r�|d u �r�d)}t | |||| || ||||� n.||| fd*k�r�| jd+d'� t | |||| |� d S ),Nr T)r Zdestfile�name)�type�required�aliases�strrg rn )rp �default�choicesZregex)rp rr )rp �value�boolF)rp rt ) r �staterT rU rV rW rX rZ rY r< r[ r rX rW rT rU rZ )Z argument_specZmutually_exclusiveZadd_file_common_argsZsupports_check_moderY r< r[ rV r* z�The %s is an empty string, which will match every line in the file. This may have unintended consequences, such as replacing the last line in the file rather than appending.z search stringzregular expressionzT If this is desired, use '^' to match every line in the file and avoid this warning.r r � zPath %s is a directory !r1 rx z%regexp is required with backrefs=truer z#line is required with state=presentr5 r9 zCone of line, search_string, or regexp is required with state=absent) r �dictr �warnr r r �isdirr rg rn )r r rY r< rZ r r[ rT rU rV r Z param_name�b_pathZins_befZins_aftr# r# r$ �main: sj ��� � r~ �__main__)Z __future__r r r rp Z __metaclass__Z DOCUMENTATIONZEXAMPLESZRETURNr rG r Zansible.module_utils.basicr Zansible.module_utils._textr r r r% r) rg rn r~ �__name__r# r# r# r$ �<module> s$ U V=C