Playlist server API
[oweals/peertube.git] / server.ts
1 // FIXME: https://github.com/nodejs/node/pull/16853
2 require('tls').DEFAULT_ECDH_CURVE = 'auto'
3
4 import { isTestInstance } from './server/helpers/core-utils'
5
6 if (isTestInstance()) {
7   require('source-map-support').install()
8 }
9
10 // ----------- Node modules -----------
11 import * as bodyParser from 'body-parser'
12 import * as express from 'express'
13 import * as morgan from 'morgan'
14 import * as cors from 'cors'
15 import * as cookieParser from 'cookie-parser'
16 import * as helmet from 'helmet'
17 import * as useragent from 'useragent'
18 import * as anonymize from 'ip-anonymize'
19 import * as cli from 'commander'
20
21 process.title = 'peertube'
22
23 // Create our main app
24 const app = express()
25
26 // ----------- Core checker -----------
27 import { checkMissedConfig, checkFFmpeg } from './server/initializers/checker-before-init'
28
29 // Do not use barrels because we don't want to load all modules here (we need to initialize database first)
30 import { logger } from './server/helpers/logger'
31 import { API_VERSION, CONFIG, CACHE } from './server/initializers/constants'
32
33 const missed = checkMissedConfig()
34 if (missed.length !== 0) {
35   logger.error('Your configuration files miss keys: ' + missed)
36   process.exit(-1)
37 }
38
39 checkFFmpeg(CONFIG)
40   .catch(err => {
41     logger.error('Error in ffmpeg check.', { err })
42     process.exit(-1)
43   })
44
45 import { checkConfig, checkActivityPubUrls } from './server/initializers/checker-after-init'
46
47 const errorMessage = checkConfig()
48 if (errorMessage !== null) {
49   throw new Error(errorMessage)
50 }
51
52 // Trust our proxy (IP forwarding...)
53 app.set('trust proxy', CONFIG.TRUST_PROXY)
54
55 // Security middleware
56 import { baseCSP } from './server/middlewares/csp'
57
58 if (CONFIG.CSP.ENABLED) {
59   app.use(baseCSP)
60   app.use(helmet({
61     frameguard: {
62       action: 'deny' // we only allow it for /videos/embed, see server/controllers/client.ts
63     },
64     hsts: false
65   }))
66 }
67
68 // ----------- Database -----------
69
70 // Initialize database and models
71 import { initDatabaseModels } from './server/initializers/database'
72 import { migrate } from './server/initializers/migrator'
73 migrate()
74   .then(() => initDatabaseModels(false))
75   .then(() => startApplication())
76   .catch(err => {
77     logger.error('Cannot start application.', { err })
78     process.exit(-1)
79   })
80
81 // ----------- PeerTube modules -----------
82 import { installApplication } from './server/initializers'
83 import { Emailer } from './server/lib/emailer'
84 import { JobQueue } from './server/lib/job-queue'
85 import { VideosPreviewCache, VideosCaptionCache } from './server/lib/cache'
86 import {
87   activityPubRouter,
88   apiRouter,
89   clientsRouter,
90   feedsRouter,
91   staticRouter,
92   servicesRouter,
93   webfingerRouter,
94   trackerRouter,
95   createWebsocketTrackerServer, botsRouter
96 } from './server/controllers'
97 import { advertiseDoNotTrack } from './server/middlewares/dnt'
98 import { Redis } from './server/lib/redis'
99 import { ActorFollowScheduler } from './server/lib/schedulers/actor-follow-scheduler'
100 import { RemoveOldJobsScheduler } from './server/lib/schedulers/remove-old-jobs-scheduler'
101 import { UpdateVideosScheduler } from './server/lib/schedulers/update-videos-scheduler'
102 import { YoutubeDlUpdateScheduler } from './server/lib/schedulers/youtube-dl-update-scheduler'
103 import { VideosRedundancyScheduler } from './server/lib/schedulers/videos-redundancy-scheduler'
104 import { isHTTPSignatureDigestValid } from './server/helpers/peertube-crypto'
105 import { PeerTubeSocket } from './server/lib/peertube-socket'
106
107 // ----------- Command line -----------
108
109 cli
110   .option('--no-client', 'Start PeerTube without client interface')
111   .parse(process.argv)
112
113 // ----------- App -----------
114
115 // Enable CORS for develop
116 if (isTestInstance()) {
117   app.use(cors({
118     origin: '*',
119     exposedHeaders: 'Retry-After',
120     credentials: true
121   }))
122 }
123 // For the logger
124 morgan.token('remote-addr', req => {
125   return (req.get('DNT') === '1') ?
126     anonymize(req.ip || (req.connection && req.connection.remoteAddress) || undefined,
127     16, // bitmask for IPv4
128     16  // bitmask for IPv6
129     ) :
130     req.ip
131 })
132 morgan.token('user-agent', req => (req.get('DNT') === '1') ?
133   useragent.parse(req.get('user-agent')).family : req.get('user-agent'))
134 app.use(morgan('combined', {
135   stream: { write: logger.info.bind(logger) }
136 }))
137 // For body requests
138 app.use(bodyParser.urlencoded({ extended: false }))
139 app.use(bodyParser.json({
140   type: [ 'application/json', 'application/*+json' ],
141   limit: '500kb',
142   verify: (req: express.Request, _, buf: Buffer) => {
143     const valid = isHTTPSignatureDigestValid(buf, req)
144     if (valid !== true) throw new Error('Invalid digest')
145   }
146 }))
147 // Cookies
148 app.use(cookieParser())
149 // W3C DNT Tracking Status
150 app.use(advertiseDoNotTrack)
151
152 // ----------- Views, routes and static files -----------
153
154 // API
155 const apiRoute = '/api/' + API_VERSION
156 app.use(apiRoute, apiRouter)
157
158 // Services (oembed...)
159 app.use('/services', servicesRouter)
160
161 app.use('/', activityPubRouter)
162 app.use('/', feedsRouter)
163 app.use('/', webfingerRouter)
164 app.use('/', trackerRouter)
165 app.use('/', botsRouter)
166
167 // Static files
168 app.use('/', staticRouter)
169
170 // Client files, last valid routes!
171 if (cli.client) app.use('/', clientsRouter)
172
173 // ----------- Errors -----------
174
175 // Catch 404 and forward to error handler
176 app.use(function (req, res, next) {
177   const err = new Error('Not Found')
178   err['status'] = 404
179   next(err)
180 })
181
182 app.use(function (err, req, res, next) {
183   let error = 'Unknown error.'
184   if (err) {
185     error = err.stack || err.message || err
186   }
187
188   // Sequelize error
189   const sql = err.parent ? err.parent.sql : undefined
190
191   logger.error('Error in controller.', { err: error, sql })
192   return res.status(err.status || 500).end()
193 })
194
195 const server = createWebsocketTrackerServer(app)
196
197 // ----------- Run -----------
198
199 async function startApplication () {
200   const port = CONFIG.LISTEN.PORT
201   const hostname = CONFIG.LISTEN.HOSTNAME
202
203   await installApplication()
204
205   // Check activity pub urls are valid
206   checkActivityPubUrls()
207     .catch(err => {
208       logger.error('Error in ActivityPub URLs checker.', { err })
209       process.exit(-1)
210     })
211
212   // Email initialization
213   Emailer.Instance.init()
214
215   await Promise.all([
216     Emailer.Instance.checkConnectionOrDie(),
217     JobQueue.Instance.init()
218   ])
219
220   // Caches initializations
221   VideosPreviewCache.Instance.init(CONFIG.CACHE.PREVIEWS.SIZE, CACHE.PREVIEWS.MAX_AGE)
222   VideosCaptionCache.Instance.init(CONFIG.CACHE.VIDEO_CAPTIONS.SIZE, CACHE.VIDEO_CAPTIONS.MAX_AGE)
223
224   // Enable Schedulers
225   ActorFollowScheduler.Instance.enable()
226   RemoveOldJobsScheduler.Instance.enable()
227   UpdateVideosScheduler.Instance.enable()
228   YoutubeDlUpdateScheduler.Instance.enable()
229   VideosRedundancyScheduler.Instance.enable()
230
231   // Redis initialization
232   Redis.Instance.init()
233
234   PeerTubeSocket.Instance.init(server)
235
236   // Make server listening
237   server.listen(port, hostname, () => {
238     logger.info('Server listening on %s:%d', hostname, port)
239     logger.info('Web server: %s', CONFIG.WEBSERVER.URL)
240   })
241
242   process.on('exit', () => {
243     JobQueue.Instance.terminate()
244   })
245
246   process.on('SIGINT', () => process.exit(0))
247 }