1 import * as express from 'express'
2 import { FEEDS, ROUTE_CACHE_LIFETIME, THUMBNAILS_SIZE, WEBSERVER } from '../initializers/constants'
5 commonVideosFiltersValidator,
7 videoCommentsFeedsValidator,
10 } from '../middlewares'
11 import { VideoModel } from '../models/video/video'
12 import * as Feed from 'pfeed'
13 import { cacheRoute } from '../middlewares/cache'
14 import { VideoCommentModel } from '../models/video/video-comment'
15 import { buildNSFWFilter } from '../helpers/express-utils'
16 import { CONFIG } from '../initializers/config'
18 const feedsRouter = express.Router()
20 feedsRouter.get('/feeds/video-comments.:format',
21 asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS)),
22 asyncMiddleware(videoCommentsFeedsValidator),
23 asyncMiddleware(generateVideoCommentsFeed)
26 feedsRouter.get('/feeds/videos.:format',
29 asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS)),
30 commonVideosFiltersValidator,
31 asyncMiddleware(videoFeedsValidator),
32 asyncMiddleware(generateVideoFeed)
35 // ---------------------------------------------------------------------------
41 // ---------------------------------------------------------------------------
43 async function generateVideoCommentsFeed (req: express.Request, res: express.Response) {
46 const video = res.locals.videoAll
47 const videoId: number = video ? video.id : undefined
49 const comments = await VideoCommentModel.listForFeed(start, FEEDS.COUNT, videoId)
51 const name = video ? video.name : CONFIG.INSTANCE.NAME
52 const description = video ? video.description : CONFIG.INSTANCE.DESCRIPTION
53 const feed = initFeed(name, description)
55 // Adding video items to the feed, one at a time
56 comments.forEach(comment => {
57 const link = WEBSERVER.URL + comment.getCommentStaticPath()
59 let title = comment.Video.name
60 const author: { name: string, link: string }[] = []
62 if (comment.Account) {
63 title += ` - ${comment.Account.getDisplayName()}`
65 name: comment.Account.getDisplayName(),
66 link: comment.Account.Actor.url
74 content: comment.text,
76 date: comment.createdAt
80 // Now the feed generation is done, let's send it!
81 return sendFeed(feed, req, res)
84 async function generateVideoFeed (req: express.Request, res: express.Response) {
87 const account = res.locals.account
88 const videoChannel = res.locals.videoChannel
89 const nsfw = buildNSFWFilter(res, req.query.nsfw)
92 let description: string
95 name = videoChannel.getDisplayName()
96 description = videoChannel.description
98 name = account.getDisplayName()
99 description = account.description
101 name = CONFIG.INSTANCE.NAME
102 description = CONFIG.INSTANCE.DESCRIPTION
105 const feed = initFeed(name, description)
107 const resultList = await VideoModel.listForApi({
110 sort: req.query.sort,
111 includeLocalVideos: true,
113 filter: req.query.filter,
115 accountId: account ? account.id : null,
116 videoChannelId: videoChannel ? videoChannel.id : null
119 // Adding video items to the feed, one at a time
120 resultList.data.forEach(video => {
121 const formattedVideoFiles = video.getFormattedVideoFilesJSON()
123 const torrents = formattedVideoFiles.map(videoFile => ({
125 url: videoFile.torrentUrl,
126 size_in_bytes: videoFile.size
129 const videos = formattedVideoFiles.map(videoFile => {
133 height: videoFile.resolution.label.replace('p', ''),
134 fileSize: videoFile.size,
135 url: videoFile.fileUrl,
136 framerate: videoFile.fps,
137 duration: video.duration
140 if (video.language) Object.assign(result, { lang: video.language })
145 const categories: { value: number, label: string }[] = []
146 if (video.category) {
148 value: video.category,
149 label: VideoModel.getCategoryLabel(video.category)
156 link: WEBSERVER.URL + '/videos/watch/' + video.uuid,
157 description: video.getTruncatedDescription(),
158 content: video.description,
161 name: video.VideoChannel.Account.getDisplayName(),
162 link: video.VideoChannel.Account.Actor.url
165 date: video.publishedAt,
170 url: video.getEmbedStaticPath(),
171 allowFullscreen: true
174 url: video.getWatchStaticPath()
184 url: WEBSERVER.URL + video.getMiniatureStaticPath(),
185 height: THUMBNAILS_SIZE.height,
186 width: THUMBNAILS_SIZE.width
192 // Now the feed generation is done, let's send it!
193 return sendFeed(feed, req, res)
196 function initFeed (name: string, description: string) {
197 const webserverUrl = WEBSERVER.URL
202 // updated: TODO: somehowGetLatestUpdate, // optional, default = today
205 image: webserverUrl + '/client/assets/images/icons/icon-96x96.png',
206 favicon: webserverUrl + '/client/assets/images/favicon.png',
207 copyright: `All rights reserved, unless otherwise specified in the terms specified at ${webserverUrl}/about` +
208 ` and potential licenses granted by each content's rightholder.`,
209 generator: `ToraifÅsu`, // ^.~
211 json: `${webserverUrl}/feeds/videos.json`,
212 atom: `${webserverUrl}/feeds/videos.atom`,
213 rss: `${webserverUrl}/feeds/videos.xml`
216 name: 'Instance admin of ' + CONFIG.INSTANCE.NAME,
217 email: CONFIG.ADMIN.EMAIL,
218 link: `${webserverUrl}/about`
223 function sendFeed (feed, req: express.Request, res: express.Response) {
224 const format = req.params.format
226 if (format === 'atom' || format === 'atom1') {
227 res.set('Content-Type', 'application/atom+xml')
228 return res.send(feed.atom1()).end()
231 if (format === 'json' || format === 'json1') {
232 res.set('Content-Type', 'application/json')
233 return res.send(feed.json1()).end()
236 if (format === 'rss' || format === 'rss2') {
237 res.set('Content-Type', 'application/rss+xml')
238 return res.send(feed.rss2()).end()
241 // We're in the ambiguous '.xml' case and we look at the format query parameter
242 if (req.query.format === 'atom' || req.query.format === 'atom1') {
243 res.set('Content-Type', 'application/atom+xml')
244 return res.send(feed.atom1()).end()
247 res.set('Content-Type', 'application/rss+xml')
248 return res.send(feed.rss2()).end()