RSSHub/lib/routes/rsshub/transform/html.ts

import { Route } from '@/types';
import got from '@/utils/got';
import { load } from 'cheerio';
import { config } from '@/config';

export const route: Route = {
    path: '/transform/html/:url/:routeParams',
    categories: ['other'],
    example: '/rsshub/transform/html/https%3A%2F%2Fwechat2rss.xlab.app%2Fposts%2Flist%2F/item=div%5Bclass%3D%27post%2Dcontent%27%5D%20p%20a',
    parameters: { url: '`encodeURIComponent`ed URL address', routeParams: 'Transformation rules, requires URL encode' },
    features: {
        requireConfig: ['ALLOW_USER_SUPPLY_UNSAFE_DOMAIN'],
        requirePuppeteer: false,
        antiCrawler: false,
        supportBT: false,
        supportPodcast: false,
        supportScihub: false,
    },
    name: 'Transformation - HTML',
    maintainers: ['ttttmr'],
    handler,
    description: `Pass URL and transformation rules to convert HTML/JSON into RSS.

Specify options (in the format of query string) in parameter \`routeParams\` parameter to extract data from HTML.

| Key               | Meaning                                                        | Accepted Values | Default                |
| ----------------- | -------------------------------------------------------------- | --------------- | ---------------------- |
| \`title\`           | The title of the RSS                                           | \`string\`        | Extract from \`<title>\` |
| \`item\`            | The HTML elements as \`item\` using CSS selector                 | \`string\`        | html                   |
| \`itemTitle\`       | The HTML elements as \`title\` in \`item\` using CSS selector      | \`string\`        | \`item\` element         |
| \`itemTitleAttr\`   | The attributes of \`title\` element as title                     | \`string\`        | Element text           |
| \`itemLink\`        | The HTML elements as \`link\` in \`item\` using CSS selector       | \`string\`        | \`item\` element         |
| \`itemLinkAttr\`    | The attributes of \`link\` element as link                       | \`string\`        | \`href\`                 |
| \`itemDesc\`        | The HTML elements as \`descrption\` in \`item\` using CSS selector | \`string\`        | \`item\` element         |
| \`itemDescAttr\`    | The attributes of \`descrption\` element as description          | \`string\`        | Element html           |
| \`itemPubDate\`     | The HTML elements as \`pubDate\` in \`item\` using CSS selector    | \`string\`        | \`item\` element         |
| \`itemPubDateAttr\` | The attributes of \`pubDate\` element as pubDate                 | \`string\`        | Element html           |

  Parameters parsing in the above example:

  | Parameter     | Value                                     |
  | ------------- | ----------------------------------------- |
  | \`url\`         | \`https://wechat2rss.xlab.app/posts/list/\` |
  | \`routeParams\` | \`item=div[class='post-content'] p a\`      |

  Parsing of \`routeParams\` parameter:

  | Parameter | Value                           |
  | --------- | ------------------------------- |
  | \`item\`    | \`div[class='post-content'] p a\` |`,
};

async function handler(ctx) {
    if (!config.feature.allow_user_supply_unsafe_domain) {
        throw new Error(`This RSS is disabled unless 'ALLOW_USER_SUPPLY_UNSAFE_DOMAIN' is set to 'true'.`);
    }
    const url = ctx.req.param('url');
    const response = await got({
        method: 'get',
        url,
    });

    const routeParams = new URLSearchParams(ctx.req.param('routeParams'));
    const $ = load(response.data);
    const rssTitle = routeParams.get('title') || $('title').text();
    const item = routeParams.get('item') || 'html';
    const items = $(item)
        .toArray()
        .map((item) => {
            try {
                item = $(item);

                const titleEle = routeParams.get('itemTitle') ? item.find(routeParams.get('itemTitle')) : item;
                const title = routeParams.get('itemTitleAttr') ? titleEle.attr(routeParams.get('itemTitleAttr')) : titleEle.text();

                let link;
                const linkEle = routeParams.get('itemLink') ? item.find(routeParams.get('itemLink')) : item;
                if (routeParams.get('itemLinkAttr')) {
                    link = linkEle.attr(routeParams.get('itemLinkAttr'));
                } else {
                    link = linkEle.is('a') ? linkEle.attr('href') : linkEle.find('a').attr('href');
                }
                // 补全绝对链接
                link = link.trim();
                if (link && !link.startsWith('http')) {
                    link = `${new URL(url).origin}${link}`;
                }

                const descEle = routeParams.get('itemDesc') ? item.find(routeParams.get('itemDesc')) : item;
                const desc = routeParams.get('itemDescAttr') ? descEle.attr(routeParams.get('itemDescAttr')) : descEle.html();

                const pubDateEle = routeParams.get('itemPubDate') ? item.find(routeParams.get('itemPubDate')) : item;
                const pubDate = routeParams.get('itemPubDateAttr') ? pubDateEle.attr(routeParams.get('itemPubDateAttr')) : pubDateEle.html();

                return {
                    title,
                    link,
                    description: desc,
                    pubDate,
                };
            } catch {
                return null;
            }
        })
        .filter(Boolean);

    return {
        title: rssTitle,
        link: url,
        description: `Proxy ${url}`,
        item: items,
    };
}