Making the switch to v2

1 files changed, 173 insertions, 0 deletions

diff --git a/v1/ansible/runner/action_plugins/fetch.py b/v1/ansible/runner/action_plugins/fetch.py
new file mode 100644
index 0000000000..27d2f6b3c6
--- /dev/null
+++ b/v1/ansible/runner/action_plugins/fetch.py
@@ -0,0 +1,173 @@
+# (c) 2012-2014, 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/>.
+
+import os
+import pwd
+import random
+import traceback
+import tempfile
+import base64
+
+import ansible.constants as C
+from ansible import utils
+from ansible import errors
+from ansible import module_common
+from ansible.runner.return_data import ReturnData
+
+class ActionModule(object):
+
+    def __init__(self, runner):
+        self.runner = runner
+
+    def run(self, conn, tmp, module_name, module_args, inject, complex_args=None, **kwargs):
+        ''' handler for fetch operations '''
+
+        if self.runner.noop_on_check(inject):
+            return ReturnData(conn=conn, comm_ok=True, result=dict(skipped=True, msg='check mode not (yet) supported for this module'))
+
+        # load up options
+        options = {}
+        if complex_args:
+            options.update(complex_args)
+        options.update(utils.parse_kv(module_args))
+        source = options.get('src', None)
+        dest = options.get('dest', None)
+        flat = options.get('flat', False)
+        flat = utils.boolean(flat)
+        fail_on_missing = options.get('fail_on_missing', False)
+        fail_on_missing = utils.boolean(fail_on_missing)
+        validate_checksum = options.get('validate_checksum', None)
+        if validate_checksum is not None:
+            validate_checksum = utils.boolean(validate_checksum)
+        # Alias for validate_checksum (old way of specifying it)
+        validate_md5 = options.get('validate_md5', None)
+        if validate_md5 is not None:
+            validate_md5 = utils.boolean(validate_md5)
+        if validate_md5 is None and validate_checksum is None:
+            # Default
+            validate_checksum = True
+        elif validate_checksum is None:
+            validate_checksum = validate_md5
+        elif validate_md5 is not None and validate_checksum is not None:
+            results = dict(failed=True, msg="validate_checksum and validate_md5 cannot both be specified")
+            return ReturnData(conn, result=results)
+
+        if source is None or dest is None:
+            results = dict(failed=True, msg="src and dest are required")
+            return ReturnData(conn=conn, result=results)
+
+        source = conn.shell.join_path(source)
+        source = self.runner._remote_expand_user(conn, source, tmp)
+
+        # calculate checksum for the remote file
+        remote_checksum = self.runner._remote_checksum(conn, tmp, source, inject)
+
+        # use slurp if sudo and permissions are lacking
+        remote_data = None
+        if remote_checksum in ('1', '2') or self.runner.become:
+            slurpres = self.runner._execute_module(conn, tmp, 'slurp', 'src=%s' % source, inject=inject)
+            if slurpres.is_successful():
+                if slurpres.result['encoding'] == 'base64':
+                    remote_data = base64.b64decode(slurpres.result['content'])
+                if remote_data is not None:
+                    remote_checksum = utils.checksum_s(remote_data)
+                # the source path may have been expanded on the
+                # target system, so we compare it here and use the
+                # expanded version if it's different
+                remote_source = slurpres.result.get('source')
+                if remote_source and remote_source != source:
+                    source = remote_source
+
+        # calculate the destination name
+        if os.path.sep not in conn.shell.join_path('a', ''):
+            source_local = source.replace('\\', '/')
+        else:
+            source_local = source
+
+        dest = os.path.expanduser(dest)
+        if flat:
+            if dest.endswith("/"):
+                # if the path ends with "/", we'll use the source filename as the
+                # destination filename
+                base = os.path.basename(source_local)
+                dest = os.path.join(dest, base)
+            if not dest.startswith("/"):
+                # if dest does not start with "/", we'll assume a relative path
+                dest = utils.path_dwim(self.runner.basedir, dest)
+        else:
+            # files are saved in dest dir, with a subdir for each host, then the filename
+            dest = "%s/%s/%s" % (utils.path_dwim(self.runner.basedir, dest), inject['inventory_hostname'], source_local)
+
+        dest = dest.replace("//","/")
+
+        if remote_checksum in ('0', '1', '2', '3', '4'):
+            # these don't fail because you may want to transfer a log file that possibly MAY exist
+            # but keep going to fetch other log files
+            if remote_checksum == '0':
+                result = dict(msg="unable to calculate the checksum of the remote file", file=source, changed=False)
+            elif remote_checksum == '1':
+                if fail_on_missing:
+                    result = dict(failed=True, msg="the remote file does not exist", file=source)
+                else:
+                    result = dict(msg="the remote file does not exist, not transferring, ignored", file=source, changed=False)
+            elif remote_checksum == '2':
+                result = dict(msg="no read permission on remote file, not transferring, ignored", file=source, changed=False)
+            elif remote_checksum == '3':
+                result = dict(msg="remote file is a directory, fetch cannot work on directories", file=source, changed=False)
+            elif remote_checksum == '4':
+                result = dict(msg="python isn't present on the system.  Unable to compute checksum", file=source, changed=False)
+            return ReturnData(conn=conn, result=result)
+
+        # calculate checksum for the local file
+        local_checksum = utils.checksum(dest)
+
+        if remote_checksum != local_checksum:
+            # create the containing directories, if needed
+            if not os.path.isdir(os.path.dirname(dest)):
+                os.makedirs(os.path.dirname(dest))
+
+            # fetch the file and check for changes
+            if remote_data is None:
+                conn.fetch_file(source, dest)
+            else:
+                f = open(dest, 'w')
+                f.write(remote_data)
+                f.close()
+            new_checksum = utils.secure_hash(dest)
+            # For backwards compatibility.  We'll return None on FIPS enabled
+            # systems
+            try:
+                new_md5 = utils.md5(dest)
+            except ValueError:
+                new_md5 = None
+
+            if validate_checksum and new_checksum != remote_checksum:
+                result = dict(failed=True, md5sum=new_md5, msg="checksum mismatch", file=source, dest=dest, remote_md5sum=None, checksum=new_checksum, remote_checksum=remote_checksum)
+                return ReturnData(conn=conn, result=result)
+            result = dict(changed=True, md5sum=new_md5, dest=dest, remote_md5sum=None, checksum=new_checksum, remote_checksum=remote_checksum)
+            return ReturnData(conn=conn, result=result)
+        else:
+            # For backwards compatibility.  We'll return None on FIPS enabled
+            # systems
+            try:
+                local_md5 = utils.md5(dest)
+            except ValueError:
+                local_md5 = None
+
+            result = dict(changed=False, md5sum=local_md5, file=source, dest=dest, checksum=local_checksum)
+            return ReturnData(conn=conn, result=result)
+