]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/commitdiff
Split static router
authorChocobozzz <me@florianbigard.com>
Wed, 13 Jul 2022 09:13:19 +0000 (11:13 +0200)
committerChocobozzz <me@florianbigard.com>
Wed, 13 Jul 2022 09:16:29 +0000 (11:16 +0200)
server.ts
server/controllers/index.ts
server/controllers/misc.ts [new file with mode: 0644]
server/controllers/static.ts
server/controllers/well-known.ts [new file with mode: 0644]

index e69ad7fb72e0646d54ad2748eaaeddbc334370be..35ccc6758ea4d2fef78ab290c50e4db6eae45d6e 100644 (file)
--- a/server.ts
+++ b/server.ts
@@ -95,9 +95,11 @@ import { VideosPreviewCache, VideosCaptionCache } from './server/lib/files-cache
 import {
   activityPubRouter,
   apiRouter,
+  miscRouter,
   clientsRouter,
   feedsRouter,
   staticRouter,
+  wellKnownRouter,
   lazyStaticRouter,
   servicesRouter,
   liveRouter,
@@ -231,6 +233,8 @@ app.use('/', botsRouter)
 
 // Static files
 app.use('/', staticRouter)
+app.use('/', wellKnownRouter)
+app.use('/', miscRouter)
 app.use('/', downloadRouter)
 app.use('/', lazyStaticRouter)
 
index fa27ecec259cfbdceed4d98543c74beeb750d78b..e8833d58cad6556d8fd99fc48a0a63caed224289 100644 (file)
@@ -7,7 +7,9 @@ export * from './services'
 export * from './static'
 export * from './lazy-static'
 export * from './live'
+export * from './misc'
 export * from './webfinger'
 export * from './tracker'
 export * from './bots'
 export * from './plugins'
+export * from './well-known'
diff --git a/server/controllers/misc.ts b/server/controllers/misc.ts
new file mode 100644 (file)
index 0000000..4c8af2a
--- /dev/null
@@ -0,0 +1,206 @@
+import cors from 'cors'
+import express from 'express'
+import { CONFIG, isEmailEnabled } from '@server/initializers/config'
+import { serveIndexHTML } from '@server/lib/client-html'
+import { ServerConfigManager } from '@server/lib/server-config-manager'
+import { HttpStatusCode } from '@shared/models'
+import { HttpNodeinfoDiasporaSoftwareNsSchema20 } from '../../shared/models/nodeinfo/nodeinfo.model'
+import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION, ROUTE_CACHE_LIFETIME } from '../initializers/constants'
+import { getThemeOrDefault } from '../lib/plugins/theme-utils'
+import { asyncMiddleware } from '../middlewares'
+import { cacheRoute } from '../middlewares/cache/cache'
+import { UserModel } from '../models/user/user'
+import { VideoModel } from '../models/video/video'
+import { VideoCommentModel } from '../models/video/video-comment'
+
+const miscRouter = express.Router()
+
+miscRouter.use(cors())
+
+miscRouter.use('/nodeinfo/:version.json',
+  cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
+  asyncMiddleware(generateNodeinfo)
+)
+
+// robots.txt service
+miscRouter.get('/robots.txt',
+  cacheRoute(ROUTE_CACHE_LIFETIME.ROBOTS),
+  (_, res: express.Response) => {
+    res.type('text/plain')
+
+    return res.send(CONFIG.INSTANCE.ROBOTS)
+  }
+)
+
+miscRouter.all('/teapot',
+  getCup,
+  asyncMiddleware(serveIndexHTML)
+)
+
+// security.txt service
+miscRouter.get('/security.txt',
+  (_, res: express.Response) => {
+    return res.redirect(HttpStatusCode.MOVED_PERMANENTLY_301, '/.well-known/security.txt')
+  }
+)
+
+// ---------------------------------------------------------------------------
+
+export {
+  miscRouter
+}
+
+// ---------------------------------------------------------------------------
+
+async function generateNodeinfo (req: express.Request, res: express.Response) {
+  const { totalVideos } = await VideoModel.getStats()
+  const { totalLocalVideoComments } = await VideoCommentModel.getStats()
+  const { totalUsers, totalMonthlyActiveUsers, totalHalfYearActiveUsers } = await UserModel.getStats()
+
+  if (!req.params.version || req.params.version !== '2.0') {
+    return res.fail({
+      status: HttpStatusCode.NOT_FOUND_404,
+      message: 'Nodeinfo schema version not handled'
+    })
+  }
+
+  const json = {
+    version: '2.0',
+    software: {
+      name: 'peertube',
+      version: PEERTUBE_VERSION
+    },
+    protocols: [
+      'activitypub'
+    ],
+    services: {
+      inbound: [],
+      outbound: [
+        'atom1.0',
+        'rss2.0'
+      ]
+    },
+    openRegistrations: CONFIG.SIGNUP.ENABLED,
+    usage: {
+      users: {
+        total: totalUsers,
+        activeMonth: totalMonthlyActiveUsers,
+        activeHalfyear: totalHalfYearActiveUsers
+      },
+      localPosts: totalVideos,
+      localComments: totalLocalVideoComments
+    },
+    metadata: {
+      taxonomy: {
+        postsName: 'Videos'
+      },
+      nodeName: CONFIG.INSTANCE.NAME,
+      nodeDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
+      nodeConfig: {
+        search: {
+          remoteUri: {
+            users: CONFIG.SEARCH.REMOTE_URI.USERS,
+            anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
+          }
+        },
+        plugin: {
+          registered: ServerConfigManager.Instance.getRegisteredPlugins()
+        },
+        theme: {
+          registered: ServerConfigManager.Instance.getRegisteredThemes(),
+          default: getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
+        },
+        email: {
+          enabled: isEmailEnabled()
+        },
+        contactForm: {
+          enabled: CONFIG.CONTACT_FORM.ENABLED
+        },
+        transcoding: {
+          hls: {
+            enabled: CONFIG.TRANSCODING.HLS.ENABLED
+          },
+          webtorrent: {
+            enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
+          },
+          enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('vod')
+        },
+        live: {
+          enabled: CONFIG.LIVE.ENABLED,
+          transcoding: {
+            enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
+            enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('live')
+          }
+        },
+        import: {
+          videos: {
+            http: {
+              enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
+            },
+            torrent: {
+              enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
+            }
+          }
+        },
+        autoBlacklist: {
+          videos: {
+            ofUsers: {
+              enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
+            }
+          }
+        },
+        avatar: {
+          file: {
+            size: {
+              max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
+            },
+            extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
+          }
+        },
+        video: {
+          image: {
+            extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
+            size: {
+              max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
+            }
+          },
+          file: {
+            extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
+          }
+        },
+        videoCaption: {
+          file: {
+            size: {
+              max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
+            },
+            extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
+          }
+        },
+        user: {
+          videoQuota: CONFIG.USER.VIDEO_QUOTA,
+          videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
+        },
+        trending: {
+          videos: {
+            intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
+          }
+        },
+        tracker: {
+          enabled: CONFIG.TRACKER.ENABLED
+        }
+      }
+    }
+  } as HttpNodeinfoDiasporaSoftwareNsSchema20
+
+  res.contentType('application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"')
+      .send(json)
+      .end()
+}
+
+function getCup (req: express.Request, res: express.Response, next: express.NextFunction) {
+  res.status(HttpStatusCode.I_AM_A_TEAPOT_418)
+  res.setHeader('Accept-Additions', 'Non-Dairy;1,Sugar;1')
+  res.setHeader('Safe', 'if-sepia-awake')
+
+  return next()
+}
index 87bceba7afa23a39ee3ac3916eaa1f15561e66c3..7668ceb82c822bd400c844378afde40b7ed69d04 100644 (file)
@@ -1,37 +1,13 @@
 import cors from 'cors'
 import express from 'express'
-import { join } from 'path'
-import { serveIndexHTML } from '@server/lib/client-html'
-import { ServerConfigManager } from '@server/lib/server-config-manager'
-import { HttpStatusCode } from '@shared/models'
-import { HttpNodeinfoDiasporaSoftwareNsSchema20 } from '../../shared/models/nodeinfo/nodeinfo.model'
-import { root } from '@shared/core-utils'
-import { CONFIG, isEmailEnabled } from '../initializers/config'
-import {
-  CONSTRAINTS_FIELDS,
-  DEFAULT_THEME_NAME,
-  HLS_STREAMING_PLAYLIST_DIRECTORY,
-  PEERTUBE_VERSION,
-  ROUTE_CACHE_LIFETIME,
-  STATIC_MAX_AGE,
-  STATIC_PATHS,
-  WEBSERVER
-} from '../initializers/constants'
-import { getThemeOrDefault } from '../lib/plugins/theme-utils'
-import { asyncMiddleware } from '../middlewares'
-import { cacheRoute } from '../middlewares/cache/cache'
-import { UserModel } from '../models/user/user'
-import { VideoModel } from '../models/video/video'
-import { VideoCommentModel } from '../models/video/video-comment'
+import { CONFIG } from '../initializers/config'
+import { HLS_STREAMING_PLAYLIST_DIRECTORY, STATIC_MAX_AGE, STATIC_PATHS } from '../initializers/constants'
 
 const staticRouter = express.Router()
 
+// Cors is very important to let other servers access torrent and video files
 staticRouter.use(cors())
 
-/*
-  Cors is very important to let other servers access torrent and video files
-*/
-
 // Videos path for webseed
 staticRouter.use(
   STATIC_PATHS.WEBSEED,
@@ -45,7 +21,6 @@ staticRouter.use(
 // HLS
 staticRouter.use(
   STATIC_PATHS.STREAMING_PLAYLISTS.HLS,
-  cors(),
   express.static(HLS_STREAMING_PLAYLIST_DIRECTORY, { fallthrough: false }) // 404 if the file does not exist
 )
 
@@ -56,248 +31,8 @@ staticRouter.use(
   express.static(thumbnailsPhysicalPath, { maxAge: STATIC_MAX_AGE.SERVER, fallthrough: false }) // 404 if the file does not exist
 )
 
-// robots.txt service
-staticRouter.get('/robots.txt',
-  cacheRoute(ROUTE_CACHE_LIFETIME.ROBOTS),
-  (_, res: express.Response) => {
-    res.type('text/plain')
-
-    return res.send(CONFIG.INSTANCE.ROBOTS)
-  }
-)
-
-staticRouter.all('/teapot',
-  getCup,
-  asyncMiddleware(serveIndexHTML)
-)
-
-// security.txt service
-staticRouter.get('/security.txt',
-  (_, res: express.Response) => {
-    return res.redirect(HttpStatusCode.MOVED_PERMANENTLY_301, '/.well-known/security.txt')
-  }
-)
-
-staticRouter.get('/.well-known/security.txt',
-  cacheRoute(ROUTE_CACHE_LIFETIME.SECURITYTXT),
-  (_, res: express.Response) => {
-    res.type('text/plain')
-    return res.send(CONFIG.INSTANCE.SECURITYTXT + CONFIG.INSTANCE.SECURITYTXT_CONTACT)
-  }
-)
-
-// nodeinfo service
-staticRouter.use('/.well-known/nodeinfo',
-  cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
-  (_, res: express.Response) => {
-    return res.json({
-      links: [
-        {
-          rel: 'http://nodeinfo.diaspora.software/ns/schema/2.0',
-          href: WEBSERVER.URL + '/nodeinfo/2.0.json'
-        }
-      ]
-    })
-  }
-)
-staticRouter.use('/nodeinfo/:version.json',
-  cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
-  asyncMiddleware(generateNodeinfo)
-)
-
-// dnt-policy.txt service (see https://www.eff.org/dnt-policy)
-staticRouter.use('/.well-known/dnt-policy.txt',
-  cacheRoute(ROUTE_CACHE_LIFETIME.DNT_POLICY),
-  (_, res: express.Response) => {
-    res.type('text/plain')
-
-    return res.sendFile(join(root(), 'dist/server/static/dnt-policy/dnt-policy-1.0.txt'))
-  }
-)
-
-// dnt service (see https://www.w3.org/TR/tracking-dnt/#status-resource)
-staticRouter.use('/.well-known/dnt/',
-  (_, res: express.Response) => {
-    res.json({ tracking: 'N' })
-  }
-)
-
-staticRouter.use('/.well-known/change-password',
-  (_, res: express.Response) => {
-    res.redirect('/my-account/settings')
-  }
-)
-
-staticRouter.use('/.well-known/host-meta',
-  (_, res: express.Response) => {
-    res.type('application/xml')
-
-    const xml = '<?xml version="1.0" encoding="UTF-8"?>\n' +
-      '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">\n' +
-      `  <Link rel="lrdd" type="application/xrd+xml" template="${WEBSERVER.URL}/.well-known/webfinger?resource={uri}"/>\n` +
-      '</XRD>'
-
-    res.send(xml).end()
-  }
-)
-
 // ---------------------------------------------------------------------------
 
 export {
   staticRouter
 }
-
-// ---------------------------------------------------------------------------
-
-async function generateNodeinfo (req: express.Request, res: express.Response) {
-  const { totalVideos } = await VideoModel.getStats()
-  const { totalLocalVideoComments } = await VideoCommentModel.getStats()
-  const { totalUsers, totalMonthlyActiveUsers, totalHalfYearActiveUsers } = await UserModel.getStats()
-
-  if (!req.params.version || req.params.version !== '2.0') {
-    return res.fail({
-      status: HttpStatusCode.NOT_FOUND_404,
-      message: 'Nodeinfo schema version not handled'
-    })
-  }
-
-  const json = {
-    version: '2.0',
-    software: {
-      name: 'peertube',
-      version: PEERTUBE_VERSION
-    },
-    protocols: [
-      'activitypub'
-    ],
-    services: {
-      inbound: [],
-      outbound: [
-        'atom1.0',
-        'rss2.0'
-      ]
-    },
-    openRegistrations: CONFIG.SIGNUP.ENABLED,
-    usage: {
-      users: {
-        total: totalUsers,
-        activeMonth: totalMonthlyActiveUsers,
-        activeHalfyear: totalHalfYearActiveUsers
-      },
-      localPosts: totalVideos,
-      localComments: totalLocalVideoComments
-    },
-    metadata: {
-      taxonomy: {
-        postsName: 'Videos'
-      },
-      nodeName: CONFIG.INSTANCE.NAME,
-      nodeDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
-      nodeConfig: {
-        search: {
-          remoteUri: {
-            users: CONFIG.SEARCH.REMOTE_URI.USERS,
-            anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
-          }
-        },
-        plugin: {
-          registered: ServerConfigManager.Instance.getRegisteredPlugins()
-        },
-        theme: {
-          registered: ServerConfigManager.Instance.getRegisteredThemes(),
-          default: getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
-        },
-        email: {
-          enabled: isEmailEnabled()
-        },
-        contactForm: {
-          enabled: CONFIG.CONTACT_FORM.ENABLED
-        },
-        transcoding: {
-          hls: {
-            enabled: CONFIG.TRANSCODING.HLS.ENABLED
-          },
-          webtorrent: {
-            enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
-          },
-          enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('vod')
-        },
-        live: {
-          enabled: CONFIG.LIVE.ENABLED,
-          transcoding: {
-            enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
-            enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('live')
-          }
-        },
-        import: {
-          videos: {
-            http: {
-              enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
-            },
-            torrent: {
-              enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
-            }
-          }
-        },
-        autoBlacklist: {
-          videos: {
-            ofUsers: {
-              enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
-            }
-          }
-        },
-        avatar: {
-          file: {
-            size: {
-              max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
-            },
-            extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
-          }
-        },
-        video: {
-          image: {
-            extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
-            size: {
-              max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
-            }
-          },
-          file: {
-            extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
-          }
-        },
-        videoCaption: {
-          file: {
-            size: {
-              max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
-            },
-            extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
-          }
-        },
-        user: {
-          videoQuota: CONFIG.USER.VIDEO_QUOTA,
-          videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
-        },
-        trending: {
-          videos: {
-            intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
-          }
-        },
-        tracker: {
-          enabled: CONFIG.TRACKER.ENABLED
-        }
-      }
-    }
-  } as HttpNodeinfoDiasporaSoftwareNsSchema20
-
-  res.contentType('application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"')
-      .send(json)
-      .end()
-}
-
-function getCup (req: express.Request, res: express.Response, next: express.NextFunction) {
-  res.status(HttpStatusCode.I_AM_A_TEAPOT_418)
-  res.setHeader('Accept-Additions', 'Non-Dairy;1,Sugar;1')
-  res.setHeader('Safe', 'if-sepia-awake')
-
-  return next()
-}
diff --git a/server/controllers/well-known.ts b/server/controllers/well-known.ts
new file mode 100644 (file)
index 0000000..f467bd6
--- /dev/null
@@ -0,0 +1,76 @@
+import cors from 'cors'
+import express from 'express'
+import { join } from 'path'
+import { root } from '@shared/core-utils'
+import { CONFIG } from '../initializers/config'
+import { ROUTE_CACHE_LIFETIME, WEBSERVER } from '../initializers/constants'
+import { cacheRoute } from '../middlewares/cache/cache'
+
+const wellKnownRouter = express.Router()
+
+wellKnownRouter.use(cors())
+
+wellKnownRouter.get('/.well-known/security.txt',
+  cacheRoute(ROUTE_CACHE_LIFETIME.SECURITYTXT),
+  (_, res: express.Response) => {
+    res.type('text/plain')
+    return res.send(CONFIG.INSTANCE.SECURITYTXT + CONFIG.INSTANCE.SECURITYTXT_CONTACT)
+  }
+)
+
+// nodeinfo service
+wellKnownRouter.use('/.well-known/nodeinfo',
+  cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
+  (_, res: express.Response) => {
+    return res.json({
+      links: [
+        {
+          rel: 'http://nodeinfo.diaspora.software/ns/schema/2.0',
+          href: WEBSERVER.URL + '/nodeinfo/2.0.json'
+        }
+      ]
+    })
+  }
+)
+
+// dnt-policy.txt service (see https://www.eff.org/dnt-policy)
+wellKnownRouter.use('/.well-known/dnt-policy.txt',
+  cacheRoute(ROUTE_CACHE_LIFETIME.DNT_POLICY),
+  (_, res: express.Response) => {
+    res.type('text/plain')
+
+    return res.sendFile(join(root(), 'dist/server/static/dnt-policy/dnt-policy-1.0.txt'))
+  }
+)
+
+// dnt service (see https://www.w3.org/TR/tracking-dnt/#status-resource)
+wellKnownRouter.use('/.well-known/dnt/',
+  (_, res: express.Response) => {
+    res.json({ tracking: 'N' })
+  }
+)
+
+wellKnownRouter.use('/.well-known/change-password',
+  (_, res: express.Response) => {
+    res.redirect('/my-account/settings')
+  }
+)
+
+wellKnownRouter.use('/.well-known/host-meta',
+  (_, res: express.Response) => {
+    res.type('application/xml')
+
+    const xml = '<?xml version="1.0" encoding="UTF-8"?>\n' +
+      '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">\n' +
+      `  <Link rel="lrdd" type="application/xrd+xml" template="${WEBSERVER.URL}/.well-known/webfinger?resource={uri}"/>\n` +
+      '</XRD>'
+
+    res.send(xml).end()
+  }
+)
+
+// ---------------------------------------------------------------------------
+
+export {
+  wellKnownRouter
+}