mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Fixes #7101: Enforce MAX_PAGE_SIZE for table and REST API pagination

Browse Source
This commit is contained in:
jeremystretch
2021-08-31 13:52:04 -04:00
parent c4c6fa6042
commit 1c09ffdd1f
4 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/release-notes/version-3.0.md
View File

@ -13,6 +13,7 @@
* [#7084](https://github.com/netbox-community/netbox/issues/7084) - Fix KeyError exception when editing access VLAN on an interface * [#7084](https://github.com/netbox-community/netbox/issues/7084) - Fix KeyError exception when editing access VLAN on an interface
* [#7089](https://github.com/netbox-community/netbox/issues/7089) - Fix ContentTypeFilterSet not filtering on q filter * [#7089](https://github.com/netbox-community/netbox/issues/7089) - Fix ContentTypeFilterSet not filtering on q filter
* [#7096](https://github.com/netbox-community/netbox/issues/7096) - Home links should honor `BASE_PATH` configuration * [#7096](https://github.com/netbox-community/netbox/issues/7096) - Home links should honor `BASE_PATH` configuration
* [#7101](https://github.com/netbox-community/netbox/issues/7101) - Enforce `MAX_PAGE_SIZE` for table and REST API pagination
--- ---

20
netbox/netbox/api/pagination.py
View File

@ -34,23 +34,13 @@ class OptionalLimitOffsetPagination(LimitOffsetPagination):
return list(queryset[self.offset:]) return list(queryset[self.offset:])
def get_limit(self, request): def get_limit(self, request):
limit = super().get_limit(request)
if self.limit_query_param: # Enforce maximum page size
try: if settings.MAX_PAGE_SIZE:
limit = int(request.query_params[self.limit_query_param]) limit = min(limit, settings.MAX_PAGE_SIZE)
if limit < 0:
raise ValueError()
# Enforce maximum page size, if defined
if settings.MAX_PAGE_SIZE:
if limit == 0:
return settings.MAX_PAGE_SIZE
else:
return min(limit, settings.MAX_PAGE_SIZE)
return limit
except (KeyError, ValueError):
pass
return self.default_limit return limit
def get_next_link(self): def get_next_link(self):

4
netbox/netbox/settings.py
View File

@ -560,6 +560,10 @@ RQ_QUEUES = {
# #
# Pagination # Pagination
if MAX_PAGE_SIZE and PAGINATE_COUNT > MAX_PAGE_SIZE:
raise ImproperlyConfigured(
f"PAGINATE_COUNT ({PAGINATE_COUNT}) must be less than or equal to MAX_PAGE_SIZE ({MAX_PAGE_SIZE}), if set."
)
PER_PAGE_DEFAULTS = [ PER_PAGE_DEFAULTS = [
25, 50, 100, 250, 500, 1000 25, 50, 100, 250, 500, 1000
] ]

12
netbox/utilities/paginator.py
View File

@ -49,21 +49,25 @@ class EnhancedPage(Page):
def get_paginate_count(request): def get_paginate_count(request):
""" """
Determine the length of a page, using the following in order: Determine the desired length of a page, using the following in order:
1. per_page URL query parameter 1. per_page URL query parameter
2. Saved user preference 2. Saved user preference
3. PAGINATE_COUNT global setting. 3. PAGINATE_COUNT global setting.
Return the lesser of the calculated value and MAX_PAGE_SIZE.
""" """
if 'per_page' in request.GET: if 'per_page' in request.GET:
try: try:
per_page = int(request.GET.get('per_page')) per_page = int(request.GET.get('per_page'))
if request.user.is_authenticated: if request.user.is_authenticated:
request.user.config.set('pagination.per_page', per_page, commit=True) request.user.config.set('pagination.per_page', per_page, commit=True)
return per_page return min(per_page, settings.MAX_PAGE_SIZE)
except ValueError: except ValueError:
pass pass
if request.user.is_authenticated: if request.user.is_authenticated:
return request.user.config.get('pagination.per_page', settings.PAGINATE_COUNT) per_page = request.user.config.get('pagination.per_page', settings.PAGINATE_COUNT)
return settings.PAGINATE_COUNT return min(per_page, settings.MAX_PAGE_SIZE)
return min(settings.PAGINATE_COUNT, settings.MAX_PAGE_SIZE)