PeerTube/shared/server-commands/feeds/feeds-command.ts

79 lines
1.9 KiB
TypeScript
Raw Normal View History

2022-06-27 03:36:16 -05:00
import { buildUUID } from '@shared/extra-utils'
2021-07-16 03:42:24 -05:00
import { HttpStatusCode } from '@shared/models'
2021-07-06 03:21:35 -05:00
import { AbstractCommand, OverrideCommandOptions } from '../shared'
2020-11-09 09:25:27 -06:00
type FeedType = 'videos' | 'video-comments' | 'subscriptions'
2018-06-08 13:34:37 -05:00
2021-07-06 03:21:35 -05:00
export class FeedCommand extends AbstractCommand {
2021-07-06 03:21:35 -05:00
getXML (options: OverrideCommandOptions & {
feed: FeedType
2022-06-27 03:36:16 -05:00
ignoreCache: boolean
2021-07-06 03:21:35 -05:00
format?: string
}) {
2022-06-27 03:36:16 -05:00
const { feed, format, ignoreCache } = options
2021-07-06 03:21:35 -05:00
const path = '/feeds/' + feed + '.xml'
2022-06-27 03:36:16 -05:00
const query: { [id: string]: string } = {}
if (ignoreCache) query.v = buildUUID()
if (format) query.format = format
2021-07-06 03:21:35 -05:00
return this.getRequestText({
...options,
2021-07-06 03:21:35 -05:00
path,
2022-06-27 03:36:16 -05:00
query,
2021-07-06 03:21:35 -05:00
accept: 'application/xml',
implicitToken: false,
2021-07-06 03:21:35 -05:00
defaultExpectedStatus: HttpStatusCode.OK_200
})
}
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 <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
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
})
}
2021-07-06 03:21:35 -05:00
getJSON (options: OverrideCommandOptions & {
feed: FeedType
2022-06-27 03:36:16 -05:00
ignoreCache: boolean
2021-07-06 03:21:35 -05:00
query?: { [ id: string ]: any }
}) {
2022-06-27 03:36:16 -05:00
const { feed, query = {}, ignoreCache } = options
2021-07-06 03:21:35 -05:00
const path = '/feeds/' + feed + '.json'
2022-06-27 03:36:16 -05:00
const cacheQuery = ignoreCache
? { v: buildUUID() }
: {}
2021-07-06 03:21:35 -05:00
return this.getRequestText({
...options,
2021-07-06 03:21:35 -05:00
path,
2022-06-27 03:36:16 -05:00
query: { ...query, ...cacheQuery },
2021-07-06 03:21:35 -05:00
accept: 'application/json',
implicitToken: false,
2021-07-06 03:21:35 -05:00
defaultExpectedStatus: HttpStatusCode.OK_200
})
}
}