peertube-plugin-livechat/server/lib/routers/settings.ts

// SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
//
// SPDX-License-Identifier: AGPL-3.0-only

import type { RegisterServerOptions } from '@peertube/peertube-types'
import type { Router, Request, Response, NextFunction } from 'express'
import { diag } from '../diagnostic'
import { getBaseStaticRoute, isUserAdmin } from '../helpers'
import { asyncMiddleware } from '../middlewares/async'

async function initSettingsRouter (options: RegisterServerOptions): Promise<Router> {
  const { peertubeHelpers, getRouter } = options
  const router = getRouter()
  const logger = peertubeHelpers.logger

  router.get('/diagnostic', asyncMiddleware(
    async (req: Request, res: Response, _next: NextFunction) => {
      logger.info('Accessing peertube-plugin-livechat diagnostic tool.')
      const src = getBaseStaticRoute(options) + 'settings/settings.js'
      res.status(200)
      res.type('html')
      res.send(`<html>
        <body><div>Loading...</div></body>
        <script type="module" src="${src}"></script>
        </html>
      `)
    }
  ))

  router.post('/diagnostic/test', asyncMiddleware(
    async (req: Request, res: Response, _next: NextFunction) => {
      if (!res.locals.authenticated) {
        res.sendStatus(403)
        return
      }
      if (!await isUserAdmin(options, res)) {
        res.sendStatus(403)
        return
      }

      const test: string = req.body.test || ''
      logger.info('Accessing peertube-plugin-livechat diagnostic tool, test "' + test + '".')

      const result = await diag(test, options)

      res.status(200)
      res.json(result)
    }
  ))

  return router
}

export {
  initSettingsRouter
}
Adding SPDX headers (WIP) 2024-05-23 09:42:14 +00:00			`// SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>`
			`//`
			`// SPDX-License-Identifier: AGPL-3.0-only`

Using types declarations from the official @peertube/peertube-types package. 2022-01-11 00:29:33 +00:00			`import type { RegisterServerOptions } from '@peertube/peertube-types'`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00			`import type { Router, Request, Response, NextFunction } from 'express'`
Refactoring diagnostic tests in multiple files. 2021-04-12 15:53:12 +00:00			`import { diag } from '../diagnostic'`
Diagnostic tools: testing user rights. 2021-04-10 11:57:47 +00:00			`import { getBaseStaticRoute, isUserAdmin } from '../helpers'`
Adding asyncMiddleware. 2021-05-03 18:06:36 +00:00			`import { asyncMiddleware } from '../middlewares/async'`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00
Changing diagnostic functions arguments. 2021-04-12 18:15:44 +00:00			`async function initSettingsRouter (options: RegisterServerOptions): Promise<Router> {`
			`const { peertubeHelpers, getRouter } = options`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00			`const router = getRouter()`
			`const logger = peertubeHelpers.logger`

Adding asyncMiddleware. 2021-05-03 18:06:36 +00:00			`router.get('/diagnostic', asyncMiddleware(`
			`async (req: Request, res: Response, _next: NextFunction) => {`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00			`logger.info('Accessing peertube-plugin-livechat diagnostic tool.')`
Use peertubeHelpers.plugin methods when available: * getBaseStaticRoute use peertubeHelper when available * getBaseRouter renamed getBaseRouterRoute and use peertubeHelper when available * Backward compatibility is maintained. 2021-05-18 16:06:11 +00:00			`const src = getBaseStaticRoute(options) + 'settings/settings.js'`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00			`res.status(200)`
			`res.type('html')`
Use ESBuild for frontend build. Replacing webpack by ESBuild for client code compilation (as in the official quickstart plugin). So we can remove deprecated webpack dependencies. Note: webpack is still used for ConverseJS build. This may be removed soon. Related to issue #122. 2022-12-07 17:36:16 +00:00			res.send(`<html>
			`<body><div>Loading...</div></body>`
			`<script type="module" src="${src}"></script>`
			`</html>`
			`)
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00			`}`
Adding asyncMiddleware. 2021-05-03 18:06:36 +00:00			`))`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00
Adding asyncMiddleware. 2021-05-03 18:06:36 +00:00			`router.post('/diagnostic/test', asyncMiddleware(`
			`async (req: Request, res: Response, _next: NextFunction) => {`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00			`if (!res.locals.authenticated) {`
Adding asyncMiddleware. 2021-05-03 18:06:36 +00:00			`res.sendStatus(403)`
			`return`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00			`}`
getAuthUser becomes async. 2021-05-05 13:55:38 +00:00			`if (!await isUserAdmin(options, res)) {`
Adding asyncMiddleware. 2021-05-03 18:06:36 +00:00			`res.sendStatus(403)`
			`return`
Diagnostic tools: testing user rights. 2021-04-10 11:57:47 +00:00			`}`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00
			`const test: string = req.body.test \|\| ''`
			`logger.info('Accessing peertube-plugin-livechat diagnostic tool, test "' + test + '".')`
Diagnostic tools. WIP 2021-04-10 02:16:25 +00:00
Changing diagnostic functions arguments. 2021-04-12 18:15:44 +00:00			`const result = await diag(test, options)`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00
			`res.status(200)`
			`res.json(result)`
			`}`
Adding asyncMiddleware. 2021-05-03 18:06:36 +00:00			`))`
Initializing a diagnostic tools. WIP 2021-04-09 19:28:16 +00:00
			`return router`
			`}`

			`export {`
			`initSettingsRouter`
			`}`