diff --git a/public/locales/en/common.json b/public/locales/en/common.json
index 2c0e1dfc..0efa1150 100644
--- a/public/locales/en/common.json
+++ b/public/locales/en/common.json
@@ -32,6 +32,7 @@
},
"resources": {
"cpu": "CPU",
+ "mem": "MEM",
"total": "Total",
"free": "Free",
"used": "Used",
@@ -461,6 +462,11 @@
"series": "Series",
"books": "Books"
},
+ "diskstation": {
+ "days": "Days",
+ "uptime": "Uptime",
+ "volumeAvailable": "Available"
+ },
"mylar": {
"series": "Series",
"issues": "Issues",
diff --git a/src/components/services/widget/container.jsx b/src/components/services/widget/container.jsx
index 945b8f6f..11dd4f56 100644
--- a/src/components/services/widget/container.jsx
+++ b/src/components/services/widget/container.jsx
@@ -9,7 +9,18 @@ export default function Container({ error = false, children, service }) {
const fields = service?.widget?.fields;
const type = service?.widget?.type;
if (fields && type) {
- visibleChildren = children.filter(child => fields.some(field => `${type}.${field}` === child?.props?.label));
+ // if the field contains a "." then it most likely contains a common loc value
+ // logic now allows a fields array that can look like:
+ // fields: [ "resources.cpu", "resources.mem", "field"]
+ // or even
+ // fields: [ "resources.cpu", "widget_type.field" ]
+ visibleChildren = children.filter(child => fields.some(field => {
+ let fullField = field;
+ if (!field.includes(".")) {
+ fullField = `${type}.${field}`;
+ }
+ return fullField === child?.props?.label;
+ }));
}
return {visibleChildren}
;
diff --git a/src/utils/proxy/handlers/synology.js b/src/utils/proxy/handlers/synology.js
new file mode 100644
index 00000000..9895e113
--- /dev/null
+++ b/src/utils/proxy/handlers/synology.js
@@ -0,0 +1,176 @@
+import cache from "memory-cache";
+
+import getServiceWidget from "utils/config/service-helpers";
+import { asJson, formatApiCall } from "utils/proxy/api-helpers";
+import { httpProxy } from "utils/proxy/http";
+import createLogger from "utils/logger";
+import widgets from "widgets/widgets";
+
+const INFO_ENDPOINT = "{url}/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query";
+const AUTH_ENDPOINT = "{url}/webapi/{path}?api=SYNO.API.Auth&version={maxVersion}&method=login&account={username}&passwd={password}&session=DownloadStation&format=cookie";
+const AUTH_API_NAME = "SYNO.API.Auth";
+
+const proxyName = "synologyProxyHandler";
+const logger = createLogger(proxyName);
+
+async function login(loginUrl) {
+ const [status, contentType, data] = await httpProxy(loginUrl);
+ if (status !== 200) {
+ return [status, contentType, data];
+ }
+
+ const json = asJson(data);
+ if (json?.success !== true) {
+ // from page 16: https://global.download.synology.com/download/Document/Software/DeveloperGuide/Os/DSM/All/enu/DSM_Login_Web_API_Guide_enu.pdf
+ /*
+ Code Description
+ 400 No such account or incorrect password
+ 401 Account disabled
+ 402 Permission denied
+ 403 2-step verification code required
+ 404 Failed to authenticate 2-step verification code
+ */
+ let message = "Authentication failed.";
+ if (json?.error?.code >= 403) message += " 2FA enabled.";
+ logger.warn("Unable to login. Code: %d", json?.error?.code);
+ return [401, "application/json", JSON.stringify({ code: json?.error?.code, message })];
+ }
+
+ return [status, contentType, data];
+}
+
+async function getApiInfo(serviceWidget, apiName, serviceName) {
+ const cacheKey = `${proxyName}__${apiName}__${serviceName}`
+ let { cgiPath, maxVersion } = cache.get(cacheKey) ?? {};
+ if (cgiPath && maxVersion) {
+ return [cgiPath, maxVersion];
+ }
+
+ const infoUrl = formatApiCall(INFO_ENDPOINT, serviceWidget);
+ // eslint-disable-next-line no-unused-vars
+ const [status, contentType, data] = await httpProxy(infoUrl);
+
+ if (status === 200) {
+ try {
+ const json = asJson(data);
+ if (json?.data?.[apiName]) {
+ cgiPath = json.data[apiName].path;
+ maxVersion = json.data[apiName].maxVersion;
+ logger.debug(`Detected ${serviceWidget.type}: apiName '${apiName}', cgiPath '${cgiPath}', and maxVersion ${maxVersion}`);
+ cache.put(cacheKey, { cgiPath, maxVersion });
+ return [cgiPath, maxVersion];
+ }
+ }
+ catch {
+ logger.warn(`Error ${status} obtaining ${apiName} info`);
+ }
+ }
+
+ return [null, null];
+}
+
+async function handleUnsuccessfulResponse(serviceWidget, url, serviceName) {
+ logger.debug(`Attempting login to ${serviceWidget.type}`);
+
+ // eslint-disable-next-line no-unused-vars
+ const [apiPath, maxVersion] = await getApiInfo(serviceWidget, AUTH_API_NAME, serviceName);
+
+ const authArgs = { path: apiPath ?? "entry.cgi", maxVersion: maxVersion ?? 7, ...serviceWidget };
+ const loginUrl = formatApiCall(AUTH_ENDPOINT, authArgs);
+
+ const [status, contentType, data] = await login(loginUrl);
+ if (status !== 200) {
+ return [status, contentType, data];
+ }
+
+ return httpProxy(url);
+}
+
+function toError(url, synologyError) {
+ // commeon codes (100 => 199) from:
+ // https://global.download.synology.com/download/Document/Software/DeveloperGuide/Os/DSM/All/enu/DSM_Login_Web_API_Guide_enu.pdf
+ const code = synologyError.error?.code ?? synologyError.error ?? synologyError.code ?? 100;
+ const error = { code };
+ switch (code) {
+ case 102:
+ error.error = "The requested API does not exist.";
+ break;
+
+ case 103:
+ error.error = "The requested method does not exist.";
+ break;
+
+ case 104:
+ error.error = "The requested version does not support the functionality.";
+ break;
+
+ case 105:
+ error.error = "The logged in session does not have permission.";
+ break;
+
+ case 106:
+ error.error = "Session timeout.";
+ break;
+
+ case 107:
+ error.error = "Session interrupted by duplicated login.";
+ break;
+
+ case 119:
+ error.error = "Invalid session or SID not found.";
+ break;
+
+ default:
+ error.error = synologyError.message ?? "Unknown error.";
+ break;
+ }
+ logger.warn(`Unable to call ${url}. code: ${code}, error: ${error.error}.`)
+ return error;
+}
+
+export default async function synologyProxyHandler(req, res) {
+ const { group, service, endpoint } = req.query;
+
+ if (!group || !service) {
+ return res.status(400).json({ error: "Invalid proxy service type" });
+ }
+
+ const serviceWidget = await getServiceWidget(group, service);
+ const widget = widgets?.[serviceWidget.type];
+ const mapping = widget?.mappings?.[endpoint];
+ if (!widget.api || !mapping) {
+ return res.status(403).json({ error: "Service does not support API calls" });
+ }
+
+ const [cgiPath, maxVersion] = await getApiInfo(serviceWidget, mapping.apiName, service);
+ if (!cgiPath || !maxVersion) {
+ return res.status(400).json({ error: `Unrecognized API name: ${mapping.apiName}`})
+ }
+
+ const url = formatApiCall(widget.api, {
+ apiName: mapping.apiName,
+ apiMethod: mapping.apiMethod,
+ cgiPath,
+ maxVersion,
+ ...serviceWidget
+ });
+ let [status, contentType, data] = await httpProxy(url);
+ if (status !== 200) {
+ logger.debug("Error %d calling url %s", status, url);
+ return res.status(status, data);
+ }
+
+ let json = asJson(data);
+ if (json?.success !== true) {
+ logger.debug(`Attempting login to ${serviceWidget.type}`);
+ [status, contentType, data] = await handleUnsuccessfulResponse(serviceWidget, url, service);
+ json = asJson(data);
+ }
+
+ if (json.success !== true) {
+ data = toError(url, json);
+ status = 500;
+ }
+ if (contentType) res.setHeader("Content-Type", contentType);
+ return res.status(status).send(data);
+}
diff --git a/src/widgets/components.js b/src/widgets/components.js
index 4948d002..f7258a52 100644
--- a/src/widgets/components.js
+++ b/src/widgets/components.js
@@ -9,6 +9,7 @@ const components = {
cloudflared: dynamic(() => import("./cloudflared/component")),
coinmarketcap: dynamic(() => import("./coinmarketcap/component")),
deluge: dynamic(() => import("./deluge/component")),
+ diskstation: dynamic(() => import("./diskstation/component")),
downloadstation: dynamic(() => import("./downloadstation/component")),
docker: dynamic(() => import("./docker/component")),
kubernetes: dynamic(() => import("./kubernetes/component")),
diff --git a/src/widgets/diskstation/component.jsx b/src/widgets/diskstation/component.jsx
new file mode 100644
index 00000000..3195a62d
--- /dev/null
+++ b/src/widgets/diskstation/component.jsx
@@ -0,0 +1,55 @@
+import { useTranslation } from "next-i18next";
+
+import Container from "components/services/widget/container";
+import Block from "components/services/widget/block";
+import useWidgetAPI from "utils/proxy/use-widget-api";
+
+export default function Component({ service }) {
+ const { t } = useTranslation();
+ const { widget } = service;
+ const { data: infoData, error: infoError } = useWidgetAPI(widget, "system_info");
+ const { data: storageData, error: storageError } = useWidgetAPI(widget, "system_storage");
+ const { data: utilizationData, error: utilizationError } = useWidgetAPI(widget, "utilization");
+
+ if (storageError || infoError || utilizationError) {
+ return ;
+ }
+
+ if (!storageData || !infoData || !utilizationData) {
+ return (
+
+
+
+
+
+
+ );
+ }
+
+ // uptime info
+ // eslint-disable-next-line no-unused-vars
+ const [hour, minutes, seconds] = infoData.data.up_time.split(":");
+ const days = Math.floor(hour / 24);
+ const uptime = `${ t("common.number", { value: days }) } ${ t("diskstation.days") }`;
+
+ // storage info
+ // TODO: figure out how to display info for more than one volume
+ const volume = storageData.data.vol_info?.[0];
+ const usedBytes = parseFloat(volume?.used_size);
+ const totalBytes = parseFloat(volume?.total_size);
+ const freeBytes = totalBytes - usedBytes;
+
+ // utilization info
+ const { cpu, memory } = utilizationData.data;
+ const cpuLoad = parseFloat(cpu.user_load) + parseFloat(cpu.system_load);
+ const memoryUsage = 100 - ((100 * (parseFloat(memory.avail_real) + parseFloat(memory.cached))) / parseFloat(memory.total_real));
+
+ return (
+
+
+
+
+
+
+ );
+}
diff --git a/src/widgets/diskstation/widget.js b/src/widgets/diskstation/widget.js
new file mode 100644
index 00000000..6cb8971e
--- /dev/null
+++ b/src/widgets/diskstation/widget.js
@@ -0,0 +1,27 @@
+import synologyProxyHandler from '../../utils/proxy/handlers/synology'
+
+const widget = {
+ // cgiPath and maxVersion are discovered at runtime, don't supply
+ api: "{url}/webapi/{cgiPath}?api={apiName}&version={maxVersion}&method={apiMethod}",
+ proxyHandler: synologyProxyHandler,
+
+ mappings: {
+ "system_storage": {
+ apiName: "SYNO.Core.System",
+ apiMethod: "info&type=\"storage\"",
+ endpoint: "system_storage"
+ },
+ "system_info": {
+ apiName: "SYNO.Core.System",
+ apiMethod: "info",
+ endpoint: "system_info"
+ },
+ "utilization": {
+ apiName: "SYNO.Core.System.Utilization",
+ apiMethod: "get",
+ endpoint: "utilization"
+ }
+ },
+};
+
+export default widget;
diff --git a/src/widgets/downloadstation/proxy.js b/src/widgets/downloadstation/proxy.js
deleted file mode 100644
index 73a6a259..00000000
--- a/src/widgets/downloadstation/proxy.js
+++ /dev/null
@@ -1,88 +0,0 @@
-import { formatApiCall } from "utils/proxy/api-helpers";
-import { httpProxy } from "utils/proxy/http";
-import createLogger from "utils/logger";
-import widgets from "widgets/widgets";
-import getServiceWidget from "utils/config/service-helpers";
-
-const logger = createLogger("downloadstationProxyHandler");
-
-async function login(loginUrl) {
- const [status, contentType, data] = await httpProxy(loginUrl);
- if (status !== 200) {
- return [status, contentType, data];
- }
-
- const json = JSON.parse(data.toString());
- if (json?.success !== true) {
- // from https://global.download.synology.com/download/Document/Software/DeveloperGuide/Package/DownloadStation/All/enu/Synology_Download_Station_Web_API.pdf
- /*
- Code Description
- 400 No such account or incorrect password
- 401 Account disabled
- 402 Permission denied
- 403 2-step verification code required
- 404 Failed to authenticate 2-step verification code
- */
- let message = "Authentication failed.";
- if (json?.error?.code >= 403) message += " 2FA enabled.";
- logger.warn("Unable to login. Code: %d", json?.error?.code);
- return [401, "application/json", JSON.stringify({ code: json?.error?.code, message })];
- }
-
- return [status, contentType, data];
-}
-
-export default async function downloadstationProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
-
- if (!group || !service) {
- return res.status(400).json({ error: "Invalid proxy service type" });
- }
-
- const widget = await getServiceWidget(group, service);
- const api = widgets?.[widget.type]?.api;
- if (!api) {
- return res.status(403).json({ error: "Service does not support API calls" });
- }
-
- const url = formatApiCall(api, { endpoint, ...widget });
- let [status, contentType, data] = await httpProxy(url);
- if (status !== 200) {
- logger.debug("Error %d calling endpoint %s", status, url);
- return res.status(status, data);
- }
-
- const json = JSON.parse(data.toString());
- if (json?.success !== true) {
- logger.debug("Attempting login to DownloadStation");
-
- const apiInfoUrl = formatApiCall("{url}/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query", widget);
- let path = "entry.cgi";
- let maxVersion = 7;
- [status, contentType, data] = await httpProxy(apiInfoUrl);
- if (status === 200) {
- try {
- const apiAuthInfo = JSON.parse(data.toString()).data['SYNO.API.Auth'];
- if (apiAuthInfo) {
- path = apiAuthInfo.path;
- maxVersion = apiAuthInfo.maxVersion;
- logger.debug(`Deteceted Downloadstation auth API path: ${path} and maxVersion: ${maxVersion}`);
- }
- } catch {
- logger.debug(`Error ${status} obtaining DownloadStation API info`);
- }
- }
-
- const authApi = `{url}/webapi/${path}?api=SYNO.API.Auth&version=${maxVersion}&method=login&account={username}&passwd={password}&session=DownloadStation&format=cookie`
- const loginUrl = formatApiCall(authApi, widget);
- [status, contentType, data] = await login(loginUrl);
- if (status !== 200) {
- return res.status(status).end(data)
- }
-
- [status, contentType, data] = await httpProxy(url);
- }
-
- if (contentType) res.setHeader("Content-Type", contentType);
- return res.status(status).send(data);
-}
diff --git a/src/widgets/downloadstation/widget.js b/src/widgets/downloadstation/widget.js
index 38245adf..02895723 100644
--- a/src/widgets/downloadstation/widget.js
+++ b/src/widgets/downloadstation/widget.js
@@ -1,12 +1,15 @@
-import downloadstationProxyHandler from "./proxy";
+import synologyProxyHandler from '../../utils/proxy/handlers/synology'
const widget = {
- api: "{url}/webapi/DownloadStation/task.cgi?api=SYNO.DownloadStation.Task&version=1&method={endpoint}",
- proxyHandler: downloadstationProxyHandler,
+ // cgiPath and maxVersion are discovered at runtime, don't supply
+ api: "{url}/webapi/{cgiPath}?api={apiName}&version={maxVersion}&method={apiMethod}",
+ proxyHandler: synologyProxyHandler,
mappings: {
"list": {
- endpoint: "list&additional=transfer",
+ apiName: "SYNO.DownloadStation.Task",
+ apiMethod: "list&additional=transfer",
+ endpoint: "list"
},
},
};
diff --git a/src/widgets/proxmox/component.jsx b/src/widgets/proxmox/component.jsx
index 00f20e58..34fa7ff9 100644
--- a/src/widgets/proxmox/component.jsx
+++ b/src/widgets/proxmox/component.jsx
@@ -24,8 +24,8 @@ export default function Component({ service }) {
-
-
+
+
);
}
@@ -46,8 +46,8 @@ export default function Component({ service }) {
-
-
+
+
);
}
diff --git a/src/widgets/widgets.js b/src/widgets/widgets.js
index 2e244331..feae40cd 100644
--- a/src/widgets/widgets.js
+++ b/src/widgets/widgets.js
@@ -6,6 +6,7 @@ import changedetectionio from "./changedetectionio/widget";
import cloudflared from "./cloudflared/widget";
import coinmarketcap from "./coinmarketcap/widget";
import deluge from "./deluge/widget";
+import diskstation from "./diskstation/widget";
import downloadstation from "./downloadstation/widget";
import emby from "./emby/widget";
import flood from "./flood/widget";
@@ -71,7 +72,7 @@ const widgets = {
cloudflared,
coinmarketcap,
deluge,
- diskstation: downloadstation,
+ diskstation,
downloadstation,
emby,
flood,