tdm_server_rust/entity/

rss.rs

//! RSS 生成用数据结构 (RSS Feed Entities)
//!
//! 定义 RSS 2.0 订阅源生成所需的全部数据结构。
//!
//! ## RSS 体系概览
//!
//! 提灯喵网站通过 RSS 2.0 对外提供以下订阅源：
//!
//! | RSS 文件 | 内容 | 来源查询 |
//! |----------|------|----------|
//! | `rss.xml` | 最新开坑漫画 | `get_manga_rss` |
//! | `rssUpdated.xml` | 最近更新漫画 | `get_manga_updated_rss` |
//! | `rssEpisode.xml` | 最新话数发布 | `get_episode_rss` |
//! | `rssEpisode_{post}.xml` | 各岗位工作提醒 | `get_work_reminder_rss` |
//!
//! ## 数据流
//!
//! ```text
//! 数据库查询 → RssXxxRow → RssService 格式化 → RssItem → RSS XML 文件
//! ```
//!
//! `RssXxxRow` 是数据库查询的中间行结构，
//! [`RssItem`] 是统一的 RSS 条目格式，
//! 最终由 `RssService` 序列化为 XML 写入 `folder.base` 目录。

use crate::entity::episode::EpisodeType;
use chrono::{DateTime, Utc};
use serde::Serialize;

/// 单个 RSS channel 最大条目数（超出后按事件时间保留最新，旧条目被挤出）
pub const RSS_MAX_ITEMS: u64 = 40;

/// RSS 2.0 统一条目
///
/// 所有 RSS 订阅源的条目均转换为此格式后再序列化为 XML。
/// 包含 RSS 2.0 规范要求的全部可选字段。
///
/// ## 字段说明
///
/// | 字段 | RSS 元素 | 说明 |
/// |------|----------|------|
/// | `title` | `<title>` | 条目标题（漫画译名 或 话数标签） |
/// | `link` | `<link>` | 条目链接（站内 URL） |
/// | `author` | `<author>` | 作者信息（翻译组员名 或 原作作者名） |
/// | `pub_date` | `<pubDate>` | RFC 2822 格式发布时间 |
/// | `category` | `<category>` | 分类描述（长短篇 + 连载状态） |
/// | `description` | `<description>` | HTML 正文（CDATA 包裹） |
/// | `enclosure_url` | `<enclosure url="...">` | 封面图片 URL |
/// | `enclosure_type` | `<enclosure type="...">` | 封面 MIME 类型（通常 `image/jpeg`） |
/// | `guid` | `<guid>` | 唯一标识（漫画 ID 或话数 ID） |
#[derive(Debug, Clone)]
pub struct RssItem {
    /// RSS 条目标题
    pub title: String,
    /// RSS 条目链接（完整 URL）
    pub link: String,
    /// 作者信息（组员名或原作作者名）
    pub author: String,
    /// 发布时间（中文格式，如"2024年1月15日20点30分"）
    pub pub_date: String,
    /// 分类描述（长短篇 + 连载状态）
    pub category: String,
    /// HTML 正文描述（CDATA 包裹）
    pub description: String,
    /// 封面图片 URL
    pub enclosure_url: String,
    /// 封面图片 MIME 类型
    pub enclosure_type: String,
    /// 全局唯一标识符
    pub guid: String,
}

/// 漫画 RSS 查询行
///
/// 来自 `get_manga_rss` 和 `get_manga_updated_rss` 查询的中间结果。
/// 包含漫画基本信息 + 作者信息，用于生成 `rss.xml` 和 `rssUpdated.xml`。
///
/// ## 查询来源
///
/// - [`MangaRepository::get_manga_rss`](crate::repository::manga_repo::MangaRepository) — 最新开坑漫画（按 `setupTime` 降序，最多 [`RSS_MAX_ITEMS`] 条）
/// - [`MangaRepository::get_manga_updated_rss`](crate::repository::manga_repo::MangaRepository) — 最近更新漫画（按 `updateTime` 降序，最多 [`RSS_MAX_ITEMS`] 条）
///
/// ## 对应 Java 查询
///
/// Java `MangaMapper.getMangaRss`。
#[derive(Debug, Clone, Serialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct RssMangaRow {
    /// 漫画 ID，序列化为 `"Id"`
    #[serde(rename = "Id")]
    pub id: i32,
    /// 漫画译名
    pub manga_tran_name: Option<String>,
    /// 漫画原名
    pub manga_ori_name: Option<String>,
    /// 漫画分类
    pub category: Option<i16>,
    /// 连载状态
    pub manga_status: Option<i16>,
    /// 封面图片路径
    pub image: Option<String>,
    /// 开坑时间
    pub setup_time: Option<DateTime<Utc>>,
    /// 最近更新时间
    pub update_time: Option<DateTime<Utc>>,
    /// 原作作者 ID
    pub author_id: Option<i32>,
    /// 原作作者名
    pub author_name: Option<String>,
    /// 作画作者 ID
    pub author_id2: Option<i32>,
    /// 作画作者名
    pub author_name2: Option<String>,
}

/// 话数 RSS 查询行
///
/// 来自 `get_episode_rss` 查询的中间结果。
/// 包含话数信息 + 关联漫画信息 + 图源/翻译组员信息。
/// 用于生成 `rssEpisode.xml`。
///
/// ## 查询来源
///
/// [`MangaRepository::get_episode_rss`](crate::repository::manga_repo::MangaRepository) — 最新话数（按 ID 降序，最多 [`RSS_MAX_ITEMS`] 条）。
///
/// ## 对应 Java 查询
///
/// Java `MangaMapper.getEpisodeRss`。
#[derive(Debug, Clone, Serialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct EpisodeRssRow {
    /// 话数 ID，序列化为 `"Id"`
    #[serde(rename = "Id")]
    pub id: i32,
    /// 漫画 ID
    pub manga_id: i32,
    /// 话数标签（如"第1话"）
    pub manga_episode: Option<String>,
    /// 话数标题
    pub manga_episode_name: Option<String>,
    /// 话数分类，用于生成正篇或番外/特典 RSS 文案
    pub episode_type: EpisodeType,
    /// 话数设立时间
    pub setup_time: Option<DateTime<Utc>>,
    /// 漫画译名
    pub manga_name: Option<String>,
    /// 漫画原名
    pub manga_ori_name: Option<String>,
    /// 漫画分类
    pub category: Option<i16>,
    /// 漫画连载状态
    pub manga_status: Option<i16>,
    /// 漫画开坑时间
    pub manga_setup_time: Option<DateTime<Utc>>,
    /// 封面图片路径
    pub image: Option<String>,
    /// 图源组员名
    pub provider_name: Option<String>,
    /// 翻译组员名
    pub translator_name: Option<String>,
    /// 翻译职阶
    pub intern: Option<i16>,
    /// 翻译邮箱
    pub email: Option<String>,
    /// 发布链接
    pub publish_link: Option<String>,
}

/// 交稿提醒 RSS 查询行
///
/// 来自 `get_work_reminder_rss` 查询的中间结果。
/// 记录某岗位组员交稿后，下一工序组员的提醒信息。
///
/// ## 字段含义
///
/// `my_name` 为当前交稿岗位（如 "translator" 完成翻译，提醒校对接稿）。
/// `username_now`/`intern_now`/`email_now` 为交稿组员信息。
/// `username`/`intern`/`email` 为下一工序组员信息。
///
/// ## 查询来源
///
/// [`MangaRepository::get_work_reminder_rss`](crate::repository::manga_repo::MangaRepository) — 按岗位名查询最新 [`RSS_MAX_ITEMS`] 条交稿提醒。
///
/// ## 对应 Java 查询
///
/// Java `MangaMapper.getWorkReminderRss`。
#[derive(Debug, Clone, Default)]
pub struct WorkReminderRssRow {
    /// 话数 ID
    pub episode_id: i32,
    /// 漫画 ID
    pub manga_id: i32,
    /// 话数标签
    pub manga_episode: Option<String>,
    /// 话数标题
    pub manga_episode_name: Option<String>,
    /// 话数分类，用于生成正篇或番外/特典 RSS 文案
    pub episode_type: EpisodeType,
    /// 话数设立时间
    pub setup_time: Option<DateTime<Utc>>,
    /// 漫画译名
    pub manga_name: Option<String>,
    /// 漫画原名
    pub manga_ori_name: Option<String>,
    /// 漫画分类
    pub category: Option<i16>,
    /// 漫画连载状态
    pub manga_status: Option<i16>,
    /// 漫画开坑时间
    pub manga_setup_time: Option<DateTime<Utc>>,
    /// 封面图片路径
    pub image: Option<String>,
    /// 当前交稿岗位英文名（translator / proofreader / letterer / timer）
    pub my_name: String,
    /// 交稿组员名
    pub username_now: Option<String>,
    /// 交稿组员职阶
    pub intern_now: Option<i16>,
    /// 交稿组员邮箱
    pub email_now: Option<String>,
    /// 下一工序组员名
    pub username: Option<String>,
    /// 下一工序组员职阶
    pub intern: Option<i16>,
    /// 下一工序组员邮箱
    pub email: Option<String>,
}

/// 三月未交稿/未转正组员 RSS 查询行
///
/// 查询超过三个月未交稿（正式）或未转正（实习）的组员信息，用于生成提醒 RSS。
///
/// ## 查询来源
///
/// [`MemberRepository::get_member_reminder_rss`](crate::repository::member_repo::MemberRepository)
/// — 正式组员筛选 `intern=0 AND lastSubmitTime <= NOW() - 3 MONTH`，
///   实习组员筛选 `intern=1 AND registrationTime <= NOW() - 3 MONTH`。
#[derive(Debug, Clone, Default)]
pub struct MemberReminderRssRow {
    /// 组员 ID
    pub id: i32,
    /// 组员用户名
    pub username: Option<String>,
    /// 组员职阶
    pub intern: i16,
    /// 组员邮箱
    pub email: Option<String>,
    /// 最近一次交稿时间（仅正式组员有意义）
    pub last_submit_time: Option<DateTime<Utc>>,
    /// 注册时间（仅实习组员有意义）
    pub registration_time: Option<DateTime<Utc>>,
}

/// 岗位 RSS 输出配置
///
/// 定义每个岗位对应的 RSS XML 文件名和查询参数。
/// 用于 `RSS_POST_CONFIGS` 常量数组，驱动各岗位 RSS 文件的批量生成。
///
/// ## 字段说明
///
/// | 字段 | 说明 |
/// |------|------|
/// | `post_name` | 岗位英文名，对应 `workreminder.myName` 列值 |
/// | `file_name` | 输出的 RSS XML 文件名 |
pub struct RssPostConfig {
    /// 岗位英文名（translator / proofreader / letterer / timer / reviewer）
    pub post_name: &'static str,
    /// 输出的 RSS XML 文件名
    pub file_name: &'static str,
}

/// 全部岗位 RSS 输出配置
///
/// 包含翻译、校对、嵌字、审稿、时轴五个岗位的 RSS 文件配置。
/// 用于 `RssService` 中批量生成各岗位的工作提醒 RSS XML。
///
/// ## 使用方式
///
/// ```rust,ignore
/// for config in RSS_POST_CONFIGS {
///     let rows = repo.get_work_reminder_rss(config.post_name).await?;
///     write_rss_file(config.file_name, rows).await?;
/// }
/// ```
pub const RSS_POST_CONFIGS: &[RssPostConfig] = &[
    RssPostConfig {
        post_name: "translator",
        file_name: "rssEpisode_translator.xml",
    },
    RssPostConfig {
        post_name: "proofreader",
        file_name: "rssEpisode_proofreader.xml",
    },
    RssPostConfig {
        post_name: "letterer",
        file_name: "rssEpisode_letterer.xml",
    },
    RssPostConfig {
        post_name: "reviewer",
        file_name: "rssEpisode_reviewer.xml",
    },
    RssPostConfig {
        post_name: "timer",
        file_name: "rssEpisode_timer.xml",
    },
];