mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 19:31:26 -07:00
We couldn't copy to_unicode, to_bytes, to_str into module_utils because of licensing. So once created it we had two sets of functions that did the same things but had different implementations. To remedy that, this change removes the ansible.utils.unicode versions of those functions.
67 lines
2.6 KiB
Python
67 lines
2.6 KiB
Python
# (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/>.
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
from errno import EEXIST
|
|
from ansible.errors import AnsibleError
|
|
from ansible.module_utils._text import to_bytes, to_native, to_text
|
|
|
|
|
|
__all__ = ['unfrackpath', 'makedirs_safe']
|
|
|
|
|
|
def unfrackpath(path):
|
|
'''
|
|
Returns a path that is free of symlinks, environment
|
|
variables, relative path traversals and symbols (~)
|
|
|
|
:arg path: A byte or text string representing a path to be canonicalized
|
|
:raises UnicodeDecodeError: If the canonicalized version of the path
|
|
contains non-utf8 byte sequences.
|
|
:rtype: A text string (unicode on pyyhon2, str on python3).
|
|
:returns: An absolute path with symlinks, environment variables, and tilde
|
|
expanded. Note that this does not check whether a path exists.
|
|
|
|
example::
|
|
'$HOME/../../var/mail' becomes '/var/spool/mail'
|
|
'''
|
|
canonical_path = os.path.normpath(os.path.realpath(os.path.expanduser(os.path.expandvars(to_bytes(path, errors='surrogate_or_strict')))))
|
|
return to_text(canonical_path, errors='surrogate_or_strict')
|
|
|
|
|
|
def makedirs_safe(path, mode=None):
|
|
'''Safe way to create dirs in muliprocess/thread environments.
|
|
|
|
:arg path: A byte or text string representing a directory to be created
|
|
:kwarg mode: If given, the mode to set the directory to
|
|
:raises AnsibleError: If the directory cannot be created and does not already exists.
|
|
:raises UnicodeDecodeError: if the path is not decodable in the utf-8 encoding.
|
|
'''
|
|
|
|
rpath = unfrackpath(path)
|
|
b_rpath = to_bytes(rpath)
|
|
if not os.path.exists(b_rpath):
|
|
try:
|
|
if mode:
|
|
os.makedirs(b_rpath, mode)
|
|
else:
|
|
os.makedirs(b_rpath)
|
|
except OSError as e:
|
|
if e.errno != EEXIST:
|
|
raise AnsibleError("Unable to create local directories(%s): %s" % (to_native(rpath), to_native(e)))
|