Файл error_handlers.cpp

#include "../../include/web_routes.h"
#include "../../include/logger.h"
#include "../../include/jxct_config_vars.h"
#include "../../include/jxct_ui_system.h"
#include "../wifi_manager.h"
#include "../../include/jxct_strings.h"

См. исходные тексты.

Макросы
#define	API_CONFIG_EXPORT   API_ROOT "/config/export"

Функции
void	setupErrorHandlers ()
	Настройка обработчиков ошибок (404, 500, и т.
bool	validateConfigInput (bool checkRequired)
	Валидация входных данных конфигурации
void	handleUploadError (const String &error)
	Обработка ошибок загрузки файлов
bool	isFeatureAvailable (const String &feature)
	Проверка доступности функции в текущем режиме WiFi.
bool	isFeatureAvailable ()
	Проверка доступности функции в текущем режиме WiFi (без параметров)
void	logWebRequest (const String &method, const String &uri, const String &clientIP)
	Логирование веб-запросов
String	generateValidationErrorResponse (const String &errorMsg)
	Генерация HTML ответа с ошибкой валидации
void	handleCriticalError (const String &error)
	Обработка критических ошибок сервера
bool	isRouteAvailable (const String &uri)
	Проверка доступности маршрута в текущем режиме
bool	checkRouteAccess (const String &routeName, const String &icon)
	Middleware для проверки доступности маршрута Используется в каждом маршруте, который недоступен в AP режиме

Макросы

API_CONFIG_EXPORT

#define API_CONFIG_EXPORT   API_ROOT "/config/export"

Используется в setupConfigRoutes().

Функции

checkRouteAccess()

bool checkRouteAccess	(	const String &	routeName,
		const String &	icon )

Middleware для проверки доступности маршрута Используется в каждом маршруте, который недоступен в AP режиме

Middleware для проверки доступности маршрута

См. определение в файле error_handlers.cpp строка 215

Перекрестные ссылки generateApModeUnavailablePage(), isRouteAvailable() и webServer.

generateValidationErrorResponse()

String generateValidationErrorResponse

(

const String &

errorMsg

)

Генерация HTML ответа с ошибкой валидации

Аргументы

errorMsg

Сообщение об ошибке

Возвращает

HTML ответ с ошибкой

См. определение в файле error_handlers.cpp строка 172

Перекрестные ссылки generateBasePage(), generateFormError() и UI_ICON_CONFIG.

Используется в setupMainRoutes().

handleCriticalError()

void handleCriticalError

(

const String &

error

)

Обработка критических ошибок сервера

Аргументы

error

Описание ошибки

См. определение в файле error_handlers.cpp строка 188

Перекрестные ссылки generateErrorPage(), logError() и webServer.

handleUploadError()

void handleUploadError

(

const String &

error

)

Обработка ошибок загрузки файлов

Аргументы

error

Описание ошибки

См. определение в файле error_handlers.cpp строка 123

Перекрестные ссылки generateErrorPage(), logError() и webServer.

isFeatureAvailable() [1/2]

bool isFeatureAvailable

(

)

Проверка доступности функции в текущем режиме WiFi (без параметров)

Возвращает

true если функция доступна в текущем режиме

См. определение в файле error_handlers.cpp строка 147

Перекрестные ссылки isFeatureAvailable().

Используется в isFeatureAvailable().

isFeatureAvailable() [2/2]

bool isFeatureAvailable

(

const String &

feature

)

Проверка доступности функции в текущем режиме WiFi.

Аргументы

feature

Название функции для проверки

Возвращает

true если функция доступна в текущем режиме

См. определение в файле error_handlers.cpp строка 131

Перекрестные ссылки AP и currentWiFiMode.

isRouteAvailable()

bool isRouteAvailable

(

const String &

uri

)

Проверка доступности маршрута в текущем режиме

Аргументы

uri	URI запроса

Возвращает

true если маршрут доступен

См. определение в файле error_handlers.cpp строка 201

Перекрестные ссылки AP и currentWiFiMode.

Используется в checkRouteAccess().

logWebRequest()

void logWebRequest	(	const String &	method,
		const String &	uri,
		const String &	clientIP )

Логирование веб-запросов

Аргументы

method	HTTP метод
uri	URI запроса
clientIP	IP клиента

См. определение в файле error_handlers.cpp строка 152

Перекрестные ссылки API_SENSOR, logDebug() и logInfo().

Используется в sendConfigExportJson(), sendHealthJson(), sendSensorJson(), sendServiceStatusJson(), setupConfigRoutes(), setupDataRoutes(), setupErrorHandlers(), setupMainRoutes(), setupOtaRoutes() и setupServiceRoutes().

setupErrorHandlers()

void setupErrorHandlers

(

)

Настройка обработчиков ошибок (404, 500, и т.

д.)

См. определение в файле error_handlers.cpp строка 8

Перекрестные ссылки generateErrorPage(), logWarn(), logWebRequest() и webServer.

Используется в setupWebServer().

validateConfigInput()

bool validateConfigInput

(

bool

checkRequired = true

)

Валидация входных данных конфигурации

Аргументы

checkRequired

Проверять ли обязательные поля

Возвращает

true если валидация прошла успешно

См. определение в файле error_handlers.cpp строка 30

Перекрестные ссылки currentWiFiMode, logDebug(), logWarn(), STA и webServer.

Используется в setupMainRoutes().