diff options
author | Alecks Gates <agates@mail.agates.io> | 2023-05-22 09:00:05 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-22 16:00:05 +0200 |
commit | cb0eda5602a21d1626a7face32de6153ed07b5f9 (patch) | |
tree | d6a7a4e31c7267c130871ac8e3beb42994271c20 /server/middlewares/validators/feeds.ts | |
parent | 3f0ceab06e5320f62f593c49daa30d963dbc36f9 (diff) | |
download | PeerTube-cb0eda5602a21d1626a7face32de6153ed07b5f9.tar.gz PeerTube-cb0eda5602a21d1626a7face32de6153ed07b5f9.tar.zst PeerTube-cb0eda5602a21d1626a7face32de6153ed07b5f9.zip |
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>
Diffstat (limited to 'server/middlewares/validators/feeds.ts')
-rw-r--r-- | server/middlewares/validators/feeds.ts | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/server/middlewares/validators/feeds.ts b/server/middlewares/validators/feeds.ts index 0bfe89e6f..ee8615cae 100644 --- a/server/middlewares/validators/feeds.ts +++ b/server/middlewares/validators/feeds.ts | |||
@@ -3,6 +3,7 @@ import { param, query } from 'express-validator' | |||
3 | import { HttpStatusCode } from '../../../shared/models/http/http-error-codes' | 3 | import { HttpStatusCode } from '../../../shared/models/http/http-error-codes' |
4 | import { isValidRSSFeed } from '../../helpers/custom-validators/feeds' | 4 | import { isValidRSSFeed } from '../../helpers/custom-validators/feeds' |
5 | import { exists, isIdOrUUIDValid, isIdValid, toCompleteUUID } from '../../helpers/custom-validators/misc' | 5 | import { exists, isIdOrUUIDValid, isIdValid, toCompleteUUID } from '../../helpers/custom-validators/misc' |
6 | import { buildPodcastGroupsCache } from '../cache' | ||
6 | import { | 7 | import { |
7 | areValidationErrors, | 8 | areValidationErrors, |
8 | checkCanSeeVideo, | 9 | checkCanSeeVideo, |
@@ -43,6 +44,21 @@ function setFeedFormatContentType (req: express.Request, res: express.Response, | |||
43 | acceptableContentTypes = [ 'application/xml', 'text/xml' ] | 44 | acceptableContentTypes = [ 'application/xml', 'text/xml' ] |
44 | } | 45 | } |
45 | 46 | ||
47 | return feedContentTypeResponse(req, res, next, acceptableContentTypes) | ||
48 | } | ||
49 | |||
50 | function setFeedPodcastContentType (req: express.Request, res: express.Response, next: express.NextFunction) { | ||
51 | const acceptableContentTypes = [ 'application/rss+xml', 'application/xml', 'text/xml' ] | ||
52 | |||
53 | return feedContentTypeResponse(req, res, next, acceptableContentTypes) | ||
54 | } | ||
55 | |||
56 | function feedContentTypeResponse ( | ||
57 | req: express.Request, | ||
58 | res: express.Response, | ||
59 | next: express.NextFunction, | ||
60 | acceptableContentTypes: string[] | ||
61 | ) { | ||
46 | if (req.accepts(acceptableContentTypes)) { | 62 | if (req.accepts(acceptableContentTypes)) { |
47 | res.set('Content-Type', req.accepts(acceptableContentTypes) as string) | 63 | res.set('Content-Type', req.accepts(acceptableContentTypes) as string) |
48 | } else { | 64 | } else { |
@@ -55,6 +71,8 @@ function setFeedFormatContentType (req: express.Request, res: express.Response, | |||
55 | return next() | 71 | return next() |
56 | } | 72 | } |
57 | 73 | ||
74 | // --------------------------------------------------------------------------- | ||
75 | |||
58 | const videoFeedsValidator = [ | 76 | const videoFeedsValidator = [ |
59 | query('accountId') | 77 | query('accountId') |
60 | .optional() | 78 | .optional() |
@@ -82,6 +100,31 @@ const videoFeedsValidator = [ | |||
82 | } | 100 | } |
83 | ] | 101 | ] |
84 | 102 | ||
103 | // --------------------------------------------------------------------------- | ||
104 | |||
105 | const videoFeedsPodcastValidator = [ | ||
106 | query('videoChannelId') | ||
107 | .custom(isIdValid), | ||
108 | |||
109 | async (req: express.Request, res: express.Response, next: express.NextFunction) => { | ||
110 | if (areValidationErrors(req, res)) return | ||
111 | if (!await doesVideoChannelIdExist(req.query.videoChannelId, res)) return | ||
112 | |||
113 | return next() | ||
114 | } | ||
115 | ] | ||
116 | |||
117 | const videoFeedsPodcastSetCacheKey = [ | ||
118 | (req: express.Request, res: express.Response, next: express.NextFunction) => { | ||
119 | if (req.query.videoChannelId) { | ||
120 | res.locals.apicacheGroups = [ buildPodcastGroupsCache({ channelId: req.query.videoChannelId }) ] | ||
121 | } | ||
122 | |||
123 | return next() | ||
124 | } | ||
125 | ] | ||
126 | // --------------------------------------------------------------------------- | ||
127 | |||
85 | const videoSubscriptionFeedsValidator = [ | 128 | const videoSubscriptionFeedsValidator = [ |
86 | query('accountId') | 129 | query('accountId') |
87 | .custom(isIdValid), | 130 | .custom(isIdValid), |
@@ -126,7 +169,10 @@ const videoCommentsFeedsValidator = [ | |||
126 | export { | 169 | export { |
127 | feedsFormatValidator, | 170 | feedsFormatValidator, |
128 | setFeedFormatContentType, | 171 | setFeedFormatContentType, |
172 | setFeedPodcastContentType, | ||
129 | videoFeedsValidator, | 173 | videoFeedsValidator, |
174 | videoFeedsPodcastValidator, | ||
130 | videoSubscriptionFeedsValidator, | 175 | videoSubscriptionFeedsValidator, |
176 | videoFeedsPodcastSetCacheKey, | ||
131 | videoCommentsFeedsValidator | 177 | videoCommentsFeedsValidator |
132 | } | 178 | } |