Add FreshRSS widget (#1377)

* feat: add FreshRSS widget

* refactor: revert credentialed.js

* refactor: custom proxy handler for FreshRSS

* refactor: cache the token as long as possible

During installation, the salt is generated and remains constant unless
the user re-installs the FreshRSS instance.

public/locales/en/common.json

@@ -98,6 +98,10 @@
         "leech": "Leech",
         "seed": "Seed"
     },
+    "freshrss": {
+        "subscriptions": "Subscriptions",
+        "unread": "Unread"
+    },
     "changedetectionio": {
         "totalObserved": "Total Observed",
         "diffsDetected": "Diffs Detected"

src/widgets/components.js

@@ -17,6 +17,7 @@ const components = {
   emby: dynamic(() => import("./emby/component")),
   fileflows: dynamic(() => import("./fileflows/component")),
   flood: dynamic(() => import("./flood/component")),
+  freshrss: dynamic(() => import("./freshrss/component")),
   ghostfolio: dynamic(() => import("./ghostfolio/component")),
   gluetun: dynamic(() => import("./gluetun/component")),
   gotify: dynamic(() => import("./gotify/component")),

src/widgets/freshrss/component.jsx

@@ -0,0 +1,33 @@
+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: freshrssData, error: freshrssError } = useWidgetAPI(widget, "info");
+
+  if (freshrssError) {
+    return <Container error={freshrssError} />;
+  }
+
+  if (!freshrssData) {
+    return (
+      <Container service={service}>
+        <Block label="freshrss.unread" />
+        <Block label="freshrss.subscriptions" />
+      </Container>
+    );
+  }
+
+  return (
+    <Container service={service}>
+      <Block label="freshrss.unread" value={t("common.number", { value: freshrssData.unread })} />
+      <Block label="freshrss.subscriptions" value={t("common.number", { value: freshrssData.subscriptions })} />
+    </Container>
+  );
+}

src/widgets/freshrss/proxy.js

@@ -0,0 +1,97 @@
+import cache from "memory-cache";
+
+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 = "freshrssProxyHandler";
+const sessionTokenCacheKey = `${proxyName}__sessionToken`;
+const logger = createLogger(proxyName);
+
+async function login(widget, service) {
+  const endpoint = "accounts/ClientLogin";
+  const api = widgets?.[widget.type]?.api
+  const loginUrl = new URL(formatApiCall(api, { endpoint, ...widget }));
+  const headers = { "Content-Type": "application/x-www-form-urlencoded" };
+
+  const [, , data,] = await httpProxy(loginUrl, {
+    method: "POST",
+    body: new URLSearchParams({
+      Email: widget.username,
+      Passwd: widget.password
+    }).toString(),
+    headers,
+  });
+
+  try {
+    const [, token] = data.toString().split("\n").find(line => line.startsWith("Auth=")).split("=")
+    cache.put(`${sessionTokenCacheKey}.${service}`, token);
+    return { token };
+  } catch (e) {
+    logger.error("Unable to login to FreshRSS API: %s", e);
+  }
+
+  return { token: false };
+}
+
+async function apiCall(widget, endpoint, service) {
+  const key = `${sessionTokenCacheKey}.${service}`;
+  const headers = {
+    "Authorization": `GoogleLogin auth=${cache.get(key)}`,
+  }
+  const url = new URL(formatApiCall(widgets[widget.type].api, { endpoint, ...widget }));
+  const method = "GET";
+
+  let [status, contentType, data, responseHeaders] = await httpProxy(url, {
+    method,
+    headers,
+  });
+
+  if (status === 401) {
+    logger.debug("FreshRSS API rejected the request, attempting to obtain new session token");
+    const { token } = await login(widget, service);
+    headers.Authorization = `GoogleLogin auth=${token}`;
+
+    // retry the request, now with the new session token
+    [status, contentType, data, responseHeaders] = await httpProxy(url, {
+      method,
+      headers,
+    });
+  }
+
+  if (status !== 200) {
+    logger.error("Error getting data from FreshRSS: %s status %d. Data: %s", url, status, data);
+    return { status, contentType, data: null, responseHeaders };
+  }
+
+  return { status, contentType, data: JSON.parse(data.toString()), responseHeaders };
+}
+
+export default async function freshrssProxyHandler(req, res) {
+  const { group, service } = 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 (!cache.get(`${sessionTokenCacheKey}.${service}`)) {
+    await login(widget, service);
+  }
+
+  const { data: subscriptionData } = await apiCall(widget, "reader/api/0/subscription/list", service);
+  const { data: unreadCountData } = await apiCall(widget, "reader/api/0/unread-count", service);
+
+  return res.status(200).send({
+    subscriptions: subscriptionData?.subscriptions.length,
+    unread: unreadCountData?.max
+  });
+}

src/widgets/freshrss/widget.js

@@ -0,0 +1,13 @@
+import freshrssProxyHandler from "./proxy";
+
+const widget = {
+  api: "{url}/api/greader.php/{endpoint}?output=json",
+  proxyHandler: freshrssProxyHandler,
+  mappings: {
+    info: {
+      endpoint: "/"
+    }
+  }
+};
+
+export default widget;

src/widgets/widgets.js

@@ -12,6 +12,7 @@ import downloadstation from "./downloadstation/widget";
 import emby from "./emby/widget";
 import fileflows from "./fileflows/widget";
 import flood from "./flood/widget";
+import freshrss from "./freshrss/widget";
 import ghostfolio from "./ghostfolio/widget"
 import gluetun from "./gluetun/widget";
 import gotify from "./gotify/widget";
@@ -90,6 +91,7 @@ const widgets = {
   emby,
   fileflows,
   flood,
+  freshrss,
   ghostfolio,
   gluetun,
   gotify,