patrick/OpenDTU
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Introduce numeric error codes in network webapi

Browse Source
This commit is contained in:
Thomas Basler 2022-12-23 20:06:22 +01:00
parent cacebf8a82
commit 3e8c7a4c10
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/WebApi_errors.h
View File

@ -54,4 +54,11 @@ enum WebApiError {
MqttPublishInterval, MqttPublishInterval,
MqttHassTopicLength, MqttHassTopicLength,
MqttHassTopicCharacter, MqttHassTopicCharacter,
NetworkBase = 8000,
NetworkIpInvalid,
NetworkNetmaskInvalid,
NetworkGatewayInvalid,
NetworkDns1Invalid,
NetworkDns2Invalid,
}; };

11
src/WebApi_network.cpp
View File

@ -6,6 +6,7 @@
#include "Configuration.h" #include "Configuration.h"
#include "NetworkSettings.h" #include "NetworkSettings.h"
#include "WebApi.h" #include "WebApi.h"
#include "WebApi_errors.h"
#include "helper.h" #include "helper.h"
#include <AsyncJson.h> #include <AsyncJson.h>
@ -90,6 +91,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
if (!request->hasParam("data", true)) { if (!request->hasParam("data", true)) {
retMsg[F("message")] = F("No values found!"); retMsg[F("message")] = F("No values found!");
retMsg[F("code")] = WebApiError::GenericNoValueFound;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -99,6 +101,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
if (json.length() > 1024) { if (json.length() > 1024) {
retMsg[F("message")] = F("Data too large!"); retMsg[F("message")] = F("Data too large!");
retMsg[F("code")] = WebApiError::GenericDataTooLarge;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -109,6 +112,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
if (error) { if (error) {
retMsg[F("message")] = F("Failed to parse data!"); retMsg[F("message")] = F("Failed to parse data!");
retMsg[F("code")] = WebApiError::GenericParseError;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -116,6 +120,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
if (!(root.containsKey("ssid") && root.containsKey("password") && root.containsKey("hostname") && root.containsKey("dhcp") && root.containsKey("ipaddress") && root.containsKey("netmask") && root.containsKey("gateway") && root.containsKey("dns1") && root.containsKey("dns2"))) { if (!(root.containsKey("ssid") && root.containsKey("password") && root.containsKey("hostname") && root.containsKey("dhcp") && root.containsKey("ipaddress") && root.containsKey("netmask") && root.containsKey("gateway") && root.containsKey("dns1") && root.containsKey("dns2"))) {
retMsg[F("message")] = F("Values are missing!"); retMsg[F("message")] = F("Values are missing!");
retMsg[F("code")] = WebApiError::GenericValueMissing;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -124,6 +129,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
IPAddress ipaddress; IPAddress ipaddress;
if (!ipaddress.fromString(root[F("ipaddress")].as<String>())) { if (!ipaddress.fromString(root[F("ipaddress")].as<String>())) {
retMsg[F("message")] = F("IP address is invalid!"); retMsg[F("message")] = F("IP address is invalid!");
retMsg[F("code")] = WebApiError::NetworkIpInvalid;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -131,6 +137,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
IPAddress netmask; IPAddress netmask;
if (!netmask.fromString(root[F("netmask")].as<String>())) { if (!netmask.fromString(root[F("netmask")].as<String>())) {
retMsg[F("message")] = F("Netmask is invalid!"); retMsg[F("message")] = F("Netmask is invalid!");
retMsg[F("code")] = WebApiError::NetworkNetmaskInvalid;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -138,6 +145,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
IPAddress gateway; IPAddress gateway;
if (!gateway.fromString(root[F("gateway")].as<String>())) { if (!gateway.fromString(root[F("gateway")].as<String>())) {
retMsg[F("message")] = F("Gateway is invalid!"); retMsg[F("message")] = F("Gateway is invalid!");
retMsg[F("code")] = WebApiError::NetworkGatewayInvalid;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -145,6 +153,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
IPAddress dns1; IPAddress dns1;
if (!dns1.fromString(root[F("dns1")].as<String>())) { if (!dns1.fromString(root[F("dns1")].as<String>())) {
retMsg[F("message")] = F("DNS Server IP 1 is invalid!"); retMsg[F("message")] = F("DNS Server IP 1 is invalid!");
retMsg[F("code")] = WebApiError::NetworkDns1Invalid;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -152,6 +161,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
IPAddress dns2; IPAddress dns2;
if (!dns2.fromString(root[F("dns2")].as<String>())) { if (!dns2.fromString(root[F("dns2")].as<String>())) {
retMsg[F("message")] = F("DNS Server IP 2 is invalid!"); retMsg[F("message")] = F("DNS Server IP 2 is invalid!");
retMsg[F("code")] = WebApiError::NetworkDns2Invalid;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -211,6 +221,7 @@ void WebApiNetworkClass::onNetworkAdminPost(AsyncWebServerRequest* request)
retMsg[F("type")] = F("success"); retMsg[F("type")] = F("success");
retMsg[F("message")] = F("Settings saved!"); retMsg[F("message")] = F("Settings saved!");
retMsg[F("code")] = WebApiError::GenericSuccess;
response->setLength(); response->setLength();
request->send(response); request->send(response);