PeerTube/server/controllers/feeds.ts

390 lines
11 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
2022-02-04 18:00:51 +01:00
import { extname } from 'path'
import { Feed } from '@peertube/feed'
2022-02-04 10:31:54 +01:00
import { mdToOneLinePlainText, toSafeHtml } from '@server/helpers/markdown'
import { getServerActor } from '@server/models/application/application'
2021-06-11 14:36:07 +02:00
import { getCategoryLabel } from '@server/models/video/formatter/video-format-utils'
import { MAccountDefault, MChannelBannerAccountDefault, MVideoFullLight } from '@server/types/models'
import { ActorImageType, VideoInclude } from '@shared/models'
import { buildNSFWFilter } from '../helpers/express-utils'
import { CONFIG } from '../initializers/config'
import { MIMETYPES, PREVIEWS_SIZE, ROUTE_CACHE_LIFETIME, WEBSERVER } from '../initializers/constants'
import {
asyncMiddleware,
commonVideosFiltersValidator,
feedsFormatValidator,
setDefaultVideosSort,
setFeedFormatContentType,
videoCommentsFeedsValidator,
videoFeedsValidator,
videosSortValidator,
2020-11-25 11:04:18 +01:00
videoSubscriptionFeedsValidator
} from '../middlewares'
import { cacheRouteFactory } from '../middlewares/cache/cache'
import { VideoModel } from '../models/video/video'
2018-06-08 20:34:37 +02:00
import { VideoCommentModel } from '../models/video/video-comment'
const feedsRouter = express.Router()
const cacheRoute = cacheRouteFactory({
headerBlacklist: [ 'Content-Type' ]
})
2018-06-08 20:34:37 +02:00
feedsRouter.get('/feeds/video-comments.:format',
feedsFormatValidator,
setFeedFormatContentType,
cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS),
asyncMiddleware(videoFeedsValidator),
2018-06-08 20:34:37 +02:00
asyncMiddleware(videoCommentsFeedsValidator),
asyncMiddleware(generateVideoCommentsFeed)
)
feedsRouter.get('/feeds/videos.:format',
2018-04-17 10:56:27 +02:00
videosSortValidator,
setDefaultVideosSort,
feedsFormatValidator,
setFeedFormatContentType,
cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS),
commonVideosFiltersValidator,
2018-06-08 20:34:37 +02:00
asyncMiddleware(videoFeedsValidator),
asyncMiddleware(generateVideoFeed)
)
2020-11-09 16:25:27 +01:00
feedsRouter.get('/feeds/subscriptions.:format',
videosSortValidator,
setDefaultVideosSort,
feedsFormatValidator,
setFeedFormatContentType,
cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS),
2020-11-09 16:25:27 +01:00
commonVideosFiltersValidator,
2020-11-25 11:04:18 +01:00
asyncMiddleware(videoSubscriptionFeedsValidator),
2020-11-09 16:25:27 +01:00
asyncMiddleware(generateVideoFeedForSubscriptions)
)
// ---------------------------------------------------------------------------
export {
feedsRouter
}
// ---------------------------------------------------------------------------
2019-03-19 10:35:15 +01:00
async function generateVideoCommentsFeed (req: express.Request, res: express.Response) {
2018-06-08 20:34:37 +02:00
const start = 0
2019-08-15 11:53:26 +02:00
const video = res.locals.videoAll
const account = res.locals.account
const videoChannel = res.locals.videoChannel
2018-06-08 20:34:37 +02:00
const comments = await VideoCommentModel.listForFeed({
start,
count: CONFIG.FEEDS.COMMENTS.COUNT,
videoId: video ? video.id : undefined,
accountId: account ? account.id : undefined,
videoChannelId: videoChannel ? videoChannel.id : undefined
})
2018-06-08 20:34:37 +02:00
const { name, description, imageUrl } = buildFeedMetadata({ video, account, videoChannel })
const feed = initFeed({
name,
description,
imageUrl,
resourceType: 'video-comments',
queryString: new URL(WEBSERVER.URL + req.originalUrl).search
})
2018-06-08 20:34:37 +02:00
// Adding video items to the feed, one at a time
for (const comment of comments) {
2022-02-22 11:14:34 +01:00
const localLink = WEBSERVER.URL + comment.getCommentStaticPath()
2018-06-14 11:25:19 +02:00
2019-12-10 08:45:52 +01:00
let title = comment.Video.name
2019-12-11 18:06:41 +01:00
const author: { name: string, link: string }[] = []
if (comment.Account) {
title += ` - ${comment.Account.getDisplayName()}`
author.push({
name: comment.Account.getDisplayName(),
link: comment.Account.Actor.url
})
}
2019-12-10 08:45:52 +01:00
2018-06-08 20:34:37 +02:00
feed.addItem({
2019-12-10 08:45:52 +01:00
title,
2022-02-22 11:14:34 +01:00
id: localLink,
link: localLink,
content: toSafeHtml(comment.text),
2019-12-11 18:06:41 +01:00
author,
2018-06-08 20:34:37 +02:00
date: comment.createdAt
})
}
2018-06-08 20:34:37 +02:00
// Now the feed generation is done, let's send it!
return sendFeed(feed, req, res)
}
2019-03-19 10:35:15 +01:00
async function generateVideoFeed (req: express.Request, res: express.Response) {
2018-04-17 14:01:06 +02:00
const start = 0
2019-03-19 10:35:15 +01:00
const account = res.locals.account
const videoChannel = res.locals.videoChannel
2018-07-20 14:35:18 +02:00
const nsfw = buildNSFWFilter(res, req.query.nsfw)
const { name, description, imageUrl } = buildFeedMetadata({ videoChannel, account })
const feed = initFeed({
name,
description,
imageUrl,
resourceType: 'videos',
queryString: new URL(WEBSERVER.URL + req.url).search
})
2020-11-09 16:25:27 +01:00
const options = {
accountId: account ? account.id : null,
videoChannelId: videoChannel ? videoChannel.id : null
}
const server = await getServerActor()
2021-05-10 10:52:52 +02:00
const { data } = await VideoModel.listForApi({
2018-04-24 15:10:54 +02:00
start,
count: CONFIG.FEEDS.VIDEOS.COUNT,
2018-04-24 17:05:32 +02:00
sort: req.query.sort,
displayOnlyForFollower: {
actorId: server.id,
orLocalVideos: true
},
2018-07-20 14:35:18 +02:00
nsfw,
isLocal: req.query.isLocal,
include: req.query.include | VideoInclude.FILES,
hasFiles: true,
2021-05-10 10:52:52 +02:00
countVideos: false,
...options
2018-04-24 17:05:32 +02:00
})
2021-05-10 10:52:52 +02:00
addVideosToFeed(feed, data)
2020-11-09 16:25:27 +01:00
// Now the feed generation is done, let's send it!
return sendFeed(feed, req, res)
}
async function generateVideoFeedForSubscriptions (req: express.Request, res: express.Response) {
const start = 0
const account = res.locals.account
const nsfw = buildNSFWFilter(res, req.query.nsfw)
const { name, description, imageUrl } = buildFeedMetadata({ account })
2020-11-09 16:25:27 +01:00
const feed = initFeed({
name,
description,
imageUrl,
2020-11-09 16:25:27 +01:00
resourceType: 'videos',
queryString: new URL(WEBSERVER.URL + req.url).search
})
2021-05-10 10:52:52 +02:00
const { data } = await VideoModel.listForApi({
2020-11-09 16:25:27 +01:00
start,
count: CONFIG.FEEDS.VIDEOS.COUNT,
2020-11-09 16:25:27 +01:00
sort: req.query.sort,
nsfw,
isLocal: req.query.isLocal,
2021-05-10 10:52:52 +02:00
hasFiles: true,
include: req.query.include | VideoInclude.FILES,
2021-05-10 10:52:52 +02:00
countVideos: false,
2020-11-25 11:04:18 +01:00
displayOnlyForFollower: {
actorId: res.locals.user.Account.Actor.id,
orLocalVideos: false
},
2020-11-25 11:04:18 +01:00
user: res.locals.user
2020-11-09 16:25:27 +01:00
})
2021-05-10 10:52:52 +02:00
addVideosToFeed(feed, data)
2020-11-09 16:25:27 +01:00
// Now the feed generation is done, let's send it!
return sendFeed(feed, req, res)
}
function initFeed (parameters: {
name: string
description: string
imageUrl: string
2020-11-09 16:25:27 +01:00
resourceType?: 'videos' | 'video-comments'
queryString?: string
}) {
const webserverUrl = WEBSERVER.URL
const { name, description, resourceType, queryString, imageUrl } = parameters
2020-11-09 16:25:27 +01:00
return new Feed({
title: name,
2022-02-04 10:31:54 +01:00
description: mdToOneLinePlainText(description),
2020-11-09 16:25:27 +01:00
// updated: TODO: somehowGetLatestUpdate, // optional, default = today
id: webserverUrl,
link: webserverUrl,
image: imageUrl,
2020-11-09 16:25:27 +01:00
favicon: webserverUrl + '/client/assets/images/favicon.png',
copyright: `All rights reserved, unless otherwise specified in the terms specified at ${webserverUrl}/about` +
` and potential licenses granted by each content's rightholder.`,
generator: `Toraifōsu`, // ^.~
feedLinks: {
json: `${webserverUrl}/feeds/${resourceType}.json${queryString}`,
atom: `${webserverUrl}/feeds/${resourceType}.atom${queryString}`,
rss: `${webserverUrl}/feeds/${resourceType}.xml${queryString}`
},
author: {
name: 'Instance admin of ' + CONFIG.INSTANCE.NAME,
email: CONFIG.ADMIN.EMAIL,
link: `${webserverUrl}/about`
}
})
}
2022-02-04 18:00:51 +01:00
function addVideosToFeed (feed: Feed, videos: VideoModel[]) {
2020-11-09 16:25:27 +01:00
for (const video of videos) {
2021-02-18 11:22:35 +01:00
const formattedVideoFiles = video.getFormattedVideoFilesJSON(false)
2019-12-09 09:40:16 +01:00
const torrents = formattedVideoFiles.map(videoFile => ({
title: video.name,
url: videoFile.torrentUrl,
size_in_bytes: videoFile.size
}))
2019-12-09 09:40:16 +01:00
2022-02-22 11:14:34 +01:00
const videoFiles = formattedVideoFiles.map(videoFile => {
2019-12-09 09:40:16 +01:00
const result = {
2022-02-04 18:00:51 +01:00
type: MIMETYPES.VIDEO.EXT_MIMETYPE[extname(videoFile.fileUrl)],
2019-12-09 09:40:16 +01:00
medium: 'video',
2022-02-04 18:00:51 +01:00
height: videoFile.resolution.id,
2019-12-09 09:40:16 +01:00
fileSize: videoFile.size,
url: videoFile.fileUrl,
framerate: videoFile.fps,
duration: video.duration
}
if (video.language) Object.assign(result, { lang: video.language })
return result
})
const categories: { value: number, label: string }[] = []
if (video.category) {
categories.push({
value: video.category,
2021-06-11 14:36:07 +02:00
label: getCategoryLabel(video.category)
2019-12-09 09:40:16 +01:00
})
}
2022-02-22 11:14:34 +01:00
const localLink = WEBSERVER.URL + video.getWatchStaticPath()
feed.addItem({
title: video.name,
2022-02-22 11:14:34 +01:00
id: localLink,
link: localLink,
2022-02-04 10:31:54 +01:00
description: mdToOneLinePlainText(video.getTruncatedDescription()),
content: toSafeHtml(video.description),
author: [
{
name: video.VideoChannel.Account.getDisplayName(),
link: video.VideoChannel.Account.Actor.url
}
],
date: video.publishedAt,
nsfw: video.nsfw,
2022-02-04 18:00:51 +01:00
torrents,
// Enclosure
2022-06-27 10:36:16 +02:00
video: videoFiles.length !== 0
? {
url: videoFiles[0].url,
length: videoFiles[0].fileSize,
type: videoFiles[0].type
}
: undefined,
2022-02-04 18:00:51 +01:00
// Media RSS
2022-02-22 11:14:34 +01:00
videos: videoFiles,
2022-02-04 18:00:51 +01:00
embed: {
2022-02-22 11:14:34 +01:00
url: WEBSERVER.URL + video.getEmbedStaticPath(),
allowFullscreen: true
},
player: {
2022-02-22 11:14:34 +01:00
url: WEBSERVER.URL + video.getWatchStaticPath()
},
2019-12-09 09:40:16 +01:00
categories,
community: {
statistics: {
views: video.views
}
},
2022-02-04 18:00:51 +01:00
thumbnails: [
{
2021-03-09 15:08:45 +01:00
url: WEBSERVER.URL + video.getPreviewStaticPath(),
height: PREVIEWS_SIZE.height,
width: PREVIEWS_SIZE.width
}
]
})
2020-11-09 16:25:27 +01:00
}
}
2022-02-04 18:00:51 +01:00
function sendFeed (feed: Feed, req: express.Request, res: express.Response) {
const format = req.params.format
if (format === 'atom' || format === 'atom1') {
return res.send(feed.atom1()).end()
}
if (format === 'json' || format === 'json1') {
return res.send(feed.json1()).end()
}
if (format === 'rss' || format === 'rss2') {
return res.send(feed.rss2()).end()
}
// We're in the ambiguous '.xml' case and we look at the format query parameter
if (req.query.format === 'atom' || req.query.format === 'atom1') {
return res.send(feed.atom1()).end()
}
return res.send(feed.rss2()).end()
}
function buildFeedMetadata (options: {
videoChannel?: MChannelBannerAccountDefault
account?: MAccountDefault
video?: MVideoFullLight
}) {
const { video, videoChannel, account } = options
let imageUrl = WEBSERVER.URL + '/client/assets/images/icons/icon-96x96.png'
let name: string
let description: string
if (videoChannel) {
name = videoChannel.getDisplayName()
description = videoChannel.description
if (videoChannel.Actor.hasImage(ActorImageType.AVATAR)) {
imageUrl = WEBSERVER.URL + videoChannel.Actor.Avatars[0].getStaticPath()
}
} else if (account) {
name = account.getDisplayName()
description = account.description
if (account.Actor.hasImage(ActorImageType.AVATAR)) {
imageUrl = WEBSERVER.URL + account.Actor.Avatars[0].getStaticPath()
}
} else if (video) {
name = video.name
description = video.description
} else {
name = CONFIG.INSTANCE.NAME
description = CONFIG.INSTANCE.DESCRIPTION
}
return { name, description, imageUrl }
}