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 --- server/lib/blocklist.ts | 4 +-- server/lib/client-html.ts | 6 ++--- server/lib/files-cache/videos-preview-cache.ts | 2 +- server/lib/internal-event-emitter.ts | 35 ++++++++++++++++++++++++++ server/lib/live/live-manager.ts | 4 +++ server/lib/plugins/plugin-helpers-builder.ts | 2 +- 6 files changed, 46 insertions(+), 7 deletions(-) create mode 100644 server/lib/internal-event-emitter.ts (limited to 'server/lib') diff --git a/server/lib/blocklist.ts b/server/lib/blocklist.ts index a11b717b5..009e229ce 100644 --- a/server/lib/blocklist.ts +++ b/server/lib/blocklist.ts @@ -1,6 +1,6 @@ import { sequelizeTypescript } from '@server/initializers/database' import { getServerActor } from '@server/models/application/application' -import { MAccountBlocklist, MAccountId, MAccountServer, MServerBlocklist } from '@server/types/models' +import { MAccountBlocklist, MAccountId, MAccountHost, MServerBlocklist } from '@server/types/models' import { AccountBlocklistModel } from '../models/account/account-blocklist' import { ServerBlocklistModel } from '../models/server/server-blocklist' @@ -34,7 +34,7 @@ function removeServerFromBlocklist (serverBlock: MServerBlocklist) { }) } -async function isBlockedByServerOrAccount (targetAccount: MAccountServer, userAccount?: MAccountId) { +async function isBlockedByServerOrAccount (targetAccount: MAccountHost, userAccount?: MAccountId) { const serverAccountId = (await getServerActor()).Account.id const sourceAccounts = [ serverAccountId ] diff --git a/server/lib/client-html.ts b/server/lib/client-html.ts index 058f29f03..18b16bee1 100644 --- a/server/lib/client-html.ts +++ b/server/lib/client-html.ts @@ -27,7 +27,7 @@ import { AccountModel } from '../models/account/account' import { VideoModel } from '../models/video/video' import { VideoChannelModel } from '../models/video/video-channel' import { VideoPlaylistModel } from '../models/video/video-playlist' -import { MAccountActor, MChannelActor, MVideo, MVideoPlaylist } from '../types/models' +import { MAccountHost, MChannelHost, MVideo, MVideoPlaylist } from '../types/models' import { getActivityStreamDuration } from './activitypub/activity' import { getBiggestActorImage } from './actor-image' import { Hooks } from './plugins/hooks' @@ -260,7 +260,7 @@ class ClientHtml { } private static async getAccountOrChannelHTMLPage ( - loader: () => Promise, + loader: () => Promise, req: express.Request, res: express.Response ) { @@ -280,7 +280,7 @@ class ClientHtml { let customHtml = ClientHtml.addTitleTag(html, entity.getDisplayName()) customHtml = ClientHtml.addDescriptionTag(customHtml, description) - const url = entity.getLocalUrl() + const url = entity.getClientUrl() const originUrl = entity.Actor.url const siteName = CONFIG.INSTANCE.NAME const title = entity.getDisplayName() diff --git a/server/lib/files-cache/videos-preview-cache.ts b/server/lib/files-cache/videos-preview-cache.ts index 48d2cb52c..d19c3f4f4 100644 --- a/server/lib/files-cache/videos-preview-cache.ts +++ b/server/lib/files-cache/videos-preview-cache.ts @@ -37,7 +37,7 @@ class VideosPreviewCache extends AbstractVideoStaticFileCache { const preview = video.getPreview() const destPath = join(FILES_CACHE.PREVIEWS.DIRECTORY, preview.filename) - const remoteUrl = preview.getFileUrl(video) + const remoteUrl = preview.getOriginFileUrl(video) try { await doRequestAndSaveToFile(remoteUrl, destPath) diff --git a/server/lib/internal-event-emitter.ts b/server/lib/internal-event-emitter.ts new file mode 100644 index 000000000..08b46a5c3 --- /dev/null +++ b/server/lib/internal-event-emitter.ts @@ -0,0 +1,35 @@ +import { MChannel, MVideo } from '@server/types/models' +import { EventEmitter } from 'events' + +export interface PeerTubeInternalEvents { + 'video-created': (options: { video: MVideo }) => void + 'video-updated': (options: { video: MVideo }) => void + 'video-deleted': (options: { video: MVideo }) => void + + 'channel-created': (options: { channel: MChannel }) => void + 'channel-updated': (options: { channel: MChannel }) => void + 'channel-deleted': (options: { channel: MChannel }) => void +} + +declare interface InternalEventEmitter { + on( + event: U, listener: PeerTubeInternalEvents[U] + ): this + + emit( + event: U, ...args: Parameters + ): boolean +} + +class InternalEventEmitter extends EventEmitter { + + private static instance: InternalEventEmitter + + static get Instance () { + return this.instance || (this.instance = new this()) + } +} + +export { + InternalEventEmitter +} diff --git a/server/lib/live/live-manager.ts b/server/lib/live/live-manager.ts index 5c6e69806..acb7af274 100644 --- a/server/lib/live/live-manager.ts +++ b/server/lib/live/live-manager.ts @@ -399,6 +399,8 @@ class LiveManager { } PeerTubeSocket.Instance.sendVideoLiveNewState(video) + + Hooks.runAction('action:live.video.state.updated', { video }) } catch (err) { logger.error('Cannot save/federate live video %d.', videoId, { err, ...localLTags }) } @@ -466,6 +468,8 @@ class LiveManager { PeerTubeSocket.Instance.sendVideoLiveNewState(fullVideo) await federateVideoIfNeeded(fullVideo, false) + + Hooks.runAction('action:live.video.state.updated', { video: fullVideo }) } catch (err) { logger.error('Cannot save/federate new video state of live streaming of video %s.', videoUUID, { err, ...lTags(videoUUID) }) } diff --git a/server/lib/plugins/plugin-helpers-builder.ts b/server/lib/plugins/plugin-helpers-builder.ts index 92ef87cca..d235f52c0 100644 --- a/server/lib/plugins/plugin-helpers-builder.ts +++ b/server/lib/plugins/plugin-helpers-builder.ts @@ -133,7 +133,7 @@ function buildVideosHelpers () { const thumbnails = video.Thumbnails.map(t => ({ type: t.type, - url: t.getFileUrl(video), + url: t.getOriginFileUrl(video), path: t.getPath() })) -- cgit v1.2.3