]>
Commit | Line | Data |
---|---|---|
cb0eda56 AG |
1 | import express from 'express' |
2 | import { Feed } from '@peertube/feed' | |
3 | import { CustomTag, CustomXMLNS, Person } from '@peertube/feed/lib/typings' | |
4 | import { mdToOneLinePlainText } from '@server/helpers/markdown' | |
5 | import { CONFIG } from '@server/initializers/config' | |
6 | import { WEBSERVER } from '@server/initializers/constants' | |
2c16f5ad | 7 | import { getBiggestActorImage } from '@server/lib/actor-image' |
cb0eda56 AG |
8 | import { UserModel } from '@server/models/user/user' |
9 | import { MAccountDefault, MChannelBannerAccountDefault, MUser, MVideoFullLight } from '@server/types/models' | |
10 | import { pick } from '@shared/core-utils' | |
11 | import { ActorImageType } from '@shared/models' | |
12 | ||
13 | export function initFeed (parameters: { | |
14 | name: string | |
15 | description: string | |
16 | imageUrl: string | |
17 | isPodcast: boolean | |
18 | link?: string | |
19 | locked?: { isLocked: boolean, email: string } | |
20 | author?: { | |
21 | name: string | |
22 | link: string | |
23 | imageUrl: string | |
24 | } | |
25 | person?: Person[] | |
26 | resourceType?: 'videos' | 'video-comments' | |
27 | queryString?: string | |
28 | medium?: string | |
29 | stunServers?: string[] | |
30 | trackers?: string[] | |
31 | customXMLNS?: CustomXMLNS[] | |
32 | customTags?: CustomTag[] | |
33 | }) { | |
34 | const webserverUrl = WEBSERVER.URL | |
35 | const { name, description, link, imageUrl, isPodcast, resourceType, queryString, medium } = parameters | |
36 | ||
37 | return new Feed({ | |
38 | title: name, | |
39 | description: mdToOneLinePlainText(description), | |
40 | // updated: TODO: somehowGetLatestUpdate, // optional, default = today | |
41 | id: link || webserverUrl, | |
42 | link: link || webserverUrl, | |
43 | image: imageUrl, | |
44 | favicon: webserverUrl + '/client/assets/images/favicon.png', | |
45 | copyright: `All rights reserved, unless otherwise specified in the terms specified at ${webserverUrl}/about` + | |
46 | ` and potential licenses granted by each content's rightholder.`, | |
47 | generator: `ToraifÅsu`, // ^.~ | |
48 | medium: medium || 'video', | |
49 | feedLinks: { | |
50 | json: `${webserverUrl}/feeds/${resourceType}.json${queryString}`, | |
51 | atom: `${webserverUrl}/feeds/${resourceType}.atom${queryString}`, | |
52 | rss: isPodcast | |
53 | ? `${webserverUrl}/feeds/podcast/videos.xml${queryString}` | |
54 | : `${webserverUrl}/feeds/${resourceType}.xml${queryString}` | |
55 | }, | |
56 | ||
57 | ...pick(parameters, [ 'stunServers', 'trackers', 'customXMLNS', 'customTags', 'author', 'person', 'locked' ]) | |
58 | }) | |
59 | } | |
60 | ||
61 | export function sendFeed (feed: Feed, req: express.Request, res: express.Response) { | |
62 | const format = req.params.format | |
63 | ||
64 | if (format === 'atom' || format === 'atom1') { | |
65 | return res.send(feed.atom1()).end() | |
66 | } | |
67 | ||
68 | if (format === 'json' || format === 'json1') { | |
69 | return res.send(feed.json1()).end() | |
70 | } | |
71 | ||
72 | if (format === 'rss' || format === 'rss2') { | |
73 | return res.send(feed.rss2()).end() | |
74 | } | |
75 | ||
76 | // We're in the ambiguous '.xml' case and we look at the format query parameter | |
77 | if (req.query.format === 'atom' || req.query.format === 'atom1') { | |
78 | return res.send(feed.atom1()).end() | |
79 | } | |
80 | ||
81 | return res.send(feed.rss2()).end() | |
82 | } | |
83 | ||
84 | export async function buildFeedMetadata (options: { | |
85 | videoChannel?: MChannelBannerAccountDefault | |
86 | account?: MAccountDefault | |
87 | video?: MVideoFullLight | |
88 | }) { | |
89 | const { video, videoChannel, account } = options | |
90 | ||
91 | let imageUrl = WEBSERVER.URL + '/client/assets/images/icons/icon-96x96.png' | |
92 | let accountImageUrl: string | |
93 | let name: string | |
94 | let userName: string | |
95 | let description: string | |
96 | let email: string | |
97 | let link: string | |
98 | let accountLink: string | |
99 | let user: MUser | |
100 | ||
101 | if (videoChannel) { | |
102 | name = videoChannel.getDisplayName() | |
103 | description = videoChannel.description | |
104 | link = videoChannel.getClientUrl() | |
105 | accountLink = videoChannel.Account.getClientUrl() | |
106 | ||
107 | if (videoChannel.Actor.hasImage(ActorImageType.AVATAR)) { | |
2c16f5ad | 108 | const videoChannelAvatar = getBiggestActorImage(videoChannel.Actor.Avatars) |
1ed1994f | 109 | imageUrl = WEBSERVER.URL + videoChannelAvatar.getStaticPath() |
cb0eda56 AG |
110 | } |
111 | ||
112 | if (videoChannel.Account.Actor.hasImage(ActorImageType.AVATAR)) { | |
2c16f5ad | 113 | const accountAvatar = getBiggestActorImage(videoChannel.Account.Actor.Avatars) |
1ed1994f | 114 | accountImageUrl = WEBSERVER.URL + accountAvatar.getStaticPath() |
cb0eda56 AG |
115 | } |
116 | ||
117 | user = await UserModel.loadById(videoChannel.Account.userId) | |
118 | userName = videoChannel.Account.getDisplayName() | |
119 | } else if (account) { | |
120 | name = account.getDisplayName() | |
121 | description = account.description | |
122 | link = account.getClientUrl() | |
123 | accountLink = link | |
124 | ||
125 | if (account.Actor.hasImage(ActorImageType.AVATAR)) { | |
2c16f5ad | 126 | const accountAvatar = getBiggestActorImage(account.Actor.Avatars) |
1ed1994f | 127 | imageUrl = WEBSERVER.URL + accountAvatar?.getStaticPath() |
cb0eda56 AG |
128 | accountImageUrl = imageUrl |
129 | } | |
130 | ||
131 | user = await UserModel.loadById(account.userId) | |
132 | } else if (video) { | |
133 | name = video.name | |
134 | description = video.description | |
135 | link = video.url | |
136 | } else { | |
137 | name = CONFIG.INSTANCE.NAME | |
138 | description = CONFIG.INSTANCE.DESCRIPTION | |
139 | link = WEBSERVER.URL | |
140 | } | |
141 | ||
142 | // If the user is local, has a verified email address, and allows it to be publicly displayed | |
143 | // Return it so the owner can prove ownership of their feed | |
144 | if (user && !user.pluginAuth && user.emailVerified && user.emailPublic) { | |
145 | email = user.email | |
146 | } | |
147 | ||
148 | return { name, userName, description, imageUrl, accountImageUrl, email, link, accountLink } | |
149 | } |