RSS 订阅

RSS 订阅源

概述

RSS 是一种内容聚合工具，通常以 XML 为基础协议。一个 RSS 订阅源中的内容通常有如下格式：

xml

<rss version="2.0">
    <script/>
    <channel>
        <title>Example RSS Source</title>
        <link>https://example.com/RSS</link>
        <description>Example RSS Source</description>
        <item>
            <guid isPermaLink="false">The guid</guid>
            <link>The link</link>
            <title>The title</title>
            <description>The description</description>
            <torrent xmlns="https://example.com/0.1/">
                <link>The link</link>
                <contentLength>287058176</contentLength>
                <pubDate>2023-12-01T18:27:53.925</pubDate>
            </torrent>
            <enclosure type="application/x-bittorrent" length="287058176" url="The url"/>
        </item>
        <item>...</item>
        <item>...</item>
        <item>...</item>
        <item>...</item>
    </channel>
</rss>

在 MinaPlay 中，每个 RSS 订阅源拥有其独立的配置和订阅规则。 MinaPlay 会定期解析 RSS 订阅源的内容，结合用户定义的订阅规则判断资源是否需要下载，并在下载后通过订阅规则整理媒体文件。

订阅模式

不同的 RSS 资源站点通常包含多种类型的订阅模式，用户可以根据自身需要选择合适的订阅模式。此处列举一些常见的订阅模式：

提示

RSS 订阅模式是指 RSS 资源站点提供的订阅方式，不是 MinaPlay 提供的功能，不论使用哪种 RSS 订阅模式 MinaPlay 都可以正常解析。

列表订阅模式
通常情况下可以直接使用资源站提供的默认列表 RSS 订阅源，此类订阅源内容包含了该 RSS 资源站点的所有内容更新。
默认列表订阅通常会包含大量订阅项目，MinaPlay 解析时会检查和匹配所有 RSS 项目，可能会造成 CPU 、内存等服务器资源的浪费。如果要节省服务器资源使用，请尽量减少 RSS 订阅源中的订阅项目。
个人订阅模式
部分 RSS 资源站点提供了用户自定义 RSS 订阅内容的功能，例如在网站页面中选择订阅项目生成个人 RSS 订阅源。这种情况下可以避免 MinaPlay 解析大部分无效订阅项目，但需要用户手动配置订阅信息。
这种情况下的 RSS 订阅地址通常会携带用户的登录 Token 或其他身份标识符，如下所示：
```
https://xxx.com/rss?token=xxxxxx
https://xxx.com/rss/latest?token=xxxxxx
```
条件订阅模式
部分 RSS 资源站点提供了条件订阅的功能，如只订阅某个剧集的更新、订阅某个发布组的更新或是订阅某些关键字内容的更新。用户可以使用条件订阅有针对性地个性化订阅内容。这种情况下通常需要用户配置多个 RSS 订阅源用以订阅不同属性的媒体资源。
其 RSS 订阅链接通常携带所订阅内容的相关信息，如下所示：
```
https://xxx.com/series/123456/rss
https://xxx.com/subs/Un-Sub/rss
https://xxx.com/rss?keyword=xxxxxx
```

在 MinaPlay 中添加订阅源

注意

此操作需要当前登录用户具有 管理 RSS 订阅源 的相关权限。

要在 MinaPlay 中添加 RSS 订阅源，首先需要在资源聚合站点中复制 RSS 订阅链接。

RSS 订阅链接一般会用图标表示。

之后在 MinaPlay 中新建 RSS 订阅源，你将看到如下的信息参数页面。

填入 RSS 订阅源的基本参数并保存信息：

标题 - RSS 订阅源的标题，可以随意填写。
链接 - RSS 订阅源的链接，填入刚才复制的链接地址。
CRON 表达式 - MinaPlay 检查 RSS 订阅源内容更新的时间周期。
备注 - RSS 订阅源的用户备注，可以随意填写。

提示

RSS 订阅源链接内容应包含每一项的下载地址，否则 MinaPlay 将无法下载对应媒体资源。
CRON 表达式的周期越短，服务器资源消耗越大，请尽量避免使用过短周期。
确保 RSS 订阅链接内容可以被 GET 请求正常访问。对于需要配置额外请求参数或需要代理网络配置的 RSS 订阅源，请参阅代理配置章节。

之后在操作板块中启用此订阅源。

订阅规则

提示

MinaPlay 中订阅规则使用到了 TypeScript 编程语言的语法，推荐用户先简单了解 TypeScript 编程语言。

对于个性化需求不高的普通用户，可以直接参阅常用订阅规则章节，复制或简单更改代码。

概述

订阅规则是 MinaPlay 对 RSS 订阅源进行个性化解析下载的核心板块。其本质上是一段 JavaScript 代码，通过用户描述的行为控制 MinaPlay 的下载和整理。

重要

订阅规则代码运行在独立的沙箱环境中，不可导入如 fs, axios 等其他模块。

在 MinaPlay 解析订阅源时，会把 RSS 包含的每个项目转化为一个 JavaScript 对象，其结构定义如下：

typescript

interface FeedEntry {
  id: string; // guid
  link?: string; // 原始链接
  title?: string; // 原始标题
  description?: string; // 原始描述
  published?: Date; // 上传时间
}

用户可以通过这个对象判断是否应该下载，下载后如何描述该媒体资源文件。每个订阅规则只需要提供两个函数： validate 和 describe ，其结构定义如下：

typescript

/**
 * Validate an RSS feed entry, Returns whether MinaPlay should download this entry
 * @param entry Original RSS feed entry
 */
declare type RuleEntryValidator = (entry: FeedEntry) => boolean | Promise<boolean>;

/**
 * Describe a downloaded media file
 * @param entry Original RSS feed entry
 * @param file Media file
 * @param files Media files in the same download task
 */
declare type RuleFileDescriber = (
  entry: FeedEntry,
  file: FileEntity,
  files: FileEntity[],
) => RuleFileDescriptor | Promise<RuleFileDescriptor>;

这里列举一个简单案例，在某 RSS 订阅站点上下载名为《NO GAME NO LIVE》（假设它真的存在）第二集的番剧，并整理成对应的剧集。我们可以用一段 JavaScript 代码描述这个订阅行为：

typescript

const hooks: RuleHooks = {
  validate(entry) {
    return entry.title === '[Un-Sub] NO GAME NO LIVE 02 [1080P][BDRip][AAC AVC][HEVC][CHS]'; // 判断 RSS 项目标题
  },
  describe(entry) {
    return {
      series: {
        name: 'NO GAME NO LIVE', // 剧集名叫 'NO GAME NO LIVE'
      },
      episode: {
        title: entry.title, // 单集名称直接使用 RSS 项目的标题
        no: '02', // 单集的集号
      }
    }
  },
};
export default hooks;

其中第 2~4 行 validate 函数用于判断资源是否应该被下载，其返回一个布尔值，当为 true 时 MinaPlay 将会下载对应媒体资源。

第 6~14 行 describe 函数用于描述下载后的媒体文件，如所属剧集、当前集数等信息。

提示

describe 函数不是必要的，其主要用于描述下载后的媒体文件的相关信息。当不提供 describe 函数时，MinaPlay 将结合使用订阅项目和本地下载文件生成媒体文件的描述信息。

基础使用

RSS 资源站点中用户在发布更新时，新的订阅项目中一般会包含如下的信息：

id - 该订阅项目的唯一标识符，通常由 RSS 资源站点分配。
link - 该订阅项目的发布页地址，此发布页通常包含了该资源的详细说明。
title - 该订阅项目的标题，用于项目的识别和检索。
description - 该订阅项目的简要说明文本。
published - 该订阅项目的发布时间。

在 MinaPlay 中，是否下载某个订阅项目可以由这几个信息确定。对于简单的订阅需求甚至可以直接由 title 字段确定。

回到刚才的例子，一个发布组发布了 title 为如下文本的 RSS 订阅项目：

[Un-Sub] NO GAME NO LIVE 02 [1080P][BDRip][AAC AVC][HEVC][CHS]

作为一个订阅项目标题，其包含了资源的一些基础属性，不同的发布组习惯于不同的标题命名规范，但一般都包含了下面所示的信息：

内容	说明	常见值
[Un-Sub]	发布组名称。Un-Sub 只是一个假设的发布组名称。	`xxx-sub` `xxx字幕组`
NO GAME NO LIVE	资源对应的媒体文件名称（电影 / 剧集名称）。
02	资源对应的剧集集号。
[1080P]	资源对应媒体文件的视频质量。	`1080P` `4K` `720P`
[BDRip]	资源的具体来源，通常有蓝光光碟、网络下载等来源。	`BDRip` `WEB-DL`
[AAC AVC]	资源对应媒体文件的音频格式。	`AAC` `AVC` `FLAC`
[HEVC]	资源对应媒体文件的视频格式。	`MP4` `HEVC` `H265`
[CHS]	资源对应媒体文件携带的字幕语言。	`CHS` `CHT` `JP`

在此基础之上，我们可以个性化自己的订阅规则，例如下面的订阅规则代码：

typescript

const hooks: RuleHooks = {
  validate(entry) {
    // 我想要看 1080P 的 《NO GAME NO LIVE》 番剧！但是不要 Un-Sub 发布的版本。
    return entry.title.includes('NO GAME NO LIVE')
      && entry.title.includes('1080P')
      && !entry.title.includes('Un-Sub');
  },
}
export default hooks;

到此为止，你已经了解了 MinaPlay 订阅规则的工作原理和使用方式，更高级的使用方式等待着你的探索！

进阶使用

提示

建议读者在阅读本章节前先了解正则表达式的基础用法。

很多时候用户需要深度定制订阅规则，并同时让 MinaPlay 担任下载后媒体文件的整理工作。这种情况下，用户需要编写更加复杂的订阅规则代码。

再回到刚才的例子，多数情况下，发布组发布的资源通常会以统一格式命名，其中只会有集号的变动。现在我们修改之前的订阅规则，让其支持固定格式的标题解析并详细描述下载的媒体文件。

typescript

// 编写固定格式的正则表达式
const regexp = /\[Un-Sub\] NO GAME NO LIVE ([\d.]+)([vV]\d+)? \[1080P\]\[BDRip\]\[AAC AVC\]\[HEVC\]\[CHS\]/;
const hooks: RuleHooks = {
  validate(entry) {
    // 只有满足正则表达式才下载。
    return regexp.test(entry.title);
  },
  describe(entry) {
    const groups = entry.title.match(regexp);
    return {
      series: {
        name: 'NO GAME NO LIVE', // 剧集的名称
        season: '01', // 剧集的季度
      },
      episode: {
        title: entry.title, // 单集的标题
        no: groups?.[1], // 单集的集号
      },
      overwriteEpisode: true, // 当存在重复单集时覆盖原有单集
    }
  }
}
export default hooks;

可以看到，我们仅仅通过一个正则表达式便完成了指定资源的解析判断和媒体文件描述。

熟悉正则表达式的读者可能注意到，我们使用了表达式 ([\d.]+)([vV]\d+)? 来确定发布的剧集集号。这和平常使用的直觉不同，正常情况下剧集的集号类似于 01, 12 这种数字。但在实际上在发布组发布的资源中，可能会存在类似于 12.5 这种过渡集号的命名。如果直接使用表达式 (\d+) 进行解析，将会导致 MinaPlay 错误地判断为此集不需要下载，或是解析为错误的集号。为了考虑到这种过渡集号的命名方式，请尽量使用 ([\d.]+) 的表达式。

另外，发布组在发布资源时，可能会因为各种因素发布了错误的资源。遇到这种情况时，发布组通常会在同一 RSS 资源站点发布针对同一资源的修正版本。

举个简单的例子，发布组发布了名为 NO GAME NO LIVE 02 的资源（这里省略了其他标题说明文本）。但在之后发现发布资源的视频文件存在问题，于是发布组发布了一个新的修正资源 NO GAME NO LIVE 02v2 。这种情况下，用户一般需要下载新的媒体资源并且替换原有的错误资源文件，所以我们在集号的正则表达式后面添加了发布版本的正则表达式 ([vV]\d+)? 。

在 MinaPlay 中添加订阅规则

注意

此操作需要当前登录用户具有 管理 RSS 订阅源 的相关权限。

要在 MinaPlay 中添加订阅规则，只需要在管理页面中新建订阅规则即可。之后填入订阅规则的基本参数，选择绑定 RSS 订阅源，并修改订阅规则代码。

备注 - 订阅规则的备注，通常可以填写规则对应的剧集名称。
RSS 订阅源 - 选择订阅规则的作用范围，此订阅规则只会在选定的 RSS 订阅源被 MinaPlay 解析时生效。
代码 - 订阅规则的代码。

提示

订阅规则的代码支持使用 TypeScript 语言编写， MinaPlay 网页客户端提供的编辑器包含订阅规则完整的类型定义，可以在对应标识符上使用组合键 Ctrl + 左键 查看。

RSS 订阅 ​

RSS 订阅源 ​

概述 ​

订阅模式 ​

在 MinaPlay 中添加订阅源 ​

订阅规则 ​

概述 ​

基础使用 ​

进阶使用 ​

在 MinaPlay 中添加订阅规则 ​

RSS 订阅

RSS 订阅源

概述

订阅模式

在 MinaPlay 中添加订阅源

订阅规则

概述

基础使用

进阶使用

在 MinaPlay 中添加订阅规则