1 import * as express from 'express'
2 import { CONFIG, FEEDS } from '../initializers/constants'
3 import { asyncMiddleware, feedsValidator, setDefaultSort, videosSortValidator } from '../middlewares'
4 import { VideoModel } from '../models/video/video'
5 import * as Feed from 'pfeed'
6 import { ResultList } from '../../shared/models'
7 import { AccountModel } from '../models/account/account'
8 import { cacheRoute } from '../middlewares/cache'
9 import { VideoSortField } from '../../client/src/app/shared/video/sort-field.type'
11 const feedsRouter = express.Router()
13 feedsRouter.get('/feeds/videos.:format',
16 asyncMiddleware(feedsValidator),
17 asyncMiddleware(cacheRoute),
18 asyncMiddleware(generateFeed)
21 // ---------------------------------------------------------------------------
27 // ---------------------------------------------------------------------------
29 async function generateFeed (req: express.Request, res: express.Response, next: express.NextFunction) {
33 let resultList: ResultList<VideoModel>
34 const account: AccountModel = res.locals.account
35 const hideNSFW = CONFIG.INSTANCE.DEFAULT_NSFW_POLICY === 'do_not_list'
38 resultList = await VideoModel.listAccountVideosForApi(
42 req.query.sort as VideoSortField,
46 resultList = await VideoModel.listForApi(
49 req.query.sort as VideoSortField,
56 // Adding video items to the feed, one at a time
57 resultList.data.forEach(video => {
58 const formattedVideoFiles = video.getFormattedVideoFilesJSON()
59 const torrents = formattedVideoFiles.map(videoFile => ({
61 url: videoFile.torrentUrl,
62 size_in_bytes: videoFile.size
69 description: video.getTruncatedDescription(),
70 content: video.description,
73 name: video.VideoChannel.Account.getDisplayName(),
74 link: video.VideoChannel.Account.Actor.url
77 date: video.publishedAt,
78 language: video.language,
84 // Now the feed generation is done, let's send it!
85 return sendFeed(feed, req, res)
88 function initFeed () {
89 const webserverUrl = CONFIG.WEBSERVER.URL
92 title: CONFIG.INSTANCE.NAME,
93 description: CONFIG.INSTANCE.SHORT_DESCRIPTION,
94 // updated: TODO: somehowGetLatestUpdate, // optional, default = today
97 image: webserverUrl + '/client/assets/images/icons/icon-96x96.png',
98 favicon: webserverUrl + '/client/assets/images/favicon.png',
99 copyright: `All rights reserved, unless otherwise specified in the terms specified at ${webserverUrl}/about` +
100 ` and potential licenses granted by each content's rightholder.`,
101 generator: `ToraifÅsu`, // ^.~
103 json: `${webserverUrl}/feeds/videos.json`,
104 atom: `${webserverUrl}/feeds/videos.atom`,
105 rss: `${webserverUrl}/feeds/videos.xml`
108 name: 'Instance admin of ' + CONFIG.INSTANCE.NAME,
109 email: CONFIG.ADMIN.EMAIL,
110 link: `${webserverUrl}/about`
115 function sendFeed (feed, req: express.Request, res: express.Response) {
116 const format = req.params.format
118 if (format === 'atom' || format === 'atom1') {
119 res.set('Content-Type', 'application/atom+xml')
120 return res.send(feed.atom1()).end()
123 if (format === 'json' || format === 'json1') {
124 res.set('Content-Type', 'application/json')
125 return res.send(feed.json1()).end()
128 if (format === 'rss' || format === 'rss2') {
129 res.set('Content-Type', 'application/rss+xml')
130 return res.send(feed.rss2()).end()
133 // We're in the ambiguous '.xml' case and we look at the format query parameter
134 if (req.query.format === 'atom' || req.query.format === 'atom1') {
135 res.set('Content-Type', 'application/atom+xml')
136 return res.send(feed.atom1()).end()
139 res.set('Content-Type', 'application/rss+xml')
140 return res.send(feed.rss2()).end()