rt/wrolpi
1
0
Fork 0
mirror of https://github.com/lrnselfreliance/wrolpi.git synced 2026-10-26 19:01:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Creating api_param_limiter which can be used to restrict limit or offset.

Browse source
This commit is contained in:
Roland 2022-01-04 12:15:11 -07:00
parent ad1b8b805e
commit 9da3b3d8b2
No known key found for this signature in database
GPG key ID: 9D6DBD3ACF11AB93
5 changed files with 57 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

10
modules/archive/api.py
View file

@ -4,7 +4,7 @@ from http import HTTPStatus
from requests import Request
from sanic import response
from wrolpi.common import logger, wrol_mode_check
from wrolpi.common import logger, wrol_mode_check, api_param_limiter
from wrolpi.errors import ValidationError
from wrolpi.root_api import get_blueprint, json_response
from wrolpi.schema import validate_doc, JSONErrorResponse
@ -44,6 +44,10 @@ async def fetch_domains(_: Request):
return json_response({'domains': domains, 'totals': {'domains': len(domains)}})
archive_limit_limiter = api_param_limiter(100)
archive_offset_limiter = api_param_limiter(100, 0)
@bp.post('/search')
@validate_doc(
'Search archive contents and titles',
@ -55,8 +59,8 @@ async def search_archives(_: Request, data: dict):
try:
search_str = data.get('search_str')
domain = data.get('domain')
limit = int(data.get('limit', 20))
offset = int(data.get('offset', 0))
limit = archive_limit_limiter(data.get('limit'))
offset = archive_offset_limiter(data.get('offset'))
except Exception as e:
raise ValidationError('Unable to validate search queries') from e

11
modules/videos/common.py
View file

@ -13,7 +13,7 @@ from sqlalchemy.orm import Session
from wrolpi import before_startup
from wrolpi.common import logger, get_config, iterify, chunks, get_media_directory, \
minimize_dict
minimize_dict, api_param_limiter
from wrolpi.db import get_db_session, get_db_curs
from wrolpi.errors import UnknownFile, UnknownDirectory, ChannelNameConflict, ChannelURLConflict, \
ChannelLinkConflict, ChannelDirectoryConflict, ChannelSourceIdConflict
@ -47,14 +47,7 @@ def load_channels_config() -> dict:
return channels
def get_allowed_limit(limit: int) -> int:
"""
Return the video limit int if it was passed, unless it is over the maximum limit. If no limit is provided, return
the default limit.
"""
if limit:
return min(int(limit), VIDEO_QUERY_MAX_LIMIT)
return VIDEO_QUERY_LIMIT
video_limiter = api_param_limiter(100)
class ConfigError(Exception):

4
modules/videos/video/api.py
View file

@ -10,7 +10,7 @@ from wrolpi.errors import ValidationError, InvalidOrderBy
from wrolpi.root_api import json_response
from wrolpi.schema import validate_doc, JSONErrorResponse
from .lib import get_video, VIDEO_ORDERS, DEFAULT_VIDEO_ORDER, video_search, get_video_for_app
from ..common import get_matching_directories, get_allowed_limit
from ..common import get_matching_directories, video_limiter
from ..lib import save_channels_config
from ..schema import VideoResponse, VideoSearchRequest, VideoSearchResponse, \
DirectoriesResponse, DirectoriesRequest
@ -45,7 +45,7 @@ async def search(_: Request, data: dict):
channel_link = data.get('channel_link')
order_by = data.get('order_by', DEFAULT_VIDEO_ORDER)
offset = int(data.get('offset', 0))
limit = get_allowed_limit(data.get('limit'))
limit = video_limiter(data.get('limit'))
filters = data.get('filters', None)
except Exception as e:
raise ValidationError('Unable to validate search queries') from e