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