/brz/remove-bazaar

# Copyright (C) 2005-2013, 2016 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

"""Exceptions for bzr, and reporting of them.

"""

from __future__ import absolute_import

from .sixish import (

    PY3,

    )

# TODO: is there any value in providing the .args field used by standard

# python exceptions?   A list of values with no names seems less useful

# to me.

# TODO: Perhaps convert the exception to a string at the moment it's

# constructed to make sure it will succeed.  But that says nothing about

# exceptions that are never raised.

# TODO: selftest assertRaises should probably also check that every error

# raised can be formatted as a string successfully, and without giving

# 'unprintable'.

# return codes from the brz program

EXIT_OK = 0

EXIT_ERROR = 3

EXIT_INTERNAL_ERROR = 4

class BzrError(Exception):

    """

    Base class for errors raised by breezy.

    :cvar internal_error: if True this was probably caused by a brz bug and

        should be displayed with a traceback; if False (or absent) this was

        probably a user or environment error and they don't need the gory

        details.  (That can be overridden by -Derror on the command line.)

    :cvar _fmt: Format string to display the error; this is expanded

        by the instance's dict.

    """

    internal_error = False

    def __init__(self, msg=None, **kwds):

        """Construct a new BzrError.

        There are two alternative forms for constructing these objects.

        Either a preformatted string may be passed, or a set of named

        arguments can be given.  The first is for generic "user" errors which

        are not intended to be caught and so do not need a specific subclass.

        The second case is for use with subclasses that provide a _fmt format

        string to print the arguments.

        Keyword arguments are taken as parameters to the error, which can

        be inserted into the format string template.  It's recommended

        that subclasses override the __init__ method to require specific

        parameters.

        :param msg: If given, this is the literal complete text for the error,

           not subject to expansion. 'msg' is used instead of 'message' because

           python evolved and, in 2.6, forbids the use of 'message'.

        """

        Exception.__init__(self)

        if msg is not None:

            # I was going to deprecate this, but it actually turns out to be

            # quite handy - mbp 20061103.

            self._preformatted_string = msg

        else:

            self._preformatted_string = None

            for key, value in kwds.items():

                setattr(self, key, value)

    def _format(self):

        s = getattr(self, '_preformatted_string', None)

        if s is not None:

            # contains a preformatted message

            return s

        err = None

        try:

            fmt = self._get_format_string()

            if fmt:

                d = dict(self.__dict__)

                s = fmt % d

                # __str__() should always return a 'str' object

                # never a 'unicode' object.

                return s

        except Exception as e:

            err = e

        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \

            % (self.__class__.__name__,

               self.__dict__,

               getattr(self, '_fmt', None),

               err)

    if PY3:

        __str__ = _format

    else:

        def __str__(self):

            return self._format().encode('utf-8')

        __unicode__ = _format

    def __repr__(self):

        return '%s(%s)' % (self.__class__.__name__, str(self))

    def _get_format_string(self):

        """Return format string for this exception or None"""

        fmt = getattr(self, '_fmt', None)

        if fmt is not None:

            from breezy.i18n import gettext

            return gettext(fmt) # _fmt strings should be ascii

    def __eq__(self, other):

        if self.__class__ is not other.__class__:

            return NotImplemented

        return self.__dict__ == other.__dict__

    def __hash__(self):

        return id(self)

class InternalBzrError(BzrError):

    """Base class for errors that are internal in nature.

    This is a convenience class for errors that are internal. The

    internal_error attribute can still be altered in subclasses, if needed.

    Using this class is simply an easy way to get internal errors.

    """

    internal_error = True

class AlreadyBuilding(BzrError):

    _fmt = "The tree builder is already building a tree."

class BranchError(BzrError):

    """Base class for concrete 'errors about a branch'."""

    def __init__(self, branch):

        BzrError.__init__(self, branch=branch)

class BzrCheckError(InternalBzrError):

    _fmt = "Internal check failed: %(msg)s"

    def __init__(self, msg):

        BzrError.__init__(self)

        self.msg = msg

class DirstateCorrupt(BzrError):

    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"

    def __init__(self, state, msg):

        BzrError.__init__(self)

        self.state = state

        self.msg = msg

class DisabledMethod(InternalBzrError):

    _fmt = "The smart server method '%(class_name)s' is disabled."

    def __init__(self, class_name):

        BzrError.__init__(self)

        self.class_name = class_name

class IncompatibleVersion(BzrError):

    _fmt = 'API %(api)s is not compatible; one of versions %(wanted)r '\

           'is required, but current version is %(current)r.'

    def __init__(self, api, wanted, current):

        self.api = api

        self.wanted = wanted

        self.current = current

class InProcessTransport(BzrError):

    _fmt = "The transport '%(transport)s' is only accessible within this " \

        "process."

    def __init__(self, transport):

        self.transport = transport

class InvalidEntryName(InternalBzrError):

    _fmt = "Invalid entry name: %(name)s"

    def __init__(self, name):

        BzrError.__init__(self)

        self.name = name

class InvalidRevisionNumber(BzrError):

    _fmt = "Invalid revision number %(revno)s"

    def __init__(self, revno):

        BzrError.__init__(self)

        self.revno = revno

class InvalidRevisionId(BzrError):

    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"

    def __init__(self, revision_id, branch):

        # branch can be any string or object with __str__ defined

        BzrError.__init__(self)

        self.revision_id = revision_id

        self.branch = branch

class ReservedId(BzrError):

    _fmt = "Reserved revision-id {%(revision_id)s}"

    def __init__(self, revision_id):

        self.revision_id = revision_id

class RootMissing(InternalBzrError):

    _fmt = ("The root entry of a tree must be the first entry supplied to "

        "the commit builder.")

class NoPublicBranch(BzrError):

    _fmt = 'There is no public branch set for "%(branch_url)s".'

    def __init__(self, branch):

        from . import urlutils

        public_location = urlutils.unescape_for_display(branch.base, 'ascii')

        BzrError.__init__(self, branch_url=public_location)

class NoSuchId(BzrError):

    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'

    def __init__(self, tree, file_id):

        BzrError.__init__(self)

        self.file_id = file_id

        self.tree = tree

class NoSuchIdInRepository(NoSuchId):

    _fmt = ('The file id "%(file_id)s" is not present in the repository'

            ' %(repository)r')

    def __init__(self, repository, file_id):

        BzrError.__init__(self, repository=repository, file_id=file_id)

class NotStacked(BranchError):

    _fmt = "The branch '%(branch)s' is not stacked."

class InventoryModified(InternalBzrError):

    _fmt = ("The current inventory for the tree %(tree)r has been modified,"

            " so a clean inventory cannot be read without data loss.")

    def __init__(self, tree):

        self.tree = tree

class NoWorkingTree(BzrError):

    _fmt = 'No WorkingTree exists for "%(base)s".'

    def __init__(self, base):

        BzrError.__init__(self)

        self.base = base

class NotBuilding(BzrError):

    _fmt = "Not currently building a tree."

class NotLocalUrl(BzrError):

    _fmt = "%(url)s is not a local path."

    def __init__(self, url):

        self.url = url

class WorkingTreeAlreadyPopulated(InternalBzrError):

    _fmt = 'Working tree already populated in "%(base)s"'

    def __init__(self, base):

        self.base = base

class BzrCommandError(BzrError):

    """Error from user command"""

    # Error from malformed user command; please avoid raising this as a

    # generic exception not caused by user input.

    #

    # I think it's a waste of effort to differentiate between errors that

    # are not intended to be caught anyway.  UI code need not subclass

    # BzrCommandError, and non-UI code should not throw a subclass of

    # BzrCommandError.  ADHB 20051211

class NotWriteLocked(BzrError):

    _fmt = """%(not_locked)r is not write locked but needs to be."""

    def __init__(self, not_locked):

        self.not_locked = not_locked

class BadIndexFormatSignature(BzrError):

    _fmt = "%(value)s is not an index of type %(_type)s."

    def __init__(self, value, _type):

        BzrError.__init__(self)

        self.value = value

        self._type = _type

class BadIndexData(BzrError):

    _fmt = "Error in data for index %(value)s."

    def __init__(self, value):

        BzrError.__init__(self)

        self.value = value

class BadIndexDuplicateKey(BzrError):

    _fmt = "The key '%(key)s' is already in index '%(index)s'."

    def __init__(self, key, index):

        BzrError.__init__(self)

        self.key = key

        self.index = index

class BadIndexKey(BzrError):

    _fmt = "The key '%(key)s' is not a valid key."

    def __init__(self, key):

        BzrError.__init__(self)

        self.key = key

class BadIndexOptions(BzrError):

    _fmt = "Could not parse options for index %(value)s."

    def __init__(self, value):

        BzrError.__init__(self)

        self.value = value

class BadIndexValue(BzrError):

    _fmt = "The value '%(value)s' is not a valid value."

    def __init__(self, value):

        BzrError.__init__(self)

        self.value = value

class StrictCommitFailed(BzrError):

    _fmt = "Commit refused because there are unknown files in the tree"

# XXX: Should be unified with TransportError; they seem to represent the

# same thing

# RBC 20060929: I think that unifiying with TransportError would be a mistake

# - this is finer than a TransportError - and more useful as such. It

# differentiates between 'transport has failed' and 'operation on a transport

# has failed.'

class PathError(BzrError):

    _fmt = "Generic path error: %(path)r%(extra)s)"

    def __init__(self, path, extra=None):

        BzrError.__init__(self)

        self.path = path

        if extra:

            self.extra = ': ' + str(extra)

        else:

            self.extra = ''

class NoSuchFile(PathError):

    _fmt = "No such file: %(path)r%(extra)s"

class FileExists(PathError):

    _fmt = "File exists: %(path)r%(extra)s"

class RenameFailedFilesExist(BzrError):

    """Used when renaming and both source and dest exist."""

    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."

            " (Use --after to tell brz about a rename that has already"

            " happened)%(extra)s")

    def __init__(self, source, dest, extra=None):

        BzrError.__init__(self)

        self.source = str(source)

        self.dest = str(dest)

        if extra:

            self.extra = ' ' + str(extra)

        else:

            self.extra = ''

class NotADirectory(PathError):

    _fmt = '"%(path)s" is not a directory %(extra)s'

class NotInWorkingDirectory(PathError):

    _fmt = '"%(path)s" is not in the working directory %(extra)s'

class DirectoryNotEmpty(PathError):

    _fmt = 'Directory not empty: "%(path)s"%(extra)s'

class HardLinkNotSupported(PathError):

    _fmt = 'Hard-linking "%(path)s" is not supported'

class ReadingCompleted(InternalBzrError):

    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "

            "called upon it - the request has been completed and no more "

            "data may be read.")

    def __init__(self, request):

        self.request = request

class ResourceBusy(PathError):

    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'

class PermissionDenied(PathError):

    _fmt = 'Permission denied: "%(path)s"%(extra)s'

class UnavailableRepresentation(InternalBzrError):

    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "

        "is encoded as '%(native)s'.")

    def __init__(self, key, wanted, native):

        InternalBzrError.__init__(self)

        self.wanted = wanted

        self.native = native

        self.key = key

class UnknownHook(BzrError):

    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of breezy."

    def __init__(self, hook_type, hook_name):

        BzrError.__init__(self)

        self.type = hook_type

        self.hook = hook_name

class UnsupportedProtocol(PathError):

    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'

    def __init__(self, url, extra=""):

        PathError.__init__(self, url, extra=extra)

class UnstackableBranchFormat(BzrError):

    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "

        "You will need to upgrade the branch to permit branch stacking.")

    def __init__(self, format, url):

        BzrError.__init__(self)

        self.format = format

        self.url = url

class UnstackableLocationError(BzrError):

    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."

    def __init__(self, branch_url, target_url):

        BzrError.__init__(self)

        self.branch_url = branch_url

        self.target_url = target_url

class UnstackableRepositoryFormat(BzrError):

    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "

        "You will need to upgrade the repository to permit branch stacking.")

    def __init__(self, format, url):

        BzrError.__init__(self)

        self.format = format

        self.url = url

class ReadError(PathError):

    _fmt = """Error reading from %(path)r."""

class ShortReadvError(PathError):

    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'

            ' at %(offset)s for "%(path)s"%(extra)s')

    internal_error = True

    def __init__(self, path, offset, length, actual, extra=None):

        PathError.__init__(self, path, extra=extra)

        self.offset = offset

        self.length = length

        self.actual = actual

class PathNotChild(PathError):

    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'

    internal_error = False

    def __init__(self, path, base, extra=None):

        BzrError.__init__(self)

        self.path = path

        self.base = base

        if extra:

            self.extra = ': ' + str(extra)

        else:

            self.extra = ''

class InvalidNormalization(PathError):

    _fmt = 'Path "%(path)s" is not unicode normalized'

# TODO: This is given a URL; we try to unescape it but doing that from inside

# the exception object is a bit undesirable.

# TODO: Probably this behavior of should be a common superclass

class NotBranchError(PathError):

    _fmt = 'Not a branch: "%(path)s"%(detail)s.'

    def __init__(self, path, detail=None, controldir=None):

       from . import urlutils

       path = urlutils.unescape_for_display(path, 'ascii')

       if detail is not None:

           detail = ': ' + detail

       self.detail = detail

       self.controldir = controldir

       PathError.__init__(self, path=path)

    def __repr__(self):

        return '<%s %r>' % (self.__class__.__name__, self.__dict__)

    def _get_format_string(self):

        # GZ 2017-06-08: Not the best place to lazy fill detail in.

        if self.detail is None:

           self.detail = self._get_detail()

        return super(NotBranchError, self)._get_format_string()

    def _get_detail(self):

        if self.controldir is not None:

            try:

                self.controldir.open_repository()

            except NoRepositoryPresent:

                return ''

            except Exception as e:

                # Just ignore unexpected errors.  Raising arbitrary errors

                # during str(err) can provoke strange bugs.  Concretely

                # Launchpad's codehosting managed to raise NotBranchError

                # here, and then get stuck in an infinite loop/recursion

                # trying to str() that error.  All this error really cares

                # about that there's no working repository there, and if

                # open_repository() fails, there probably isn't.

                return ': ' + e.__class__.__name__

            else:

                return ': location is a repository'

        return ''

class NoSubmitBranch(PathError):

    _fmt = 'No submit branch available for branch "%(path)s"'

    def __init__(self, branch):

       from . import urlutils

       self.path = urlutils.unescape_for_display(branch.base, 'ascii')

class AlreadyControlDirError(PathError):

    _fmt = 'A control directory already exists: "%(path)s".'

class AlreadyBranchError(PathError):

    _fmt = 'Already a branch: "%(path)s".'

class InvalidBranchName(PathError):

    _fmt = "Invalid branch name: %(name)s"

    def __init__(self, name):

        BzrError.__init__(self)

        self.name = name

class ParentBranchExists(AlreadyBranchError):

    _fmt = 'Parent branch already exists: "%(path)s".'

class BranchExistsWithoutWorkingTree(PathError):

    _fmt = 'Directory contains a branch, but no working tree \

(use brz checkout if you wish to build a working tree): "%(path)s"'

class AtomicFileAlreadyClosed(PathError):

    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'

            ' "%(path)s"')

    def __init__(self, path, function):

        PathError.__init__(self, path=path, extra=None)

        self.function = function

class InaccessibleParent(PathError):

    _fmt = ('Parent not accessible given base "%(base)s" and'

            ' relative path "%(path)s"')

    def __init__(self, path, base):

        PathError.__init__(self, path)

        self.base = base

class NoRepositoryPresent(BzrError):