mirror of
https://github.com/ansible/awx.git
synced 2026-02-05 03:24:50 -03:30
0645d342dd
* Before, the optional url prefix feature required calling our versioning version of reverse(). This worked _ok_ until we added more and more urls from 3rd party apps. Those 3rd party apps do not call our reverse(), writefully so. * This implementation looks at the incoming request path. If it includes the special optional prefix url, then we register ALL the urls WITH the optional url prefix. If the incoming request path does NOT contain the options url prefix then we register ALL the urls WITHOUT the optional url prefix. * Before this, we were registering BOTH sets of urls and then reverse() + the request as context to decide which url.
43 lines
1.7 KiB
Python
43 lines
1.7 KiB
Python
# Copyright (c) 2017 Ansible by Red Hat
|
|
# All Rights Reserved.
|
|
|
|
from django.conf import settings
|
|
|
|
from rest_framework.reverse import reverse as drf_reverse
|
|
from rest_framework.versioning import URLPathVersioning as BaseVersioning
|
|
|
|
|
|
def is_optional_api_urlpattern_prefix_request(request):
|
|
if settings.OPTIONAL_API_URLPATTERN_PREFIX and request:
|
|
if request.path.startswith(f"/api/{settings.OPTIONAL_API_URLPATTERN_PREFIX}"):
|
|
return True
|
|
return False
|
|
|
|
|
|
def transform_optional_api_urlpattern_prefix_url(request, url):
|
|
if is_optional_api_urlpattern_prefix_request(request):
|
|
url = url.replace('/api', f"/api/{settings.OPTIONAL_API_URLPATTERN_PREFIX}")
|
|
return url
|
|
|
|
|
|
def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra):
|
|
if request is None or getattr(request, 'version', None) is None:
|
|
# We need the "current request" to determine the correct version to
|
|
# prepend to reverse URLs. If there is no "current request", assume
|
|
# the latest API version.
|
|
if kwargs is None:
|
|
kwargs = {}
|
|
if 'version' not in kwargs:
|
|
kwargs['version'] = settings.REST_FRAMEWORK['DEFAULT_VERSION']
|
|
return drf_reverse(viewname, args, kwargs, request, format, **extra)
|
|
|
|
|
|
class URLPathVersioning(BaseVersioning):
|
|
def reverse(self, viewname, args=None, kwargs=None, request=None, format=None, **extra):
|
|
if request.version is not None:
|
|
kwargs = {} if (kwargs is None) else kwargs
|
|
kwargs[self.version_param] = request.version
|
|
request = None
|
|
|
|
return super(BaseVersioning, self).reverse(viewname, args, kwargs, request, format, **extra)
|