#!/usr/bin/env python3
#-*- coding: utf-8 -*-

# Copyright (c) 2012-2021 Jérôme Poisson
# Copyright (c) 2013-2016 Adrien Cossa
# Copyright (c) 2003-2011 Ralph Meijer


# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
# --

# This program is based on Idavoll (http://idavoll.ik.nu/),
# originaly written by Ralph Meijer (http://ralphm.net/blog/)
# It is sublicensed under AGPL v3 (or any later version) as allowed by the original
# license.

# --

# Here is a copy of the original license:

# Copyright (c) 2003-2011 Ralph Meijer

# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:

# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


class Error(Exception):
    msg = ''

    def __init__(self, msg=None):
        self.msg = msg or self.msg


    def __str__(self):
        return self.msg


class Deprecated(Exception):
    pass


class NodeNotFound(Error):
    pass


class NodeExists(Error):
    pass


class NotSubscribed(Error):
    """
    Entity is not subscribed to this node.
    """


class SubscriptionExists(Error):
    """
    There already exists a subscription to this node.
    """


class NotLeafNodeError(Error):
    """a leaf node is expected but we have a collection"""


class Forbidden(Error):
    pass


class NotAuthorized(Error):
    pass


class NotInRoster(Error):
    pass


class ItemNotFound(Error):
    pass


class ItemForbidden(Error):
    pass


class ItemRequired(Error):
    pass


class NoInstantNodes(Error):
    pass


class InvalidConfigurationOption(Error):
    msg = 'Invalid configuration option'


class InvalidConfigurationValue(Error):
    msg = 'Bad configuration value'


class NodeNotPersistent(Error):
    pass


class NoRootNode(Error):
    pass


class NoCallbacks(Error):
    """
    There are no callbacks for this node.
    """

class NoCollections(Error):
    pass


class NoPublishing(Error):
    """
    This node does not support publishing.
    """

class BadAccessTypeError(Error):
    pass


class ConstraintFailed(Error):
    """
    A requirement is not fulfilled
    """

class NotAllowedError(Error):
    """A permission necessary to do a privileged action is not given"""