From cb0eda5602a21d1626a7face32de6153ed07b5f9 Mon Sep 17 00:00:00 2001 From: Alecks Gates Date: Mon, 22 May 2023 09:00:05 -0500 Subject: Add Podcast RSS feeds (#5487) * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Add medium/socialInteract to podcast RSS feeds. Use HTML for description * Change base production image to bullseye, install prosody in image * Add liveItem and trackers to Podcast RSS feeds Remove height from alternateEnclosure, replaced with title. * Clear Podcast RSS feed cache when live streams start/end * Upgrade to Node 16 * Refactor clearCacheRoute to use ApiCache * Remove unnecessary type hint * Update dockerfile to node 16, install python-is-python2 * Use new file paths for captions/playlists * Fix legacy videos in RSS after migration to object storage * Improve method of identifying non-fragmented mp4s in podcast RSS feeds * Don't include fragmented MP4s in podcast RSS feeds * Add experimental support for podcast:categories on the podcast RSS item * Fix undefined category when no videos exist Allows for empty feeds to exist (important for feeds that might only go live) * Add support for podcast:locked -- user has to opt in to show their email * Use comma for podcast:categories delimiter * Make cache clearing async * Fix merge, temporarily test with pfeed-podcast * Syntax changes * Add EXT_MIMETYPE constants for captions * Update & fix tests, fix enclosure mimetypes, remove admin email * Add test for podacst:socialInteract * Add filters hooks for podcast customTags * Remove showdown, updated to pfeed-podcast 6.1.2 * Add 'action:api.live-video.state.updated' hook * Avoid assigning undefined category to podcast feeds * Remove nvmrc * Remove comment * Remove unused podcast config * Remove more unused podcast config * Fix MChannelAccountDefault type hint missed in merge * Remove extra line * Re-add newline in config * Fix lint errors for isEmailPublic * Fix thumbnails in podcast feeds * Requested changes based on review * Provide podcast rss 2.0 only on video channels * Misc cleanup for a less messy PR * Lint fixes * Remove pfeed-podcast * Add peertube version to new hooks * Don't use query include, remove TODO * Remove film medium hack * Clear podcast rss cache before video/channel update hooks * Clear podcast rss cache before video uploaded/deleted hooks * Refactor podcast feed cache clearing * Set correct person name from video channel * Styling * Fix tests --------- Co-authored-by: Chocobozzz --- shared/models/plugins/server/server-hook.model.ts | 15 ++++++++++++++- shared/models/users/user-update-me.model.ts | 1 + shared/models/users/user.model.ts | 1 + shared/models/videos/video-include.enum.ts | 3 ++- shared/server-commands/feeds/feeds-command.ts | 23 +++++++++++++++++++++++ 5 files changed, 41 insertions(+), 2 deletions(-) (limited to 'shared') diff --git a/shared/models/plugins/server/server-hook.model.ts b/shared/models/plugins/server/server-hook.model.ts index 4c9d86079..0ec62222d 100644 --- a/shared/models/plugins/server/server-hook.model.ts +++ b/shared/models/plugins/server/server-hook.model.ts @@ -122,7 +122,17 @@ export const serverFilterHookObject = { // Filter the result of video JSON LD builder // You may also need to use filter:activity-pub.activity.context.build.result to also update JSON LD context - 'filter:activity-pub.video.json-ld.build.result': true + 'filter:activity-pub.video.json-ld.build.result': true, + + // Filter result to allow custom XMLNS definitions in podcast RSS feeds + // Peertube >= 5.2 + 'filter:feed.podcast.rss.create-custom-xmlns.result': true, + + // Filter result to allow custom tags in podcast RSS feeds + // Peertube >= 5.2 + 'filter:feed.podcast.channel.create-custom-tags.result': true, + // Peertube >= 5.2 + 'filter:feed.podcast.video.create-custom-tags.result': true } export type ServerFilterHookName = keyof typeof serverFilterHookObject @@ -154,6 +164,9 @@ export const serverActionHookObject = { // Fired when a live video is created 'action:api.live-video.created': true, + // Fired when a live video starts or ends + // Peertube >= 5.2 + 'action:live.video.state.updated': true, // Fired when a thread is created 'action:api.video-thread.created': true, diff --git a/shared/models/users/user-update-me.model.ts b/shared/models/users/user-update-me.model.ts index e664e44b5..f3cceb5f2 100644 --- a/shared/models/users/user-update-me.model.ts +++ b/shared/models/users/user-update-me.model.ts @@ -16,6 +16,7 @@ export interface UserUpdateMe { videoLanguages?: string[] email?: string + emailPublic?: boolean currentPassword?: string password?: string diff --git a/shared/models/users/user.model.ts b/shared/models/users/user.model.ts index 761a2edba..0761c1e32 100644 --- a/shared/models/users/user.model.ts +++ b/shared/models/users/user.model.ts @@ -13,6 +13,7 @@ export interface User { pendingEmail: string | null emailVerified: boolean + emailPublic: boolean nsfwPolicy: NSFWPolicyType adminFlags?: UserAdminFlag diff --git a/shared/models/videos/video-include.enum.ts b/shared/models/videos/video-include.enum.ts index 7e16b129a..32ee12e86 100644 --- a/shared/models/videos/video-include.enum.ts +++ b/shared/models/videos/video-include.enum.ts @@ -3,5 +3,6 @@ export const enum VideoInclude { NOT_PUBLISHED_STATE = 1 << 0, BLACKLISTED = 1 << 1, BLOCKED_OWNER = 1 << 2, - FILES = 1 << 3 + FILES = 1 << 3, + CAPTIONS = 1 << 4 } diff --git a/shared/server-commands/feeds/feeds-command.ts b/shared/server-commands/feeds/feeds-command.ts index 939b18dee..26763b43e 100644 --- a/shared/server-commands/feeds/feeds-command.ts +++ b/shared/server-commands/feeds/feeds-command.ts @@ -30,6 +30,29 @@ export class FeedCommand extends AbstractCommand { }) } + getPodcastXML (options: OverrideCommandOptions & { + ignoreCache: boolean + channelId: number + }) { + const { ignoreCache, channelId } = options + const path = `/feeds/podcast/videos.xml` + + const query: { [id: string]: string } = {} + + if (ignoreCache) query.v = buildUUID() + if (channelId) query.videoChannelId = channelId + '' + + return this.getRequestText({ + ...options, + + path, + query, + accept: 'application/xml', + implicitToken: false, + defaultExpectedStatus: HttpStatusCode.OK_200 + }) + } + getJSON (options: OverrideCommandOptions & { feed: FeedType ignoreCache: boolean -- cgit v1.2.3