-import * as express from 'express'
-import * as Feed from 'pfeed'
+import express from 'express'
+import { extname } from 'path'
+import { Feed } from '@peertube/feed'
+import { mdToOneLinePlainText, toSafeHtml } from '@server/helpers/markdown'
+import { getServerActor } from '@server/models/application/application'
+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 { FEEDS, ROUTE_CACHE_LIFETIME, THUMBNAILS_SIZE, WEBSERVER } from '../initializers/constants'
+import { MIMETYPES, PREVIEWS_SIZE, ROUTE_CACHE_LIFETIME, WEBSERVER } from '../initializers/constants'
import {
asyncMiddleware,
commonVideosFiltersValidator,
setFeedFormatContentType,
videoCommentsFeedsValidator,
videoFeedsValidator,
- videosSortValidator
+ videosSortValidator,
+ videoSubscriptionFeedsValidator
} from '../middlewares'
-import { cacheRoute } from '../middlewares/cache'
+import { cacheRouteFactory } from '../middlewares/cache/cache'
import { VideoModel } from '../models/video/video'
import { VideoCommentModel } from '../models/video/video-comment'
const feedsRouter = express.Router()
+const cacheRoute = cacheRouteFactory({
+ headerBlacklist: [ 'Content-Type' ]
+})
+
feedsRouter.get('/feeds/video-comments.:format',
feedsFormatValidator,
setFeedFormatContentType,
- asyncMiddleware(cacheRoute({
- headerBlacklist: [
- 'Content-Type'
- ]
- })(ROUTE_CACHE_LIFETIME.FEEDS)),
+ cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS),
asyncMiddleware(videoFeedsValidator),
asyncMiddleware(videoCommentsFeedsValidator),
asyncMiddleware(generateVideoCommentsFeed)
setDefaultVideosSort,
feedsFormatValidator,
setFeedFormatContentType,
- asyncMiddleware(cacheRoute({
- headerBlacklist: [
- 'Content-Type'
- ]
- })(ROUTE_CACHE_LIFETIME.FEEDS)),
+ cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS),
commonVideosFiltersValidator,
asyncMiddleware(videoFeedsValidator),
asyncMiddleware(generateVideoFeed)
)
+feedsRouter.get('/feeds/subscriptions.:format',
+ videosSortValidator,
+ setDefaultVideosSort,
+ feedsFormatValidator,
+ setFeedFormatContentType,
+ cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS),
+ commonVideosFiltersValidator,
+ asyncMiddleware(videoSubscriptionFeedsValidator),
+ asyncMiddleware(generateVideoFeedForSubscriptions)
+)
+
// ---------------------------------------------------------------------------
export {
async function generateVideoCommentsFeed (req: express.Request, res: express.Response) {
const start = 0
-
const video = res.locals.videoAll
const account = res.locals.account
const videoChannel = res.locals.videoChannel
const comments = await VideoCommentModel.listForFeed({
start,
- count: FEEDS.COUNT,
+ count: CONFIG.FEEDS.COMMENTS.COUNT,
videoId: video ? video.id : undefined,
accountId: account ? account.id : undefined,
videoChannelId: videoChannel ? videoChannel.id : undefined
})
- let name: string
- let description: string
+ const { name, description, imageUrl } = buildFeedMetadata({ video, account, videoChannel })
- if (videoChannel) {
- name = videoChannel.getDisplayName()
- description = videoChannel.description
- } else if (account) {
- name = account.getDisplayName()
- description = account.description
- } else {
- name = video ? video.name : CONFIG.INSTANCE.NAME
- description = video ? video.description : CONFIG.INSTANCE.DESCRIPTION
- }
const feed = initFeed({
name,
description,
+ imageUrl,
resourceType: 'video-comments',
queryString: new URL(WEBSERVER.URL + req.originalUrl).search
})
// Adding video items to the feed, one at a time
for (const comment of comments) {
- const link = WEBSERVER.URL + comment.getCommentStaticPath()
+ const localLink = WEBSERVER.URL + comment.getCommentStaticPath()
let title = comment.Video.name
const author: { name: string, link: string }[] = []
feed.addItem({
title,
- id: comment.url,
- link,
- content: comment.text,
+ id: localLink,
+ link: localLink,
+ content: toSafeHtml(comment.text),
author,
date: comment.createdAt
})
async function generateVideoFeed (req: express.Request, res: express.Response) {
const start = 0
-
const account = res.locals.account
const videoChannel = res.locals.videoChannel
const nsfw = buildNSFWFilter(res, req.query.nsfw)
- let name: string
- let description: string
+ const { name, description, imageUrl } = buildFeedMetadata({ videoChannel, account })
- if (videoChannel) {
- name = videoChannel.getDisplayName()
- description = videoChannel.description
- } else if (account) {
- name = account.getDisplayName()
- description = account.description
- } else {
- name = CONFIG.INSTANCE.NAME
- description = CONFIG.INSTANCE.DESCRIPTION
+ const feed = initFeed({
+ name,
+ description,
+ imageUrl,
+ resourceType: 'videos',
+ queryString: new URL(WEBSERVER.URL + req.url).search
+ })
+
+ const options = {
+ accountId: account ? account.id : null,
+ videoChannelId: videoChannel ? videoChannel.id : null
}
+ const server = await getServerActor()
+ const { data } = await VideoModel.listForApi({
+ start,
+ count: CONFIG.FEEDS.VIDEOS.COUNT,
+ sort: req.query.sort,
+ displayOnlyForFollower: {
+ actorId: server.id,
+ orLocalVideos: true
+ },
+ nsfw,
+ isLocal: req.query.isLocal,
+ include: req.query.include | VideoInclude.FILES,
+ hasFiles: true,
+ countVideos: false,
+ ...options
+ })
+
+ addVideosToFeed(feed, data)
+
+ // 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 })
+
const feed = initFeed({
name,
description,
+ imageUrl,
resourceType: 'videos',
queryString: new URL(WEBSERVER.URL + req.url).search
})
- const resultList = await VideoModel.listForApi({
+ const { data } = await VideoModel.listForApi({
start,
- count: FEEDS.COUNT,
+ count: CONFIG.FEEDS.VIDEOS.COUNT,
sort: req.query.sort,
- includeLocalVideos: true,
nsfw,
- filter: req.query.filter,
- withFiles: true,
- accountId: account ? account.id : null,
- videoChannelId: videoChannel ? videoChannel.id : null
+
+ isLocal: req.query.isLocal,
+
+ hasFiles: true,
+ include: req.query.include | VideoInclude.FILES,
+
+ countVideos: false,
+
+ displayOnlyForFollower: {
+ actorId: res.locals.user.Account.Actor.id,
+ orLocalVideos: false
+ },
+ user: res.locals.user
})
- // Adding video items to the feed, one at a time
- resultList.data.forEach(video => {
- const formattedVideoFiles = video.getFormattedVideoFilesJSON()
+ addVideosToFeed(feed, data)
+
+ // Now the feed generation is done, let's send it!
+ return sendFeed(feed, req, res)
+}
+
+function initFeed (parameters: {
+ name: string
+ description: string
+ imageUrl: string
+ resourceType?: 'videos' | 'video-comments'
+ queryString?: string
+}) {
+ const webserverUrl = WEBSERVER.URL
+ const { name, description, resourceType, queryString, imageUrl } = parameters
+
+ return new Feed({
+ title: name,
+ description: mdToOneLinePlainText(description),
+ // updated: TODO: somehowGetLatestUpdate, // optional, default = today
+ id: webserverUrl,
+ link: webserverUrl,
+ image: imageUrl,
+ 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`
+ }
+ })
+}
+
+function addVideosToFeed (feed: Feed, videos: VideoModel[]) {
+ for (const video of videos) {
+ const formattedVideoFiles = video.getFormattedVideoFilesJSON(false)
const torrents = formattedVideoFiles.map(videoFile => ({
title: video.name,
size_in_bytes: videoFile.size
}))
- const videos = formattedVideoFiles.map(videoFile => {
+ const videoFiles = formattedVideoFiles.map(videoFile => {
const result = {
- type: 'video/mp4',
+ type: MIMETYPES.VIDEO.EXT_MIMETYPE[extname(videoFile.fileUrl)],
medium: 'video',
- height: videoFile.resolution.label.replace('p', ''),
+ height: videoFile.resolution.id,
fileSize: videoFile.size,
url: videoFile.fileUrl,
framerate: videoFile.fps,
if (video.category) {
categories.push({
value: video.category,
- label: VideoModel.getCategoryLabel(video.category)
+ label: getCategoryLabel(video.category)
})
}
+ const localLink = WEBSERVER.URL + video.getWatchStaticPath()
+
feed.addItem({
title: video.name,
- id: video.url,
- link: WEBSERVER.URL + '/videos/watch/' + video.uuid,
- description: video.getTruncatedDescription(),
- content: video.description,
+ id: localLink,
+ link: localLink,
+ description: mdToOneLinePlainText(video.getTruncatedDescription()),
+ content: toSafeHtml(video.description),
author: [
{
name: video.VideoChannel.Account.getDisplayName(),
],
date: video.publishedAt,
nsfw: video.nsfw,
- torrent: torrents,
- videos,
+ torrents,
+
+ // Enclosure
+ video: videoFiles.length !== 0
+ ? {
+ url: videoFiles[0].url,
+ length: videoFiles[0].fileSize,
+ type: videoFiles[0].type
+ }
+ : undefined,
+
+ // Media RSS
+ videos: videoFiles,
+
embed: {
- url: video.getEmbedStaticPath(),
+ url: WEBSERVER.URL + video.getEmbedStaticPath(),
allowFullscreen: true
},
player: {
- url: video.getWatchStaticPath()
+ url: WEBSERVER.URL + video.getWatchStaticPath()
},
categories,
community: {
views: video.views
}
},
- thumbnail: [
+ thumbnails: [
{
- url: WEBSERVER.URL + video.getMiniatureStaticPath(),
- height: THUMBNAILS_SIZE.height,
- width: THUMBNAILS_SIZE.width
+ url: WEBSERVER.URL + video.getPreviewStaticPath(),
+ height: PREVIEWS_SIZE.height,
+ width: PREVIEWS_SIZE.width
}
]
})
- })
-
- // Now the feed generation is done, let's send it!
- return sendFeed(feed, req, res)
-}
-
-function initFeed (parameters: {
- name: string
- description: string
- resourceType?: 'videos' | 'video-comments'
- queryString?: string
-}) {
- const webserverUrl = WEBSERVER.URL
- const { name, description, resourceType, queryString } = parameters
-
- return new Feed({
- title: name,
- description,
- // updated: TODO: somehowGetLatestUpdate, // optional, default = today
- id: webserverUrl,
- link: webserverUrl,
- image: webserverUrl + '/client/assets/images/icons/icon-96x96.png',
- 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`
- }
- })
+ }
}
-function sendFeed (feed, req: express.Request, res: express.Response) {
+function sendFeed (feed: Feed, req: express.Request, res: express.Response) {
const format = req.params.format
if (format === 'atom' || format === 'atom1') {
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 }
+}
projects / github / Chocobozzz / PeerTube.git / blobdiff