MatrixSynapse/synapse/streams/config.py

88 lines
2.7 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 16:10:52 +02:00
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from typing import Optional
import attr
2018-07-09 08:09:20 +02:00
from synapse.api.errors import SynapseError
from synapse.http.servlet import parse_integer, parse_string
from synapse.http.site import SynapseRequest
2018-07-09 08:09:20 +02:00
from synapse.types import StreamToken
logger = logging.getLogger(__name__)
2014-08-12 16:10:52 +02:00
MAX_LIMIT = 1000
@attr.s(slots=True)
2020-09-04 12:54:56 +02:00
class PaginationConfig:
2014-08-12 16:10:52 +02:00
"""A configuration object which stores pagination parameters."""
from_token = attr.ib(type=Optional[StreamToken])
to_token = attr.ib(type=Optional[StreamToken])
direction = attr.ib(type=str)
limit = attr.ib(type=Optional[int])
2014-08-12 16:10:52 +02:00
@classmethod
def from_request(
cls,
request: SynapseRequest,
raise_invalid_params: bool = True,
default_limit: Optional[int] = None,
) -> "PaginationConfig":
2019-06-20 11:32:02 +02:00
direction = parse_string(request, "dir", default="f", allowed_values=["f", "b"])
from_tok = parse_string(request, "from")
to_tok = parse_string(request, "to")
try:
if from_tok == "END":
from_tok = None # For backwards compat.
elif from_tok:
from_tok = StreamToken.from_string(from_tok)
except Exception:
raise SynapseError(400, "'from' parameter is invalid")
try:
if to_tok:
to_tok = StreamToken.from_string(to_tok)
except Exception:
raise SynapseError(400, "'to' parameter is invalid")
limit = parse_integer(request, "limit", default=default_limit)
if limit:
if limit < 0:
raise SynapseError(400, "Limit must be 0 or above")
limit = min(int(limit), MAX_LIMIT)
try:
return PaginationConfig(from_tok, to_tok, direction, limit)
except Exception:
logger.exception("Failed to create pagination config")
raise SynapseError(400, "Invalid request.")
2014-08-12 16:10:52 +02:00
def __repr__(self) -> str:
return ("PaginationConfig(from_tok=%r, to_tok=%r, direction=%r, limit=%r)") % (
self.from_token,
self.to_token,
self.direction,
self.limit,
)