140 lines
4.0 KiB
Python
140 lines
4.0 KiB
Python
# Copyright (C) 2014 Andrey Antukh <niwi@niwi.be>
|
|
# Copyright (C) 2014 Jesús Espino <jespinog@gmail.com>
|
|
# Copyright (C) 2014 David Barragán <bameda@dbarragan.com>
|
|
# 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/>.
|
|
|
|
from rest_framework import exceptions
|
|
from rest_framework import status
|
|
|
|
from django.core.exceptions import PermissionDenied as DjangoPermissionDenied
|
|
from django.utils.encoding import force_text
|
|
from django.utils.translation import ugettext_lazy as _
|
|
from django.http import Http404
|
|
|
|
from taiga.base import response
|
|
|
|
|
|
class BaseException(exceptions.APIException):
|
|
status_code = status.HTTP_400_BAD_REQUEST
|
|
default_detail = _("Unexpected error")
|
|
|
|
def __init__(self, detail=None):
|
|
self.detail = detail or self.default_detail
|
|
|
|
|
|
class NotFound(BaseException, Http404):
|
|
"""
|
|
Exception used for not found objects.
|
|
"""
|
|
|
|
status_code = status.HTTP_404_NOT_FOUND
|
|
default_detail = _("Not found.")
|
|
|
|
|
|
class NotSupported(BaseException):
|
|
status_code = status.HTTP_405_METHOD_NOT_ALLOWED
|
|
default_detail = _("Method not supported for this endpoint.")
|
|
|
|
|
|
class BadRequest(BaseException):
|
|
"""
|
|
Exception used on bad arguments detected
|
|
on api view.
|
|
"""
|
|
default_detail = _("Wrong arguments.")
|
|
|
|
|
|
class WrongArguments(BadRequest):
|
|
"""
|
|
Exception used on bad arguments detected
|
|
on service. This is same as `BadRequest`.
|
|
"""
|
|
default_detail = _("Wrong arguments.")
|
|
|
|
|
|
class RequestValidationError(BadRequest):
|
|
default_detail = _("Data validation error")
|
|
|
|
|
|
class PermissionDenied(exceptions.PermissionDenied):
|
|
"""
|
|
Compatibility subclass of restframework `PermissionDenied`
|
|
exception.
|
|
"""
|
|
pass
|
|
|
|
|
|
class IntegrityError(BadRequest):
|
|
default_detail = _("Integrity Error for wrong or invalid arguments")
|
|
|
|
|
|
class PreconditionError(BadRequest):
|
|
"""
|
|
Error raised on precondition method on viewset.
|
|
"""
|
|
default_detail = _("Precondition error")
|
|
|
|
|
|
class NotAuthenticated(exceptions.NotAuthenticated):
|
|
"""
|
|
Compatibility subclass of restframework `NotAuthenticated`
|
|
exception.
|
|
"""
|
|
pass
|
|
|
|
|
|
def format_exception(exc):
|
|
if isinstance(exc.detail, (dict, list, tuple,)):
|
|
detail = exc.detail
|
|
else:
|
|
class_name = exc.__class__.__name__
|
|
class_module = exc.__class__.__module__
|
|
detail = {
|
|
"_error_message": force_text(exc.detail),
|
|
"_error_type": "{0}.{1}".format(class_module, class_name)
|
|
}
|
|
|
|
return detail
|
|
|
|
|
|
def exception_handler(exc):
|
|
"""
|
|
Returns the response that should be used for any given exception.
|
|
|
|
By default we handle the REST framework `APIException`, and also
|
|
Django's builtin `Http404` and `PermissionDenied` exceptions.
|
|
|
|
Any unhandled exceptions may return `None`, which will cause a 500 error
|
|
to be raised.
|
|
"""
|
|
|
|
if isinstance(exc, exceptions.APIException):
|
|
headers = {}
|
|
if getattr(exc, "auth_header", None):
|
|
headers["WWW-Authenticate"] = exc.auth_header
|
|
if getattr(exc, "wait", None):
|
|
headers["X-Throttle-Wait-Seconds"] = "%d" % exc.wait
|
|
|
|
detail = format_exception(exc)
|
|
return response.Response(detail, status=exc.status_code, headers=headers)
|
|
|
|
elif isinstance(exc, Http404):
|
|
return response.NotFound({'_error_message': str(exc)})
|
|
|
|
elif isinstance(exc, DjangoPermissionDenied):
|
|
return response.Forbidden({"_error_message": str(exc)})
|
|
|
|
# Note: Unhandled exceptions will raise a 500 error.
|
|
return None
|