84 lines
3.0 KiB
Python
84 lines
3.0 KiB
Python
# Copyright (c) 2019 Red Hat, Inc.
|
|
#
|
|
# This file is part of ARA Records Ansible.
|
|
#
|
|
# ARA is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# ARA 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 General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with ARA. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from collections import OrderedDict
|
|
|
|
from rest_framework.pagination import LimitOffsetPagination
|
|
from rest_framework.response import Response
|
|
from rest_framework.utils.urls import remove_query_param, replace_query_param
|
|
|
|
|
|
class LimitOffsetPaginationWithLinks(LimitOffsetPagination):
|
|
"""
|
|
Extends LimitOffsetPagination to provide links
|
|
to first and last pages as well as the limit and offset, if available.
|
|
Generates relative links instead of absolute URIs.
|
|
"""
|
|
|
|
def get_next_link(self):
|
|
if self.offset + self.limit >= self.count:
|
|
return None
|
|
|
|
url = self.request.get_full_path()
|
|
url = replace_query_param(url, self.limit_query_param, self.limit)
|
|
|
|
offset = self.offset + self.limit
|
|
return replace_query_param(url, self.offset_query_param, offset)
|
|
|
|
def get_previous_link(self):
|
|
if self.offset <= 0:
|
|
return None
|
|
|
|
url = self.request.get_full_path()
|
|
url = replace_query_param(url, self.limit_query_param, self.limit)
|
|
|
|
if self.offset - self.limit <= 0:
|
|
return remove_query_param(url, self.offset_query_param)
|
|
|
|
offset = self.offset - self.limit
|
|
return replace_query_param(url, self.offset_query_param, offset)
|
|
|
|
def get_first_link(self):
|
|
if self.offset <= 0:
|
|
return None
|
|
url = self.request.get_full_path()
|
|
return remove_query_param(url, self.offset_query_param)
|
|
|
|
def get_last_link(self):
|
|
if self.offset + self.limit >= self.count:
|
|
return None
|
|
url = self.request.get_full_path()
|
|
url = replace_query_param(url, self.limit_query_param, self.limit)
|
|
offset = self.count - self.limit
|
|
return replace_query_param(url, self.offset_query_param, offset)
|
|
|
|
def get_paginated_response(self, data):
|
|
return Response(
|
|
OrderedDict(
|
|
[
|
|
("count", self.count),
|
|
("next", self.get_next_link()),
|
|
("previous", self.get_previous_link()),
|
|
("first", self.get_first_link()),
|
|
("last", self.get_last_link()),
|
|
("limit", self.limit),
|
|
("offset", self.offset),
|
|
("results", data),
|
|
]
|
|
)
|
|
)
|