/brz/remove-bazaar

# Copyright (C) 2005-2011 Canonical Ltd

#

# This program 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 2 of the License, or

# (at your option) any later version.

#

# This program 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 this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

import errno

import os

import re

import stat

import sys

import time

import codecs

from .lazy_import import lazy_import

lazy_import(globals(), """

from datetime import datetime

import getpass

import locale

import ntpath

import posixpath

import select

# We need to import both shutil and rmtree as we export the later on posix

# and need the former on windows

import shutil

from shutil import rmtree

import socket

import subprocess

# We need to import both tempfile and mkdtemp as we export the later on posix

# and need the former on windows

import tempfile

from tempfile import mkdtemp

import unicodedata

from breezy import (

    config,

    trace,

    win32utils,

    )

from breezy.i18n import gettext

""")

from hashlib import (

    md5,

    sha1 as sha,

    )

import breezy

from . import (

    _fs_enc,

    errors,

    )

# On win32, O_BINARY is used to indicate the file should

# be opened in binary mode, rather than text mode.

# On other platforms, O_BINARY doesn't exist, because

# they always open in binary mode, so it is okay to

# OR with 0 on those platforms.

# O_NOINHERIT and O_TEXT exists only on win32 too.

O_BINARY = getattr(os, 'O_BINARY', 0)

O_TEXT = getattr(os, 'O_TEXT', 0)

O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)

class UnsupportedTimezoneFormat(errors.BzrError):

    _fmt = ('Unsupported timezone format "%(timezone)s", '

            'options are "utc", "original", "local".')

    def __init__(self, timezone):

        self.timezone = timezone

def get_unicode_argv():

    return sys.argv[1:]

def make_readonly(filename):

    """Make a filename read-only."""

    mod = os.lstat(filename).st_mode

    if not stat.S_ISLNK(mod):

        mod = mod & 0o777555

        chmod_if_possible(filename, mod)

def make_writable(filename):

    mod = os.lstat(filename).st_mode

    if not stat.S_ISLNK(mod):

        mod = mod | 0o200

        chmod_if_possible(filename, mod)

def chmod_if_possible(filename, mode):

    # Set file mode if that can be safely done.

    # Sometimes even on unix the filesystem won't allow it - see

    # https://bugs.launchpad.net/bzr/+bug/606537

    try:

        # It is probably faster to just do the chmod, rather than

        # doing a stat, and then trying to compare

        os.chmod(filename, mode)

    except (IOError, OSError) as e:

        # Permission/access denied seems to commonly happen on smbfs; there's

        # probably no point warning about it.

        # <https://bugs.launchpad.net/bzr/+bug/606537>

        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):

            trace.mutter("ignore error on chmod of %r: %r" % (

                filename, e))

            return

        raise

def minimum_path_selection(paths):

    """Return the smallset subset of paths which are outside paths.

    :param paths: A container (and hence not None) of paths.

    :return: A set of paths sufficient to include everything in paths via

        is_inside, drawn from the paths parameter.

    """

    if len(paths) < 2:

        return set(paths)

    def sort_key(path):

        if isinstance(path, bytes):

            return path.split(b'/')

        else:

            return path.split('/')

    sorted_paths = sorted(list(paths), key=sort_key)

    search_paths = [sorted_paths[0]]

    for path in sorted_paths[1:]:

        if not is_inside(search_paths[-1], path):

            # This path is unique, add it

            search_paths.append(path)

    return set(search_paths)

_QUOTE_RE = None

def quotefn(f):

    """Return a quoted filename filename

    This previously used backslash quoting, but that works poorly on

    Windows."""

    # TODO: I'm not really sure this is the best format either.x

    global _QUOTE_RE

    if _QUOTE_RE is None:

        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')

    if _QUOTE_RE.search(f):

        return '"' + f + '"'

    else:

        return f

_directory_kind = 'directory'

def get_umask():

    """Return the current umask"""

    # Assume that people aren't messing with the umask while running

    # XXX: This is not thread safe, but there is no way to get the

    #      umask without setting it

    umask = os.umask(0)

    os.umask(umask)

    return umask

_kind_marker_map = {

    "file": "",

    _directory_kind: "/",

    "symlink": "@",

    'tree-reference': '+',

}

def kind_marker(kind):

    try:

        return _kind_marker_map[kind]

    except KeyError:

        # Slightly faster than using .get(, '') when the common case is that

        # kind will be found

        return ''

lexists = getattr(os.path, 'lexists', None)

if lexists is None:

    def lexists(f):

        try:

            stat = getattr(os, 'lstat', os.stat)

            stat(f)

            return True

        except OSError as e:

            if e.errno == errno.ENOENT:

                return False

            else:

                raise errors.BzrError(

                    gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))

def fancy_rename(old, new, rename_func, unlink_func):

    """A fancy rename, when you don't have atomic rename.

    :param old: The old path, to rename from

    :param new: The new path, to rename to

    :param rename_func: The potentially non-atomic rename function

    :param unlink_func: A way to delete the target file if the full rename

        succeeds

    """

    # sftp rename doesn't allow overwriting, so play tricks:

    base = os.path.basename(new)

    dirname = os.path.dirname(new)

    # callers use different encodings for the paths so the following MUST

    # respect that. We rely on python upcasting to unicode if new is unicode

    # and keeping a str if not.

    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),

                                      os.getpid(), rand_chars(10))

    tmp_name = pathjoin(dirname, tmp_name)

    # Rename the file out of the way, but keep track if it didn't exist

    # We don't want to grab just any exception

    # something like EACCES should prevent us from continuing

    # The downside is that the rename_func has to throw an exception

    # with an errno = ENOENT, or NoSuchFile

    file_existed = False

    try:

        rename_func(new, tmp_name)

    except (errors.NoSuchFile,):

        pass

    except IOError as e:

        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename

        # function raises an IOError with errno is None when a rename fails.

        # This then gets caught here.

        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):

            raise

    except Exception as e:

        if (getattr(e, 'errno', None) is None

                or e.errno not in (errno.ENOENT, errno.ENOTDIR)):

            raise

    else:

        file_existed = True

    success = False

    try:

        # This may throw an exception, in which case success will

        # not be set.

        rename_func(old, new)

        success = True

    except (IOError, OSError) as e:

        # source and target may be aliases of each other (e.g. on a

        # case-insensitive filesystem), so we may have accidentally renamed

        # source by when we tried to rename target

        if (file_existed and e.errno in (None, errno.ENOENT)

                and old.lower() == new.lower()):

            # source and target are the same file on a case-insensitive

            # filesystem, so we don't generate an exception

            pass

        else:

            raise

    finally:

        if file_existed:

            # If the file used to exist, rename it back into place

            # otherwise just delete it from the tmp location

            if success:

                unlink_func(tmp_name)

            else:

                rename_func(tmp_name, new)

# In Python 2.4.2 and older, os.path.abspath and os.path.realpath

# choke on a Unicode string containing a relative path if

# os.getcwd() returns a non-sys.getdefaultencoding()-encoded

# string.

def _posix_abspath(path):

    # jam 20060426 rather than encoding to fsencoding

    # copy posixpath.abspath, but use os.getcwdu instead

    if not posixpath.isabs(path):

        path = posixpath.join(getcwd(), path)

    return _posix_normpath(path)

def _posix_realpath(path):

    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)

def _posix_normpath(path):

    path = posixpath.normpath(path)

    # Bug 861008: posixpath.normpath() returns a path normalized according to

    # the POSIX standard, which stipulates (for compatibility reasons) that two

    # leading slashes must not be simplified to one, and only if there are 3 or

    # more should they be simplified as one. So we treat the leading 2 slashes

    # as a special case here by simply removing the first slash, as we consider

    # that breaking POSIX compatibility for this obscure feature is acceptable.

    # This is not a paranoid precaution, as we notably get paths like this when

    # the repo is hosted at the root of the filesystem, i.e. in "/".

    if path.startswith('//'):

        path = path[1:]

    return path

def _posix_path_from_environ(key):

    """Get unicode path from `key` in environment or None if not present

    Note that posix systems use arbitrary byte strings for filesystem objects,

    so a path that raises BadFilenameEncoding here may still be accessible.

    """

    return os.environ.get(key, None)

def _posix_get_home_dir():

    """Get the home directory of the current user as a unicode path"""

    path = posixpath.expanduser("~")

    try:

        return path.decode(_fs_enc)

    except AttributeError:

        return path

    except UnicodeDecodeError:

        raise errors.BadFilenameEncoding(path, _fs_enc)

def _posix_getuser_unicode():

    """Get username from environment or password database as unicode"""

    return getpass.getuser()

def _win32_fixdrive(path):

    """Force drive letters to be consistent.

    win32 is inconsistent whether it returns lower or upper case

    and even if it was consistent the user might type the other

    so we force it to uppercase

    running python.exe under cmd.exe return capital C:\\

    running win32 python inside a cygwin shell returns lowercase c:\\

    """

    drive, path = ntpath.splitdrive(path)

    return drive.upper() + path

def _win32_abspath(path):

    # Real ntpath.abspath doesn't have a problem with a unicode cwd

    return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))

def _win32_realpath(path):

    # Real ntpath.realpath doesn't have a problem with a unicode cwd

    return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))

def _win32_pathjoin(*args):

    return ntpath.join(*args).replace('\\', '/')

def _win32_normpath(path):

    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))

def _win32_getcwd():

    return _win32_fixdrive(_getcwd().replace('\\', '/'))

def _win32_mkdtemp(*args, **kwargs):

    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))

def _win32_rename(old, new):

    """We expect to be able to atomically replace 'new' with old.

    On win32, if new exists, it must be moved out of the way first,

    and then deleted.

    """

    try:

        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)

    except OSError as e:

        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):

            # If we try to rename a non-existant file onto cwd, we get

            # EPERM or EACCES instead of ENOENT, this will raise ENOENT

            # if the old path doesn't exist, sometimes we get EACCES

            # On Linux, we seem to get EBUSY, on Mac we get EINVAL

            os.lstat(old)

        raise

def _mac_getcwd():

    return unicodedata.normalize('NFC', _getcwd())

def _rename_wrap_exception(rename_func):

    """Adds extra information to any exceptions that come from rename().

    The exception has an updated message and 'old_filename' and 'new_filename'

    attributes.

    """

    def _rename_wrapper(old, new):

        try:

            rename_func(old, new)

        except OSError as e:

            detailed_error = OSError(e.errno, e.strerror +

                                     " [occurred when renaming '%s' to '%s']" %

                                     (old, new))

            detailed_error.old_filename = old

            detailed_error.new_filename = new

            raise detailed_error

    return _rename_wrapper

_getcwd = os.getcwd

# Default rename wraps os.rename()

rename = _rename_wrap_exception(os.rename)

# Default is to just use the python builtins, but these can be rebound on

# particular platforms.

abspath = _posix_abspath

realpath = _posix_realpath

pathjoin = os.path.join

normpath = _posix_normpath

path_from_environ = _posix_path_from_environ

_get_home_dir = _posix_get_home_dir

getuser_unicode = _posix_getuser_unicode

getcwd = _getcwd

dirname = os.path.dirname

basename = os.path.basename

split = os.path.split

splitext = os.path.splitext

# These were already lazily imported into local scope

# mkdtemp = tempfile.mkdtemp

# rmtree = shutil.rmtree

lstat = os.lstat

fstat = os.fstat

def wrap_stat(st):

    return st

MIN_ABS_PATHLENGTH = 1

if sys.platform == 'win32':

    abspath = _win32_abspath

    realpath = _win32_realpath

    pathjoin = _win32_pathjoin

    normpath = _win32_normpath

    getcwd = _win32_getcwd

    mkdtemp = _win32_mkdtemp

    rename = _rename_wrap_exception(_win32_rename)

    try:

        from . import _walkdirs_win32

    except ImportError:

        pass

    else:

        lstat = _walkdirs_win32.lstat

        fstat = _walkdirs_win32.fstat

        wrap_stat = _walkdirs_win32.wrap_stat

    MIN_ABS_PATHLENGTH = 3

    def _win32_delete_readonly(function, path, excinfo):

        """Error handler for shutil.rmtree function [for win32]

        Helps to remove files and dirs marked as read-only.

        """

        exception = excinfo[1]

        if function in (os.remove, os.rmdir) \

                and isinstance(exception, OSError) \

                and exception.errno == errno.EACCES:

            make_writable(path)

            function(path)

        else:

            raise

    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):

        """Replacer for shutil.rmtree: could remove readonly dirs/files"""

        return shutil.rmtree(path, ignore_errors, onerror)

    get_unicode_argv = getattr(win32utils, 'get_unicode_argv', get_unicode_argv)

    path_from_environ = win32utils.get_environ_unicode

    _get_home_dir = win32utils.get_home_location

    getuser_unicode = win32utils.get_user_name

elif sys.platform == 'darwin':

    getcwd = _mac_getcwd

def get_terminal_encoding(trace=False):

    """Find the best encoding for printing to the screen.

    This attempts to check both sys.stdout and sys.stdin to see

    what encoding they are in, and if that fails it falls back to

    osutils.get_user_encoding().

    The problem is that on Windows, locale.getpreferredencoding()

    is not the same encoding as that used by the console:

    http://mail.python.org/pipermail/python-list/2003-May/162357.html

    On my standard US Windows XP, the preferred encoding is

    cp1252, but the console is cp437

    :param trace: If True trace the selected encoding via mutter().

    """

    from .trace import mutter

    output_encoding = getattr(sys.stdout, 'encoding', None)

    if not output_encoding:

        input_encoding = getattr(sys.stdin, 'encoding', None)

        if not input_encoding:

            output_encoding = get_user_encoding()

            if trace:

                mutter('encoding stdout as osutils.get_user_encoding() %r',

                       output_encoding)

        else:

            output_encoding = input_encoding

            if trace:

                mutter('encoding stdout as sys.stdin encoding %r',

                       output_encoding)

    else:

        if trace:

            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)

    if output_encoding == 'cp0':

        # invalid encoding (cp0 means 'no codepage' on Windows)

        output_encoding = get_user_encoding()

        if trace:

            mutter('cp0 is invalid encoding.'

                   ' encoding stdout as osutils.get_user_encoding() %r',

                   output_encoding)

    # check encoding

    try:

        codecs.lookup(output_encoding)

    except LookupError:

        sys.stderr.write('brz: warning:'

                         ' unknown terminal encoding %s.\n'

                         '  Using encoding %s instead.\n'

                         % (output_encoding, get_user_encoding())

                         )

        output_encoding = get_user_encoding()

    return output_encoding

def normalizepath(f):

    if getattr(os.path, 'realpath', None) is not None:

        F = realpath

    else:

        F = abspath

    [p, e] = os.path.split(f)

    if e == "" or e == "." or e == "..":

        return F(f)

    else:

        return pathjoin(F(p), e)

def isdir(f):

    """True if f is an accessible directory."""

    try:

        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])

    except OSError:

        return False

def isfile(f):

    """True if f is a regular file."""

    try:

        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])

    except OSError:

        return False

def islink(f):

    """True if f is a symlink."""

    try:

        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])

    except OSError:

        return False

def is_inside(dir, fname):

    """True if fname is inside dir.

    The parameters should typically be passed to osutils.normpath first, so

    that . and .. and repeated slashes are eliminated, and the separators

    are canonical for the platform.

    The empty string as a dir name is taken as top-of-tree and matches

    everything.

    """

    # XXX: Most callers of this can actually do something smarter by

    # looking at the inventory

    if dir == fname:

        return True

    if dir in ('', b''):

        return True

    if isinstance(dir, bytes):

        if not dir.endswith(b'/'):

            dir += b'/'

    else:

        if not dir.endswith('/'):

            dir += '/'

    return fname.startswith(dir)

def is_inside_any(dir_list, fname):

    """True if fname is inside any of given dirs."""

    for dirname in dir_list:

        if is_inside(dirname, fname):

            return True

    return False

def is_inside_or_parent_of_any(dir_list, fname):

    """True if fname is a child or a parent of any of the given files."""

    for dirname in dir_list:

        if is_inside(dirname, fname) or is_inside(fname, dirname):

            return True

    return False

def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,

             report_activity=None, direction='read'):

    """Copy contents of one file to another.

    The read_length can either be -1 to read to end-of-file (EOF) or

    it can specify the maximum number of bytes to read.

    The buff_size represents the maximum size for each read operation

    performed on from_file.

    :param report_activity: Call this as bytes are read, see

        Transport._report_activity

    :param direction: Will be passed to report_activity

    :return: The number of bytes copied.

    """

    length = 0

    if read_length >= 0:

        # read specified number of bytes

        while read_length > 0:

            num_bytes_to_read = min(read_length, buff_size)

            block = from_file.read(num_bytes_to_read)

            if not block:

                # EOF reached

                break

            if report_activity is not None:

                report_activity(len(block), direction)

            to_file.write(block)

            actual_bytes_read = len(block)

            read_length -= actual_bytes_read

            length += actual_bytes_read

    else:

        # read to EOF

        while True:

            block = from_file.read(buff_size)

            if not block:

                # EOF reached

                break

            if report_activity is not None:

                report_activity(len(block), direction)

            to_file.write(block)

            length += len(block)

    return length

def pump_string_file(bytes, file_handle, segment_size=None):

    """Write bytes to file_handle in many smaller writes.

    :param bytes: The string to write.

    :param file_handle: The file to write to.