# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

#

# This file is part of CubicWeb.

#

# CubicWeb is free software: you can redistribute it and/or modify it under the

# terms of the GNU Lesser General Public License as published by the Free

# Software Foundation, either version 2.1 of the License, or (at your option)

# any later version.

#

# CubicWeb 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 Lesser General Public License for more

# details.

#

# You should have received a copy of the GNU Lesser General Public License along

# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""Exceptions shared by different cubicweb packages.

"""

__docformat__ = "restructuredtext en"

from yams import ValidationError

# abstract exceptions #########################################################

class CubicWebException(Exception):

    """base class for cubicweb server exception"""

    msg = ""

    def __str__(self):

        if self.msg:

            if self.args:

                return self.msg % tuple(self.args)

            return self.msg

        return ' '.join(unicode(arg) for arg in self.args)

class ConfigurationError(CubicWebException):

    """a misconfiguration error"""

class InternalError(CubicWebException):

    """base class for exceptions which should not occurs"""

class SecurityError(CubicWebException):

    """base class for cubicweb server security exception"""

class RepositoryError(CubicWebException):

    """base class for repository exceptions"""

class SourceException(CubicWebException):

    """base class for source exceptions"""

class CubicWebRuntimeError(CubicWebException):

    """base class for runtime exceptions"""

# repository exceptions #######################################################

class ConnectionError(RepositoryError):

    """raised when a bad connection id is given or when an attempt to establish

    a connection failed

    """

class AuthenticationError(ConnectionError):

    """raised when when an attempt to establish a connection failed do to wrong

    connection information (login / password or other authentication token)

    """

class BadConnectionId(ConnectionError):

    """raised when a bad connection id is given"""

class UnknownEid(RepositoryError):

    """the eid is not defined in the system tables"""

    msg = 'No entity with eid %s in the repository'

class ETypeNotSupportedBySources(RepositoryError, InternalError):

    """no source support an entity type"""

    msg = 'No source supports %r entity\'s type'

class MultiSourcesError(RepositoryError, InternalError):

    """usually due to bad multisources configuration or rql query"""

class UniqueTogetherError(RepositoryError):

    """raised when a unique_together constraint caused an IntegrityError"""

# security exceptions #########################################################

class Unauthorized(SecurityError):

    """raised when a user tries to perform an action without sufficient

    credentials

    """

    msg = 'You are not allowed to perform this operation'

    msg1 = 'You are not allowed to perform %s operation on %s'

    var = None

    def __str__(self):

        try:

            if self.args and len(self.args) == 2:

                return self.msg1 % self.args

            if self.args:

                return ' '.join(self.args)

            return self.msg

        except Exception, ex:

            return str(ex)

# source exceptions ###########################################################

class EidNotInSource(SourceException):

    """trying to access an object with a particular eid from a particular

    source has failed

    """

    msg = 'No entity with eid %s in %s'

# registry exceptions #########################################################

class RegistryException(CubicWebException):

    """raised when an unregistered view is called"""

class RegistryNotFound(RegistryException):

    """raised when an unknown registry is requested

    this is usually a programming/typo error...

    """

class ObjectNotFound(RegistryException):

    """raised when an unregistered object is requested

    this may be a programming/typo or a misconfiguration error

    """

class NoSelectableObject(RegistryException):

    """raised when no appobject is selectable for a given context."""

    def __init__(self, args, kwargs, appobjects):

        self.args = args

        self.kwargs = kwargs

        self.appobjects = appobjects

    def __str__(self):

        return ('args: %s, kwargs: %s\ncandidates: %s'

                % (self.args, self.kwargs.keys(), self.appobjects))

class UnknownProperty(RegistryException):

    """property found in database but unknown in registry"""

# query exception #############################################################

class QueryError(CubicWebRuntimeError):

    """a query try to do something it shouldn't"""

class NotAnEntity(CubicWebRuntimeError):

    """raised when get_entity is called for a column which doesn't contain

    a non final entity

    """

# tools exceptions ############################################################

class ExecutionError(Exception):

    """server execution control error (already started, not running...)"""

# pylint: disable=W0611

from logilab.common.clcommands import BadCommandUsage