Source code for social_core.exceptions

from __future__ import annotations

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from social_core.backends.base import BaseAuth




class SocialAuthBaseException(ValueError):
    """Base class for pipeline exceptions."""





class SocialAuthImproperlyConfiguredError(SocialAuthBaseException):
    """Raised when configuration is invalid."""





class StrategyMissingFeatureError(SocialAuthBaseException):
    """Strategy does not support this."""

    def __init__(self, strategy_name: str, feature_name: str) -> None:
        self.strategy_name = strategy_name
        self.feature_name = feature_name
        super().__init__()

    def __str__(self) -> str:
        return f"Strategy {self.strategy_name} does not support {self.feature_name}"





class DefaultStrategyMissingError(SocialAuthBaseException):
    """Default strategy is not configured."""

    def __str__(self) -> str:
        return "Default strategy is not configured"





class StrategyMissingBackendError(SocialAuthBaseException):
    """Strategy storage backend is not configured."""

    def __str__(self) -> str:
        return "Strategy storage backend is not configured"





class WrongBackend(SocialAuthBaseException):
    def __init__(self, backend_name: str) -> None:
        self.backend_name = backend_name
        super().__init__()

    def __str__(self) -> str:
        return f'Incorrect authentication service "{self.backend_name}"'





class MissingBackend(WrongBackend):
    def __str__(self) -> str:
        return f'Missing backend "{self.backend_name}" entry'





class NotAllowedToDisconnect(SocialAuthBaseException):
    """User is not allowed to disconnect it's social account."""

    def __str__(self) -> str:
        return "This account is not allowed to be disconnected."





class AuthException(SocialAuthBaseException):
    """Auth process exception."""

    def __init__(self, backend: BaseAuth, *args, **kwargs) -> None:
        self.backend = backend
        super().__init__(*args, **kwargs)





class AuthFailed(AuthException):
    """Auth process failed for some reason."""

    def __str__(self) -> str:
        msg = super().__str__()
        if msg == "access_denied":
            return "Authentication process was canceled"
        return f"Authentication failed: {msg}"





class AuthCanceled(AuthException):
    """Auth process was canceled by user."""

    def __init__(self, *args, **kwargs) -> None:
        self.response = kwargs.pop("response", None)
        super().__init__(*args, **kwargs)

    def __str__(self) -> str:
        msg = super().__str__()
        if msg:
            return f"Authentication process canceled: {msg}"
        return "Authentication process canceled"





class AuthUnknownError(AuthException):
    """Unknown auth process error."""

    def __str__(self) -> str:
        msg = super().__str__()
        return f"An unknown error happened while authenticating {msg}"





class AuthTokenError(AuthException):
    """Auth token error."""

    def __str__(self) -> str:
        msg = super().__str__()
        return f"Token error: {msg}"





class AuthMissingParameter(AuthException):
    """Missing parameter needed to start or complete the process."""

    def __init__(self, backend: BaseAuth, parameter: str, *args, **kwargs) -> None:
        self.parameter = parameter
        super().__init__(backend, *args, **kwargs)

    def __str__(self) -> str:
        return f"Missing needed parameter {self.parameter}"





class AuthInvalidParameter(AuthMissingParameter):
    """Invalid value for parameter to start or complete the process."""

    def __str__(self) -> str:
        return f"Invalid value for parameter {self.parameter}"





class AuthNotImplementedParameter(AuthMissingParameter):
    """Optional parameter not implemented to start or complete the process."""

    def __str__(self) -> str:
        return f"Not implemented parameter {self.parameter}"





class AuthStateMissing(AuthException):
    """State parameter is incorrect."""

    def __str__(self) -> str:
        return "Session value state missing."





class AuthStateForbidden(AuthException):
    """State parameter is incorrect."""

    def __str__(self) -> str:
        return "Wrong state parameter given."





class AuthAlreadyAssociated(AuthException):
    """A different user has already associated the target social account"""

    def __str__(self) -> str:
        return "This account is already in use."





class AuthTokenRevoked(AuthException):
    """User revoked the access_token in the provider."""

    def __str__(self) -> str:
        return "User revoke access to the token"





class AuthForbidden(AuthException):
    """Authentication for this user is forbidden"""

    def __str__(self) -> str:
        return "Your credentials aren't allowed"





class AuthUnreachableProvider(AuthException):
    """Cannot reach the provider"""

    def __str__(self) -> str:
        return "The authentication provider could not be reached"





class InvalidEmail(AuthException):
    def __str__(self) -> str:
        return "Email couldn't be validated"





class AuthConnectionError(AuthException):
    """Connection error duing authentication."""

    def __str__(self) -> str:
        msg = super().__str__()
        return f"Connection error: {msg}"





class InvalidExpiryValue(SocialAuthBaseException):
    """Invalid expiry value in extra_data."""

    def __init__(self, field_name: str, value: object) -> None:
        self.field_name = field_name
        self.value = value
        super().__init__()

    def __str__(self) -> str:
        return f"Invalid expiry value for field '{self.field_name}': {self.value}"