Init commit

server/core/controllers/feeds/shared/common-feed-utils.ts

@@ -0,0 +1,170 @@
+import { Feed } from '@peertube/feed'
+import { CustomTag, CustomXMLNS, Person } from '@peertube/feed/lib/typings/index.js'
+import { pick } from '@peertube/peertube-core-utils'
+import { ActorImageType } from '@peertube/peertube-models'
+import { mdToPlainText } from '@server/helpers/markdown.js'
+import { CONFIG } from '@server/initializers/config.js'
+import { WEBSERVER } from '@server/initializers/constants.js'
+import { ServerConfigManager } from '@server/lib/server-config-manager.js'
+import { getServerActor } from '@server/models/application/application.js'
+import { UserModel } from '@server/models/user/user.js'
+import { MAccountDefault, MChannelBannerAccountDefault, MUser, MVideoFullLight } from '@server/types/models/index.js'
+import express from 'express'
+
+export async function initFeed (parameters: {
+  name: string
+  description: string
+  imageUrl: string
+  isPodcast: boolean
+  nsfw?: boolean
+  guid?: string
+  link?: string
+  locked?: { isLocked: boolean, email: string }
+  author?: {
+    name: string
+    link: string
+  }
+  category?: string
+  language?: string
+  person?: Person[]
+  resourceType?: 'videos' | 'video-comments'
+  queryString?: string
+  medium?: string
+  stunServers?: string[]
+  trackers?: string[]
+  customXMLNS?: CustomXMLNS[]
+  customTags?: CustomTag[]
+}) {
+  const webserverUrl = WEBSERVER.URL
+  const { name, description, link, imageUrl, category, isPodcast, resourceType, queryString, medium, nsfw } = parameters
+
+  const feed = new Feed({
+    title: name,
+    description: mdToPlainText(description),
+
+    // updated: TODO: somehowGetLatestUpdate, // optional, default = today
+    id: link || webserverUrl,
+    link: link || webserverUrl,
+
+    image: imageUrl,
+
+    favicon: ServerConfigManager.Instance.getFavicon(await getServerActor()).fileUrl,
+
+    copyright: `All rights reserved, unless otherwise specified in the terms specified at ${webserverUrl}/about` +
+      ` and potential licenses granted by each content's rightholder.`,
+
+    generator: `PeerTube - ${webserverUrl}`,
+
+    medium: medium || 'video',
+
+    nsfw: nsfw ?? false,
+
+    feedLinks: {
+      json: `${webserverUrl}/feeds/${resourceType}.json${queryString}`,
+      atom: `${webserverUrl}/feeds/${resourceType}.atom${queryString}`,
+      rss: isPodcast
+        ? `${webserverUrl}/feeds/podcast/videos.xml${queryString}`
+        : `${webserverUrl}/feeds/${resourceType}.xml${queryString}`
+    },
+
+    ...pick(parameters, [
+      'guid',
+      'language',
+      'stunServers',
+      'trackers',
+      'customXMLNS',
+      'customTags',
+      'author',
+      'person',
+      'locked'
+    ])
+  })
+
+  if (category) {
+    feed.addCategory(category)
+  }
+
+  return feed
+}
+
+export 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()
+}
+
+export async function buildFeedMetadata (options: {
+  videoChannel?: MChannelBannerAccountDefault
+  account?: MAccountDefault
+  video?: MVideoFullLight
+}) {
+  const { video, videoChannel, account } = options
+
+  let imageUrl = ServerConfigManager.Instance.getLogoUrl(await getServerActor(), 512)
+  let ownerImageUrl: string
+  let name: string
+  let description: string
+  let email: string
+  let link: string
+  let ownerLink: string
+  let user: MUser
+
+  if (videoChannel) {
+    name = videoChannel.getDisplayName()
+    description = videoChannel.description
+    ownerLink = videoChannel.getClientUrl()
+    link = ownerLink
+
+    if (videoChannel.Actor.hasImage(ActorImageType.AVATAR)) {
+      imageUrl = WEBSERVER.URL + videoChannel.Actor.getMaxQualityImage(ActorImageType.AVATAR).getStaticPath()
+      ownerImageUrl = imageUrl
+    }
+
+    user = await UserModel.loadById(videoChannel.Account.userId)
+  } else if (account) {
+    name = account.getDisplayName()
+    description = account.description
+    ownerLink = account.getClientUrl()
+    link = ownerLink
+
+    if (account.Actor.hasImage(ActorImageType.AVATAR)) {
+      imageUrl = WEBSERVER.URL + account.Actor.getMaxQualityImage(ActorImageType.AVATAR).getStaticPath()
+      ownerImageUrl = imageUrl
+    }
+
+    user = await UserModel.loadById(account.userId)
+  } else if (video) {
+    name = video.name
+    description = video.description
+    link = video.url
+  } else {
+    name = CONFIG.INSTANCE.NAME
+    description = CONFIG.INSTANCE.DESCRIPTION
+    link = WEBSERVER.URL
+  }
+
+  // If the user is local, has a verified email address, and allows it to be publicly displayed
+  // Return it so the owner can prove ownership of their feed
+  if (user && !user.pluginAuth && user.emailVerified && user.emailPublic) {
+    email = user.email
+  }
+
+  return { name, description, imageUrl, ownerImageUrl, email, link, ownerLink }
+}

server/core/controllers/feeds/shared/index.ts

@@ -0,0 +1,2 @@
+export * from './video-feed-utils.js'
+export * from './common-feed-utils.js'

server/core/controllers/feeds/shared/video-feed-utils.ts

@@ -0,0 +1,83 @@
+import { getChannelPodcastFeed } from '@peertube/peertube-core-utils'
+import { VideoIncludeType } from '@peertube/peertube-models'
+import { mdToPlainText, toSafeHtml } from '@server/helpers/markdown.js'
+import { CONFIG } from '@server/initializers/config.js'
+import { WEBSERVER } from '@server/initializers/constants.js'
+import { Hooks } from '@server/lib/plugins/hooks.js'
+import { getServerActor } from '@server/models/application/application.js'
+import { getCategoryLabel } from '@server/models/video/formatter/index.js'
+import { DisplayOnlyForFollowerOptions } from '@server/models/video/sql/video/index.js'
+import { VideoModel } from '@server/models/video/video.js'
+import { MChannelHostOnly, MThumbnail, MUserDefault } from '@server/types/models/index.js'
+
+export async function getVideosForFeeds (options: {
+  sort: string
+  nsfw: boolean
+  isLocal: boolean
+  include: VideoIncludeType
+
+  accountId?: number
+  videoChannelId?: number
+  displayOnlyForFollower?: DisplayOnlyForFollowerOptions
+  user?: MUserDefault
+}) {
+  const server = await getServerActor()
+
+  const { data } = await Hooks.wrapPromiseFun(
+    VideoModel.listForApi.bind(VideoModel),
+    {
+    start: 0,
+    count: CONFIG.FEEDS.VIDEOS.COUNT,
+    displayOnlyForFollower: {
+      actorId: server.id,
+      orLocalVideos: true
+    },
+    hasFiles: true,
+    countVideos: false,
+
+    ...options
+  },
+    'filter:feed.videos.list.result'
+  )
+
+  return data
+}
+
+export function getCommonVideoFeedAttributes (video: VideoModel) {
+  const localLink = WEBSERVER.URL + video.getWatchStaticPath()
+
+  const thumbnailModels: MThumbnail[] = []
+  if (video.hasPreview()) thumbnailModels.push(video.getPreview())
+  if (video.hasMiniature()) thumbnailModels.push(video.getMiniature())
+
+  return {
+    title: video.name,
+    link: localLink,
+    description: mdToPlainText(video.getTruncatedDescription()),
+    content: toSafeHtml(video.description),
+
+    date: video.publishedAt,
+    nsfw: video.nsfw,
+
+    category: video.category
+      ? [ { name: getCategoryLabel(video.category) } ]
+      : undefined,
+
+    thumbnails: thumbnailModels.map(t => ({
+      url: WEBSERVER.URL + t.getLocalStaticPath(),
+      width: t.width,
+      height: t.height
+    }))
+  }
+}
+
+export function getPodcastFeedUrlCustomTag (videoChannel: MChannelHostOnly) {
+  return {
+    name: 'podcast:txt',
+    attributes: {
+      purpose: 'p20url'
+    },
+    // TODO: use remote channel podcast feed URL
+    value: getChannelPodcastFeed(WEBSERVER.URL, videoChannel)
+  }
+}