]>
Commit | Line | Data |
---|---|---|
1 | import express from 'express' | |
2 | import { constants, promises as fs } from 'fs' | |
3 | import { readFile } from 'fs-extra' | |
4 | import { join } from 'path' | |
5 | import { logger } from '@server/helpers/logger' | |
6 | import { CONFIG } from '@server/initializers/config' | |
7 | import { Hooks } from '@server/lib/plugins/hooks' | |
8 | import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '@shared/core-utils/i18n' | |
9 | import { HttpStatusCode } from '@shared/models' | |
10 | import { root } from '@shared/core-utils' | |
11 | import { STATIC_MAX_AGE } from '../initializers/constants' | |
12 | import { ClientHtml, sendHTML, serveIndexHTML } from '../lib/client-html' | |
13 | import { asyncMiddleware, embedCSP } from '../middlewares' | |
14 | ||
15 | const clientsRouter = express.Router() | |
16 | ||
17 | const distPath = join(root(), 'client', 'dist') | |
18 | const testEmbedPath = join(distPath, 'standalone', 'videos', 'test-embed.html') | |
19 | ||
20 | // Special route that add OpenGraph and oEmbed tags | |
21 | // Do not use a template engine for a so little thing | |
22 | clientsRouter.use([ '/w/p/:id', '/videos/watch/playlist/:id' ], asyncMiddleware(generateWatchPlaylistHtmlPage)) | |
23 | clientsRouter.use([ '/w/:id', '/videos/watch/:id' ], asyncMiddleware(generateWatchHtmlPage)) | |
24 | clientsRouter.use([ '/accounts/:nameWithHost', '/a/:nameWithHost' ], asyncMiddleware(generateAccountHtmlPage)) | |
25 | clientsRouter.use([ '/video-channels/:nameWithHost', '/c/:nameWithHost' ], asyncMiddleware(generateVideoChannelHtmlPage)) | |
26 | clientsRouter.use('/@:nameWithHost', asyncMiddleware(generateActorHtmlPage)) | |
27 | ||
28 | const embedMiddlewares = [ | |
29 | CONFIG.CSP.ENABLED | |
30 | ? embedCSP | |
31 | : (req: express.Request, res: express.Response, next: express.NextFunction) => next(), | |
32 | ||
33 | // Set headers | |
34 | (req: express.Request, res: express.Response, next: express.NextFunction) => { | |
35 | res.removeHeader('X-Frame-Options') | |
36 | ||
37 | // Don't cache HTML file since it's an index to the immutable JS/CSS files | |
38 | res.setHeader('Cache-Control', 'public, max-age=0') | |
39 | ||
40 | next() | |
41 | }, | |
42 | ||
43 | asyncMiddleware(generateEmbedHtmlPage) | |
44 | ] | |
45 | ||
46 | clientsRouter.use('/videos/embed', ...embedMiddlewares) | |
47 | clientsRouter.use('/video-playlists/embed', ...embedMiddlewares) | |
48 | ||
49 | const testEmbedController = (req: express.Request, res: express.Response) => res.sendFile(testEmbedPath) | |
50 | ||
51 | clientsRouter.use('/videos/test-embed', testEmbedController) | |
52 | clientsRouter.use('/video-playlists/test-embed', testEmbedController) | |
53 | ||
54 | // Dynamic PWA manifest | |
55 | clientsRouter.get('/manifest.webmanifest', asyncMiddleware(generateManifest)) | |
56 | ||
57 | // Static client overrides | |
58 | // Must be consistent with static client overrides redirections in /support/nginx/peertube | |
59 | const staticClientOverrides = [ | |
60 | 'assets/images/logo.svg', | |
61 | 'assets/images/favicon.png', | |
62 | 'assets/images/icons/icon-36x36.png', | |
63 | 'assets/images/icons/icon-48x48.png', | |
64 | 'assets/images/icons/icon-72x72.png', | |
65 | 'assets/images/icons/icon-96x96.png', | |
66 | 'assets/images/icons/icon-144x144.png', | |
67 | 'assets/images/icons/icon-192x192.png', | |
68 | 'assets/images/icons/icon-512x512.png', | |
69 | 'assets/images/default-playlist.jpg', | |
70 | 'assets/images/default-avatar-account.png', | |
71 | 'assets/images/default-avatar-account-48x48.png', | |
72 | 'assets/images/default-avatar-video-channel.png', | |
73 | 'assets/images/default-avatar-video-channel-48x48.png' | |
74 | ] | |
75 | ||
76 | for (const staticClientOverride of staticClientOverrides) { | |
77 | const overridePhysicalPath = join(CONFIG.STORAGE.CLIENT_OVERRIDES_DIR, staticClientOverride) | |
78 | clientsRouter.use(`/client/${staticClientOverride}`, asyncMiddleware(serveClientOverride(overridePhysicalPath))) | |
79 | } | |
80 | ||
81 | clientsRouter.use('/client/locales/:locale/:file.json', serveServerTranslations) | |
82 | clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE.CLIENT })) | |
83 | ||
84 | // 404 for static files not found | |
85 | clientsRouter.use('/client/*', (req: express.Request, res: express.Response) => { | |
86 | res.status(HttpStatusCode.NOT_FOUND_404).end() | |
87 | }) | |
88 | ||
89 | // Always serve index client page (the client is a single page application, let it handle routing) | |
90 | // Try to provide the right language index.html | |
91 | clientsRouter.use('/(:language)?', asyncMiddleware(serveIndexHTML)) | |
92 | ||
93 | // --------------------------------------------------------------------------- | |
94 | ||
95 | export { | |
96 | clientsRouter | |
97 | } | |
98 | ||
99 | // --------------------------------------------------------------------------- | |
100 | ||
101 | function serveServerTranslations (req: express.Request, res: express.Response) { | |
102 | const locale = req.params.locale | |
103 | const file = req.params.file | |
104 | ||
105 | if (is18nLocale(locale) && LOCALE_FILES.includes(file)) { | |
106 | const completeLocale = getCompleteLocale(locale) | |
107 | const completeFileLocale = buildFileLocale(completeLocale) | |
108 | ||
109 | const path = join(__dirname, `../../../client/dist/locale/${file}.${completeFileLocale}.json`) | |
110 | return res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) | |
111 | } | |
112 | ||
113 | return res.status(HttpStatusCode.NOT_FOUND_404).end() | |
114 | } | |
115 | ||
116 | async function generateEmbedHtmlPage (req: express.Request, res: express.Response) { | |
117 | const hookName = req.originalUrl.startsWith('/video-playlists/') | |
118 | ? 'filter:html.embed.video-playlist.allowed.result' | |
119 | : 'filter:html.embed.video.allowed.result' | |
120 | ||
121 | const allowParameters = { req } | |
122 | ||
123 | const allowedResult = await Hooks.wrapFun( | |
124 | isEmbedAllowed, | |
125 | allowParameters, | |
126 | hookName | |
127 | ) | |
128 | ||
129 | if (!allowedResult || allowedResult.allowed !== true) { | |
130 | logger.info('Embed is not allowed.', { allowedResult }) | |
131 | ||
132 | return sendHTML(allowedResult?.html || '', res) | |
133 | } | |
134 | ||
135 | const html = await ClientHtml.getEmbedHTML() | |
136 | ||
137 | return sendHTML(html, res) | |
138 | } | |
139 | ||
140 | async function generateWatchHtmlPage (req: express.Request, res: express.Response) { | |
141 | const html = await ClientHtml.getWatchHTMLPage(req.params.id + '', req, res) | |
142 | ||
143 | return sendHTML(html, res, true) | |
144 | } | |
145 | ||
146 | async function generateWatchPlaylistHtmlPage (req: express.Request, res: express.Response) { | |
147 | const html = await ClientHtml.getWatchPlaylistHTMLPage(req.params.id + '', req, res) | |
148 | ||
149 | return sendHTML(html, res, true) | |
150 | } | |
151 | ||
152 | async function generateAccountHtmlPage (req: express.Request, res: express.Response) { | |
153 | const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res) | |
154 | ||
155 | return sendHTML(html, res, true) | |
156 | } | |
157 | ||
158 | async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) { | |
159 | const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res) | |
160 | ||
161 | return sendHTML(html, res, true) | |
162 | } | |
163 | ||
164 | async function generateActorHtmlPage (req: express.Request, res: express.Response) { | |
165 | const html = await ClientHtml.getActorHTMLPage(req.params.nameWithHost, req, res) | |
166 | ||
167 | return sendHTML(html, res, true) | |
168 | } | |
169 | ||
170 | async function generateManifest (req: express.Request, res: express.Response) { | |
171 | const manifestPhysicalPath = join(root(), 'client', 'dist', 'manifest.webmanifest') | |
172 | const manifestJson = await readFile(manifestPhysicalPath, 'utf8') | |
173 | const manifest = JSON.parse(manifestJson) | |
174 | ||
175 | manifest.name = CONFIG.INSTANCE.NAME | |
176 | manifest.short_name = CONFIG.INSTANCE.NAME | |
177 | manifest.description = CONFIG.INSTANCE.SHORT_DESCRIPTION | |
178 | ||
179 | res.json(manifest) | |
180 | } | |
181 | ||
182 | function serveClientOverride (path: string) { | |
183 | return async (req: express.Request, res: express.Response, next: express.NextFunction) => { | |
184 | try { | |
185 | await fs.access(path, constants.F_OK) | |
186 | // Serve override client | |
187 | res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) | |
188 | } catch { | |
189 | // Serve dist client | |
190 | next() | |
191 | } | |
192 | } | |
193 | } | |
194 | ||
195 | type AllowedResult = { allowed: boolean, html?: string } | |
196 | function isEmbedAllowed (_object: { | |
197 | req: express.Request | |
198 | }): AllowedResult { | |
199 | return { allowed: true } | |
200 | } |