wrolpi/wrolpi/schema.py
Roland 0a2e343201
Some checks failed
CodeQL / Analyze (push) Has been cancelled
Controller Tests / controller-tests (push) Has been cancelled
Jest Tests / jest-tests (push) Has been cancelled
Adding new key to download settings for feature to skip already downloaded resources.
2026-05-05 20:24:10 -06:00

416 lines
11 KiB
Python

import enum
import pathlib
from dataclasses import dataclass, field
from typing import Optional, List
from wrolpi.common import get_relative_to_media_directory, unique_by_predicate
from wrolpi.errors import InvalidDownload, ValidationError
@dataclass
class SettingsObject:
media_directory: str
@dataclass
class SettingsResponse:
download_manager_disabled: bool
download_manager_stopped: bool
download_on_startup: bool
download_timeout: int
download_wait: int
download_window_start: Optional[str]
download_window_end: Optional[str]
hotspot_device: str
hotspot_on_startup: bool
hotspot_password: str
hotspot_ssid: str
hotspot_status: str
ignore_outdated_zims: str
ignored_directories: str
log_level: str
nav_color: str
media_directory: str
require_cookies_unlocked: bool
tags_directory: bool
throttle_on_startup: bool
throttle_status: str
version: str
wrol_mode: bool
archive_destination: str = 'archive/%(domain_tag)s/%(domain)s'
map_destination: str = 'map'
videos_destination: str = 'videos/%(channel_tag)s/%(channel_name)s'
zims_destination: str = 'zims'
class SemanticUIColors(enum.StrEnum):
red = enum.auto()
orange = enum.auto()
yellow = enum.auto()
olive = enum.auto()
green = enum.auto()
teal = enum.auto()
blue = enum.auto()
violet = enum.auto()
purple = enum.auto()
pink = enum.auto()
brown = enum.auto()
grey = enum.auto()
@dataclass
class SettingsRequest:
archive_destination: Optional[str] = None
download_on_startup: Optional[bool] = None
download_timeout: Optional[int] = None
download_wait: Optional[int] = None
download_window_start: Optional[str] = None
download_window_end: Optional[str] = None
hotspot_device: Optional[str] = None
hotspot_on_startup: Optional[bool] = None
hotspot_password: Optional[str] = None
hotspot_ssid: Optional[str] = None
hotspot_status: Optional[bool] = None
check_for_upgrades: Optional[bool] = None
ignore_outdated_zims: Optional[bool] = None
log_level: Optional[int] = None
map_destination: Optional[str] = None
nav_color: Optional[str] = None
media_directory: Optional[str] = None
tags_directory: Optional[bool] = None
throttle_on: Optional[bool] = None
throttle_on_startup: Optional[bool] = None
videos_destination: Optional[str] = None
wrol_mode: Optional[bool] = None
zims_destination: Optional[str] = None
require_cookies_unlocked: Optional[bool] = None
save_ffprobe_json: Optional[bool] = None
timezone: Optional[str] = None
def __post_init__(self):
self.nav_color = self.nav_color.lower() if self.nav_color else None
if self.nav_color and self.nav_color not in SemanticUIColors.__members__:
raise ValidationError('Nav color is invalid')
@dataclass
class FlagsStatusResponse:
db_up: bool
file_worker_busy: bool
file_worker_cleanup: bool
file_worker_counting: bool
file_worker_discovery: bool
file_worker_indexing: bool
file_worker_modeling: bool
global_refresh_active: bool
have_internet: bool
outdated_zims: bool
refresh_complete: bool
@dataclass
class CPUStatusResponse:
cores: int
cur_frequency: int
max_frequency: int
min_frequency: int
percent: int
temperature: int
high_temperature: int
critical_temperature: int
@dataclass
class LoadStatusStat:
minute_1: int
minute_5: int
minute_15: int
@dataclass
class DriveStatusStat:
mount: str
percent: int
size: int
used: int
@dataclass
class ProcessStatusStat:
pid: int
percent_cpu: int
percent_mem: int
command: str
@dataclass
class MemoryStatusStat:
total: int
used: int
free: int
cached: int
@dataclass
class NicBandwidthStatusStat:
name: str
now: float
bytes_recv: int
bytes_sent: int
speed: int
bytes_recv_ps: int
bytes_sent_ps: int
elapsed: int
@dataclass
class DiskBandwidthStatusStat:
bytes_read: int
bytes_read_ps: int
bytes_write: int
bytes_write_ps: int
elapsed: int
max_read_ps: int
max_write_ps: int
name: str
now: float
speed: int
@dataclass
class StatusResponse:
cpu_stats: CPUStatusResponse
disk_bandwidth_stats: dict[str, DiskBandwidthStatusStat]
dockerized: bool
downloads: int
drive_status: List[DriveStatusStat]
flags: FlagsStatusResponse
hotspot_ssid: str
hotspot_status: str
is_rpi4: bool
is_rpi5: bool
is_rpi: bool
last_status: str
load_stats: LoadStatusStat
memory_stats: MemoryStatusStat
nic_bandwidth_stats: dict[str, NicBandwidthStatusStat]
processes_stats: List[ProcessStatusStat]
sanic_workers: dict
throttle_status: str
version: str
wrol_mode: str
@dataclass
class RegexRequest:
regex: str
@dataclass
class RegexResponse:
regex: str
valid: bool
@dataclass
class EchoResponse:
form: dict
headers: dict
json: str
method: str
@dataclass
class DownloadSettings:
channel_id: Optional[int] = None
channel_tag_name: List[str] = field(default_factory=list)
channel_url: Optional[str] = None
collection_id: Optional[int] = None
depth: Optional[int] = None
destination: Optional[str] = None # Legacy support
download_metadata_only: bool = False
download_order: Optional[str] = None
excluded_urls: Optional[str] = None
max_pages: Optional[int] = None
maximum_duration: Optional[int] = None
minimum_duration: Optional[int] = None
suffix: Optional[str] = None
tag_names: Optional[List[str]] = None # Legacy support
title_exclude: Optional[str] = None
title_include: Optional[str] = None
video_count_limit: Optional[int] = None
video_format: Optional[str] = None
video_resolutions: List[str] = field(default_factory=list)
parent_download_url: Optional[str] = None
skip_already_downloaded: Optional[bool] = None
# Inheritable video settings (Optional so they're only set when user overrides)
writesubtitles: Optional[bool] = None
writeautomaticsub: Optional[bool] = None
writethumbnail: Optional[bool] = None
writeinfojson: Optional[bool] = None
yt_dlp_extra_args: Optional[str] = None
sleep_requests: Optional[float] = None
user_agent: Optional[str] = None
continue_dl: Optional[bool] = None
nooverwrites: Optional[bool] = None
audio_only: Optional[bool] = None
audio_format: Optional[str] = None
def __post_init__(self):
if self.excluded_urls and self.excluded_urls.endswith(','):
raise ValidationError('Excluded urls cannot end with ,')
if self.excluded_urls and self.excluded_urls.startswith(','):
raise ValidationError('Excluded urls cannot start with ,')
if self.suffix and not self.suffix.startswith('.'):
raise ValidationError('suffix must start with .')
self.title_exclude = self.title_exclude or None
self.title_include = self.title_include or None
if not self.download_metadata_only:
del self.download_metadata_only
if self.download_order not in (None, 'newest', 'oldest', 'views'):
raise ValidationError(f'Download order must be one of newest, oldest, views, or null.')
if self.video_format not in (None, 'mp4', 'mkv', 'ogg', 'webm'):
raise ValidationError(f'Video format must be one of mp4, mkv, ogg, webm, or null.')
if self.audio_format not in (None, 'mp3', 'opus', 'm4a', 'flac', 'vorbis', 'wav'):
raise ValidationError(f'Audio format must be one of mp3, opus, m4a, flac, vorbis, wav, or null.')
valid_resolutions = ('360p', '480p', '720p', '1080p', '1440p', '2160p', 'maximum')
if not all(i in valid_resolutions for i in self.video_resolutions):
raise ValidationError(f'Download order must be one of 360p, 480p, 720p, 1080p, 1440p, 2160p, or maximum.')
@dataclass
class DownloadRequest:
urls: List[str]
downloader: str
destination: Optional[str] = None
tag_names: Optional[List[str]] = field(default_factory=list)
frequency: Optional[int] = None
sub_downloader: Optional[str] = None
settings: Optional[dict] = field(default_factory=dict)
collection_id: Optional[int] = None
def __post_init__(self):
urls = [j for i in self.urls if (j := i.strip())]
if not urls:
raise InvalidDownload(f'urls cannot be empty')
# Get unique URLs, preserve order.
self.urls = unique_by_predicate(urls)
if self.destination:
destination = pathlib.Path(self.destination)
if destination.is_absolute():
destination = get_relative_to_media_directory(destination)
self.destination = str(destination)
self.tag_names = self.tag_names or []
# Validate settings contents. Remove empty values.
settings = self.settings or dict()
self.settings = {k: v for k, v in DownloadSettings(**settings).__dict__.items() if v not in ([], None)}
@dataclass
class DownloadBatchRequest:
"""Request for batch operations on downloads."""
download_ids: List[int]
def __post_init__(self):
if not self.download_ids:
raise ValidationError('download_ids cannot be empty')
@dataclass
class JSONErrorResponse:
error: str
@dataclass
class EventsRequest:
after: Optional[str] = None
@dataclass
class TagRequest:
name: str
color: str
@dataclass
class DeleteTagRequest:
name: str
@dataclass
class NotifyRequest:
message: str
url: str = None
@dataclass
class VINDecoderRequest:
vin_number: str
@dataclass
class VIN:
country: str
manufacturer: str
region: str
years: str
body: str = None
engine: str = None
model: str = None
plant: str = None
transmission: str = None
serial: str = None
def __json__(self) -> dict:
d = dict(
country=self.country,
manufacturer=self.manufacturer,
region=self.region,
years=self.years,
body=self.body,
engine=self.engine,
model=self.model,
plant=self.plant,
transmission=self.transmission,
serial=self.serial,
)
return d
@dataclass
class VINDecoderResponse:
vin: VIN
@dataclass
class SearchSuggestionsRequest:
search_str: Optional[str] = None
order_by_video_count: bool = True
@dataclass
class SearchFileEstimateRequest:
search_str: Optional[str] = None
mimetypes: List[str] = field(default_factory=list)
tag_names: List[str] = field(default_factory=list)
months: Optional[List[int]] = None
from_year: Optional[int] = None
to_year: Optional[int] = None
any_tag: bool = False
def __post_init__(self):
if self.any_tag and self.tag_names:
raise ValidationError('Cannot search for any tag, and list of tags.')
@dataclass
class SearchOtherEstimateRequest:
tag_names: List[str] = field(default_factory=list)