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