From 99b50b4faf491e72154bc57821bef164287732e8 Mon Sep 17 00:00:00 2001
From: robo <30987265+Robonau@users.noreply.github.com>
Date: Tue, 12 Nov 2024 01:52:51 +0000
Subject: [PATCH] Feature: suwayomi Service Widget (#4273)
Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
---
docs/widgets/services/suwayomi.md | 20 ++++
public/locales/en/common.json | 10 ++
src/widgets/components.js | 1 +
src/widgets/suwayomi/component.jsx | 40 +++++++
src/widgets/suwayomi/proxy.js | 175 +++++++++++++++++++++++++++++
src/widgets/suwayomi/widget.js | 8 ++
src/widgets/widgets.js | 2 +
7 files changed, 256 insertions(+)
create mode 100644 docs/widgets/services/suwayomi.md
create mode 100644 src/widgets/suwayomi/component.jsx
create mode 100644 src/widgets/suwayomi/proxy.js
create mode 100644 src/widgets/suwayomi/widget.js
diff --git a/docs/widgets/services/suwayomi.md b/docs/widgets/services/suwayomi.md
new file mode 100644
index 00000000000..216725981b7
--- /dev/null
+++ b/docs/widgets/services/suwayomi.md
@@ -0,0 +1,20 @@
+---
+title: Suwayomi
+description: Suwayomi Widget Configuration
+---
+
+Learn more about [Suwayomi](https://github.com/Suwayomi/Suwayomi-Server).
+
+Allowed fields: ["download", "nondownload", "read", "unread", "downloadedread", "downloadedunread", "nondownloadedread", "nondownloadedunread"]
+
+The widget defaults to the first four above. If more than four fields are provided, only the first 4 are displayed.
+Category IDs can be obtained from the url when navigating to it, `?tab={categoryID}`.
+
+```yaml
+widget:
+ type: suwayomi
+ url: http://suwayomi.host.or.ip
+ username: username #optional
+ password: password #optional
+ category: 0 #optional, defaults to all categories
+```
diff --git a/public/locales/en/common.json b/public/locales/en/common.json
index bdde0a34b6b..81576984e7b 100644
--- a/public/locales/en/common.json
+++ b/public/locales/en/common.json
@@ -309,6 +309,16 @@
"stopped": "Stopped",
"total": "Total"
},
+ "suwayomi": {
+ "download": "Downloaded",
+ "nondownload": "Non-Downloaded",
+ "read": "Read",
+ "unread": "Unread",
+ "downloadedread": "Downloaded & Read",
+ "downloadedunread": "Downloaded & Unread",
+ "nondownloadedread": "Non-Downloaded & Read",
+ "nondownloadedunread": "Non-Downloaded & Unread"
+ },
"tailscale": {
"address": "Address",
"expires": "Expires",
diff --git a/src/widgets/components.js b/src/widgets/components.js
index 7e6b68e14b9..3cba84d2d21 100644
--- a/src/widgets/components.js
+++ b/src/widgets/components.js
@@ -114,6 +114,7 @@ const components = {
stocks: dynamic(() => import("./stocks/component")),
strelaysrv: dynamic(() => import("./strelaysrv/component")),
swagdashboard: dynamic(() => import("./swagdashboard/component")),
+ suwayomi: dynamic(() => import("./suwayomi/component")),
tailscale: dynamic(() => import("./tailscale/component")),
tandoor: dynamic(() => import("./tandoor/component")),
tautulli: dynamic(() => import("./tautulli/component")),
diff --git a/src/widgets/suwayomi/component.jsx b/src/widgets/suwayomi/component.jsx
new file mode 100644
index 00000000000..b7c34820f6b
--- /dev/null
+++ b/src/widgets/suwayomi/component.jsx
@@ -0,0 +1,40 @@
+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: suwayomiData, error: suwayomiError } = useWidgetAPI(widget);
+
+ if (suwayomiError) {
+ return ;
+ }
+
+ if (!suwayomiData) {
+ if (!widget.fields || widget.fields.length === 0) {
+ widget.fields = ["download", "nondownload", "read", "unread"];
+ } else if (widget.fields.length > 4) {
+ widget.fields = widget.fields.slice(0, 4);
+ }
+ return (
+
+ {widget.fields.map((field) => (
+
+ ))}
+
+ );
+ }
+
+ return (
+
+ {suwayomiData.map((data) => (
+
+ ))}
+
+ );
+}
diff --git a/src/widgets/suwayomi/proxy.js b/src/widgets/suwayomi/proxy.js
new file mode 100644
index 00000000000..d4d7167520b
--- /dev/null
+++ b/src/widgets/suwayomi/proxy.js
@@ -0,0 +1,175 @@
+import { httpProxy } from "utils/proxy/http";
+import { formatApiCall } from "utils/proxy/api-helpers";
+import getServiceWidget from "utils/config/service-helpers";
+import createLogger from "utils/logger";
+import widgets from "widgets/widgets";
+
+const proxyName = "suwayomiProxyHandler";
+const logger = createLogger(proxyName);
+
+const countsToExtract = {
+ download: {
+ condition: (c) => c.isDownloaded,
+ gqlCondition: "isDownloaded: true",
+ },
+ nondownload: {
+ condition: (c) => !c.isDownloaded,
+ gqlCondition: "isDownloaded: false",
+ },
+ read: {
+ condition: (c) => c.isRead,
+ gqlCondition: "isRead: true",
+ },
+ unread: {
+ condition: (c) => !c.isRead,
+ gqlCondition: "isRead: false",
+ },
+ downloadedread: {
+ condition: (c) => c.isDownloaded && c.isRead,
+ gqlCondition: "isDownloaded: true, isRead: true",
+ },
+ downloadedunread: {
+ condition: (c) => c.isDownloaded && !c.isRead,
+ gqlCondition: "isDownloaded: true, isRead: false",
+ },
+ nondownloadedread: {
+ condition: (c) => !c.isDownloaded && c.isRead,
+ gqlCondition: "isDownloaded: false, isRead: true",
+ },
+ nondownloadedunread: {
+ condition: (c) => !c.isDownloaded && !c.isRead,
+ gqlCondition: "isDownloaded: false, isRead: false",
+ },
+};
+
+function makeBody(fields, category = "all") {
+ if (Number.isNaN(Number(category))) {
+ let query = "";
+ fields.forEach((field) => {
+ query += `
+ ${field}: chapters(
+ condition: {${countsToExtract[field].gqlCondition}}
+ filter: {inLibrary: {equalTo: true}}
+ ) {
+ totalCount
+ }`;
+ });
+ return JSON.stringify({
+ operationName: "Counts",
+ query: `
+ query Counts {
+ ${query}
+ }`,
+ });
+ }
+
+ return JSON.stringify({
+ operationName: "category",
+ query: `
+ query category($id: Int!) {
+ category(id: $id) {
+ # name
+ mangas {
+ nodes {
+ chapters {
+ nodes {
+ isRead
+ isDownloaded
+ }
+ }
+ }
+ }
+ }
+ }`,
+ variables: {
+ id: Number(category),
+ },
+ });
+}
+
+function extractCounts(responseJSON, fields) {
+ if (!("category" in responseJSON.data)) {
+ return fields.map((field) => ({
+ count: responseJSON.data[field].totalCount,
+ label: `suwayomi.${field}`,
+ }));
+ }
+ const tmp = responseJSON.data.category.mangas.nodes.reduce(
+ (accumulator, manga) => {
+ manga.chapters.nodes.forEach((chapter) => {
+ fields.forEach((field, i) => {
+ if (countsToExtract[field].condition(chapter)) {
+ accumulator[i] += 1;
+ }
+ });
+ });
+ return accumulator;
+ },
+ [0, 0, 0, 0],
+ );
+ return fields.map((field, i) => ({
+ count: tmp[i],
+ label: `suwayomi.${field}`,
+ }));
+}
+
+export default async function suwayomiProxyHandler(req, res) {
+ const { group, service, endpoint } = req.query;
+
+ if (!group || !service) {
+ logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
+ return res.status(400).json({ error: "Invalid proxy service type" });
+ }
+
+ const widget = await getServiceWidget(group, service);
+
+ if (!widget) {
+ logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
+ return res.status(400).json({ error: "Invalid proxy service type" });
+ }
+
+ if (!widget.fields || widget.fields.length === 0) {
+ widget.fields = ["download", "nondownload", "read", "unread"];
+ } else if (widget.fields.length > 4) {
+ widget.fields = widget.fields.slice(0, 4);
+ }
+
+ const url = new URL(formatApiCall(widgets[widget.type].api, { endpoint, ...widget }));
+
+ const body = makeBody(widget.fields, widget.category);
+
+ const headers = {
+ "Content-Type": "application/json",
+ };
+
+ if (widget.username && widget.password) {
+ headers.Authorization = `Basic ${Buffer.from(`${widget.username}:${widget.password}`).toString("base64")}`;
+ }
+
+ const [status, contentType, data] = await httpProxy(url, {
+ method: "POST",
+ body,
+ headers,
+ });
+
+ if (status === 401) {
+ logger.error("Invalid or missing username or password for service '%s' in group '%s'", service, group);
+ return res.status(status).send({ error: { message: "401: unauthorized, username or password is incorrect." } });
+ }
+
+ if (status !== 200) {
+ logger.error(
+ "Error getting data from Suwayomi for service '%s' in group '%s': %d. Data: %s",
+ service,
+ group,
+ status,
+ data,
+ );
+ return res.status(status).send({ error: { message: "Error getting data. body: %s, data: %s", body, data } });
+ }
+
+ const returnData = extractCounts(JSON.parse(data), widget.fields);
+
+ if (contentType) res.setHeader("Content-Type", contentType);
+ return res.status(status).send(returnData);
+}
diff --git a/src/widgets/suwayomi/widget.js b/src/widgets/suwayomi/widget.js
new file mode 100644
index 00000000000..e2ed509c614
--- /dev/null
+++ b/src/widgets/suwayomi/widget.js
@@ -0,0 +1,8 @@
+import suwayomiProxyHandler from "./proxy";
+
+const widget = {
+ api: "{url}/api/graphql",
+ proxyHandler: suwayomiProxyHandler,
+};
+
+export default widget;
diff --git a/src/widgets/widgets.js b/src/widgets/widgets.js
index 4d76fa0707f..7911037895e 100644
--- a/src/widgets/widgets.js
+++ b/src/widgets/widgets.js
@@ -105,6 +105,7 @@ import stash from "./stash/widget";
import stocks from "./stocks/widget";
import strelaysrv from "./strelaysrv/widget";
import swagdashboard from "./swagdashboard/widget";
+import suwayomi from "./suwayomi/widget";
import tailscale from "./tailscale/widget";
import tandoor from "./tandoor/widget";
import tautulli from "./tautulli/widget";
@@ -238,6 +239,7 @@ const widgets = {
stocks,
strelaysrv,
swagdashboard,
+ suwayomi,
tailscale,
tandoor,
tautulli,