rsshub 1.0.0-master.ffaca71 → 1.0.0-master.ffd5f26

package/README.md

@@ -3,15 +3,15 @@
 </p>
 <h1 align="center">RSSHub</h1>
 
-> 🍰 Everything is RSSible
+> 🧡 Everything is RSSible
 
-[![telegram](https://img.shields.io/badge/chat-telegram-brightgreen.svg?logo=telegram&style=flat-square)](https://t.me/rsshub)
-[![npm publish](https://img.shields.io/github/actions/workflow/status/DIYgod/RSSHub/npm-publish.yml?branch=master&label=npm%20publish&logo=npm&style=flat-square)](https://www.npmjs.com/package/rsshub)
-[![docker publish](https://img.shields.io/github/actions/workflow/status/DIYgod/RSSHub/docker-release.yml?branch=master&label=docker%20publish&logo=docker&style=flat-square)](https://hub.docker.com/r/diygod/rsshub)
+[![](https://img.shields.io/badge/dynamic/json?url=https://rsshub-analytics.diygod.workers.dev/&query=requests&color=F38020&label=requests&logo=cloudflare&style=flat-square&suffix=/month)](https://rsshub.app)
+[![docker publish](https://img.shields.io/docker/pulls/diygod/rsshub?label=docker%20pulls&logo=docker&style=flat-square)](https://hub.docker.com/r/diygod/rsshub)
+[![npm publish](https://img.shields.io/npm/dt/rsshub?label=npm%20downloads&logo=npm&style=flat-square)](https://www.npmjs.com/package/rsshub)
 [![test](https://img.shields.io/github/actions/workflow/status/DIYgod/RSSHub/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/DIYgod/RSSHub/actions/workflows/test.yml?query=event%3Apush+branch%3Amaster)
 [![Test coverage](https://img.shields.io/codecov/c/github/DIYgod/RSSHub.svg?style=flat-square&logo=codecov)](https://app.codecov.io/gh/DIYgod/RSSHub/branch/master)
-[![CodeFactor](https://www.codefactor.io/repository/github/diygod/rsshub/badge)](https://www.codefactor.io/repository/github/diygod/rsshub)
-[![DeepScan grade](https://deepscan.io/api/teams/6244/projects/8135/branches/92448/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=6244&pid=8135&bid=92448)
+
+[![Telegram group](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.swo.moe%2Fstats%2Ftelegram%2Frsshub&query=count&color=2CA5E0&label=Telegram%20Group&logo=telegram&cacheSeconds=3600&style=flat-square)](https://t.me/rsshub) [![Telegram channel](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.swo.moe%2Fstats%2Ftelegram%2FawesomeRSSHub&query=count&color=2CA5E0&label=Telegram%20Channel&logo=telegram&cacheSeconds=3600&style=flat-square)](https://t.me/awesomeRSSHub) [![Twitter](https://img.shields.io/badge/any_text-Follow-blue?color=2CA5E0&label=Twitter&logo=twitter&cacheSeconds=3600&style=flat-square)](https://twitter.com/intent/follow?screen_name=_RSSHub)
 
 ## Introduction
 
@@ -21,19 +21,17 @@ RSSHub delivers millions of contents aggregated from all kinds of sources, our v
 
 RSSHub can be used with browser extension [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) and mobile auxiliary app [RSSBud](https://github.com/Cay-Zhang/RSSBud) (iOS) and [RSSAid](https://github.com/LeetaoGoooo/RSSAid) (Android)
 
-[English docs](https://docs.rsshub.app) | [Telegram Group](https://t.me/rsshub) | [Telegram Channel](https://t.me/awesomeRSSHub)
-
-[中文文档](https://docs.rsshub.app/zh/) | [Telegram 群](https://t.me/rsshub) | [Telegram 频道](https://t.me/awesomeRSSHub)
+[English docs](https://docs.rsshub.app) | [Telegram Group](https://t.me/rsshub) | [Telegram Channel](https://t.me/awesomeRSSHub) | [Twitter](https://twitter.com/intent/follow?screen_name=_RSSHub) | [中文文档](https://docs.rsshub.app/zh/)
 
 ## Special Thanks
 
 ### Special Sponsors
 
 <p>
-<a href="https://xlog.app/" target="_blank"><img height="100px" src="https://i.imgur.com/JuhHTKD.png"></a>
+<a href="https://rss3.io" target="_blank"><img height="50px" src="https://i.imgur.com/lb1dDGK.png"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://xlog.app/" target="_blank"><img height="50px" src="https://i.imgur.com/JuhHTKD.png"></a>
 </p>
 
-[![](https://opencollective.com/static/images/become_sponsor.svg)](https://docs.rsshub.app/support/)
+[![](https://opencollective.com/static/images/become_sponsor.svg)](https://docs.rsshub.app/sponsor/)
 
 ### Contributors
 
@@ -43,12 +41,12 @@ Logo designer [sheldonrrr](https://dribbble.com/sheldonrrr)
 
 ### Backers
 
-<a href="https://www.cloudflare.com" target="_blank"><img height="50px" src="https://i.imgur.com/7Ph27Fq.png"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://www.netlify.com" target="_blank"><img height="40px" src="https://i.imgur.com/cU01915.png"></a>
+<a href="https://www.cloudflare.com" target="_blank"><img height="50px" src="https://i.imgur.com/7Ph27Fq.png"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://www.netlify.com" target="_blank"><img height="40px" src="https://i.imgur.com/cU01915.png"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://1password.com" target="_blank"><img height="40px" src="https://i.imgur.com/a2XjflO.png"></a>
 
 ## Related Projects
 
 -   [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) | A browser extension that can help you quickly discover and subscribe to the RSS and RSSHub of current websites.
--   [RSSBud](https://github.com/Cay-Zhang/RSSBud) ([TestFlight](https://testflight.apple.com/join/rjCVzzHP)) | RSSHub Radar for iOS platform, designed specifically for mobile ecosystem optimization.
+-   [RSSBud](https://github.com/Cay-Zhang/RSSBud) | RSSHub Radar for iOS platform, designed specifically for mobile ecosystem optimization.
 -   [RSSAid](https://github.com/LeetaoGoooo/RSSAid) | RSSHub Radar for Android platform built with Flutter.
 -   [DocSearch](https://github.com/Fatpandac/DocSearch) | Link RSSHub DocSearch into Raycast
 
@@ -56,15 +54,15 @@ Logo designer [sheldonrrr](https://dribbble.com/sheldonrrr)
 
 We welcome all pull requests. Suggestions and feedback are also welcomed [here](https://github.com/DIYgod/RSSHub/issues).
 
-Refer to [Join Us](https://docs.rsshub.app/joinus/quick-start)
+Refer to [Join Us](https://docs.rsshub.app/joinus/)
 
 ## Deployment
 
-Refer to [Deployment](https://docs.rsshub.app/install/)
+Refer to [Deployment](https://docs.rsshub.app/deploy/)
 
 ## Support RSSHub
 
-Refer to [Support RSSHub](https://docs.rsshub.app/support/)
+Refer to [Support RSSHub](https://docs.rsshub.app/sponsor/)
 
 RSSHub is open source and completely free under the MIT license. However, just like any other open source project, as the project grows, the hosting, development and maintenance requires funding support.
 
@@ -78,7 +76,7 @@ Recurring donors will be rewarded via express issue response, or even have your
 -   Become a Sponser on [Patreon](https://www.patreon.com/DIYgod)
 -   Become a Sponser on [Open Collective](https://opencollective.com/RSSHub)
 -   Become a Sponser on [爱发电](https://afdian.net/@diygod)
--   Contact us directly: i@diygod.me
+-   Contact us directly: <i@diygod.me>
 
 ### One-time Donation
 
@@ -88,6 +86,14 @@ We accept donations via the following ways:
 -   [Alipay](https://archive.diygod.me/images/zfb.jpg)
 -   [Paypal](https://www.paypal.me/DIYgod)
 
+Open source is a very expensive thing. RSSHub would not be possible without the help of these individuals and organizations.
+
+<p align="center">
+  <a href="https://github.com/DIYgod/sponsors">
+    <img src="https://raw.githubusercontent.com/DIYgod/sponsors/main/sponsors.wide.svg" />
+  </a>
+</p>
+
 ## Author
 
 **RSSHub** © [DIYgod](https://github.com/DIYgod), Released under the [MIT](./LICENSE) License.<br>

package/lib/api/index.ts

@@ -0,0 +1,31 @@
+// import { route as rulesRoute, handler as rulesHandler } from '@/api/radar/rules';
+import { route as namespaceAllRoute, handler as namespaceAllHandler } from '@/api/namespace/all';
+import { route as namespaceOneRoute, handler as namespaceOneHandler } from '@/api/namespace/one';
+import { route as radarRulesAllRoute, handler as radarRulesAllHandler } from '@/api/radar/rules/all';
+import { route as radarRulesOneRoute, handler as radarRulesOneHandler } from '@/api/radar/rules/one';
+import { OpenAPIHono } from '@hono/zod-openapi';
+import { swaggerUI } from '@hono/swagger-ui';
+
+const app = new OpenAPIHono();
+
+app.openapi(namespaceAllRoute, namespaceAllHandler);
+app.openapi(namespaceOneRoute, namespaceOneHandler);
+app.openapi(radarRulesAllRoute, radarRulesAllHandler);
+app.openapi(radarRulesOneRoute, radarRulesOneHandler);
+
+const docs = app.getOpenAPI31Document({
+    openapi: '3.1.0',
+    info: {
+        version: '0.0.1',
+        title: 'RSSHub API',
+    },
+});
+for (const path in docs.paths) {
+    docs.paths[`/api${path}`] = docs.paths[path];
+    delete docs.paths[path];
+}
+app.get('/docs', (ctx) => ctx.json(docs));
+
+app.get('/ui', swaggerUI({ url: '/api/docs' }));
+
+export default app;

package/lib/api/namespace/all.ts

@@ -0,0 +1,17 @@
+import { namespaces } from '@/registry';
+import { createRoute, RouteHandler } from '@hono/zod-openapi';
+
+const route = createRoute({
+    method: 'get',
+    path: '/namespace',
+    tags: ['Namespace'],
+    responses: {
+        200: {
+            description: 'Information about all namespaces',
+        },
+    },
+});
+
+const handler: RouteHandler<typeof route> = (ctx) => ctx.json(namespaces);
+
+export { route, handler };

package/lib/api/namespace/one.ts

@@ -0,0 +1,33 @@
+import { namespaces } from '@/registry';
+import { z, createRoute, RouteHandler } from '@hono/zod-openapi';
+
+const ParamsSchema = z.object({
+    namespace: z.string().openapi({
+        param: {
+            name: 'namespace',
+            in: 'path',
+        },
+        example: 'github',
+    }),
+});
+
+const route = createRoute({
+    method: 'get',
+    path: '/namespace/{namespace}',
+    tags: ['Namespace'],
+    request: {
+        params: ParamsSchema,
+    },
+    responses: {
+        200: {
+            description: 'Information about a namespace',
+        },
+    },
+});
+
+const handler: RouteHandler<typeof route> = (ctx) => {
+    const { namespace } = ctx.req.valid('param');
+    return ctx.json(namespaces[namespace]);
+};
+
+export { route, handler };

package/lib/api/radar/rules/all.ts

@@ -0,0 +1,59 @@
+import { namespaces } from '@/registry';
+import { parse } from 'tldts';
+import { RadarItem } from '@/types';
+import { createRoute, RouteHandler } from '@hono/zod-openapi';
+
+const radar: {
+    [domain: string]: {
+        _name: string;
+        [subdomain: string]: RadarItem[] | string;
+    };
+} = {};
+
+for (const namespace in namespaces) {
+    for (const path in namespaces[namespace].routes) {
+        const realPath = `/${namespace}${path}`;
+        const data = namespaces[namespace].routes[path];
+        if (data.radar?.length) {
+            for (const radarItem of data.radar) {
+                const parsedDomain = parse(new URL('https://' + radarItem.source[0]).hostname);
+                const subdomain = parsedDomain.subdomain || '.';
+                const domain = parsedDomain.domain;
+                if (domain) {
+                    if (!radar[domain]) {
+                        radar[domain] = {
+                            _name: namespaces[namespace].name,
+                        };
+                    }
+                    if (!radar[domain][subdomain]) {
+                        radar[domain][subdomain] = [];
+                    }
+                    radar[domain][subdomain].push({
+                        title: radarItem.title || data.name,
+                        docs: `https://docs.rsshub.app/routes/${data.categories?.[0] || 'other'}`,
+                        source: radarItem.source.map((source) => {
+                            const sourceURL = new URL('https://' + source);
+                            return sourceURL.pathname + sourceURL.search + sourceURL.hash;
+                        }),
+                        target: radarItem.target ? `/${namespace}${radarItem.target}` : realPath,
+                    });
+                }
+            }
+        }
+    }
+}
+
+const route = createRoute({
+    method: 'get',
+    path: '/radar/rules',
+    tags: ['Radar'],
+    responses: {
+        200: {
+            description: 'All Radar rules',
+        },
+    },
+});
+
+const handler: RouteHandler<typeof route> = (ctx) => ctx.json(radar);
+
+export { route, handler };

package/lib/api/radar/rules/one.ts

@@ -0,0 +1,75 @@
+import { namespaces } from '@/registry';
+import { parse } from 'tldts';
+import { RadarItem } from '@/types';
+import { z, createRoute, RouteHandler } from '@hono/zod-openapi';
+
+const radar: {
+    [domain: string]: {
+        _name: string;
+        [subdomain: string]: RadarItem[] | string;
+    };
+} = {};
+
+for (const namespace in namespaces) {
+    for (const path in namespaces[namespace].routes) {
+        const realPath = `/${namespace}${path}`;
+        const data = namespaces[namespace].routes[path];
+        if (data.radar?.length) {
+            for (const radarItem of data.radar) {
+                const parsedDomain = parse(new URL('https://' + radarItem.source[0]).hostname);
+                const subdomain = parsedDomain.subdomain || '.';
+                const domain = parsedDomain.domain;
+                if (domain) {
+                    if (!radar[domain]) {
+                        radar[domain] = {
+                            _name: namespaces[namespace].name,
+                        };
+                    }
+                    if (!radar[domain][subdomain]) {
+                        radar[domain][subdomain] = [];
+                    }
+                    radar[domain][subdomain].push({
+                        title: radarItem.title || data.name,
+                        docs: `https://docs.rsshub.app/routes/${data.categories?.[0] || 'other'}`,
+                        source: radarItem.source.map((source) => {
+                            const sourceURL = new URL('https://' + source);
+                            return sourceURL.pathname + sourceURL.search + sourceURL.hash;
+                        }),
+                        target: radarItem.target ? `/${namespace}${radarItem.target}` : realPath,
+                    });
+                }
+            }
+        }
+    }
+}
+
+const ParamsSchema = z.object({
+    domain: z.string().openapi({
+        param: {
+            name: 'domain',
+            in: 'path',
+        },
+        example: 'github.com',
+    }),
+});
+
+const route = createRoute({
+    method: 'get',
+    path: '/radar/rules/{domain}',
+    tags: ['Radar'],
+    request: {
+        params: ParamsSchema,
+    },
+    responses: {
+        200: {
+            description: 'Radar rules for a domain name (does not support subdomains)',
+        },
+    },
+});
+
+const handler: RouteHandler<typeof route> = (ctx) => {
+    const { domain } = ctx.req.valid('param');
+    return ctx.json(radar[domain]);
+};
+
+export { route, handler };

package/lib/app.test.ts

@@ -0,0 +1,11 @@
+import { describe, expect, it } from 'vitest';
+
+import app from '@/app';
+
+describe('index', () => {
+    it('serve index', async () => {
+        const res = await app.request('/');
+        expect(res.status).toBe(200);
+        expect(await res.text()).toContain('Welcome to RSSHub!');
+    });
+});

package/lib/app.tsx

@@ -0,0 +1,54 @@
+import '@/utils/request-rewriter';
+
+import { Hono } from 'hono';
+
+import { compress } from 'hono/compress';
+import mLogger from '@/middleware/logger';
+import cache from '@/middleware/cache';
+import template from '@/middleware/template';
+import sentry from '@/middleware/sentry';
+import accessControl from '@/middleware/access-control';
+import debug from '@/middleware/debug';
+import header from '@/middleware/header';
+import antiHotlink from '@/middleware/anti-hotlink';
+import parameter from '@/middleware/parameter';
+import { jsxRenderer } from 'hono/jsx-renderer';
+
+import logger from '@/utils/logger';
+
+import { notFoundHandler, errorHandler } from '@/errors';
+import registry from '@/registry';
+import api from '@/api';
+
+process.on('uncaughtException', (e) => {
+    logger.error('uncaughtException: ' + e);
+});
+
+const app = new Hono();
+
+app.use(compress());
+
+app.use(jsxRenderer(
+    ({ children }) => <>{children}</>,
+    {
+        docType: '<?xml version="1.0" encoding="UTF-8"?>',
+        stream: {}
+    }
+));
+app.use(mLogger);
+app.use(sentry);
+app.use(accessControl);
+app.use(debug);
+app.use(template);
+app.use(header);
+app.use(antiHotlink);
+app.use(parameter);
+app.use(cache);
+
+app.route('/', registry);
+app.route('/api', api);
+
+app.notFound(notFoundHandler);
+app.onError(errorHandler);
+
+export default app;

package/lib/config.test.ts

@@ -0,0 +1,99 @@
+import { describe, expect, it, afterEach, vi } from 'vitest';
+
+afterEach(() => {
+    vi.resetModules();
+});
+
+describe('config', () => {
+    it('bilibilib cookie', async () => {
+        process.env.BILIBILI_COOKIE_12 = 'cookie1';
+        process.env.BILIBILI_COOKIE_34 = 'cookie2';
+
+        const { config } = await import('./config');
+        expect(config.bilibili.cookies).toMatchObject({
+            12: 'cookie1',
+            34: 'cookie2',
+        });
+
+        delete process.env.BILIBILI_COOKIE_12;
+        delete process.env.BILIBILI_COOKIE_34;
+    });
+
+    it('email config', async () => {
+        process.env['EMAIL_CONFIG_xx.qq.com'] = 'token1';
+        process.env['EMAIL_CONFIG_oo.qq.com'] = 'token2';
+
+        const { config } = await import('./config');
+        expect(config.email.config).toMatchObject({
+            'xx.qq.com': 'token1',
+            'oo.qq.com': 'token2',
+        });
+
+        delete process.env['EMAIL_CONFIG_xx.qq.com'];
+        delete process.env['EMAIL_CONFIG_oo.qq.com'];
+    });
+
+    it('discuz cookie', async () => {
+        process.env.DISCUZ_COOKIE_12 = 'cookie1';
+        process.env.DISCUZ_COOKIE_34 = 'cookie2';
+
+        const { config } = await import('./config');
+        expect(config.discuz.cookies).toMatchObject({
+            12: 'cookie1',
+            34: 'cookie2',
+        });
+
+        delete process.env.DISCUZ_COOKIE_12;
+        delete process.env.DISCUZ_COOKIE_34;
+    });
+
+    it('medium cookie', async () => {
+        process.env.MEDIUM_COOKIE_12 = 'cookie1';
+        process.env.MEDIUM_COOKIE_34 = 'cookie2';
+
+        const { config } = await import('./config');
+        expect(config.medium.cookies).toMatchObject({
+            12: 'cookie1',
+            34: 'cookie2',
+        });
+
+        delete process.env.MEDIUM_COOKIE_12;
+        delete process.env.MEDIUM_COOKIE_34;
+    });
+
+    it('discourse config', async () => {
+        process.env.DISCOURSE_CONFIG_12 = JSON.stringify({ a: 1 });
+        process.env.DISCOURSE_CONFIG_34 = JSON.stringify({ b: 2 });
+
+        const { config } = await import('./config');
+        expect(config.discourse.config).toMatchObject({
+            12: { a: 1 },
+            34: { b: 2 },
+        });
+
+        delete process.env.DISCOURSE_CONFIG_12;
+        delete process.env.DISCOURSE_CONFIG_34;
+    });
+
+    it('no random ua', async () => {
+        process.env.NO_RANDOM_UA = '1';
+
+        const { config } = await import('./config');
+        expect(config.ua).toBe('RSSHub/1.0 (+http://github.com/DIYgod/RSSHub; like FeedFetcher-Google)');
+
+        delete process.env.NO_RANDOM_UA;
+    });
+
+    it('random ua', async () => {
+        const { config } = await import('./config');
+        expect(config.ua).not.toBe('RSSHub/1.0 (+http://github.com/DIYgod/RSSHub; like FeedFetcher-Google)');
+    });
+
+    it('remote config', async () => {
+        process.env.REMOTE_CONFIG = 'http://rsshub.test/config';
+
+        const { config } = await import('./config');
+        await new Promise((resolve) => setTimeout(resolve, 100));
+        expect(config.ua).toBe('test');
+    });
+});