mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
32083e58c0
* Fixes: #14840 - Forces API to use proxy model * Update tests to use proxy model * Revert "Update tests to use proxy model" This reverts commit 1d784cfe5d689a00ae3c75edc56ce226e62e8fc3. * Revert "Fixes: #14840 - Forces API to use proxy model" This reverts commit df85cc967c2e951cb02c8ea3b9074dc6bd7dc301. * More realistic change to resole issue with netboxusers-list * Revert "More realistic change to resole issue with netboxusers-list" This reverts commit 15df8082aafbebf32c932c4c38b970851492eea8. * Fixes: #14840 - Better fix for netboxusers-list * Swap model for serializer from proxy model
104 lines
3.2 KiB
Python
104 lines
3.2 KiB
Python
import platform
|
|
import sys
|
|
|
|
from django.conf import settings
|
|
from django.http import JsonResponse
|
|
from django.urls import reverse
|
|
from rest_framework import status
|
|
from rest_framework.utils import formatting
|
|
|
|
from netbox.api.exceptions import GraphQLTypeNotFound, SerializerNotFound
|
|
from .utils import dynamic_import
|
|
|
|
__all__ = (
|
|
'get_graphql_type_for_model',
|
|
'get_serializer_for_model',
|
|
'get_view_name',
|
|
'is_api_request',
|
|
'rest_api_server_error',
|
|
)
|
|
|
|
|
|
def get_serializer_for_model(model, prefix=''):
|
|
"""
|
|
Dynamically resolve and return the appropriate serializer for a model.
|
|
"""
|
|
app_name, model_name = model._meta.label.split('.')
|
|
# Serializers for Django's auth models are in the users app
|
|
if app_name == 'auth':
|
|
app_name = 'users'
|
|
# Account for changes using Proxy model
|
|
if app_name == 'users':
|
|
if model_name == 'NetBoxUser':
|
|
model_name = 'User'
|
|
elif model_name == 'NetBoxGroup':
|
|
model_name = 'Group'
|
|
|
|
serializer_name = f'{app_name}.api.serializers.{prefix}{model_name}Serializer'
|
|
try:
|
|
return dynamic_import(serializer_name)
|
|
except AttributeError:
|
|
raise SerializerNotFound(
|
|
f"Could not determine serializer for {app_name}.{model_name} with prefix '{prefix}'"
|
|
)
|
|
|
|
|
|
def get_graphql_type_for_model(model):
|
|
"""
|
|
Return the GraphQL type class for the given model.
|
|
"""
|
|
app_name, model_name = model._meta.label.split('.')
|
|
# Object types for Django's auth models are in the users app
|
|
if app_name == 'auth':
|
|
app_name = 'users'
|
|
class_name = f'{app_name}.graphql.types.{model_name}Type'
|
|
try:
|
|
return dynamic_import(class_name)
|
|
except AttributeError:
|
|
raise GraphQLTypeNotFound(f"Could not find GraphQL type for {app_name}.{model_name}")
|
|
|
|
|
|
def is_api_request(request):
|
|
"""
|
|
Return True of the request is being made via the REST API.
|
|
"""
|
|
api_path = reverse('api-root')
|
|
|
|
return request.path_info.startswith(api_path) and request.content_type == 'application/json'
|
|
|
|
|
|
def get_view_name(view, suffix=None):
|
|
"""
|
|
Derive the view name from its associated model, if it has one. Fall back to DRF's built-in `get_view_name`.
|
|
"""
|
|
if hasattr(view, 'queryset'):
|
|
# Determine the model name from the queryset.
|
|
name = view.queryset.model._meta.verbose_name
|
|
name = ' '.join([w[0].upper() + w[1:] for w in name.split()]) # Capitalize each word
|
|
|
|
else:
|
|
# Replicate DRF's built-in behavior.
|
|
name = view.__class__.__name__
|
|
name = formatting.remove_trailing_string(name, 'View')
|
|
name = formatting.remove_trailing_string(name, 'ViewSet')
|
|
name = formatting.camelcase_to_spaces(name)
|
|
|
|
if suffix:
|
|
name += ' ' + suffix
|
|
|
|
return name
|
|
|
|
|
|
def rest_api_server_error(request, *args, **kwargs):
|
|
"""
|
|
Handle exceptions and return a useful error message for REST API requests.
|
|
"""
|
|
type_, error, traceback = sys.exc_info()
|
|
data = {
|
|
'error': str(error),
|
|
'exception': type_.__name__,
|
|
'netbox_version': settings.VERSION,
|
|
'python_version': platform.python_version(),
|
|
}
|
|
return JsonResponse(data, status=status.HTTP_500_INTERNAL_SERVER_ERROR)
|