184 lines
7.9 KiB
Python
184 lines
7.9 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 os
|
|
import shutil
|
|
import tempfile
|
|
|
|
from ansible import constants as C
|
|
from ansible.errors import AnsibleError, AnsibleFileNotFound
|
|
from ansible.module_utils._text import to_bytes, to_text
|
|
from ansible.module_utils.parsing.convert_bool import boolean
|
|
from ansible.plugins.action import ActionBase
|
|
from ansible.template import generate_ansible_template_vars
|
|
from ansible.utils.hashing import checksum_s
|
|
|
|
|
|
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_text(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), strict=False)
|
|
follow = boolean(self._task.args.get('follow', False), strict=False)
|
|
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_text(e)
|
|
|
|
if 'failed' in result:
|
|
return result
|
|
|
|
# Get vault decrypted tmp file
|
|
try:
|
|
tmp_source = self._loader.get_real_file(source)
|
|
except AnsibleFileNotFound as e:
|
|
result['failed'] = True
|
|
result['msg'] = "could not find src=%s, %s" % (source, e)
|
|
self._remove_tmp_path(tmp)
|
|
return result
|
|
|
|
# template the source data locally & get ready to transfer
|
|
try:
|
|
with open(tmp_source, 'r') as f:
|
|
template_data = to_text(f.read())
|
|
|
|
# set jinja2 internal search path for includes
|
|
searchpath = task_vars.get('ansible_search_path', [])
|
|
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)
|
|
|
|
# add ansible 'template' vars
|
|
temp_vars = task_vars.copy()
|
|
temp_vars.update(generate_ansible_template_vars(source))
|
|
|
|
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'] = "%s: %s" % (type(e).__name__, to_text(e))
|
|
return result
|
|
finally:
|
|
self._loader.cleanup_tmp_file(tmp_source)
|
|
|
|
new_task = self._task.copy()
|
|
new_task.args.pop('newline_sequence', None)
|
|
new_task.args.pop('block_start_string', None)
|
|
new_task.args.pop('block_end_string', None)
|
|
new_task.args.pop('variable_start_string', None)
|
|
new_task.args.pop('variable_end_string', None)
|
|
new_task.args.pop('trim_blocks', None)
|
|
try:
|
|
tempdir = tempfile.mkdtemp()
|
|
result_file = os.path.join(tempdir, os.path.basename(source))
|
|
with open(result_file, 'wb') as f:
|
|
f.write(to_bytes(resultant, errors='surrogate_or_strict'))
|
|
|
|
new_task.args.update(
|
|
dict(
|
|
src=result_file,
|
|
dest=dest,
|
|
follow=follow,
|
|
),
|
|
)
|
|
copy_action = self._shared_loader_obj.action_loader.get('copy',
|
|
task=new_task,
|
|
connection=self._connection,
|
|
play_context=self._play_context,
|
|
loader=self._loader,
|
|
templar=self._templar,
|
|
shared_loader_obj=self._shared_loader_obj)
|
|
result.update(copy_action.run(task_vars=task_vars))
|
|
finally:
|
|
shutil.rmtree(tempdir)
|
|
|
|
return result
|