rhodecode/lib/exceptions.py

# Copyright (C) 2010-2023 RhodeCode GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# 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 Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/

"""
Set of custom exceptions used in RhodeCode
"""

from webob.exc import HTTPClientError
from pyramid.httpexceptions import HTTPBadGateway


class LdapUsernameError(Exception):
    pass


class LdapPasswordError(Exception):
    pass


class LdapConnectionError(Exception):
    pass


class LdapImportError(Exception):
    pass


class DefaultUserException(Exception):
    pass


class UserOwnsReposException(Exception):
    pass


class UserOwnsRepoGroupsException(Exception):
    pass


class UserOwnsUserGroupsException(Exception):
    pass


class UserOwnsPullRequestsException(Exception):
    pass


class UserOwnsArtifactsException(Exception):
    pass


class UserGroupAssignedException(Exception):
    pass


class StatusChangeOnClosedPullRequestError(Exception):
    pass


class AttachedForksError(Exception):
    pass


class AttachedPullRequestsError(Exception):
    pass


class AttachedArtifactsError(Exception):
    pass


class RepoGroupAssignmentError(Exception):
    pass


class NonRelativePathError(Exception):
    pass


class HTTPRequirementError(HTTPClientError):
    title = explanation = 'Repository Requirement Missing'
    reason = None

    def __init__(self, message, *args, **kwargs):
        self.title = self.explanation = message
        super().__init__(*args, **kwargs)
        self.args = (message, )


class ClientNotSupportedError(HTTPRequirementError):
    title = explanation = 'Client Not Supported'
    reason = None


class HTTPLockedRC(HTTPClientError):
    """
    Special Exception For locked Repos in RhodeCode, the return code can
    be overwritten by _code keyword argument passed into constructors
    """
    code = 423
    title = explanation = 'Repository Locked'
    reason = None

    def __init__(self, message, *args, **kwargs):
        import rhodecode

        self.code = rhodecode.ConfigGet().get_int('lock_ret_code', missing=self.code)

        self.title = self.explanation = message
        super().__init__(*args, **kwargs)
        self.args = (message, )


class HTTPBranchProtected(HTTPClientError):
    """
    Special Exception For Indicating that branch is protected in RhodeCode, the
    return code can be overwritten by _code keyword argument passed into constructors
    """
    code = 403
    title = explanation = 'Branch Protected'
    reason = None

    def __init__(self, message, *args, **kwargs):
        self.title = self.explanation = message
        super().__init__(*args, **kwargs)
        self.args = (message, )


class IMCCommitError(Exception):
    pass


class UserCreationError(Exception):
    pass


class NotAllowedToCreateUserError(Exception):
    pass


class DuplicateUpdateUserError(Exception):
    pass


class RepositoryCreationError(Exception):
    pass


class VCSServerUnavailable(HTTPBadGateway):
    """ HTTP Exception class for VCS Server errors """
    code = 502
    title = 'VCS Server Error'
    causes = [
        'VCS Server is not running',
        'Incorrect vcs.server=host:port',
        'Incorrect vcs.server.protocol',
    ]

    def __init__(self, message=''):
        self.explanation = 'Could not connect to VCS Server'
        if message:
            self.explanation += ': ' + message
        super().__init__()


class ArtifactMetadataDuplicate(ValueError):

    def __init__(self, *args, **kwargs):
        self.err_section = kwargs.pop('err_section', None)
        self.err_key = kwargs.pop('err_key', None)
        super().__init__(*args, **kwargs)


class ArtifactMetadataBadValueType(ValueError):
    pass


class CommentVersionMismatch(ValueError):
    pass


class SignatureVerificationError(ValueError):
    pass


def signature_verification_error(msg):
    details = """
Encryption signature verification failed. 
Please check your value of secret key, and/or encrypted value stored. 
Secret key stored inside .ini file:
`rhodecode.encrypted_values.secret` or defaults to
`beaker.session.secret` 

Probably the stored values were encrypted using a different secret then currently set in .ini file    
"""

    final_msg = f'{msg}\n{details}'
    return SignatureVerificationError(final_msg)