]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - server/controllers/static.ts
Merge branch 'release/3.3.0' into develop
[github/Chocobozzz/PeerTube.git] / server / controllers / static.ts
1 import * as cors from 'cors'
2 import * as express from 'express'
3 import { join } from 'path'
4 import { serveIndexHTML } from '@server/lib/client-html'
5 import { ServerConfigManager } from '@server/lib/server-config-manager'
6 import { HttpStatusCode } from '@shared/models'
7 import { HttpNodeinfoDiasporaSoftwareNsSchema20 } from '../../shared/models/nodeinfo/nodeinfo.model'
8 import { root } from '../helpers/core-utils'
9 import { CONFIG, isEmailEnabled } from '../initializers/config'
10 import {
11 CONSTRAINTS_FIELDS,
12 DEFAULT_THEME_NAME,
13 HLS_STREAMING_PLAYLIST_DIRECTORY,
14 PEERTUBE_VERSION,
15 ROUTE_CACHE_LIFETIME,
16 STATIC_MAX_AGE,
17 STATIC_PATHS,
18 WEBSERVER
19 } from '../initializers/constants'
20 import { getThemeOrDefault } from '../lib/plugins/theme-utils'
21 import { asyncMiddleware } from '../middlewares'
22 import { cacheRoute } from '../middlewares/cache/cache'
23 import { UserModel } from '../models/user/user'
24 import { VideoModel } from '../models/video/video'
25 import { VideoCommentModel } from '../models/video/video-comment'
26
27 const staticRouter = express.Router()
28
29 staticRouter.use(cors())
30
31 /*
32 Cors is very important to let other servers access torrent and video files
33 */
34
35 // FIXME: deprecated in 3.2, use lazy-statics instead
36 // Due to historical reasons, we can't really remove this controller
37 const torrentsPhysicalPath = CONFIG.STORAGE.TORRENTS_DIR
38 staticRouter.use(
39 STATIC_PATHS.TORRENTS,
40 express.static(torrentsPhysicalPath, { maxAge: 0 }) // Don't cache because we could regenerate the torrent file
41 )
42
43 // Videos path for webseed
44 staticRouter.use(
45 STATIC_PATHS.WEBSEED,
46 express.static(CONFIG.STORAGE.VIDEOS_DIR, { fallthrough: false }) // 404 because we don't have this video
47 )
48 staticRouter.use(
49 STATIC_PATHS.REDUNDANCY,
50 express.static(CONFIG.STORAGE.REDUNDANCY_DIR, { fallthrough: false }) // 404 because we don't have this video
51 )
52
53 // HLS
54 staticRouter.use(
55 STATIC_PATHS.STREAMING_PLAYLISTS.HLS,
56 cors(),
57 express.static(HLS_STREAMING_PLAYLIST_DIRECTORY, { fallthrough: false }) // 404 if the file does not exist
58 )
59
60 // Thumbnails path for express
61 const thumbnailsPhysicalPath = CONFIG.STORAGE.THUMBNAILS_DIR
62 staticRouter.use(
63 STATIC_PATHS.THUMBNAILS,
64 express.static(thumbnailsPhysicalPath, { maxAge: STATIC_MAX_AGE.SERVER, fallthrough: false }) // 404 if the file does not exist
65 )
66
67 // robots.txt service
68 staticRouter.get('/robots.txt',
69 cacheRoute(ROUTE_CACHE_LIFETIME.ROBOTS),
70 (_, res: express.Response) => {
71 res.type('text/plain')
72 return res.send(CONFIG.INSTANCE.ROBOTS)
73 }
74 )
75
76 staticRouter.all('/teapot',
77 getCup,
78 asyncMiddleware(serveIndexHTML)
79 )
80
81 // security.txt service
82 staticRouter.get('/security.txt',
83 (_, res: express.Response) => {
84 return res.redirect(HttpStatusCode.MOVED_PERMANENTLY_301, '/.well-known/security.txt')
85 }
86 )
87
88 staticRouter.get('/.well-known/security.txt',
89 cacheRoute(ROUTE_CACHE_LIFETIME.SECURITYTXT),
90 (_, res: express.Response) => {
91 res.type('text/plain')
92 return res.send(CONFIG.INSTANCE.SECURITYTXT + CONFIG.INSTANCE.SECURITYTXT_CONTACT)
93 }
94 )
95
96 // nodeinfo service
97 staticRouter.use('/.well-known/nodeinfo',
98 cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
99 (_, res: express.Response) => {
100 return res.json({
101 links: [
102 {
103 rel: 'http://nodeinfo.diaspora.software/ns/schema/2.0',
104 href: WEBSERVER.URL + '/nodeinfo/2.0.json'
105 }
106 ]
107 })
108 }
109 )
110 staticRouter.use('/nodeinfo/:version.json',
111 cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
112 asyncMiddleware(generateNodeinfo)
113 )
114
115 // dnt-policy.txt service (see https://www.eff.org/dnt-policy)
116 staticRouter.use('/.well-known/dnt-policy.txt',
117 cacheRoute(ROUTE_CACHE_LIFETIME.DNT_POLICY),
118 (_, res: express.Response) => {
119 res.type('text/plain')
120
121 return res.sendFile(join(root(), 'dist/server/static/dnt-policy/dnt-policy-1.0.txt'))
122 }
123 )
124
125 // dnt service (see https://www.w3.org/TR/tracking-dnt/#status-resource)
126 staticRouter.use('/.well-known/dnt/',
127 (_, res: express.Response) => {
128 res.json({ tracking: 'N' })
129 }
130 )
131
132 staticRouter.use('/.well-known/change-password',
133 (_, res: express.Response) => {
134 res.redirect('/my-account/settings')
135 }
136 )
137
138 staticRouter.use('/.well-known/host-meta',
139 (_, res: express.Response) => {
140 res.type('application/xml')
141
142 const xml = '<?xml version="1.0" encoding="UTF-8"?>\n' +
143 '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">\n' +
144 ` <Link rel="lrdd" type="application/xrd+xml" template="${WEBSERVER.URL}/.well-known/webfinger?resource={uri}"/>\n` +
145 '</XRD>'
146
147 res.send(xml).end()
148 }
149 )
150
151 // ---------------------------------------------------------------------------
152
153 export {
154 staticRouter
155 }
156
157 // ---------------------------------------------------------------------------
158
159 async function generateNodeinfo (req: express.Request, res: express.Response) {
160 const { totalVideos } = await VideoModel.getStats()
161 const { totalLocalVideoComments } = await VideoCommentModel.getStats()
162 const { totalUsers, totalMonthlyActiveUsers, totalHalfYearActiveUsers } = await UserModel.getStats()
163
164 if (!req.params.version || req.params.version !== '2.0') {
165 return res.fail({
166 status: HttpStatusCode.NOT_FOUND_404,
167 message: 'Nodeinfo schema version not handled'
168 })
169 }
170
171 const json = {
172 version: '2.0',
173 software: {
174 name: 'peertube',
175 version: PEERTUBE_VERSION
176 },
177 protocols: [
178 'activitypub'
179 ],
180 services: {
181 inbound: [],
182 outbound: [
183 'atom1.0',
184 'rss2.0'
185 ]
186 },
187 openRegistrations: CONFIG.SIGNUP.ENABLED,
188 usage: {
189 users: {
190 total: totalUsers,
191 activeMonth: totalMonthlyActiveUsers,
192 activeHalfyear: totalHalfYearActiveUsers
193 },
194 localPosts: totalVideos,
195 localComments: totalLocalVideoComments
196 },
197 metadata: {
198 taxonomy: {
199 postsName: 'Videos'
200 },
201 nodeName: CONFIG.INSTANCE.NAME,
202 nodeDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
203 nodeConfig: {
204 search: {
205 remoteUri: {
206 users: CONFIG.SEARCH.REMOTE_URI.USERS,
207 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
208 }
209 },
210 plugin: {
211 registered: ServerConfigManager.Instance.getRegisteredPlugins()
212 },
213 theme: {
214 registered: ServerConfigManager.Instance.getRegisteredThemes(),
215 default: getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
216 },
217 email: {
218 enabled: isEmailEnabled()
219 },
220 contactForm: {
221 enabled: CONFIG.CONTACT_FORM.ENABLED
222 },
223 transcoding: {
224 hls: {
225 enabled: CONFIG.TRANSCODING.HLS.ENABLED
226 },
227 webtorrent: {
228 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
229 },
230 enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('vod')
231 },
232 live: {
233 enabled: CONFIG.LIVE.ENABLED,
234 transcoding: {
235 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
236 enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('live')
237 }
238 },
239 import: {
240 videos: {
241 http: {
242 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
243 },
244 torrent: {
245 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
246 }
247 }
248 },
249 autoBlacklist: {
250 videos: {
251 ofUsers: {
252 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
253 }
254 }
255 },
256 avatar: {
257 file: {
258 size: {
259 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
260 },
261 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
262 }
263 },
264 video: {
265 image: {
266 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
267 size: {
268 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
269 }
270 },
271 file: {
272 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
273 }
274 },
275 videoCaption: {
276 file: {
277 size: {
278 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
279 },
280 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
281 }
282 },
283 user: {
284 videoQuota: CONFIG.USER.VIDEO_QUOTA,
285 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
286 },
287 trending: {
288 videos: {
289 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
290 }
291 },
292 tracker: {
293 enabled: CONFIG.TRACKER.ENABLED
294 }
295 }
296 }
297 } as HttpNodeinfoDiasporaSoftwareNsSchema20
298
299 res.contentType('application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"')
300 .send(json)
301 .end()
302 }
303
304 function getCup (req: express.Request, res: express.Response, next: express.NextFunction) {
305 res.status(HttpStatusCode.I_AM_A_TEAPOT_418)
306 res.setHeader('Accept-Additions', 'Non-Dairy;1,Sugar;1')
307 res.setHeader('Safe', 'if-sepia-awake')
308
309 return next()
310 }