PeerTube/server.ts

350 lines
11 KiB
TypeScript
Raw Normal View History

2016-02-07 11:47:30 +01:00
// ----------- Node modules -----------
2022-07-05 15:43:21 +02:00
import { registerOpentelemetryTracing } from './server/lib/opentelemetry/tracing'
registerOpentelemetryTracing()
2021-08-27 14:32:44 +02:00
import express from 'express'
import morgan, { token } from 'morgan'
import cors from 'cors'
import cookieParser from 'cookie-parser'
import { frameguard } from 'helmet'
import { parse } from 'useragent'
import anonymize from 'ip-anonymize'
2021-06-25 17:39:27 +02:00
import { program as cli } from 'commander'
2016-02-07 11:47:30 +01:00
2016-10-21 14:23:20 +02:00
process.title = 'peertube'
2016-02-07 11:47:30 +01:00
// Create our main app
2022-01-03 16:37:16 +01:00
const app = express().disable('x-powered-by')
2016-02-07 11:47:30 +01:00
2017-08-26 09:17:20 +02:00
// ----------- Core checker -----------
import { checkMissedConfig, checkFFmpeg, checkNodeVersion } from './server/initializers/checker-before-init'
2018-03-26 15:54:13 +02:00
// Do not use barrels because we don't want to load all modules here (we need to initialize database first)
import { CONFIG } from './server/initializers/config'
import { API_VERSION, FILES_CACHE, WEBSERVER, loadLanguages } from './server/initializers/constants'
import { logger } from './server/helpers/logger'
2018-03-26 15:54:13 +02:00
2017-05-15 22:22:03 +02:00
const missed = checkMissedConfig()
if (missed.length !== 0) {
2018-03-26 15:54:13 +02:00
logger.error('Your configuration files miss keys: ' + missed)
process.exit(-1)
}
2017-08-26 09:17:20 +02:00
checkFFmpeg(CONFIG)
2018-03-26 15:54:13 +02:00
.catch(err => {
logger.error('Error in ffmpeg check.', { err })
process.exit(-1)
})
2021-12-24 13:43:59 +01:00
try {
checkNodeVersion()
} catch (err) {
logger.error('Error in NodeJS check.', { err })
process.exit(-1)
}
2021-03-11 09:51:08 +01:00
import { checkConfig, checkActivityPubUrls, checkFFmpegVersion } from './server/initializers/checker-after-init'
2022-02-11 10:51:33 +01:00
checkConfig()
2018-03-29 10:58:24 +02:00
// Trust our proxy (IP forwarding...)
app.set('trust proxy', CONFIG.TRUST_PROXY)
2022-07-05 15:43:21 +02:00
app.use((_req, res, next) => {
res.locals.requestStart = Date.now()
return next()
})
2018-07-19 16:17:54 +02:00
// Security middleware
2019-02-26 10:55:40 +01:00
import { baseCSP } from './server/middlewares/csp'
if (CONFIG.CSP.ENABLED) {
app.use(baseCSP)
2021-04-12 15:33:54 +02:00
}
if (CONFIG.SECURITY.FRAMEGUARD.ENABLED) {
2021-08-27 14:32:44 +02:00
app.use(frameguard({
2021-04-12 15:33:54 +02:00
action: 'deny' // we only allow it for /videos/embed, see server/controllers/client.ts
}))
}
2017-08-26 09:17:20 +02:00
// ----------- Database -----------
2017-12-13 17:46:23 +01:00
2017-08-26 09:17:20 +02:00
// Initialize database and models
2020-08-24 14:11:15 +02:00
import { initDatabaseModels, checkDatabaseConnectionOrDie } from './server/initializers/database'
checkDatabaseConnectionOrDie()
2017-12-13 17:46:23 +01:00
import { migrate } from './server/initializers/migrator'
migrate()
.then(() => initDatabaseModels(false))
.then(() => startApplication())
.catch(err => {
logger.error('Cannot start application.', { err })
process.exit(-1)
})
2017-08-26 09:17:20 +02:00
// ----------- Initialize -----------
loadLanguages()
// ----------- PeerTube modules -----------
2020-05-07 14:58:24 +02:00
import { installApplication } from './server/initializers/installer'
2018-01-30 13:27:07 +01:00
import { Emailer } from './server/lib/emailer'
import { JobQueue } from './server/lib/job-queue'
2019-03-19 14:23:17 +01:00
import { VideosPreviewCache, VideosCaptionCache } from './server/lib/files-cache'
import {
activityPubRouter,
apiRouter,
clientsRouter,
feedsRouter,
staticRouter,
2019-08-09 11:32:40 +02:00
lazyStaticRouter,
servicesRouter,
liveRouter,
pluginsRouter,
2018-06-26 16:53:24 +02:00
webfingerRouter,
trackerRouter,
createWebsocketTrackerServer,
botsRouter,
downloadRouter
} from './server/controllers'
import { advertiseDoNotTrack } from './server/middlewares/dnt'
2021-06-02 18:15:41 +02:00
import { apiFailMiddleware } from './server/middlewares/error'
2018-01-30 13:27:07 +01:00
import { Redis } from './server/lib/redis'
import { ActorFollowScheduler } from './server/lib/schedulers/actor-follow-scheduler'
2019-04-11 17:33:36 +02:00
import { RemoveOldViewsScheduler } from './server/lib/schedulers/remove-old-views-scheduler'
import { RemoveOldJobsScheduler } from './server/lib/schedulers/remove-old-jobs-scheduler'
import { UpdateVideosScheduler } from './server/lib/schedulers/update-videos-scheduler'
2018-08-02 16:02:51 +02:00
import { YoutubeDlUpdateScheduler } from './server/lib/schedulers/youtube-dl-update-scheduler'
2018-09-11 16:27:07 +02:00
import { VideosRedundancyScheduler } from './server/lib/schedulers/videos-redundancy-scheduler'
import { RemoveOldHistoryScheduler } from './server/lib/schedulers/remove-old-history-scheduler'
import { AutoFollowIndexInstances } from './server/lib/schedulers/auto-follow-index-instances'
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 11:13:41 +02:00
import { RemoveDanglingResumableUploadsScheduler } from './server/lib/schedulers/remove-dangling-resumable-uploads-scheduler'
import { VideoViewsBufferScheduler } from './server/lib/schedulers/video-views-buffer-scheduler'
import { GeoIPUpdateScheduler } from './server/lib/schedulers/geo-ip-update-scheduler'
import { isHTTPSignatureDigestValid } from './server/helpers/peertube-crypto'
2018-12-26 10:36:24 +01:00
import { PeerTubeSocket } from './server/lib/peertube-socket'
2019-04-08 11:13:49 +02:00
import { updateStreamingPlaylistsInfohashesIfNeeded } from './server/lib/hls'
2019-07-16 14:52:24 +02:00
import { PluginsCheckScheduler } from './server/lib/schedulers/plugins-check-scheduler'
2021-03-11 16:54:52 +01:00
import { PeerTubeVersionCheckScheduler } from './server/lib/schedulers/peertube-version-check-scheduler'
2019-07-19 17:30:41 +02:00
import { Hooks } from './server/lib/plugins/hooks'
2019-10-21 16:02:15 +02:00
import { PluginManager } from './server/lib/plugins/plugin-manager'
2021-06-16 15:14:41 +02:00
import { LiveManager } from './server/lib/live'
2021-07-16 10:42:24 +02:00
import { HttpStatusCode } from './shared/models/http/http-error-codes'
import { VideosTorrentCache } from '@server/lib/files-cache/videos-torrent-cache'
import { ServerConfigManager } from '@server/lib/server-config-manager'
import { VideoViewsManager } from '@server/lib/views/video-views-manager'
import { isTestOrDevInstance } from './server/helpers/core-utils'
2022-07-05 15:43:21 +02:00
import { OpenTelemetryMetrics } from '@server/lib/opentelemetry/metrics'
2016-02-07 11:47:30 +01:00
// ----------- Command line -----------
2018-11-14 15:27:47 +01:00
cli
.option('--no-client', 'Start PeerTube without client interface')
.option('--no-plugins', 'Start PeerTube without plugins/themes enabled')
.option('--benchmark-startup', 'Automatically stop server when initialized')
2018-11-14 15:27:47 +01:00
.parse(process.argv)
2016-02-07 11:47:30 +01:00
// ----------- App -----------
// Enable CORS for develop
if (isTestOrDevInstance()) {
2018-07-17 15:04:54 +02:00
app.use(cors({
origin: '*',
exposedHeaders: 'Retry-After',
credentials: true
}))
}
2016-02-07 11:47:30 +01:00
// For the logger
2021-08-27 14:32:44 +02:00
token('remote-addr', (req: express.Request) => {
if (CONFIG.LOG.ANONYMIZE_IP === true || req.get('DNT') === '1') {
return anonymize(req.ip, 16, 16)
}
return req.ip
})
2021-08-27 14:32:44 +02:00
token('user-agent', (req: express.Request) => {
if (req.get('DNT') === '1') {
2021-08-27 14:32:44 +02:00
return parse(req.get('user-agent')).family
}
return req.get('user-agent')
})
2017-05-22 20:58:25 +02:00
app.use(morgan('combined', {
stream: {
write: (str: string) => logger.info(str.trim(), { tags: [ 'http' ] })
},
2021-01-13 09:38:19 +01:00
skip: req => CONFIG.LOG.LOG_PING_REQUESTS === false && req.originalUrl === '/api/v1/ping'
2017-05-22 20:58:25 +02:00
}))
2021-06-02 18:15:41 +02:00
// Add .fail() helper to response
app.use(apiFailMiddleware)
2021-06-01 13:25:41 +02:00
2016-02-07 11:47:30 +01:00
// For body requests
2021-06-01 13:25:41 +02:00
app.use(express.urlencoded({ extended: false }))
app.use(express.json({
type: [ 'application/json', 'application/*+json' ],
limit: '500kb',
2021-06-01 13:25:41 +02:00
verify: (req: express.Request, res: express.Response, buf: Buffer) => {
const valid = isHTTPSignatureDigestValid(buf, req)
2021-06-02 18:15:41 +02:00
2021-06-01 13:25:41 +02:00
if (valid !== true) {
res.fail({
status: HttpStatusCode.FORBIDDEN_403,
message: 'Invalid digest'
})
}
}
}))
2018-06-28 13:59:48 +02:00
// Cookies
app.use(cookieParser())
// W3C DNT Tracking Status
app.use(advertiseDoNotTrack)
2016-02-07 11:47:30 +01:00
2022-07-05 15:43:21 +02:00
// ----------- Open Telemetry -----------
OpenTelemetryMetrics.Instance.init(app)
// ----------- Views, routes and static files -----------
// API
const apiRoute = '/api/' + API_VERSION
app.use(apiRoute, apiRouter)
// Services (oembed...)
app.use('/services', servicesRouter)
// Live streaming
app.use('/live', liveRouter)
// Plugins & themes
2019-07-12 11:39:58 +02:00
app.use('/', pluginsRouter)
2017-11-14 17:31:26 +01:00
app.use('/', activityPubRouter)
app.use('/', feedsRouter)
app.use('/', webfingerRouter)
2018-06-26 16:53:24 +02:00
app.use('/', trackerRouter)
2018-12-05 17:27:24 +01:00
app.use('/', botsRouter)
2017-11-14 17:31:26 +01:00
// Static files
app.use('/', staticRouter)
app.use('/', downloadRouter)
2019-08-09 11:32:40 +02:00
app.use('/', lazyStaticRouter)
2018-05-31 18:12:15 +02:00
// Client files, last valid routes!
2022-06-03 16:17:28 +02:00
const cliOptions = cli.opts<{ client: boolean, plugins: boolean }>()
2021-02-03 09:33:05 +01:00
if (cliOptions.client) app.use('/', clientsRouter)
2016-02-07 11:47:30 +01:00
// ----------- Errors -----------
2021-06-01 13:25:41 +02:00
// Catch unmatched routes
2022-06-03 16:17:28 +02:00
app.use((_req, res: express.Response) => {
2021-06-01 13:25:41 +02:00
res.status(HttpStatusCode.NOT_FOUND_404).end()
2016-02-07 11:47:30 +01:00
})
2021-06-01 13:25:41 +02:00
// Catch thrown errors
2022-06-03 16:17:28 +02:00
app.use((err, _req, res: express.Response, _next) => {
2021-06-01 13:25:41 +02:00
// Format error to be logged
2018-02-14 15:33:49 +01:00
let error = 'Unknown error.'
if (err) {
error = err.stack || err.message || err
}
2021-06-01 13:25:41 +02:00
// Handling Sequelize error traces
const sql = err.parent ? err.parent.sql : undefined
logger.error('Error in controller.', { err: error, sql })
2021-06-01 13:25:41 +02:00
return res.fail({
status: err.status || HttpStatusCode.INTERNAL_SERVER_ERROR_500,
message: err.message,
type: err.name
})
2016-03-07 14:48:46 +01:00
})
2016-02-07 11:47:30 +01:00
2018-12-26 10:36:24 +01:00
const server = createWebsocketTrackerServer(app)
2018-06-26 16:53:24 +02:00
// ----------- Run -----------
async function startApplication () {
2017-05-15 22:22:03 +02:00
const port = CONFIG.LISTEN.PORT
const hostname = CONFIG.LISTEN.HOSTNAME
2017-12-13 17:46:23 +01:00
await installApplication()
// Check activity pub urls are valid
checkActivityPubUrls()
.catch(err => {
logger.error('Error in ActivityPub URLs checker.', { err })
process.exit(-1)
})
2021-03-11 09:51:08 +01:00
checkFFmpegVersion()
.catch(err => logger.error('Cannot check ffmpeg version', { err }))
// Email initialization
Emailer.Instance.init()
2018-11-19 15:21:09 +01:00
await Promise.all([
Emailer.Instance.checkConnection(),
JobQueue.Instance.init(),
ServerConfigManager.Instance.init()
2018-11-19 15:21:09 +01:00
])
// Caches initializations
2019-03-19 14:23:17 +01:00
VideosPreviewCache.Instance.init(CONFIG.CACHE.PREVIEWS.SIZE, FILES_CACHE.PREVIEWS.MAX_AGE)
VideosCaptionCache.Instance.init(CONFIG.CACHE.VIDEO_CAPTIONS.SIZE, FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE)
VideosTorrentCache.Instance.init(CONFIG.CACHE.TORRENTS.SIZE, FILES_CACHE.TORRENTS.MAX_AGE)
// Enable Schedulers
ActorFollowScheduler.Instance.enable()
RemoveOldJobsScheduler.Instance.enable()
UpdateVideosScheduler.Instance.enable()
2018-08-02 16:02:51 +02:00
YoutubeDlUpdateScheduler.Instance.enable()
2018-09-11 16:27:07 +02:00
VideosRedundancyScheduler.Instance.enable()
RemoveOldHistoryScheduler.Instance.enable()
2019-04-11 17:33:36 +02:00
RemoveOldViewsScheduler.Instance.enable()
2019-07-16 14:52:24 +02:00
PluginsCheckScheduler.Instance.enable()
2021-03-11 16:54:52 +01:00
PeerTubeVersionCheckScheduler.Instance.enable()
AutoFollowIndexInstances.Instance.enable()
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 11:13:41 +02:00
RemoveDanglingResumableUploadsScheduler.Instance.enable()
VideoViewsBufferScheduler.Instance.enable()
GeoIPUpdateScheduler.Instance.enable()
2022-07-05 15:43:21 +02:00
OpenTelemetryMetrics.Instance.registerMetrics()
Redis.Instance.init()
2018-12-26 10:36:24 +01:00
PeerTubeSocket.Instance.init(server)
VideoViewsManager.Instance.init()
2018-12-26 10:36:24 +01:00
2019-04-08 11:13:49 +02:00
updateStreamingPlaylistsInfohashesIfNeeded()
.catch(err => logger.error('Cannot update streaming playlist infohashes.', { err }))
LiveManager.Instance.init()
2021-11-05 11:36:03 +01:00
if (CONFIG.LIVE.ENABLED) await LiveManager.Instance.run()
// Make server listening
server.listen(port, hostname, async () => {
if (cliOptions.plugins) {
try {
await PluginManager.Instance.registerPluginsAndThemes()
} catch (err) {
logger.error('Cannot register plugins and themes.', { err })
}
}
logger.info('HTTP server listening on %s:%d', hostname, port)
logger.info('Web server: %s', WEBSERVER.URL)
2019-07-19 17:30:41 +02:00
Hooks.runAction('action:application.listening')
if (cliOptions['benchmarkStartup']) process.exit(0)
2018-04-18 16:04:49 +02:00
})
2018-07-30 18:49:54 +02:00
process.on('exit', () => {
JobQueue.Instance.terminate()
})
process.on('SIGINT', () => process.exit(0))
2017-02-18 11:56:28 +01:00
}