(feed) adding thumbnail support for RSS feed

[github/Chocobozzz/PeerTube.git] / server / controllers / feeds.ts

diff --git a/server/controllers/feeds.ts b/server/controllers/feeds.ts
index 08f179509e1747bcfb83207e2fa3f0a515747799..1773fc71e2a38eed02a72d5d2fc4314e8819eb36 100644 (file)
--- a/server/controllers/feeds.ts
+++ b/server/controllers/feeds.ts
@@ -1,20 +1,28 @@
 import * as express from 'express'
-import { CONFIG, FEEDS } from '../initializers/constants'
-import { asyncMiddleware, feedsValidator, setDefaultSort, videosSortValidator } from '../middlewares'
+import { CONFIG, FEEDS, ROUTE_CACHE_LIFETIME } from '../initializers/constants'
+import { THUMBNAILS_SIZE } from '../initializers'
+import { asyncMiddleware, setDefaultSort, videoCommentsFeedsValidator, videoFeedsValidator, videosSortValidator } from '../middlewares'
 import { VideoModel } from '../models/video/video'
 import * as Feed from 'pfeed'
 import { AccountModel } from '../models/account/account'
 import { cacheRoute } from '../middlewares/cache'
 import { VideoChannelModel } from '../models/video/video-channel'
+import { VideoCommentModel } from '../models/video/video-comment'
 
 const feedsRouter = express.Router()
 
+feedsRouter.get('/feeds/video-comments.:format',
+  asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS)),
+  asyncMiddleware(videoCommentsFeedsValidator),
+  asyncMiddleware(generateVideoCommentsFeed)
+)
+
 feedsRouter.get('/feeds/videos.:format',
   videosSortValidator,
   setDefaultSort,
-  asyncMiddleware(feedsValidator),
-  asyncMiddleware(cacheRoute),
-  asyncMiddleware(generateFeed)
+  asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.FEEDS)),
+  asyncMiddleware(videoFeedsValidator),
+  asyncMiddleware(generateVideoFeed)
 )
 
 // ---------------------------------------------------------------------------
@@ -25,14 +33,64 @@ export {
 
 // ---------------------------------------------------------------------------
 
-async function generateFeed (req: express.Request, res: express.Response, next: express.NextFunction) {
-  let feed = initFeed()
+async function generateVideoCommentsFeed (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const start = 0
+
+  const video = res.locals.video as VideoModel
+  const videoId: number = video ? video.id : undefined
+
+  const comments = await VideoCommentModel.listForFeed(start, FEEDS.COUNT, videoId)
+
+  const name = video ? video.name : CONFIG.INSTANCE.NAME
+  const description = video ? video.description : CONFIG.INSTANCE.DESCRIPTION
+  const feed = initFeed(name, description)
+
+  // Adding video items to the feed, one at a time
+  comments.forEach(comment => {
+    const link = CONFIG.WEBSERVER.URL + '/videos/watch/' + comment.Video.uuid + ';threadId=' + comment.getThreadId()
+
+    feed.addItem({
+      title: `${comment.Video.name} - ${comment.Account.getDisplayName()}`,
+      id: comment.url,
+      link,
+      content: comment.text,
+      author: [
+        {
+          name: comment.Account.getDisplayName(),
+          link: comment.Account.Actor.url
+        }
+      ],
+      date: comment.createdAt
+    })
+  })
+
+  // Now the feed generation is done, let's send it!
+  return sendFeed(feed, req, res)
+}
+
+async function generateVideoFeed (req: express.Request, res: express.Response, next: express.NextFunction) {
   const start = 0
 
   const account: AccountModel = res.locals.account
   const videoChannel: VideoChannelModel = res.locals.videoChannel
   const hideNSFW = CONFIG.INSTANCE.DEFAULT_NSFW_POLICY === 'do_not_list'
 
+  let name: string
+  let description: string
+
+  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)
+
   const resultList = await VideoModel.listForApi({
     start,
     count: FEEDS.COUNT,
@@ -56,7 +114,7 @@ async function generateFeed (req: express.Request, res: express.Response, next:
     feed.addItem({
       title: video.name,
       id: video.url,
-      link: video.url,
+      link: CONFIG.WEBSERVER.URL + '/videos/watch/' + video.uuid,
       description: video.getTruncatedDescription(),
       content: video.description,
       author: [
@@ -68,7 +126,14 @@ async function generateFeed (req: express.Request, res: express.Response, next:
       date: video.publishedAt,
       language: video.language,
       nsfw: video.nsfw,
-      torrent: torrents
+      torrent: torrents,
+      thumbnail: [
+        {
+          url: CONFIG.WEBSERVER.URL + video.getThumbnailPath(),
+          height: THUMBNAILS_SIZE.height,
+          width: THUMBNAILS_SIZE.width
+        }
+      ]
     })
   })
 
@@ -76,12 +141,12 @@ async function generateFeed (req: express.Request, res: express.Response, next:
   return sendFeed(feed, req, res)
 }
 
-function initFeed () {
+function initFeed (name: string, description: string) {
   const webserverUrl = CONFIG.WEBSERVER.URL
 
   return new Feed({
-    title: CONFIG.INSTANCE.NAME,
-    description: CONFIG.INSTANCE.SHORT_DESCRIPTION,
+    title: name,
+    description,
     // updated: TODO: somehowGetLatestUpdate, // optional, default = today
     id: webserverUrl,
     link: webserverUrl,