Files
pages/docs/design/ja/feeds.md
T

7.6 KiB
Raw Blame History

15. RSSビューア・FreshRSS・newsboat

状態:正本の役割分担は決定、実装は未着手。既存のブログRSS「配信」と、本章の外部RSS「購読」は別機能。

2026-11-08:利用者指定のサブプロジェクト順で最初に実施する。内蔵readerは簡易利用の 正本、本格運用はFreshRSSを正本とする。実環境の接続先・版・資格情報は別途指定する。

正本と責務

モード 正本 PagesWikiの役割 範囲
内蔵簡易reader PagesWikiの購読・フォルダ・既読・star feed取得、保持上限内の記事保存、閲覧とWiki保存 個人の簡易利用。外部reader向け同期サーバーや高度なルール機能は初期範囲外
FreshRSS連携 FreshRSSの購読・フォルダ・記事・既読・star 表示用cache、連携UI、Wiki保存・タスク化 本格運用。PagesWikiは独立した購読・既読の正本を重ねない
newsboat等のclient 接続先FreshRSS PagesWikiと同じ正本を使う別clientとして扱う PagesWiki経由の代理同期やnewsboatのDB共有は行わない

FreshRSSにはGoogle Reader互換APIがあり、APIの有効化と専用passwordを使います。newsboatにはFreshRSS連携が用意され、カテゴリのtag化やstar操作を扱えます。FreshRSS公式API、newsboat公式マニュアル。

本格運用は FreshRSSを正本、PagesWikiとnewsboatをそのclient とする構成を採用します。 内蔵簡易readerも別providerとして提供し、共通の一覧・保存UIを使用します。FreshRSSを PagesWiki全体の必須依存にはせず、外部サービスの新設・接続は設定時の明示操作とします。

sourceは一つのproviderに束縛し、記事キーはDomain/所有者/source UUID/remote IDで 区別します。同じURLの記事でも別sourceの既読を自動統合しません。FreshRSSのcacheは 再取得可能な派生データですが、内蔵の購読・状態は正本として保全対象にします。

FreshRSS停止時は取得済みcacheと鮮度・接続状態を示し、内蔵正本へ自動切替しません。 外部操作の未送信状態は正本と区別し、成功していない既読・starを同期済みと表示しません。 内蔵からFreshRSSへの移行はOPML等による明示的なexport/importとし、初期版では既読・star・ 記事IDの完全移行を保証しません。移行完了の確認前に内蔵データを削除しません。

読取MVP

購読一覧、フォルダ、記事一覧、外部原文、Wiki保存を提供します。初期段階では表示しただけでFreshRSSへ既読を送りません。UIには「読取専用・既読は同期していない」と明示します。ブラウザへFreshRSS password/tokenを渡さず、backend connectorがsecret参照を使います。

最小cache案はsource UUID、remote feed/item ID、title、safe excerpt/body hash、canonical URL、published/updated/fetched時刻、remote state/versionです。IDなしRSSにはfeed単位の保守的な代替キーを使い、題名だけで重複排除しません。Atomはentry IDと更新情報を持つ形式です。Atom仕様。

既読・star同期を追加する条件

server-authoritative stateと未送信の操作を分けます。操作ごとのrequest_idで重複を防ぎ、成功応答前に確定済みと表示しません。newsboat等で同時変更された場合、古いローカルcacheをまとめて送り返しません。接続解除・認可失効時は未送信変更を勝手に再送しません。

FreshRSS APIに条件付き更新がない操作もあり得るため、対応版の実機fixtureで競合動作を確認するまで完全な双方向同期を約束しません。

内蔵簡易reader

購読追加/削除、フォルダ、記事一覧、既読/未読、star、更新間隔と保持上限を初期範囲に します。取得は背景ジョブで行い、更新失敗で購読や状態を消しません。記事本文cacheと 既読・starの保持期間を分離し、古い記事を再取得しただけで未読へ戻る挙動を防ぎます。 高度な自動分類、全文収集、reader向け互換APIはFreshRSSとの機能競争として追加しません。

定期event、条件付きGET、host別同時数、timeout、応答サイズ、展開サイズ、backoffを設けます。XML外部entityを無効にし、feed HTMLを安全化します。redirect/DNSを含むSSRF対策、外部画像の同意、個人購読URLや認証情報の秘匿が必要です。

OPMLは購読の入出力として扱い、既読・star・全本文のバックアップと同一視しません。importはpreview・追加/置換選択・重複確認を行い、既存購読を黙って削除しません。

Wiki保存と権利・公開

既定はURL、出典、短いメモの保存です。全文保存は取得可能性・利用条件・個人用途等を確認する独立操作とし、feedが短いからといって有料記事を自動取得しません。保存先が自動公開範囲なら内容と添付の公開を明示確認します。

TODOと受け入れ

RSS-1:read-only FreshRSS fixture。RSS-2:安全な共通一覧と出典付きWiki保存。RSS-3:FreshRSSへの明示的な既読/star操作。RSS-4:内蔵簡易readerとOPML。オフライン、欠落ID、巨大feed、未知HTML、同期再送、他user情報、feed削除後の保存Page維持を試験します。内蔵とFreshRSSの正本を混ぜないこと、停止時の自動切替がないこと、移行後も保存済みWiki/タスクが残ることを両provider共通の受入条件とします。

実施段階

  1. 共通契約とfixture:Domain/本人のsource所有、provider ID、remote ID、cursor、取得予算、 最終成功/失敗と無効化を定義する。FreshRSS読取connectorを合成fixtureで先に検証し、 内蔵providerも同じ表示契約へ接続する。sourceの資格情報をブラウザ・ログへ出さない。
  2. 読取UIと背景取得:購読/フォルダ、記事の一行一覧、本文表示、出典リンクを用意する。 デスクトップでは一覧を見渡せる配置、スマホでは一覧と本文を切り替える。画面表示で外部fetchを 待たず、schedulerで有界に更新し、取得済みcacheと鮮度を表示する。source停止・失効も検証する。
  3. Wiki保存とタスク化:タイトル・URL・出典・短いメモをpreviewし、保存先Pathを選ぶ。 既存captureと権限確認を再利用し、二重送信・保存先競合・自動公開範囲を検査する。全文保存は 独立した明示操作。タスク作成が失敗しても保存済みWikiを消さず、部分成功と再試行方法を示す。
  4. ダッシュボードとprovider完成:読める記事だけのwidget、内蔵簡易readerとOPML、 FreshRSSの明示的な既読/star操作を段階的に追加する。接続先・対象版の指定後に実環境で read-only→書込の順に受入し、read-only連携を有効化しただけで外部状態を変更しない。

各段階で無効化、件数・時間・容量上限、移行の再実行、ユーザー/Domain間の分離を試験する。 source解除時のcache清掃と、利用者が明示保存したWiki/タスクの保持は別操作とする。