242 lines
10 KiB
Python
242 lines
10 KiB
Python
# (c) 2015, Michael DeHaan <michael.dehaan@gmail.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import datetime
|
|
import os
|
|
import pwd
|
|
import time
|
|
|
|
from ansible import constants as C
|
|
from ansible.errors import AnsibleError
|
|
from ansible.module_utils.six import string_types
|
|
from ansible.module_utils._text import to_bytes, to_native, to_text
|
|
from ansible.plugins.action import ActionBase
|
|
from ansible.utils.hashing import checksum_s
|
|
|
|
boolean = C.mk_boolean
|
|
|
|
class ActionModule(ActionBase):
|
|
|
|
TRANSFERS_FILES = True
|
|
DEFAULT_NEWLINE_SEQUENCE = "\n"
|
|
|
|
def get_checksum(self, dest, all_vars, try_directory=False, source=None, tmp=None):
|
|
try:
|
|
dest_stat = self._execute_remote_stat(dest, all_vars=all_vars, follow=False, tmp=tmp)
|
|
|
|
if dest_stat['exists'] and dest_stat['isdir'] and try_directory and source:
|
|
base = os.path.basename(source)
|
|
dest = os.path.join(dest, base)
|
|
dest_stat = self._execute_remote_stat(dest, all_vars=all_vars, follow=False, tmp=tmp)
|
|
|
|
except AnsibleError as e:
|
|
return dict(failed=True, msg=to_native(e))
|
|
|
|
return dest_stat['checksum']
|
|
|
|
def run(self, tmp=None, task_vars=None):
|
|
''' handler for template operations '''
|
|
|
|
if task_vars is None:
|
|
task_vars = dict()
|
|
|
|
result = super(ActionModule, self).run(tmp, task_vars)
|
|
|
|
source = self._task.args.get('src', None)
|
|
dest = self._task.args.get('dest', None)
|
|
force = boolean(self._task.args.get('force', True))
|
|
state = self._task.args.get('state', None)
|
|
newline_sequence = self._task.args.get('newline_sequence', self.DEFAULT_NEWLINE_SEQUENCE)
|
|
variable_start_string = self._task.args.get('variable_start_string', None)
|
|
variable_end_string = self._task.args.get('variable_end_string', None)
|
|
block_start_string = self._task.args.get('block_start_string', None)
|
|
block_end_string = self._task.args.get('block_end_string', None)
|
|
trim_blocks = self._task.args.get('trim_blocks', None)
|
|
|
|
wrong_sequences = ["\\n", "\\r", "\\r\\n"]
|
|
allowed_sequences = ["\n", "\r", "\r\n"]
|
|
|
|
# We need to convert unescaped sequences to proper escaped sequences for Jinja2
|
|
if newline_sequence in wrong_sequences:
|
|
newline_sequence = allowed_sequences[wrong_sequences.index(newline_sequence)]
|
|
|
|
if state is not None:
|
|
result['failed'] = True
|
|
result['msg'] = "'state' cannot be specified on a template"
|
|
elif source is None or dest is None:
|
|
result['failed'] = True
|
|
result['msg'] = "src and dest are required"
|
|
elif newline_sequence not in allowed_sequences:
|
|
result['failed'] = True
|
|
result['msg'] = "newline_sequence needs to be one of: \n, \r or \r\n"
|
|
else:
|
|
try:
|
|
source = self._find_needle('templates', source)
|
|
except AnsibleError as e:
|
|
result['failed'] = True
|
|
result['msg'] = to_native(e)
|
|
|
|
if 'failed' in result:
|
|
return result
|
|
|
|
# Expand any user home dir specification
|
|
dest = self._remote_expand_user(dest)
|
|
|
|
directory_prepended = False
|
|
if dest.endswith(os.sep):
|
|
directory_prepended = True
|
|
base = os.path.basename(source)
|
|
dest = os.path.join(dest, base)
|
|
|
|
# template the source data locally & get ready to transfer
|
|
b_source = to_bytes(source)
|
|
try:
|
|
with open(b_source, 'r') as f:
|
|
template_data = to_text(f.read())
|
|
|
|
try:
|
|
template_uid = pwd.getpwuid(os.stat(b_source).st_uid).pw_name
|
|
except:
|
|
template_uid = os.stat(b_source).st_uid
|
|
|
|
temp_vars = task_vars.copy()
|
|
temp_vars['template_host'] = os.uname()[1]
|
|
temp_vars['template_path'] = source
|
|
temp_vars['template_mtime'] = datetime.datetime.fromtimestamp(os.path.getmtime(b_source))
|
|
temp_vars['template_uid'] = template_uid
|
|
temp_vars['template_fullpath'] = os.path.abspath(source)
|
|
temp_vars['template_run_date'] = datetime.datetime.now()
|
|
|
|
managed_default = C.DEFAULT_MANAGED_STR
|
|
managed_str = managed_default.format(
|
|
host = temp_vars['template_host'],
|
|
uid = temp_vars['template_uid'],
|
|
file = to_bytes(temp_vars['template_path'])
|
|
)
|
|
temp_vars['ansible_managed'] = time.strftime(
|
|
managed_str,
|
|
time.localtime(os.path.getmtime(b_source))
|
|
)
|
|
|
|
searchpath = []
|
|
# set jinja2 internal search path for includes
|
|
if 'ansible_search_path' in task_vars:
|
|
searchpath = task_vars['ansible_search_path']
|
|
# our search paths aren't actually the proper ones for jinja includes.
|
|
|
|
searchpath.extend([self._loader._basedir, os.path.dirname(source)])
|
|
|
|
# We want to search into the 'templates' subdir of each search path in
|
|
# addition to our original search paths.
|
|
newsearchpath = []
|
|
for p in searchpath:
|
|
newsearchpath.append(os.path.join(p, 'templates'))
|
|
newsearchpath.append(p)
|
|
searchpath = newsearchpath
|
|
|
|
self._templar.environment.loader.searchpath = searchpath
|
|
self._templar.environment.newline_sequence = newline_sequence
|
|
if block_start_string is not None:
|
|
self._templar.environment.block_start_string = block_start_string
|
|
if block_end_string is not None:
|
|
self._templar.environment.block_end_string = block_end_string
|
|
if variable_start_string is not None:
|
|
self._templar.environment.variable_start_string = variable_start_string
|
|
if variable_end_string is not None:
|
|
self._templar.environment.variable_end_string = variable_end_string
|
|
if trim_blocks is not None:
|
|
self._templar.environment.trim_blocks = bool(trim_blocks)
|
|
|
|
old_vars = self._templar._available_variables
|
|
self._templar.set_available_variables(temp_vars)
|
|
resultant = self._templar.do_template(template_data, preserve_trailing_newlines=True, escape_backslashes=False)
|
|
self._templar.set_available_variables(old_vars)
|
|
except Exception as e:
|
|
result['failed'] = True
|
|
result['msg'] = type(e).__name__ + ": " + str(e)
|
|
return result
|
|
|
|
if not tmp:
|
|
tmp = self._make_tmp_path()
|
|
|
|
local_checksum = checksum_s(resultant)
|
|
remote_checksum = self.get_checksum(dest, task_vars, not directory_prepended, source=source, tmp=tmp)
|
|
if isinstance(remote_checksum, dict):
|
|
# Error from remote_checksum is a dict. Valid return is a str
|
|
result.update(remote_checksum)
|
|
return result
|
|
|
|
diff = {}
|
|
new_module_args = self._task.args.copy()
|
|
|
|
# remove newline_sequence from standard arguments
|
|
new_module_args.pop('newline_sequence', None)
|
|
new_module_args.pop('block_start_string', None)
|
|
new_module_args.pop('block_end_string', None)
|
|
new_module_args.pop('variable_start_string', None)
|
|
new_module_args.pop('variable_end_string', None)
|
|
new_module_args.pop('trim_blocks', None)
|
|
|
|
if (remote_checksum == '1') or (force and local_checksum != remote_checksum):
|
|
|
|
result['changed'] = True
|
|
# if showing diffs, we need to get the remote value
|
|
if self._play_context.diff:
|
|
diff = self._get_diff_data(dest, resultant, task_vars, source_file=False)
|
|
|
|
if not self._play_context.check_mode: # do actual work through copy
|
|
xfered = self._transfer_data(self._connection._shell.join_path(tmp, 'source'), resultant)
|
|
|
|
# fix file permissions when the copy is done as a different user
|
|
self._fixup_perms2((tmp, xfered))
|
|
|
|
# run the copy module
|
|
new_module_args.update(
|
|
dict(
|
|
src=xfered,
|
|
dest=dest,
|
|
original_basename=os.path.basename(source),
|
|
follow=True,
|
|
),
|
|
)
|
|
result.update(self._execute_module(module_name='copy', module_args=new_module_args, task_vars=task_vars, tmp=tmp, delete_remote_tmp=False))
|
|
|
|
if result.get('changed', False) and self._play_context.diff:
|
|
result['diff'] = diff
|
|
|
|
else:
|
|
# when running the file module based on the template data, we do
|
|
# not want the source filename (the name of the template) to be used,
|
|
# since this would mess up links, so we clear the src param and tell
|
|
# the module to follow links. When doing that, we have to set
|
|
# original_basename to the template just in case the dest is
|
|
# a directory.
|
|
new_module_args.update(
|
|
dict(
|
|
src=None,
|
|
original_basename=os.path.basename(source),
|
|
follow=True,
|
|
),
|
|
)
|
|
result.update(self._execute_module(module_name='file', module_args=new_module_args, task_vars=task_vars, tmp=tmp, delete_remote_tmp=False))
|
|
|
|
self._remove_tmp_path(tmp)
|
|
|
|
return result
|