wrolpi/wrolpi/errors.py
2022-02-16 21:57:27 -07:00

329 lines
7.4 KiB
Python

from http import HTTPStatus
# TODO remove service-specific errors
class APIError(Exception):
pass
class UnknownVideo(APIError):
pass
class UnknownChannel(APIError):
pass
class UnknownDirectory(APIError):
pass
class UnknownFile(APIError):
pass
class ChannelNameConflict(APIError):
pass
class ChannelURLConflict(APIError):
pass
class ChannelDirectoryConflict(APIError):
pass
class ChannelSourceIdConflict(APIError):
pass
class SearchEmpty(APIError):
pass
class UnknownCaptionFile(APIError):
pass
class ValidationError(APIError):
pass
class ChannelLinkConflict(APIError):
pass
class BadFieldType(APIError):
pass
class MissingRequiredField(APIError):
pass
class ExcessJSONFields(APIError):
pass
class NoBodyContents(APIError):
pass
class InvalidOrderBy(ValidationError):
pass
class WROLModeEnabled(APIError):
pass
class ChannelURLEmpty(APIError):
pass
class InvalidOTP(APIError):
pass
class InvalidPlaintext(APIError):
pass
class InvalidCiphertext(APIError):
pass
class NoFrequency(APIError):
pass
class NoInventories(APIError):
pass
class InventoriesVersionMismatch(APIError):
pass
class InvalidTimezone(APIError):
pass
class InvalidDomain(APIError):
pass
class UnknownURL(APIError):
pass
class PendingArchive(APIError):
pass
class InvalidArchive(APIError):
pass
class InvalidDownload(APIError):
pass
class UnrecoverableDownloadError(APIError):
pass
class InvalidFile(APIError):
pass
class NativeOnly(APIError):
pass
class HotspotError(APIError):
pass
error_codes = iter(range(1, 1000))
API_ERRORS = {
UnknownVideo: {
'code': next(error_codes),
'message': 'The video could not be found.',
'status': HTTPStatus.NOT_FOUND,
},
UnknownChannel: {
'code': next(error_codes),
'message': 'The channel could not be found by its link.',
'status': HTTPStatus.NOT_FOUND,
},
UnknownDirectory: {
'code': next(error_codes),
'message': 'The directory does not exist.',
'status': HTTPStatus.NOT_FOUND,
},
UnknownFile: {
'code': next(error_codes),
'message': 'The file does not exist.',
'status': HTTPStatus.NOT_FOUND,
},
ChannelNameConflict: {
'code': next(error_codes),
'message': 'The channel name is already taken.',
'status': HTTPStatus.BAD_REQUEST,
},
ChannelURLConflict: {
'code': next(error_codes),
'message': 'The URL is already used by another channel.',
'status': HTTPStatus.BAD_REQUEST,
},
ChannelDirectoryConflict: {
'code': next(error_codes),
'message': 'The directory is already used by another channel.',
'status': HTTPStatus.BAD_REQUEST,
},
SearchEmpty: {
'code': next(error_codes),
'message': 'Search is empty, search_str must have content.',
'status': HTTPStatus.BAD_REQUEST,
},
UnknownCaptionFile: {
'code': next(error_codes),
'message': 'The caption file could not be found',
'status': HTTPStatus.NOT_FOUND,
},
ValidationError: {
'code': next(error_codes),
'message': 'Could not validate the contents of the request',
'status': HTTPStatus.BAD_REQUEST,
},
ChannelLinkConflict: {
'code': next(error_codes),
'message': 'Channel link already used by another channel',
'status': HTTPStatus.BAD_REQUEST,
},
BadFieldType: {
'code': next(error_codes),
'message': 'Field could not be converted to the required type',
'status': HTTPStatus.BAD_REQUEST,
},
MissingRequiredField: {
'code': next(error_codes),
'message': 'Missing required field',
'status': HTTPStatus.BAD_REQUEST,
},
ExcessJSONFields: {
'code': next(error_codes),
'message': 'Extra fields in request',
'status': HTTPStatus.BAD_REQUEST,
},
NoBodyContents: {
'code': next(error_codes),
'message': 'No content in the body of the request',
'status': HTTPStatus.BAD_REQUEST,
},
InvalidOrderBy: {
'code': next(error_codes),
'message': 'Invalid order_by',
'status': HTTPStatus.BAD_REQUEST,
},
WROLModeEnabled: {
'code': next(error_codes),
'message': 'This method is disabled while WROL Mode is enabled.',
'status': HTTPStatus.FORBIDDEN,
},
ChannelURLEmpty: {
'code': next(error_codes),
'message': 'This channel has no URL',
'status': HTTPStatus.BAD_REQUEST,
},
InvalidOTP: {
'code': next(error_codes),
'message': 'OTP has invalid characters',
'status': HTTPStatus.BAD_REQUEST,
},
InvalidPlaintext: {
'code': next(error_codes),
'message': 'Plaintext has invalid characters',
'status': HTTPStatus.BAD_REQUEST,
},
InvalidCiphertext: {
'code': next(error_codes),
'message': 'Ciphertext has invalid characters',
'status': HTTPStatus.BAD_REQUEST,
},
NoFrequency: {
'code': next(error_codes),
'message': 'Channel does not have a frequency',
'status': HTTPStatus.BAD_REQUEST,
},
NoInventories: {
'code': next(error_codes),
'message': 'No Inventories',
'status': HTTPStatus.BAD_REQUEST,
},
InventoriesVersionMismatch: {
'code': next(error_codes),
'message': 'Inventories version in the DB does not match the inventories config',
'status': HTTPStatus.BAD_REQUEST,
},
InvalidTimezone: {
'code': next(error_codes),
'message': 'Invalid timezone',
'status': HTTPStatus.BAD_REQUEST,
},
InvalidDomain: {
'code': next(error_codes),
'message': 'Invalid archive domain',
'status': HTTPStatus.BAD_REQUEST,
},
UnknownURL: {
'code': next(error_codes),
'message': 'Unknown URL',
'status': HTTPStatus.BAD_REQUEST,
},
PendingArchive: {
'code': next(error_codes),
'message': 'Archive with that URL is already pending',
'status': HTTPStatus.BAD_REQUEST,
},
InvalidArchive: {
'code': next(error_codes),
'message': 'The archive is invalid. See server logs.',
'status': HTTPStatus.INTERNAL_SERVER_ERROR,
},
InvalidDownload: {
'code': next(error_codes),
'message': 'The URL cannot be downloaded.',
'status': HTTPStatus.BAD_REQUEST,
},
ChannelSourceIdConflict: {
'code': next(error_codes),
'message': 'Channel with source id already exists',
'status': HTTPStatus.INTERNAL_SERVER_ERROR,
},
UnrecoverableDownloadError: {
'code': next(error_codes),
'message': 'Download experienced an error which cannot be recovered. Download will be deleted.',
'status': HTTPStatus.INTERNAL_SERVER_ERROR,
},
InvalidFile: {
'code': next(error_codes),
'message': 'File does not exist or is a directory',
'status': HTTPStatus.BAD_REQUEST,
},
NativeOnly: {
'code': next(error_codes),
'message': 'This functionality is only supported outside a docker container',
'status': HTTPStatus.BAD_REQUEST,
},
HotspotError: {
'code': next(error_codes),
'message': 'Updating/accessing Hotspot encountered an error',
'status': HTTPStatus.INTERNAL_SERVER_ERROR,
}
}