From e60619b867c2bc1c5e2d9ac25003f2e4a01e2be7 Mon Sep 17 00:00:00 2001 From: Thomas Basler Date: Mon, 21 Nov 2022 23:28:53 +0100 Subject: [PATCH 01/11] Added device reboot functionality --- include/WebApi.h | 2 + include/WebApi_maintenance.h | 15 ++++ src/WebApi.cpp | 2 + src/WebApi_maintenance.cpp | 82 ++++++++++++++++++ webapp/src/components/NavBar.vue | 3 + webapp/src/router/index.ts | 6 ++ webapp/src/views/MaintenanceRebootView.vue | 97 ++++++++++++++++++++++ 7 files changed, 207 insertions(+) create mode 100644 include/WebApi_maintenance.h create mode 100644 src/WebApi_maintenance.cpp create mode 100644 webapp/src/views/MaintenanceRebootView.vue diff --git a/include/WebApi.h b/include/WebApi.h index e831f0b8e..5c8927f24 100644 --- a/include/WebApi.h +++ b/include/WebApi.h @@ -8,6 +8,7 @@ #include "WebApi_firmware.h" #include "WebApi_inverter.h" #include "WebApi_limit.h" +#include "WebApi_maintenance.h" #include "WebApi_mqtt.h" #include "WebApi_network.h" #include "WebApi_ntp.h" @@ -38,6 +39,7 @@ class WebApiClass { WebApiFirmwareClass _webApiFirmware; WebApiInverterClass _webApiInverter; WebApiLimitClass _webApiLimit; + WebApiMaintenanceClass _webApiMaintenance; WebApiMqttClass _webApiMqtt; WebApiNetworkClass _webApiNetwork; WebApiNtpClass _webApiNtp; diff --git a/include/WebApi_maintenance.h b/include/WebApi_maintenance.h new file mode 100644 index 000000000..dd7915375 --- /dev/null +++ b/include/WebApi_maintenance.h @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +#pragma once + +#include + +class WebApiMaintenanceClass { +public: + void init(AsyncWebServer* server); + void loop(); + +private: + void onRebootPost(AsyncWebServerRequest* request); + + AsyncWebServer* _server; +}; \ No newline at end of file diff --git a/src/WebApi.cpp b/src/WebApi.cpp index d522e7c5c..37941c2be 100644 --- a/src/WebApi.cpp +++ b/src/WebApi.cpp @@ -25,6 +25,7 @@ void WebApiClass::init() _webApiFirmware.init(&_server); _webApiInverter.init(&_server); _webApiLimit.init(&_server); + _webApiMaintenance.init(&_server); _webApiMqtt.init(&_server); _webApiNetwork.init(&_server); _webApiNtp.init(&_server); @@ -47,6 +48,7 @@ void WebApiClass::loop() _webApiFirmware.loop(); _webApiInverter.loop(); _webApiLimit.loop(); + _webApiMaintenance.loop(); _webApiMqtt.loop(); _webApiNetwork.loop(); _webApiNtp.loop(); diff --git a/src/WebApi_maintenance.cpp b/src/WebApi_maintenance.cpp new file mode 100644 index 000000000..9a1768223 --- /dev/null +++ b/src/WebApi_maintenance.cpp @@ -0,0 +1,82 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Copyright (C) 2022 Thomas Basler and others + */ + +#include "WebApi_maintenance.h" +#include "AsyncJson.h" +#include "WebApi.h" + +void WebApiMaintenanceClass::init(AsyncWebServer* server) +{ + using std::placeholders::_1; + + _server = server; + + _server->on("/api/maintenance/reboot", HTTP_POST, std::bind(&WebApiMaintenanceClass::onRebootPost, this, _1)); +} + +void WebApiMaintenanceClass::loop() +{ +} + +void WebApiMaintenanceClass::onRebootPost(AsyncWebServerRequest* request) +{ + if (!WebApi.checkCredentials(request)) { + return; + } + + AsyncJsonResponse* response = new AsyncJsonResponse(false, MQTT_JSON_DOC_SIZE); + JsonObject retMsg = response->getRoot(); + retMsg[F("type")] = F("warning"); + + if (!request->hasParam("data", true)) { + retMsg[F("message")] = F("No values found!"); + response->setLength(); + request->send(response); + return; + } + + String json = request->getParam("data", true)->value(); + + if (json.length() > MQTT_JSON_DOC_SIZE) { + retMsg[F("message")] = F("Data too large!"); + response->setLength(); + request->send(response); + return; + } + + DynamicJsonDocument root(MQTT_JSON_DOC_SIZE); + DeserializationError error = deserializeJson(root, json); + + if (error) { + retMsg[F("message")] = F("Failed to parse data!"); + response->setLength(); + request->send(response); + return; + } + + if (!(root.containsKey("reboot"))) { + retMsg[F("message")] = F("Values are missing!"); + response->setLength(); + request->send(response); + return; + } + + if (root[F("reboot")].as()) { + retMsg[F("type")] = F("success"); + retMsg[F("message")] = F("Reboot triggered!"); + + response->setLength(); + request->send(response); + yield(); + delay(1000); + yield(); + ESP.restart(); + } else { + retMsg[F("message")] = F("Reboot cancled!"); + + response->setLength(); + request->send(response); + } +} \ No newline at end of file diff --git a/webapp/src/components/NavBar.vue b/webapp/src/components/NavBar.vue index f86f587d9..178478708 100644 --- a/webapp/src/components/NavBar.vue +++ b/webapp/src/components/NavBar.vue @@ -46,6 +46,9 @@
  • Firmware Upgrade
    • +
  • + Device Reboot +
  • diff --git a/webapp/src/router/index.ts b/webapp/src/router/index.ts index 74a7d1231..ca4993841 100644 --- a/webapp/src/router/index.ts +++ b/webapp/src/router/index.ts @@ -14,6 +14,7 @@ import FirmwareUpgradeView from '@/views/FirmwareUpgradeView.vue' import ConfigAdminView from '@/views/ConfigAdminView.vue' import SecurityAdminView from '@/views/SecurityAdminView.vue' import LoginView from '@/views/LoginView.vue' +import MaintenanceRebootView from '@/views/MaintenanceRebootView.vue'; const router = createRouter({ history: createWebHistory(import.meta.env.BASE_URL), @@ -93,6 +94,11 @@ const router = createRouter({ path: '/settings/security', name: 'Security', component: SecurityAdminView + }, + { + path: '/maintenance/reboot', + name: 'Device Reboot', + component: MaintenanceRebootView } ] }); diff --git a/webapp/src/views/MaintenanceRebootView.vue b/webapp/src/views/MaintenanceRebootView.vue new file mode 100644 index 000000000..0806ebd9e --- /dev/null +++ b/webapp/src/views/MaintenanceRebootView.vue @@ -0,0 +1,97 @@ + + + From a06a8fec3d66eeeb4463f515d2771e213202762b Mon Sep 17 00:00:00 2001 From: Thomas Basler Date: Tue, 22 Nov 2022 20:37:01 +0100 Subject: [PATCH 02/11] webapp: Removed hardcoded info about views which require authentication If the return value of a API request equals 401 then the user will be redirected to the login page. Using this method it's possible to decided within the API if a authentication is needed or not. --- webapp/src/router/index.ts | 16 --------------- webapp/src/utils/authentication.ts | 18 ++++++++-------- webapp/src/views/ConfigAdminView.vue | 2 +- webapp/src/views/DtuAdminView.vue | 4 ++-- webapp/src/views/HomeView.vue | 24 +++++++++++----------- webapp/src/views/InverterAdminView.vue | 4 ++-- webapp/src/views/MaintenanceRebootView.vue | 2 +- webapp/src/views/MqttAdminView.vue | 4 ++-- webapp/src/views/MqttInfoView.vue | 5 +++-- webapp/src/views/NetworkAdminView.vue | 4 ++-- webapp/src/views/NetworkInfoView.vue | 5 +++-- webapp/src/views/NtpAdminView.vue | 8 ++++---- webapp/src/views/NtpInfoView.vue | 5 +++-- webapp/src/views/SecurityAdminView.vue | 4 ++-- webapp/src/views/SystemInfoView.vue | 5 +++-- 15 files changed, 50 insertions(+), 60 deletions(-) diff --git a/webapp/src/router/index.ts b/webapp/src/router/index.ts index ca4993841..eb81a019b 100644 --- a/webapp/src/router/index.ts +++ b/webapp/src/router/index.ts @@ -103,20 +103,4 @@ const router = createRouter({ ] }); -router.beforeEach((to, from, next) => { - // redirect to login page if not logged in and trying to access a restricted page - const publicPages = ['/', '/login', '/about', '/info/network', '/info/system', '/info/ntp', '/info/mqtt', ]; - const authRequired = !publicPages.includes(to.path); - const loggedIn = localStorage.getItem('user'); - - if (authRequired && !loggedIn) { - return next({ - path: '/login', - query: { returnUrl: to.path } - }); - } - - next(); -}); - export default router; \ No newline at end of file diff --git a/webapp/src/utils/authentication.ts b/webapp/src/utils/authentication.ts index 6d8276cec..0bcb178e6 100644 --- a/webapp/src/utils/authentication.ts +++ b/webapp/src/utils/authentication.ts @@ -1,17 +1,19 @@ import type { Emitter, EventType } from "mitt"; +import type { Router } from "vue-router"; export function authHeader(): Headers { // return authorization header with basic auth credentials - let user = JSON.parse(localStorage.getItem('user') || ""); + let user = null; + try { + user = JSON.parse(localStorage.getItem('user') || ""); + } catch { } + const headers = new Headers(); + headers.append('X-Requested-With', 'XMLHttpRequest'); if (user && user.authdata) { - const headers = new Headers(); headers.append('Authorization', 'Basic ' + user.authdata); - headers.append('X-Requested-With', 'XMLHttpRequest') - return new Headers(headers); - } else { - return new Headers(); } + return new Headers(headers); } export function logout() { @@ -47,7 +49,7 @@ export function login(username: String, password: String) { }); } -export function handleResponse(response: Response, emitter: Emitter>) { +export function handleResponse(response: Response, emitter: Emitter>, router: Router) { return response.text().then(text => { const data = text && JSON.parse(text); if (!response.ok) { @@ -55,7 +57,7 @@ export function handleResponse(response: Response, emitter: Emitter handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then( (response) => { this.alertMessage = response.message; diff --git a/webapp/src/views/DtuAdminView.vue b/webapp/src/views/DtuAdminView.vue index e23ba4060..802def3c7 100644 --- a/webapp/src/views/DtuAdminView.vue +++ b/webapp/src/views/DtuAdminView.vue @@ -79,7 +79,7 @@ export default defineComponent({ getDtuConfig() { this.dataLoading = true; fetch("/api/dtu/config", { headers: authHeader() }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then( (data) => { this.dtuConfigList = data; @@ -98,7 +98,7 @@ export default defineComponent({ headers: authHeader(), body: formData, }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then( (response) => { this.alertMessage = response.message; diff --git a/webapp/src/views/HomeView.vue b/webapp/src/views/HomeView.vue index 0d5c65faf..1256f1640 100644 --- a/webapp/src/views/HomeView.vue +++ b/webapp/src/views/HomeView.vue @@ -463,8 +463,8 @@ export default defineComponent({ isLoggedIn, getInitialData() { this.dataLoading = true; - fetch("/api/livedata/status") - .then((response) => response.json()) + fetch("/api/livedata/status", { headers: authHeader() }) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.liveData = data; this.dataLoading = false; @@ -526,8 +526,8 @@ export default defineComponent({ }, onShowEventlog(serial: number) { this.eventLogLoading = true; - fetch("/api/eventlog/status?inv=" + serial) - .then((response) => response.json()) + fetch("/api/eventlog/status?inv=" + serial, { headers: authHeader() }) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.eventLogList = data[serial]; this.eventLogLoading = false; @@ -540,8 +540,8 @@ export default defineComponent({ }, onShowDevInfo(serial: number) { this.devInfoLoading = true; - fetch("/api/devinfo/status") - .then((response) => response.json()) + fetch("/api/devinfo/status", { headers: authHeader() }) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.devInfoList = data[serial][0]; this.devInfoLoading = false; @@ -559,8 +559,8 @@ export default defineComponent({ this.targetLimitTypeText = "Relative (%)"; this.limitSettingLoading = true; - fetch("/api/limit/status") - .then((response) => response.json()) + fetch("/api/limit/status", { headers: authHeader() }) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.currentLimitList = data[serial]; this.targetLimitList.serial = serial; @@ -583,7 +583,7 @@ export default defineComponent({ headers: authHeader(), body: formData, }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then( (response) => { if (response.type == "success") { @@ -614,8 +614,8 @@ export default defineComponent({ onShowPowerSettings(serial: number) { this.powerSettingLoading = true; - fetch("/api/power/status") - .then((response) => response.json()) + fetch("/api/power/status", { headers: authHeader() }) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.successCommandPower = data[serial].power_set_status; this.powerSettingSerial = serial; @@ -653,7 +653,7 @@ export default defineComponent({ headers: authHeader(), body: formData, }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then( (response) => { if (response.type == "success") { diff --git a/webapp/src/views/InverterAdminView.vue b/webapp/src/views/InverterAdminView.vue index 981642eff..47f0585b3 100644 --- a/webapp/src/views/InverterAdminView.vue +++ b/webapp/src/views/InverterAdminView.vue @@ -207,7 +207,7 @@ export default defineComponent({ getInverters() { this.dataLoading = true; fetch("/api/inverter/list", { headers: authHeader() }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.inverters = data.inverter; this.dataLoading = false; @@ -222,7 +222,7 @@ export default defineComponent({ headers: authHeader(), body: formData, }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.getInverters(); this.alert = data; diff --git a/webapp/src/views/MaintenanceRebootView.vue b/webapp/src/views/MaintenanceRebootView.vue index 0806ebd9e..5d8d415d0 100644 --- a/webapp/src/views/MaintenanceRebootView.vue +++ b/webapp/src/views/MaintenanceRebootView.vue @@ -78,7 +78,7 @@ export default defineComponent({ headers: authHeader(), body: formData, }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.alertMessage = data.message; this.alertType = data.type; diff --git a/webapp/src/views/MqttAdminView.vue b/webapp/src/views/MqttAdminView.vue index 769412946..b905aaff9 100644 --- a/webapp/src/views/MqttAdminView.vue +++ b/webapp/src/views/MqttAdminView.vue @@ -242,7 +242,7 @@ export default defineComponent({ getMqttConfig() { this.dataLoading = true; fetch("/api/mqtt/config", { headers: authHeader() }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then((data) => { this.mqttConfigList = data; this.dataLoading = false; @@ -259,7 +259,7 @@ export default defineComponent({ headers: authHeader(), body: formData, }) - .then((response) => handleResponse(response, this.$emitter)) + .then((response) => handleResponse(response, this.$emitter, this.$router)) .then( (response) => { this.alertMessage = response.message; diff --git a/webapp/src/views/MqttInfoView.vue b/webapp/src/views/MqttInfoView.vue index 2f20f46d6..43cc2331e 100644 --- a/webapp/src/views/MqttInfoView.vue +++ b/webapp/src/views/MqttInfoView.vue @@ -149,6 +149,7 @@