PeerTube/server/server.ts

390 lines
12 KiB
TypeScript
Raw Normal View History

import { registerOpentelemetryTracing } from '@server/lib/opentelemetry/tracing.js'
await registerOpentelemetryTracing()
2016-02-07 11:47:30 +01:00
2016-10-21 14:23:20 +02:00
process.title = 'peertube'
2017-08-26 09:17:20 +02:00
// ----------- Core checker -----------
2023-10-04 15:13:25 +02:00
import { checkMissedConfig, checkFFmpeg, checkNodeVersion } from './core/initializers/checker-before-init.js'
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)
2023-10-04 15:13:25 +02:00
import { CONFIG } from './core/initializers/config.js'
import { API_VERSION, WEBSERVER, loadLanguages } from './core/initializers/constants.js'
import { logger } from './core/helpers/logger.js'
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)
}
2023-10-04 15:13:25 +02:00
import { checkConfig, checkActivityPubUrls, checkFFmpegVersion } from './core/initializers/checker-after-init.js'
2022-10-10 11:12:23 +02:00
try {
checkConfig()
} catch (err) {
logger.error('Config error.', { err })
process.exit(-1)
}
// ----------- Database -----------
// Initialize database and models
import { initDatabaseModels, checkDatabaseConnectionOrDie, sequelizeTypescript } from './core/initializers/database.js'
checkDatabaseConnectionOrDie()
2023-10-04 15:13:25 +02:00
import { migrate } from './core/initializers/migrator.js'
migrate()
.then(() => initDatabaseModels(false))
.then(() => startApplication())
.catch(err => {
logger.error('Cannot start application.', { err })
process.exit(-1)
})
// ----------- Initialize -----------
loadLanguages()
.catch(err => logger.error('Cannot load languages', { err }))
// Express configuration
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'
import { program as cli } from 'commander'
const app = express().disable('x-powered-by')
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) => {
2023-02-27 09:22:59 +01:00
// OpenTelemetry
2022-07-05 15:43:21 +02:00
res.locals.requestStart = Date.now()
2023-02-27 09:22:59 +01:00
if (CONFIG.SECURITY.POWERED_BY_HEADER.ENABLED === true) {
res.setHeader('x-powered-by', 'PeerTube')
}
2022-07-05 15:43:21 +02:00
return next()
})
2018-07-19 16:17:54 +02:00
// Security middleware
2023-10-04 15:13:25 +02:00
import { baseCSP } from './core/middlewares/csp.js'
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
}))
}
// ----------- PeerTube modules -----------
2023-10-04 15:13:25 +02:00
import { installApplication } from './core/initializers/installer.js'
import { Emailer } from './core/lib/emailer.js'
import { JobQueue } from './core/lib/job-queue/index.js'
import {
activityPubRouter,
apiRouter,
2022-07-13 11:13:19 +02:00
miscRouter,
clientsRouter,
feedsRouter,
staticRouter,
2022-07-13 11:13:19 +02:00
wellKnownRouter,
2019-08-09 11:32:40 +02:00
lazyStaticRouter,
servicesRouter,
objectStorageProxyRouter,
pluginsRouter,
2018-06-26 16:53:24 +02:00
trackerRouter,
createWebsocketTrackerServer,
2023-07-25 15:18:10 +02:00
sitemapRouter,
downloadRouter
2023-10-04 15:13:25 +02:00
} from './core/controllers/index.js'
import { advertiseDoNotTrack } from './core/middlewares/dnt.js'
import { apiFailMiddleware } from './core/middlewares/error.js'
import { Redis } from './core/lib/redis.js'
import { ActorFollowScheduler } from './core/lib/schedulers/actor-follow-scheduler.js'
import { RemoveOldViewsScheduler } from './core/lib/schedulers/remove-old-views-scheduler.js'
import { UpdateVideosScheduler } from './core/lib/schedulers/update-videos-scheduler.js'
import { YoutubeDlUpdateScheduler } from './core/lib/schedulers/youtube-dl-update-scheduler.js'
import { VideosRedundancyScheduler } from './core/lib/schedulers/videos-redundancy-scheduler.js'
import { RemoveOldHistoryScheduler } from './core/lib/schedulers/remove-old-history-scheduler.js'
import { AutoFollowIndexInstances } from './core/lib/schedulers/auto-follow-index-instances.js'
import { RemoveDanglingResumableUploadsScheduler } from './core/lib/schedulers/remove-dangling-resumable-uploads-scheduler.js'
import { VideoViewsBufferScheduler } from './core/lib/schedulers/video-views-buffer-scheduler.js'
import { GeoIPUpdateScheduler } from './core/lib/schedulers/geo-ip-update-scheduler.js'
import { RunnerJobWatchDogScheduler } from './core/lib/schedulers/runner-job-watch-dog-scheduler.js'
import { isHTTPSignatureDigestValid } from './core/helpers/peertube-crypto.js'
import { PeerTubeSocket } from './core/lib/peertube-socket.js'
import { updateStreamingPlaylistsInfohashesIfNeeded } from './core/lib/hls.js'
import { PluginsCheckScheduler } from './core/lib/schedulers/plugins-check-scheduler.js'
import { PeerTubeVersionCheckScheduler } from './core/lib/schedulers/peertube-version-check-scheduler.js'
import { Hooks } from './core/lib/plugins/hooks.js'
import { PluginManager } from './core/lib/plugins/plugin-manager.js'
import { LiveManager } from './core/lib/live/index.js'
import { HttpStatusCode } from '@peertube/peertube-models'
import { ServerConfigManager } from '@server/lib/server-config-manager.js'
import { VideoViewsManager } from '@server/lib/views/video-views-manager.js'
import { isTestOrDevInstance } from '@peertube/peertube-node-utils'
import { OpenTelemetryMetrics } from '@server/lib/opentelemetry/metrics.js'
import { ApplicationModel } from '@server/models/application/application.js'
import { VideoChannelSyncLatestScheduler } from '@server/lib/schedulers/video-channel-sync-latest-scheduler.js'
2024-02-12 10:47:52 +01:00
import { RemoveExpiredUserExportsScheduler } from '@server/lib/schedulers/remove-expired-user-exports-scheduler.js'
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
}))
}
2023-10-24 10:57:41 +02:00
// HTTP logging
if (CONFIG.LOG.LOG_HTTP_REQUESTS) {
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
})
2023-10-24 10:57:41 +02:00
token('user-agent', (req: express.Request) => {
if (req.get('DNT') === '1') {
return parse(req.get('user-agent')).family
}
2023-10-24 10:57:41 +02:00
return req.get('user-agent')
})
app.use(morgan('combined', {
stream: {
write: (str: string) => logger.info(str.trim(), { tags: [ 'http' ] })
},
skip: req => CONFIG.LOG.LOG_PING_REQUESTS === false && req.originalUrl === '/api/v1/ping'
}))
}
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'
})
}
if (req.originalUrl.startsWith('/plugins/')) {
req.rawBody = buf
}
}
}))
// 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 -----------
2023-07-25 15:18:10 +02:00
app.use('/api/' + API_VERSION, apiRouter)
// Services (oembed...)
app.use('/services', servicesRouter)
2017-11-14 17:31:26 +01:00
app.use('/', activityPubRouter)
app.use('/', feedsRouter)
2018-06-26 16:53:24 +02:00
app.use('/', trackerRouter)
2023-07-25 15:18:10 +02:00
app.use('/', sitemapRouter)
2017-11-14 17:31:26 +01:00
// Static files
app.use('/', staticRouter)
2022-07-13 11:13:19 +02:00
app.use('/', wellKnownRouter)
app.use('/', miscRouter)
app.use('/', downloadRouter)
2019-08-09 11:32:40 +02:00
app.use('/', lazyStaticRouter)
app.use('/', objectStorageProxyRouter)
2023-11-30 11:08:04 +01:00
// Cookies for plugins and HTML
app.use(cookieParser())
// Plugins & themes
app.use('/', pluginsRouter)
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
// Help us to debug SequelizeConnectionAcquireTimeoutError errors
const activeRequests = err?.name === 'SequelizeConnectionAcquireTimeoutError' && typeof (process as any)._getActiveRequests !== 'function'
? (process as any)._getActiveRequests()
: undefined
logger.error('Error in controller.', { err: error, sql, activeRequests })
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
2023-01-05 10:19:51 +01:00
const { server, trackerServer } = 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 }))
2022-07-13 10:00:17 +02:00
Redis.Instance.init()
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
])
// Enable Schedulers
ActorFollowScheduler.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()
Channel sync (#5135) * Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-08-10 09:53:39 +02:00
VideoChannelSyncLatestScheduler.Instance.enable()
VideoViewsBufferScheduler.Instance.enable()
GeoIPUpdateScheduler.Instance.enable()
RunnerJobWatchDogScheduler.Instance.enable()
2024-02-12 10:47:52 +01:00
RemoveExpiredUserExportsScheduler.Instance.enable()
2023-01-05 10:19:51 +01:00
OpenTelemetryMetrics.Instance.registerMetrics({ trackerServer })
PluginManager.Instance.init(server)
// Before PeerTubeSocket init
PluginManager.Instance.registerWebSocketRouter()
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.rebuildNativePluginsIfNeeded()
await PluginManager.Instance.registerPluginsAndThemes()
} catch (err) {
logger.error('Cannot register plugins and themes.', { err })
}
}
ApplicationModel.updateNodeVersions()
.catch(err => logger.error('Cannot update node versions.', { err }))
JobQueue.Instance.start()
.catch(err => {
logger.error('Cannot start job queue.', { err })
process.exit(-1)
})
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', () => {
sequelizeTypescript.close()
.catch(err => logger.error('Cannot close database connection.', { err }))
2018-07-30 18:49:54 +02:00
JobQueue.Instance.terminate()
2022-08-08 10:42:08 +02:00
.catch(err => logger.error('Cannot terminate job queue.', { err }))
2018-07-30 18:49:54 +02:00
})
process.on('SIGINT', () => process.exit(0))
2017-02-18 11:56:28 +01:00
}